recurly 3.3.0 → 3.6.0

data/lib/recurly/connection_pool.rb

@@ -0,0 +1,40 @@
+require "net/https"
+
+module Recurly
+  class ConnectionPool
+    def initialize
+      @mutex = Mutex.new
+      @pool = []
+    end
+
+    def with_connection
+      http = nil
+      @mutex.synchronize do
+        http = @pool.pop
+      end
+
+      # create connection if the pool was empty
+      http ||= init_http_connection
+
+      response = yield http
+
+      if http.started?
+        @mutex.synchronize do
+          @pool.push(http)
+        end
+      end
+
+      response
+    end
+
+    def init_http_connection
+      http = Net::HTTP.new(Client::BASE_HOST, Client::BASE_PORT)
+      http.use_ssl = true
+      http.ca_file = Client::CA_FILE
+      http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      http.keep_alive_timeout = 600
+
+      http
+    end
+  end
+end

data/lib/recurly/errors.rb

@@ -17,6 +17,36 @@ module Recurly
         Errors.const_get(class_name)
       end
 
+      # When the response does not have a JSON body, this determines the appropriate
+      # Error class based on the response code. This may occur when a load balancer
+      # returns an error before it reaches Recurly's API.
+      # @param response [Net::Response]
+      # @return [Errors::APIError,Errors::NetworkError]
+      # rubocop:disable Metrics/CyclomaticComplexity
+      def self.from_response(response)
+        case response
+        when Net::HTTPBadRequest # 400
+          Recurly::Errors::BadRequestError
+        when Net::HTTPUnauthorized, Net::HTTPForbidden # 401, 403
+          Recurly::Errors::UnauthorizedError
+        when Net::HTTPRequestTimeOut # 408
+          Recurly::Errors::TimeoutError
+        when Net::HTTPTooManyRequests # 429
+          Recurly::Errors::RateLimitedError
+        when Net::HTTPInternalServerError # 500
+          Recurly::Errors::InternalServerError
+        when Net::HTTPServiceUnavailable # 503
+          Recurly::Errors::UnavailableError
+        when Net::HTTPGatewayTimeOut # 504
+          Recurly::Errors::TimeoutError
+        when Net::HTTPServerError # 5xx
+          Recurly::Errors::UnavailableError
+        else
+          Recurly::Errors::APIError
+        end
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
+
       def initialize(response, error)
         super(error.message)
         @response = response

data/lib/recurly/errors/network_errors.rb

@@ -1,8 +1,10 @@
 module Recurly
   module Errors
     class NetworkError < StandardError; end
+    class InvalidResponseError < NetworkError; end
     class TimeoutError < NetworkError; end
     class ConnectionFailedError < NetworkError; end
     class SSLError < NetworkError; end
+    class UnavailableError < NetworkError; end
   end
 end

data/lib/recurly/http.rb

@@ -4,16 +4,21 @@ module Recurly
       attr_accessor :status, :body, :request,
         :request_id, :rate_limit, :rate_limit_remaining,
         :rate_limit_reset, :date, :proxy_metadata,
-        :content_type
+        :content_type, :total_records
 
       def initialize(resp, request)
-        @request = request
-        @status = resp.status
-        @request_id = resp.headers["x-request-id"]
-        @rate_limit = resp.headers["x-ratelimit-limit"].to_i
-        @rate_limit_remaining = resp.headers["x-ratelimit-remaining"].to_i
-        @rate_limit_reset = Time.at(resp.headers["x-ratelimit-reset"].to_i).to_datetime
-        @content_type = resp.headers["content-type"].split(";").first if resp.headers["content-type"]
+        @request = Request.new(request.method, request.path, request.body)
+        @status = resp.code.to_i
+        @request_id = resp["x-request-id"]
+        @rate_limit = resp["x-ratelimit-limit"].to_i
+        @rate_limit_remaining = resp["x-ratelimit-remaining"].to_i
+        @rate_limit_reset = Time.at(resp["x-ratelimit-reset"].to_i).to_datetime
+        @total_records = resp["recurly-total-records"]&.to_i
+        if resp["content-type"]
+          @content_type = resp["content-type"].split(";").first
+        else
+          @content_type = resp.content_type
+        end
         if resp.body && !resp.body.empty?
           @body = resp.body
         else

