zaikio-client-helpers 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f9d6f6f113ac843f051aa75868b818e5d61320f593f134b40355dcf453f27dd
-  data.tar.gz: 39fbcef434b1bdc0b6dd9a9116d0213a14ffb4cc92252c790ffb451656eade15
+  metadata.gz: 363d6b961f22895db699c5ee54243f515cc79845c95784958e66e72f58f568bd
+  data.tar.gz: 442e1e463e845d525829d908866d6f26fd48e9b4dfd3ba8a7927bd19d53b442c
 SHA512:
-  metadata.gz: a84a8904648fc53c027e645cf687e503667075cadc244bc31f5c988b2ce1573ea6fdf8e1b586b5abbb013b9ae96259d8c3f837481981b91056d067933869576b
-  data.tar.gz: 1136f7ce6cdd6da736c344c27beafb7ed5c275b95a4d993844c3e93f7e8f10b704b663e1b4446f7d7584eae7dc9896d2be79f2caebc66b8fa2933d1db94dd10b
+  metadata.gz: 4e9319b55e7e03a9ea0d13958ad0df34bfd1d92c832e5ef8669e0fc02933a60495069997f253e7cd1651f716d985fab00164b8305f71bc68998de481ec171c3d
+  data.tar.gz: 0e45c6d37c8ec0065b805c60e5f419a01a47673d988aaf36940d252b0df709609c3009f173ad0da5e97f947caadb6bb1be90ff0549e197d62e28a2f1981be108

data/CHANGELOG.md

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

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/version.rb

@@ -3,7 +3,7 @@
 module Zaikio
   module Client
     module Helpers
-      VERSION = "0.1.1"
+      VERSION = "0.2.0"
     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 = Class.new Zaikio::ConnectionError
+  ResourceNotFound = Class.new Zaikio::ResourceNotFound
+end

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.0
 platform: ruby
 authors:
 - Zaikio GMBH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-29 00:00:00.000000000 Z
+date: 2021-07-22 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