simple_jsonapi_client 0.1.0

data/lib/simple_jsonapi_client/error.rb

@@ -0,0 +1,6 @@
+module SimpleJSONAPIClient
+  class Error < StandardError
+  end
+
+  require 'simple_jsonapi_client/errors/api_error'
+end

data/lib/simple_jsonapi_client/errors/api_error.rb

@@ -0,0 +1,84 @@
+require 'delegate'
+
+module SimpleJSONAPIClient
+  module Errors
+    class APIError < ::SimpleJSONAPIClient::Error
+      extend Forwardable
+
+      KNOWN_ERRORS = {
+        400 => 'BadRequestError',
+        404 => 'NotFoundError',
+        422 => 'UnprocessableEntityError'
+      }
+      KNOWN_ERRORS.default = 'APIError'
+
+      def self.generate(response)
+        error = KNOWN_ERRORS[response.status]
+        SimpleJSONAPIClient::Errors.const_get(error).new(response)
+      end
+
+      attr_reader :response
+      def_delegators :response, :status, :body
+
+      def initialize(response)
+        @response = response
+        super(full_message)
+      end
+
+      def errors
+        Array(body['errors'])
+      end
+
+      def message
+        if !codes.empty?
+          codes_message
+        elsif !details.empty?
+          details_message
+        else
+          default_message
+        end
+      end
+
+      def full_message
+        "The API returned a #{status} error status and this content:\n" +
+          pretty_printed_response.each_line.map { |line| "  #{line}" }.join
+      end
+
+      def codes
+        @codes ||= errors.map { |error| error['code'] }.compact
+      end
+
+      def details
+        @details ||= errors.map { |error| error['detail'] }.compact
+      end
+
+      private
+
+      def pretty_printed_response
+        JSON.pretty_generate(body)
+      end
+
+      def codes_message
+        codes_word = codes.size == 1 ? 'code' : 'codes'
+        "The API returned a #{status} error status with the following error #{codes_word}: #{
+        codes.map(&:inspect).join(', ')
+        }"
+      end
+
+      def details_message
+        details_word = details.size == 1 ? 'detail' : 'details'
+        "The API returned a #{status} error status with the following error #{details_word}: #{
+        details.map(&:inspect).join(', ')
+        }"
+      end
+
+      def default_message
+        "The API responded with a #{status} error status."
+      end
+    end
+
+    BadRequestError          = Class.new(APIError)
+    NotFoundError            = Class.new(APIError)
+    UnprocessableEntityError = Class.new(APIError)
+  end
+end

data/lib/simple_jsonapi_client/redirection/fetch_all.rb

@@ -0,0 +1,43 @@
+require 'simple_jsonapi_client/redirection/proxy'
+
+module SimpleJSONAPIClient
+  module Redirection
+    class FetchAll < ::SimpleJSONAPIClient::Redirection::Proxy
+      def_delegators :internal_object, *(Array.instance_methods(false) - instance_methods)
+      def_delegators :internal_enumerator, *(Enumerator.instance_methods(false) - instance_methods)
+
+      def initialize(base_opts, &operation)
+        @base_opts = base_opts
+        @operation = operation
+      end
+
+      private
+      attr_reader :base_opts, :operation
+
+      def pseudo_inspect
+        internal_enumerator.inspect
+      end
+
+      def fetch_internal_object
+        internal_enumerator.to_a
+      end
+
+      def internal_enumerator
+        @internal_enumerator ||= Enumerator.new do |yielder|
+          loop do
+            current_response = operation.call(current_opts)
+            current_response['data'].each do |record|
+              yielder << record
+            end
+            break unless (next_link = current_response.dig('links', 'next'))
+            current_opts.merge!(url_opts: {}, url: next_link)
+          end
+        end
+      end
+
+      def current_opts
+        @current_opts ||= base_opts.dup
+      end
+    end
+  end
+end

data/lib/simple_jsonapi_client/redirection/proxy.rb

