whiplash-app 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5b252f73755dcd2e6cc7d907d0009393a0661993
-  data.tar.gz: d38c18badde2221b2c9de962db701ca54a486739
+SHA256:
+  metadata.gz: f5d805e2893ed8f2276b6beb9cb3803784466eed89cbe8526b0322b552c56cb6
+  data.tar.gz: '04628b22e8d4d2ac908c7f3f8fd2d2e70d37e209708a55e329add9ec59f2c195'
 SHA512:
-  metadata.gz: ae66c0ded848674943ad97c2781236569d4d3cfff515ad30218b7025028660ce0cf10374f243d516b553781ca3a023460ca4b25e21713225b0a135c3ec6708cb
-  data.tar.gz: '04845cdd6a2eb36c1f05b43932f11bf25c6d32d0c91fbb74db2cb7f23b5ca9d84d3f8719fe58926831a4d26c1c07119aa03d3b74a92b7f1528f706fa169b37f1'
+  metadata.gz: c9b01590969f01f35c5b7c153df98b553cac683dfa3b0cbfeb1f428fa9844a0824f3c6c8294ef40342689579eec5b8c47907945ee7c3808d7188acdec5f4ee1f
+  data.tar.gz: 9bda8b451dd1ba823d906b54f11b023cf2bef90ba6c21bd1533eb4083d84f8f7258f4a084c6b58a2bd6e49d5d9cfe748a08f9648815dddcbb07f48ba66b1684d

data/lib/errors/whiplash_api_error.rb

@@ -0,0 +1,94 @@
+class WhiplashApiError < StandardError
+  class Deadlock < WhiplashApiError
+  end
+
+  class Timeout < WhiplashApiError
+  end
+
+  class Configuration < WhiplashApiError
+  end
+
+  class Inventory < WhiplashApiError
+  end
+
+  class Ignore < WhiplashApiError
+  end
+
+  # 400
+  class BadRequest < WhiplashApiError
+  end
+
+  # 401
+  class Unauthorized < WhiplashApiError
+  end
+
+  # 403
+  class Forbidden < WhiplashApiError
+  end
+
+  # 404
+  class RecordNotFound < WhiplashApiError
+  end
+
+  # 405
+  class MethodNotAllowed < WhiplashApiError
+  end
+
+  # 406
+  class NotAcceptable < WhiplashApiError
+  end
+
+  # 408
+  class Timeout < WhiplashApiError
+  end
+
+  # 409
+  class Conflict < WhiplashApiError
+  end
+
+  # 415
+  class UnsupportedMediaType < WhiplashApiError
+  end
+
+  # 422
+  class UnprocessableEntity < WhiplashApiError
+  end
+
+  # 429
+  class OverRateLimit < WhiplashApiError
+  end
+
+  class SSLError < WhiplashApiError
+  end
+
+  # 500+
+  class InternalServerError < WhiplashApiError
+  end
+
+  # 503
+  class ServiceUnavailable < WhiplashApiError
+  end
+
+  # ???
+  class UnknownError < WhiplashApiError
+  end
+
+  def self.codes
+    {
+      400 => WhiplashApiError::BadRequest,
+      401 => WhiplashApiError::Unauthorized,
+      403 => WhiplashApiError::Forbidden,
+      404 => WhiplashApiError::RecordNotFound,
+      405 => WhiplashApiError::MethodNotAllowed,
+      406 => WhiplashApiError::NotAcceptable,
+      408 => WhiplashApiError::Timeout,
+      409 => WhiplashApiError::Conflict,
+      415 => WhiplashApiError::UnsupportedMediaType,
+      422 => WhiplashApiError::UnprocessableEntity,
+      429 => WhiplashApiError::OverRateLimit,
+      495 => WhiplashApiError::SSLError,
+      500 => WhiplashApiError::InternalServerError,
+      503 => WhiplashApiError::ServiceUnavailable
+    }
+  end
+end

data/lib/whiplash/app/api_config.rb

@@ -18,6 +18,10 @@ module Whiplash
         ENV["WHIPLASH_API_URL"] || "https://sandbox.getwhiplash.com"
       end
 
+      def rate_limit
+        ENV['WHIPLASH_RATE_LIMIT'] || 25
+      end
+
     end
   end
 end

data/lib/whiplash/app/connections.rb

@@ -2,7 +2,7 @@ module Whiplash
   class App
     module Connections
 
