json_api_client 1.23.0 → 1.24.0

data/lib/json_api_client/result_set.rb

@@ -1,25 +1,25 @@
-require 'forwardable'
-
-module JsonApiClient
-  class ResultSet < Array
-    extend Forwardable
-
-    attr_accessor :errors,
-                  :record_class,
-                  :meta,
-                  :pages,
-                  :uri,
-                  :links,
-                  :implementation,
-                  :relationships,
-                  :included
-
-    # pagination methods are handled by the paginator
-    def_delegators :pages, :total_pages, :total_entries, :total_count, :offset, :per_page, :current_page, :limit_value, :next_page, :previous_page, :out_of_bounds?
-
-    def has_errors?
-      errors.present?
-    end
-
-  end
-end
+require 'forwardable'
+
+module JsonApiClient
+  class ResultSet < Array
+    extend Forwardable
+
+    attr_accessor :errors,
+                  :record_class,
+                  :meta,
+                  :pages,
+                  :uri,
+                  :links,
+                  :implementation,
+                  :relationships,
+                  :included
+
+    # pagination methods are handled by the paginator
+    def_delegators :pages, :total_pages, :total_entries, :total_count, :offset, :per_page, :current_page, :limit_value, :next_page, :previous_page, :out_of_bounds?
+
+    def has_errors?
+      errors.present?
+    end
+
+  end
+end

data/lib/json_api_client/schema.rb

@@ -1,154 +1,154 @@
-require 'bigdecimal'
-module JsonApiClient
-  class Schema
-    module Types
-
-      class Integer
-        def self.cast(value, _)
-          value.to_i
-        end
-      end
-
-      class String
-        def self.cast(value, _)
-          value.to_s
-        end
-      end
-
-      class Float
-        def self.cast(value, _)
-          value.to_f
-        end
-      end
-
-      class Time
-        def self.cast(value, _)
-          value.is_a?(::Time) ? value : ::Time.parse(value)
-        end
-      end
-
-      class Decimal
-        def self.cast(value, _)
-          BigDecimal(value)
-        end
-      end
-
-      class Boolean
-        def self.cast(value, default)
-          case value
-            when "false", "0", 0, false
-              false
-            when "true", "1", 1, true
-              true
-            else
-              # if it's unknown, use the default value
-              default
-          end
-        end
-      end
-
-    end
-
-    class TypeFactory
-      @@types = {}
-      # Register a new type key or keys with appropriate classes
-      #
-      # eg:
-      #
-      #   require 'money'
-      #
-      #   class MyMoneyCaster
-      #      def self.cast(value, default)
-      #         begin
-      #           Money.new(value, "USD")
-      #         rescue ArgumentError
-      #           default
-      #         end
-      #      end
-      #   end
-      #
-      #   JsonApiClient::Schema::TypeFactory.register money: MyMoneyCaster
-      #
-      # You can setup several at once:
-      #
-      #   JsonApiClient::Schema::TypeFactory.register money: MyMoneyCaster,
-      #                                         date: MyJsonDateTypeCaster
-      #
-      #
-      #
-      #
-      def self.register(type_hash)
-        @@types.merge!(type_hash)
-      end
-
-      def self.type_for(type)
-        @@types[type]
-      end
-
-      self.register int: Types::Integer,
-                    integer: Types::Integer,
-                    string: Types::String,
-                    float: Types::Float,
-                    time: Types::Time,
-                    decimal: Types::Decimal,
-                    boolean: Types::Boolean
-
-    end
-
-    Property = Struct.new(:name, :type, :default) do
-      def cast(value)
-        return nil if value.nil?
-        return value if type.nil?
-        type_caster = TypeFactory.type_for(type)
-        return value if type_caster.nil?
-        type_caster.cast(value, default)
-      end
-    end
-
-    def initialize
-      @properties = {}
-    end
-
-    # Add a property to the schema
-    #
-    # @param name [Symbol] the name of the property
-    # @param options [Hash] property options
-    # @option options [Symbol] :type The property type
-    # @option options [Symbol] :default The default value for the property
-    # @return [void]
-    def add(name, options)
-      @properties[name.to_sym] = Property.new(name.to_sym, options[:type], options[:default])
-    end
-
-    # How many properties are defined
-    #
-    # @return [Fixnum] the number of defined properties
-    def size
-      @properties.size
-    end
-
-    alias_method :length, :size
-
-    def each_property(&block)
-      @properties.values.each(&block)
-    end
-
-    alias_method :each, :each_property
-
-    # Look up a property by name
-    #
-    # @param property_name [String] the name of the property
-    # @return [Property, nil] the property definition for property_name or nil
-    def find(property_name)
-      @properties[property_name.to_sym]
-    end
-
-    alias_method :[], :find
-
-    class << self
-      def register(type_hash)
-        TypeFactory.register(type_hash)
-      end
-    end
-  end
-end
+require 'bigdecimal'
+module JsonApiClient
+  class Schema
+    module Types
+
+      class Integer
+        def self.cast(value, _)
+          value.to_i
+        end
+      end
+
+      class String
+        def self.cast(value, _)
+          value.to_s
+        end
+      end
+
+      class Float
+        def self.cast(value, _)
+          value.to_f
+        end
+      end
+
+      class Time
+        def self.cast(value, _)
+          value.is_a?(::Time) ? value : ::Time.parse(value)
+        end
+      end
+
+      class Decimal
+        def self.cast(value, _)
+          BigDecimal(value)
+        end
+      end
+
+      class Boolean
+        def self.cast(value, default)
+          case value
+            when "false", "0", 0, false
+              false
+            when "true", "1", 1, true
+              true
+            else
+              # if it's unknown, use the default value
+              default
+          end
+        end
+      end
+
+    end
+
+    class TypeFactory
+      @@types = {}
+      # Register a new type key or keys with appropriate classes
+      #
+      # eg:
+      #
+      #   require 'money'
+      #
+      #   class MyMoneyCaster
+      #      def self.cast(value, default)
+      #         begin
+      #           Money.new(value, "USD")
+      #         rescue ArgumentError
+      #           default
+      #         end
+      #      end
+      #   end
+      #
+      #   JsonApiClient::Schema::TypeFactory.register money: MyMoneyCaster
+      #
+      # You can setup several at once:
+      #
+      #   JsonApiClient::Schema::TypeFactory.register money: MyMoneyCaster,
+      #                                         date: MyJsonDateTypeCaster
+      #
+      #
+      #
+      #
+      def self.register(type_hash)
+        @@types.merge!(type_hash)
+      end
+
+      def self.type_for(type)
+        @@types[type]
+      end
+
+      self.register int: Types::Integer,
+                    integer: Types::Integer,
+                    string: Types::String,
+                    float: Types::Float,
+                    time: Types::Time,
+                    decimal: Types::Decimal,
+                    boolean: Types::Boolean
+
+    end
+
+    Property = Struct.new(:name, :type, :default) do
+      def cast(value)
+        return nil if value.nil?
+        return value if type.nil?
+        type_caster = TypeFactory.type_for(type)
+        return value if type_caster.nil?
+        type_caster.cast(value, default)
+      end
+    end
+
+    def initialize
+      @properties = {}
+    end
+
+    # Add a property to the schema
+    #
+    # @param name [Symbol] the name of the property
+    # @param options [Hash] property options
+    # @option options [Symbol] :type The property type
+    # @option options [Symbol] :default The default value for the property
+    # @return [void]
+    def add(name, options)
+      @properties[name.to_sym] = Property.new(name.to_sym, options[:type], options[:default])
+    end
+
+    # How many properties are defined
+    #
+    # @return [Fixnum] the number of defined properties
+    def size
+      @properties.size
+    end
+
+    alias_method :length, :size
+
+    def each_property(&block)
+      @properties.values.each(&block)
+    end
+
+    alias_method :each, :each_property
+
+    # Look up a property by name
+    #
+    # @param property_name [String] the name of the property
+    # @return [Property, nil] the property definition for property_name or nil
+    def find(property_name)
+      @properties[property_name.to_sym]
+    end
+
+    alias_method :[], :find
+
+    class << self
+      def register(type_hash)
+        TypeFactory.register(type_hash)
+      end
+    end
+  end
+end

