zaikio-client-helpers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3409eab2392246cb7990f31dff3d24b47fa8616b150ad217ed0bb5a7f89607a9
+  data.tar.gz: cefdc3ec682204a0552484e0d37ad06dda3449ff05c0ec00637aa4b85c695415
+SHA512:
+  metadata.gz: a0b859d93659e155556e14c36b66b7ab2fbadcea7922f226b431e34d13668104144441239de59656055f321b92d84fc246ce1fe60f295f82d57a5f5879d7360a
+  data.tar.gz: e420427ff71df44f79ef37fa59ccb54a22c2becf3863021ce80b2a3164806c8336c0701ce0809f7571e9e7efd5c66dac07829adf861e15e4410900ac0632ac0f

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-06-17
+
+- Initial release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Zaikio GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,84 @@
+# Zaikio::Client::Helpers
+
+A small gem which includes helpers for parsing & pagination when working with
+Zaikio APIs using the [Spyke] library. Parts of this are referenced in:
+
+  * [Zaikio Hub Client]
+  * [Zaikio Procurement Client]
+
+[Spyke]: https://github.com/balvig/spyke
+[Zaikio Hub Client]: https://github.com/zaikio/zaikio-hub-ruby
+[Zaikio Procurement Client]: https://github.com/zaikio/zaikio-procurement-ruby
+
+## Installation
+
+1. Add to your gemspec or Gemfile:
+
+```ruby
+spec.add_dependency "zaikio-client-helpers"
+```
+
+2. Require it when your code is loaded:
+
+```ruby
+require "zaikio-client-helpers"
+```
+
+3. Extend the base class for your models:
+
+```ruby
+class User < Zaikio::Client::Model
+  # ...
+end
+```
+
+## Parsing API responses
+
+Spyke needs a couple of extra things in addition to JSON parsing, so this library exposes
+a Spyke-compatible JSON parser that raises the correct exceptions when things go wrong:
+
+```ruby
+Faraday.new do |f|
+  f.use Zaikio::Client::Helpers::JSONParser
+  ...
+end
+```
+
+> Note: if you're also using the pagination middleware below, you should set this
+> middleware _after_ the pagination middleware, because it needs to run before pagination
+> can happen.
+
+## Automatic pagination
+
+First, we need to configure the Faraday middleware, wherever the Faraday::Connection is
+constructed:
+
+```ruby
+Faraday.new do |f|
+  f.use Zaikio::Client::Helpers::Pagination::FaradayMiddleware
+  f.use Zaikio::Client::Helpers::JSONParser
+  ...
+end
+```
+
+If you aren't inheriting `Zaikio::Client::Model`, you should mixin our pagination library
+like so: `include Zaikio::Client::Helpers::Pagination`.
+
+The library works by overriding the `#all` method on a relation, so it will keep fetching
+pages from the remote API until there are none left:
+
+```ruby
+Model.all.map(&:id)
+#=> There are 3 pages, I will load more pages automatically
+#=> [1,2,3]
+```
+
+If you wish to opt-out of automatic pagination, you can use the Lazy version (don't forget
+to call `each` or `to_a` to materialize the records):
+
+```ruby
+Model.all.lazy.take(2).map(&:id).to_a
+```
+
+Note that if the endpoint doesn't support pagination (i.e. doesn't return a `Current-Page`
+header), pagination is automatically disabled.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/lib/zaikio-client-helpers.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "zaikio/client/helpers/version"
+require_relative "zaikio/client/helpers/json_parser"
+require_relative "zaikio/client/helpers/pagination"

data/lib/zaikio/client/helpers/json_parser.rb

@@ -0,0 +1,33 @@
+require "faraday"
+require "multi_json"
+
+module Zaikio::Client::Helpers
+  class JSONParser < Faraday::Response::Middleware
+    def on_complete(env)
+      connection_error(env) unless /^(2\d\d)|422|404$/.match?(env.status.to_s)
+
+      raise Spyke::ResourceNotFound if env.status.to_s == "404"
+
+      env.body = parse_body(env.body)
+    end
+
+    def connection_error(env)
+      raise Spyke::ConnectionError, "Status: #{env.status}, URL: #{env.url}, body: #{env.body}"
+    end
+
+    def parse_body(body)
+      json = MultiJson.load(body, symbolize_keys: true)
+      {
+        data: json,
+        metadata: {},
+        errors: json.is_a?(Hash) ? json[:errors] : {}
+      }
+    rescue MultiJson::ParseError
+      {
+        data: {},
+        metadata: {},
+        errors: {}
+      }
+    end
+  end
+end

