recurly 2.17.0 → 3.14.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (260) hide show
  1. checksums.yaml +4 -4
  2. data/.bumpversion.cfg +15 -0
  3. data/.github/ISSUE_TEMPLATE/bug-report.md +30 -0
  4. data/.github/ISSUE_TEMPLATE/question-or-other.md +10 -0
  5. data/.github/workflows/docs.yml +28 -0
  6. data/.github_changelog_generator +8 -0
  7. data/.gitignore +15 -0
  8. data/.rspec +2 -0
  9. data/.travis.yml +13 -0
  10. data/.yardopts +2 -0
  11. data/CHANGELOG.md +313 -0
  12. data/CODE_OF_CONDUCT.md +130 -0
  13. data/CONTRIBUTING.md +106 -0
  14. data/GETTING_STARTED.md +319 -0
  15. data/Gemfile +4 -0
  16. data/LICENSE.txt +21 -0
  17. data/README.md +9 -153
  18. data/Rakefile +6 -0
  19. data/benchmark.rb +16 -0
  20. data/lib/data/ca-certificates.crt +3466 -0
  21. data/lib/recurly/client/operations.rb +3665 -0
  22. data/lib/recurly/client.rb +353 -0
  23. data/lib/recurly/connection_pool.rb +40 -0
  24. data/lib/recurly/errors/api_errors.rb +83 -0
  25. data/lib/recurly/errors/network_errors.rb +10 -0
  26. data/lib/recurly/errors.rb +68 -0
  27. data/lib/recurly/http.rb +50 -0
  28. data/lib/recurly/pager.rb +146 -0
  29. data/lib/recurly/request.rb +31 -0
  30. data/lib/recurly/requests/account_acquisition_cost.rb +18 -0
  31. data/lib/recurly/requests/account_acquisition_updatable.rb +26 -0
  32. data/lib/recurly/requests/account_create.rb +90 -0
  33. data/lib/recurly/requests/account_purchase.rb +90 -0
  34. data/lib/recurly/requests/account_update.rb +78 -0
  35. data/lib/recurly/requests/add_on_create.rb +94 -0
  36. data/lib/recurly/requests/add_on_pricing.rb +18 -0
  37. data/lib/recurly/requests/add_on_update.rb +74 -0
  38. data/lib/recurly/requests/address.rb +46 -0
  39. data/lib/recurly/requests/billing_info_create.rb +110 -0
  40. data/lib/recurly/requests/coupon_bulk_create.rb +14 -0
  41. data/lib/recurly/requests/coupon_create.rb +94 -0
  42. data/lib/recurly/requests/coupon_pricing.rb +18 -0
  43. data/lib/recurly/requests/coupon_redemption_create.rb +18 -0
  44. data/lib/recurly/requests/coupon_update.rb +34 -0
  45. data/lib/recurly/requests/custom_field.rb +18 -0
  46. data/lib/recurly/requests/external_refund.rb +22 -0
  47. data/lib/recurly/requests/external_transaction.rb +26 -0
  48. data/lib/recurly/requests/invoice_address.rb +54 -0
  49. data/lib/recurly/requests/invoice_collect.rb +18 -0
  50. data/lib/recurly/requests/invoice_create.rb +42 -0
  51. data/lib/recurly/requests/invoice_refund.rb +34 -0
  52. data/lib/recurly/requests/invoice_updatable.rb +34 -0
  53. data/lib/recurly/requests/item_create.rb +58 -0
  54. data/lib/recurly/requests/item_update.rb +58 -0
  55. data/lib/recurly/requests/line_item_create.rb +82 -0
  56. data/lib/recurly/requests/line_item_refund.rb +22 -0
  57. data/lib/recurly/requests/measured_unit_create.rb +22 -0
  58. data/lib/recurly/requests/measured_unit_update.rb +22 -0
  59. data/lib/recurly/requests/plan_create.rb +98 -0
  60. data/lib/recurly/requests/plan_hosted_pages.rb +26 -0
  61. data/lib/recurly/requests/plan_pricing.rb +22 -0
  62. data/lib/recurly/requests/plan_update.rb +94 -0
  63. data/lib/recurly/requests/pricing.rb +18 -0
  64. data/lib/recurly/requests/purchase_create.rb +74 -0
  65. data/lib/recurly/requests/shipping_address_create.rb +62 -0
  66. data/lib/recurly/requests/shipping_address_update.rb +66 -0
  67. data/lib/recurly/requests/shipping_fee_create.rb +22 -0
  68. data/lib/recurly/requests/shipping_method_create.rb +26 -0
  69. data/lib/recurly/requests/shipping_method_update.rb +26 -0
  70. data/lib/recurly/requests/shipping_purchase.rb +22 -0
  71. data/lib/recurly/requests/subscription_add_on_create.rb +38 -0
  72. data/lib/recurly/requests/subscription_add_on_tier.rb +18 -0
  73. data/lib/recurly/requests/subscription_add_on_update.rb +42 -0
  74. data/lib/recurly/requests/subscription_cancel.rb +14 -0
  75. data/lib/recurly/requests/subscription_change_create.rb +66 -0
  76. data/lib/recurly/requests/subscription_change_shipping_create.rb +22 -0
  77. data/lib/recurly/requests/subscription_create.rb +106 -0
  78. data/lib/recurly/requests/subscription_pause.rb +14 -0
  79. data/lib/recurly/requests/subscription_purchase.rb +66 -0
  80. data/lib/recurly/requests/subscription_shipping_create.rb +30 -0
  81. data/lib/recurly/requests/subscription_shipping_purchase.rb +22 -0
  82. data/lib/recurly/requests/subscription_shipping_update.rb +22 -0
  83. data/lib/recurly/requests/subscription_update.rb +58 -0
  84. data/lib/recurly/requests/tier.rb +18 -0
  85. data/lib/recurly/requests/usage_create.rb +26 -0
  86. data/lib/recurly/requests.rb +8 -0
  87. data/lib/recurly/resource.rb +23 -1082
  88. data/lib/recurly/resources/account.rb +130 -0
  89. data/lib/recurly/resources/account_acquisition.rb +46 -0
  90. data/lib/recurly/resources/account_acquisition_cost.rb +18 -0
  91. data/lib/recurly/resources/account_balance.rb +26 -0
  92. data/lib/recurly/resources/account_balance_amount.rb +18 -0
  93. data/lib/recurly/resources/account_mini.rb +46 -0
  94. data/lib/recurly/resources/account_note.rb +34 -0
  95. data/lib/recurly/resources/add_on.rb +114 -0
  96. data/lib/recurly/resources/add_on_mini.rb +54 -0
  97. data/lib/recurly/resources/add_on_pricing.rb +18 -0
  98. data/lib/recurly/resources/address.rb +46 -0
  99. data/lib/recurly/resources/billing_info.rb +66 -0
  100. data/lib/recurly/resources/billing_info_updated_by.rb +18 -0
  101. data/lib/recurly/resources/binary_file.rb +14 -0
  102. data/lib/recurly/resources/coupon.rb +130 -0
  103. data/lib/recurly/resources/coupon_discount.rb +26 -0
  104. data/lib/recurly/resources/coupon_discount_pricing.rb +18 -0
  105. data/lib/recurly/resources/coupon_discount_trial.rb +18 -0
  106. data/lib/recurly/resources/coupon_mini.rb +42 -0
  107. data/lib/recurly/resources/coupon_redemption.rb +50 -0
  108. data/lib/recurly/resources/coupon_redemption_mini.rb +34 -0
  109. data/lib/recurly/resources/credit_payment.rb +66 -0
  110. data/lib/recurly/resources/custom_field.rb +18 -0
  111. data/lib/recurly/resources/custom_field_definition.rb +50 -0
  112. data/lib/recurly/resources/error.rb +22 -0
  113. data/lib/recurly/resources/error_may_have_transaction.rb +26 -0
  114. data/lib/recurly/resources/export_dates.rb +18 -0
  115. data/lib/recurly/resources/export_file.rb +22 -0
  116. data/lib/recurly/resources/export_files.rb +18 -0
  117. data/lib/recurly/resources/fraud_info.rb +22 -0
  118. data/lib/recurly/resources/invoice.rb +146 -0
  119. data/lib/recurly/resources/invoice_address.rb +54 -0
  120. data/lib/recurly/resources/invoice_collection.rb +22 -0
  121. data/lib/recurly/resources/invoice_mini.rb +30 -0
  122. data/lib/recurly/resources/item.rb +82 -0
  123. data/lib/recurly/resources/item_mini.rb +34 -0
  124. data/lib/recurly/resources/line_item.rb +198 -0
  125. data/lib/recurly/resources/line_item_list.rb +26 -0
  126. data/lib/recurly/resources/measured_unit.rb +46 -0
  127. data/lib/recurly/resources/payment_method.rb +66 -0
  128. data/lib/recurly/resources/plan.rb +118 -0
  129. data/lib/recurly/resources/plan_hosted_pages.rb +26 -0
  130. data/lib/recurly/resources/plan_mini.rb +26 -0
  131. data/lib/recurly/resources/plan_pricing.rb +22 -0
  132. data/lib/recurly/resources/pricing.rb +18 -0
  133. data/lib/recurly/resources/settings.rb +22 -0
  134. data/lib/recurly/resources/shipping_address.rb +82 -0
  135. data/lib/recurly/resources/shipping_method.rb +46 -0
  136. data/lib/recurly/resources/shipping_method_mini.rb +26 -0
  137. data/lib/recurly/resources/site.rb +54 -0
  138. data/lib/recurly/resources/subscription.rb +174 -0
  139. data/lib/recurly/resources/subscription_add_on.rb +66 -0
  140. data/lib/recurly/resources/subscription_add_on_tier.rb +18 -0
  141. data/lib/recurly/resources/subscription_change.rb +78 -0
  142. data/lib/recurly/resources/subscription_change_preview.rb +78 -0
  143. data/lib/recurly/resources/subscription_shipping.rb +26 -0
  144. data/lib/recurly/resources/tax_info.rb +22 -0
  145. data/lib/recurly/resources/tier.rb +18 -0
  146. data/lib/recurly/resources/transaction.rb +158 -0
  147. data/lib/recurly/resources/transaction_error.rb +38 -0
  148. data/lib/recurly/resources/transaction_payment_gateway.rb +26 -0
  149. data/lib/recurly/resources/unique_coupon_code.rb +50 -0
  150. data/lib/recurly/resources/usage.rb +70 -0
  151. data/lib/recurly/resources/user.rb +42 -0
  152. data/lib/recurly/resources.rb +18 -0
  153. data/lib/recurly/schema/file_parser.rb +13 -0
  154. data/lib/recurly/schema/json_parser.rb +72 -0
  155. data/lib/recurly/schema/request_caster.rb +60 -0
  156. data/lib/recurly/schema/resource_caster.rb +46 -0
  157. data/lib/recurly/schema/schema_factory.rb +48 -0
  158. data/lib/recurly/schema/schema_validator.rb +144 -0
  159. data/lib/recurly/schema.rb +156 -0
  160. data/lib/recurly/version.rb +1 -15
  161. data/lib/recurly.rb +15 -137
  162. data/openapi/api.yaml +21024 -0
  163. data/recurly.gemspec +39 -0
  164. data/scripts/build +5 -0
  165. data/scripts/bump +11 -0
  166. data/scripts/changelog +14 -0
  167. data/scripts/clean +6 -0
  168. data/scripts/format +12 -0
  169. data/scripts/prepare-release +36 -0
  170. data/scripts/release +32 -0
  171. data/scripts/test +15 -0
  172. metadata +206 -168
  173. data/lib/recurly/account.rb +0 -169
  174. data/lib/recurly/account_balance.rb +0 -21
  175. data/lib/recurly/add_on.rb +0 -30
  176. data/lib/recurly/address.rb +0 -25
  177. data/lib/recurly/adjustment.rb +0 -76
  178. data/lib/recurly/api/errors.rb +0 -206
  179. data/lib/recurly/api/net_http_adapter.rb +0 -111
  180. data/lib/recurly/api.rb +0 -101
  181. data/lib/recurly/billing_info.rb +0 -80
  182. data/lib/recurly/coupon.rb +0 -134
  183. data/lib/recurly/credit_payment.rb +0 -28
  184. data/lib/recurly/custom_field.rb +0 -15
  185. data/lib/recurly/delivery.rb +0 -19
  186. data/lib/recurly/error.rb +0 -13
  187. data/lib/recurly/gift_card.rb +0 -79
  188. data/lib/recurly/helper.rb +0 -51
  189. data/lib/recurly/invoice.rb +0 -268
  190. data/lib/recurly/invoice_collection.rb +0 -14
  191. data/lib/recurly/js.rb +0 -14
  192. data/lib/recurly/juris_detail.rb +0 -14
  193. data/lib/recurly/measured_unit.rb +0 -16
  194. data/lib/recurly/money.rb +0 -120
  195. data/lib/recurly/plan.rb +0 -40
  196. data/lib/recurly/purchase.rb +0 -219
  197. data/lib/recurly/redemption.rb +0 -46
  198. data/lib/recurly/resource/association.rb +0 -16
  199. data/lib/recurly/resource/errors.rb +0 -20
  200. data/lib/recurly/resource/pager.rb +0 -314
  201. data/lib/recurly/shipping_address.rb +0 -22
  202. data/lib/recurly/subscription/add_ons.rb +0 -77
  203. data/lib/recurly/subscription.rb +0 -325
  204. data/lib/recurly/subscription_add_on.rb +0 -50
  205. data/lib/recurly/tax_detail.rb +0 -14
  206. data/lib/recurly/tax_type.rb +0 -12
  207. data/lib/recurly/transaction/errors.rb +0 -107
  208. data/lib/recurly/transaction.rb +0 -116
  209. data/lib/recurly/usage.rb +0 -24
  210. data/lib/recurly/webhook/account_notification.rb +0 -10
  211. data/lib/recurly/webhook/billing_info_updated_notification.rb +0 -6
  212. data/lib/recurly/webhook/canceled_account_notification.rb +0 -6
  213. data/lib/recurly/webhook/canceled_subscription_notification.rb +0 -6
  214. data/lib/recurly/webhook/closed_credit_invoice_notification.rb +0 -6
  215. data/lib/recurly/webhook/closed_invoice_notification.rb +0 -6
  216. data/lib/recurly/webhook/credit_payment_notification.rb +0 -12
  217. data/lib/recurly/webhook/dunning_notification.rb +0 -14
  218. data/lib/recurly/webhook/expired_subscription_notification.rb +0 -6
  219. data/lib/recurly/webhook/failed_charge_invoice_notification.rb +0 -6
  220. data/lib/recurly/webhook/failed_payment_notification.rb +0 -6
  221. data/lib/recurly/webhook/gift_card_notification.rb +0 -8
  222. data/lib/recurly/webhook/invoice_notification.rb +0 -12
  223. data/lib/recurly/webhook/new_account_notification.rb +0 -6
  224. data/lib/recurly/webhook/new_charge_invoice_notification.rb +0 -6
  225. data/lib/recurly/webhook/new_credit_invoice_notification.rb +0 -6
  226. data/lib/recurly/webhook/new_credit_payment_notification.rb +0 -6
  227. data/lib/recurly/webhook/new_dunning_event_notification.rb +0 -6
  228. data/lib/recurly/webhook/new_invoice_notification.rb +0 -6
  229. data/lib/recurly/webhook/new_subscription_notification.rb +0 -6
  230. data/lib/recurly/webhook/new_usage_notification.rb +0 -8
  231. data/lib/recurly/webhook/notification.rb +0 -18
  232. data/lib/recurly/webhook/paid_charge_invoice_notification.rb +0 -6
  233. data/lib/recurly/webhook/past_due_charge_invoice_notification.rb +0 -6
  234. data/lib/recurly/webhook/past_due_invoice_notification.rb +0 -6
  235. data/lib/recurly/webhook/processing_charge_invoice_notification.rb +0 -6
  236. data/lib/recurly/webhook/processing_credit_invoice_notification.rb +0 -6
  237. data/lib/recurly/webhook/processing_invoice_notification.rb +0 -6
  238. data/lib/recurly/webhook/processing_payment_notification.rb +0 -6
  239. data/lib/recurly/webhook/purchased_gift_card_notification.rb +0 -7
  240. data/lib/recurly/webhook/reactivated_account_notification.rb +0 -6
  241. data/lib/recurly/webhook/redeemed_gift_card_notification.rb +0 -7
  242. data/lib/recurly/webhook/renewed_subscription_notification.rb +0 -6
  243. data/lib/recurly/webhook/reopened_charge_invoice_notification.rb +0 -6
  244. data/lib/recurly/webhook/reopened_credit_invoice_notification.rb +0 -6
  245. data/lib/recurly/webhook/scheduled_payment_notification.rb +0 -6
  246. data/lib/recurly/webhook/subscription_notification.rb +0 -12
  247. data/lib/recurly/webhook/successful_payment_notification.rb +0 -6
  248. data/lib/recurly/webhook/successful_refund_notification.rb +0 -6
  249. data/lib/recurly/webhook/transaction_authorized_notification.rb +0 -6
  250. data/lib/recurly/webhook/transaction_notification.rb +0 -12
  251. data/lib/recurly/webhook/updated_account_notification.rb +0 -6
  252. data/lib/recurly/webhook/updated_balance_gift_card_notification.rb +0 -7
  253. data/lib/recurly/webhook/updated_subscription_notification.rb +0 -6
  254. data/lib/recurly/webhook/void_payment_notification.rb +0 -6
  255. data/lib/recurly/webhook/voided_credit_invoice_notification.rb +0 -6
  256. data/lib/recurly/webhook/voided_credit_payment_notification.rb +0 -6
  257. data/lib/recurly/webhook.rb +0 -88
  258. data/lib/recurly/xml/nokogiri.rb +0 -58
  259. data/lib/recurly/xml/rexml.rb +0 -50
  260. data/lib/recurly/xml.rb +0 -120
