whiplash-app 0.9.5 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0e2ae334bdd40de1ae96543cd86eb7506e3de9a7d65d04b003fa67d2eb83da1
-  data.tar.gz: a2ae0fe3f75c4ed25e7703c85f71495609f10434c9bf3d687483d1ad440a5513
+  metadata.gz: c1bf73813a5c4e7bdc0417901e1734afb3dade5b3fbd9e1dc3c8b31b0b0bdcc3
+  data.tar.gz: 7ec1abc0b3adaf3f68d1f43f2c19f42bf700277b0c368e383c42cddedc80e1a1
 SHA512:
-  metadata.gz: 1fd9e63cc8d1359a38adc462eb4818928d4ea84bc1e57db46e1fa9725ef547c59172763727f8fc7957c8de22d0a3720a437040789966116ce5a1c0a833ad210f
-  data.tar.gz: 0f35b12647a50d4a4c8fbb1a0f24fb6d40946c19dbbeb4d0238eb19d5c075fd3958e2cea68a72072d8db5770c83d18a5c1bc831a3bee2497e9cc7a4bfde52913
+  metadata.gz: f7b75b10c21856dd22bf2c1d2652ac875f5283d483f56d5123f9b86f93d71bfe76081b3a96cfb4bd5108fddad6f35ce89585128295fafc671ed62913060790c5
+  data.tar.gz: 7950a5979e5e3fbee7f91785507a22dbc5d506c83bcea2acb10ac22708abe13ba55b2fee353c298187df66457fb020bcab812896b81529006f61f8fda24e720a

data/README.md

@@ -59,18 +59,26 @@ As long as all of your apps are on the same subdomain, they will share auth cook
 
 ```json
 {
-    "oauth_token": XXXXXXX,
-    "user": {"id":151,"email":"mark@getwhiplash.com","role":"admin","locale":"en","first_name":"Mark","last_name":"Dickson","partner_id":null,"warehouse_id": 1,"customer_ids":[1, 2, 3]}
+    "oauth_token": "XXXXXXX",
+    "user": {"id":151,"email":"mark@getwhiplash.com","role":"admin","locale":"en","first_name":"Mark","last_name":"Dickson","partner_id":null, "customer_ids":[1, 2, 3]},
+    "customer": {"id": 123, "name": "BooYaa"},
+    "warehouse": {"id": 1, "name": "Ann Arbor"}
 }
 ```
 
 You get a variety of helper methods for free:
 
 `init_whiplash_api` - This instantiates `@whiplash_api` which can be used to make requests, out of the box
-`current_user` - This is a **hash** with the above fields; you typically shouldn't need much more user info than this
+`current_user` - This is a **hash** with the above fields; you typically shouldn't need much more user info than this'
+`current_customer` - This is a **hash** with the above fields; you typically shouldn't need much more user info than this
+`current_warehouse` - This is a **hash** with the above fields; you typically shouldn't need much more user info than this
 `require_user` - Typically you'd use this in a `before_action`. You almost always want this in `ApplicationController`.
 `set_locale!` - Sets the locale based on the value in the user hash
-`set_current_user_cookie!` - Updates the current user cookie with fresh data from the api. You typically won't need this, unless your app updates fields like `warehouse_id` or `locale`.
+`set_current_user_cookie!` - Updates the current user cookie with fresh data from the api. You typically won't need this, unless your app updates fields like `locale`.
+`set_current_customer_cookie!` - Updates the current customer cookie with fresh data from the api; typically used after you've changed customer
+`set_current_warehouse_cookie!` - Updates the current customer cookie with fresh data from the api; typically used after you've changed warehouse
+`unset_current_customer_cookie!` - Deletes the current customer cookie, with appropriate domain settings
+`unset_current_warehouse_cookie!` - Deletes the current warehouse cookie, with appropriate domain settings
 `core_url` - Shorthand for `ENV['WHIPLASH_API_URL']`
 `core_url_for` - Link back to Core like `core_url_for('login')`
 

data/lib/whiplash/app/canonical_host.rb

@@ -9,7 +9,8 @@ module Whiplash
       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 unless Rails.configuration.respond_to?(:application_url)
