jsonapi-consumer 0.1.1 → 1.0.0

data/lib/jsonapi/consumer/schema.rb

@@ -0,0 +1,153 @@
+module JSONAPI::Consumer
+  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, _)
+          value.to_d
+        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
+      #
+      #   JSONAPI::Consumer::Schema::Types.register money: MyMoneyCaster
+      #
+      # You can setup several at once:
+      #
+      #   JSONAPI::Consumer::Schema::Types.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/jsonapi/consumer/utils.rb

@@ -0,0 +1,28 @@
+module JSONAPI::Consumer
+  module Utils
+
+    def self.compute_type(klass, 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
+
+  end
+end

data/lib/jsonapi/consumer/version.rb

@@ -1,5 +1,5 @@
 module Jsonapi
   module Consumer
-    VERSION = "0.1.1"
+    VERSION = "1.0.0"
   end
 end

data/lib/jsonapi/consumer.rb

@@ -1,41 +1,66 @@
 require "jsonapi/consumer/version"
 
-require 'faraday'
-require 'faraday_middleware'
-require 'active_model'
-
-require "active_support/concern"
-require "active_support/core_ext"
-require "active_support/inflector"
+require "faraday"
+require "faraday_middleware"
+require "addressable/uri"
+require "active_support/core_ext/string"
 
 module JSONAPI
   module Consumer
 
+    module Associations
+      autoload :BaseAssociation, 'jsonapi/consumer/associations/base_association'
+      autoload :BelongsTo, 'jsonapi/consumer/associations/belongs_to'
+      autoload :HasMany, 'jsonapi/consumer/associations/has_many'
+      autoload :HasOne, 'jsonapi/consumer/associations/has_one'
+    end
+
+    module Helpers
+      autoload :Callbacks, 'jsonapi/consumer/helpers/callbacks'
+      autoload :Dirty, 'jsonapi/consumer/helpers/dirty'
+      autoload :DynamicAttributes, 'jsonapi/consumer/helpers/dynamic_attributes'
+      autoload :URI, 'jsonapi/consumer/helpers/uri'
+    end
+
+    module Linking
+      autoload :Links, "jsonapi/consumer/linking/links"
+      autoload :TopLevelLinks, "jsonapi/consumer/linking/top_level_links"
+    end
+
+    module Relationships
+      autoload :Relations, "jsonapi/consumer/relationships/relations"
+      autoload :TopLevelRelations, "jsonapi/consumer/relationships/top_level_relations"
+    end
+
+    module Middleware
+      autoload :JsonRequest, 'jsonapi/consumer/middleware/json_request'
+      autoload :ParseJson, 'jsonapi/consumer/middleware/parse_json'
+      autoload :Status, 'jsonapi/consumer/middleware/status'
+    end
+
+    module Paginating
+      autoload :Paginator, 'jsonapi/consumer/paginating/paginator'
+    end
+
+    module Parsers
+      autoload :Parser, 'jsonapi/consumer/parsers/parser'
+    end
+
+    module Query
+      autoload :Builder, 'jsonapi/consumer/query/builder'
+      autoload :Requestor, 'jsonapi/consumer/query/requestor'
+    end
+
+    autoload :Connection, 'jsonapi/consumer/connection'
+    autoload :Errors, 'jsonapi/consumer/errors'
+    autoload :ErrorCollector, 'jsonapi/consumer/error_collector'
+    autoload :Formatter, 'jsonapi/consumer/formatter'
+    autoload :Implementation, 'jsonapi/consumer/implementation'
+    autoload :IncludedData, 'jsonapi/consumer/included_data'
+    autoload :MetaData, 'jsonapi/consumer/meta_data'
+    autoload :Resource, 'jsonapi/consumer/resource'
+    autoload :ResultSet, 'jsonapi/consumer/result_set'
+    autoload :Schema, 'jsonapi/consumer/schema'
+    autoload :Utils, 'jsonapi/consumer/utils'
   end
-end
-
-require "jsonapi/consumer/errors"
-
-require "jsonapi/consumer/middleware"
-require "jsonapi/consumer/middleware/parse_json"
-require "jsonapi/consumer/middleware/raise_error"
-require "jsonapi/consumer/middleware/request_headers"
-require "jsonapi/consumer/middleware/request_timeout"
-
-require "jsonapi/consumer/parser"
-
-require "jsonapi/consumer/query"
-require "jsonapi/consumer/query/base"
-require "jsonapi/consumer/query/create"
-require "jsonapi/consumer/query/delete"
-require "jsonapi/consumer/query/find"
-require "jsonapi/consumer/query/new"
-require "jsonapi/consumer/query/update"
-
-require "jsonapi/consumer/resource/association_concern"
-require "jsonapi/consumer/resource/attributes_concern"
-require "jsonapi/consumer/resource/connection_concern"
-require "jsonapi/consumer/resource/finders_concern"
-require "jsonapi/consumer/resource/object_build_concern"
-require "jsonapi/consumer/resource/serializer_concern"
-require "jsonapi/consumer/resource"
+end

metadata

@@ -1,93 +1,51 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-consumer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Justin Smestad
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2015-01-23 00:00:00.000000000 Z
+date: 2018-04-13 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activemodel
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.0
-- !ruby/object:Gem::Dependency
-  name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: factory_girl
+  name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -95,35 +53,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
+        version: 2.5.2
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 2.5.2
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '3.2'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: rspec-its
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -157,51 +115,47 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
-- ".rspec"
-- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - jsonapi-consumer.gemspec
 - lib/jsonapi/consumer.rb
+- lib/jsonapi/consumer/associations/base_association.rb
+- lib/jsonapi/consumer/associations/belongs_to.rb
+- lib/jsonapi/consumer/associations/has_many.rb
+- lib/jsonapi/consumer/associations/has_one.rb
+- lib/jsonapi/consumer/connection.rb
+- lib/jsonapi/consumer/error_collector.rb
 - lib/jsonapi/consumer/errors.rb
-- lib/jsonapi/consumer/middleware.rb
+- lib/jsonapi/consumer/formatter.rb
+- lib/jsonapi/consumer/helpers/callbacks.rb
+- lib/jsonapi/consumer/helpers/dirty.rb
+- lib/jsonapi/consumer/helpers/dynamic_attributes.rb
+- lib/jsonapi/consumer/helpers/uri.rb
+- lib/jsonapi/consumer/implementation.rb
+- lib/jsonapi/consumer/included_data.rb
+- lib/jsonapi/consumer/linking/links.rb
+- lib/jsonapi/consumer/linking/top_level_links.rb
+- lib/jsonapi/consumer/meta_data.rb
+- lib/jsonapi/consumer/middleware/json_request.rb
 - lib/jsonapi/consumer/middleware/parse_json.rb
-- lib/jsonapi/consumer/middleware/raise_error.rb
-- lib/jsonapi/consumer/middleware/request_headers.rb
-- lib/jsonapi/consumer/middleware/request_timeout.rb
-- lib/jsonapi/consumer/parser.rb
-- lib/jsonapi/consumer/query.rb
-- lib/jsonapi/consumer/query/base.rb
-- lib/jsonapi/consumer/query/create.rb
-- lib/jsonapi/consumer/query/delete.rb
-- lib/jsonapi/consumer/query/find.rb
-- lib/jsonapi/consumer/query/new.rb
-- lib/jsonapi/consumer/query/update.rb
+- lib/jsonapi/consumer/middleware/status.rb
+- lib/jsonapi/consumer/paginating/paginator.rb
+- lib/jsonapi/consumer/parsers/parser.rb
+- lib/jsonapi/consumer/query/builder.rb
+- lib/jsonapi/consumer/query/requestor.rb
+- lib/jsonapi/consumer/relationships/relations.rb
+- lib/jsonapi/consumer/relationships/top_level_relations.rb
 - lib/jsonapi/consumer/resource.rb
-- lib/jsonapi/consumer/resource/association_concern.rb
-- lib/jsonapi/consumer/resource/attributes_concern.rb
-- lib/jsonapi/consumer/resource/connection_concern.rb
-- lib/jsonapi/consumer/resource/finders_concern.rb
-- lib/jsonapi/consumer/resource/object_build_concern.rb
-- lib/jsonapi/consumer/resource/serializer_concern.rb
+- lib/jsonapi/consumer/result_set.rb
+- lib/jsonapi/consumer/schema.rb
+- lib/jsonapi/consumer/utils.rb
 - lib/jsonapi/consumer/version.rb
-- spec/fixtures/.gitkeep
-- spec/fixtures/resources.rb
-- spec/fixtures/responses.rb
-- spec/jsonapi/consumer/associations_spec.rb
-- spec/jsonapi/consumer/attributes_spec.rb
-- spec/jsonapi/consumer/connection_spec.rb
-- spec/jsonapi/consumer/error_handling_spec.rb
-- spec/jsonapi/consumer/object_build_spec.rb
-- spec/jsonapi/consumer/parser_spec.rb
-- spec/jsonapi/consumer/resource_spec.rb
-- spec/jsonapi/consumer/serializer_spec.rb
-- spec/spec_helper.rb
-- spec/support/.gitkeep
-- spec/support/load_fixtures.rb
 homepage: https://github.com/jsmestad/jsonapi-consumer
 licenses:
 - Apache-2.0
@@ -222,22 +176,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: JSONAPI client framework for API consumption.
-test_files:
-- spec/fixtures/.gitkeep
-- spec/fixtures/resources.rb
-- spec/fixtures/responses.rb
-- spec/jsonapi/consumer/associations_spec.rb
-- spec/jsonapi/consumer/attributes_spec.rb
-- spec/jsonapi/consumer/connection_spec.rb
-- spec/jsonapi/consumer/error_handling_spec.rb
-- spec/jsonapi/consumer/object_build_spec.rb
-- spec/jsonapi/consumer/parser_spec.rb
-- spec/jsonapi/consumer/resource_spec.rb
-- spec/jsonapi/consumer/serializer_spec.rb
-- spec/spec_helper.rb
-- spec/support/.gitkeep
-- spec/support/load_fixtures.rb
+test_files: []

data/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/CHANGELOG.md

@@ -1,36 +0,0 @@
-
-0.1.1 / 2015-01-23
-==================
-
-  * Add internal helper #remove_links? for association payloads
-  * Do not send `links: {}` if new object, and empty associations
-
-0.1.0 / 2014-12-03
-==================
-
-  * `middleware` and `ssl` attributes are inheritable
-  * Support custom faraday connection middleware with `#middleware` block
-  * update README with usage
-
-0.1.0.pre.3 / 2014-11-11
-==================
-
-  * Has One relationships use plural names in side-loading lookups.
-
-0.1.0.pre.2 / 2014-11-11
-==================
-
-  * Set Accept header properly to 'application/json'
-  * Add spec for Resource.all with params
-
-0.1.0.pre.1 / 2014-10-19
-==================
-
-  * Add yarddoc to associations_concern
-  * Add error handling and parsing of Bad Requests
-  * Parse `has_one` and `has_many` links attribute from JSONAPI
-  * CRUD is supported
-  * Support create, find, all finders
-  * Create query support
-  * Basic serialization and association building.
-

data/lib/jsonapi/consumer/middleware/raise_error.rb

@@ -1,21 +0,0 @@
-module JSONAPI::Consumer::Middleware
-  class RaiseError < Faraday::Response::Middleware
-    def on_complete(env)
-      return if (status = env[:status]) < 400
-      message = "#{env[:status]} #{env[:method].upcase} #{env[:url]} #{env[:body]}"
-      raise ::JSONAPI::Consumer::Errors.class_for_error_code(status).new(message, response_values(env))
-    end
-
-    def response_values(env)
-      {status: env[:status], headers: env[:response_headers], body: parse_body(env[:body])}
-    end
-
-    def parse_body(body)
-      if body.nil?
-        nil
-      else
-        JSON.parse(body) rescue nil
-      end
-    end
-  end
-end

data/lib/jsonapi/consumer/middleware/request_headers.rb

@@ -1,20 +0,0 @@
-module JSONAPI::Consumer::Middleware
-  class RequestHeaders < Faraday::Middleware
-
-    def initialize(app, headers)
-      super(app)
-      @headers = headers
-    end
-
-    def call(env)
-      @headers.each do |header, value|
-        env[:request_headers][header] ||= value
-      end
-      @app.call(env)
-    end
-
-  end
-end
-
-Faraday::Request.register_middleware request_headers: JSONAPI::Consumer::Middleware::RequestHeaders
-

data/lib/jsonapi/consumer/middleware/request_timeout.rb

@@ -1,9 +0,0 @@
-module JSONAPI::Consumer::Middleware
-  class RequestTimeout < Faraday::Middleware
-    def call(env)
-      @app.call(env)
-    rescue Faraday::TimeoutError
-      raise JSONAPI::Consumer::Errors::ServerNotResponding
-    end
-  end
-end

data/lib/jsonapi/consumer/middleware.rb

@@ -1,5 +0,0 @@
-module JSONAPI::Consumer
-  module Middleware
-
-  end
-end