whiplash-app 0.4.0 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5b252f73755dcd2e6cc7d907d0009393a0661993
-  data.tar.gz: d38c18badde2221b2c9de962db701ca54a486739
+SHA256:
+  metadata.gz: 3d70f904d63e4b816748c23f7a3287763420f8c222b2e7e4c63519c63614613f
+  data.tar.gz: 3a267c71d211814b6e85bfd8fa8075d1f048a90f936187b4353a0d36bc40b4d2
 SHA512:
-  metadata.gz: ae66c0ded848674943ad97c2781236569d4d3cfff515ad30218b7025028660ce0cf10374f243d516b553781ca3a023460ca4b25e21713225b0a135c3ec6708cb
-  data.tar.gz: '04845cdd6a2eb36c1f05b43932f11bf25c6d32d0c91fbb74db2cb7f23b5ca9d84d3f8719fe58926831a4d26c1c07119aa03d3b74a92b7f1528f706fa169b37f1'
+  metadata.gz: 27d80f78a200d4d202b1236941ec7b7c5b3b2e185bdcf3c51ba98ce7304010cc258c350f2cf524d684343eae2c8111f837ced586b10fda93439ed2f1e608a556
+  data.tar.gz: 92bcf7a2e0bc197d7b97aba7d4748fe4759b9ede63cf60ec9027645b44ee4155057b2e6b63ed2177b2a6d208fb8563409cf2d7dae0bb68a04cca0e8c0eed8e8c

data/.gitignore

@@ -9,3 +9,4 @@
 /tmp/
 .env
 .ruby-version
+.idea/*

data/lib/errors/whiplash_api_error.rb

@@ -0,0 +1,99 @@
+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
+
+  # 502
+  class Timeout < 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,
+      502 => WhiplashApiError::Timeout,
+      503 => WhiplashApiError::ServiceUnavailable
+    }
+  end
+end

data/lib/whiplash/app.rb

@@ -4,6 +4,7 @@ require "whiplash/app/connections"
 require "whiplash/app/finder_methods"
 require "whiplash/app/signing"
 require "whiplash/app/version"
+require "errors/whiplash_api_error"
 require "oauth2"
 require "faraday_middleware"
 
@@ -19,11 +20,18 @@ module Whiplash
 
     def initialize(token=nil, options={})
       opts = options.with_indifferent_access
+      token ||= cache_store["whiplash_api_token"]
       @token = format_token(token) unless token.nil?
       @customer_id = options[:customer_id]
       @shop_id = options[:shop_id]
     end
 
+    def self.whiplash_api_token
+      store = Moneta.new(:Redis, host: ENV["REDIS_HOST"], port: ENV["REDIS_PORT"], password: ENV["REDIS_PASSWORD"], expires: 7200)
+      cache_store = Moneta::Namespace.new store, Whiplash::App::Caching.namespace_value
+      cache_store["whiplash_api_token"]
+    end
+
     def client
       OAuth2::Client.new(ENV["WHIPLASH_CLIENT_ID"], ENV["WHIPLASH_CLIENT_SECRET"], site: api_url)
     end
@@ -56,7 +64,7 @@ module Whiplash
 
     def token_expired?
       return token.expired? unless token.blank?
-      return true unless cache_store.has_key?("whiplash_api_token")
+      return true unless cache_store.key?("whiplash_api_token")
       return true if cache_store["whiplash_api_token"].blank?
       false
     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).to_i
+      end
+
     end
   end
 end

data/lib/whiplash/app/caching.rb

@@ -7,13 +7,13 @@ module Whiplash
       def cache_store
         if ENV["REDIS_HOST"]
           store = Moneta.new(:Redis, host: ENV["REDIS_HOST"], port: ENV["REDIS_PORT"], password: ENV["REDIS_PASSWORD"], expires: 7200)
-          Moneta::Namespace.new store, namespace_value
+          Moneta::Namespace.new store, Whiplash::App::Caching.namespace_value
         else
           Moneta.new(:File, dir: "tmp", expires: 7200)
         end
       end
 
-      def namespace_value
+      def self.namespace_value
         ENV["REDIS_NAMESPACE"] || ENV["WHIPLASH_CLIENT_ID"]
       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
+          response = app_request(options)
+          return response 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, message)
+        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
       end
 
       def delete(endpoint, params = {}, headers = nil)
@@ -45,6 +84,65 @@ 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 get_body_or_empty(endpoint, params = {}, headers = nil)
+        response = get(endpoint, params, headers)
+        if !response.success?
+          case response.status
+          when 500
+            Appsignal.send_error(WhiplashApiError::InternalServerError.new(response.body), {raised: false})
+          else
+          end
+
+          case get_context(endpoint)
+          when 'collection'
+            Rails.logger.info "[WhiplashApi] Returned #{response.status}. Returning an empty array..."
+            return []
+          when 'member'
+            Rails.logger.info "[WhiplashApi] Returned #{response.status}. Returning nil..."
+            return nil
+          when 'aggregate'
+            Rails.logger.info "[WhiplashApi] Returned #{response.status}. Returning an empty hash..."
+            return {}
+          end
+        end
+        response.body
+      end
+
+      def get_context(endpoint)
+        parts = endpoint.split('/').compact
+        return 'member' if (parts.last =~ /\d+/).present?
+        return 'aggregate' if parts.include?('aggregate')
+        'collection'
+      end
+
       def sanitize_headers(headers)
         if headers
           {}.tap do |hash|
@@ -55,6 +153,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.6.2"
   end
 end

data/whiplash-app.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "moneta", "~> 0.8.0"
 
   spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry" , '~> 0.12.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whiplash-app
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.2
 platform: ruby
 authors:
 - Don Sullivan, Mark Dickson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-12 00:00:00.000000000 Z
+date: 2020-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -70,16 +70,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
 description: this gem provides connectivity to the Whiplash API for authentication
   and REST requests.
 email:
@@ -103,6 +117,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".idea/.gitignore"
 - ".rspec"
 - ".travis.yml"
 - Gemfile
@@ -110,6 +125,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 +154,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