@@ -0,0 +1,54 @@
+require 'delegate'
+
+module SimpleJSONAPIClient
+  module Redirection
+    class Proxy
+      extend Forwardable
+
+      def_delegator :internal_object, :nil?
+
+      def inspect
+        if @internal_object
+          @internal_object.inspect
+        else
+          pseudo_inspect
+        end
+      end
+
+      def method_missing(meth, *args, &block)
+        self.class.def_delegator :internal_object, meth
+        internal_object.__send__(meth, *args, &block)
+      end
+
+      def respond_to_missing?(*args)
+        internal_object.__send__(:respond_to?, *args)
+      end
+
+      def as_json
+        if internal_object.respond_to?(:as_json)
+          internal_object.as_json
+        elsif internal_object.is_a?(Array)
+          internal_object.map(&:as_json)
+        elsif nil?
+          nil
+        else
+          raise "Cannot convert #{inspect} to JSON!"
+        end
+      end
+
+      private
+
+      def internal_object
+        @internal_object ||= fetch_internal_object
+      end
+
+      def pseudo_inspect
+        raise NotImplementedError
+      end
+
+      def fetch_internal_object
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/simple_jsonapi_client/relationships/array_data_relationship.rb

@@ -0,0 +1,19 @@
+require 'simple_jsonapi_client/relationships/data_relationship_proxy'
+
+module SimpleJSONAPIClient
+  module Relationships
+    class ArrayDataRelationship < DataRelationshipProxy
+      private
+
+      def pseudo_inspect
+        "#<#{self.class.name} model_class=#{@klass} ids=#{@record_or_records.map { |record| record['id'] }}>"
+      end
+
+      def fetch_internal_object
+        @record_or_records.map { |record|
+          instantiated_relationship_record(record)
+        }
+      end
+    end
+  end
+end

data/lib/simple_jsonapi_client/relationships/array_link_relationship.rb

@@ -0,0 +1,15 @@
+require 'simple_jsonapi_client/relationships/link_relationship_proxy'
+
+module SimpleJSONAPIClient
+  module Relationships
+    class ArrayLinkRelationship < LinkRelationshipProxy
+      def_delegators :internal_object, *(Array.instance_methods(false) - instance_methods)
+
+      private
+
+      def fetch_internal_object
+        @klass.fetch_all(connection: @connection, url: @url)
+      end
+    end
+  end
+end

data/lib/simple_jsonapi_client/relationships/data_relationship_proxy.rb

@@ -0,0 +1,30 @@
+require 'simple_jsonapi_client/redirection/proxy'
+
+module SimpleJSONAPIClient
+  module Relationships
+    class DataRelationshipProxy < ::SimpleJSONAPIClient::Redirection::Proxy
+      def initialize(klass, records, included, connection)
+        @klass = klass
+        @record_or_records = records
+        @included = included
+        @connection = connection
+      end
+
+      private
+
+      def instantiated_relationship_record(record)
+        @klass.model_from(
+          initialization_data(record),
+          @included,
+          @connection
+        )
+      end
+
+      def initialization_data(record)
+        @included.fetch(record) do
+          { 'attributes' => nil, 'relationships' => nil }.merge!(record)
+        end
+      end
+    end
+  end
+end

data/lib/simple_jsonapi_client/relationships/has_many_relationship.rb

@@ -0,0 +1,16 @@
+require 'simple_jsonapi_client/relationships/array_data_relationship'
+require 'simple_jsonapi_client/relationships/array_link_relationship'
+
+module SimpleJSONAPIClient
+  module Relationships
+    class HasManyRelationship < Relationship
+      def call(info, included, connection)
+        if (records = info['data'])
+          ArrayDataRelationship.new(model_class, records, included, connection)
+        elsif (link = link_from(info))
+          ArrayLinkRelationship.new(model_class, connection, link)
+        end
+      end
+    end
+  end
+end

data/lib/simple_jsonapi_client/relationships/has_one_relationship.rb

@@ -0,0 +1,16 @@
+require 'simple_jsonapi_client/relationships/singular_data_relationship'
+require 'simple_jsonapi_client/relationships/singular_link_relationship'
+
+module SimpleJSONAPIClient
+  module Relationships
+    class HasOneRelationship < Relationship
+      def call(info, included, connection)
+        if (record = info['data'])
+          SingularDataRelationship.new(model_class, record, included, connection)
+        elsif (link = link_from(info))
+          SingularLinkRelationship.new(model_class, connection, link)
+        end
+      end
+    end
+  end
+end

data/lib/simple_jsonapi_client/relationships/link_relationship_proxy.rb

@@ -0,0 +1,19 @@
+require 'simple_jsonapi_client/redirection/proxy'
+
+module SimpleJSONAPIClient
+  module Relationships
+    class LinkRelationshipProxy < ::SimpleJSONAPIClient::Redirection::Proxy
+      def initialize(klass, connection, url)
+        @klass = klass
+        @connection = connection
+        @url = url
+      end
+
+      private
+
+      def pseudo_inspect
+        "#<#{self.class.name} model_class=#{@klass} url=#{@url}>"
+      end
+    end
+  end
+end

