solidus_bolt 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e25dd3c40e487372056178b18ffae03f5cddbd5b56756cf32874a7e0f761a5ac
-  data.tar.gz: 74bfbc7db9a0b6b9b47f501cbd67d6c141a9164549266eb99114a3de5a4de840
+  metadata.gz: 85a81224dbf00b809093c50581fa790f56f6389a85753a002eff55ed149ddbff
+  data.tar.gz: 84ee9afd0a6dd580df9d3ffcbe2550a3e957d5c43fafc209e42cd79965caf9c2
 SHA512:
-  metadata.gz: 6df41aae33da5dc6d3c070507fe0c7a19410ece8ffabfef114f8dca23a387b5f3cdadb0317ef1121051d95807b08717782db0e802290668e277f7ae492f4464e
-  data.tar.gz: 840b8836eaf726ab402b807bed737d536c14adaac70d24d0bba4a030afd58d8677d715ae54ddcd8a2167f3ab4a829a39dcf49e7aefb028064bfd8f539722c49a
+  metadata.gz: ed702363808663ef10223d943f670c2bc90b248be1f4953b9288b631b36ec9a40908d1c7d3b295bb6f5cbf27b92820845dbe49e8f51a3336a1da68372c247f18
+  data.tar.gz: 2398a99717a2d8f76b1b20c790062b5543d0f7323d90dc55637814bbeadac6d55c3078008a0213f2c6461630dd51362316d5d1b2a2c987fe37acac41cd4e34e8

data/app/controllers/spree/admin/bolt_callback_urls_controller.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Spree
+  module Admin
+    class BoltCallbackUrlsController < Spree::Admin::BaseController
+      def new
+        callback_urls = SolidusBolt::MerchantConfiguration::GetCallbackUrlsService.call
+
+        @oauth_logout = callback_urls['callback_urls'].find { |c| c['type'] == 'oauth_logout' }['url']
+        @oauth_redirect = callback_urls['callback_urls'].find { |c| c['type'] == 'oauth_redirect' }['url']
+      end
+
+      def update
+        SolidusBolt::MerchantConfiguration::SetCallbackUrlsService.call(
+          oauth_logout: params[:bolt_callback_urls][:oauth_logout],
+          oauth_redirect: params[:bolt_callback_urls][:oauth_redirect]
+        )
+        flash[:success] = "Successfully updated callback urls."
+
+        redirect_to new_admin_bolt_callback_urls_path
+      rescue SolidusBolt::ServerError => e
+        flash[:error] = e.message
+
+        render :new
+      end
+
+      private
+
+      def bolt_webhook_params
+        params
+          .require(:bolt_webhook)
+          .permit(
+            :event,
+            :webhook_url,
+          )
+      end
+    end
+  end
+end

data/app/models/solidus_bolt/bolt_configuration.rb

@@ -16,11 +16,11 @@ module SolidusBolt
     validate :config_can_be_created, on: :create
 
     def merchant_public_id
-      publishable_key.split('.').first
+      publishable_key&.split('.')&.first
     end
 
     def division_public_id
-      publishable_key.split('.').second
+      publishable_key&.split('.')&.second
     end
 
     def self.fetch

data/app/services/solidus_bolt/merchant_configuration/get_callback_urls_service.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module SolidusBolt
+  module MerchantConfiguration
+    class GetCallbackUrlsService < SolidusBolt::BaseService
+      attr_reader :oauth_redirect, :oauth_logout, :get_account
+
+      def call
+        get_callbacks
+      end
+
+      private
+
+      def get_callbacks # rubocop:disable Naming/AccessorMethodName
+        url = "#{api_base_url}/#{api_version}/merchant/callbacks"
+        handle_result(
+          HTTParty.get(
+            url, headers: headers, query: query
+          )
+        )
+      end
+
+      def query
+        {
+          division_id: @config.division_public_id
+        }
+      end
+
+      def headers
+        {
+          'Content-Type' => 'application/json',
+        }.merge(authentication_header)
+      end
+    end
+  end
+end