data/lib/json_api_client/utils.rb

@@ -1,53 +1,53 @@
-module JsonApiClient
-  module Utils
-
-    def self.compute_type(klass, type_name)
-      return klass.custom_type_to_class.fetch(type_name).constantize if klass.custom_type_to_class.key?(type_name)
-      # If the type is prefixed with a scope operator then we assume that
-      # the type_name is an absolute reference.
-      return type_name.constantize if type_name.match(/^::/)
-
-      # Check the klass association definitions
-      association_klass_match = klass.associations.find { |a| a.attr_name.to_s.singularize == type_name.underscore }
-      association_klass = association_klass_match.options[:class] if association_klass_match
-      return association_klass if association_klass
-
-      # Build a list of candidates to search for
-      candidates = []
-      klass.name.scan(/::|$/) { candidates.unshift "#{$`}::#{type_name}" }
-      candidates << type_name
-
-      candidates.each do |candidate|
-        begin
-          constant = candidate.constantize
-          return constant if candidate == constant.to_s
-        rescue NameError => e
-          # We don't want to swallow NoMethodError < NameError errors
-          raise e unless e.instance_of?(NameError)
-        end
-      end
-
-      raise NameError, "uninitialized constant #{candidates.first}"
-    end
-
-    def self.parse_includes(klass, *tables)
-      tables.map do |table|
-        case table
-        when Hash
-          table.map do |k, v|
-            parse_includes(klass, *v).map do |sub|
-              "#{k}.#{sub}"
-            end
-          end
-        when Array
-          table.map do |v|
-            parse_includes(klass, *v)
-          end
-        else
-          klass.key_formatter.format(table)
-        end
-      end.flatten
-    end
-
-  end
-end
+module JsonApiClient
+  module Utils
+
+    def self.compute_type(klass, type_name)
+      return klass.custom_type_to_class.fetch(type_name).constantize if klass.custom_type_to_class.key?(type_name)
+      # If the type is prefixed with a scope operator then we assume that
+      # the type_name is an absolute reference.
+      return type_name.constantize if type_name.match(/^::/)
+
+      # Check the klass association definitions
+      association_klass_match = klass.associations.find { |a| a.attr_name.to_s.singularize == type_name.underscore }
+      association_klass = association_klass_match.options[:class] if association_klass_match
+      return association_klass if association_klass
+
+      # Build a list of candidates to search for
+      candidates = []
+      klass.name.scan(/::|$/) { candidates.unshift "#{$`}::#{type_name}" }
+      candidates << type_name
+
+      candidates.each do |candidate|
+        begin
+          constant = candidate.constantize
+          return constant if candidate == constant.to_s
+        rescue NameError => e
+          # We don't want to swallow NoMethodError < NameError errors
+          raise e unless e.instance_of?(NameError)
+        end
+      end
+
+      raise NameError, "uninitialized constant #{candidates.first}"
+    end
+
+    def self.parse_includes(klass, *tables)
+      tables.map do |table|
+        case table
+        when Hash
+          table.map do |k, v|
+            parse_includes(klass, *v).map do |sub|
+              "#{k}.#{sub}"
+            end
+          end
+        when Array
+          table.map do |v|
+            parse_includes(klass, *v)
+          end
+        else
+          klass.key_formatter.format(table)
+        end
+      end.flatten
+    end
+
+  end
+end

