zaikio-client-helpers 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b04e37308c3d4d671262df75c9e71a56feccfa2ecbddd561a5c495d9bb08116c
-  data.tar.gz: f9cd398097d4e20637398ce37bf75cd035d52385f6beafb58d32c8d787ac50b5
+  metadata.gz: a7c1175b44ca6b5ce9c35a6c24e3c2c546da668af38553303510b6e3ebb549f5
+  data.tar.gz: 57f77bce22039beedee0f51da1ff1655dc3e602de987d3d13ce594337e5f37c0
 SHA512:
-  metadata.gz: 41d8e99d08d8dc5bc2f6cfcb247285857222a830ac74a73da9339cd293aedf43fdcd0ac74a9fb4d08479028c7a34956c1afb00406a7655e33769fbca39132a47
-  data.tar.gz: '08baf07f1cee0553900681da973abd696ab9f12b40c4dd03d8df46fb27402d20716721dd537908b77c14993e9b0ca5f59fe798ca0ae8f8cf00562cee2f8ac41a'
+  metadata.gz: 1eeb54b3661b5aa9d7730fa2751e1632273a63011cf3259f7db5df8228bd9b1208951b692332a54bf449750f1bde6ef8ea23f97d3927c896f96042a628e7d508
+  data.tar.gz: a22972654c7b0a53f5844a7005d3afb08345cfab355d5493ff58c99fb2e28030f54854bc8bdb32aec118723470df0cd58d98ba101feaf1e04ff16f6295eceb3b

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 ## [Unreleased]
 
+## [0.3.0] - 2022-08-15
+
+- Add `Zaikio::Client::Helpers::AuthorizationMiddleware` and `Zaikio::Client.with_token` to pass down bearer token to multiple clients (e.g. hub + procurement) at the same time
+- Add `Zaikio::Client::Helpers::Configuration` as an abstract configuration class
+- Add `Zaikio::Client.create_connection`
+
+## [0.2.4] - 2022-03-29
+
+- Add support for Faraday 2.x
+
+## [0.2.3] - 2021-11-12
+
+- Handle "uncountable" responses (i.e. those without a Total-Count or Total-Pages header)
+
 ## [0.2.2] - 2021-08-12
 
 - Attempt to fix `NoMethodError` when looking for pagination headers

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

@@ -0,0 +1,27 @@
+require "faraday"
+
+module Zaikio
+  module Client
+    module Helpers
+      class AuthorizationMiddleware < Faraday::Middleware
+        def self.token
+          Thread.current[:zaikio_client_access_token]
+        end
+
+        def self.token=(value)
+          Thread.current[:zaikio_client_access_token] = value
+        end
+
+        def self.reset_token
+          Thread.current[:zaikio_client_access_token] = nil
+        end
+
+        def call(request_env)
+          request_env[:request_headers]["Authorization"] = "Bearer #{self.class.token}" if self.class.token
+
+          @app.call(request_env)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+require "logger"
+
+module Zaikio
+  module Client
+    module Helpers
+      class Configuration
+        attr_accessor :host
+        attr_reader :environment
+        attr_writer :logger
+
+        def self.hosts
+          raise NotImplementedError
+        end
+
+        def initialize
+          self.environment = :sandbox
+        end
+
+        def logger
+          @logger ||= Logger.new($stdout)
+        end
+
+        def environment=(env)
+          @environment = env.to_sym
+          @host = host_for(environment)
+        end
+
+        private
+
+        def host_for(environment)
+          self.class.hosts.fetch(environment) do
+            raise "Invalid Zaikio::Client environment '#{environment}'"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -2,7 +2,13 @@ require "faraday"
 require "multi_json"
 
 module Zaikio::Client::Helpers
-  class JSONParser < Faraday::Response::Middleware
+  superclass = if Gem.loaded_specs["faraday"].version >= Gem::Version.new("2.0")
+    Faraday::Middleware
+  else
+    Faraday::Response::Middleware
+  end
+
+  JSONParser = Class.new(superclass) do
     def on_complete(env)
       case env.status
       when 404 then raise Spyke::ResourceNotFound.new(nil, url: env.url)

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

@@ -11,6 +11,12 @@ module Zaikio::Client::Helpers
 
     METADATA_KEY = :pagination
 
+    superclass = if Gem.loaded_specs["faraday"].version >= Gem::Version.new("2.0")
+      Faraday::Middleware
+    else
+      Faraday::Response::Middleware
+    end
+
     # Faraday Middleware for extracting any pagination headers into the a top-level
     # :metadata hash, or the env hash for non-JSON responses.
     #
@@ -22,7 +28,7 @@ module Zaikio::Client::Helpers
     #   response = conn.get("/")
     #   response.env[METADATA_KEY]
     #   #=> {total_count: 4, total_pages: 1, current_page: 1}
-    class FaradayMiddleware < Faraday::Response::Middleware
+    FaradayMiddleware = Class.new(superclass) do
       def on_complete(env)
         @env = env
 
@@ -76,7 +82,11 @@ module Zaikio::Client::Helpers
       end
 
       def last_page?
-        current_page >= total_pages
+        if total_pages.nil?
+          find_some.empty?
+        else
+          current_page >= total_pages
+        end
       end
 
       def supports_pagination?

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

@@ -3,7 +3,7 @@
 module Zaikio
   module Client
     module Helpers
-      VERSION = "0.2.2"
+      VERSION = "0.3.0"
     end
   end
 end

data/lib/zaikio/client.rb

@@ -0,0 +1,31 @@
+require "zaikio/client/model"
+require "zaikio/client/helpers/json_parser"
+require "zaikio/client/helpers/pagination"
+require "zaikio/client/helpers/configuration"
+require "zaikio/client/helpers/authorization_middleware"
+
+module Zaikio
+  module Client
+    class << self
+      def with_token(token)
+        original_token = Helpers::AuthorizationMiddleware.token
+        Helpers::AuthorizationMiddleware.token = token
+        yield
+      ensure
+        Helpers::AuthorizationMiddleware.token = original_token
+      end
+
+      def create_connection(configuration)
+        Faraday.new(url: configuration.host,
+                                      ssl: { verify: configuration.environment != :test }) do |c|
+          c.request     :json
+          c.response    :logger, configuration&.logger, headers: false
+          c.use         Zaikio::Client::Helpers::Pagination::FaradayMiddleware
+          c.use         Zaikio::Client::Helpers::JSONParser
+          c.use         Zaikio::Client::Helpers::AuthorizationMiddleware
+          c.adapter     Faraday.default_adapter
+        end
+      end
+    end
+  end
+end

data/lib/zaikio-client-helpers.rb

@@ -3,6 +3,4 @@
 require_relative "zaikio/client/helpers/version"
 
 require_relative "zaikio/error"
-require_relative "zaikio/client/model"
-require_relative "zaikio/client/helpers/json_parser"
-require_relative "zaikio/client/helpers/pagination"
+require_relative "zaikio/client"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zaikio-client-helpers
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Zaikio GMBH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-13 00:00:00.000000000 Z
+date: 2022-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -42,16 +48,16 @@ dependencies:
   name: spyke
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -92,6 +98,9 @@ files:
 - README.md
 - Rakefile
 - lib/zaikio-client-helpers.rb
+- lib/zaikio/client.rb
+- lib/zaikio/client/helpers/authorization_middleware.rb
+- lib/zaikio/client/helpers/configuration.rb
 - lib/zaikio/client/helpers/json_parser.rb
 - lib/zaikio/client/helpers/pagination.rb
 - lib/zaikio/client/helpers/version.rb