recurly 2.17.0 → 3.23.0

data/lib/recurly/purchase.rb

@@ -1,219 +0,0 @@
-module Recurly
-  # The Purchase object works in a slightly different way 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 {InvoiceCollection}.
-  #
-  # 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 added to the invoice.
-  #
-  # There are multiple ways to set the shipping addresses:
-  # 1. Use {Purchase#shipping_address_id} If you want to apply an existing shipping
-  #    address to all subscriptions and adjustments in this purchase.
-  # 2. Add multiple shipping addresses to {Account#shipping_addresses}. The last
-  #    address in the list will apply to all subscriptions and adjustments
-  #    in this purchase.
-  # 3. Use {Subscription#shipping_address_id} or {Subscription#shipping_address}
-  #    to set a shipping address for only the subscription.
-  # 4. Use {Adjustment#shipping_address_id} or {Adjustment#shipping_address}
-  #    to set a shipping address for only the adjustment.
-  #
-  # @example
-  #   require 'securerandom'
-  #
-  #   purchase = Recurly::Purchase.new(
-  #     currency: 'USD',
-  #     collection_method: :automatic,
-  #     account: {
-  #       account_code: SecureRandom.uuid,
-  #       shipping_addresses: [
-  #         {
-  #           first_name: 'Benjamin',
-  #           last_name: 'Du Monde',
-  #           address1: '400 Dolores St.',
-  #           city: 'San Francisco',
-  #           state: 'CA',
-  #           zip: '94110',
-  #           country: 'US',
-  #           nickname: 'Home'
-  #         }
-  #       ],
-  #       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_collection = Recurly::Purchase.preview!(purchase)
-  #     puts preview_collection.inspect
-  #   rescue Recurly::Resource::Invalid => e
-  #     # Invalid data
-  #   end
-  #
-  #   begin
-  #     invoice_collection = Recurly::Purchase.invoice!(purchase)
-  #     puts invoice_collection.inspect
-  #   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, class_name: :Account, readonly: false
-
-    # @return [GiftCard, nil]
-    has_one :gift_card, class_name: :GiftCard, readonly: false
-
-    # @return [[Subscription], nil]
-    has_many :subscriptions, class_name: :Subscription, readonly: false
-
-    define_attribute_methods %w(
-      currency
-      collection_method
-      po_number
-      net_terms
-      coupon_codes
-      terms_and_conditions
-      customer_notes
-      vat_reverse_charge_notes
-      shipping_address_id
-      gateway_code
-    )
-
-    class << self
-
-      # Generate an invoice for the purchase and run any needed transactions.
-      #
-      # @param purchase [Purchase] The purchase data for the request.
-      # @return [InvoiceCollection] The saved invoice(s) representing this purchase.
-      # @raise [Invalid] Raised if the purchase 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 [InvoiceCollection] The preview invoice(s) representing this purchase.
-      # @raise [Invalid] Raised if the purchase cannot be invoiced.
-      def preview!(purchase)
-        post(purchase, "#{collection_path}/preview")
-      end
-
-      # Generate an authorized invoice for the purchase. Runs validations
-      # but does not run any transactions. This endpoint will create a
-      # pending purchase that can be activated at a later time once payment
-      # has been completed on an external source (e.g. Adyen's Hosted
-      # Payment Pages).
-      #
-      # @param purchase [Purchase] The purchase data for the request.
-      # @return [InvoiceCollection] The authorized invoice collection representing this purchase.
-      # @raise [Invalid] Raised if the purchase cannot be invoiced.
-      def authorize!(purchase)
-        post(purchase, "#{collection_path}/authorize")
-      end
-
-      # Use for Adyen HPP transaction requests. Runs validations
-      # but does not run any transactions.
-      #
-      # @param purchase [Purchase] The purchase data for the request.
-      # @return [InvoiceCollection] The authorized invoice collection representing this purchase.
-      # @raise [Invalid] Raised if the purchase cannot be invoiced.
-      def pending!(purchase)
-        post(purchase, "#{collection_path}/pending")
-      end
-
-      # Allows the merchant to cancel an authorization.
-      #
-      # @param transaction_uuid [String] The uuid for the transaction representing the authorization. Can typically be found at invoice_collection.charge_invoice.transactions.first.uuid.
-      # @return [InvoiceCollection] The canceled invoice collection.
-      # @raise [Invalid] Raised if the authorization cannot be canceled.
-      def cancel!(transaction_uuid)
-        post(nil, "#{collection_path}/transaction-uuid-#{transaction_uuid}/cancel")
-      end
-
-      # Allows the merchants to initiate a capture transaction tied to the original authorization.
-      #
-      # @param transaction_uuid [String] The uuid for the transaction representing the authorization. Can typically be found at invoice_collection.charge_invoice.transactions.first.uuid.
-      # @return [InvoiceCollection] The captured invoice collection.
-      # @raise [Invalid] Raised if the authorization cannot be captured.
-      def capture!(transaction_uuid)
-        post(nil, "#{collection_path}/transaction-uuid-#{transaction_uuid}/capture")
-      end
-
-      def post(purchase, path)
-        body = purchase.nil? ? nil : purchase.to_xml
-        response = API.send(:post, path, body)
-        InvoiceCollection.from_response(response)
-      rescue API::UnprocessableEntity => e
-        purchase.apply_errors(e) if purchase
-        Transaction::Error.validate!(e, nil)
-        raise Resource::Invalid.new(purchase)
-      end
-    end
-
-    # TODO
-    # This is a temporary solution which allows us to
-    # embed these resources in a purchase without changing their
-    # interface. It will be removed once we get rid of default_currency.
-    def to_xml(options = {})
-      subscriptions.each {|s| s.currency = nil}
-      adjustments.each   {|a| a.currency = nil}
-      super(options)
-    end
-
-    # 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 post create! create))
-  end
-end

