recurly 2.9.3 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: '0810dfb4e91991de5ea68776f877db4961e0fe4e5b27897edc1fd2a13a1e32b5'
-  data.tar.gz: d7da1593f6ebacbea835751fe68cd639fac7918b4888727e73041a46ea8e6927
+SHA1:
+  metadata.gz: 2b2f5ee6a8f39d65f8f8b7bf0e7e28dc8fbfe5f7
+  data.tar.gz: 87bb6b057dd79daa33251094d2be8b4cf9030c80
 SHA512:
-  metadata.gz: 2d28a5665bae1cb32d4193769f72c6f08d57674002bdbeba4a279e8ef6931f974c00f9b15a77ac1cf444120e6a770b9247c9d63e3ab20b038515557e0732bb92
-  data.tar.gz: 77d7119a631d9c6e0091354852fdd61dfe71b72983776ffe3c46616713db89276dd4b0a98948484489ab439bdc8f3a385250fbcc79e57d938f178b7c7bdebcf5
+  metadata.gz: 44074d5b0f6e35dadb1a0d442be7f071b1f5a8466e838163afcb73cb9901f0b5ba5821916e2e1cd26c806f618940bbd1f2a32ced62610016cb86ba50dd76e875
+  data.tar.gz: '049c7dd6465aba53105a3d5d279d8a5cb9298dabb52be3c682020c0db665fce2e964b37a8fd21036d98226a9bd3b642b2902a294f29914b29a82ecf316dff170'

data/README.md

