simple_jsonapi_client 0.1.0 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48b579116cf787a39e4a97030ad4961063c4db940ec2fbdee03353ae162d2b6b
-  data.tar.gz: 26ae2466b469d541e2ce3105db766fbcb4dc72c80d6ba49a284a2b8a432e2341
+  metadata.gz: 87849cea3879d98446f4b38def54869878ee782a4cd5982eba053ba38df0163e
+  data.tar.gz: 4abec126d2887df66b608c1497d70b5d539b74f4b83b5df3da2973c0012a04e7
 SHA512:
-  metadata.gz: 82279b13b63ae34daec3f2e72118108bf345d847a790e064aca6471b42bbb303d899d29cbafc76930c2738418835a69d4c918a119474d53b00ce06159b43c108
-  data.tar.gz: 1725ec376ef0e45f8e3a7bc59b59e473a516b047db2d061c5a469330e382eb18996464db771698c59a8cacd7ac21656f6252f1b753f0f5509b1312a8835a8f3c
+  metadata.gz: 6bbb34268e4fbeecebadca831d8ae1e7cf26e422f729973e837686eb3c1b918b23a1d557fd9f13d4cf2844578193470449aff1c165ad4e183d103d2945205ee7
+  data.tar.gz: 73086d69a203c6f67077540e13c02f549cf74009698991bd2f5c698aa8c5c847df8219f99ce49d917850da9323f0f742b659306984e82b24da8d7f77e98c46cf

data/.travis.yml

@@ -4,5 +4,7 @@ services:
   - docker
 before_install:
   - bin/setup
+  - gem install -v 2.2 bundler -N
+  - echo "$DOCKER_PASSWORD" | docker login -u "$DOCKER_USERNAME" --password-stdin
 script:
   - rake

data/Dockerfile

@@ -1,9 +1,9 @@
-FROM ruby:2.3.1
+FROM ruby:2.6.6
 RUN apt-get update -qq
-RUN gem update bundler
+RUN gem update --system
+RUN gem install -v 2.2.3 bundler -N
+ENV BUNDLER_VERSION=2.2
 RUN mkdir /simple_jsonapi_client
 WORKDIR /simple_jsonapi_client
-ADD Gemfile /simple_jsonapi_client/Gemfile
-ADD simple_jsonapi_client.gemspec /simple_jsonapi_client/simple_jsonapi_client.gemspec
-ADD . /simple_jsonapi_client
+ADD . .
 RUN bundle install

data/README.md

