recurly 2.4.5 → 2.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9129e582c2f343662f42f02a850f10a2c8171aa9
-  data.tar.gz: a038472ed54dbe931172bbb2a8cc562492e0cf1f
+  metadata.gz: 972f95d54db4267cb3a761d4ca74c95e79eb8df3
+  data.tar.gz: 61d5fb37a103b1551f19562b1e71600b1ceffa00
 SHA512:
-  metadata.gz: 44df4de6338077fcf0e7773fd75d41d927722f46a38415475d47217e2e0be79dfdeb27b67d401a6fb88a3a395861eb5db7d22fc25000004ac589c1352f7f85d4
-  data.tar.gz: e57590648287086676edf3e884ceeaca561483b65451b3da9eca251d9efddad85c0aae814724abf710ad3b8cf0a84dcad970780f3c626cc54e0589734b7b5d0b
+  metadata.gz: 65cf967a326482f1c394289957c670119480797e5864aad3d149c1e2cb305437738dd3f3e3849c61e7d349029dd0bdf9002e2420d6a20646f1d395f4d7c6a098
+  data.tar.gz: c94dc16a2010ed26dc803e7bf6f0f7f29c1608f23c0e9f842d192d50a1f1dda3aba44638e347a4dd19ef6a20392b526a2d036cfebd6ce015714c85419f6ac4b9

data/README.md

@@ -2,8 +2,8 @@
 
 <https://github.com/recurly/recurly-client-ruby>
 
