zaikio-client-helpers 0.1.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f9d6f6f113ac843f051aa75868b818e5d61320f593f134b40355dcf453f27dd
-  data.tar.gz: 39fbcef434b1bdc0b6dd9a9116d0213a14ffb4cc92252c790ffb451656eade15
+  metadata.gz: 429b80bf8b9d429a9cebbf05e6621a37d891d5cedb9c12f92cdf87f8902006da
+  data.tar.gz: 448b5a7fe652b0c2cc540da2f8f33b1f689c3f29f16401e0828787cd72385108
 SHA512:
-  metadata.gz: a84a8904648fc53c027e645cf687e503667075cadc244bc31f5c988b2ce1573ea6fdf8e1b586b5abbb013b9ae96259d8c3f837481981b91056d067933869576b
-  data.tar.gz: 1136f7ce6cdd6da736c344c27beafb7ed5c275b95a4d993844c3e93f7e8f10b704b663e1b4446f7d7584eae7dc9896d2be79f2caebc66b8fa2933d1db94dd10b
+  metadata.gz: bb55ed4c40c35ae902df31aa4cc0a5e2600f9c48dfac43e50acde69f5af1ae1c76e46d3b94c5deb1205638ac30ca040b500c6dc9e16789dfd69e1d55ec6ac4f7
+  data.tar.gz: 0caa6bd56a7716321d8fb99b7b53132c23b0d83d7843e832b3c5cd557d86e9db249e3d6f6c41ec91b786a822e6a154a34c52d0d957deba26b2052e4065e7da06

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 ## [Unreleased]
 
+## [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
+
+## [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

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
 
@@ -76,7 +76,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.1.1"
+      VERSION = "0.2.3"
     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

data/lib/zaikio-client-helpers.rb

@@ -2,6 +2,7 @@
 
 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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zaikio-client-helpers
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Zaikio GMBH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-29 00:00:00.000000000 Z
+date: 2021-11-12 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:
   - - ">="