iron_bank 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 91fae8e035b3b2912c560e92f1082514e24fbf53a38ea9a3b2b64afd18a363fa
-  data.tar.gz: 16a00f1540532b6f3c6473e8d7e66c18ef5acaed7754b3097957222db1aa27ba
+SHA1:
+  metadata.gz: 901b217a92f89e748bd3e766c6d079ed15da7805
+  data.tar.gz: bacc2026bf92a9dceb35592c4c1306cac08cfaf5
 SHA512:
-  metadata.gz: 1194bc5b7a1fc98a4aaa20b5060fa02bc9e58b43e40c87aa8bc67b7c7728ee312c796943c4eaf6e3981d19cbfe9fe682287e2beb35302ece13a2fe47eec12877
-  data.tar.gz: 664e41aafd6c72aebb4930ff03e436fb9196bfc5439293cdb6d9aeb92426d7d71d23e66d05b2a4132d95fd6016ad30522b7be892e9ff2c5f07c7c16d572f40cf
+  metadata.gz: 592874e55ed11e85cdcb6877becf2b2d5635536414781c5c5e20e66d68859d5743b7a86559e8f962fdb5c29a96b219323e74af262dd54286a67fcecd584dd2af
+  data.tar.gz: 658224c2ae4b3f8ae18fea954a68d5ee73a05966d07d299a06985eec6599df655b58f9d325cf655ebbeac6d4af52bf60258512a7439b3211b5951aac99c4538c

data/.reek.yml

@@ -64,9 +64,7 @@ detectors:
       - IronBank::Resources::ProductRatePlanChargeTier#self.load_records
 
   NilCheck:
-    exclude:
-      - IronBank::Local#load_records
-      - IronBank::Resources::ProductRatePlanChargeTier#self.load_records
+    enabled: false
 
   TooManyInstanceVariables:
     max_instance_variables: 6
@@ -80,6 +78,7 @@ detectors:
       - IronBank::Client#connection
       - IronBank::Configuration#schema_directory=
       - IronBank::Configuration#initialize
+      - IronBank::Error#message_from_body
       - IronBank::Queryable#find_each
       - IronBank::Queryable#where
       - IronBank::Utils#camelize

data/iron_bank.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bump',             '~> 0.5'
-  spec.add_development_dependency 'bundler',          '~> 1.15'
+  spec.add_development_dependency 'bundler',          '~> 2.0'
   spec.add_development_dependency 'dotenv',           '~> 2.2'
   spec.add_development_dependency 'factory_bot',      '~> 4.10'
   spec.add_development_dependency 'pry-byebug',       '~> 3.4'

data/lib/iron_bank.rb

@@ -58,7 +58,7 @@ require 'iron_bank/version'
 require 'iron_bank/csv'
 require 'iron_bank/error'
 require 'iron_bank/faraday_middleware/raise_error'
-require 'iron_bank/faraday_middleware/retriable_auth'
+require 'iron_bank/faraday_middleware/renew_auth'
 require 'iron_bank/faraday_middleware'
 
 # Helpers

data/lib/iron_bank/action.rb

@@ -13,7 +13,7 @@ module IronBank
     def call
       @body = IronBank.client.connection.post(endpoint, params).body
 
-      raise ::IronBank::UnprocessableEntity, errors unless success?
+      raise ::IronBank::UnprocessableEntityError, errors unless success?
 
       IronBank::Object.new(body).deep_underscore
     end

data/lib/iron_bank/client.rb

@@ -16,6 +16,12 @@ module IronBank
     #
     class InvalidHostname < Error; end
 
+    RETRIABLE_ERRORS = [
+      IronBank::LockCompetitionError,
+      IronBank::TemporaryError,
+      IronBank::UnauthorizedError
+    ].freeze
+
     # Alias each actions as a `Client` instance method
     IronBank::Actions.constants.each do |action|
       method_name = IronBank::Utils.underscore(action)
@@ -41,15 +47,27 @@ module IronBank
       validate_domain
       reset_connection if auth.expired?
 
