recurly 3.0.0.beta.5 → 3.0.0

data/lib/recurly/resource.rb

@@ -5,7 +5,7 @@ module Recurly
   # and get a new Resource.
   class Resource
     extend Schema::SchemaFactory
-    extend Schema::JsonDeserializer
+    extend Schema::ResourceCaster
     include Schema::SchemaValidator
 
     attr_reader :attributes
@@ -18,10 +18,23 @@ module Recurly
       self.attributes == other_resource.attributes
     end
 
+    # Hide instance variables to keep from accidental logging
+    def inspect
+      "#<#{self.class.name}:#{object_id}} @attributes=#{attributes}>"
+    end
+
     def to_s
       self.inspect
     end
 
+    def to_json
+      raise NoMethodError, "to_json is not implemented for Resources. Please use Resource#attributes"
+    end
+
+    def get_response
+      @response
+    end
+
     protected
 
     def schema

data/lib/recurly/resources.rb

@@ -0,0 +1,17 @@
+# Include all resource files
+resources = File.join(File.dirname(__FILE__), "resources", "*.rb")
+Dir.glob(resources, &method(:require))
+
+module Recurly
+  module Resources
+    class Empty < Resource
+    end
+
+    class Page < Resource
+      # leave data untyped
+      define_attribute :data, Array, item_type: Hash
+      define_attribute :has_more, :Boolean
+      define_attribute :next, String
+    end
+  end
+end

data/lib/recurly/resources/account_acquisition.rb

@@ -19,8 +19,8 @@ module Recurly
       define_attribute :channel, String
 
       # @!attribute cost
-      #   @return [Hash] Account balance
-      define_attribute :cost, Hash
+      #   @return [AccountAcquisitionCost]
+      define_attribute :cost, :AccountAcquisitionCost
 
       # @!attribute created_at
       #   @return [DateTime] When the account acquisition data was created.

data/lib/recurly/resources/add_on.rb

@@ -55,7 +55,7 @@ module Recurly
       define_attribute :state, String
 
       # @!attribute tax_code
-      #   @return [String] Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature `P0000000` is `physical`, `D0000000` is `digital`, and an empty string is `unknown`.
+      #   @return [String] Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
       define_attribute :tax_code, String
 
       # @!attribute updated_at

data/lib/recurly/resources/billing_info.rb

@@ -27,8 +27,8 @@ module Recurly
       define_attribute :first_name, String
 
       # @!attribute fraud
-      #   @return [Hash] Most recent fraud result.
-      define_attribute :fraud, Hash
+      #   @return [FraudInfo] Most recent fraud result.
+      define_attribute :fraud, :FraudInfo
 
       # @!attribute id
       #   @return [String]
@@ -43,16 +43,16 @@ module Recurly
       define_attribute :object, String
 
       # @!attribute payment_method
-      #   @return [Hash]
-      define_attribute :payment_method, Hash
+      #   @return [PaymentMethod]
+      define_attribute :payment_method, :PaymentMethod
 
       # @!attribute updated_at
       #   @return [DateTime] When the billing information was last changed.
       define_attribute :updated_at, DateTime
 
       # @!attribute updated_by
-      #   @return [Hash]
-      define_attribute :updated_by, Hash
+      #   @return [BillingInfoUpdatedBy]
+      define_attribute :updated_by, :BillingInfoUpdatedBy
 
       # @!attribute valid
       #   @return [Boolean]

data/lib/recurly/resources/coupon.rb

@@ -75,7 +75,7 @@ module Recurly
       define_attribute :object, String
 
       # @!attribute plans
-      #   @return [Array[PlanMini]] Plans
+      #   @return [Array[PlanMini]] A list of plans for which this coupon applies. This will be `null` if `applies_to_all_plans=true`.
       define_attribute :plans, Array, { :item_type => :PlanMini }
 
       # @!attribute plans_names

data/lib/recurly/resources/coupon_discount.rb

