recurly 3.0.0.beta.5 → 3.0.0

data/lib/recurly/schema/json_parser.rb

@@ -1,8 +1,9 @@
 require "json"
 
 module Recurly
-  # This is a wrapper class to help parse responses into Recurly objects.
+  # This is a wrapper class to help parse http response into Recurly objects.
   class JSONParser
+
     # Parses the json body into a recurly object.
     #
     # @param client [Client] The Recurly client which made the request.
@@ -17,13 +18,18 @@ module Recurly
 
     # Converts the parsed JSON into a Recurly object.
     #
+    # *TODO*: Instead of inferring this type from the `object`
+    # attribute. We should instead "register" the response type
+    # in the client/operations code. The `get`, `post`, etc methods
+    # could explicitly state their response types.
+    #
     # @param data [Hash] The parsed JSON data
     # @return [Error,Resource]
     def self.from_json(data)
       type = if data.has_key?("error")
                "error"
              else
-               data.delete("object")
+               data["object"]
              end
       klazz = self.recurly_class(type)
 
@@ -33,15 +39,14 @@ module Recurly
 
       data = data["error"] if klazz == Resources::Error
 
-      klazz.from_json(data)
+      klazz.cast(data)
     end
 
     # Returns the Recurly ruby class responsible for the Recurly json key.
-    # TODO figure out how we should handle nil types
     #
     # @example
     #   JSONParser.recurly_class('list')
-    #   #=> Recurly::Pager
+    #   #=> Recurly::Page
     # @example
     #   JSONParser.recurly_class('shipping_address')
     #   #=> Recurly::Resources::ShippingAddress
@@ -53,7 +58,7 @@ module Recurly
       when nil
         nil
       when "list"
-        Pager
+        Resources::Page
       else
         type_camelized = type.split("_").map(&:capitalize).join
         if Resources.const_defined?(type_camelized)
@@ -61,8 +66,11 @@ module Recurly
           if klazz.ancestors.include?(Resource)
             klazz
           else
-            # TODO might want to throw an error?
-            nil
+            if Recurly::STRICT_MODE
+              raise ArgumentError, "Could not find Recurly Resource responsible for key #{type}"
+            else
+              nil
+            end
           end
         end
       end

data/lib/recurly/schema/request_caster.rb

@@ -2,19 +2,20 @@ require "date"
 
 module Recurly
   class Schema
-    # *Note*: This class is for internal use.
+    # *Note*: This module is for internal use.
     # The RequestCaster turns mixed data into a pure Hash
     # so it can be serialized into JSON and used as the body of a request.
     # This module is to be extended by the Request class.
     module RequestCaster
+
       # This method casts the data object (of mixed types) into a Hash ready for JSON
       # serialization. The *schema* will default to the self's schema.
       # You should pass in the schema where possible. This is because objects are serialized
       # differently depending on the context in which they are being written.
       #
       # @example
-      #   Recurly::Requests::AccountUpdatable.cast(account_code: 'benjamin')
-      #   #=> {:account_code=>"benjamin"}
+      #   Recurly::Requests::AccountUpdatable.cast(code: 'benjamin')
+      #   #=> {:code=>"benjamin"}
       # @example
       #   # If you have some mixed data, like passing in an Address, it should cast that
       #   # address into a Hash based on the Schema defined in AccountUpdatable
@@ -25,26 +26,26 @@ module Recurly
       # @param data [Hash,Resource,Request] The data to transform into a JSON Hash.
       # @param schema [Schema] The schema to use to transform the data into a JSON Hash.
       # @return [Hash] The pure Hash ready to be serialized into JSON.
-      def cast(data, schema = self.schema)
+      def cast_request(data, schema = self.schema)
         casted = {}
         if data.is_a?(Resource) || data.is_a?(Request)
-          data = as_json(data, schema)
+          data = data.attributes.reject { |_k, v| v.nil? }
         end
 
         data.each do |k, v|
           schema_attr = schema.get_attribute(k)
           norm_val = if v.respond_to?(:attributes)
-                       cast(v, schema_attr.recurly_class.schema)
+                       cast_request(v, v.class.schema)
                      elsif v.is_a?(Array)
                        v.map do |elem|
                          if elem.respond_to?(:attributes)
-                           cast(elem, schema_attr.recurly_class.schema)
+                           cast_request(elem, elem.class.schema)
                          else
                            elem
                          end
                        end
-                     elsif v.is_a?(Hash) && schema_attr && schema_attr.type.is_a?(Symbol)
-                       cast(v, schema_attr.recurly_class.schema)
+                     elsif v.is_a?(Hash) && schema_attr && schema_attr.is_a?(Schema::ResourceAttribute)
+                       cast_request(v, schema_attr.recurly_class.schema)
                      else
                        v
                      end
@@ -54,13 +55,6 @@ module Recurly
 
         casted
       end
-
-      private
-
-      def as_json(resource, schema)
-        writeable_attributes = schema.attributes.reject(&:read_only?).map(&:name)
-        resource.attributes.select { |k, _| writeable_attributes.include?(k) }
-      end
     end
   end
 end

data/lib/recurly/schema/resource_caster.rb

@@ -0,0 +1,48 @@
+require "date"
+
+module Recurly
+  class Schema
+    # The purpose of this class is to turn JSON parsed Hashes
+    # defined into Recurly ruby objects. It's to be used
+    # by the Resource as an extension.
+    module ResourceCaster
+
+      # Gives the class the ability to initialize itself
+      # given some json data.
+      #
+      # @example
+      #   Recurly::Resources::Account.cast({"code" => "mycode"})
+      #   #=> #<Recurly::Resources::Account @attributes={:code=>"mycode"}>
+      #
+      # @param attributes [Hash] A primitive Hash from JSON.parse of Recurly response.
+      # @return [Resource] the {Resource} (ruby object) representing the passed in JSON data.
+      def cast(attributes = {})
+        resource = new()
+        attributes.each do |attr_name, val|
+          next if attr_name == "object"
+
+          schema_attr = self.schema.get_attribute(attr_name)
+
+          if schema_attr
+            val = if val.nil?
+                    val
+                  elsif schema_attr.is_valid?(val)
+                    schema_attr.cast(val)
+                  else
+                    if Recurly::STRICT_MODE
+                      msg = "#{self.class}##{attr_name} does not have the right type. Value: #{val.inspect} was expected to be a #{schema_attr}"
+                      raise ArgumentError, msg
+                    end
+                  end
+
+            writer = "#{attr_name}="
+            resource.send(writer, val)
+          elsif Recurly::STRICT_MODE
+            raise ArgumentError, "#{resource.class.name} encountered json attribute #{attr_name.inspect}: #{val.inspect} but it's unknown to it's schema"
+          end
+        end
+        resource
+      end
+    end
+  end
+end

data/lib/recurly/schema/schema_factory.rb

@@ -41,8 +41,6 @@ module Recurly
           self.attributes[name] = val
         end
 
-        protected "#{name}=" if attribute.read_only?
-
         self
       end
     end

data/lib/recurly/schema/schema_validator.rb

@@ -24,45 +24,42 @@ module Recurly
             err_msg = "Attribute '#{attr_name}' does not exist on request #{self.class.name}."
             if did_you_mean = get_did_you_mean(schema, attr_name)
               err_msg << " Did you mean '#{did_you_mean}'?"
-              raise ArgumentError, err_msg
             end
-          elsif schema_attr.read_only?
-            raise ArgumentError, "Attribute '#{attr_name}' on resource #{self.class.name} is not writeable"
+            raise ArgumentError, err_msg
           else
-            validate_attribute!(schema_attr, val)
+            validate_attribute!(attr_name, schema_attr, val)
           end
         end
       end
 
       # Validates an individual attribute
-      def validate_attribute!(schema_attr, val)
-        unless schema_attr.type.is_a?(Symbol) || val.is_a?(schema_attr.type)
+      def validate_attribute!(name, schema_attr, val)
+        unless schema_attr.is_valid?(val)
           # If it's safely castable, the json deserializer or server
           # will take care of it for us
           unless safely_castable?(val.class, schema_attr.type)
-            expected = case schema_attr.type
-                       when Array
-                         "Array of #{schema_attr.type.item_type}s"
+            expected = case schema_attr
+                       when Schema::ArrayAttribute
+                         "Array of #{schema_attr.type}s"
                        else
                          schema_attr.type
                        end
 
-            raise ArgumentError, "Attribute '#{schema_attr.name}' on the resource #{self.class.name} is type #{val.class} but should be a #{expected}"
+            raise ArgumentError, "Attribute '#{name}' on the resource #{self.class.name} is type #{val.class} but should be a #{expected}"
           end
         end
 
         # This is the convention for a recurly object
-        if schema_attr.type.is_a?(Symbol) && val.is_a?(Hash)
-          klazz = Schema.get_recurly_class(schema_attr.type)
+        if schema_attr.is_a?(Schema::ResourceAttribute) && val.is_a?(Hash)
           # Using send because the initializer may be private
-          instance = klazz.send(:new, val)
+          instance = schema_attr.recurly_class.send(:new, val)
           instance.validate!
         end
       end
 
       # Gets the closest term to the misspelled attribute
       def get_did_you_mean(schema, misspelled_attr)
-        closest = schema.attributes.map(&:name).sort_by do |v|
+        closest = schema.attributes.keys.sort_by do |v|
           levenshtein_distance(v, misspelled_attr)
         end.first
 

data/lib/recurly/version.rb

@@ -1,3 +1,3 @@
 module Recurly
-  VERSION = "3.0.0.beta.5"
+  VERSION = "3.0.0"
 end

data/recurly.gemspec

@@ -7,11 +7,11 @@ Gem::Specification.new do |spec|
   spec.name = "recurly"
   spec.version = Recurly::VERSION
   spec.authors = ["Recurly"]
-  spec.email = ["support@recurly.com"]
+  spec.email = ["dx@recurly.com"]
 
-  spec.summary = "The ruby client for Recurly's Partner API"
-  spec.description = "The ruby client for Recurly's Partner API"
-  spec.homepage = "https://partner-docs.recurly.com"
+  spec.summary = "The ruby client for Recurly's V3 API"
+  spec.description = "The ruby client for Recurly's V3 API"
+  spec.homepage = "https://github.com/recurly/recurly-client-ruby"
   spec.license = "MIT"
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
@@ -21,10 +21,10 @@ Gem::Specification.new do |spec|
   # spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "faraday", ">= 0.8.11", "<= 1.0.0"
+  spec.add_dependency "faraday", ">= 0.8.11", "< 0.16"
 
   spec.add_development_dependency "net-http-persistent", "~> 2.9.4"
-  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "yard", "~> 0.9"

data/scripts/build

@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+set -e
 
 bundle install --binstubs --quiet
 ./bin/yard --quiet

data/scripts/bump

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+
+bump2version "$@"

data/scripts/format

@@ -1,4 +1,6 @@
 #!/usr/bin/env bash
+set -e
+
 if [ "$1" == "--check" ]; then
   ./bin/rufo . --check
 else

data/scripts/release

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+set -e
+
+# Clean up any leftover gems
+rm -f *.gem
+
+# Build the new gem
+gem build recurly.gemspec
+
+# Push what should be the only gem present
+gem push *.gem

data/scripts/test

@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+set -e
 
 # First check formatting
 echo "Checking style..."

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recurly
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta.5
+  version: 3.0.0
 platform: ruby
 authors:
 - Recurly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-28 00:00:00.000000000 Z
+date: 2019-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -17,9 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.11
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.11
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: net-http-persistent
   requirement: !ruby/object:Gem::Requirement
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -142,21 +142,25 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
-description: The ruby client for Recurly's Partner API
+description: The ruby client for Recurly's V3 API
 email:
-- support@recurly.com
+- dx@recurly.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".bumpversion.cfg"
 - ".gitignore"
 - ".rspec"
-- ".ruby-version"
 - ".travis.yml"
+- ".yardopts"
+- CONTRIBUTING.md
+- GETTING_STARTED.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmark.rb
 - lib/data/ca-certificates.crt
 - lib/recurly.rb
 - lib/recurly/client.rb
@@ -165,8 +169,10 @@ files:
 - lib/recurly/errors.rb
 - lib/recurly/errors/api_errors.rb
 - lib/recurly/errors/network_errors.rb
+- lib/recurly/http.rb
 - lib/recurly/pager.rb
 - lib/recurly/request.rb
+- lib/recurly/requests.rb
 - lib/recurly/requests/account_acquisition_cost.rb
 - lib/recurly/requests/account_acquisition_updatable.rb
 - lib/recurly/requests/account_create.rb
@@ -182,6 +188,7 @@ files:
 - lib/recurly/requests/coupon_pricing.rb
 - lib/recurly/requests/coupon_redemption_create.rb
 - lib/recurly/requests/coupon_update.rb
+- lib/recurly/requests/custom_field.rb
 - lib/recurly/requests/external_refund.rb
 - lib/recurly/requests/invoice_address.rb
 - lib/recurly/requests/invoice_create.rb
@@ -196,14 +203,21 @@ files:
 - lib/recurly/requests/purchase_create.rb
 - lib/recurly/requests/shipping_address_create.rb
 - lib/recurly/requests/shipping_address_update.rb
+- lib/recurly/requests/shipping_fee_create.rb
+- lib/recurly/requests/shipping_purchase.rb
 - lib/recurly/requests/subscription_add_on_create.rb
+- lib/recurly/requests/subscription_add_on_update.rb
 - lib/recurly/requests/subscription_change_create.rb
+- lib/recurly/requests/subscription_change_shipping_create.rb
 - lib/recurly/requests/subscription_create.rb
 - lib/recurly/requests/subscription_pause.rb
 - lib/recurly/requests/subscription_purchase.rb
+- lib/recurly/requests/subscription_shipping_create.rb
 - lib/recurly/requests/subscription_shipping_purchase.rb
+- lib/recurly/requests/subscription_shipping_update.rb
 - lib/recurly/requests/subscription_update.rb
 - lib/recurly/resource.rb
+- lib/recurly/resources.rb
 - lib/recurly/resources/account.rb
 - lib/recurly/resources/account_acquisition.rb
 - lib/recurly/resources/account_acquisition_cost.rb
@@ -216,7 +230,6 @@ files:
 - lib/recurly/resources/add_on_pricing.rb
 - lib/recurly/resources/address.rb
 - lib/recurly/resources/billing_info.rb
-- lib/recurly/resources/billing_info_payment_method.rb
 - lib/recurly/resources/billing_info_updated_by.rb
 - lib/recurly/resources/coupon.rb
 - lib/recurly/resources/coupon_discount.rb
@@ -237,35 +250,41 @@ files:
 - lib/recurly/resources/invoice_mini.rb
 - lib/recurly/resources/line_item.rb
 - lib/recurly/resources/line_item_list.rb
+- lib/recurly/resources/payment_method.rb
 - lib/recurly/resources/plan.rb
 - lib/recurly/resources/plan_hosted_pages.rb
 - lib/recurly/resources/plan_mini.rb
 - lib/recurly/resources/plan_pricing.rb
 - lib/recurly/resources/settings.rb
 - lib/recurly/resources/shipping_address.rb
+- lib/recurly/resources/shipping_method.rb
+- lib/recurly/resources/shipping_method_mini.rb
 - lib/recurly/resources/site.rb
 - lib/recurly/resources/subscription.rb
 - lib/recurly/resources/subscription_add_on.rb
 - lib/recurly/resources/subscription_change.rb
+- lib/recurly/resources/subscription_shipping.rb
 - lib/recurly/resources/tax_info.rb
 - lib/recurly/resources/transaction.rb
+- lib/recurly/resources/transaction_error.rb
 - lib/recurly/resources/transaction_payment_gateway.rb
-- lib/recurly/resources/transaction_payment_method.rb
 - lib/recurly/resources/unique_coupon_code.rb
 - lib/recurly/resources/user.rb
 - lib/recurly/schema.rb
-- lib/recurly/schema/json_deserializer.rb
 - lib/recurly/schema/json_parser.rb
 - lib/recurly/schema/request_caster.rb
+- lib/recurly/schema/resource_caster.rb
 - lib/recurly/schema/schema_factory.rb
 - lib/recurly/schema/schema_validator.rb
 - lib/recurly/version.rb
 - recurly.gemspec
 - scripts/build
+- scripts/bump
 - scripts/clean
 - scripts/format
+- scripts/release
 - scripts/test
-homepage: https://partner-docs.recurly.com
+homepage: https://github.com/recurly/recurly-client-ruby
 licenses:
 - MIT
 metadata: {}
@@ -280,13 +299,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
-summary: The ruby client for Recurly's Partner API
+summary: The ruby client for Recurly's V3 API
 test_files: []