data/lib/recurly/pager.rb

@@ -7,7 +7,25 @@ module Recurly
       @client = client
       @path = path
       @options = map_array_params(options)
-      @next = build_path(@path, @options)
+      rewind!
+    end
+
+    # Performs a request with the pager `limit` set to 1 and only returns the first
+    # result in the response.
+    def first
+      # Modify the @next url to set the :limit to 1
+      original_next = @next
+      @next = @path
+      fetch_next!(@options.merge(limit: 1))
+      # Restore the @next url to the original
+      @next = original_next
+      @data.first
+    end
+
+    # Makes a HEAD request to the API to determine how many total records exist.
+    def count
+      resource = @client.send(:head, self.next, @options)
+      resource.get_response.total_records
     end
 
     # Enumerates each "page" from the server.
@@ -84,7 +102,9 @@ module Recurly
     def page_enumerator
       Enumerator.new do |yielder|
         loop do
-          fetch_next!
+          # Pass in @options when requesting the first page (@data.empty?)
+          next_options = @data.empty? ? @options : {}
+          fetch_next!(next_options)
           yielder << data
           unless has_more?
             rewind!
@@ -94,8 +114,9 @@ module Recurly
       end
     end
 
-    def fetch_next!
-      page = @client.next_page(self)
+    def fetch_next!(options)
+      path = extract_path(self.next)
+      page = @client.send(:get, path, options)
       @data = page.data.map { |d| JSONParser.from_json(d) }
       @has_more = page.has_more
       @next = page.next
@@ -103,15 +124,13 @@ module Recurly
 
     def rewind!
       @data = []
-      @next = build_path(@path, @options)
+      @next = @path
     end
 
-    def build_path(path, options)
-      if options.empty?
-        path
-      else
-        "#{path}?#{URI.encode_www_form(options)}"
-      end
+    # Returns just the path and parameters so we can safely reuse the connection
+    def extract_path(uri_or_path)
+      uri = URI(uri_or_path)
+      uri.kind_of?(URI::HTTP) ? uri.request_uri : uri_or_path
     end
 
     # Converts array parameters to CSV strings to maintain consistency with
@@ -121,7 +140,7 @@ module Recurly
       @options = params.map do |key, param|
         new_param = param.is_a?(Array) ? param.join(",") : param
         [key, new_param]
-      end
+      end.to_h
     end
   end
 end

data/lib/recurly/requests/add_on_create.rb

@@ -7,7 +7,7 @@ module Recurly
     class AddOnCreate < Request
 
       # @!attribute accounting_code
-      #   @return [String] Accounting code for invoice line items for this add-on. If no value is provided, it defaults to add-on's code. If `item_code`/`item_id` is part of the request then `code` must be absent.
+      #   @return [String] Accounting code for invoice line items for this add-on. If no value is provided, it defaults to add-on's code. If `item_code`/`item_id` is part of the request then `accounting_code` must be absent.
       define_attribute :accounting_code, String
 
       # @!attribute code
@@ -15,7 +15,7 @@ module Recurly
       define_attribute :code, String
 
       # @!attribute currencies
-      #   @return [Array[AddOnPricing]] If `item_code`/`item_id` is part of the request and the item has a default currency then `currencies` is optional. If the item does not have a default currency, then `currencies` is required. If `item_code`/`item_id` is not present `currencies` is required.
+      #   @return [Array[AddOnPricing]] * If `item_code`/`item_id` is part of the request and the item has a default currency then `currencies` is optional. If the item does not have a default currency, then `currencies` is required. If `item_code`/`item_id` is not present `currencies` is required. * If the add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `currencies` must be absent.
       define_attribute :currencies, Array, { :item_type => :AddOnPricing }
 
       # @!attribute default_quantity
