duodealer_app 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 867012539e0d946ff8737b9f5a10995a2e40762ba4245c00fb4cbdfba998d3af
-  data.tar.gz: 976c1f4cc69c53a17fc6241594fd9a3405369dfca8dc2e01efd21906a2400c48
+  metadata.gz: a2269bcddcbaf2ec4b28af339d18939f72c087eeb238612d5ffafd30c1911f7f
+  data.tar.gz: 9837fe7b93b11dda135fab7e9913cebe4388ccd23f48c4182309a3e9839f17cc
 SHA512:
-  metadata.gz: 7012a1cd22626b677d50ed634e41084c55f7f170f1cdd3781f77b169c8c9434ae8ce04f8efc9e559adeb51175e2391dc0578d867d87f3678b389ebbf36a2286d
-  data.tar.gz: 73874f4a88d4a4b744b7b95f43681f5c0083465cb7cb4e6c6f40f9c8f7195b96e79928552c2e4ddb240a62a6985e8cb0cff7e539fa273e01fbb07f46b60d9f67
+  metadata.gz: 390073fdc0a5321ec2f11c5535237e23299f3718bb9f38d786370a46367e73ae292154721cfcebbf23bec93e72b360b249427f9c988f5f9e16468a8b5444a3d9
+  data.tar.gz: 8c230c87bbcc2e07d9c95c980c6444f604a5eca30172359776fc49870d75230c52641baf40578c670f4495da9323924463f7bb46b844ae85b26536dfceb9d521

data/README.md

@@ -155,7 +155,7 @@ Mounting the Engine will provide the basic routes to authenticating a shop with
 |--------|-------------------------------|------------------------------|
 |GET     |'/login'                       |Login                         |
 |POST    |'/login'                       |Login                         |
-|GET     |'/auth/duodealer/callback'       |Authenticate Callback         |
+|GET     |'/auth/duodealer/callback'     |Authenticate Callback         |
 |GET     |'/logout'                      |Logout                        |
 |POST    |'/webhooks/:type'              |Webhook Callback              |
 