+      retry_options = {
+        max:                 4,
+        interval:            0.1,
+        interval_randomness: 0.05,
+        backoff_factor:      5,
+        exceptions:          RETRIABLE_ERRORS,
+        retry_if:            ->(_, ex) { RETRIABLE_ERRORS.include?(ex.class) }
+      }
+
       @connection ||= Faraday.new(faraday_config) do |conn|
-        conn.use      :ddtrace, open_tracing_options if open_tracing_enabled?
-        conn.use      instrumenter, instrumenter_options if instrumenter
         conn.request  :json
-        conn.request  :retry, max: 2, exceptions: [IronBank::Unauthorized]
-        conn.use      :raise_error
-        conn.request  :retriable_auth, auth
+        conn.request  :retry, retry_options
+
+        conn.response :raise_error
+        conn.response :renew_auth, auth
         conn.response :logger, IronBank.logger
         conn.response :json, content_type: /\bjson$/
+
+        conn.use      :ddtrace, open_tracing_options if open_tracing_enabled?
+        conn.use      instrumenter, instrumenter_options if instrumenter
+
         conn.adapter  Faraday.default_adapter
       end
     end

data/lib/iron_bank/error.rb

@@ -6,24 +6,42 @@ module IronBank
     # Returns the appropriate IronBank::Error subclass based on status and
     # response message
     def self.from_response(response)
-      status = response[:status].to_i
-
       klass = begin
-        case status
-        when 400      then IronBank::BadRequest
-        when 401      then IronBank::Unauthorized
-        when 404      then IronBank::NotFound
-        when 422      then IronBank::UnprocessableEntity
-        when 429      then IronBank::TooManyRequests
+        case response.status
+        when 200      then from_body(response)
+        when 400      then IronBank::BadRequestError
+        when 401      then IronBank::UnauthorizedError
+        when 404      then IronBank::NotFoundError
+        when 422      then IronBank::UnprocessableEntityError
+        when 429      then IronBank::TooManyRequestsError
         when 500      then IronBank::InternalServerError
         when 400..499 then IronBank::ClientError
         when 500..599 then IronBank::ServerError
+        else               IronBank::Error
         end
       end
 
-      return unless klass
+      klass&.new(response)
+    end
+
+    def self.from_body(response)
+      return unless (match = CODE_MATCHER.match(response.body.to_s))
+
+      CODE_CLASSES[match.captures.first]
+    end
+
+    attr_reader :response
+
+    def initialize(response = nil)
+      @response = response
+
+      message = response.is_a?(Faraday::Response) ? message_from_body : response
 
-      klass.new(response)
+      super(message)
+    end
+
+    def message_from_body
+      response && "Body: #{response.body}"
     end
   end
 
@@ -31,23 +49,57 @@ module IronBank
   class ClientError < Error; end
 
   # Raised when Zuora returns a 400 HTTP status code
-  class BadRequest < ClientError; end
+  class BadRequestError < ClientError; end
 
   # Raised when Zuora returns a 401 HTTP status code
-  class Unauthorized < Error; end
+  class UnauthorizedError < ClientError; end
 
   # Raised when Zuora returns a 404 HTTP status code
-  class NotFound < ClientError; end
+  class NotFoundError < ClientError; end
+
+  # Zuora doesn't return a 409, but indicates it via the response
+  class ConflictError < ClientError; end
 
   # Raised when Zuora return 422 and unsuccessful action responses
-  class UnprocessableEntity < Error; end
+  class UnprocessableEntityError < ClientError; end
 
   # Raised when Zuora returns a 429 HTTP status code
-  class TooManyRequests < ClientError; end
+  class TooManyRequestsError < ClientError; end
 
   # Raised on errors in the 500-599 range
   class ServerError < Error; end
 
   # Raised when Zuora returns a 500 HTTP status code
   class InternalServerError < ServerError; end
