Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Fixed creating Secret Keys with Scopes in rails admin

Damian Legawiecbd3e22ccca27
diff --git a/spree/admin/app/views/spree/admin/api_keys/_form.html.erb b/spree/admin/app/views/spree/admin/api_keys/_form.html.erb
index 0fe27634da..d911186ea9 100644
--- a/spree/admin/app/views/spree/admin/api_keys/_form.html.erb
+++ b/spree/admin/app/views/spree/admin/api_keys/_form.html.erb
@@ -24,3 +24,21 @@
<% end %>
</div>
</div>
+
+<div class="card mb-6" id="api-key-scopes" data-secret-only data-show-when-key-type="secret">
+ <div class="card-header">
+ <h5 class="card-title"><%= Spree.t('admin.api_keys.scopes', default: 'Scopes') %></h5>
+ <p class="text-sm text-gray-500 mt-1">
+ <%= Spree.t('admin.api_keys.scopes_description', default: 'Required for secret keys. Pick the narrowest set of scopes your integration needs.') %>
+ </p>
+ </div>
+ <div class="card-body">
+ <% Spree::ApiKey::SCOPES.each do |scope| %>
+ <div class="custom-control custom-checkbox mb-1">
+ <%= f.check_box :scopes, { multiple: true, class: 'custom-control-input', id: "api_key_scopes_#{scope}" }, scope, nil %>
+ <%= f.label "scopes_#{scope}", scope, class: 'custom-control-label font-mono text-sm' %>
+ </div>
+ <% end %>
+ <%= f.hidden_field :scopes, value: '', multiple: true %>
+ </div>
+</div>
diff --git a/spree/admin/config/locales/en.yml b/spree/admin/config/locales/en.yml
index b682cb07f1..defb4f0e0e 100644
--- a/spree/admin/config/locales/en.yml
+++ b/spree/admin/config/locales/en.yml
@@ -26,6 +26,8 @@ en:
revoked: API key has been revoked
revoked_at: Revoked at
revoked_by: Revoked by
+ scopes: Scopes
+ scopes_description: Required for secret keys. Pick the narrowest set of scopes your integration needs.
secret_key_hidden: This secret key cannot be revealed. If you've lost it, revoke this key and create a new one.
statuses:
active: Active
diff --git a/spree/admin/spec/controllers/spree/admin/api_keys_controller_spec.rb b/spree/admin/spec/controllers/spree/admin/api_keys_controller_spec.rb
index 7ef797d932..58dc947c04 100644
--- a/spree/admin/spec/controllers/spree/admin/api_keys_controller_spec.rb
+++ b/spree/admin/spec/controllers/spree/admin/api_keys_controller_spec.rb
@@ -101,7 +101,8 @@ RSpec.describe Spree::Admin::ApiKeysController, type: :controller do
let(:key_params) do
{
name: 'Secret Key',
- key_type: 'secret'
+ key_type: 'secret',
+ scopes: ['write_all']
}
end
diff --git a/spree/core/lib/spree/permitted_attributes.rb b/spree/core/lib/spree/permitted_attributes.rb
index 7cffc53a73..b5a0e11ff5 100644
--- a/spree/core/lib/spree/permitted_attributes.rb
+++ b/spree/core/lib/spree/permitted_attributes.rb
@@ -90,7 +90,7 @@ module Spree
@@allowed_origin_attributes = [:origin]
- @@api_key_attributes = [:name, :key_type]
+ @@api_key_attributes = [:name, :key_type, { scopes: [] }]
@@asset_attributes = [:type, :viewable_id, :viewable_type, :attachment, :alt, :position, :url, :signed_id]