recurly 2.18.15 → 3.0.0.beta.1

data/lib/recurly/account.rb

@@ -1,190 +0,0 @@
-module Recurly
-  # Accounts are core to managing your customers inside of Recurly.
-  # The account object stores the entire Recurly history of your customer and acts as the entry point
-  # for working with a customer's billing information, subscription data, transactions, invoices and more.
-  #
-  # Recurly Documentation: https://dev.recurly.com/docs/account-object
-  class Account < Resource
-    # @macro [attach] scope
-    #   @scope class
-    #   @return [Pager<Account>] A pager that yields +$1+ accounts.
-    scope :active,         state: :active
-    scope :closed,         state: :closed
-    scope :subscriber,     state: :subscriber
-    scope :non_subscriber, state: :non_subscriber
-    scope :past_due,       state: :past_due
-
-    # @return [Pager<Adjustment>, []] A pager that yields Adjustments for persisted
-    has_many :adjustments
-
-    # @return [Pager<Invoice>, []] A pager that yields Invoices for persisted
-    has_many :invoices
-
-    # @return [Pager<Subscription>, []] A pager that yields Subscriptions for persisted
-    has_many :subscriptions
-
-    # @return [Pager<Transaction>, []] A pager that yields Transaction for persisted
-    has_many :transactions
-
-    # @return [Pager<Note>, []] A pager that yields Note for persisted
-    has_many :notes
-
-    # @return [Pager<Redemption>, []] A pager that yields Redemptions for persisted
-    has_many :redemptions
-
-    # @return [Pager<ShippingAddress>, [ShippingAddress], []] A pager that yields ShippingAddresses;
-    #   or a list of ShippingAddresses if set by the programmer
-    has_many :shipping_addresses, readonly: false
-
-    # @return [BillingInfo, nil]
-    has_one :billing_info, readonly: false
-
-    # @return [AccountBalance, nil]
-    has_one :account_balance, readonly: true
-
-    # @return [Account, nil]
-    belongs_to :parent_account, class_name: :Account
-
-    # @return [Pager<Account>, []] A pager that yields Account for persisted
-    has_many :child_accounts, class_name: :Account
-
-    # @return [Pager<CreditPayment>, []]
-    has_many :credit_payments, class_name: :CreditPayment, readonly: true
-
-    # @return [[CustomField], []]
-    has_many :custom_fields, class_name: :CustomField, readonly: false
-
-    # @return [AccountAcquisition, nil]
-    has_one :account_acquisition, class_name: :AccountAcquisition, readonly: false
-
-    # Get's the first redemption given a coupon code
-    # @deprecated Use #{redemptions} instead
-    # @param coupon_code [String] The coupon code for the redemption
-    def redemption(coupon_code)
-      redemptions.detect { |r| r.coupon_code == coupon_code }
-    end
-
-    define_attribute_methods %w(
-      account_code
-      parent_account_code
-      state
-      username
-      email
-      cc_emails
-      first_name
-      last_name
-      company_name
-      company
-      phone
-      accept_language
-      hosted_login_token
-      vat_number
-      address
-      tax_exempt
-      exemption_certificate
-      entity_use_code
-      created_at
-      updated_at
-      closed_at
-      vat_location_valid
-      has_live_subscription
-      has_active_subscription
-      has_future_subscription
-      has_canceled_subscription
-      has_past_due_invoice
-      has_paused_subscription
-      preferred_locale
-      transaction_type
-    )
-    alias to_param account_code
-
-    def company_name
-      super || company
-    end
-
-    # Creates an invoice from the pending charges on the account.
-    # Raises an error if it fails.
-    #
-    # @return [InvoiceCollection] A newly-created invoice.
-    # @raise [Invalid] Raised if the account cannot be invoiced.
-    def invoice!(attrs={})
-      InvoiceCollection.from_response API.post(invoices.uri, attrs.empty? ? nil : Invoice.to_xml(attrs))
-    rescue Recurly::API::UnprocessableEntity => e
-      raise Invalid, e.message
-    end
-
-    # Builds an invoice from the pending charges on the account but does not persist the invoice.
-    # Raises an error if it fails.
-    #
-    # @return [InvoiceCollection] The newly-built invoice that has not been persisted.
-    # @raise [Invalid] Raised if the account cannot be invoiced.
-    def build_invoice
-      InvoiceCollection.from_response API.post("#{invoices.uri}/preview")
-    rescue Recurly::API::UnprocessableEntity => e
-      raise Invalid, e.message
-    end
-
-    # Reopen an account.
-    #
-    # @return [true, false] +true+ when successful, +false+ when unable to
-    #   (e.g., the account is already open), and may raise an exception if the
-    #   attempt fails.
-    def reopen
-      return false unless link? :reopen
-      reload follow_link :reopen
-      true
-    end
-
-    # Verify a cvv code for the account's billing info.
-    #
-    # @example
-    #   acct = Recurly::Account.find('benjamin-du-monde')
-    #   begin
-    #     # If successful, returned billing_info will contain
-    #     # updated billing info details.
-    #     billing_info = acct.verify_cvv!("504")
-    #   rescue Recurly::API::BadRequest => e
-    #     e.message # => "This credit card has too many cvv check attempts."
-    #   rescue Recurly::Transaction::Error => e
-    #     # this will be the errors coming back from gateway
-    #     e.transaction_error_code # => "fraud_security_code"
-    #     e.gateway_error_code # => "fraud"
-    #   rescue Recurly::Resource::Invalid => e
-    #     e.message # => "verification_value must be three digits"
-    #   end
-    #
-    # @param [String] verification_value The CVV code to check
-    # @return [BillingInfo] The updated billing info
-    # @raise [Recurly::Transaction::Error] A Transaction Error will be raised if the gateway declines
-    # the cvv code.
-    # @raise [API::BadRequest] A BadRequest error will be raised if you attempt to check too many times
-    # and are locked out.
-    # @raise [Resource::Invalid] An Invalid Error will be raised if you send an invalid request (such as
-    # a value that is not a propert verification number).
-    def verify_cvv!(verification_value)
-      bi = BillingInfo.new(verification_value: verification_value)
-      bi.uri = "#{path}/billing_info/verify_cvv"
-      bi.save!
-      bi
-    end
-
-    def changed_attributes
-      attrs = super
-      if address.respond_to?(:changed?) && address.changed?
-        attrs['address'] = address
-      end
-      if custom_fields.any?(&:changed?)
-        attrs['custom_fields'] = custom_fields.select(&:changed?)
-      end
-      attrs
-    end
-
-    private
-
-    def xml_keys
-      keys = super
-      keys << 'account_code' if account_code? && !account_code_changed?
-      keys.sort
-    end
-  end
-end