data/lib/json_api_client/version.rb

@@ -1,3 +1,3 @@
-module JsonApiClient
-  VERSION = "1.23.0"
-end
+module JsonApiClient
+  VERSION = "1.24.0"
+end

data/lib/json_api_client.rb

@@ -1,30 +1,30 @@
-require 'faraday'
-require 'faraday/gzip'
-require 'json'
-require 'addressable/uri'
-require 'json_api_client/formatter'
-
-module JsonApiClient
-  autoload :Associations, 'json_api_client/associations'
-  autoload :Attributes, 'json_api_client/attributes'
-  autoload :Connection, 'json_api_client/connection'
-  autoload :Errors, 'json_api_client/errors'
-  autoload :ErrorCollector, 'json_api_client/error_collector'
-  autoload :Helpers, 'json_api_client/helpers'
-  autoload :Implementation, 'json_api_client/implementation'
-  autoload :IncludedData, 'json_api_client/included_data'
-  autoload :Linking, 'json_api_client/linking'
-  autoload :Relationships, 'json_api_client/relationships'
-  autoload :LinkDefinition, 'json_api_client/link_definition'
-  autoload :MetaData, 'json_api_client/meta_data'
-  autoload :Middleware, 'json_api_client/middleware'
-  autoload :Paginating, 'json_api_client/paginating'
-  autoload :Parsers, 'json_api_client/parsers'
-  autoload :Query, 'json_api_client/query'
-  autoload :RequestParams, 'json_api_client/request_params'
-  autoload :Resource, 'json_api_client/resource'
-  autoload :ResultSet, 'json_api_client/result_set'
-  autoload :Schema, 'json_api_client/schema'
-  autoload :Utils, 'json_api_client/utils'
-  autoload :VERSION, 'json_api_client/version'
-end
+require 'faraday'
+require 'faraday/gzip'
+require 'json'
+require 'addressable/uri'
+require 'json_api_client/formatter'
+
+module JsonApiClient
+  autoload :Associations, 'json_api_client/associations'
+  autoload :Attributes, 'json_api_client/attributes'
+  autoload :Connection, 'json_api_client/connection'
+  autoload :Errors, 'json_api_client/errors'
+  autoload :ErrorCollector, 'json_api_client/error_collector'
+  autoload :Helpers, 'json_api_client/helpers'
+  autoload :Implementation, 'json_api_client/implementation'
+  autoload :IncludedData, 'json_api_client/included_data'
+  autoload :Linking, 'json_api_client/linking'
+  autoload :Relationships, 'json_api_client/relationships'
+  autoload :LinkDefinition, 'json_api_client/link_definition'
+  autoload :MetaData, 'json_api_client/meta_data'
+  autoload :Middleware, 'json_api_client/middleware'
+  autoload :Paginating, 'json_api_client/paginating'
+  autoload :Parsers, 'json_api_client/parsers'
+  autoload :Query, 'json_api_client/query'
+  autoload :RequestParams, 'json_api_client/request_params'
+  autoload :Resource, 'json_api_client/resource'
+  autoload :ResultSet, 'json_api_client/result_set'
+  autoload :Schema, 'json_api_client/schema'
+  autoload :Utils, 'json_api_client/utils'
+  autoload :VERSION, 'json_api_client/version'
+end