whiplash-app 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3925f8e5706f3b3a36144ad80df98efa751630299d2bbc8f3c3a942fd75e6c8
-  data.tar.gz: 522d2ed541e7a6a70140de1967bdcc74c1b4a0b13b329495e60fd4b2cf9c1614
+  metadata.gz: 216d093d7f7c804c1f6b7563a429e7d0ed70cf31e90eb56266e03c086107863a
+  data.tar.gz: bd62a9c2da9f0a603c13c7c40e99a0bfd1e6b48b958cd20f9c74f02613d3dd70
 SHA512:
-  metadata.gz: ab92fa0ff5e7c87765a03c2097f0a3dd2f0cbf5d757a60cf54353511bf6571fb2811e71000880e1bcd20482b212bcfb47d8a9b8d69dfaff5b5eb1d8772d22a5b
-  data.tar.gz: 0e3af57cdab4d9956c38dce8cf1eb55e0f1d53b05ab3e21c31a06a4bb4dc13f15ddb1ef7f886d1ea3ac45920ef0dbd3f0ea4f83e37121ce0536cf345cb2eae7f
+  metadata.gz: f3ee8b0c5c9817ddbc3231889abe2d4edd95873234674c8a2da66e418cc262810a5424813f8144439a43fdc40765bc6e0fab10dfcb540cf9d6e2a1896393ae58
+  data.tar.gz: a2281f059a7d4c227d7d6a89cedeb75e082dcdaa2fb2799e9a3f36f205881f07813530ac120718035d702476c176a11e1f58a0a084e736790ede55f7991ef00c

data/.travis.yml

@@ -1,4 +1,4 @@
 language: ruby
 rvm:
-  - 2.2.3
-before_install: gem install bundler -v 1.11.2
+  - 2.6.7
+before_install: gem install bundler -v 2.2.25

data/lib/errors/whiplash_api_error.rb

@@ -65,6 +65,10 @@ class WhiplashApiError < StandardError
   class InternalServerError < WhiplashApiError
   end
 
+  # 502
+  class Timeout < WhiplashApiError
+  end
+
   # 503
   class ServiceUnavailable < WhiplashApiError
   end
@@ -88,6 +92,7 @@ class WhiplashApiError < StandardError
       429 => WhiplashApiError::OverRateLimit,
       495 => WhiplashApiError::SSLError,
       500 => WhiplashApiError::InternalServerError,
+      502 => WhiplashApiError::Timeout,
       503 => WhiplashApiError::ServiceUnavailable
     }
   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,6 +2,8 @@ module Whiplash
   class App
     module Connections
 
+      PER_PAGE_REQUEST_LIMIT = 50
+
       def base_app_request(options={})
         if options[:params][:id]
           endpoint = [options[:endpoint], options[:params].delete(:id)].join('/')
@@ -11,6 +13,7 @@ module Whiplash
         options[:headers] ||= {}
         options[:headers][:customer_id] ||= customer_id if customer_id
         options[:headers][:shop_id] ||= shop_id if shop_id
+        options[:headers][:version] ||= 2
 
         args = [
           options[:method],
@@ -32,7 +35,12 @@ module Whiplash
 
       def app_request!(options = {})
         begin
-          app_request(options)
+          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'
@@ -49,11 +57,32 @@ module Whiplash
             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, message)
+      end
+
+      def multi_page_get!(endpoint, params = {}, headers = nil)
+        results = []
+        page = 1
+        params[:per_page] = PER_PAGE_REQUEST_LIMIT
+
+        loop do
+          partial_results_request = app_request!(
+            method: :get,
+            endpoint: endpoint,
+            params: params,
+            headers: headers
+          ).body
+
+          results << partial_results_request
+          results.flatten!
+
+          page += 1
+          params[:page] = page
+
+          break if partial_results_request.size == 0
+          break if partial_results_request.size < PER_PAGE_REQUEST_LIMIT
+        end
+
+        results
       end
 
       def delete(endpoint, params = {}, headers = nil)
@@ -112,10 +141,44 @@ module Whiplash
                     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' unless (parts.last =~ /\d+/).nil?
+        return 'aggregate' if parts.include?('aggregate')
+        'collection'
+      end
+
       def sanitize_headers(headers)
-        if headers
-          {}.tap do |hash|
-            headers.each do |k,v|
+        return if headers.nil? || headers.empty?
+        out = {}.tap do |hash|
+          headers.each do |k,v|
+            if k.to_s == 'version'
+              hash['Accept-Version'] = "v#{v}"
+            else
               hash["X-#{k.to_s.upcase.gsub('_','-')}"] = v.to_s
             end
           end