data/lib/simple_jsonapi_client/relationships/relationship.rb

@@ -0,0 +1,34 @@
+module SimpleJSONAPIClient
+  module Relationships
+    class Relationship
+      def initialize(model_class, url_opts = {})
+        @model_class = model_class
+        @url_opts = url_opts
+      end
+
+      def call(*args)
+        raise NotImplementedError
+      end
+
+      private
+      attr_reader :url_opts
+
+      def model_class
+        @evaluated_model_class ||=
+          case @model_class
+          when String
+            Kernel::const_get(@model_class)
+          else
+            @model_class
+          end
+      end
+
+      def link_from(info)
+        info['links'].to_h.values_at('related', 'self').compact.first
+      end
+    end
+  end
+end
+
+require 'simple_jsonapi_client/relationships/has_many_relationship'
+require 'simple_jsonapi_client/relationships/has_one_relationship'

data/lib/simple_jsonapi_client/relationships/singular_data_relationship.rb

@@ -0,0 +1,17 @@
+require 'simple_jsonapi_client/relationships/data_relationship_proxy'
+
+module SimpleJSONAPIClient
+  module Relationships
+    class SingularDataRelationship < DataRelationshipProxy
+      private
+
+      def pseudo_inspect
+        "#<#{self.class.name} model_class=#{@klass} id=#{@record_or_records['id']}}>"
+      end
+
+      def fetch_internal_object
+        instantiated_relationship_record(@record_or_records)
+      end
+    end
+  end
+end

data/lib/simple_jsonapi_client/relationships/singular_link_relationship.rb

@@ -0,0 +1,13 @@
+require 'simple_jsonapi_client/relationships/link_relationship_proxy'
+
+module SimpleJSONAPIClient
+  module Relationships
+    class SingularLinkRelationship < LinkRelationshipProxy
+      private
+
+      def fetch_internal_object
+        @klass.fetch(connection: @connection, url: @url)
+      end
+    end
+  end
+end

data/lib/simple_jsonapi_client/version.rb

@@ -0,0 +1,3 @@
+module SimpleJSONAPIClient
+  VERSION = "0.1.0"
+end

data/simple_jsonapi_client.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "simple_jsonapi_client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_jsonapi_client"
+  spec.version       = SimpleJSONAPIClient::VERSION
+  spec.authors       = ["Ariel Caplan"]
+  spec.email         = ["arielmcaplan@gmail.com"]
+
+  spec.summary       = %q{Framework for writing clients for JSONAPI APIs in Ruby.}
+  spec.homepage      = "https://github.com/amcaplan/simple_jsonapi_client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 0.12"
+  spec.add_dependency "faraday_middleware", "~> 0.11"
+  spec.add_dependency "activesupport", ">= 3.1.12", "< 6"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0"
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: simple_jsonapi_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ariel Caplan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.12
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.12
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: 
+email:
+- arielmcaplan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Dockerfile
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/development_start
+- bin/rails
+- bin/setup
+- bin/wait_for_it
+- docker-compose.yml
+- lib/simple_jsonapi_client.rb
+- lib/simple_jsonapi_client/base.rb
+- lib/simple_jsonapi_client/error.rb
+- lib/simple_jsonapi_client/errors/api_error.rb
+- lib/simple_jsonapi_client/redirection/fetch_all.rb
+- lib/simple_jsonapi_client/redirection/proxy.rb
+- lib/simple_jsonapi_client/relationships/array_data_relationship.rb
+- lib/simple_jsonapi_client/relationships/array_link_relationship.rb
+- lib/simple_jsonapi_client/relationships/data_relationship_proxy.rb
+- lib/simple_jsonapi_client/relationships/has_many_relationship.rb
+- lib/simple_jsonapi_client/relationships/has_one_relationship.rb
+- lib/simple_jsonapi_client/relationships/link_relationship_proxy.rb
+- lib/simple_jsonapi_client/relationships/relationship.rb
+- lib/simple_jsonapi_client/relationships/singular_data_relationship.rb
+- lib/simple_jsonapi_client/relationships/singular_link_relationship.rb
+- lib/simple_jsonapi_client/version.rb
+- simple_jsonapi_client.gemspec
+homepage: https://github.com/amcaplan/simple_jsonapi_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: []
+rubyforge_project: 
+rubygems_version: 2.7.1
+signing_key: 
+specification_version: 4
+summary: Framework for writing clients for JSONAPI APIs in Ruby.
+test_files: []