recurly 2.20.3 → 3.0.0.beta.1

data/lib/recurly/resource/pager.rb

@@ -1,313 +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 = {}
-        @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/rev_rec.rb

@@ -1,18 +0,0 @@
-module Recurly
-  module RevRec
-    POB_ATTRIBUTE = %i(performance_obligation_id).freeze
-    POB_NATIVE_ATTRIBUTE = %i(performance_obligation_identifier).freeze
-
-    GLA_ID_ATTRIBUTES = %i(liability_gl_account_id revenue_gl_account_id).freeze
-    GLA_CODE_ATTRIBUTES = %i(liability_gl_account_code revenue_gl_account_code).freeze
-
-    PRODUCT_NATIVE_ATTRS = (POB_NATIVE_ATTRIBUTE + GLA_ID_ATTRIBUTES).freeze
-    PRODUCT_ATTRIBUTES = (POB_ATTRIBUTE + GLA_ID_ATTRIBUTES).freeze
-
-    LINE_ITEM_ATTRIBUTES = (POB_ATTRIBUTE + GLA_CODE_ATTRIBUTES).freeze
-    ALL_ATTRIBUTES = (PRODUCT_ATTRIBUTES + LINE_ITEM_ATTRIBUTES).uniq.freeze
-
-    SETUP_FEE_ATTRIBUTES = PRODUCT_ATTRIBUTES.map { |key| :"setup_fee_#{key}" }.freeze
-    PLAN_ATTRIBUTES = [*PRODUCT_ATTRIBUTES, *SETUP_FEE_ATTRIBUTES].freeze
-  end
-end

data/lib/recurly/shipping_address.rb

@@ -1,26 +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
-      company_name
-      email
-      geo_code
-      vat_number
-      street1
-      street2
-    )
-    alias to_param address1
-  end
-end

data/lib/recurly/shipping_fee.rb

@@ -1,17 +0,0 @@
-module Recurly
-  class ShippingFee < Resource
-    # @return [ShippingAddress, nil]
-    has_one :shipping_address, class_name: :ShippingAddress, readonly: false
-
-    define_attribute_methods %w(
-      shipping_method_code
-      shipping_amount_in_cents,
-      shipping_address_id
-    )
-
-    # shipping_amount_in_cents should just be a number rather than a currency
-    # See https://github.com/recurly/recurly-client-ruby/blob/3726114fdf584ba50982e0ee28fd219136043fbc/lib/recurly/resource.rb#L751-L753
-    def currency
-    end
-  end
-end

data/lib/recurly/shipping_method.rb

@@ -1,13 +0,0 @@
-module Recurly
-  class ShippingMethod < Resource
-    define_attribute_methods %w(
-      code
-      name
-      accounting_code
-      tax_code
-      created_at
-      updated_at
-    ) + RevRec::PRODUCT_ATTRIBUTES
-    alias to_param code
-  end
-end

data/lib/recurly/sub_add_on_percentage_tier.rb

@@ -1,17 +0,0 @@
-module Recurly
-  class SubAddOnPercentageTier < Resource
-
-    belongs_to :subscription_add_on
-
-    define_attribute_methods %w(
-      ending_amount_in_cents
-      usage_percentage
-    )
-
-    def xml_keys
-      attributes.keys
-    end
-
-    embedded! true
-  end
-end

data/lib/recurly/subscription/add_ons.rb

@@ -1,82 +0,0 @@
-module Recurly
-  class Subscription < Resource
-    class AddOns
-      instance_methods.each do |method|
-        undef_method method if method !~ /^__|^(object_id|respond_to\?|send)$/
-      end
-
-      # @param subscription [Subscription]
-      # @param add_ons [Array, nil]
-      def initialize subscription, add_ons = []
-        @subscription, @add_ons = subscription, []
-        add_ons and add_ons.each { |a| self << a }
-      end
-
-      # @return [self]
-      # @param add_on [AddOn, String, Symbol, Hash] A {Plan} add-on,
-      #   +add_on_code+, or hash with optional <tt>:quantity</tt> and
-      #   <tt>:unit_amount_in_cents</tt> keys.
-      # @example
-      #   pp subscription.add_ons << '1YEARWAR' << '1YEARWAR' << :BONUS
-      #   [
-      #     {:add_on_code => "1YEARWAR", :quantity => 2},
-      #     {:add_on_code => "BONUS"}
-      #   ]
-      def << add_on
-        add_on = SubscriptionAddOn.new(add_on, @subscription)
-
-        exist = @add_ons.find do |a|
-          source1 = a.add_on_source || "plan_add_on"
-          source2 = add_on.add_on_source || "plan_add_on"
-          a.add_on_code == add_on.add_on_code && source1 == source2
-        end
-
-        if exist
-          exist.quantity ||= 1
-          exist.quantity += add_on.quantity || 1
-
-          if add_on.unit_amount_in_cents
-            exist.unit_amount_in_cents = add_on.unit_amount_in_cents
-          end
-        else
-          @add_ons << add_on
-        end
-
-        self
-      end
-
-      def to_a
-        @add_ons.dup
-      end
-
-      def errors
-        @add_ons.map { |add_on| add_on.errors }
-      end
-
-      def to_xml options = {}
-        builder = options[:builder] || XML.new('<subscription_add_ons/>')
-        @add_ons.each do |add_on|
-          node = builder.add_element 'subscription_add_on'
-          add_on.attributes.each_pair do |k, v|
-            node.add_element k.to_s, v if v
-          end
-        end
-        builder.to_s
-      end
-
-      def respond_to? method_name, include_private = false
-        super || @add_ons.respond_to?(method_name, include_private)
-      end
-
-      private
-
-      def method_missing name, *args, &block
-        if @add_ons.respond_to? name
-          return @add_ons.send name, *args, &block
-        end
-
-        super
-      end
-    end
-  end
-end