data/lib/recurly/redemption.rb

@@ -1,46 +0,0 @@
-module Recurly
-  # Redemptions are not top-level resources, but they can be accessed (and
-  # created) through {Coupon} instances.
-  #
-  # @example
-  #   coupon = Coupon.find("summer2011")
-  #   coupon.redemptions.each { |r| p r }
-  #   coupon.redeem Account.find("groupon_lover")
-  class Redemption < Resource
-    # @return [Coupon]
-    belongs_to :coupon
-
-    # @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
-      coupon_code
-      subscription_uuid
-      created_at
-      updated_at
-    )
-
-    def save
-      return false if persisted?
-      copy_from coupon.redeem account, currency
-      true
-    rescue Recurly::API::UnprocessableEntity => e
-      apply_errors e
-      false
-    end
-
-    # Redemptions are only writeable through {Coupon} instances.
-    embedded!
-  end
-end

data/lib/recurly/resource/association.rb

@@ -1,16 +0,0 @@
-module Recurly
-  class Resource
-    class Association
-      attr_reader :relation, :resource_class
-
-      def initialize relation, resource_class, options = {}
-        @relation, @resource_class, @options = relation, resource_class, options
-      end
-
-      def class_name
-        return @class_name if defined? @class_name
-        @class_name = @options[:class_name]
-      end
-    end
-  end
-end

data/lib/recurly/resource/errors.rb

@@ -1,20 +0,0 @@
-module Recurly
-  class Resource
-    class Errors < Hash
-      def [] key
-        super key.to_s
-      end
-
-      def []= key, value
-        super key.to_s, value
-      end
-
-      def full_messages
-        map { |attribute, messages|
-          attribute_name = attribute.capitalize.gsub('_', ' ')
-          messages.map { |message| "#{attribute_name} #{message}." }
-        }.flatten
-      end
-    end
-  end
-end

data/lib/recurly/resource/pager.rb