data/app/services/solidus_bolt/merchant_configuration/set_callback_urls_service.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module SolidusBolt
+  module MerchantConfiguration
+    class SetCallbackUrlsService < SolidusBolt::BaseService
+      attr_reader :oauth_redirect, :oauth_logout, :get_account
+
+      def initialize(oauth_redirect: nil, oauth_logout: nil, get_account: nil)
+        @oauth_redirect = oauth_redirect
+        @oauth_logout = oauth_logout
+        @get_account = get_account
+
+        super
+      end
+
+      def call
+        set_callbacks
+      end
+
+      private
+
+      def set_callbacks
+        url = "#{api_base_url}/#{api_version}/merchant/callbacks"
+        handle_result(
+          HTTParty.post(
+            url, headers: headers, body: body.to_json
+          )
+        )
+      end
+
+      def body
+        {
+          division_id: @config.division_public_id,
+          callback_urls: callback_urls
+        }
+      end
+
+      def callback_urls
+        callback_urls = []
+
+        callback_urls <<  { type: 'oauth_redirect', url: oauth_redirect } if oauth_redirect.present?
+        callback_urls <<  { type: 'oauth_logout', url: oauth_logout } if oauth_logout.present?
+        callback_urls <<  { type: 'get_account', url: get_account } if get_account.present?
+
+        callback_urls
+      end
+
+      def headers
+        {
+          'Content-Type' => 'application/json',
+        }.merge(authentication_header)
+      end
+    end
+  end
+end

data/app/views/spree/admin/bolt_callback_urls/new.html.erb

@@ -0,0 +1,24 @@
+<% admin_breadcrumb(plural_resource_name(SolidusBolt::BoltConfiguration)) %>
+
+<%= form_for :bolt_callback_urls, url: admin_bolt_callback_urls_path, method: :patch do |f| %>
+  <fieldset class="form-group no-border-bottom no-border-top">
+    <div class="row">
+      <div id="general_fields" class="col-9">
+        <div class="row">
+          <div class="col-12">
+            <%= f.label :oauth_redirect %>
+            <%= f.text_field :oauth_redirect, class: 'fullwidth', value: @oauth_redirect || 'https://domain.com/webhooks/bolt' %>
+          </div>
+          <div class="col-12">
+            <%= f.label :oauth_logout %>
+            <%= f.text_field :oauth_logout, class: 'fullwidth', value: @oauth_logout || 'https://domain.com/webhooks/bolt' %>
+          </div>
+        </div>
+        <div class="row p-2 justify-content-center">
+          <%= f.submit 'Update', class: 'btn btn-primary', data: { disable_with: 'Creating..' } %>
+          <%= link_to 'Cancel', admin_bolt_path, class: 'button' %>
+        </div>
+      </div>
+    </div>
+  </fieldset>
+<% end %>

data/app/views/spree/admin/bolts/show.html.erb

@@ -11,6 +11,9 @@
         ) %>
     </li>
   <% else %>
+    <li>
+      <%= link_to 'Configure Callbacks URLs', new_admin_bolt_callback_urls_path, class: 'btn btn-primary' %>
+    </li>
     <li>
       <%= link_to 'Configure Webhooks', new_admin_bolt_webhook_path, class: 'btn btn-primary' %>
     </li>

data/config/routes.rb

@@ -4,8 +4,13 @@ Spree::Core::Engine.routes.draw do
   namespace :admin do
     resource :bolt, only: [:show, :edit, :update]
     resource :bolt_webhook, only: [:new, :create]
+    resource :bolt_callback_urls, only: [:new, :update]
   end
 
   post '/webhooks/bolt', to: '/solidus_bolt/webhooks#update'
   post '/api/accounts/bolt', to: '/solidus_bolt/accounts#create'
+
+  devise_scope :spree_user do
+    get '/bolt_logout', to: '/spree/user_sessions#destroy', as: 'bolt_logout'
+  end
 end

data/lib/solidus_bolt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidusBolt
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/lib/views/frontend/spree/shared/_login_bar_items.html.erb

@@ -1,6 +1,6 @@
 <% if spree_current_user %>
   <li><%= link_to t('spree.my_account'), spree.account_path %></li>
-  <li><%= link_to t('spree.logout'), spree.logout_path, method: Devise.sign_out_via %></li>
+  <li><div class="bolt-account-sso" data-logged-in="true"></div></li>
 <% else %>
   <li>
     <div class="bolt-account-sso"></div>

data/spec/fixtures/vcr_cassettes/SolidusBolt_MerchantConfiguration_GetCallbackUrlsService/_call/receives_the_correct_response.yml