data/lib/recurly/account_acquisition.rb

@@ -1,27 +0,0 @@
-module Recurly
-  # Recurly Documentation: https://dev.recurly.com/docs/create-account-acquisition
-  class AccountAcquisition < Resource
-    # @return [Account]
-    belongs_to :account
-
-    define_attribute_methods %w(
-      cost_in_cents
-      currency
-      channel
-      subchannel
-      campaign
-    )
-
-    def self.member_name
-      "acquisition"
-    end
-
-    def self.xml_root_key
-      "account_acquisition"
-    end
-
-    # Acquisitions are only writeable and readable through {Account} instances.
-    embedded!
-    private_class_method :find
-  end
-end

data/lib/recurly/account_balance.rb

@@ -1,21 +0,0 @@
-module Recurly
-  # The AccountBalance object contains some information about the account's balance.
-  # It exists to give us parity with the v1 API which used to include this information with
-  # the {Account}. You can get an account's balance by calling {Account#account_balance} on an account instance.
-  #
-  # Recurly Documentation: https://dev.recurly.com/docs/lookup-account-balance
-  class AccountBalance < Resource
-    # @return [Account, nil]
-    has_one :account, readonly: true
-
-    define_attribute_methods %w(
-      past_due
-      balance_in_cents
-    )
-
-    # This object does not represent a model on the server side
-    # so we do not need to expose these methods.
-    protected(*%w(save save!))
-    private_class_method(*%w(all find_each first paginate scoped where create! create))
-  end
-end

data/lib/recurly/add_on.rb