@@ -27,24 +27,40 @@ module Recurly
       define_attribute :display_quantity, :Boolean
 
       # @!attribute item_code
-      #   @return [String] Unique code to identify an item, when the `Catalog: Item Add-Ons` feature is enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
+      #   @return [String] Unique code to identify an item. Avaliable when the `Credit Invoices` and `Subscription Billing Terms` features are enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
       define_attribute :item_code, String
 
       # @!attribute item_id
-      #   @return [String] Available when the `Catalog: Item Add-Ons` feature is enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
+      #   @return [String] System-generated unique identifier for an item. Available when the `Credit Invoices` and `Subscription Billing Terms` features are enabled. If `item_id` and `item_code` are both present, `item_id` will be used.
       define_attribute :item_id, String
 
       # @!attribute name
-      #   @return [String] Describes your add-on and will appear in subscribers' invoices. If `item_code`/`item_id` is part of the request then `code` must be absent. If `item_code`/`item_id` is not present `code` is required.
+      #   @return [String] Describes your add-on and will appear in subscribers' invoices. If `item_code`/`item_id` is part of the request then `name` must be absent. If `item_code`/`item_id` is not present `name` is required.
       define_attribute :name, String
 
+      # @!attribute optional
+      #   @return [Boolean] Whether the add-on is optional for the customer to include in their purchase on the hosted payment page. If false, the add-on will be included when a subscription is created through the Recurly UI. However, the add-on will not be included when a subscription is created through the API.
+      define_attribute :optional, :Boolean
+
       # @!attribute plan_id
       #   @return [String] Plan ID
       define_attribute :plan_id, String
 
+      # @!attribute revenue_schedule_type
+      #   @return [String] When this add-on is invoiced, the line item will use this revenue schedule. If `item_code`/`item_id` is part of the request then `revenue_schedule_type` must be absent in the request as the value will be set from the item.
+      define_attribute :revenue_schedule_type, String
+
       # @!attribute tax_code
-      #   @return [String] Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`. If `item_code`/`item_id` is part of the request then `code` must be absent.
+      #   @return [String] Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`. If `item_code`/`item_id` is part of the request then `tax_code` must be absent.
       define_attribute :tax_code, String
+
+      # @!attribute tier_type
+      #   @return [String] The type of tiering used by the Add-on.
+      define_attribute :tier_type, String
+
+      # @!attribute tiers
+      #   @return [Array[Tier]] At least one tier is required if `tier_type` is not 'flat'.
+      define_attribute :tiers, Array, { :item_type => :Tier }
     end
   end
 end

data/lib/recurly/requests/add_on_update.rb

@@ -15,7 +15,7 @@ module Recurly
       define_attribute :code, String
 
       # @!attribute currencies
-      #   @return [Array[AddOnPricing]] Add-on pricing
+      #   @return [Array[AddOnPricing]] If the add-on's `tier_type` is `tiered`, `volume` or `stairstep`, then `currencies` must be absent.
       define_attribute :currencies, Array, { :item_type => :AddOnPricing }
 
       # @!attribute default_quantity
@@ -34,9 +34,21 @@ module Recurly
       #   @return [String] Describes your add-on and will appear in subscribers' invoices. If an `Item` is associated to the `AddOn` then `name` must be absent.
       define_attribute :name, String
 
+      # @!attribute optional
+      #   @return [Boolean] Whether the add-on is optional for the customer to include in their purchase on the hosted payment page. If false, the add-on will be included when a subscription is created through the Recurly UI. However, the add-on will not be included when a subscription is created through the API.
+      define_attribute :optional, :Boolean
+
+      # @!attribute revenue_schedule_type
+      #   @return [String] When this add-on is invoiced, the line item will use this revenue schedule. If an `Item` is associated to the `AddOn` then `revenue_schedule_type` must be absent in the request as the value will be set from the item.
+      define_attribute :revenue_schedule_type, String
+
       # @!attribute tax_code
       #   @return [String] Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`. If an `Item` is associated to the `AddOn` then `tax code` must be absent.
       define_attribute :tax_code, String
+
+      # @!attribute tiers
+      #   @return [Array[Tier]] If tiers are provided in the request, all existing tiers on the Add-on will be removed and replaced by the tiers in the request.
+      define_attribute :tiers, Array, { :item_type => :Tier }
     end
   end
 end

data/lib/recurly/requests/billing_info_create.rb

@@ -6,6 +6,14 @@ module Recurly
   module Requests
     class BillingInfoCreate < Request
 
+      # @!attribute account_number
+      #   @return [String] The bank account number. (ACH only)
+      define_attribute :account_number, String
+
+      # @!attribute account_type
+      #   @return [String] The bank account type. (ACH only)
+      define_attribute :account_type, String
+
       # @!attribute address
       #   @return [Address]
       define_attribute :address, :Address
@@ -38,6 +46,10 @@ module Recurly
       #   @return [String] A token used in place of a credit card in order to perform transactions. Must be used in conjunction with `gateway_code`.
       define_attribute :gateway_token, String
 
+      # @!attribute iban
+      #   @return [String] The International Bank Account Number, up to 34 alphanumeric characters comprising a country code; two check digits; and a number that includes the domestic bank account number, branch identifier, and potential routing information. (SEPA only)
+      define_attribute :iban, String
+
       # @!attribute ip_address
       #   @return [String] *STRONGLY RECOMMENDED* Customer's IP address when updating their billing information.
       define_attribute :ip_address, String
@@ -50,6 +62,10 @@ module Recurly
       #   @return [String] Expiration month
       define_attribute :month, String
 
+      # @!attribute name_on_account
+      #   @return [String] The name associated with the bank account.
+      define_attribute :name_on_account, String
+
       # @!attribute number
       #   @return [String] Credit card number, spaces and dashes are accepted.
       define_attribute :number, String
@@ -58,12 +74,16 @@ module Recurly
       #   @return [String] PayPal billing agreement ID
       define_attribute :paypal_billing_agreement_id, String
 
+      # @!attribute routing_number
+      #   @return [String] The bank's rounting number. (ACH only)
+      define_attribute :routing_number, String
+
       # @!attribute three_d_secure_action_result_token_id
       #   @return [String] A token generated by Recurly.js after completing a 3-D Secure device fingerprinting or authentication challenge.
       define_attribute :three_d_secure_action_result_token_id, String
 
       # @!attribute token_id
-      #   @return [String] A token [generated by Recurly.js](https://docs.recurly.com/js/#getting-a-token).
+      #   @return [String] A token [generated by Recurly.js](https://developers.recurly.com/reference/recurly-js/#getting-a-token).
       define_attribute :token_id, String
 
       # @!attribute transaction_type

data/lib/recurly/requests/external_transaction.rb

@@ -0,0 +1,26 @@
+# This file is automatically created by Recurly's OpenAPI generation process
+# and thus any edits you make by hand will be lost. If you wish to make a
+# change to this file, please create a Github issue explaining the changes you
+# need and we will usher them to the appropriate places.
+module Recurly
+  module Requests
+    class ExternalTransaction < Request
+
+      # @!attribute amount
+      #   @return [Float] The total amount of the transcaction. Cannot excceed the invoice total.
+      define_attribute :amount, Float
+
+      # @!attribute collected_at
+      #   @return [DateTime] Datetime that the external payment was collected. Defaults to current datetime.
+      define_attribute :collected_at, DateTime
+
+      # @!attribute description
+      #   @return [String] Used as the transaction's description.
+      define_attribute :description, String
+
+      # @!attribute payment_method
+      #   @return [String] Payment method used for the external transaction.
+      define_attribute :payment_method, String
+    end
+  end
+end

data/lib/recurly/requests/invoice_refund.rb

@@ -7,8 +7,8 @@ module Recurly
     class InvoiceRefund < Request
 
       # @!attribute amount
-      #   @return [Integer] The amount to be refunded. The amount will be split between the line items. If no amount is specified, it will default to refunding the total refundable amount on the invoice.
-      define_attribute :amount, Integer
+      #   @return [Float] The amount to be refunded. The amount will be split between the line items. If no amount is specified, it will default to refunding the total refundable amount on the invoice.
+      define_attribute :amount, Float
 
       # @!attribute credit_customer_notes
       #   @return [String] Used as the Customer Notes on the credit invoice.  This field can only be include when the Credit Invoices feature is enabled.

data/lib/recurly/requests/line_item_create.rb

@@ -27,11 +27,11 @@ module Recurly
       define_attribute :end_date, DateTime
 
       # @!attribute item_code
-      #   @return [String] Unique code to identify an item, when the Catalog feature is enabled.
+      #   @return [String] Unique code to identify an item. Avaliable when the Credit Invoices and Subscription Billing Terms features are enabled.
       define_attribute :item_code, String
 
       # @!attribute item_id
-      #   @return [String] Available when the Catalog feature is enabled.
+      #   @return [String] System-generated unique identifier for an item. Available when the Credit Invoices and Subscription Billing Terms features are enabled.
       define_attribute :item_id, String
 
       # @!attribute origin

data/lib/recurly/requests/plan_create.rb

@@ -46,10 +46,18 @@ module Recurly
       #   @return [String] This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.
       define_attribute :name, String
 
+      # @!attribute revenue_schedule_type
+      #   @return [String] Revenue schedule type
+      define_attribute :revenue_schedule_type, String
+
       # @!attribute setup_fee_accounting_code
       #   @return [String] Accounting code for invoice line items for the plan's setup fee. If no value is provided, it defaults to plan's accounting code.
       define_attribute :setup_fee_accounting_code, String
 
+      # @!attribute setup_fee_revenue_schedule_type
+      #   @return [String] Setup fee revenue schedule type
+      define_attribute :setup_fee_revenue_schedule_type, String
+
       # @!attribute tax_code
       #   @return [String] Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`.
       define_attribute :tax_code, String

data/lib/recurly/requests/plan_update.rb

@@ -42,10 +42,18 @@ module Recurly
       #   @return [String] This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.
       define_attribute :name, String
 
+      # @!attribute revenue_schedule_type
+      #   @return [String] Revenue schedule type
+      define_attribute :revenue_schedule_type, String
+
       # @!attribute setup_fee_accounting_code
       #   @return [String] Accounting code for invoice line items for the plan's setup fee. If no value is provided, it defaults to plan's accounting code.
       define_attribute :setup_fee_accounting_code, String
 
+      # @!attribute setup_fee_revenue_schedule_type
+      #   @return [String] Setup fee revenue schedule type
+      define_attribute :setup_fee_revenue_schedule_type, String
+
       # @!attribute tax_code
       #   @return [String] Optional field used by Avalara, Vertex, and Recurly's EU VAT tax feature to determine taxation rules. If you have your own AvaTax or Vertex account configured, use their tax codes to assign specific tax rules. If you are using Recurly's EU VAT feature, you can use values of `unknown`, `physical`, or `digital`.
       define_attribute :tax_code, String

data/lib/recurly/requests/subscription_add_on_create.rb

@@ -14,8 +14,16 @@ module Recurly
       #   @return [Integer] Quantity
       define_attribute :quantity, Integer
 
+      # @!attribute revenue_schedule_type
+      #   @return [String] Revenue schedule type
+      define_attribute :revenue_schedule_type, String
+
+      # @!attribute tiers
+      #   @return [Array[SubscriptionAddOnTier]] If the plan add-on's `tier_type` is `flat`, then `tiers` must be absent.
+      define_attribute :tiers, Array, { :item_type => :SubscriptionAddOnTier }
+
       # @!attribute unit_amount
-      #   @return [Float] Optionally, override the add-on's default unit amount.
+      #   @return [Float] * Optionally, override the add-on's default unit amount. * If the plan add-on's `tier_type` is `tiered`, `volume`, or `stairstep`, then `unit_amount` must be absent.
       define_attribute :unit_amount, Float
     end
   end