@@ -294,7 +294,7 @@ Duo Dealer's API is versioned, and you can [read about that process in the Duo D
 
 Since duodealer_app gem version 1.11.0, the included duodealer_api gem has also been updated to allow you to easily set and switch what version of the Duo Dealer API you want your app or service to use, as well as surface warnings to Rails apps about [deprecated endpoints, GraphQL fields and more](https://duodealer.dev/concepts/about-apis/versioning#deprecation-practices).
 
-See the [duodealer_api gem README](https://github.com/Duo Dealer/duodealer_api/) for more details.
+See the [duodealer_api gem README](https://gitlab.com/duodealer/duodealer_api/) for more details.
 
 WebhooksManager
 ---------------

data/app/controllers/duodealer_app/callback_controller.rb

@@ -7,7 +7,7 @@ module DuodealerApp
 
     def callback
       if auth_hash
-        login_shop
+        login_account
         install_webhooks
         install_scripttags
         perform_after_authenticate_job
@@ -15,12 +15,12 @@ module DuodealerApp
         redirect_to return_address
       else
         flash[:error] = I18n.t("could_not_log_in")
-        redirect_to(login_url_with_optional_shop)
+        redirect_to(login_url_with_optional_account)
       end
     end
 
     private
-      def login_shop
+      def login_account
         reset_session_options
         set_duodealer_session
       end
@@ -29,7 +29,7 @@ module DuodealerApp
         request.env["omniauth.auth"]
       end
 
-      def shop_name
+      def account_name
         auth_hash.uid
       end
 
@@ -50,12 +50,12 @@ module DuodealerApp
 
       def set_duodealer_session
         session_store = DuodealerAPI::Session.new(
-          domain: shop_name,
+          domain: account_name,
           token: token,
           api_version: DuodealerApp.configuration.api_version
         )
         session[:duodealer] = DuodealerApp::SessionRepository.store(session_store, user: associated_user)
-        session[:duodealer_domain] = shop_name
+        session[:duodealer_domain] = account_name
         session[:duodealer_user] = associated_user
 
         if DuodealerApp.configuration.per_user_tokens?
@@ -70,7 +70,7 @@ module DuodealerApp
         return unless DuodealerApp.configuration.has_webhooks?
 
         WebhooksManager.queue(
-          shop_name,
+          account_name,
           token,
           DuodealerApp.configuration.webhooks
         )
@@ -80,7 +80,7 @@ module DuodealerApp
         return unless DuodealerApp.configuration.has_scripttags?
 
         ScripttagsManager.queue(
-          shop_name,
+          account_name,
           token,
           DuodealerApp.configuration.scripttags
         )
@@ -95,9 +95,9 @@ module DuodealerApp
         job = job.constantize if job.is_a?(String)
 
         if config[:inline] == true
-          job.perform_now(shop_domain: session[:duodealer_domain])
+          job.perform_now(account_domain: session[:duodealer_domain])
         else
-          job.perform_later(shop_domain: session[:duodealer_domain])
+          job.perform_later(account_domain: session[:duodealer_domain])
         end
       end
   end

data/app/controllers/duodealer_app/sessions_controller.rb

@@ -10,7 +10,7 @@ module DuodealerApp
     end
 
     def new
-      authenticate if sanitized_shop_name.present?
+      authenticate if sanitized_account_name.present?
     end
 
     def create
@@ -18,16 +18,16 @@ module DuodealerApp
     end
 
     def enable_cookies
-      return unless validate_shop
+      return unless validate_account
 
       render(:enable_cookies, layout: false, locals: {
         does_not_have_storage_access_url: top_level_interaction_path(
-          shop: sanitized_shop_name,
+          account: sanitized_account_name,
           return_to: params[:return_to]
         ),
-        has_storage_access_url: login_url_with_optional_shop(top_level: true),
+        has_storage_access_url: login_url_with_optional_account(top_level: true),
         app_target_url: granted_storage_access_path(
-          shop: sanitized_shop_name,
+          account: sanitized_account_name,
           return_to: params[:return_to]
         ),
         current_duodealer_domain: current_duodealer_domain
@@ -35,30 +35,30 @@ module DuodealerApp
     end
 
     def top_level_interaction
-      @url = login_url_with_optional_shop(top_level: true)
-      validate_shop
+      @url = login_url_with_optional_account(top_level: true)
+      validate_account
     end
 
     def granted_storage_access
-      return unless validate_shop
+      return unless validate_account
 
       session["duodealer.granted_storage_access"] = true
 
       copy_return_to_param_to_session
 
-      redirect_to(return_address_with_params({ shop: @shop }))
+      redirect_to(return_address_with_params({ account: @account }))
     end
 
     def destroy
       reset_session
       flash[:notice] = I18n.t(".logged_out")
-      redirect_to(login_url_with_optional_shop)
+      redirect_to(login_url_with_optional_account)
     end
 
     private
       def authenticate
-        return render_invalid_shop_error if sanitized_shop_name.blank?
-        session["duodealer.omniauth_params"] = { shop: sanitized_shop_name }
+        return render_invalid_account_error if sanitized_account_name.blank?
+        session["duodealer.omniauth_params"] = { account: sanitized_account_name }
 
         copy_return_to_param_to_session
 
@@ -89,10 +89,10 @@ module DuodealerApp
         end
       end
 
-      def validate_shop
-        @shop = sanitized_shop_name
-        unless @shop
-          render_invalid_shop_error
+      def validate_account
+        @account = sanitized_account_name
+        unless @account
+          render_invalid_account_error
           return false
         end
 
@@ -103,14 +103,14 @@ module DuodealerApp
         session[:return_to] = params[:return_to] if params[:return_to]
       end
 
-      def render_invalid_shop_error
-        flash[:error] = I18n.t("invalid_shop_url")
+      def render_invalid_account_error
+        flash[:error] = I18n.t("invalid_account_url")
         redirect_to return_address
       end
 
       def enable_cookie_access
         fullpage_redirect_to(enable_cookies_path(
-                               shop: sanitized_shop_name,
+                               account: sanitized_account_name,
                                return_to: session[:return_to]
         ))
       end
@@ -120,7 +120,7 @@ module DuodealerApp
       end
 
       def authenticate_at_top_level
-        fullpage_redirect_to(login_url_with_optional_shop(top_level: true))
+        fullpage_redirect_to(login_url_with_optional_account(top_level: true))
       end
 
       def authenticate_in_context?
@@ -143,12 +143,12 @@ module DuodealerApp
           layout: false,
           locals: {
             does_not_have_storage_access_url: top_level_interaction_path(
-              shop: sanitized_shop_name,
+              account: sanitized_account_name,
               return_to: session[:return_to]
             ),
-            has_storage_access_url: login_url_with_optional_shop(top_level: true),
+            has_storage_access_url: login_url_with_optional_account(top_level: true),
             app_target_url: granted_storage_access_path(
-              shop: sanitized_shop_name,
+              account: sanitized_account_name,
               return_to: session[:return_to]
             ),
             current_duodealer_domain: current_duodealer_domain

data/app/controllers/duodealer_app/webhooks_controller.rb

@@ -8,7 +8,7 @@ module DuodealerApp
 
     def receive
       params.permit!
-      job_args = { shop_domain: shop_domain, webhook: webhook_params.to_h }
+      job_args = { account_domain: account_domain, webhook: webhook_params.to_h }
       webhook_job_klass.perform_later(job_args)
       head :no_content
     end

data/lib/duodealer_app/controller_concerns/login_protection.rb

@@ -15,28 +15,28 @@ module DuodealerApp
     end
 
     def duodealer_session
-      return redirect_to_login unless shop_session
+      return redirect_to_login unless account_session
       clear_top_level_oauth_cookie
 
       begin
-        DuodealerAPI::Base.activate_session(shop_session)
+        DuodealerAPI::Base.activate_session(account_session)
         yield
       ensure
         DuodealerAPI::Base.clear_session
       end
     end
 
-    def shop_session
+    def account_session
       if DuodealerApp.configuration.per_user_tokens?
         return unless session[:duodealer_user]
-        @shop_session ||= DuodealerApp::SessionRepository.retrieve(session[:duodealer_user]["id"])
+        @account_session ||= DuodealerApp::SessionRepository.retrieve(session[:duodealer_user]["id"])
       else
         return unless session[:duodealer]
-        @shop_session ||= DuodealerApp::SessionRepository.retrieve(session[:duodealer])
+        @account_session ||= DuodealerApp::SessionRepository.retrieve(session[:duodealer])
       end
     end
 
-    def login_again_if_different_user_or_shop
+    def login_again_if_different_user_or_account
       if DuodealerApp.configuration.per_user_tokens?
         valid_session_data = session[:user_session].present? && params[:session].present? # session data was sent/stored correctly
         sessions_do_not_match = session[:user_session] != params[:session] # current user is different from stored user
@@ -46,12 +46,12 @@ module DuodealerApp
         end
       end
 
-      if shop_session && params[:shop] && params[:shop].is_a?(String) && (shop_session.domain != params[:shop])
+      if account_session && params[:account] && params[:account].is_a?(String) && (account_session.domain != params[:account])
         clear_session = true
       end
 
       if clear_session
-        clear_shop_session
+        clear_account_session
         redirect_to_login
       end
     end
@@ -70,23 +70,23 @@ module DuodealerApp
             query = "#{referer.query}&#{sanitized_params.to_query}"
           end
           session[:return_to] = "#{path}?#{query}"
-          redirect_to(login_url_with_optional_shop)
+          redirect_to(login_url_with_optional_account)
         end
       end
 
       def close_session
-        clear_shop_session
-        redirect_to(login_url_with_optional_shop)
+        clear_account_session
+        redirect_to(login_url_with_optional_account)
       end
 
-      def clear_shop_session
+      def clear_account_session
         session[:duodealer] = nil
         session[:duodealer_domain] = nil
         session[:duodealer_user] = nil
         session[:user_session] = nil
       end
 
-      def login_url_with_optional_shop(top_level: false)
+      def login_url_with_optional_account(top_level: false)
         url = DuodealerApp.configuration.login_url
 
         query_params = login_url_params(top_level: top_level)
@@ -97,7 +97,7 @@ module DuodealerApp
 
       def login_url_params(top_level:)
         query_params = {}
-        query_params[:shop] = sanitized_params[:shop] if params[:shop].present?
+        query_params[:account] = sanitized_params[:account] if params[:account].present?
 
         return_to = session[:return_to] || params[:return_to]
 
@@ -105,10 +105,10 @@ module DuodealerApp
           query_params[:return_to] = return_to
         end
 
-        has_referer_shop_name = referer_sanitized_shop_name.present?
+        has_referer_account_name = referer_sanitized_account_name.present?
 
-        if has_referer_shop_name
-          query_params[:shop] ||= referer_sanitized_shop_name
+        if has_referer_account_name
+          query_params[:account] ||= referer_sanitized_account_name
         end
 
         query_params[:top_level] = true if top_level
@@ -116,7 +116,7 @@ module DuodealerApp
       end
 
       def return_to_param_required?
-        native_params = %i[shop hmac timestamp locale protocol return_to]
+        native_params = %i[account hmac timestamp locale protocol return_to]
         request.path != "/" || sanitized_params.except(*native_params).any?
       end
 
@@ -129,36 +129,36 @@ module DuodealerApp
       end
 
       def current_duodealer_domain
-        duodealer_domain = sanitized_shop_name || session[:duodealer_domain]
+        duodealer_domain = sanitized_account_name || session[:duodealer_domain]
         return duodealer_domain if duodealer_domain.present?
 
         raise DuodealerDomainNotFound
       end
 
-      def sanitized_shop_name
-        @sanitized_shop_name ||= sanitize_shop_param(params)
+      def sanitized_account_name
+        @sanitized_account_name ||= sanitize_account_param(params)
       end
 
-      def referer_sanitized_shop_name
+      def referer_sanitized_account_name
         return if request.referer.blank?
 
-        @referer_sanitized_shop_name ||= begin
+        @referer_sanitized_account_name ||= begin
           referer_uri = URI(request.referer)
           query_params = Rack::Utils.parse_query(referer_uri.query)
 
-          sanitize_shop_param(query_params.with_indifferent_access)
+          sanitize_account_param(query_params.with_indifferent_access)
         end
       end
 
-      def sanitize_shop_param(params)
-        return if params[:shop].blank?
-        DuodealerApp::Utils.sanitize_shop_domain(params[:shop])
+      def sanitize_account_param(params)
+        return if params[:account].blank?
+        DuodealerApp::Utils.sanitize_account_domain(params[:account])
       end
 
       def sanitized_params
         request.query_parameters.clone.tap do |query_params|
-          if params[:shop].is_a?(String)
-            query_params[:shop] = sanitize_shop_param(params)
+          if params[:account].is_a?(String)
+            query_params[:account] = sanitize_account_param(params)
           end
         end
       end

data/lib/duodealer_app/controller_concerns/webhook_verification.rb

@@ -28,8 +28,8 @@ module DuodealerApp
         end
       end
 
-      def shop_domain
-        request.headers["HTTP_X_DUODEALER_SHOP_DOMAIN"]
+      def account_domain
+        request.headers["HTTP_X_DUODEALER_ACCOUNT_DOMAIN"]
       end
 
       def duodealer_hmac

data/lib/duodealer_app/jobs/scripttags_manager_job.rb

@@ -6,10 +6,10 @@ module DuodealerApp
       DuodealerApp.configuration.scripttags_manager_queue_name
     end
 
-    def perform(shop_domain:, shop_token:, scripttags:)
+    def perform(account_domain:, account_token:, scripttags:)
       api_version = DuodealerApp.configuration.api_version
-      DuodealerAPI::Session.temp(domain: shop_domain, token: shop_token, api_version: api_version) do
-        manager = ScripttagsManager.new(scripttags, shop_domain)
+      DuodealerAPI::Session.temp(domain: account_domain, token: account_token, api_version: api_version) do
+        manager = ScripttagsManager.new(scripttags, account_domain)
         manager.create_scripttags
       end
     end

data/lib/duodealer_app/jobs/webhooks_manager_job.rb

@@ -6,9 +6,9 @@ module DuodealerApp
       DuodealerApp.configuration.webhooks_manager_queue_name
     end
 
-    def perform(shop_domain:, shop_token:, webhooks:)
+    def perform(account_domain:, account_token:, webhooks:)
       api_version = DuodealerApp.configuration.api_version
-      DuodealerAPI::Session.temp(domain: shop_domain, token: shop_token, api_version: api_version) do
+      DuodealerAPI::Session.temp(domain: account_domain, token: account_token, api_version: api_version) do
         manager = WebhooksManager.new(webhooks)
         manager.create_webhooks
       end

data/lib/duodealer_app/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DuodealerApp
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/generators/duodealer_app/install/templates/duodealer_provider.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 provider :duodealer,
   DuodealerApp.configuration.api_key,
   DuodealerApp.configuration.secret,