data/lib/zaikio/client/helpers/pagination.rb

@@ -0,0 +1,111 @@
+require "faraday"
+require "spyke"
+
+module Zaikio::Client::Helpers
+  module Pagination
+    HEADERS = {
+      total_count: "Total-Count",
+      total_pages: "Total-Pages",
+      current_page: "Current-Page"
+    }.freeze
+
+    METADATA_KEY = :pagination
+
+    # Faraday Middleware for extracting any pagination headers into the a top-level
+    # :metadata hash, or the env hash for non-JSON responses.
+    #
+    # @example Usage
+    #   conn = Faraday.new do |f|
+    #     f.use Zaikio::Client::Helpers::Pagination::FaradayMiddleware
+    #   end
+    #
+    #   response = conn.get("/")
+    #   response.env[METADATA_KEY]
+    #   #=> {total_count: 4, total_pages: 1, current_page: 1}
+    class FaradayMiddleware < Faraday::Response::Middleware
+      def on_complete(env)
+        @env = env
+
+        metadata = HEADERS.transform_values do |key|
+          header(key)
+        end
+
+        if env.body.is_a?(Hash)
+          @env.body[:metadata] ||= {}
+          @env.body[:metadata][METADATA_KEY] = metadata
+        else
+          @env[METADATA_KEY] = metadata
+        end
+      end
+
+      private
+
+      def header(key)
+        value = @env.response_headers[key]
+        value.try(:to_i)
+      end
+    end
+
+    extend ActiveSupport::Concern
+
+    included do
+      scope :page, ->(value) { where(page: value) }
+      scope :per_page, ->(value) { where(per_page: value) }
+    end
+
+    module ClassMethods
+      # Overrides the method included by Spyke::Scoping to return paginated relations.
+      def all
+        current_scope || Relation.new(self, uri: uri)
+      end
+    end
+
+    class Relation < Spyke::Relation
+      HEADERS.each_key do |symbol|
+        define_method(symbol) do
+          find_some.metadata[METADATA_KEY][symbol]
+        end
+      end
+
+      def first_page?
+        current_page == 1
+      end
+
+      def next_page
+        current_page + 1
+      end
+
+      def last_page?
+        current_page >= total_pages
+      end
+
+      def supports_pagination?
+        current_page.present?
+      end
+
+      # Unlike the default implementation in Spyke, this version of #each is recursive
+      # and will repeatedly paginate through the remote API until it runs out of
+      # records.
+      #
+      # To avoid this behaviour, you can ask for a Lazy enumerator to take just the
+      # records you need, e.g.:
+      #   User.all.lazy.take(3).to_a
+      #   #=> [.., .., ..]
+      def each(&block)
+        return to_enum(:each) unless block_given?
+
+        find_some.each(&block)
+        return if !supports_pagination? || last_page?
+
+        puts "There are #{total_count} pages, I will load more pages automatically" if first_page?
+        clone.page(next_page).each(&block)
+      end
+
+      def clone
+        # We use cloning when fetching a second page using the same scope/query, however
+        # we want to clear any loaded records from @find_some before doing so.
+        super.tap { |obj| obj.instance_variable_set(:@find_some, nil) }
+      end
+    end
+  end
+end

data/lib/zaikio/client/helpers/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Zaikio
+  module Client
+    module Helpers
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/zaikio/client/model.rb

@@ -0,0 +1,9 @@
+require_relative "helpers/pagination"
+
+module Zaikio
+  module Client
+    class Model < Spyke::Base
+      include Helpers::Pagination
+    end
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: zaikio-client-helpers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zaikio GMBH
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: multi_json
+  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: spyke
+  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: vcr
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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:
+- suppoert@zaikio.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/zaikio-client-helpers.rb
+- lib/zaikio/client/helpers/json_parser.rb
+- lib/zaikio/client/helpers/pagination.rb
+- lib/zaikio/client/helpers/version.rb
+- lib/zaikio/client/model.rb
+homepage: https://github.com/zaikio/zaikio-client-helpers
+licenses:
+- MIT
+metadata:
+  changelog_uri: https://github.com/zaikio/zaikio-client-helpers/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/zaikio/zaikio-client-helpers
+  source_code_uri: https://github.com/zaikio/zaikio-client-helpers
+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.2.15
+signing_key: 
+specification_version: 4
+summary: Small meta-gem with middleware and tools for working with Zaikio APIs
+test_files: []