+
+  # Zuora doesn't return a 502, but indicates it via the response
+  class BadGatewayError < ServerError; end
+
+  # Zuora indicates a temporary error via the response
+  class TemporaryError < ServerError; end
+
+  # Zuora indicates lock competition errors via the response
+  class LockCompetitionError < TemporaryError; end
+
+  CODE_CLASSES = {
+    'API_DISABLED'           => ServerError,
+    'CANNOT_DELETE'          => UnprocessableEntityError,
+    'DUPLICATE_VALUE'        => ConflictError,
+    'INVALID_FIELD'          => BadRequestError,
+    'INVALID_ID'             => BadRequestError,
+    'INVALID_TYPE'           => BadRequestError,
+    'INVALID_VALUE'          => BadRequestError,
+    'LOCK_COMPETITION'       => LockCompetitionError,
+    'MALFORMED_QUERY'        => ClientError,
+    'MISSING_REQUIRED_VALUE' => ClientError,
+    'REQUEST_EXCEEDED_LIMIT' => TooManyRequestsError,
+    'REQUEST_EXCEEDED_RATE'  => TooManyRequestsError,
+    'TEMPORARY_ERROR'        => TemporaryError,
+    'TRANSACTION_FAILED'     => InternalServerError,
+    'TRANSACTION_TERMINATED' => InternalServerError,
+    'TRANSACTION_TIMEOUT'    => BadGatewayError,
+    'UNKNOWN_ERROR'          => InternalServerError
+  }.freeze
+
+  CODE_MATCHER = /(#{CODE_CLASSES.keys.join('|')})/.freeze
 end

data/lib/iron_bank/faraday_middleware.rb

@@ -4,12 +4,11 @@
 module IronBank
   # IronBank Faraday middleware module
   module FaradayMiddleware
-    if Faraday::Middleware.respond_to? :register_middleware
-      Faraday::Middleware.register_middleware \
-        raise_error: -> { RaiseError }
-
-      Faraday::Request.register_middleware \
-        retriable_auth: -> { RetriableAuth }
+    if Faraday::Middleware.respond_to?(:register_middleware)
+      Faraday::Response.register_middleware(
+        raise_error: -> { RaiseError },
+        renew_auth:  -> { RenewAuth }
+      )
     end
   end
 end

data/lib/iron_bank/faraday_middleware/raise_error.rb

@@ -9,8 +9,8 @@ module IronBank
     class RaiseError < Faraday::Response::Middleware
       private
 
-      def on_complete(response)
-        (error = IronBank::Error.from_response(response)) && raise(error)
+      def on_complete(env)
+        (error = IronBank::Error.from_response(env.response)) && raise(error)
       end
     end
   end

data/lib/iron_bank/faraday_middleware/{retriable_auth.rb → renew_auth.rb}

@@ -5,17 +5,17 @@ module IronBank
   # IronBank Faraday middleware module
   module FaradayMiddleware
     # This middleware reauthorize the request on unauthorized request
-    class RetriableAuth < Faraday::Middleware
+    class RenewAuth < Faraday::Response::Middleware
       def initialize(app, auth)
         @auth = auth
+
         super(app)
       end
 
-      def call(env)
+      def on_complete(env)
         @env = env
-        renew_auth_header if env.status == 401
 
-        @app.call(env)
+        renew_auth_header if env.status == 401
       end
 
       private

data/lib/iron_bank/queryable.rb

@@ -6,7 +6,7 @@ module IronBank
   module Queryable
     # We use the REST endpoint for the `find` method
     def find(id)
-      raise IronBank::NotFound unless id
+      raise IronBank::NotFoundError unless id
 
       response = IronBank.client.connection.get(
         "v1/object/#{object_name}/#{id}"

data/lib/iron_bank/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module IronBank
-  VERSION     = '2.0.2'
+  VERSION     = '2.1.0'
   API_VERSION = 'v1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iron_bank
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Mickael Pham
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-03 00:00:00.000000000 Z
+date: 2019-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -33,14 +33,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -321,7 +321,7 @@ files:
 - lib/iron_bank/error.rb
 - lib/iron_bank/faraday_middleware.rb
 - lib/iron_bank/faraday_middleware/raise_error.rb
-- lib/iron_bank/faraday_middleware/retriable_auth.rb
+- lib/iron_bank/faraday_middleware/renew_auth.rb
 - lib/iron_bank/instrumentation.rb
 - lib/iron_bank/local.rb
 - lib/iron_bank/local_records.rb
@@ -380,7 +380,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.14.3
 signing_key: 
 specification_version: 4
 summary: An opinionated Ruby interface to the Zuora API.