whiplash-app 0.9.5 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0e2ae334bdd40de1ae96543cd86eb7506e3de9a7d65d04b003fa67d2eb83da1
-  data.tar.gz: a2ae0fe3f75c4ed25e7703c85f71495609f10434c9bf3d687483d1ad440a5513
+  metadata.gz: ed3192117f026dce179a249afae7d1dd8e887883f4272ce9a8ceeff2f9ae9429
+  data.tar.gz: 2b3626ec34d6d3fe8bfd4111c3578235ae129321b090501cd0881917506aafe8
 SHA512:
-  metadata.gz: 1fd9e63cc8d1359a38adc462eb4818928d4ea84bc1e57db46e1fa9725ef547c59172763727f8fc7957c8de22d0a3720a437040789966116ce5a1c0a833ad210f
-  data.tar.gz: 0f35b12647a50d4a4c8fbb1a0f24fb6d40946c19dbbeb4d0238eb19d5c075fd3958e2cea68a72072d8db5770c83d18a5c1bc831a3bee2497e9cc7a4bfde52913
+  metadata.gz: 8a2ad62e4666d538fed3ecefb03bd675196c4c2612255f84e38e5865d5abca52a2bbe1c026b6e52cc14c16a9c409719c4cd404f60d7d0cbbfdc0e477232ae8c2
+  data.tar.gz: cee2a29068bf4ca7e200085539738a902c72c096bc01af699cb8a2330e1c2511a86715fc4d2aefd15487d603f31d0011972cdf1bd6ddefc2678b0a6ec5560db5

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/controller_helpers.rb

@@ -8,7 +8,9 @@ module Whiplash
         helper_method :cookie_domain,
                       :core_url,
                       :core_url_for,
-                      :current_user
+                      :current_customer,
+                      :current_user,
+                      :current_warehouse
       end 
 
       private
@@ -25,6 +27,28 @@ module Whiplash
         [core_url, path].join('/')
       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
         return if cookies[:user].blank?
         begin
@@ -35,6 +59,28 @@ 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
@@ -59,10 +105,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 +136,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)
+        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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whiplash-app
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.9.6
 platform: ruby
 authors:
 - Don Sullivan, Mark Dickson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-10 00:00:00.000000000 Z
+date: 2024-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2