@@ -15,8 +15,8 @@ module Recurly
       define_attribute :percent, Integer
 
       # @!attribute trial
-      #   @return [Hash] This is only present when `type=free_trial`.
-      define_attribute :trial, Hash
+      #   @return [CouponDiscountTrial] This is only present when `type=free_trial`.
+      define_attribute :trial, :CouponDiscountTrial
 
       # @!attribute type
       #   @return [String]

data/lib/recurly/resources/coupon_redemption.rb

@@ -23,8 +23,8 @@ module Recurly
       define_attribute :currency, String
 
       # @!attribute discounted
-      #   @return [String] The amount that was discounted upon the application of the coupon, formatted with the currency.
-      define_attribute :discounted, String
+      #   @return [Float] The amount that was discounted upon the application of the coupon, formatted with the currency.
+      define_attribute :discounted, Float
 
       # @!attribute id
       #   @return [String] Coupon Redemption ID

data/lib/recurly/resources/coupon_redemption_mini.rb

@@ -15,8 +15,8 @@ module Recurly
       define_attribute :created_at, DateTime
 
       # @!attribute discounted
-      #   @return [String] The amount that was discounted upon the application of the coupon, formatted with the currency.
-      define_attribute :discounted, String
+      #   @return [Float] The amount that was discounted upon the application of the coupon, formatted with the currency.
+      define_attribute :discounted, Float
 
       # @!attribute id
       #   @return [String] Coupon Redemption ID

data/lib/recurly/resources/error_may_have_transaction.rb

@@ -15,8 +15,8 @@ module Recurly
       define_attribute :params, Array, { :item_type => Hash }
 
       # @!attribute transaction_error
-      #   @return [Hash] This is only included on errors with `type=transaction`.
-      define_attribute :transaction_error, Hash
+      #   @return [TransactionError] This is only included on errors with `type=transaction`.
+      define_attribute :transaction_error, :TransactionError
 
       # @!attribute type
       #   @return [String] Type

data/lib/recurly/resources/invoice.rb

@@ -90,6 +90,10 @@ module Recurly
       #   @return [Float] The refundable amount on a charge invoice. It will be null for all other invoices.
       define_attribute :refundable_amount, Float
 
+      # @!attribute shipping_address
+      #   @return [ShippingAddress]
+      define_attribute :shipping_address, :ShippingAddress
+
       # @!attribute state
       #   @return [String] Invoice state
       define_attribute :state, String

data/lib/recurly/resources/line_item.rb

@@ -139,7 +139,7 @@ module Recurly
       define_attribute :tax, Float
 
       # @!attribute tax_code
-      #   @return [String] Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature `P0000000` is `physical`, `D0000000` is `digital`, and an empty string is `unknown`.
+      #   @return [String] Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
       define_attribute :tax_code, String
 
       # @!attribute tax_exempt

data/lib/recurly/resources/{billing_info_payment_method.rb → payment_method.rb}

@@ -4,7 +4,15 @@
 # need and we will usher them to the appropriate places.
 module Recurly
   module Resources
-    class BillingInfoPaymentMethod < Resource
+    class PaymentMethod < Resource
+
+      # @!attribute account_type
+      #   @return [String] The bank account type. Only present for ACH payment methods.
+      define_attribute :account_type, String
+
+      # @!attribute billing_agreement_id
+      #   @return [String] Billing Agreement identifier. Only present for Amazon or Paypal payment methods.
+      define_attribute :billing_agreement_id, String
 
       # @!attribute card_type
       #   @return [String] Visa, MasterCard, American Express, Discover, JCB, etc.
@@ -23,12 +31,20 @@ module Recurly
       define_attribute :first_six, String
 
       # @!attribute last_four
-      #   @return [String] Credit card number's last four digits.
+      #   @return [String] Credit card number's last four digits. Will refer to bank account if payment method is ACH.
       define_attribute :last_four, String
 
       # @!attribute object
       #   @return [String]
       define_attribute :object, String
+
+      # @!attribute routing_number
+      #   @return [String] The bank account's routing number. Only present for ACH payment methods.
+      define_attribute :routing_number, String
+
+      # @!attribute routing_number_bank
+      #   @return [String] The bank name of this routing number.
+      define_attribute :routing_number_bank, String
     end
   end
 end

data/lib/recurly/resources/plan.rb

@@ -67,7 +67,7 @@ module Recurly
       define_attribute :state, String
 
       # @!attribute tax_code
-      #   @return [String] Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature `P0000000` is `physical`, `D0000000` is `digital`, and an empty string is `unknown`.
+      #   @return [String] Used by Avalara, Vertex, and Recurly’s EU VAT tax feature. The tax code values are specific to each tax system. If you are using Recurly’s EU VAT feature you can use `unknown`, `physical`, or `digital`.
       define_attribute :tax_code, String
 
       # @!attribute tax_exempt

data/lib/recurly/resources/shipping_method.rb

@@ -0,0 +1,42 @@
+# 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 Resources
+    class ShippingMethod < Resource
+
+      # @!attribute code
+      #   @return [String] The internal name used identify the shipping method.
+      define_attribute :code, String
+
+      # @!attribute created_at
+      #   @return [DateTime] Created at
+      define_attribute :created_at, DateTime
+
+      # @!attribute deleted_at
+      #   @return [DateTime] Deleted at
+      define_attribute :deleted_at, DateTime
+
+      # @!attribute id
+      #   @return [String] Shipping Method ID
+      define_attribute :id, String
+
+      # @!attribute name
+      #   @return [String] The name of the shipping method displayed to customers.
+      define_attribute :name, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+
+      # @!attribute tax_code
+      #   @return [String] Used by Avalara, Vertex, and Recurly’s built-in tax feature. The tax code values are specific to each tax system. If you are using Recurly’s built-in taxes the values are:  - `FR` – Common Carrier FOB Destination - `FR022000` – Common Carrier FOB Origin - `FR020400` – Non Common Carrier FOB Destination - `FR020500` – Non Common Carrier FOB Origin - `FR010100` – Delivery by Company Vehicle Before Passage of Title - `FR010200` – Delivery by Company Vehicle After Passage of Title - `NT` – Non-Taxable
+      define_attribute :tax_code, String
+
+      # @!attribute updated_at
+      #   @return [DateTime] Last updated at
+      define_attribute :updated_at, DateTime
+    end
+  end
+end

data/lib/recurly/resources/shipping_method_mini.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 Resources
+    class ShippingMethodMini < Resource
+
+      # @!attribute code
+      #   @return [String] The internal name used identify the shipping method.
+      define_attribute :code, String
+
+      # @!attribute id
+      #   @return [String] Shipping Method ID
+      define_attribute :id, String
+
+      # @!attribute name
+      #   @return [String] The name of the shipping method displayed to customers.
+      define_attribute :name, String
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+    end
+  end
+end

data/lib/recurly/resources/subscription.rb

@@ -126,9 +126,9 @@ module Recurly
       #   @return [Integer] If `auto_renew=true`, when a term completes, `total_billing_cycles` takes this value as the length of subsequent terms. Defaults to the plan's `total_billing_cycles`.
       define_attribute :renewal_billing_cycles, Integer
 
-      # @!attribute shipping_address
-      #   @return [ShippingAddress]
-      define_attribute :shipping_address, :ShippingAddress
+      # @!attribute shipping
+      #   @return [SubscriptionShipping]
+      define_attribute :shipping, :SubscriptionShipping
 
       # @!attribute state
       #   @return [String] State

data/lib/recurly/resources/subscription_change.rb

@@ -42,6 +42,10 @@ module Recurly
       #   @return [Integer] Subscription quantity
       define_attribute :quantity, Integer
 
+      # @!attribute shipping
+      #   @return [SubscriptionShipping]
+      define_attribute :shipping, :SubscriptionShipping
+
       # @!attribute subscription_id
       #   @return [String] The ID of the subscription that is going to be changed.
       define_attribute :subscription_id, String

data/lib/recurly/resources/subscription_shipping.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 Resources
+    class SubscriptionShipping < Resource
+
+      # @!attribute address
+      #   @return [ShippingAddress]
+      define_attribute :address, :ShippingAddress
+
+      # @!attribute amount
+      #   @return [Float] Subscription's shipping cost
+      define_attribute :amount, Float
+
+      # @!attribute method
+      #   @return [ShippingMethodMini]
+      define_attribute :method, :ShippingMethodMini
+
+      # @!attribute object
+      #   @return [String] Object type
+      define_attribute :object, String
+    end
+  end
+end

data/lib/recurly/resources/transaction.rb

@@ -103,12 +103,12 @@ module Recurly
       define_attribute :original_transaction_id, String
 
       # @!attribute payment_gateway
-      #   @return [Hash]
-      define_attribute :payment_gateway, Hash
+      #   @return [TransactionPaymentGateway]
+      define_attribute :payment_gateway, :TransactionPaymentGateway
 
       # @!attribute payment_method
-      #   @return [Hash] Payment method (TODO: this overlaps with BillingInfo’s payment_method but only documents credit cards)
-      define_attribute :payment_method, Hash
+      #   @return [PaymentMethod]
+      define_attribute :payment_method, :PaymentMethod
 
       # @!attribute refunded
       #   @return [Boolean] Indicates if part or all of this transaction was refunded.

data/lib/recurly/resources/transaction_error.rb

@@ -0,0 +1,30 @@
+# 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 Resources
+    class TransactionError < Resource
+
+      # @!attribute category
+      #   @return [String] Category
+      define_attribute :category, String
+
+      # @!attribute code
+      #   @return [String] Code
+      define_attribute :code, String
+
+      # @!attribute merchant_advice
+      #   @return [String] Merchant message
+      define_attribute :merchant_advice, String
+
+      # @!attribute message
+      #   @return [String] Customer message
+      define_attribute :message, String
+
+      # @!attribute transaction_id
+      #   @return [String] Transaction ID
+      define_attribute :transaction_id, String
+    end
+  end
+end

data/lib/recurly/schema.rb

@@ -3,21 +3,21 @@ module Recurly
   # This is used for requests and resources.
   class Schema
     # The attributes in the schema
-    # @return [Array<Attribute>]
+    # @return [Hash<String,Attribute>]
     attr_reader :attributes
 
     def initialize
-      @attributes = []
+      @attributes = {}
     end
 
     # Adds an attribute to the schema definition
     #
     # @param name [Symbol] The name of the attribute
     # @param type [Class,Symbol] The type of the attribute. Use capitalized symbol for Recurly class. Example: :Account.
-    # @param options [Hash] The attribute options. See {Attribute#options}
+    # @param options [Schema::Attribute] The created and registered attribute object.
     def add_attribute(name, type, options)
-      attribute = Attribute.new(name, type, options)
-      @attributes.push(attribute)
+      attribute = Attribute.build(type, options)
+      @attributes[name.to_s] = attribute
       attribute
     end
 
@@ -26,8 +26,7 @@ module Recurly
     # @param name [String,Symbol] The name/key of the attribute
     # @return [Attribute,nil] The found Attribute. nil if not found.
     def get_attribute(name)
-      name = name.to_s
-      @attributes.find { |a| a.name.to_s == name }
+      @attributes[name.to_s]
     end
 
     # Gets a recurly class given a symbol name.
@@ -46,75 +45,112 @@ module Recurly
         Resources::Address
       elsif Requests.const_defined?(type)
         Requests.const_get(type)
-      elsif Resources.const_defined?(type)
+      elsif Recurly::Resources.const_defined?(type)
         Resources.const_get(type)
       else
         raise ArgumentError, "Recurly type '#{type}' is unknown"
       end
     end
 
-    # Describes a list attribute type
-    class List
-      # The type of the elements of the list
-      # @return [Symbol]
-      attr_accessor :item_type
+    class Attribute
+      # The type of the attribute. Might be a class like `DateTime`
+      # or could be a Recurly object. In this case a symbol should be used.
+      # Example: :Account. To get the Recurly type use #recurly_class
+      # @return [Class,Symbol]
+      attr_reader :type
+
+      PRIMITIVE_TYPES = [
+        String,
+        Integer,
+        Float,
+        Hash,
+      ].freeze
+
+      def self.build(type, options = {})
+        if PRIMITIVE_TYPES.include? type
+          PrimitiveAttribute.new(type)
+        elsif type == :Boolean
+          BooleanAttribute.new
+        elsif type == DateTime
+          DateTimeAttribute.new
+        elsif type.is_a? Symbol
+          ResourceAttribute.new(type)
+        elsif type == Array
+          item_attr = build(options[:item_type])
+          ArrayAttribute.new(item_attr)
+        else
+          throw ArgumentError
+        end
+      end
 
-      def initialize(item_type)
-        @item_type = item_type
+      def initialize(type = nil)
+        @type = type
       end
 
-      def to_s
-        "List<#{item_type}>"
+      def cast(value)
+        value
       end
-    end
 
-    # Describes and attribute for a schema.
-    class Attribute
-      # The name of the attribute.
-      # @return [Symbol]
-      attr_accessor :name
+      def recurly_class
+        @recurly_class ||= Schema.get_recurly_class(type)
+      end
+    end
 
-      # The type of the attribute. Might be a class like `DateTime`
-      # or could be a Recurly object. In this case a symbol should be used.
-      # Example: :Account
-      # @return [Class,Symbol]
-      attr_accessor :type
+    class PrimitiveAttribute < Attribute
+      def is_valid?(value)
+        value.is_a? self.type
+      end
+    end
 
-      # Options for the attribute.
-      # @return [Hash]
-      attr_accessor :options
+    class BooleanAttribute < Attribute
+      def is_valid?(value)
+        [true, false].include? value
+      end
+    end
 
-      # The description of the attribute for documentation.
-      # @return [String]
-      attr_accessor :description
+    class DateTimeAttribute < Attribute
+      def is_valid?(value)
+        value.is_a?(String) || value.is_a?(DateTime)
+      end
 
-      def initialize(name, type, options = {}, description = nil)
-        @name = name
-        @type = type
-        @options = options
-        @description = description
+      def cast(value)
+        if value.is_a?(DateTime)
+          value
+        else
+          DateTime.parse(value)
+        end
       end
 
-      def read_only?
-        @options.fetch(:read_only, false)
+      def type
+        DateTime
       end
+    end
 
-      def recurly_class
-        Schema.get_recurly_class(type == Array ? options[:item_type] : type)
+    class ResourceAttribute < Attribute
+      def is_valid?(value)
+        value.is_a? Hash
       end
 
-      def is_primitive?
-        t = type == Array ? options[:item_type] : type
-        t.is_a?(Class) || t == :Boolean
+      def cast(value)
+        self.recurly_class.cast(value)
       end
     end
 
-    private_constant :List
-    private_constant :Attribute
+    class ArrayAttribute < Attribute
+      def is_valid?(value)
+        value.is_a? Array
+      end
+
+      def cast(value)
+        value.map do |v|
+          self.type.cast(v)
+        end
+      end
+    end
   end
 
   require_relative "./schema/schema_factory"
   require_relative "./schema/schema_validator"
-  require_relative "./schema/json_deserializer"
+  require_relative "./schema/resource_caster"
   require_relative "./schema/request_caster"
 end