carwow-json_api_client 1.19.0

data/lib/json_api_client/result_set.rb

@@ -0,0 +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

data/lib/json_api_client/schema.rb

@@ -0,0 +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

data/lib/json_api_client/utils.rb

@@ -0,0 +1,48 @@
+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(/^::/)
+
+      # 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

@@ -0,0 +1,3 @@
+module JsonApiClient
+  VERSION = "1.19.0"
+end

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification
+name: carwow-json_api_client
+version: !ruby/object:Gem::Version
+  version: 1.19.0
+platform: ruby
+authors:
+- Jeff Ching
+- carwow
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.1
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Build client libraries compliant with specification defined by jsonapi.org
+email: developers@carwow.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/json_api_client.rb
+- lib/json_api_client/associations.rb
+- lib/json_api_client/associations/base_association.rb
+- lib/json_api_client/associations/belongs_to.rb
+- lib/json_api_client/associations/has_many.rb
+- lib/json_api_client/associations/has_one.rb
+- lib/json_api_client/connection.rb
+- lib/json_api_client/error_collector.rb
+- lib/json_api_client/errors.rb
+- lib/json_api_client/formatter.rb
+- lib/json_api_client/helpers.rb
+- lib/json_api_client/helpers/associatable.rb
+- lib/json_api_client/helpers/callbacks.rb
+- lib/json_api_client/helpers/dirty.rb
+- lib/json_api_client/helpers/dynamic_attributes.rb
+- lib/json_api_client/helpers/uri.rb
+- lib/json_api_client/implementation.rb
+- lib/json_api_client/included_data.rb
+- lib/json_api_client/linking.rb
+- lib/json_api_client/linking/links.rb
+- lib/json_api_client/linking/top_level_links.rb
+- lib/json_api_client/meta_data.rb
+- lib/json_api_client/middleware.rb
+- lib/json_api_client/middleware/json_request.rb
+- lib/json_api_client/middleware/parse_json.rb
+- lib/json_api_client/middleware/status.rb
+- lib/json_api_client/paginating.rb
+- lib/json_api_client/paginating/nested_param_paginator.rb
+- lib/json_api_client/paginating/paginator.rb
+- lib/json_api_client/parsers.rb
+- lib/json_api_client/parsers/parser.rb
+- lib/json_api_client/query.rb
+- lib/json_api_client/query/builder.rb
+- lib/json_api_client/query/requestor.rb
+- lib/json_api_client/relationships.rb
+- lib/json_api_client/relationships/relations.rb
+- lib/json_api_client/relationships/top_level_relations.rb
+- lib/json_api_client/request_params.rb
+- lib/json_api_client/resource.rb
+- lib/json_api_client/result_set.rb
+- lib/json_api_client/schema.rb
+- lib/json_api_client/utils.rb
+- lib/json_api_client/version.rb
+homepage: http://github.com/carwow/json_api_client
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Build client libraries compliant with specification defined by jsonapi.org
+test_files: []