@@ -0,0 +1,54 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api-sandbox.bolt.com/v1/merchant/callbacks?division_id=<DIVISION_PUBLIC_ID>
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      X-Api-Key:
+      - "<API_KEY>"
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 27 Jul 2022 18:10:11 GMT
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '157'
+      Connection:
+      - keep-alive
+      Public-Key-Pins-Report-Only:
+      - max-age=2592000;pin-sha256="OGAVOYhLZd3ADKYGFZOED1c5m1ObMlRv9PyIWrO4Nd0=";pin-sha256="RRM1dGqnDFsCJXBTHky16vi1obOlCgFFn/yOhI/y+ho=";pin-sha256="IXHYSIdST+XY22J5ivybYkntMIfjA5P6pMKX2hWG1BE=";report-uri="https://77aa1bd121ef22d50247a23390ce6cff.report-uri.io/r/default/hpkp/reportOnly"
+      Set-Cookie:
+      - trk=f47ec1df-c6f5-460c-baf3-2ff506846dd2; Path=/; Max-Age=31536000; HttpOnly;
+        Secure; SameSite=None
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains; preload
+      X-Bolt-Api-Version:
+      - '2022-01-01'
+      X-Bolt-Trace-Id:
+      - Root=1-62e17f83-46d90f8f25fd210e0420dbdb
+      X-Device-Id:
+      - cc0e49b483c9bdb9dce4a6f35b9fcfb75194e19da94e18882fac74a192a8fc71
+      X-Envoy-Upstream-Service-Time:
+      - '29'
+      Server:
+      - envoy
+    body:
+      encoding: UTF-8
+      string: '{"callback_urls":[{"url":"http://localhost:3000/bolt_logout","type":"oauth_logout"},{"url":"http://localhost:3000/users/auth/bolt","type":"oauth_redirect"}]}'
+  recorded_at: Wed, 27 Jul 2022 18:10:11 GMT
+recorded_with: VCR 6.1.0

data/spec/fixtures/vcr_cassettes/SolidusBolt_MerchantConfiguration_SetCallbackUrlsService/_call/receives_the_correct_response.yml

@@ -0,0 +1,54 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api-sandbox.bolt.com/v1/merchant/callbacks
+    body:
+      encoding: UTF-8
+      string: '{"division_id":"Rq4qB1QajYLn","callback_urls":[{"type":"oauth_redirect","url":"http://localhost:3000/users/auth/bolt"},{"type":"oauth_logout","url":"http://localhost:3000//user/spree_user/logout"}]}'
+    headers:
+      Content-Type:
+      - application/json
+      X-Api-Key:
+      - "<API_KEY>"
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 26 Jul 2022 21:17:15 GMT
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '4'
+      Connection:
+      - keep-alive
+      Public-Key-Pins-Report-Only:
+      - max-age=2592000;pin-sha256="OGAVOYhLZd3ADKYGFZOED1c5m1ObMlRv9PyIWrO4Nd0=";pin-sha256="RRM1dGqnDFsCJXBTHky16vi1obOlCgFFn/yOhI/y+ho=";pin-sha256="IXHYSIdST+XY22J5ivybYkntMIfjA5P6pMKX2hWG1BE=";report-uri="https://77aa1bd121ef22d50247a23390ce6cff.report-uri.io/r/default/hpkp/reportOnly"
+      Set-Cookie:
+      - trk=ea8f518e-f41d-4b8c-9615-161bff916a0f; Path=/; Max-Age=31536000; HttpOnly;
+        Secure; SameSite=None
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubDomains; preload
+      X-Bolt-Api-Version:
+      - '2022-01-01'
+      X-Bolt-Trace-Id:
+      - Root=1-62e059db-307d2def557ae7d63cda1f93
+      X-Device-Id:
+      - 65fb9d676354668c7128f58217c94230e32303007b66559078fee6aefb88e8a4
+      X-Envoy-Upstream-Service-Time:
+      - '37'
+      Server:
+      - envoy
+    body:
+      encoding: UTF-8
+      string: 'null'
+  recorded_at: Tue, 26 Jul 2022 21:17:15 GMT
+recorded_with: VCR 6.1.0

data/spec/models/solidus_bolt/bolt_configuration_spec.rb

@@ -62,6 +62,11 @@ RSpec.describe SolidusBolt::BoltConfiguration, type: :model do
       bolt_configuration = create(:bolt_configuration, publishable_key: 'abc.def.ghi')
       expect(bolt_configuration.merchant_public_id).to eq('abc')
     end