@@ -1,4 +1,5 @@
 [![Build Status](https://travis-ci.org/amcaplan/simple_jsonapi_client.svg?branch=master)](https://travis-ci.org/amcaplan/simple_jsonapi_client)
+[![Gem Version](https://badge.fury.io/rb/simple_jsonapi_client.svg)](https://badge.fury.io/rb/simple_jsonapi_client)
 
 # What is `SimpleJSONAPIClient`?
 
@@ -165,11 +166,28 @@ post.comments.first.author # will not make another web request
 
 `SimpleJSONAPIClient` will check the included records for related records you access through the returned model.
 
-And finally, you can use JSONAPI-style filtering as well:
+And finally, you can use JSONAPI-style filtering and pagination as well:
 
 ```ruby
+# Given 3 authors...
+JSONAPIAppClient::Author.fetch_all(connection: connection).to_a
+=> [#<JSONAPIAppClient::Author id=1 name="Filbert" posts=#<SimpleJSONAPIClient::Relationships::ArrayLinkRelationship model_class=JSONAPIAppClient::Post url=http://jsonapi_app_console:3002/authors/1/posts> comments=#<SimpleJSONAPIClient::Relationships::ArrayLinkRelationship model_class=JSONAPIAppClient::Comment url=http://jsonapi_app_console:3002/authors/1/comments>>,
+ #<JSONAPIAppClient::Author id=2 name="Dilbert" posts=#<SimpleJSONAPIClient::Relationships::ArrayLinkRelationship model_class=JSONAPIAppClient::Post url=http://jsonapi_app_console:3002/authors/2/posts> comments=#<SimpleJSONAPIClient::Relationships::ArrayLinkRelationship model_class=JSONAPIAppClient::Comment url=http://jsonapi_app_console:3002/authors/2/comments>>,
+ #<JSONAPIAppClient::Author id=3 name="Wilbert" posts=#<SimpleJSONAPIClient::Relationships::ArrayLinkRelationship model_class=JSONAPIAppClient::Post url=http://jsonapi_app_console:3002/authors/3/posts> comments=#<SimpleJSONAPIClient::Relationships::ArrayLinkRelationship model_class=JSONAPIAppClient::Comment url=http://jsonapi_app_console:3002/authors/3/comments>>]
+
+# Filtering by name
 JSONAPIAppClient::Author.fetch_all(connection: connection, filter_opts: { name: 'Filbert' }).to_a
 => [#<JSONAPIAppClient::Author id=1 name="Filbert" posts=#<SimpleJSONAPIClient::Relationships::ArrayLinkRelationship model_class=JSONAPIAppClient::Post url=http://jsonapi_app_console:3002/authors/1/posts> comments=#<SimpleJSONAPIClient::Relationships::ArrayLinkRelationship model_class=JSONAPIAppClient::Comment url=http://jsonapi_app_console:3002/authors/1/comments>>]
+
+# Just grabbing the last page
+JSONAPIAppClient::Author.fetch_all(connection: connection, page_opts: { size: 1, number: 3 }).to_a
+=> [#<JSONAPIAppClient::Author id=3 name="Wilbert" posts=#<SimpleJSONAPIClient::Relationships::ArrayLinkRelationship model_class=JSONAPIAppClient::Post url=http://jsonapi_app_console:3002/authors/3/posts> comments=#<SimpleJSONAPIClient::Relationships::ArrayLinkRelationship model_class=JSONAPIAppClient::Comment url=http://jsonapi_app_console:3002/authors/3/comments>>]
+
+# You can adjust the pagination strategy and SimpleJSONAPIClient will follow it, but return the same results
+JSONAPIAppClient::Author.fetch_all(connection: connection, page_opts: { size: 1, number: 1 }).to_a
+=> [#<JSONAPIAppClient::Author id=1 name="Filbert" posts=#<SimpleJSONAPIClient::Relationships::ArrayLinkRelationship model_class=JSONAPIAppClient::Post url=http://jsonapi_app_console:3002/authors/1/posts> comments=#<SimpleJSONAPIClient::Relationships::ArrayLinkRelationship model_class=JSONAPIAppClient::Comment url=http://jsonapi_app_console:3002/authors/1/comments>>,
+ #<JSONAPIAppClient::Author id=2 name="Dilbert" posts=#<SimpleJSONAPIClient::Relationships::ArrayLinkRelationship model_class=JSONAPIAppClient::Post url=http://jsonapi_app_console:3002/authors/2/posts> comments=#<SimpleJSONAPIClient::Relationships::ArrayLinkRelationship model_class=JSONAPIAppClient::Comment url=http://jsonapi_app_console:3002/authors/2/comments>>,
+ #<JSONAPIAppClient::Author id=3 name="Wilbert" posts=#<SimpleJSONAPIClient::Relationships::ArrayLinkRelationship model_class=JSONAPIAppClient::Post url=http://jsonapi_app_console:3002/authors/3/posts> comments=#<SimpleJSONAPIClient::Relationships::ArrayLinkRelationship model_class=JSONAPIAppClient::Comment url=http://jsonapi_app_console:3002/authors/3/comments>>]
 ```
 
 ## Creating

data/docker-compose.yml

@@ -2,6 +2,8 @@ version: '3'
 services:
   db:
     image: postgres
+    ports:
+      - "5432:5432"
   spec:
     build: .
     entrypoint: bin/wait_for_it jsonapi_app_spec:3001 -t 30 --
@@ -15,10 +17,9 @@ services:
       API_PORT: 3001
   jsonapi_app_spec:
     build: ./spec/jsonapi_app
-    entrypoint: bin/wait_for_it db:5432 -t 30 --
-    volumes:
-      - ./spec/jsonapi_app:/jsonapi_app
-      - /jsonapi_app/tmp/
+    entrypoint: bin/wait_for_it db:5432 -t 60 --
+    # volumes:
+      # - ./spec/jsonapi_app:/jsonapi_app
     command: bundle exec rails s -p 3001 -b '0.0.0.0'
     ports:
       - "3001:3001"
@@ -39,10 +40,9 @@ services:
       API_PORT: 3002
   jsonapi_app_console:
     build: ./spec/jsonapi_app
-    entrypoint: bin/wait_for_it db:5432 -t 30 --
-    volumes:
-      - ./spec/jsonapi_app:/jsonapi_app
-      - /jsonapi_app/tmp/
+    entrypoint: bin/wait_for_it db:5432 -t 60 --
+    # volumes:
+      # - ./spec/jsonapi_app:/jsonapi_app
     command: bundle exec rails s -p 3002 -b '0.0.0.0'
     ports:
       - "3002:3002"

data/lib/simple_jsonapi_client/base.rb

@@ -1,5 +1,4 @@
-require 'active_support/core_ext/hash/keys'
-require 'active_support/core_ext/hash/transform_values'
+require 'simple_jsonapi_client/utils'
 require 'simple_jsonapi_client/error'
 require 'simple_jsonapi_client/relationships/relationship'
 require 'simple_jsonapi_client/redirection/fetch_all'
@@ -163,10 +162,12 @@ module SimpleJSONAPIClient
                             url_opts: {},
                             url: self::COLLECTION_URL % url_opts,
                             filter_opts: {},
+                            page_opts: {},
                             includes: [])
         params = {}
         params[:include] = includes.join(',') unless includes.empty?
         params[:filter] = filter_opts unless filter_opts.empty?
+        params[:page] = page_opts unless page_opts.empty?
         connection.get(url, params)
       end
 
@@ -206,12 +207,22 @@ module SimpleJSONAPIClient
       def interpret_empty_response(response, connection)
       end
 
-      def interpreted_relationships(relationships)
-        relationships.transform_values { |value|
-          if (relationship = relationship_from(value))
-            { data: relationship }
-          end
-        }
+      if {}.respond_to?(:transform_values)
+        def interpreted_relationships(relationships)
+          relationships.transform_values { |value|
+            if (relationship = relationship_from(value))
+              { data: relationship }
+            end
+          }
+        end
+      else
+        def interpreted_relationships(relationships)
+          Utils.transform_values(relationships) { |value|
+            if (relationship = relationship_from(value))
+              { data: relationship }
+            end
+          }
+        end
       end
 
       def relationship_from(value)
@@ -236,12 +247,12 @@ module SimpleJSONAPIClient
     attr_reader :id, :context
 
     def initialize(meta: nil, id:, attributes: nil, relationships: nil, included: {}, connection:, context: nil)
-      @meta = meta.symbolize_keys if meta
+      @meta = Utils.symbolize_keys(meta) if meta
       @id = id
       @included = included
       @connection = connection
       @context = context
-      @attributes = attributes.symbolize_keys if attributes
+      @attributes = Utils.symbolize_keys(attributes) if attributes
       @input_relationships = relationships
     end
 
@@ -265,7 +276,7 @@ module SimpleJSONAPIClient
       @relationships ||=
         begin
           if input_relationships
-            relationships_to_models(input_relationships.symbolize_keys)
+            relationships_to_models(Utils.symbolize_keys(input_relationships))
           else
             loaded_record.relationships
           end

data/lib/simple_jsonapi_client/errors/api_error.rb

@@ -1,4 +1,5 @@
 require 'delegate'
+require 'forwardable'
 
 module SimpleJSONAPIClient
   module Errors

data/lib/simple_jsonapi_client/redirection/fetch_all.rb

@@ -3,8 +3,9 @@ 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_delegators :internal_enumerator, *(Enumerable.instance_methods(false) - instance_methods)
+      def_delegators :internal_object, :size, *(Array.instance_methods(false) - instance_methods)
 
       def initialize(base_opts, &operation)
         @base_opts = base_opts
@@ -29,8 +30,9 @@ module SimpleJSONAPIClient
             current_response['data'].each do |record|
               yielder << record
             end
-            break unless (next_link = current_response.dig('links', 'next'))
+            break unless (next_link = Utils.hash_dig(current_response, 'links', 'next'))
             current_opts.merge!(url_opts: {}, url: next_link)
+            current_opts.delete(:page_opts)
           end
         end
       end

data/lib/simple_jsonapi_client/utils.rb

@@ -0,0 +1,47 @@
+module SimpleJSONAPIClient
+  module Utils
+    class <<  self
+      # Implementation adapted from ActiveSupport
+      # Copyright (c) 2005-2019 David Heinemeier Hansson
+      # https://github.com/rails/rails/blob/b9ca94caea2ca6a6cc09abaffaad67b447134079/activesupport/lib/active_support/core_ext/hash/keys.rb
+      def symbolize_keys(hash)
+        result = {}
+        hash.each_key do |key|
+          result[(key.to_sym rescue key)] = hash[key]
+        end
+        result
+      end
+
+      def hash_dig(hash, *keys)
+        if hash.respond_to?(:dig)
+          hash.dig(*keys)
+        else
+          dig(hash, keys)
+        end
+      end
+
+      private
+
+      # Implementation adapted from the hash_dig gem, Copyright (c) 2015 Colin Kelley, MIT License
+      # https://github.com/Invoca/ruby_dig/blob/19fa8c1d2cc7706d015a3004f028169a2ff83391/lib/ruby_dig.rb
+      def dig(hash, key, *rest)
+        value = hash[key]
+        if value.nil? || rest.empty?
+          value
+        elsif value.is_a?(Hash) || value.is_a?(Array)
+          dig(value, *rest)
+        else
+          fail TypeError, "#{value.class} does not work with #dig" # should not happen with our use of #dig
+        end
+      end
+
+      def transform_values(hash)
+        result = {}
+        hash.each do |key, value|
+          result[key] = yield(value)
+        end
+        result
+      end
+    end
+  end
+end

data/lib/simple_jsonapi_client/version.rb

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

data/simple_jsonapi_client.gemspec

@@ -20,11 +20,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.12"
-  spec.add_dependency "faraday_middleware", "~> 0.11"
-  spec.add_dependency "activesupport", ">= 3.1.12", "< 6"
+  spec.add_dependency "faraday", ">= 0.12", "< 2.0"
+  spec.add_dependency "faraday_middleware", "> 0.11", "< 2.0"
 
-  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "bundler", "~> 2.2"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry", "~> 0"

metadata

@@ -1,77 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: simple_jsonapi_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.5
 platform: ruby
 authors:
 - Ariel Caplan
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-11-27 00:00:00.000000000 Z
+date: 2021-02-28 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'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.12'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !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'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: 3.1.12
+        version: '0.11'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -114,7 +106,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - arielmcaplan@gmail.com
 executables: []
@@ -151,13 +143,14 @@ files:
 - 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/utils.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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -172,9 +165,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.1
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Framework for writing clients for JSONAPI APIs in Ruby.
 test_files: []