whiplash-app 0.9.1 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dccfbc052c641052a83cdaeeda9231a5303c96041f9755187cf59a0b5f48b7a8
-  data.tar.gz: 3dfb8c5cd0ac077c817a628bed55323907484ac32ccf566f1e7f778071942cc8
+  metadata.gz: 228da95848c936a8a771e6f67e6d4aa03899ab722274b2d355917593c9b83a89
+  data.tar.gz: 2f1f50222b2b7a578d23a88efdfd5328e2d0b772bdae0696249be13457e57db5
 SHA512:
-  metadata.gz: dc050d5563f89987d926714a04806f473f1df4f4943efbce813b61e22400061f620b95e3ec27396497e051d1267d3abd230252c402ca36fc579cb7cfcf9b592a
-  data.tar.gz: 53345d8bc82e9a3e8ac09e91cab22a7db12b0cc1c8e0bc1eaf80caf330384d08974d8b622cba21790bd1f4456a3a6607ccc27da216983c82b4ccb2f60570b6d2
+  metadata.gz: 31ba3a5b17e6679551d961ce009efb489e3a4a49bf0cf5cf8e9d4e978626c6ae825a38dad30d62552cf619e08a78a09066cd3ffb67a04599f5dcb6f7d01bc4a4
+  data.tar.gz: e845ad83845b36f932d21a3fd4fa283e8ef0fc45066cc37a82f80c3c178600a3c4870c76633f9ee88aad1967b16db7e7caf280a55e91b2f0d0d7fcf4ce6965e1

data/lib/whiplash/app/api_config.rb

@@ -10,6 +10,12 @@ module Whiplash
         end
       end
 
+      def rate_limit
+        (ENV['WHIPLASH_RATE_LIMIT'] || 25).to_i
+      end
+
+      private
+      
       def production_url
         ENV["WHIPLASH_API_URL"] || "https://www.getwhiplash.com"
       end
@@ -18,10 +24,6 @@ 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/canonical_host.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module Whiplash
+  class App
+    module CanonicalHost
+      extend ActiveSupport::Concern
+
+      private
+
+      def require_canonical_host!
+        canonical_host = ENV.fetch('CANONICAL_HOST', false).in?([true, 'true', 1, '1'])
+        return unless canonical_host
+        application_host = URI.parse(Rails.configuration.app_url).host
+        return if application_host == request.host
+        return unless request.method_symbol == :get # can't redirect PUT, POST, DELETE
+    
+        redirect_to_canonical_host request.query_parameters
+      end
+    
+      def redirect_to_canonical_host(query_params, status=301)
+        redirect_to "#{Rails.configuration.app_url}#{request.path}#{'?' if query_params.to_query.present?}#{query_params.to_query}", status: status
+      end
+
+    end
+  end
+end

data/lib/whiplash/app/connections.rb

@@ -27,7 +27,7 @@ module Whiplash
 
       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 = Sidekiq::Limiter.window('whiplash-core', self.class.rate_limit, :second, wait_timeout: 15)
         limiter.within_limit do
           base_app_request(options)
         end

data/lib/whiplash/app/controller_helpers.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+module Whiplash
+  class App
+    module ControllerHelpers
+      extend ActiveSupport::Concern
+
+      included do
+        helper_method :cookie_domain,
+                      :core_url,
+                      :core_url_for,
+                      :current_user
+      end 
+
+      private
+
+      def cookie_domain
+        '.' + URI.parse(core_url).host
+      end
+
+      def core_url
+        ENV['WHIPLASH_API_URL']
+      end
+
+      def core_url_for(path)
+        [core_url, path].join('/')
+      end
+
+      def current_user
+        return if cookies[:user].blank?
+        begin
+          @current_user ||= JSON.parse(cookies[:user])
+        rescue StandardError => e 
+          Rails.logger.warn "User could not be initialized: #{e.message}"
+          @current_user = nil
+        end
+      end
+
+      def http_scheme
+        URI(core_url).scheme
+      end
+
+      def init_whiplash_api(options = {})
+        return redirect_to core_url_for('login') if cookies[:oauth_token].blank?
+        token = {access_token: cookies[:oauth_token]}
+        begin 
+          @whiplash_api = Whiplash::App.new(token, options)
+        rescue StandardError => e 
+          Rails.logger.warn "API failed to initialize: #{e.message}"
+          @whiplash_api = nil
+        end
+      end
+    
+      def require_user
+        redirect_to core_url_for('login') if current_user.blank?
+      end
+    
+      def set_locale!
+        I18n.default_locale = :en
+        I18n.locale = current_user.try('locale') || I18n.default_locale
+      end
+
+
+      def set_current_user_cookie!(expires_at = nil)
+        user = @whiplash_api.get!("me").body
+        fields_we_care_about = %w(id email role locale first_name last_name partner_id warehouse_id customer_ids)
+        user_hash = user.slice(*fields_we_care_about)
+        expires_at ||= user['current_sign_in_expires_at']
+
+        shared_values = {
+          expires: DateTime.parse(expires_at),
+          secure: http_scheme == 'https',
+          samesite: :strict,
+          domain: cookie_domain
+        }
+        cookies[:user] = shared_values.merge(value: user_hash.to_json)
+      end
+
+    end
+  end
+end