+
+    it 'returns nil if publishable_key is nil' do
+      bolt_configuration = create(:bolt_configuration, publishable_key: nil)
+      expect(bolt_configuration.division_public_id).to be_nil
+    end
   end
 
   describe '#division_public_id' do
@@ -69,6 +74,11 @@ RSpec.describe SolidusBolt::BoltConfiguration, type: :model do
       bolt_configuration = create(:bolt_configuration, publishable_key: 'abc.def.ghi')
       expect(bolt_configuration.division_public_id).to eq('def')
     end
+
+    it 'returns nil if publishable_key is nil' do
+      bolt_configuration = create(:bolt_configuration, publishable_key: nil)
+      expect(bolt_configuration.division_public_id).to be_nil
+    end
   end
 
   describe '#environment_url' do

data/spec/services/solidus_bolt/merchant_configuration/get_callback_urls_service_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe SolidusBolt::MerchantConfiguration::GetCallbackUrlsService, :vcr, :bolt_configuration do
+  subject(:api) { described_class.new }
+
+  describe '#call', vcr: true do
+    it 'receives the correct response' do
+      expect(api.call).to match hash_including(
+        'callback_urls' => array_including(hash_including('type', 'url'))
+      )
+    end
+  end
+end

data/spec/services/solidus_bolt/merchant_configuration/set_callback_urls_service_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe SolidusBolt::MerchantConfiguration::SetCallbackUrlsService, :vcr, :bolt_configuration do
+  subject(:api) { described_class.new(params) }
+
+  let(:params) {
+    {
+      oauth_redirect: 'http://localhost:3000/users/auth/bolt',
+      oauth_logout: 'http://localhost:3000//user/spree_user/logout'
+    }
+  }
+
+  describe '#call', vcr: true do
+    it 'receives the correct response' do
+      expect(api.call).to be_nil
+    end
+  end
+end

data/spec/support/bolt_configuration.rb

@@ -7,7 +7,7 @@ RSpec.configure do |config|
     solidus_bolt_configuration.environment = 'sandbox'
     solidus_bolt_configuration.api_key = ENV['BOLT_API_KEY']
     solidus_bolt_configuration.signing_secret = ENV['BOLT_SIGNING_SECRET']
-    solidus_bolt_configuration.publishable_key = ENV['BOLT_PUBLISHABLE_KEY']
+    solidus_bolt_configuration.publishable_key = ENV['BOLT_PUBLISHABLE_KEY'] || 'abc.def.ghi'
 
     solidus_bolt_configuration.save!
 

data/spec/support/vcr.rb

@@ -19,6 +19,7 @@ VCR.configure do |config|
   end
 
   config.filter_sensitive_data('<PUBLISHABLE_KEY>') { SolidusBolt::BoltConfiguration.fetch.publishable_key }
+  config.filter_sensitive_data('<DIVISION_PUBLIC_ID>') { SolidusBolt::BoltConfiguration.fetch.division_public_id }
   config.filter_sensitive_data('<API_KEY>') { SolidusBolt::BoltConfiguration.fetch.api_key }
 
   # Let's you set default VCR record mode with VCR_RECORDE_MODE=all for re-recording

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solidus_bolt
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - piyushswain
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-26 00:00:00.000000000 Z
+date: 2022-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coffee-rails
@@ -242,6 +242,7 @@ files:
 - app/controllers/solidus_bolt/accounts_controller.rb
 - app/controllers/solidus_bolt/base_controller.rb
 - app/controllers/solidus_bolt/webhooks_controller.rb
+- app/controllers/spree/admin/bolt_callback_urls_controller.rb
 - app/controllers/spree/admin/bolt_webhooks_controller.rb
 - app/controllers/spree/admin/bolts_controller.rb
 - app/decorators/controllers/solidus_bolt/spree_checkout_controller/add_addresses_to_bolt.rb
@@ -265,6 +266,8 @@ files:
 - app/services/solidus_bolt/accounts/detail_service.rb
 - app/services/solidus_bolt/accounts/detect_account_service.rb
 - app/services/solidus_bolt/base_service.rb
+- app/services/solidus_bolt/merchant_configuration/get_callback_urls_service.rb
+- app/services/solidus_bolt/merchant_configuration/set_callback_urls_service.rb
 - app/services/solidus_bolt/oauth/token_service.rb
 - app/services/solidus_bolt/payments/capture_sync_service.rb
 - app/services/solidus_bolt/payments/credit_sync_service.rb
