forked from spreedly/spreedly-gem
-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.txt
91 lines (65 loc) · 2.93 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
= Spreedly-Gem
* http:https://terralien.com/static/projects/spreedly-gem/
* Source[http:https://github.com/terralien/spreedly-gem]
== DESCRIPTION:
The Spreedly gem provides a convenient Ruby wrapper for the goodness that is
the http:https://spreedly.com API. Created by Terralien[http:https://terralien.com].
== FEATURES:
* Makes it easy to get started.
* Fully tested.
* (Mostly) fully substitutable mock implementation for fast tests.
* Great example code.
== SYNOPSIS:
# For real
## Genral API
require 'spreedly'
Spreedly.configure('site short name', 'crazy hash token')
url = Spreedly.subscribe_url('customer id', 'plan id')
subscriber = Spreedly::Subscriber.find('customer id')
subscriber.active?
## Payment API
invoice = Spreedly::Invoice.create!('plan_id', :subscriber => { :customer_id => 'customer_id, :email => "[email protected]"})
puts invoice.closed? # Nope!
invoice.pay(credit_card)
puts invoice.closed? # Yep!
OR
invoice = Spreedly::Invoice.create!('plan_id', :subscriber => { :customer_id => 'customer_id, :email => "[email protected]"})
Spreedly::Invoice.pay(credit_card, invoice.token)
Spreedly::Subscriber.find(customer_id).active? # Nope!
Spreedly::Invoice.pay(credit_card, invoice.token)
Spreedly::Subscriber.find(customer_id).active? # Yep!
# For fast tests
require 'spreedly/mock'
Spreedly.configure('site short name', 'crazy hash token')
url = Spreedly.subscribe_url('customer id', 'plan id')
subscriber = Spreedly::Subscriber.find('customer id')
subscriber.active?
Yup, they're exactly the same except for the require and the speed!
## Note
The mocks for the payment API don't mimic spreedly's logic, they
simply make the tests pass. In Real mode, all passes with
flying colors, but at 10000000000000% less speed.
== REQUIREMENTS:
* A (free) Spreedly account.
* HTTParty (vendored for now).
== INSTALL:
`sudo gem install spreedly`
== LICENSE:
(The MIT License)
Copyright (c) 2009 Nathaniel Talbott
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.