zaikio-client-helpers 0.1.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3409eab2392246cb7990f31dff3d24b47fa8616b150ad217ed0bb5a7f89607a9
-  data.tar.gz: cefdc3ec682204a0552484e0d37ad06dda3449ff05c0ec00637aa4b85c695415
+  metadata.gz: b04e37308c3d4d671262df75c9e71a56feccfa2ecbddd561a5c495d9bb08116c
+  data.tar.gz: f9cd398097d4e20637398ce37bf75cd035d52385f6beafb58d32c8d787ac50b5
 SHA512:
-  metadata.gz: a0b859d93659e155556e14c36b66b7ab2fbadcea7922f226b431e34d13668104144441239de59656055f321b92d84fc246ce1fe60f295f82d57a5f5879d7360a
-  data.tar.gz: e420427ff71df44f79ef37fa59ccb54a22c2becf3863021ce80b2a3164806c8336c0701ce0809f7571e9e7efd5c66dac07829adf861e15e4410900ac0632ac0f
+  metadata.gz: 41d8e99d08d8dc5bc2f6cfcb247285857222a830ac74a73da9339cd293aedf43fdcd0ac74a9fb4d08479028c7a34956c1afb00406a7655e33769fbca39132a47
+  data.tar.gz: '08baf07f1cee0553900681da973abd696ab9f12b40c4dd03d8df46fb27402d20716721dd537908b77c14993e9b0ca5f59fe798ca0ae8f8cf00562cee2f8ac41a'

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 ## [Unreleased]
 
+## [0.2.2] - 2021-08-12
+
+- Attempt to fix `NoMethodError` when looking for pagination headers
+
+## [0.2.1] - 2021-08-05
+
+- Fixed `with_fallback` from spyke by aliasing the correct error classes
+
+## [0.2.0] - 2021-07-22
+
+- Add `Zaikio:Error` and allow setting arbitrary attributes on the exceptions
+- Add `Zaikio::RateLimitedError` when HTTP 429 occurs (note that this subclasses
+  `Zaikio::ConnectionError` so all existing error handling should continue to work).
+
+## [0.1.1] - 2021-06-18
+
+- Require `zaikio/client/model` as part of gem loading to avoid need to load it elsewhere
+- Fix message about total number of pages - count pages, not objects!
+
 ## [0.1.0] - 2021-06-17
 
 - Initial release

data/lib/zaikio-client-helpers.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
 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"

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

@@ -4,15 +4,21 @@ 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)
+      case env.status
+      when 404 then raise Spyke::ResourceNotFound.new(nil, url: env.url)
+      when 429 then raise Zaikio::RateLimitedError.new(nil, url: env.url)
+      when (200..299), 422 then env.body = parse_body(env.body)
+      else connection_error(env)
+      end
     end
 
     def connection_error(env)
-      raise Spyke::ConnectionError, "Status: #{env.status}, URL: #{env.url}, body: #{env.body}"
+      raise Spyke::ConnectionError.new(
+        "Status: #{env.status}, URL: #{env.url}, body: #{env.body}",
+        status: env.status,
+        url: env.url,
+        body: env.body
+      )
     end
 
     def parse_body(body)

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

@@ -63,7 +63,7 @@ module Zaikio::Client::Helpers
     class Relation < Spyke::Relation
       HEADERS.each_key do |symbol|
         define_method(symbol) do
-          find_some.metadata[METADATA_KEY][symbol]
+          find_some.metadata.dig(METADATA_KEY, symbol)
         end
       end
 
@@ -97,7 +97,7 @@ module Zaikio::Client::Helpers
         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?
+        puts "There are #{total_pages} pages, I will load more pages automatically" if first_page?
         clone.page(next_page).each(&block)
       end
 

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

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

data/lib/zaikio/error.rb

@@ -0,0 +1,31 @@
+module Zaikio
+  class Error < StandardError
+    def initialize(message = nil, **opts)
+      super(message)
+
+      opts.each do |key, value|
+        ivar = "@#{key}".to_sym
+        instance_variable_set(ivar, value)
+        define_singleton_method(key) { instance_variable_get(ivar) }
+      end
+    end
+  end
+
+  class ResourceNotFound < Zaikio::Error; end
+
+  class ConnectionError < Zaikio::Error; end
+  class RateLimitedError < ConnectionError; end
+end
+
+require "spyke"
+
+module Spyke
+  instance_eval do
+    # avoid warning: already initialized constant
+    remove_const("ConnectionError")
+    remove_const("ResourceNotFound")
+  end
+
+  ConnectionError = Zaikio::ConnectionError
+  ResourceNotFound = Zaikio::ResourceNotFound
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zaikio-client-helpers
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Zaikio GMBH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-18 00:00:00.000000000 Z
+date: 2021-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -96,6 +96,7 @@ files:
 - lib/zaikio/client/helpers/pagination.rb
 - lib/zaikio/client/helpers/version.rb
 - lib/zaikio/client/model.rb
+- lib/zaikio/error.rb
 homepage: https://github.com/zaikio/zaikio-client-helpers
 licenses:
 - MIT
@@ -111,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="