-[Recurly](http://recurly.com/)'s Ruby client library is an interface to its
-[REST API](http://docs.recurly.com/api/basics).
+[Recurly](https://recurly.com/)'s Ruby client library is an interface to its
+[REST API](https://dev.recurly.com/docs/getting-started).
 
 
 ## Installation
@@ -12,7 +12,7 @@ Recurly is packaged as a Ruby gem. We recommend you install it with
 [Bundler](http://gembundler.com/) by adding the following line to your Gemfile:
 
 ``` ruby
-gem 'recurly', '~> 2.4.5'
+gem 'recurly', '~> 2.4.6'
 ```
 
 Recurly will automatically use [Nokogiri](http://nokogiri.org/) (for a nice
@@ -38,7 +38,7 @@ Recurly.api_key        = ENV['RECURLY_API_KEY']
 Configure the client library with
 [your API credentials](https://app.recurly.com/go/developer/api_access).
 
-* `RECURLY_SUBDOMAIN` should contain subdomain for your recurly account. 
+* `RECURLY_SUBDOMAIN` should contain subdomain for your recurly account.
 * `RECURLY_API_KEY` is your "Private API Key" which can be found under "API Credentials" on the `api_access` admin page.
 
 The default currency is USD. To override with a different code:
@@ -47,13 +47,15 @@ The default currency is USD. To override with a different code:
 Recurly.default_currency = 'EUR' # Assign nil to disable the default entirely.
 ```
 
-If you are using [Recurly.js](https://js.recurly.com) you can store "Public API Key" (which can be found under "API Credentials" on the `api_access` admin page):
+If you are using [Recurly.js](https://js.recurly.com) you can store "Public API Key" (which can be found
+under "API Credentials" on the `api_access` admin page):
 
 ``` ruby
 Recurly.js.public_key = ENV['RECURLY_PUBLIC_API_KEY']
 ```
 
-Then, in your Rails project you can create `recurly_service.js.erb` file and [configure](https://docs.recurly.com/js/#configure) recurly.js with public key this way:
+Then, in your Rails project you can create `recurly_service.js.erb` file and
+[configure](https://docs.recurly.com/js/#configure) recurly.js with public key this way:
 
 ``` js
 recurly.configure({ publicKey: '<%= Recurly.js.public_key %>'});
@@ -70,7 +72,8 @@ Recurly::API.net_http = {
 ```
 
 ## Multi-Threaded Configuration
-If you are using the client in a multi-threaded environment and require a different configuration per thread you can use the following within the thread's context:
+If you are using the client in a multi-threaded environment and require a different configuration per
+thread you can use the following within the thread's context:
 
 ``` ruby
 Recurly.config({
@@ -81,14 +84,15 @@ Recurly.config({
 })
 ```
 
-Any configuration items you do not include in the above config call will be defaulted to the standard configuration items.   For example if you do not define default_currency then
-Recurly.default_currency will be used.
+Any configuration items you do not include in the above config call will be defaulted to the standard
+configuration items. For example if you do not define default_currency then Recurly.default_currency
+will be used.
 
 
 ## Usage
 
 Instructions and examples are available on
-[Recurly's documentation site](http://docs.recurly.com/api/basics).
+[Recurly's documentation site](https://dev.recurly.com/docs/getting-started).
 
 Recurly's gem API is available
 [here](http://rubydoc.info/gems/recurly/frames/Recurly).
@@ -107,9 +111,8 @@ Recurly's gem API is available
 
 Developing for the Recurly gem is easy with [Bundler](http://gembundler.com/).
 
-Fork and clone the repository, `cd` into the directory, and, with a Ruby of
-your choice (1.9.3 or greater), set up your
-environment.
+Fork and clone the repository, `cd` into the directory, and, with a Ruby of your choice
+(1.9.3 or greater), set up your environment.
 
 If you don't have Bundler installed, install it with the following command:
 
@@ -138,8 +141,7 @@ $ XML=nokogiri bundle exec rake
 If you plan on submitting a patch, please write tests for it (we use
 [MiniTest::Spec](http://bfts.rubyforge.org/minitest/MiniTest/Expectations.html)).
 
-If everything looks good, submit a pull request on GitHub and we'll bring in
-your changes.
+If everything looks good, submit a pull request on GitHub and we'll bring in your changes.
 
 ## License
 

data/lib/recurly/account.rb

@@ -20,8 +20,11 @@ module Recurly
     # @return [BillingInfo, nil]
     has_one :billing_info, :readonly => false
 
-    # @return [Redemption, nil]
-    has_one :redemption
+    has_many :redemptions
+
+    def redemption
+      redemptions.first
+    end
 
     define_attribute_methods %w(
       account_code
@@ -38,6 +41,7 @@ module Recurly
       tax_exempt
       entity_use_code
       created_at
+      closed_at
       vat_location_valid
     )
     alias to_param account_code

data/lib/recurly/api.rb

@@ -16,6 +16,8 @@ module Recurly
 
     @@base_uri = "https://api.recurly.com/v2/"
 
+    RECURLY_API_VERSION = '2.1'
+
     FORMATS = Helper.hash_with_indifferent_read_access(
       'pdf' => 'application/pdf',
       'xml' => 'application/xml'
@@ -25,7 +27,7 @@ module Recurly
       # Additional HTTP headers sent with each API call
       # @return [Hash{String => String}]
       def headers
-        @headers ||= { 'Accept' => accept, 'User-Agent' => user_agent }
+        @headers ||= { 'Accept' => accept, 'User-Agent' => user_agent, 'X-Api-Version' => RECURLY_API_VERSION }
       end
 
       # @return [String, nil] Accept-Language header value

data/lib/recurly/coupon.rb

@@ -24,11 +24,14 @@ module Recurly
       temporal_unit
       temporal_amount
       max_redemptions
+      max_redemptions_per_account
       applies_to_all_plans
       created_at
       plan_codes
       description
       invoice_description
+      applies_to_non_plan_charges
+      redemption_resource
     )
     alias to_param coupon_code
 
@@ -46,14 +49,16 @@ module Recurly
     #
     # @return [true]
     # @param account_or_code [Account, String]
+    # @param currency [String]
+    # @param opts [Hash]
     # @example
     #   coupon = Coupon.find coupon_code
-    #   coupon.redeem account_code
+    #   coupon.redeem account_code, 'USD', subscription_uuid: 'ab3b1dbabc3195'
     #
     #   coupon = Coupon.find coupon_code
     #   account = Account.find account_code
     #   coupon.redeem account
-    def redeem account_or_code, currency = nil
+    def redeem account_or_code, currency = nil, extra_opts={}
       return false unless link? :redeem
 
       account_code = if account_or_code.is_a? Account
@@ -62,11 +67,15 @@ module Recurly
         account_or_code
       end
 
+      redemption_options = {
+        :account_code => account_code,
+        :currency     => currency || Recurly.default_currency
+      }.merge(extra_opts)
+
+      redemption = redemptions.new(redemption_options)
+
       Redemption.from_response follow_link(:redeem,
-        :body => (redemption = redemptions.new(
-          :account_code => account_code,
-          :currency     => currency || Recurly.default_currency
-        )).to_xml
+        :body => redemption.to_xml
       )
     rescue API::UnprocessableEntity => e
       redemption.apply_errors e
@@ -78,5 +87,9 @@ module Recurly
       raise Invalid.new(self) unless redemption.persisted?
       redemption
     end
+
+    def unlimited_redemptions_per_account?
+      !max_redemptions_per_account
+    end
   end
 end

data/lib/recurly/invoice.rb

@@ -21,7 +21,11 @@ module Recurly
     belongs_to :original_invoice, class_name: 'Invoice'
 
     # @return [Redemption]
-    has_one :redemption
+    has_many :redemptions
+
+    def redemption
+      redemptions.first
+    end
 
     def invoice_number_with_prefix
       "#{invoice_number_prefix}#{invoice_number}"
@@ -78,7 +82,7 @@ module Recurly
       reload follow_link :mark_failed
       true
     end
-    
+
     def enter_offline_payment(attrs={})
       Transaction.from_response API.post("#{uri}/transactions", attrs.empty? ? nil : Transaction.to_xml(attrs))
     rescue Recurly::API::UnprocessableEntity => e

data/lib/recurly/plan.rb

@@ -24,6 +24,7 @@ module Recurly
       trial_interval_unit
       total_billing_cycles
       accounting_code
+      setup_fee_accounting_code
       tax_exempt
       tax_code
       created_at

data/lib/recurly/redemption.rb

@@ -12,14 +12,26 @@ module Recurly
     # @return [Account]
     belongs_to :account, :readonly => false
 
+    # @return [Subscription]
+    belongs_to :subscription
+
+    # @return [Invoice]
+    belongs_to :invoice
+
     define_attribute_methods %w(
+      uuid
       single_use
       total_discounted_in_cents
       currency
       state
+      subscription_uuid
       created_at
     )
 
+    def destroy_uri
+      uri + "s/#{uuid}"
+    end
+
     def save
       return false if persisted?
       copy_from coupon.redeem account, currency

data/lib/recurly/resource.rb

@@ -283,8 +283,8 @@ module Recurly
       # @see Pager#find_each
       # @example
       #   Recurly::Account.find_each { |a| p a }
-      def find_each per_page = 50
-        paginate(:per_page => per_page).find_each(&Proc.new)
+      def find_each per_page = 50, &block
+        paginate(:per_page => per_page).find_each(&block)
       end
 
       # @return [Integer] The total record count of the resource in question.
@@ -909,12 +909,16 @@ module Recurly
     #   race_condition.destroy # raises Recurly::Resource::NotFound
     def destroy
       return false unless persisted?
-      @response = API.delete uri
+      @response = API.delete destroy_uri
       @destroyed = true
     rescue API::NotFound => e
       raise NotFound, e.description
     end
 
+    def destroy_uri
+      uri
+    end
+
     def signable_attributes
       Hash[xml_keys.map { |key| [key, self[key]] }]
     end

data/lib/recurly/subscription.rb

@@ -25,6 +25,9 @@ module Recurly
     # @return [Invoice]
     has_one :invoice
 
+    # @return [Redemption]
+    has_many :redemptions
+
     define_attribute_methods %w(
       uuid
       state
@@ -42,6 +45,7 @@ module Recurly
       pending_subscription
       subscription_add_ons
       coupon_code
+      coupon_codes
       total_billing_cycles
       remaining_billing_cycles
       net_terms
@@ -103,6 +107,16 @@ module Recurly
       attributes[:coupon] = coupon
     end
 
+    # Assign Coupon resources (rather than coupon codes).
+    #
+    # @param coupons [[Coupons]]
+    def coupons= coupons
+      self.coupon_codes = coupons.map do |coupon|
+        coupon.coupon_code if coupon.respond_to? :coupon_code
+      end.compact
+      attributes[:coupons] = coupons
+    end
+
     # @return [AddOns]
     def subscription_add_ons
       self[:subscription_add_ons] ||= AddOns.new self, super

data/lib/recurly/transaction/errors.rb

@@ -44,6 +44,10 @@ module Recurly
         xml.text '/errors/transaction_error/error_code'
       end
 
+      def gateway_error_code
+        xml.text '/errors/transaction_error/gateway_error_code'
+      end
+
       private
 
       def update_transaction transaction

data/lib/recurly/version.rb

@@ -2,7 +2,7 @@ module Recurly
   module Version
     MAJOR   = 2
     MINOR   = 4
-    PATCH   = 5
+    PATCH   = 6
     PRE     = nil
 
     VERSION = [MAJOR, MINOR, PATCH, PRE].compact.join('.').freeze

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 2.4.5
+  version: 2.4.6
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-31 00:00:00.000000000 Z
+date: 2015-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake