recurly 2.17.0 → 3.23.0

data/lib/recurly/api.rb

@@ -1,101 +0,0 @@
-module Recurly
-  # The API class handles all requests to the Recurly API. While most of its
-  # functionality is leveraged by the Resource class, it can be used directly,
-  # as well.
-  #
-  # Requests are made with methods named after the four main HTTP verbs
-  # recognized by the Recurly API.
-  #
-  # @example
-  #   Recurly::API.get 'accounts'             # => #<Net::HTTPOK ...>
-  #   Recurly::API.post 'accounts', xml_body  # => #<Net::HTTPCreated ...>
-  #   Recurly::API.put 'accounts/1', xml_body # => #<Net::HTTPOK ...>
-  #   Recurly::API.delete 'accounts/1'        # => #<Net::HTTPNoContent ...>
-  class API
-    require 'recurly/api/errors'
-
-    @@base_uri = "https://api.recurly.com/v2/"
-    @@valid_domains = [".recurly.com"]
-
-    RECURLY_API_VERSION = '2.14'
-
-    FORMATS = Helper.hash_with_indifferent_read_access(
-      'pdf' => 'application/pdf',
-      'xml' => 'application/xml'
-    )
-
-    class << self
-      # Additional HTTP headers sent with each API call
-      # @return [Hash{String => String}]
-      def headers
-        @headers ||= { 'Accept' => accept, 'User-Agent' => user_agent, 'X-Api-Version' => RECURLY_API_VERSION }
-      end
-
-      # @return [String, nil] Accept-Language header value
-      def accept_language
-        headers['Accept-Language']
-      end
-
-      # @param [String] language Accept-Language header value
-      def accept_language=(language)
-        headers['Accept-Language'] = language
-      end
-
-      # @return [Net::HTTPOK, Net::HTTPResponse]
-      # @raise [ResponseError] With a non-2xx status code.
-      def head uri, params = {}, options = {}
-        request :head, uri, { :params => params || {} }.merge(options)
-      end
-
-      # @return [Net::HTTPOK, Net::HTTPResponse]
-      # @raise [ResponseError] With a non-2xx status code.
-      def get uri, params = {}, options = {}
-        request :get, uri, { :params => params || {} }.merge(options)
-      end
-
-      # @return [Net::HTTPCreated, Net::HTTPResponse]
-      # @raise [ResponseError] With a non-2xx status code.
-      def post uri, body = nil, options = {}
-        request :post, uri, { :body => body.to_s }.merge(options)
-      end
-
-      # @return [Net::HTTPOK, Net::HTTPResponse]
-      # @raise [ResponseError] With a non-2xx status code.
-      def put uri, body = nil, options = {}
-        request :put, uri, { :body => body.to_s }.merge(options)
-      end
-
-      # @return [Net::HTTPNoContent, Net::HTTPResponse]
-      # @raise [ResponseError] With a non-2xx status code.
-      def delete uri, body = nil, options = {}
-        request :delete, uri, options
-      end
-
-      # @return [URI::Generic]
-      def base_uri
-        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}"
-      end
-
-      private
-
-      def accept
-        FORMATS['xml']
-      end
-      alias content_type accept
-    end
-  end
-end
-
-require 'recurly/api/net_http_adapter'

data/lib/recurly/billing_info.rb

@@ -1,80 +0,0 @@
-module Recurly
-  # Represents an account's Billing Information. You normally want to use a token when creating billing information.
-  #
-  # Recurly Documentation: https://dev.recurly.com/docs/create-an-accounts-billing-info-token
-  class BillingInfo < Resource
-    BANK_ACCOUNT_ATTRIBUTES = %w(name_on_account account_type last_four routing_number).freeze
-    CREDIT_CARD_ATTRIBUTES = %w(number verification_value card_type year month first_six last_four).freeze
-    AMAZON_ATTRIBUTES = %w(amazon_billing_agreement_id).freeze
-    PAYPAL_ATTRIBUTES = %w(paypal_billing_agreement_id).freeze
-    ROKU_ATTRIBUTES = %w(roku_billing_agreement_id last_four).freeze
-
-    # @return [Account]
-    belongs_to :account
-
-    define_attribute_methods %w(
-      first_name
-      last_name
-      company
-      address1
-      address2
-      city
-      state
-      zip
-      country
-      phone
-      vat_number
-      ip_address
-      ip_address_country
-      token_id
-      currency
-      geo_code
-      updated_at
-      external_hpp_type
-      gateway_token
-      gateway_code
-    ) | CREDIT_CARD_ATTRIBUTES | BANK_ACCOUNT_ATTRIBUTES | AMAZON_ATTRIBUTES | PAYPAL_ATTRIBUTES | ROKU_ATTRIBUTES
-
-    # @return ["credit_card", "paypal", "amazon", "bank_account", "roku", nil] The type of billing info.
-    attr_reader :type
-
-    # @return [String]
-    def inspect
-      attributes = self.class.attribute_names
-      case type
-      when 'credit_card'
-        attributes -= (AMAZON_ATTRIBUTES + PAYPAL_ATTRIBUTES + BANK_ACCOUNT_ATTRIBUTES + ROKU_ATTRIBUTES)
-        attributes |= CREDIT_CARD_ATTRIBUTES
-      when 'paypal'
-        attributes -= (CREDIT_CARD_ATTRIBUTES | BANK_ACCOUNT_ATTRIBUTES + AMAZON_ATTRIBUTES + ROKU_ATTRIBUTES)
-      when 'amazon'
-        attributes -= (CREDIT_CARD_ATTRIBUTES | BANK_ACCOUNT_ATTRIBUTES + PAYPAL_ATTRIBUTES + ROKU_ATTRIBUTES)
-      when 'bank_account'
-        attributes -= (CREDIT_CARD_ATTRIBUTES + PAYPAL_ATTRIBUTES + AMAZON_ATTRIBUTES + ROKU_ATTRIBUTES)
-        attributes |= BANK_ACCOUNT_ATTRIBUTES
-      when 'roku'
-        attributes -= (CREDIT_CARD_ATTRIBUTES + PAYPAL_ATTRIBUTES + AMAZON_ATTRIBUTES + BANK_ACCOUNT_ATTRIBUTES)
-        attributes |= ROKU_ATTRIBUTES
-      end
-      super attributes
-    end
-
-    class << self
-      # Overrides the inherited member_path method to allow for billing info's
-      # irregular URL structure.
-      #
-      # @return [String] The relative path to an account's billing info from the
-      #   API's base URI.
-      # @param uuid [String]
-      # @example
-      #   Recurly::BillingInfo.member_path "code"
-      #   # => "accounts/code/billing_info"
-      def member_path uuid
-        "accounts/#{uuid}/billing_info"
-      end
-    end
-
-    # Billing info is only writeable through an {Account} instance.
-    embedded!
-  end
-end

data/lib/recurly/coupon.rb

@@ -1,134 +0,0 @@
-module Recurly
-
-  # Recurly Documentation: https://dev.recurly.com/docs/list-active-coupons
-  class Coupon < Resource
-    BULK = 'bulk'.freeze
-    SINGLE_CODE = 'single_code'.freeze
-
-    # @macro [attach] scope
-    #   @scope class
-    #   @return [Pager<Coupon>] A pager that yields +$1+ coupons.
-    scope :redeemable, :state => :redeemable
-    scope :expired,    :state => :expired
-    scope :maxed_out,  :state => :maxed_out
-
-    # @return [Pager<Redemption>, []] A pager that yields Redemptions
-    has_many :redemptions
-
-    # @return [Pager<Coupon>, []] A pager that yields coupon-code type Coupons
-    has_many :unique_coupon_codes, class_name: :Coupon
-
-    define_attribute_methods %w(
-      id
-      coupon_code
-      name
-      state
-      discount_type
-      discount_percent
-      discount_in_cents
-      redeem_by_date
-      single_use
-      applies_for_months
-      duration
-      temporal_unit
-      temporal_amount
-      max_redemptions
-      max_redemptions_per_account
-      applies_to_all_plans
-      created_at
-      updated_at
-      plan_codes
-      description
-      invoice_description
-      applies_to_non_plan_charges
-      redemption_resource
-      coupon_type
-      unique_template_code
-      free_trial_amount
-      free_trial_unit
-    )
-    alias to_param coupon_code
-
-    # Redeem a coupon with a given account or account code.
-    #
-    # @return [true]
-    # @param account_or_code [Account, String]
-    # @param currency [String] Three-letter currency code
-    # @param extra_opts [Hash] extra options that go into the {Redemption}
-    # @example
-    #   coupon = Coupon.find(coupon_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, extra_opts={}
-      return false unless link? :redeem
-
-      account_code = if account_or_code.is_a? Account
-        account_or_code.account_code
-      else
-        account_or_code
-      end
-
-      redemption_options = {
-        :account_code => account_code,
-        :currency     => currency || Recurly.default_currency
-      }.merge(extra_opts)
-
-      redemption = Redemption.new(redemption_options)
-
-      Redemption.from_response follow_link(:redeem,
-        :body => redemption.to_xml
-      )
-    rescue API::UnprocessableEntity => e
-      redemption.apply_errors e
-      redemption
-    end
-
-    # Generate unique coupon codes on the server. This is based on the unique_template_code.
-    #
-    # @param amount [Integer]
-    # @return [Pager<Coupon>] A pager that yields the coupon-code type Coupons
-    # @example
-    #   unique_codes = coupon.generate(10)
-    #   unique_codes.each do |c|
-    #     puts c.coupon_code
-    #   end
-    def generate(amount)
-      builder = XML.new("<coupon/>")
-      builder.add_element 'number_of_unique_codes', amount
-
-      resp = follow_link(:generate,
-        :body => builder.to_s
-      )
-
-      Pager.new(Recurly::Coupon, uri: resp['location'], parent: self, etag: resp['ETag'])
-    end
-
-    # Redeem a coupon on the given account code
-    #
-    # @param account_code [String] Acccount's account code
-    # @param currency [String] Three-letter currency code
-    # @raise [Invalid] If the coupon cannot be redeemed
-    # @return [Redemption] The Coupon Redemption
-    def redeem!(account_code, currency = nil)
-      redemption = redeem(account_code, currency)
-      raise Invalid.new(self) unless redemption && redemption.persisted?
-      redemption
-    end
-
-    # Restores the coupon
-    def restore!
-      return false unless link? :restore
-      reload follow_link(:restore, body: self.to_xml(delta: true))
-    end
-
-    # Will return true if there are no limits on number of redemptions for this Coupon.
-    #
-    # @return [true, false]
-    def unlimited_redemptions_per_account?
-      !max_redemptions_per_account
-    end
-  end
-end

data/lib/recurly/credit_payment.rb

@@ -1,28 +0,0 @@
-module Recurly
-  class CreditPayment < Resource
-    # @return [Account, nil]
-    belongs_to :account, class_name: :Account, readonly: true
-
-    # @return [Invoice, nil]
-    has_one :original_invoice, class_name: :Invoice, readonly: true
-
-    # @return [Invoice, nil]
-    has_one :applied_to_invoice, class_name: :Invoice, readonly: true
-
-    define_attribute_methods %w(
-      action
-      amount_in_cents
-      currency
-      created_at
-      original_credit_payment
-      refund_transaction
-      updated_at
-      uuid
-      voided_at
-    )
-    alias to_param uuid
-
-    # @return ["charge", "credit", nil] The type of credit payment.
-    attr_reader :type
-  end
-end

data/lib/recurly/custom_field.rb

@@ -1,15 +0,0 @@
-module Recurly
-  # Recurly Documentation: https://dev.recurly.com/docs/custom-fields
-  class CustomField < Resource
-
-    define_attribute_methods %w(
-      name
-      value
-    )
-
-    # include the name with the serialized field, even though it can't change
-    def xml_keys
-      attributes.keys
-    end
-  end
-end

data/lib/recurly/delivery.rb

@@ -1,19 +0,0 @@
-module Recurly
-  # Delivery objects are only used with GiftCards.
-  #
-  # Recurly Documentation: https://dev.recurly.com/docs/gift-card-object
-  class Delivery < Resource
-    # @return [Address, nil]
-    has_one :address
-
-    define_attribute_methods %w(
-      deliver_at
-      email_address
-      first_name
-      gifter_name
-      last_name
-      method
-      personal_message
-    )
-  end
-end

data/lib/recurly/error.rb

@@ -1,13 +0,0 @@
-module Recurly
-  # The exception class from which all Recurly exceptions inherit.
-  class Error < StandardError
-    def set_message message
-      @message = message
-    end
-
-    # @return [String]
-    def to_s
-      defined? @message and @message or super
-    end
-  end
-end

data/lib/recurly/gift_card.rb

@@ -1,79 +0,0 @@
-module Recurly
-  class GiftCard < Resource
-    # @return [Invoice, nil]
-    belongs_to :invoice
-
-    # @return [Account, nil] The Account belonging to the gifter
-    belongs_to :gifter_account, class_name: :Account, readonly: false
-
-    # @return [Account, nil] The Account belonging to the recipient of the gift
-    belongs_to :recipient_account, class_name: :Account, readonly: false
-
-    # @return [Delivery, nil] Delivery information of the recipient.
-    has_one :delivery, class_name: :Delivery, readonly: false
-
-    # @return [Invoice, nil] The credit invoice for the gift card redemption.
-    has_one :redemption_invoice, class_name: :Invoice, readonly: true
-
-    # @return [Invoice, nil] The charge invoice for the gift card redemption.
-    has_one :purchase_invoice, class_name: :Invoice, readonly: true
-
-    define_attribute_methods %w(
-      balance_in_cents
-      currency
-      created_at
-      delivered_at
-      id
-      product_code
-      redeemed_at
-      redemption_code
-      unit_amount_in_cents
-      updated_at
-      canceled_at
-    )
-    alias to_param id
-
-    # Preview a GiftCard given some attributes
-    #
-    # @param [Hash] attributes for the gift card
-    # @return [GiftCard] The resulting preview GiftCard
-    def self.preview(attributes = {})
-      new(attributes) { |record| record.preview }
-    end
-
-    # Preview the GiftCard. Runs and validates the GiftCard but
-    # does not persist it. Errors are applied to the GiftCard if there
-    # are any errors.
-    def preview
-      clear_errors
-      @response = API.send(:post, "#{path}/preview", to_xml)
-      reload response
-    rescue API::UnprocessableEntity => e
-      apply_errors e
-    end
-
-    # Redeem this GiftCard on the given account.
-    #
-    # @param [String] Recipient's account code
-    def redeem(recipient_account_code)
-      clear_errors
-      xml = <<-XML
-        <recipient_account>
-            <account_code>#{recipient_account_code}</account_code>
-        </recipient_account>
-      XML
-      @response = API.send(:post, "#{self.class.collection_path}/#{redemption_code}/redeem", xml)
-      reload response
-    rescue API::UnprocessableEntity => e
-      apply_errors e
-    end
-
-    private
-
-    def xml_keys
-      keys = super
-      keys << 'redemption_code' if redemption_code? && !redemption_code_changed?
-      keys.sort
-    end
-  end
-end

data/lib/recurly/helper.rb

@@ -1,51 +0,0 @@
-module Recurly
-  module Helper
-    def camelize underscored_word
-      underscored_word.to_s.gsub(/(?:^|_)(.)/) { $1.upcase }
-    end
-
-    def classify table_name
-      camelize singularize(table_name.to_s.sub(/.*\./, ''))
-    end
-
-    def demodulize class_name_in_module
-      class_name_in_module.to_s.sub(/^.*::/, '')
-    end
-
-    def pluralize word
-      word.to_s.sub(/([^s])$/, '\1s')
-    end
-
-    def singularize word
-      word = word.to_s
-      return word if word.end_with?('address')
-      return "shipping_address" if word == "shipping_addresses"
-      word.sub(/s$/, '').sub(/ie$/, 'y')
-    end
-
-    def underscore camel_cased_word
-      word = camel_cased_word.to_s.dup
-      word.gsub!(/::/, '/')
-      word.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-      word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
-      word.tr! "-", "_"
-      word.downcase!
-      word
-    end
-
-    def hash_with_indifferent_read_access base = {}
-      indifferent = Hash.new { |hash, key| hash[key.to_s] if key.is_a? Symbol }
-      base.each_pair { |key, value| indifferent[key.to_s] = value }
-      indifferent
-    end
-
-    def stringify_keys! hash
-      hash.keys.each do |key|
-        stringify_keys! hash[key] if hash[key].is_a? Hash
-        hash[key.to_s] = hash.delete key if key.is_a? Symbol
-      end
-    end
-
-    extend self
-  end
-end