+        application_host = URI.parse(Rails.configuration.application_url).host
         return if application_host == request.host
         return unless request.method_symbol == :get # can't redirect PUT, POST, DELETE
     
@@ -17,7 +18,7 @@ module Whiplash
       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
+        redirect_to "#{Rails.configuration.application_url}#{request.path}#{'?' if query_params.to_query.present?}#{query_params.to_query}", status: status
       end
 
     end

data/lib/whiplash/app/controller_helpers.rb

@@ -8,21 +8,78 @@ module Whiplash
         helper_method :cookie_domain,
                       :core_url,
                       :core_url_for,
-                      :current_user
+                      :current_customer,
+                      :current_user,
+                      :current_warehouse
       end 
 
       private
 
+      def application_domain
+        return nil if Rails.configuration.application_url.blank?
+        host = URI.parse(Rails.configuration.application_url).host
+        '.' + host
+      end
+
+      def clear_application_cookies!
+        return if application_domain.blank?
+        cookie_keys_we_care_about.each { |k| cookies.delete(k, domain: application_domain) }
+      end
+
+      def clear_domain_cookies!
+        cookie_keys_we_care_about.each { |k| cookies.delete(k, domain: cookie_domain) }
+      end
+
       def cookie_domain
-        '.' + URI.parse(core_url).host
+        host = URI.parse(core_url).host
+        host.gsub!('www.', '')
+        '.' + host
+      end
+
+      def cookie_keys_we_care_about
+        %i(
+            _session
+            customer
+            customer_id
+            oauth_token
+            partner_id 
+            user
+            user_id
+            warehouse
+            warehouse_id
+          )
       end
 
       def core_url
-        ENV['WHIPLASH_API_URL']
+        ENV['WHIPLASH_CORE_URL'] || ENV['WHIPLASH_API_URL']
       end
 
-      def core_url_for(path)
-        [core_url, path].join('/')
+      def core_url_for(path, query_params = {})
+        out = [core_url, path].join('/')
+        out = [out, query_params.to_query].join('?') if query_params.present?
+        return out
+      end
+
+      def current_customer
+        return if cookies[:customer].blank?
+        begin
+          customer_hash = JSON.parse(cookies[:customer])
+          @current_customer ||= customer_hash
+        rescue StandardError => e 
+          Rails.logger.warn "Customer could not be initialized: #{e.message}"
+          nil
+        end
+      end
+
+      def current_customer_full
+        return if cookies[:customer].blank?
+        begin
+          customer_hash = JSON.parse(cookies[:customer])
+          @current_customer ||= @whiplash_api.get!("customers/#{customer_hash['id']}").body
+        rescue StandardError => e 
+          Rails.logger.warn "Customer could not be initialized: #{e.message}"
+          nil
+        end
       end
 
       def current_user
@@ -35,12 +92,37 @@ module Whiplash
         end
       end
 
+      def current_warehouse
+        return if cookies[:warehouse].blank?
+        begin
+          warehouse_hash = JSON.parse(cookies[:warehouse])
+          @current_warehouse ||= warehouse_hash
+        rescue StandardError => e 
+          Rails.logger.warn "Warehouse could not be initialized: #{e.message}"
+          @current_warehouse = nil
+        end
+      end
+
+      def current_warehouse_full
+        return if cookies[:warehouse].blank?
+        begin
+          warehouse_hash = JSON.parse(cookies[:warehouse])
+          @whiplash_api.get!("warehouses/#{warehouse_hash['id']}").body
+        rescue StandardError => e 
+          Rails.logger.warn "Warehouse could not be initialized: #{e.message}"
+          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?
+        if cookies[:oauth_token].blank?
+          clear_application_cookies!
+          return redirect_to core_url_for('login', redirect_url: request.original_url)
+        end
         token = {access_token: cookies[:oauth_token]}
         begin 
           @whiplash_api = Whiplash::App.new(token, options)
@@ -51,7 +133,9 @@ module Whiplash
       end
     
       def require_user
-        redirect_to core_url_for('login') if current_user.blank?
+        return if current_user.present?
+        clear_application_cookies!
+        redirect_to core_url_for('login', redirect_url: request.original_url) 
       end
     
       def set_locale!