data/lib/whiplash/app/railtie.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Whiplash
+  class App
+    class Railtie < Rails::Railtie
+
+      config.before_configuration do |app|
+        # App name/etc, mainly for consistency in logging
+        app_name = app.class.module_parent.name.underscore.dasherize
+        app.config.environment_key = ENV.fetch('ENVIRONMENT_KEY', Rails.env.to_s)
+        app.config.application_key = ENV.fetch('APPLICATION_KEY', app_name)
+        app.config.application_name_space = [config.application_key, config.environment_key].join('-')
+    
+        # session settings
+        session_days = 30 
+        session_seconds = session_days * 24 * 60 * 60
+        session_length = ENV.fetch('SESSION_LENGTH', session_seconds).to_i
+        app.config.session_length = session_length
+        app.config.session_store :cookie_store, :key => '_session', :expire_after => session_length
+      end
+
+      initializer "whiplash_app.action_controller" do
+        ActiveSupport.on_load(:action_controller) do
+          include Whiplash::App::CanonicalHost
+          include Whiplash::App::ControllerHelpers
+        end
+      end
+
+    end
+  end
+end

data/lib/whiplash/app/version.rb

@@ -1,5 +1,5 @@
 module Whiplash
   class App
-    VERSION = "0.9.1"
+    VERSION = "0.9.4"
   end
 end

data/lib/whiplash/app.rb

@@ -7,12 +7,19 @@ require "errors/whiplash_api_error"
 require "oauth2"
 require "faraday"
 
+# Rails app stuff
+if defined?(Rails::Railtie)
+  require "whiplash/app/railtie"
+  require "whiplash/app/canonical_host" 
+  require "whiplash/app/controller_helpers"
+end 
+
 module Whiplash
   class App
-    include Whiplash::App::ApiConfig
+    extend Whiplash::App::Signing
+    extend Whiplash::App::ApiConfig
     include Whiplash::App::Connections
     include Whiplash::App::FinderMethods
-    extend Whiplash::App::Signing
 
     attr_accessor :customer_id, :shop_id, :token
 
@@ -23,16 +30,16 @@ module Whiplash
       @api_version = options[:api_version] || 2 # can be 2_1
     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 client
+      OAuth2::Client.new(ENV["WHIPLASH_CLIENT_ID"], ENV["WHIPLASH_CLIENT_SECRET"], site: self.class.api_url)
+    end
+
     def connection
-      Faraday.new [api_url, versioned_api_url].join("/") do |conn|
+      Faraday.new [self.class.api_url, versioned_api_url].join("/") do |conn|
         conn.request :authorization, 'Bearer', token.token
         conn.request :json
         conn.response :json, :content_type => /\bjson$/
@@ -47,9 +54,9 @@ module Whiplash
       case ENV["WHIPLASH_CLIENT_SCOPE"]
       when /app_(manage|read)/
         begin
-          access_token = client.client_credentials.get_token(scope: ENV["WHIPLASH_CLIENT_SCOPE"])
+          access_token = self.class.client_credentials_token
         rescue URI::InvalidURIError => e
-          raise StandardError, "The provide URL (#{ENV["WHIPLASH_API_URL"]}) is not valid"
+          raise StandardError, "The provided 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?
@@ -64,6 +71,13 @@ module Whiplash
       false
     end
 
+    class << self 
+      def client_credentials_token
+        client = OAuth2::Client.new(ENV["WHIPLASH_CLIENT_ID"], ENV["WHIPLASH_CLIENT_SECRET"], site: api_url)
+        client.client_credentials.get_token(scope: ENV["WHIPLASH_CLIENT_SCOPE"])
+      end
+    end
+
     private
     def format_token(oauth_token)
       return oauth_token if oauth_token.is_a?(OAuth2::AccessToken)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whiplash-app
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.4
 platform: ruby
 authors:
 - Don Sullivan, Mark Dickson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-20 00:00:00.000000000 Z
+date: 2024-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -115,8 +115,11 @@ files:
 - lib/errors/whiplash_api_error.rb
 - lib/whiplash/app.rb
 - lib/whiplash/app/api_config.rb
+- lib/whiplash/app/canonical_host.rb
 - lib/whiplash/app/connections.rb
+- lib/whiplash/app/controller_helpers.rb
 - lib/whiplash/app/finder_methods.rb
+- lib/whiplash/app/railtie.rb
 - lib/whiplash/app/signing.rb
 - lib/whiplash/app/version.rb
 - whiplash-app.gemspec