@@ -280,6 +283,7 @@ files:
 - app/services/solidus_bolt/users/sync_addresses_service.rb
 - app/services/solidus_bolt/users/sync_payment_sources_service.rb
 - app/services/solidus_bolt/webhooks/create_service.rb
+- app/views/spree/admin/bolt_callback_urls/new.html.erb
 - app/views/spree/admin/bolt_webhooks/new.html.erb
 - app/views/spree/admin/bolts/_configuration.html.erb
 - app/views/spree/admin/bolts/_form.html.erb
@@ -341,6 +345,8 @@ files:
 - spec/fixtures/vcr_cassettes/SolidusBolt_Accounts_DetailService/_call/with_wrong_access_token/gives_an_error.yml
 - spec/fixtures/vcr_cassettes/SolidusBolt_Accounts_DetectAccountService/_call/receives_the_correct_response.yml
 - spec/fixtures/vcr_cassettes/SolidusBolt_Accounts_DetectAccountService/_call/returns_status_200.yml
+- spec/fixtures/vcr_cassettes/SolidusBolt_MerchantConfiguration_GetCallbackUrlsService/_call/receives_the_correct_response.yml
+- spec/fixtures/vcr_cassettes/SolidusBolt_MerchantConfiguration_SetCallbackUrlsService/_call/receives_the_correct_response.yml
 - spec/fixtures/vcr_cassettes/SolidusBolt_Oauth_TokenService/_call/makes_the_API_call.yml
 - spec/fixtures/vcr_cassettes/SolidusBolt_Transactions_AuthorizeService/when_repeat_payment/_call/makes_the_API_call.yml
 - spec/fixtures/vcr_cassettes/SolidusBolt_Transactions_AuthorizeService/with_auto_capture/_call/makes_the_API_call.yml
@@ -372,6 +378,8 @@ files:
 - spec/services/solidus_bolt/accounts/detail_service_spec.rb
 - spec/services/solidus_bolt/accounts/detect_account_service_spec.rb
 - spec/services/solidus_bolt/base_service_spec.rb
+- spec/services/solidus_bolt/merchant_configuration/get_callback_urls_service_spec.rb
+- spec/services/solidus_bolt/merchant_configuration/set_callback_urls_service_spec.rb
 - spec/services/solidus_bolt/oauth/token_service_spec.rb
 - spec/services/solidus_bolt/payments/capture_sync_service_spec.rb
 - spec/services/solidus_bolt/payments/credit_sync_service_spec.rb
@@ -435,6 +443,8 @@ test_files:
 - spec/fixtures/vcr_cassettes/SolidusBolt_Accounts_DetailService/_call/with_wrong_access_token/gives_an_error.yml
 - spec/fixtures/vcr_cassettes/SolidusBolt_Accounts_DetectAccountService/_call/receives_the_correct_response.yml
 - spec/fixtures/vcr_cassettes/SolidusBolt_Accounts_DetectAccountService/_call/returns_status_200.yml
+- spec/fixtures/vcr_cassettes/SolidusBolt_MerchantConfiguration_GetCallbackUrlsService/_call/receives_the_correct_response.yml
+- spec/fixtures/vcr_cassettes/SolidusBolt_MerchantConfiguration_SetCallbackUrlsService/_call/receives_the_correct_response.yml
 - spec/fixtures/vcr_cassettes/SolidusBolt_Oauth_TokenService/_call/makes_the_API_call.yml
 - spec/fixtures/vcr_cassettes/SolidusBolt_Transactions_AuthorizeService/when_repeat_payment/_call/makes_the_API_call.yml
 - spec/fixtures/vcr_cassettes/SolidusBolt_Transactions_AuthorizeService/with_auto_capture/_call/makes_the_API_call.yml
@@ -466,6 +476,8 @@ test_files:
 - spec/services/solidus_bolt/accounts/detail_service_spec.rb
 - spec/services/solidus_bolt/accounts/detect_account_service_spec.rb
 - spec/services/solidus_bolt/base_service_spec.rb
+- spec/services/solidus_bolt/merchant_configuration/get_callback_urls_service_spec.rb
+- spec/services/solidus_bolt/merchant_configuration/set_callback_urls_service_spec.rb
 - spec/services/solidus_bolt/oauth/token_service_spec.rb
 - spec/services/solidus_bolt/payments/capture_sync_service_spec.rb
 - spec/services/solidus_bolt/payments/credit_sync_service_spec.rb