@@ -1,314 +0,0 @@
-require 'erb'
-
-module Recurly
-  class Resource
-    # Pages through an index resource, yielding records as it goes. It's rare
-    # to instantiate one on its own: use {Resource.paginate},
-    # {Resource.find_each}, and <tt>Resource#{has_many_association}</tt>
-    # instead.
-    #
-    # Because pagers handle +has_many+ associations, pagers can also build and
-    # create child records.
-    #
-    # @example Through a resource class:
-    #   Recurly::Account.paginate # => #<Recurly::Resource::Pager...>
-    #
-    #   Recurly::Account.find_each { |a| p a }
-    # @example Through an resource instance:
-    #   account.transactions
-    #   # => #<Recurly::Resource::Pager...>
-    #
-    #   account.transactions.new(attributes) # or #create, or #create!
-    #   # => #<Recurly::Transaction ...>
-    #
-    #   account.transactions.find_each do |transaction|
-    #     puts transaction
-    #   end
-    # @example Iterate through a page of invoices at a time
-    #   opts = {
-    #     order: :desc,
-    #     state: :collected
-    #   }
-    #   invoices = Recurly::Invoice.paginate(opts)
-    #   begin
-    #     invoices.each do |invoice|
-    #       puts invoice.invoice_number
-    #     end
-    #     puts "fetching next page..."
-    #   end while invoices.next
-    # @example Passing sorting and filtering parameters
-    #   opts = {
-    #     begin_time: DateTime.new(2016,1,1),
-    #     end_time: DateTime.new(2017,1,1),
-    #     sort: :updated_at,
-    #     order: :desc,
-    #     state: :collected
-    #   }
-    #   Recurly::Invoice.find_each(opts) do |invoice|
-    #     puts invoice
-    #   end
-    #
-    class Pager
-      include Enumerable
-
-      # @return [Resource] The resource class of the pager.
-      attr_reader :resource_class
-
-      # @return [Hash, nil] A hash of links to which the pager can page.
-      attr_reader :links
-
-      # @return [String, nil] An ETag for the current page.
-      attr_reader :etag
-
-      # A pager for paginating through resource records.
-      #
-      # @param resource_class [Resource] The resource to be paginated.
-      # @param options [Hash] A hash of pagination options.
-      # @option options [Integer] :per_page The number of records returned per
-      #   page.
-      # @option options [DateTime, Time, Integer] :cursor A timestamp that the
-      #   pager will skim back to and return records created before it.
-      # @option options [String] :etag When set, will raise {API::NotModified}
-      #   if the loaded page content has not changed.
-      # @option options [String] :uri The default location the pager will
-      #   request.
-      # @option options [String, Symbol] :sort The attribute that will be used to order
-      #   records: <tt>created_at</tt>, <tt>updated_at</tt>. Defaults to <tt>created_at</tt>.
-      # @option options [String, Symbol] :order The order in which records will be
-      #   returned: <tt>asc</tt> for ascending order, <tt>desc</tt> for descending order.
-      #   Defaults to <tt>desc</tt>.
-      # @option options [DateTime, String] :begin_time Operates on the attribute specified by the
-      #   <tt>sort</tt> parameter. Filters records to only include those with datetimes
-      #   greater than or equal to the supplied datetime. Accepts an ISO 8601
-      #   date or date and time.
-      # @option options [DateTime, String] :end_time Operates on the attribute specified by
-      #   the <tt>sort</tt> parameter. Filters records to only include those with
-      #   datetimes less than or equal to the supplied datetime. Accepts an
-      #   ISO 8601 date or date and time.
-      # @raise [API::NotModified] If the <tt>:etag</tt> option is set and
-      #   matches the server's.
-      def initialize resource_class, options = {}
-        options[:cursor] &&= options[:cursor].to_i
-        @parent = options.delete :parent
-        @uri    = options.delete :uri
-        @etag   = options.delete :etag
-        @resource_class, @options = resource_class, options
-        @collection = nil
-      end
-
-      # This will tell you if there are any associated resources
-      # on the server by checking the presence of a link in the xml
-      #
-      # @example
-      #   # if <invoices href="..." /> is present, will return true
-      #   account.invoices.any?
-      #   #=> true
-      # @return [Boolean] whether or not the xml element is present
-      def any?
-        !@uri.nil?
-      end
-
-      # @return [String] The URI of the paginated resource.
-      def uri
-        @uri ||= resource_class.collection_path
-      end
-
-      # Calls the server to get the count of server side resources.
-      #
-      # @example Count collected invoices in 2016
-      #   opts = {
-      #     begin_time: DateTime.new(2016,1,1),
-      #     end_time: DateTime.new(2017,1,1),
-      #     state: :collected
-      #   }
-      #   count = Recurly::Invoice.paginate(opts).count
-      #   #=> 42
-      #
-      # @return [Integer] The total record count of the resource in question.
-      # @see Resource.count
-      def count
-        API.head(uri, @options)['X-Records'].to_i
-      end
-
-      # @return [Array] Iterates through the current page of records.
-      # @yield [record]
-      def each
-        return enum_for :each unless block_given?
-        load! unless @collection
-        @collection.each { |record| yield record }
-      end
-
-      # @return [nil]
-      # @see Resource.find_each
-      # @yield [record]
-      def find_each
-        return enum_for :find_each unless block_given?
-        begin
-          each { |record| yield record }
-        end while self.next
-      end
-
-      # @return [Array, nil] Refreshes the pager's collection of records with
-      #   the next page.
-      def next
-        load_from links['next'], nil if links.key? 'next'
-      end
-
-      # @return [Array, nil] Refreshes the pager's collection of records with
-      #   the previous page.
-      def prev
-        load_from links['prev'], nil if links.key? 'prev'
-      end
-
-      # @return [Array, nil] Refreshes the pager's collection of records with
-      #   the first page.
-      def start
-        load_from links['start'], nil if links.key? 'start'
-      end
-
-      # @return [Array, nil] Load (or reload) the pager's collection from the
-      #   original, supplied options.
-      def load!
-        load_from uri, @options
-      end
-      alias reload load!
-
-
-      # @return [Pager] Duplicates the pager, updating it with the options
-      #   supplied. Useful for resource scopes.
-      # @option options [String, Symbol] :sort The attribute that will be used to order
-      #   records: <tt>created_at</tt>, <tt>updated_at</tt>. Defaults to <tt>created_at</tt>.
-      # @option options [String, Symbol] :order The order in which records will be
-      #   returned: <tt>asc</tt> for ascending order, <tt>desc</tt> for descending order.
-      #   Defaults to <tt>desc</tt>.
-      # @option options [DateTime, String] :begin_time Operates on the attribute specified by the
-      #   <tt>sort</tt> parameter. Filters records to only include those with datetimes
-      #   greater than or equal to the supplied datetime. Accepts an ISO 8601
-      #   date or date and time.
-      # @option options [DateTime, String] :end_time Operates on the attribute specified by
-      #   the <tt>sort</tt> parameter. Filters records to only include those with
-      #   datetimes less than or equal to the supplied datetime. Accepts an
-      #   ISO 8601 date or date and time.
-      # @example
-      #   Recurly::Account.paginate(sort: :updated_at, per_page: 20)
-      def paginate(options = {})
-        dup.instance_eval {
-          @collection = @etag = nil
-          @options = @options.merge options
-          self
-        }
-      end
-      alias scoped paginate
-      alias where  paginate
-
-      def all options = {}
-        paginate(options).to_a
-      end
-
-      # Instantiates a new record in the scope of the pager.
-      #
-      # @return [Resource] A new record.
-      # @example
-      #   account = Recurly::Account.find 'schrader'
-      #   subscription = account.subscriptions.new attributes
-      # @see Resource.new
-      def new attributes = {}
-        record = resource_class.send(:new, attributes) { |r|
-          r.attributes[@parent.class.member_name] ||= @parent if @parent
-          r.uri = uri
-        }
-        yield record if block_given?
-        record
-      end
-
-      # Instantiates and saves a record in the scope of the pager.
-      #
-      # @return [Resource] The record.
-      # @raise [Transaction::Error] A monetary transaction failed.
-      # @example
-      #   account = Recurly::Account.find 'schrader'
-      #   subscription = account.subscriptions.create attributes
-      # @see Resource.create
-      def create attributes = {}
-        new(attributes) { |record| record.save }
-      end
-
-      # Instantiates a record in the scope of the pager.
-      #
-      # @return [Resource] The record.
-      # @example
-      #   account = Recurly::Account.find 'schrader'
-      #   subscription = account.subscriptions.build attributes
-      # @see Resource.new
-      def build attributes = {}
-        new(attributes)
-      end
-
-      # Instantiates and saves a record in the scope of the pager.
-      #
-      # @return [Resource] The saved record.
-      # @raise [Invalid] The record is invalid.
-      # @raise [Transaction::Error] A monetary transaction failed.
-      # @example
-      #   account = Recurly::Account.find 'schrader'
-      #   subscription = account.subscriptions.create! attributes
-      # @see Resource.create!
-      def create! attributes = {}
-        new(attributes) { |record| record.save! }
-      end
-
-      def find uuid
-        if resource_class.respond_to? :find
-          raise NoMethodError, "#find must be called on #{resource_class} directly"
-        end
-
-        resource_class.from_response API.get("#{uri}/#{ERB::Util.url_encode(uuid)}")
-      end
-
-      # @return [true, false]
-      # @see Object#respond_to?
-      def respond_to? method_name, include_private = false
-        super || [].respond_to?(method_name, include_private)
-      end
-
-      private
-
-      def load_from uri, params
-        options = {}
-        options[:head] = { 'If-None-Match' => etag } if etag
-        response = API.get uri, params, options
-
-        @etag = response['ETag']
-        @links = {}
-        if links = response['Link']
-          links.scan(/<([^>]+)>; rel="([^"]+)"/).each do |link, rel|
-            @links[rel] = link.freeze
-          end
-        end
-        @links.freeze
-
-        @collection = []
-        document = XML.new response.body
-        document.each_element(resource_class.member_name) do |el|
-          record = resource_class.from_xml el
-          record.attributes[@parent.class.member_name] = @parent if @parent
-          @collection << record
-        end
-        @collection.freeze
-      rescue API::NotModified
-        @collection and @collection or raise
-      end
-
-      def method_missing name, *args, &block
-        scope = resource_class.scopes[name] and return paginate scope
-
-        if [].respond_to? name
-          load! unless @collection
-          return @collection.send name, *args, &block
-        end
-
-        super
-      end
-    end
-  end
-end

data/lib/recurly/shipping_address.rb

@@ -1,22 +0,0 @@
-module Recurly
-  # Recurly Documentation: https://dev.recurly.com/docs/list-accounts-shipping-address
-  class ShippingAddress < Resource
-    define_attribute_methods %w(
-      id
-      address1
-      address2
-      first_name
-      last_name
-      city
-      state
-      zip
-      country
-      phone
-      nickname
-      company
-      email
-      geo_code
-    )
-    alias to_param address1
-  end
-end