@@ -14,7 +14,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.9.2'
+gem 'recurly', '~> 2.10.0'
 ```
 
 Recurly will automatically use [Nokogiri](http://nokogiri.org/) (for a nice

data/lib/recurly.rb

@@ -30,6 +30,7 @@ module Recurly
   require 'recurly/xml'
   require 'recurly/delivery'
   require 'recurly/gift_card'
+  require 'recurly/purchase'
   require 'recurly/webhook'
 
   @subdomain = nil
@@ -86,8 +87,6 @@ module Recurly
     end
 
     # Assigns a logger to log requests/responses and more.
-    # The logger can only be set if the environment variable
-    # `RECURLY_INSECURE_DEBUG` equals `true`.
     #
     # @return [Logger, nil]
     # @example
@@ -99,22 +98,6 @@ module Recurly
     #   Recurly.logger = nil # Or Recurly.logger = Logger.new nil
     attr_accessor :logger
 
-    def logger=(logger)
-      if ENV['RECURLY_INSECURE_DEBUG'].to_s.downcase == 'true'
-        @logger = logger
-        puts <<-MSG
-        [WARNING] Recurly logger enabled. The logger has the potential to leak
-        PII and should never be used in production environments.
-        MSG
-      else
-        puts <<-MSG
-        [WARNING] Recurly logger has been disabled. If you wish to use it,
-        only do so in a non-production environment and make sure
-        the `RECURLY_INSECURE_DEBUG` environment variable is set to `true`.
-        MSG
-      end
-    end
-
     # Convenience logging method includes a Logger#progname dynamically.
     # @return [true, nil]
     def log level, message

data/lib/recurly/account.rb

@@ -17,7 +17,7 @@ module Recurly
     has_many :subscriptions
     has_many :transactions
     has_many :redemptions
-    has_many :shipping_addresses, resource_class: :ShippingAddress, readonly: false
+    has_many :shipping_addresses, readonly: false
 
     # @return [BillingInfo, nil]
     has_one :billing_info, :readonly => false

data/lib/recurly/api.rb

@@ -15,9 +15,8 @@ module Recurly
     require 'recurly/api/errors'
 
     @@base_uri = "https://api.recurly.com/v2/"
-    @@valid_domains = [".recurly.com"]
 
-    RECURLY_API_VERSION = '2.5'
+    RECURLY_API_VERSION = '2.6'
 
     FORMATS = Helper.hash_with_indifferent_read_access(
       'pdf' => 'application/pdf',
@@ -76,13 +75,6 @@ module Recurly
         URI.parse @@base_uri.sub('api', Recurly.subdomain)
       end
 
-      def validate_uri!(uri)
-        domain = @@valid_domains.detect { |d| uri.host.end_with?(d) }
-        unless domain
-          raise ArgumentError, "URI #{uri} is invalid. You may only make requests to a Recurly domain."
-        end
-      end
-
       # @return [String]
       def user_agent
         "Recurly/#{Version}; #{RUBY_DESCRIPTION}"

data/lib/recurly/api/net_http_adapter.rb

@@ -43,7 +43,6 @@ module Recurly
             }
             uri += "?#{pairs.join '&'}"
           end
-          self.validate_uri!(uri)
           request = METHODS[method].new uri.request_uri, head
           request.basic_auth(*[Recurly.api_key, nil].flatten[0, 2])
           if options[:body]

data/lib/recurly/invoice.rb

@@ -18,7 +18,7 @@ module Recurly
     # @return [Subscription]
     belongs_to :subscription
     # @return [Invoice]
-    belongs_to :original_invoice, class_name: 'Invoice'
+    belongs_to :original_invoice, class_name: :Invoice
 
     # This will only be present if the invoice has > 500 line items
     # @return [Adjustment]

data/lib/recurly/plan.rb

@@ -29,9 +29,21 @@ module Recurly
       setup_fee_revenue_schedule_type
       tax_exempt
       tax_code
+      trial_requires_billing_info
       created_at
       updated_at
     )
     alias to_param plan_code
+
+    #TODO this can be removed after the server update
+    def trial_requires_billing_info
+      val = read_attribute(:trial_requires_billing_info)
+      case val
+      when String
+        val == 'true'
+      else
+        val
+      end
+    end
   end
 end

data/lib/recurly/purchase.rb

@@ -0,0 +1,131 @@
+module Recurly
+  # The Purchase object works a slightly differently than the rest of the models.
+  # You build up the purchase data into an object then pass to either:
+  # {Purchase.invoice!} or {Purchase.preview!} and it will
+  # return an {Invoice}.
+  #
+  # You can build your purchase object with a new account or an existing account.
+  # For an existing account, you just need an account_code:
+  #   Recurly::Purchase.new({account: {account_code: 'myexistingaccount'}})
+  # or
+  #   account = Recurly::Account.find('existing_account')
+  #   Recurly::Purchase.new({account: account})
+  # or
+  #   account = Recurly::Account.find('existing_account')
+  #   purchase = Recurly::Purchase.new
+  #   purchase.account = account
+  #
+  # For a new account, you can pass in {Account} data, {BillingInfo} data, etc
+  # in the same way you would when creating a {Subscription} with a new account.
+  #
+  # You can also pass in adjustments and invoicing data to be passed to the invoice.
+  # Here is an example of a Purchase with a new account:
+  #   require 'securerandom'
+  #
+  #   purchase = Recurly::Purchase.new({
+  #     currency: 'USD',
+  #     collection_method: :automatic,
+  #     account: {
+  #       account_code: SecureRandom.uuid,
+  #       billing_info: {
+  #         first_name: 'Benjamin',
+  #         last_name: 'Du Monde',
+  #         address1: '400 Alabama St',
+  #         city: 'San Francisco',
+  #         state: 'CA',
+  #         zip: '94110',
+  #         country: 'US',
+  #         number: '4111-1111-1111-1111',
+  #         month: 12,
+  #         year: 2019,
+  #       }
+  #     },
+  #     adjustments: [
+  #       {
+  #          product_code: 'product_1',
+  #          unit_amount_in_cents: 1000,
+  #          quantity: 1,
+  #          revenue_schedule_type: :at_invoice
+  #       },
+  #       {
+  #         product_code: 'product_2'
+  #         unit_amount_in_cents: 3000,
+  #         quantity: 5,
+  #         revenue_schedule_type: :at_invoice
+  #       }
+  #     ]
+  #   })
+  #
+  #   begin
+  #     preview_invoice = Recurly::Purchase.invoice!(purchase)
+  #     puts preview_invoice.inspect
+  #   rescue Recurly::Resource::Invalid => e
+  #     # Invalid data
+  #   end
+  #
+  #   begin
+  #     invoice = Recurly::Purchase.invoice!(purchase)
+  #   rescue Recurly::Resource::Invalid => e
+  #     # Invalid data
+  #   rescue Recurly::Transaction::DeclinedError => e
+  #     # Display e.message and/or subscription (and associated) errors...
+  #   rescue Recurly::Transaction::RetryableError => e
+  #     # You should be able to attempt to save this again later.
+  #   rescue Recurly::Transaction::Error => e
+  #     # Fallback transaction error
+  #     # e.transaction
+  #     # e.transaction_error_code
+  #   end
+  #
+  class Purchase < Resource
+    # @return [[Adjustment], nil]
+    has_many :adjustments, class_name: :Adjustment, readonly: false
+
+    # @return [Account, nil]
+    has_one :account, readonly: false
+
+    define_attribute_methods %w(
+      currency
+      collection_method
+      po_number
+      net_terms
+    )
+
+    class << self
+
+      # Generate an invoice for the purchase and run any needed transactions
+      #
+      # @param purchase [Purchase] The purchase data for the request
+      # @return [Invoice] The new invoice representing this purchase
+      # @raise [Invalid] Raised if the account cannot be invoiced.
+      # @raise [Transaction::Error] Raised if the transaction failed
+      def invoice!(purchase)
+        post(purchase, collection_path)
+      end
+
+      # Generate a preview invoice for the purchase. Runs validations
+      # but does not run any transactions.
+      #
+      # @param purchase [Purchase] The purchase data for the request
+      # @return [Invoice] The new invoice representing this purchase
+      # @raise [Invalid] Raised if the account cannot be invoiced.
+      def preview!(purchase)
+        post(purchase, "#{collection_path}/preview")
+      end
+
+      def post(purchase, path)
+        response = API.send(:post, path, purchase.to_xml)
+        Invoice.from_response(response)
+      rescue API::UnprocessableEntity => e
+        purchase.apply_errors(e)
+        Transaction::Error.validate!(e, nil)
+        raise Resource::Invalid.new(purchase)
+      end
+    end
+
+    # This object does not represent a model on the server side
+    # so we do not need to expose thses methods.
+    protected(*%w(save save!))
+    private_class_method(*%w(all find_each first paginate scoped where post create! create))
+  end
+end

data/lib/recurly/resource.rb

@@ -163,7 +163,6 @@ module Recurly
       end
     end
 
-
     class << self
       # @return [String] The demodulized name of the resource class.
       # @example
@@ -336,8 +335,9 @@ module Recurly
           raise NotFound, "can't find a record with nil identifier"
         end
 
+        uri = uuid =~ /^http/ ? uuid : member_path(uuid)
         begin
-          from_response API.get(member_path(uuid), {}, options)
+          from_response API.get(uri, {}, options)
         rescue API::NotFound => e
           raise NotFound, e.description
         end
@@ -509,7 +509,7 @@ module Recurly
       # @param collection_name [Symbol] Association name.
       # @param options [Hash] A hash of association options.
       # @option options [true, false] :readonly Don't define a setter.
-      #                 [String] :resource_class Actual associated resource class name
+      #                 [String] :class_name Actual associated resource class name
       #                                      if not same as collection_name.
       def has_many(collection_name, options = {})
         associations << Association.new(:has_many, collection_name.to_s, options)
@@ -535,7 +535,7 @@ module Recurly
       # @param member_name [Symbol] Association name.
       # @param options [Hash] A hash of association options.
       # @option options [true, false] :readonly Don't define a setter.
-      #                 [String] :resource_class Actual associated resource class name
+      #                 [String] :class_name Actual associated resource class name
       #                                      if not same as member_name.
       def has_one(member_name, options = {})
         associations << Association.new(:has_one, member_name.to_s, options)
@@ -573,7 +573,7 @@ module Recurly
       # @param parent_name [Symbol] Association name.
       # @param options [Hash] A hash of association options.
       # @option options [true, false] :readonly Don't define a setter.
-      #                 [String] :resource_class Actual associated resource class name
+      #                 [String] :class_name Actual associated resource class name
       #                                      if not same as parent_name.
       def belongs_to(parent_name, options = {})
         associations << Association.new(:belongs_to, parent_name.to_s, options)
@@ -634,12 +634,9 @@ module Recurly
         return if response.body.to_s.length.zero?
         fresh = self.class.from_response response
       else
-        options = {:etag => (etag unless changed?)}
-        fresh = if @href
-                  self.class.from_response API.get(@href, {}, options)
-                else
-                  self.class.find(to_param, options)
-                end
+        fresh = self.class.find(
+          @href || to_param, :etag => (etag unless changed?)
+        )
       end
       fresh and copy_from fresh
       persist! true
@@ -849,7 +846,7 @@ module Recurly
       if new_record? || changed?
         clear_errors
         @response = API.send(
-          persisted? ? :put : :post, path, to_xml(:delta => true)
+          persisted? ? :put : :post, path, to_xml
         )
         reload response
         persist! true
@@ -1026,6 +1023,15 @@ module Recurly
     end
     alias to_s inspect
 
+    def apply_errors(exception)
+      @response = exception.response
+      document = XML.new exception.response.body
+      document.each_element 'error' do |el|
+        attribute_path = el.attribute('field').value.split '.'
+        invalid! attribute_path[1, attribute_path.length], el.text
+      end
+    end
+
     protected
 
     def path
@@ -1064,23 +1070,17 @@ module Recurly
       end
     end
 
-    def apply_errors(exception)
-      @response = exception.response
-      document = XML.new exception.response.body
-      document.each_element 'error' do |el|
-        attribute_path = el.attribute('field').value.split '.'
-        invalid! attribute_path[1, attribute_path.length], el.text
-      end
-    end
-
     private
 
-    def fetch_associated(name, value)
+    def fetch_associated(name, value, options = {})
       case value
       when Array
-        value.map { |each| fetch_associated(Helper.singularize(name), each) }
+        value.map do |v|
+          fetch_associated(Helper.singularize(name), v, association_name: name)
+        end
       when Hash
-        associated_class_name = self.class.find_association(name).class_name
+        association_name = options[:association_name] || name
+        associated_class_name = self.class.find_association(association_name).class_name
         associated_class_name ||= Helper.classify(name)
         Recurly.const_get(associated_class_name, false).send(:new, value)
       when Proc, Resource, Resource::Pager, nil

data/lib/recurly/resource/pager.rb

@@ -65,7 +65,7 @@ module Recurly
         @uri    = options.delete :uri
         @etag   = options.delete :etag
         @resource_class, @options = resource_class, options
-        @collection = @count = nil
+        @collection = nil
       end
 
       # @return [Boolean] whether or not the xml element is present
@@ -81,7 +81,7 @@ module Recurly
       # @return [Integer] The total record count of the resource in question.
       # @see Resource.count
       def count
-        @count ||= API.head(uri, @options)['X-Records'].to_i
+        API.head(uri, @options)['X-Records'].to_i
       end
 
       # @return [Array] Iterates through the current page of records.
@@ -134,7 +134,7 @@ module Recurly
       #   Recurly::Account.active.paginate :per_page => 20
       def paginate options = {}
         dup.instance_eval {
-          @collection = @count = @etag = nil
+          @collection = @etag = nil
           @options = @options.merge options
           self
         }
@@ -220,7 +220,6 @@ module Recurly
         response = API.get uri, params, options
 
         @etag = response['ETag']
-        @count = response['X-Records'].to_i
         @links = {}
         if links = response['Link']
           links.scan(/<([^>]+)>; rel="([^"]+)"/).each do |link, rel|

data/lib/recurly/subscription.rb

@@ -73,6 +73,7 @@ module Recurly
       timeframe
       started_with_gift
       converted_at
+      no_billing_info_reason
     )
     alias to_param uuid
 

data/lib/recurly/transaction.rb

@@ -21,7 +21,7 @@ module Recurly
     belongs_to :subscription
 
     # @return [Transaction, nil]
-    has_one :original_transaction, class_name: 'Transaction', readonly: true
+    has_one :original_transaction, class_name: :Transaction, readonly: true
 
     define_attribute_methods %w(
       id

data/lib/recurly/version.rb

@@ -1,8 +1,8 @@
 module Recurly
   module Version
     MAJOR   = 2
-    MINOR   = 9
-    PATCH   = 3
+    MINOR   = 10
+    PATCH   = 0
     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.9.3
+  version: 2.10.0
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-09 00:00:00.000000000 Z
+date: 2017-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 11.1.0
+        version: '11.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 11.1.0
+        version: '11.3'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -171,6 +171,7 @@ files:
 - lib/recurly/measured_unit.rb
 - lib/recurly/money.rb
 - lib/recurly/plan.rb
+- lib/recurly/purchase.rb
 - lib/recurly/redemption.rb
 - lib/recurly/resource.rb
 - lib/recurly/resource/association.rb
@@ -238,7 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Recurly API Client