-      def app_request(options = {})
+      def base_app_request(options={})
         if options[:params][:id]
           endpoint = [options[:endpoint], options[:params].delete(:id)].join('/')
         else
@@ -11,10 +11,49 @@ module Whiplash
         options[:headers] ||= {}
         options[:headers][:customer_id] ||= customer_id if customer_id
         options[:headers][:shop_id] ||= shop_id if shop_id
-        connection.send(options[:method],
-                        endpoint,
-                        options[:params],
-                        sanitize_headers(options[:headers]))
+
+        args = [
+          options[:method],
+          endpoint,
+          options[:params],
+          sanitize_headers(options[:headers])
+        ]
+
+        connection.send(*args)
+      end
+
+      def app_request(options={})
+        return base_app_request(options) unless defined?(Sidekiq)
+        limiter = Sidekiq::Limiter.window('whiplash-core', self.rate_limit, :second, wait_timeout: 15)
+        limiter.within_limit do
+          base_app_request(options)
+        end
+      end
+
+      def app_request!(options = {})
+        begin
+          app_request(options)
+        rescue Faraday::ConnectionFailed => e
+          case e.message
+          when 'end of file reached'
+            store_whiplash_error!(:eof, options)
+            Rails.logger.error "[Whiplash][EOF] Failed to connect to #{url}"
+            raise ProviderError::InternalServerError, e.message
+          when 'Net::OpenTimeout'
+            store_whiplash_error!(:timeout, options)
+            Rails.logger.error "[Whiplash][Timeout] Request to #{url} timed out"
+            raise ProviderError::Timeout, e.message
+          else
+            store_whiplash_error!(:connection, options)
+            Rails.logger.error "[Whiplash] Request to #{url} failed"
+            raise ProviderError::InternalServerError, e.message
+          end
+        end
+        return response.body if response.success?
+        message = response.body if response.body.is_a? String
+        message = response.body.dig('error') if response.body.respond_to?(:dig)
+        store_whiplash_error!(response.status)
+        error_response(response.status, 'Whiplash', message)
       end
 
       def delete(endpoint, params = {}, headers = nil)
@@ -45,6 +84,34 @@ module Whiplash
                     headers: headers)
       end
 
+      def delete!(endpoint, params = {}, headers = nil)
+        app_request!(method: :delete,
+                    endpoint: endpoint,
+                    params: params,
+                    headers: headers)
+      end
+
+      def get!(endpoint, params = {}, headers = nil)
+        app_request!(method: :get,
+                    endpoint: endpoint,
+                    params: params,
+                    headers: headers)
+      end
+
+      def post!(endpoint, params = {}, headers = nil)
+        app_request!(method: :post,
+                    endpoint: endpoint,
+                    params: params,
+                    headers: headers)
+      end
+
+      def put!(endpoint, params = {}, headers = nil)
+        app_request!(method: :put,
+                    endpoint: endpoint,
+                    params: params,
+                    headers: headers)
+      end
+
       def sanitize_headers(headers)
         if headers
           {}.tap do |hash|
@@ -55,6 +122,36 @@ module Whiplash
         end
       end
 
+      def store_whiplash_error!(error, options={})
+        return unless defined?(Appsignal)
+        options = options.with_indifferent_access
+        Appsignal.increment_counter(
+          "whiplash_error",
+          1.0,
+          shop_id: options[:shop_id],
+          customer_id: options[:customer_id],
+          error: error.to_s
+        )
+      end
+
+      def error_codes
+        WhiplashApiError.codes
+      end
+
+      def select_error(status_code)
+        unless error_codes.keys.include? status_code
+          Rails.logger.info "[Provider] Unknown status code from #{self.class.name}: #{status_code}"
+          return WhiplashApiError::UnknownError
+        end
+        error_codes[status_code]
+      end
+
+      # Select an applicable error message on a request to a provider.
+      def error_response(status_code, message=nil)
+        message ||= "Your request has been denied as a #{status_code} error"
+        raise select_error(status_code), message
+      end
+
     end
   end
 end

data/lib/whiplash/app/version.rb

@@ -1,5 +1,5 @@
 module Whiplash
   class App
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whiplash-app
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Don Sullivan, Mark Dickson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-12 00:00:00.000000000 Z
+date: 2019-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -110,6 +110,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/errors/whiplash_api_error.rb
 - lib/whiplash/app.rb
 - lib/whiplash/app/api_config.rb
 - lib/whiplash/app/caching.rb
@@ -138,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: this gem provides connectivity to the Whiplash API for authentication and