@@ -124,7 +187,7 @@ module Whiplash
 
       def store_whiplash_error!(error, options={})
         return unless defined?(Appsignal)
-        options = options.with_indifferent_access
+        options.transform_keys!(&:to_sym)
         Appsignal.increment_counter(
           "whiplash_error",
           1.0,

data/lib/whiplash/app/signing.rb

@@ -15,7 +15,11 @@ module Whiplash
       private
 
       def request_body(body)
-        body.blank? ? ENV["WHIPLASH_CLIENT_ID"] : body
+        begin
+          (body.nil? || body.empty?) ? ENV["WHIPLASH_CLIENT_ID"] : body
+        rescue NoMethodError => e
+          ENV["WHIPLASH_CLIENT_ID"]
+        end
       end
     end
   end

data/lib/whiplash/app/version.rb

@@ -1,5 +1,5 @@
 module Whiplash
   class App
-    VERSION = "0.5.1"
+    VERSION = "0.7.0"
   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"
 
@@ -18,18 +19,29 @@ module Whiplash
     attr_accessor :customer_id, :shop_id, :token
 
     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]
+      @api_version = options[:api_version] || 2 # can be 2_1
+    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
 
+    def versioned_api_url
+      "api/v#{@api_version}"
+    end
+
     def connection
-      out = Faraday.new [api_url, "api/v2"].join("/") do |conn|
+      out = Faraday.new [api_url, versioned_api_url].join("/") do |conn|
         conn.request :oauth2, token.token, token_type: "bearer"
         conn.request :json
         conn.response :json, :content_type => /\bjson$/
@@ -44,34 +56,41 @@ module Whiplash
     end
 
     def refresh_token!
-      if token.blank? # If we're storing locally, grab a new token and cache it
-        access_token = client.client_credentials.get_token(scope: ENV["WHIPLASH_CLIENT_SCOPE"])
-        new_token = access_token.to_hash
-        cache_store["whiplash_api_token"] = new_token
+      case ENV["WHIPLASH_CLIENT_SCOPE"]
+      when /app_(manage|read)/
+        begin
+          access_token = client.client_credentials.get_token(scope: ENV["WHIPLASH_CLIENT_SCOPE"])
+          new_token = access_token.to_hash
+          cache_store["whiplash_api_token"] = new_token
+        rescue URI::InvalidURIError => e
+          raise StandardError, "The provide URL (#{ENV["WHIPLASH_API_URL"]}) is not valid"
+        end
       else
+        raise StandardError, "You must request an access token before you can refresh it" if token.nil?
+        raise StandardError, "Token must either be a Hash or an OAuth2::AccessToken" unless token.is_a?(OAuth2::AccessToken)
         access_token = token.refresh!
       end
       self.token = access_token
     end
 
     def token_expired?
-      return token.expired? unless token.blank?
-      return true unless cache_store.has_key?("whiplash_api_token")
-      return true if cache_store["whiplash_api_token"].blank?
+      return token.expired? unless token.nil?
+      return true unless cache_store.key?("whiplash_api_token")
+      return true if cache_store["whiplash_api_token"].nil?
+      return true if cache_store["whiplash_api_token"].empty?
       false
     end
 
     private
     def format_token(oauth_token)
-      unless oauth_token.is_a?(OAuth2::AccessToken)
-        raise StandardError, "Token must either be a Hash or an OAuth2::AccessToken" unless oauth_token.is_a?(Hash)
-        oauth_token['expires'] = oauth_token['expires'].to_s # from_hash expects 'true'
-        if oauth_token.has_key?('token')
-          oauth_token['access_token'] = oauth_token['token']
-          oauth_token.delete('token')
-        end
-        oauth_token = OAuth2::AccessToken.from_hash(client, oauth_token)
+      return oauth_token if oauth_token.is_a?(OAuth2::AccessToken)
+      raise StandardError, "Token must either be a Hash or an OAuth2::AccessToken" unless oauth_token.is_a?(Hash)
+      oauth_token['expires'] = oauth_token['expires'].to_s # from_hash expects 'true'
+      if oauth_token.has_key?('token')
+        oauth_token['access_token'] = oauth_token['token']
+        oauth_token.delete('token')
       end
+      oauth_token = OAuth2::AccessToken.from_hash(client, oauth_token)
     end
 
   end

data/whiplash-app.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday_middleware", "~> 0.11.0"
   spec.add_dependency "moneta", "~> 0.8.0"
 
-  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "bundler", ">= 2.2"
   spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry" , '~> 0.12.2'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whiplash-app
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Don Sullivan, Mark Dickson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-20 00:00:00.000000000 Z
+date: 2021-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -56,16 +56,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -153,8 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: this gem provides connectivity to the Whiplash API for authentication and