@@ -59,10 +143,25 @@ module Whiplash
         I18n.locale = current_user.try('locale') || I18n.default_locale
       end
 
+      def set_current_customer_cookie!(customer_id, expires_at = nil)
+        customer = @whiplash_api.get!("customers/#{customer_id}").body
+        user = @whiplash_api.get!("me").body
+        fields_we_care_about = %w(id name)
+        customer_hash = customer.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[:customer] = shared_values.merge(value: customer_hash.to_json)
+      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)
+        fields_we_care_about = %w(id email role locale first_name last_name partner_id customer_ids)
         user_hash = user.slice(*fields_we_care_about)
         expires_at ||= user['current_sign_in_expires_at']
 
@@ -75,6 +174,30 @@ module Whiplash
         cookies[:user] = shared_values.merge(value: user_hash.to_json)
       end
 
+      def set_current_warehouse_cookie!(warehouse_id, expires_at = nil)
+        warehouse = @whiplash_api.get!("warehouses/#{warehouse_id}").body
+        user = @whiplash_api.get!("me").body
+        fields_we_care_about = %w(id name slug)
+        warehouse_hash = warehouse.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[:warehouse] = shared_values.merge(value: warehouse_hash.to_json)
+      end
+
+      def unset_current_customer_cookie!
+        cookies.delete(:customer, domain: cookie_domain)
+      end
+
+      def unset_current_warehouse_cookie!
+        cookies.delete(:warehouse, domain: cookie_domain)
+      end
+
     end
   end
 end

data/lib/whiplash/app/railtie.rb

@@ -20,7 +20,7 @@ module Whiplash
       end
 
       initializer "whiplash_app.action_controller" do
-        ActiveSupport.on_load(:action_controller) do
+        ActiveSupport.on_load(:action_controller_base) do
           include Whiplash::App::CanonicalHost
           include Whiplash::App::ControllerHelpers
         end

data/lib/whiplash/app/version.rb

@@ -1,5 +1,5 @@
 module Whiplash
   class App
-    VERSION = "0.9.5"
+    VERSION = "0.10.0"
   end
 end

data/lib/whiplash/app.rb

@@ -6,6 +6,7 @@ require "whiplash/app/version"
 require "errors/whiplash_api_error"
 require "oauth2"
 require "faraday"
+require 'faraday/net_http_persistent'
 
 # Rails app stuff
 if defined?(Rails::Railtie)
@@ -40,9 +41,21 @@ module Whiplash
 
     def connection
       Faraday.new [self.class.api_url, versioned_api_url].join("/") do |conn|
+        # Authentication
         conn.request :authorization, 'Bearer', token.token
         conn.request :json
         conn.response :json, :content_type => /\bjson$/
+        conn.options.timeout = 30 # Total request timeout
+        conn.options.open_timeout = 5 # Connection establishment timeout
+        
+        # Use persistent HTTP connections (requires net-http-persistent gem)
+        begin
+          conn.adapter :net_http_persistent
+        rescue LoadError
+          # Fallback to default adapter if net-http-persistent isn't available
+          Rails.logger.warn "[WhiplashApp] net-http-persistent gem not found, using default adapter" if defined?(Rails)
+          conn.adapter Faraday.default_adapter
+        end
       end
     end
 
@@ -112,4 +125,4 @@ module Net
 
     end
   end
-end
+end

data/whiplash-app.gemspec

@@ -20,9 +20,10 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "oauth2", "~> 2.0.4"
   spec.add_dependency "faraday", "~> 2.7"
+  spec.add_dependency 'faraday-net_http_persistent'
 
   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'
+  spec.add_development_dependency "pry", "~> 0.14"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whiplash-app
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.10.0
 platform: ruby
 authors:
 - Don Sullivan, Mark Dickson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-10 00:00:00.000000000 Z
+date: 2025-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: faraday-net_http_persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: '0.14'
 description: this gem provides connectivity to the Whiplash API for authentication
   and REST requests.
 email:
@@ -141,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: this gem provides connectivity to the Whiplash API for authentication and