whiplash-app 0.6.2 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d70f904d63e4b816748c23f7a3287763420f8c222b2e7e4c63519c63614613f
-  data.tar.gz: 3a267c71d211814b6e85bfd8fa8075d1f048a90f936187b4353a0d36bc40b4d2
+  metadata.gz: f264f95fe30e26b24988d6f8db597a349259a79ab9fb446402a3528569112fed
+  data.tar.gz: a07d6c73760ec2d98107b0510c7f7d9b3566a217afe364b2b53e9044eebe940f
 SHA512:
-  metadata.gz: 27d80f78a200d4d202b1236941ec7b7c5b3b2e185bdcf3c51ba98ce7304010cc258c350f2cf524d684343eae2c8111f837ced586b10fda93439ed2f1e608a556
-  data.tar.gz: 92bcf7a2e0bc197d7b97aba7d4748fe4759b9ede63cf60ec9027645b44ee4155057b2e6b63ed2177b2a6d208fb8563409cf2d7dae0bb68a04cca0e8c0eed8e8c
+  metadata.gz: 34d77d907ea7d03b60483b3fd7f6177e1a9c1d502cef48e27bccc77c8694849ded0a47e9f1155025602c4dcadb78af0753502e0ab46305ad7f411caa32a992ca
+  data.tar.gz: 356479891eb004b6beb00437452ed0b55190176618aff587fb3d5d9370c8689673a2388d1c6ae08e69f4c6472f8c0e134f910e152706aa8e04ac0c6e36143dc3

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/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],
@@ -56,6 +59,47 @@ module Whiplash
         end
       end
 
+      def multi_page_get!(endpoint, params = {}, headers = nil)
+        results = []
+        page = 1
+        params[:per_page] = PER_PAGE_REQUEST_LIMIT
+        response = nil
+
+        loop do
+          partial_results_request = app_request!(
+            method: :get,
+            endpoint: endpoint,
+            params: params,
+            headers: headers
+          )
+
+          if !partial_results_request.success?
+            response = Faraday::Response.new(
+              body: partial_results_request.body,
+              status: partial_results_request.status,
+              method: :get
+            )
+            break
+          end
+
+          results << partial_results_request.body
+          results.flatten!
+
+          page += 1
+          params[:page] = page
+
+          break if partial_results_request.body.size == 0
+          break if partial_results_request.body.size < PER_PAGE_REQUEST_LIMIT
+        end
+
+        response ||= Faraday::Response.new(
+          body: results,
+          status: 200,
+          method: :get
+        )
+
+      end
+
       def delete(endpoint, params = {}, headers = nil)
         app_request(method: :delete,
                     endpoint: endpoint,
@@ -138,15 +182,18 @@ module Whiplash
 
       def get_context(endpoint)
         parts = endpoint.split('/').compact
-        return 'member' if (parts.last =~ /\d+/).present?
+        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
@@ -155,7 +202,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.6.2"
+    VERSION = "0.8.1"
   end
 end

data/lib/whiplash/app.rb

@@ -19,11 +19,11 @@ 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
@@ -36,8 +36,12 @@ module Whiplash
       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$/
@@ -52,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 token.expired? unless token.nil?
       return true unless cache_store.key?("whiplash_api_token")
-      return true if cache_store["whiplash_api_token"].blank?
+      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

@@ -18,11 +18,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "oauth2", "~> 1.2.0"
-  spec.add_dependency "faraday_middleware", "~> 0.11.0"
+  spec.add_dependency "oauth2", "~> 2.0.4"
+  spec.add_dependency "faraday_middleware", "~> 1.2.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.6.2
+  version: 0.8.1
 platform: ruby
 authors:
 - Don Sullivan, Mark Dickson
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-13 00:00:00.000000000 Z
+date: 2022-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 2.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 2.0.4
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: moneta
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -138,7 +138,7 @@ files:
 homepage: https://github.com/whiplashmerch/whiplash-app
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -153,9 +153,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.0.9
+signing_key:
 specification_version: 4
 summary: this gem provides connectivity to the Whiplash API for authentication and
   REST requests.