data/lib/recurly/api.rb DELETED
@@ -1,101 +0,0 @@
1
- module Recurly
2
- # The API class handles all requests to the Recurly API. While most of its
3
- # functionality is leveraged by the Resource class, it can be used directly,
4
- # as well.
5
- #
6
- # Requests are made with methods named after the four main HTTP verbs
7
- # recognized by the Recurly API.
8
- #
9
- # @example
10
- # Recurly::API.get 'accounts' # => #<Net::HTTPOK ...>
11
- # Recurly::API.post 'accounts', xml_body # => #<Net::HTTPCreated ...>
12
- # Recurly::API.put 'accounts/1', xml_body # => #<Net::HTTPOK ...>
13
- # Recurly::API.delete 'accounts/1' # => #<Net::HTTPNoContent ...>
14
- class API
15
- require 'recurly/api/errors'
16
-
17
- @@base_uri = "https://api.recurly.com/v2/"
18
- @@valid_domains = [".recurly.com"]
19
-
20
- RECURLY_API_VERSION = '2.14'
21
-
22
- FORMATS = Helper.hash_with_indifferent_read_access(
23
- 'pdf' => 'application/pdf',
24
- 'xml' => 'application/xml'
25
- )
26
-
27
- class << self
28
- # Additional HTTP headers sent with each API call
29
- # @return [Hash{String => String}]
30
- def headers
31
- @headers ||= { 'Accept' => accept, 'User-Agent' => user_agent, 'X-Api-Version' => RECURLY_API_VERSION }
32
- end
33
-
34
- # @return [String, nil] Accept-Language header value
35
- def accept_language
36
- headers['Accept-Language']
37
- end
38
-
39
- # @param [String] language Accept-Language header value
40
- def accept_language=(language)
41
- headers['Accept-Language'] = language
42
- end
43
-
44
- # @return [Net::HTTPOK, Net::HTTPResponse]
45
- # @raise [ResponseError] With a non-2xx status code.
46
- def head uri, params = {}, options = {}
47
- request :head, uri, { :params => params || {} }.merge(options)
48
- end
49
-
50
- # @return [Net::HTTPOK, Net::HTTPResponse]
51
- # @raise [ResponseError] With a non-2xx status code.
52
- def get uri, params = {}, options = {}
53
- request :get, uri, { :params => params || {} }.merge(options)
54
- end
55
-
56
- # @return [Net::HTTPCreated, Net::HTTPResponse]
57
- # @raise [ResponseError] With a non-2xx status code.
58
- def post uri, body = nil, options = {}
59
- request :post, uri, { :body => body.to_s }.merge(options)
60
- end
61
-
62
- # @return [Net::HTTPOK, Net::HTTPResponse]
63
- # @raise [ResponseError] With a non-2xx status code.
64
- def put uri, body = nil, options = {}
65
- request :put, uri, { :body => body.to_s }.merge(options)
66
- end
67
-
68
- # @return [Net::HTTPNoContent, Net::HTTPResponse]
69
- # @raise [ResponseError] With a non-2xx status code.
70
- def delete uri, body = nil, options = {}
71
- request :delete, uri, options
72
- end
73
-
74
- # @return [URI::Generic]
75
- def base_uri
76
- URI.parse @@base_uri.sub('api', Recurly.subdomain)
77
- end
78
-
79
- def validate_uri!(uri)
80
- domain = @@valid_domains.detect { |d| uri.host.end_with?(d) }
81
- unless domain
82
- raise ArgumentError, "URI #{uri} is invalid. You may only make requests to a Recurly domain."
83
- end
84
- end
85
-
86
- # @return [String]
87
- def user_agent
88
- "Recurly/#{Version}; #{RUBY_DESCRIPTION}"
89
- end
90
-
91
- private
92
-
93
- def accept
94
- FORMATS['xml']
95
- end
96
- alias content_type accept
97
- end
98
- end
99
- end
100
-
101
- require 'recurly/api/net_http_adapter'
@@ -1,80 +0,0 @@
1
- module Recurly
2
- # Represents an account's Billing Information. You normally want to use a token when creating billing information.
3
- #
4
- # Recurly Documentation: https://dev.recurly.com/docs/create-an-accounts-billing-info-token
5
- class BillingInfo < Resource
6
- BANK_ACCOUNT_ATTRIBUTES = %w(name_on_account account_type last_four routing_number).freeze
7
- CREDIT_CARD_ATTRIBUTES = %w(number verification_value card_type year month first_six last_four).freeze
8
- AMAZON_ATTRIBUTES = %w(amazon_billing_agreement_id).freeze
9
- PAYPAL_ATTRIBUTES = %w(paypal_billing_agreement_id).freeze
10
- ROKU_ATTRIBUTES = %w(roku_billing_agreement_id last_four).freeze
11
-
12
- # @return [Account]
13
- belongs_to :account
14
-
15
- define_attribute_methods %w(
16
- first_name
17
- last_name
18
- company
19
- address1
20
- address2
21
- city
22
- state
23
- zip
24
- country
25
- phone
26
- vat_number
27
- ip_address
28
- ip_address_country
29
- token_id
30
- currency
31
- geo_code
32
- updated_at
33
- external_hpp_type
34
- gateway_token
35
- gateway_code
36
- ) | CREDIT_CARD_ATTRIBUTES | BANK_ACCOUNT_ATTRIBUTES | AMAZON_ATTRIBUTES | PAYPAL_ATTRIBUTES | ROKU_ATTRIBUTES
37
-
38
- # @return ["credit_card", "paypal", "amazon", "bank_account", "roku", nil] The type of billing info.
39
- attr_reader :type
40
-
41
- # @return [String]
42
- def inspect
43
- attributes = self.class.attribute_names
44
- case type
45
- when 'credit_card'
46
- attributes -= (AMAZON_ATTRIBUTES + PAYPAL_ATTRIBUTES + BANK_ACCOUNT_ATTRIBUTES + ROKU_ATTRIBUTES)
47
- attributes |= CREDIT_CARD_ATTRIBUTES
48
- when 'paypal'
49
- attributes -= (CREDIT_CARD_ATTRIBUTES | BANK_ACCOUNT_ATTRIBUTES + AMAZON_ATTRIBUTES + ROKU_ATTRIBUTES)
50
- when 'amazon'
51
- attributes -= (CREDIT_CARD_ATTRIBUTES | BANK_ACCOUNT_ATTRIBUTES + PAYPAL_ATTRIBUTES + ROKU_ATTRIBUTES)
52
- when 'bank_account'
53
- attributes -= (CREDIT_CARD_ATTRIBUTES + PAYPAL_ATTRIBUTES + AMAZON_ATTRIBUTES + ROKU_ATTRIBUTES)
54
- attributes |= BANK_ACCOUNT_ATTRIBUTES
55
- when 'roku'
56
- attributes -= (CREDIT_CARD_ATTRIBUTES + PAYPAL_ATTRIBUTES + AMAZON_ATTRIBUTES + BANK_ACCOUNT_ATTRIBUTES)
57
- attributes |= ROKU_ATTRIBUTES
58
- end
59
- super attributes
60
- end
61
-
62
- class << self
63
- # Overrides the inherited member_path method to allow for billing info's
64
- # irregular URL structure.
65
- #
66
- # @return [String] The relative path to an account's billing info from the
67
- # API's base URI.
68
- # @param uuid [String]
69
- # @example
70
- # Recurly::BillingInfo.member_path "code"
71
- # # => "accounts/code/billing_info"
72
- def member_path uuid
73
- "accounts/#{uuid}/billing_info"
74
- end
75
- end
76
-
77
- # Billing info is only writeable through an {Account} instance.
78
- embedded!
79
- end
80
- end
@@ -1,134 +0,0 @@
1
- module Recurly
2
-
3
- # Recurly Documentation: https://dev.recurly.com/docs/list-active-coupons
4
- class Coupon < Resource
5
- BULK = 'bulk'.freeze
6
- SINGLE_CODE = 'single_code'.freeze
7
-
8
- # @macro [attach] scope
9
- # @scope class
10
- # @return [Pager<Coupon>] A pager that yields +$1+ coupons.
11
- scope :redeemable, :state => :redeemable
12
- scope :expired, :state => :expired
13
- scope :maxed_out, :state => :maxed_out
14
-
15
- # @return [Pager<Redemption>, []] A pager that yields Redemptions
16
- has_many :redemptions
17
-
18
- # @return [Pager<Coupon>, []] A pager that yields coupon-code type Coupons
19
- has_many :unique_coupon_codes, class_name: :Coupon
20
-
21
- define_attribute_methods %w(
22
- id
23
- coupon_code
24
- name
25
- state
26
- discount_type
27
- discount_percent
28
- discount_in_cents
29
- redeem_by_date
30
- single_use
31
- applies_for_months
32
- duration
33
- temporal_unit
34
- temporal_amount
35
- max_redemptions
36
- max_redemptions_per_account
37
- applies_to_all_plans
38
- created_at
39
- updated_at
40
- plan_codes
41
- description
42
- invoice_description
43
- applies_to_non_plan_charges
44
- redemption_resource
45
- coupon_type
46
- unique_template_code
47
- free_trial_amount
48
- free_trial_unit
49
- )
50
- alias to_param coupon_code
51
-
52
- # Redeem a coupon with a given account or account code.
53
- #
54
- # @return [true]
55
- # @param account_or_code [Account, String]
56
- # @param currency [String] Three-letter currency code
57
- # @param extra_opts [Hash] extra options that go into the {Redemption}
58
- # @example
59
- # coupon = Coupon.find(coupon_code)
60
- # coupon.redeem(account_code, 'USD', subscription_uuid: 'ab3b1dbabc3195')
61
- #
62
- # coupon = Coupon.find(coupon_code)
63
- # account = Account.find(account_code)
64
- # coupon.redeem(account)
65
- def redeem account_or_code, currency = nil, extra_opts={}
66
- return false unless link? :redeem
67
-
68
- account_code = if account_or_code.is_a? Account
69
- account_or_code.account_code
70
- else
71
- account_or_code
72
- end
73
-
74
- redemption_options = {
75
- :account_code => account_code,
76
- :currency => currency || Recurly.default_currency
77
- }.merge(extra_opts)
78
-
79
- redemption = Redemption.new(redemption_options)
80
-
81
- Redemption.from_response follow_link(:redeem,
82
- :body => redemption.to_xml
83
- )
84
- rescue API::UnprocessableEntity => e
85
- redemption.apply_errors e
86
- redemption
87
- end
88
-
89
- # Generate unique coupon codes on the server. This is based on the unique_template_code.
90
- #
91
- # @param amount [Integer]
92
- # @return [Pager<Coupon>] A pager that yields the coupon-code type Coupons
93
- # @example
94
- # unique_codes = coupon.generate(10)
95
- # unique_codes.each do |c|
96
- # puts c.coupon_code
97
- # end
98
- def generate(amount)
99
- builder = XML.new("<coupon/>")
100
- builder.add_element 'number_of_unique_codes', amount
101
-
102
- resp = follow_link(:generate,
103
- :body => builder.to_s
104
- )
105
-
106
- Pager.new(Recurly::Coupon, uri: resp['location'], parent: self, etag: resp['ETag'])
107
- end
108
-
109
- # Redeem a coupon on the given account code
110
- #
111
- # @param account_code [String] Acccount's account code
112
- # @param currency [String] Three-letter currency code
113
- # @raise [Invalid] If the coupon cannot be redeemed
114
- # @return [Redemption] The Coupon Redemption
115
- def redeem!(account_code, currency = nil)
116
- redemption = redeem(account_code, currency)
117
- raise Invalid.new(self) unless redemption && redemption.persisted?
118
- redemption
119
- end
120
-
121
- # Restores the coupon
122
- def restore!
123
- return false unless link? :restore
124
- reload follow_link(:restore, body: self.to_xml(delta: true))
125
- end
126
-
127
- # Will return true if there are no limits on number of redemptions for this Coupon.
128
- #
129
- # @return [true, false]
130
- def unlimited_redemptions_per_account?
131
- !max_redemptions_per_account
132
- end
133
- end
134
- end
@@ -1,28 +0,0 @@
1
- module Recurly
2
- class CreditPayment < Resource
3
- # @return [Account, nil]
4
- belongs_to :account, class_name: :Account, readonly: true
5
-
6
- # @return [Invoice, nil]
7
- has_one :original_invoice, class_name: :Invoice, readonly: true
8
-
9
- # @return [Invoice, nil]
10
- has_one :applied_to_invoice, class_name: :Invoice, readonly: true
11
-
12
- define_attribute_methods %w(
13
- action
14
- amount_in_cents
15
- currency
16
- created_at
17
- original_credit_payment
18
- refund_transaction
19
- updated_at
20
- uuid
21
- voided_at
22
- )
23
- alias to_param uuid
24
-
25
- # @return ["charge", "credit", nil] The type of credit payment.
26
- attr_reader :type
27
- end
28
- end
@@ -1,15 +0,0 @@
1
- module Recurly
2
- # Recurly Documentation: https://dev.recurly.com/docs/custom-fields
3
- class CustomField < Resource
4
-
5
- define_attribute_methods %w(
6
- name
7
- value
8
- )
9
-
10
- # include the name with the serialized field, even though it can't change
11
- def xml_keys
12
- attributes.keys
13
- end
14
- end
15
- end
@@ -1,19 +0,0 @@
1
- module Recurly
2
- # Delivery objects are only used with GiftCards.
3
- #
4
- # Recurly Documentation: https://dev.recurly.com/docs/gift-card-object
5
- class Delivery < Resource
6
- # @return [Address, nil]
7
- has_one :address
8
-
9
- define_attribute_methods %w(
10
- deliver_at
11
- email_address
12
- first_name
13
- gifter_name
14
- last_name
15
- method
16
- personal_message
17
- )
18
- end
19
- end
data/lib/recurly/error.rb DELETED
@@ -1,13 +0,0 @@
1
- module Recurly
2
- # The exception class from which all Recurly exceptions inherit.
3
- class Error < StandardError
4
- def set_message message
5
- @message = message
6
- end
7
-
8
- # @return [String]
9
- def to_s
10
- defined? @message and @message or super
11
- end
12
- end
13
- end
@@ -1,79 +0,0 @@
1
- module Recurly
2
- class GiftCard < Resource
3
- # @return [Invoice, nil]
4
- belongs_to :invoice
5
-
6
- # @return [Account, nil] The Account belonging to the gifter
7
- belongs_to :gifter_account, class_name: :Account, readonly: false
8
-
9
- # @return [Account, nil] The Account belonging to the recipient of the gift
10
- belongs_to :recipient_account, class_name: :Account, readonly: false
11
-
12
- # @return [Delivery, nil] Delivery information of the recipient.
13
- has_one :delivery, class_name: :Delivery, readonly: false
14
-
15
- # @return [Invoice, nil] The credit invoice for the gift card redemption.
16
- has_one :redemption_invoice, class_name: :Invoice, readonly: true
17
-
18
- # @return [Invoice, nil] The charge invoice for the gift card redemption.
19
- has_one :purchase_invoice, class_name: :Invoice, readonly: true
20
-
21
- define_attribute_methods %w(
22
- balance_in_cents
23
- currency
24
- created_at
25
- delivered_at
26
- id
27
- product_code
28
- redeemed_at
29
- redemption_code
30
- unit_amount_in_cents
31
- updated_at
32
- canceled_at
33
- )
34
- alias to_param id
35
-
36
- # Preview a GiftCard given some attributes
37
- #
38
- # @param [Hash] attributes for the gift card
39
- # @return [GiftCard] The resulting preview GiftCard
40
- def self.preview(attributes = {})
41
- new(attributes) { |record| record.preview }
42
- end
43
-
44
- # Preview the GiftCard. Runs and validates the GiftCard but
45
- # does not persist it. Errors are applied to the GiftCard if there
46
- # are any errors.
47
- def preview
48
- clear_errors
49
- @response = API.send(:post, "#{path}/preview", to_xml)
50
- reload response
51
- rescue API::UnprocessableEntity => e
52
- apply_errors e
53
- end
54
-
55
- # Redeem this GiftCard on the given account.
56
- #
57
- # @param [String] Recipient's account code
58
- def redeem(recipient_account_code)
59
- clear_errors
60
- xml = <<-XML
61
- <recipient_account>
62
- <account_code>#{recipient_account_code}</account_code>
63
- </recipient_account>
64
- XML
65
- @response = API.send(:post, "#{self.class.collection_path}/#{redemption_code}/redeem", xml)
66
- reload response
67
- rescue API::UnprocessableEntity => e
68
- apply_errors e
69
- end
70
-
71
- private
72
-
73
- def xml_keys
74
- keys = super
75
- keys << 'redemption_code' if redemption_code? && !redemption_code_changed?
76
- keys.sort
77
- end
78
- end
79
- end
@@ -1,51 +0,0 @@
1
- module Recurly
2
- module Helper
3
- def camelize underscored_word
4
- underscored_word.to_s.gsub(/(?:^|_)(.)/) { $1.upcase }
5
- end
6
-
7
- def classify table_name
8
- camelize singularize(table_name.to_s.sub(/.*\./, ''))
9
- end
10
-
11
- def demodulize class_name_in_module
12
- class_name_in_module.to_s.sub(/^.*::/, '')
13
- end
14
-
15
- def pluralize word
16
- word.to_s.sub(/([^s])$/, '\1s')
17
- end
18
-
19
- def singularize word
20
- word = word.to_s
21
- return word if word.end_with?('address')
22
- return "shipping_address" if word == "shipping_addresses"
23
- word.sub(/s$/, '').sub(/ie$/, 'y')
24
- end
25
-
26
- def underscore camel_cased_word
27
- word = camel_cased_word.to_s.dup
28
- word.gsub!(/::/, '/')
29
- word.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
30
- word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
31
- word.tr! "-", "_"
32
- word.downcase!
33
- word
34
- end
35
-
36
- def hash_with_indifferent_read_access base = {}
37
- indifferent = Hash.new { |hash, key| hash[key.to_s] if key.is_a? Symbol }
38
- base.each_pair { |key, value| indifferent[key.to_s] = value }
39
- indifferent
40
- end
41
-
42
- def stringify_keys! hash
43
- hash.keys.each do |key|
44
- stringify_keys! hash[key] if hash[key].is_a? Hash
45
- hash[key.to_s] = hash.delete key if key.is_a? Symbol
46
- end
47
- end
48
-
49
- extend self
50
- end
51
- end