@@ -1,44 +0,0 @@
-module Recurly
-  class AddOn < Resource
-    # @return [Plan]
-    belongs_to :plan
-    # @return [[Tier], []]
-    has_many :tiers, class_name: :Tier, readonly: false
-
-    define_attribute_methods %w(
-      add_on_code
-      item_code
-      name
-      accounting_code
-      default_quantity
-      unit_amount_in_cents
-      display_quantity_on_hosted_page
-      tax_code
-      add_on_type
-      measured_unit_id
-      optional
-      usage_type
-      usage_percentage
-      revenue_schedule_type
-      created_at
-      updated_at
-      tier_type
-      avalara_service_type
-      avalara_transaction_type
-    )
-    alias to_param add_on_code
-    alias quantity default_quantity
-
-    def changed_attributes
-      attrs = super
-      if tiers.any?(&:changed?)
-        attrs['tiers'] = tiers.select(&:changed?)
-      end
-      attrs
-    end
-
-    # Add-ons are only writeable and readable through {Plan} instances.
-    embedded!
-    private_class_method :find
-  end
-end

data/lib/recurly/address.rb

@@ -1,25 +0,0 @@
-module Recurly
-  class Address < Resource
-    define_attribute_methods %w(
-      first_name
-      last_name
-      name_on_account
-      company
-      address1
-      address2
-      city
-      state
-      zip
-      country
-      phone
-      geo_code
-    )
-
-    # This ensures every attribute is rendered
-    # when updating. The Address object does not
-    # accept partial updates on the server
-    def xml_keys
-      attributes.keys
-    end
-  end
-end

data/lib/recurly/adjustment.rb

@@ -1,81 +0,0 @@
-module Recurly
-  # The history of your customer's Recurly account can be tracked through adjustments, made up of credits and charges.
-  #
-  # Recurly Documentation: https://dev.recurly.com/docs/adjustment-object
-  class Adjustment < Resource
-    # @macro [attach] scope
-    #   @scope class
-    #   @return [Pager<Adjustment>] a pager that yields +$1+.
-    scope :charges,  type:  'charge'
-    scope :credits,  type:  'credit'
-    scope :pending,  state: 'pending'
-    scope :invoiced, state: 'invoiced'
-
-    # @return [Account, nil]
-    belongs_to :account
-    # @return [Invoice, nil]
-    belongs_to :invoice
-    # @return [Subscription, nil]
-    belongs_to :subscription
-
-    # @return [Pager<Adjustment>, []]
-    has_many :credit_adjustments, class_name: :Adjustment, readonly: true
-
-    # @return [ShippingAddress, nil]
-    has_one :shipping_address, class_name: :ShippingAddress, readonly: false
-
-    define_attribute_methods %w(
-      uuid
-      state
-      description
-      accounting_code
-      origin
-      unit_amount_in_cents
-      quantity
-      discount_in_cents
-      total_in_cents
-      currency
-      product_code
-      item_code
-      external_sku
-      start_date
-      end_date
-      created_at
-      updated_at
-      quantity_remaining
-      revenue_schedule_type
-      tax_in_cents
-      tax_type
-      tax_region
-      tax_rate
-      tax_exempt
-      tax_code
-      tax_details
-      tax_types
-      proration_rate
-      credit_reason_code
-      original_adjustment_uuid
-      shipping_address_id
-      surcharge_in_cents
-      avalara_transaction_type
-      avalara_service_type
-    )
-    alias to_param uuid
-
-    # @return ["charge", "credit", nil] The type of adjustment.
-    attr_reader :type
-
-    # Adjustments should be built through {Account} instances.
-    #
-    # @return [Adjustment] A new adjustment.
-    # @example
-    #   account.adjustments.new attributes
-    # @see Resource#initialize
-    def initialize(attributes = {})
-      super({ :currency => Recurly.default_currency }.merge attributes)
-    end
-
-    # Adjustments are only writeable through an {Account} instance.
-    embedded! true
-  end
-end

data/lib/recurly/api.rb

@@ -1,110 +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'
-    require 'openssl'
-
-    @@base_uri = "https://api.recurly.com/v2/"
-    @@valid_domains = [".recurly.com"]
-
-    RECURLY_API_VERSION = '2.29'
-
-    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
-        agent_string = "Recurly/#{Version}; #{RUBY_DESCRIPTION};"
-
-        if OpenSSL.const_defined?(:OPENSSL_VERSION)       
-          "#{agent_string} #{OpenSSL::OPENSSL_VERSION}"
-        elsif OpenSSL.const_defined?(:OPENSSL_LIBRARY_VERSION)
-          "#{agent_string} #{OpenSSL::OPENSSL_LIBRARY_VERSION}"
-        else
-          agent_string
-        end
-      end
-
-      private
-
-      def accept
-        FORMATS['xml']
-      end
-      alias content_type accept
-    end
-  end
-end
-
-require 'recurly/api/net_http_adapter'