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.

Admin: basic UI to manage

Damian Legawiecd939a3b0ae3f
diff --git a/admin/app/controllers/spree/admin/api_keys_controller.rb b/admin/app/controllers/spree/admin/api_keys_controller.rb
new file mode 100644
index 0000000000..5cd610d08e
--- /dev/null
+++ b/admin/app/controllers/spree/admin/api_keys_controller.rb
@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Spree
+ module Admin
+ class ApiKeysController < ResourceController
+ include Spree::Admin::SettingsConcern
+ include Spree::Admin::TableConcern
+
+ helper 'spree/admin/api_keys'
+
+ def revoke
+ @object = scope.find(params[:id])
+ @object.revoke!(try_spree_current_user)
+ flash[:success] = Spree.t('admin.api_keys.revoked')
+ redirect_to spree.admin_api_key_path(@object)
+ end
+
+ private
+
+ def model_class
+ Spree::ApiKey
+ end
+
+ def scope
+ current_store.api_keys
+ end
+
+ def object_name
+ 'api_key'
+ end
+
+ def permitted_resource_params
+ permitted = params.require(:api_key).permit(permitted_api_key_attributes)
+ # key_type can only be set on create, not update
+ permitted.delete(:key_type) unless action_name == 'create'
+ permitted
+ end
+
+ def location_after_save
+ spree.admin_api_key_path(@object)
+ end
+
+ def update_turbo_stream_enabled?
+ true
+ end
+
+ def build_resource
+ if params[:api_key].present?
+ scope.new(permitted_resource_params.merge(created_by: try_spree_current_user))
+ else
+ scope.new(created_by: try_spree_current_user)
+ end
+ end
+ end
+ end
+end
diff --git a/admin/app/helpers/spree/admin/api_keys_helper.rb b/admin/app/helpers/spree/admin/api_keys_helper.rb
new file mode 100644
index 0000000000..e0556a1c09
--- /dev/null
+++ b/admin/app/helpers/spree/admin/api_keys_helper.rb
@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Spree
+ module Admin
+ module ApiKeysHelper
+ def api_key_type_options
+ Spree::ApiKey::KEY_TYPES.map do |type|
+ [Spree.t("admin.api_keys.key_types.#{type}"), type]
+ end
+ end
+
+ def api_key_status_badge(api_key)
+ if api_key.active?
+ content_tag(:span, icon('check') + Spree.t('admin.api_keys.statuses.active'), class: 'badge badge-success')
+ else
+ content_tag(:span, icon('alert-triangle') + Spree.t('admin.api_keys.statuses.revoked'), class: 'badge badge-danger')
+ end
+ end
+
+ def api_key_type_badge(api_key)
+ badge_class = api_key.publishable? ? 'badge-light' : 'badge-warning'
+ icon = api_key.publishable? ? 'eye' : 'lock-password'
+ content_tag(:span, icon(icon) + Spree.t("admin.api_keys.key_types.#{api_key.key_type}"), class: "badge #{badge_class}")
+ end
+
+ def masked_api_key(api_key)
+ token = api_key.token
+ "#{token[0..6]}#{'*' * 16}#{token[-4..]}"
+ end
+ end
+ end
+end
diff --git a/admin/app/views/spree/admin/api_keys/_details.html.erb b/admin/app/views/spree/admin/api_keys/_details.html.erb
new file mode 100644
index 0000000000..daf3fb4bfa
--- /dev/null
+++ b/admin/app/views/spree/admin/api_keys/_details.html.erb
@@ -0,0 +1,51 @@
+<div class="card mb-6">
+ <div class="card-header">
+ <h5 class="card-title"><%= Spree.t(:details) %></h5>
+ </div>
+ <div class="card-body">
+ <dl class="space-y-4">
+ <div>
+ <dt class="text-sm text-gray-500"><%= Spree.t(:status) %></dt>
+ <dd class="mt-1"><%= api_key_status_badge(@api_key) %></dd>
+ </div>
+
+ <div>
+ <dt class="text-sm text-gray-500"><%= Spree.t(:type) %></dt>
+ <dd class="mt-1"><%= api_key_type_badge(@api_key) %></dd>
+ </div>
+
+ <div>
+ <dt class="text-sm text-gray-500"><%= Spree.t(:created_at) %></dt>
+ <dd class="mt-1"><%= l(@api_key.created_at, format: :long) %></dd>
+ </div>
+
+ <% if @api_key.created_by.present? %>
+ <div>
+ <dt class="text-sm text-gray-500"><%= Spree.t(:created_by) %></dt>
+ <dd class="mt-1"><%= @api_key.created_by.try(:email) || @api_key.created_by.to_s %></dd>
+ </div>
+ <% end %>
+
+ <% if @api_key.last_used_at.present? %>
+ <div>
+ <dt class="text-sm text-gray-500"><%= Spree.t('admin.api_keys.last_used_at') %></dt>
+ <dd class="mt-1"><%= l(@api_key.last_used_at, format: :long) %></dd>
+ </div>
+ <% end %>
+
+ <% if @api_key.revoked_at.present? %>
+ <div>
+ <dt class="text-sm text-gray-500"><%= Spree.t('admin.api_keys.revoked_at') %></dt>
+ <dd class="mt-1 text-red-600"><%= l(@api_key.revoked_at, format: :long) %></dd>
+ </div>
+
+ <% if @api_key.revoked_by.present? %>
+ <div>
+ <dt class="text-sm text-gray-500"><%= Spree.t('admin.api_keys.revoked_by') %></dt>
+ <dd class="mt-1"><%= @api_key.revoked_by.try(:email) || @api_key.revoked_by.to_s %></dd>
+ </div>
+ <% end %>
+ <% end %>
+ </dl>
+ </div>
+</div>
diff --git a/admin/app/views/spree/admin/api_keys/_form.html.erb b/admin/app/views/spree/admin/api_keys/_form.html.erb
new file mode 100644
index 0000000000..0fe27634da
--- /dev/null
+++ b/admin/app/views/spree/admin/api_keys/_form.html.erb
@@ -0,0 +1,26 @@
+<div class="card mb-6">
+ <div class="card-body">
+ <%= f.spree_text_field :name, required: true, autofocus: f.object.new_record?,
+ placeholder: Spree.t('admin.api_keys.name_placeholder') %>
+
+ <% if f.object.new_record? %>
+ <%= f.spree_select :key_type, api_key_type_options,
+ { prompt: Spree.t(:select_key_type), label: Spree.t(:type) },
+ { required: true } %>
+ <p class="text-sm text-gray-500 mt-2">
+ <strong><%= Spree.t('admin.api_keys.key_types.publishable') %>:</strong>
+ <%= Spree.t('admin.api_keys.key_type_descriptions.publishable') %>
+ <br>
+ <strong><%= Spree.t('admin.api_keys.key_types.secret') %>:</strong>
+ <%= Spree.t('admin.api_keys.key_type_descriptions.secret') %>
+ </p>
+ <% else %>
+ <div class="form-group">
+ <label class="form-label"><%= Spree.t(:type) %></label>
+ <div class="form-control-plaintext">
+ <%= api_key_type_badge(@api_key) %>
+ </div>
+ </div>
+ <% end %>
+ </div>
+</div>
diff --git a/admin/app/views/spree/admin/api_keys/_token_card.html.erb b/admin/app/views/spree/admin/api_keys/_token_card.html.erb
new file mode 100644
index 0000000000..e1fe4d4752
--- /dev/null
+++ b/admin/app/views/spree/admin/api_keys/_token_card.html.erb
@@ -0,0 +1,28 @@
+<div class="card mb-6">
+ <div class="card-header">
+ <h5 class="card-title"><%= Spree.t(:api_key) %></h5>
+ </div>
+ <div class="card-body">
+ <% if @api_key.active? %>
+ <div data-controller="password-visibility" class="input-group gap-0 pr-1">
+ <input type="password" class="grow text-truncate" data-password-visibility-target="input" spellcheck="false" value="<%= @api_key.token %>" readonly>
+
+ <button type="button" class="btn hover:bg-gray-100 p-1 mr-1 rounded" data-action="password-visibility#toggle">
+ <span data-password-visibility-target="icon"><%= icon 'eye', class: 'mr-0' %></span>
+ <span data-password-visibility-target="icon" class="hidden"><%= icon 'eye-off', class: 'mr-0' %></span>
+ </button>
+
+ <%= clipboard_component(@api_key.token,
+ button_class: 'btn hover:bg-gray-100 p-1 rounded',
+ icon_class: 'mr-0') %>
+ </div>
+ <% else %>
+ <div class="bg-red-50 border border-red-200 rounded-md p-4">
+ <div class="flex items-center">
+ <%= icon 'alert-triangle', class: 'text-red-500 mr-2' %>
+ <span class="text-red-700"><%= Spree.t('admin.api_keys.key_revoked_message') %></span>
+ </div>
+ </div>
+ <% end %>
+ </div>
+</div>
diff --git a/admin/app/views/spree/admin/api_keys/_usage_info.html.erb b/admin/app/views/spree/admin/api_keys/_usage_info.html.erb
new file mode 100644
index 0000000000..cf5d0eef3d
--- /dev/null
+++ b/admin/app/views/spree/admin/api_keys/_usage_info.html.erb
@@ -0,0 +1,16 @@
+<div class="card mb-6">
+ <div class="card-header">
+ <h5 class="card-title"><%= Spree.t('admin.api_keys.usage') %></h5>
+ </div>
+ <div class="card-body">
+ <p class="text-sm text-gray-600 mb-4">
+ <%= Spree.t("admin.api_keys.usage_instructions.#{@api_key.key_type}") %>
+ </p>
+
+ <h6 class="font-medium text-sm mb-2"><%= Spree.t('admin.api_keys.example_request') %></h6>
+ <div class="bg-gray-900 rounded-md p-4 overflow-x-auto">
+ <pre class="text-green-400 text-sm font-mono whitespace-pre-wrap"><code>curl -X GET "https://your-store.com/api/v3/store/products" \
+ -H "X-Spree-Api-Key: <%= @api_key.token %>"</code></pre>
+ </div>
+ </div>
+</div>
diff --git a/admin/app/views/spree/admin/api_keys/edit.html.erb b/admin/app/views/spree/admin/api_keys/edit.html.erb
new file mode 100644
index 0000000000..f5b8f8cb5d
--- /dev/null
+++ b/admin/app/views/spree/admin/api_keys/edit.html.erb
@@ -0,0 +1 @@
+<%= render 'spree/admin/shared/edit_resource' %>
diff --git a/admin/app/views/spree/admin/api_keys/index.html.erb b/admin/app/views/spree/admin/api_keys/index.html.erb
new file mode 100644
index 0000000000..f0c2a7a3c9
--- /dev/null
+++ b/admin/app/views/spree/admin/api_keys/index.html.erb
@@ -0,0 +1,9 @@
+<%= render 'spree/admin/shared/developers_nav' %>
+
+<%= content_for(:title, Spree.t(:api_keys)) %>
+
+<% content_for :page_actions do %>
+ <%= link_to_with_icon 'plus', Spree.t(:new_api_key), new_object_url, class: "btn btn-primary" if can? :create, Spree::ApiKey %>
+<% end %>
+
+<%= render_table @collection, :api_keys %>
diff --git a/admin/app/views/spree/admin/api_keys/new.html.erb b/admin/app/views/spree/admin/api_keys/new.html.erb
new file mode 100644
index 0000000000..65a817edc9
--- /dev/null
+++ b/admin/app/views/spree/admin/api_keys/new.html.erb
@@ -0,0 +1 @@
+<%= render 'spree/admin/shared/new_resource' %>
diff --git a/admin/app/views/spree/admin/api_keys/show.html.erb b/admin/app/views/spree/admin/api_keys/show.html.erb
new file mode 100644
index 0000000000..3a86543e56
--- /dev/null
+++ b/admin/app/views/spree/admin/api_keys/show.html.erb
@@ -0,0 +1,26 @@
+<%= content_for :page_title do %>
+ <%= page_header_back_button(collection_url) %>
+ <%= @api_key.name %>
+<% end %>
+
+<% content_for :page_actions do %>
+ <% if @api_key.active? && can?(:update, @api_key) %>
+ <%= link_to Spree.t(:edit), edit_object_url(@api_key), class: 'btn btn-light' %>
+ <%= button_to Spree.t('admin.api_keys.revoke'),
+ spree.revoke_admin_api_key_path(@api_key),
+ method: :put,
+ class: 'btn btn-danger',
+ data: { confirm: Spree.t('admin.api_keys.revoke_confirmation') } %>
+ <% end %>
+<% end %>
+
+<div class="grid grid-cols-12 gap-6">
+ <div class="col-span-12 lg:col-span-8">
+ <%= render 'token_card' %>
+ <%= render 'usage_info' %>
+ </div>
+
+ <div class="col-span-12 lg:col-span-4">
+ <%= render 'details' %>
+ </div>
+</div>
diff --git a/admin/app/views/spree/admin/shared/_content_header.html.erb b/admin/app/views/spree/admin/shared/_content_header.html.erb
index 17fa1bd976..fbbfcde41a 100644
--- a/admin/app/views/spree/admin/shared/_content_header.html.erb
+++ b/admin/app/views/spree/admin/shared/_content_header.html.erb
@@ -52,7 +52,7 @@
</div>
<% end %>
<div data-controller="clipboard" data-clipboard-success-content-value='<%= icon('check') + ' ' + Spree.t(:copied) %>'>
- <%= hidden_field_tag :record_id, record.id, data: { clipboard_target: 'source' } %>
+ <%= hidden_field_tag :record_id, record.respond_to?(:prefix_id) ? record.prefix_id : record.id, data: { clipboard_target: 'source' } %>
<button data-action="clipboard#copy" class="text-left dropdown-item" data-clipboard-target="button">
<%= icon 'copy' %>
<%= Spree.t(:copy_id) %>
diff --git a/admin/app/views/spree/admin/tables/columns/_api_key_status.html.erb b/admin/app/views/spree/admin/tables/columns/_api_key_status.html.erb
new file mode 100644
index 0000000000..27f9151803
--- /dev/null
+++ b/admin/app/views/spree/admin/tables/columns/_api_key_status.html.erb
@@ -0,0 +1,2 @@
+<%# locals: (record:, column:, value:) %>
+<%= api_key_status_badge(record) %>
diff --git a/admin/app/views/spree/admin/tables/columns/_api_key_type.html.erb b/admin/app/views/spree/admin/tables/columns/_api_key_type.html.erb
new file mode 100644
index 0000000000..9d1ef48c10
--- /dev/null
+++ b/admin/app/views/spree/admin/tables/columns/_api_key_type.html.erb
@@ -0,0 +1,2 @@
+<%# locals: (record:, column:, value:) %>
+<%= api_key_type_badge(record) %>
diff --git a/admin/config/initializers/spree_admin_navigation.rb b/admin/config/initializers/spree_admin_navigation.rb
index cc2ad577f0..f8c55c5bab 100644
--- a/admin/config/initializers/spree_admin_navigation.rb
+++ b/admin/config/initializers/spree_admin_navigation.rb
@@ -346,11 +346,11 @@ Rails.application.config.after_initialize do
# Developers
settings_nav.add :developers,
label: :developers,
- url: :admin_oauth_applications_path,
+ url: :admin_api_keys_path,
icon: 'terminal',
position: 150,
- active: -> { %w[oauth_applications webhooks_subscribers webhook_endpoints webhook_deliveries].include?(controller_name) },
- if: -> { can?(:manage, Spree::OauthApplication) }
+ active: -> { %w[oauth_applications api_keys webhooks_subscribers webhook_endpoints webhook_deliveries].include?(controller_name) },
+ if: -> { can?(:manage, Spree::ApiKey) }
# Edit Profile
settings_nav.add :edit_profile,
@@ -459,10 +459,10 @@ Rails.application.config.after_initialize do
developers_tabs_nav.add :api_keys,
label: :api_keys,
- url: :admin_oauth_applications_path,
+ url: :admin_api_keys_path,
position: 10,
- active: -> { controller_name == 'oauth_applications' },
- if: -> { can?(:manage, Spree::OauthApplication) }
+ active: -> { controller_name == 'api_keys' },
+ if: -> { can?(:manage, Spree::ApiKey) }
developers_tabs_nav.add :webhook_endpoints,
label: :webhook_endpoints,
@@ -471,6 +471,13 @@ Rails.application.config.after_initialize do
active: -> { %w[webhook_endpoints webhook_deliveries].include?(controller_name) },
if: -> { can?(:manage, Spree::WebhookEndpoint) }
+ developers_tabs_nav.add :oauth_applications,
+ label: :oauth_applications,
+ url: :admin_oauth_applications_path,
+ position: 30,
+ active: -> { controller_name == 'oauth_applications' },
+ if: -> { can?(:manage, Spree::OauthApplication) }
+
# Audit Tab Navigation
audit_tabs_nav = Spree.admin.navigation.audit_tabs
diff --git a/admin/config/initializers/spree_admin_tables.rb b/admin/config/initializers/spree_admin_tables.rb
index c44a9e54af..63a0cccc4b 100644
--- a/admin/config/initializers/spree_admin_tables.rb
+++ b/admin/config/initializers/spree_admin_tables.rb
@@ -1408,6 +1408,66 @@ Rails.application.config.after_initialize do
default: false,
position: 80
+ # ==========================================
+ # API Keys Table
+ # ==========================================
+ Spree.admin.tables.register(:api_keys, model_class: Spree::ApiKey, search_param: :name_cont, row_actions: false, link_to_action: :show)
+
+ Spree.admin.tables.api_keys.add :name,
+ label: :name,
+ type: :link,
+ sortable: true,
+ filterable: true,
+ default: true,
+ position: 10
+
+ Spree.admin.tables.api_keys.add :key_type,
+ label: 'admin.api_keys.key_type',
+ type: :custom,
+ sortable: true,
+ filterable: true,
+ default: true,
+ position: 20,
+ partial: 'spree/admin/tables/columns/api_key_type',
+ filter_type: :select,
+ value_options: [
+ { value: 'publishable', label: 'Publishable' },
+ { value: 'secret', label: 'Secret' }
+ ]
+
+ Spree.admin.tables.api_keys.add :status,
+ label: :status,
+ type: :custom,
+ sortable: false,
+ filterable: false,
+ default: true,
+ position: 30,
+ partial: 'spree/admin/tables/columns/api_key_status'
+
+ Spree.admin.tables.api_keys.add :last_used_at,
+ label: 'admin.api_keys.last_used_at',
+ type: :datetime,
+ sortable: true,
+ filterable: false,
+ default: true,
+ position: 40
+
+ Spree.admin.tables.api_keys.add :created_at,
+ label: :created_at,
+ type: :datetime,
+ sortable: true,
+ filterable: true,
+ default: true,
+ position: 50
+
+ Spree.admin.tables.api_keys.add :updated_at,
+ label: :updated_at,
+ type: :datetime,
+ sortable: true,
+ filterable: true,
+ default: false,
+ position: 60
+
# ==========================================
# Price Lists Table
# ==========================================
diff --git a/admin/config/locales/en.yml b/admin/config/locales/en.yml
index 0f6ad4ce7c..aac215b89d 100644
--- a/admin/config/locales/en.yml
+++ b/admin/config/locales/en.yml
@@ -355,6 +355,30 @@ en:
total_inventory_html: 'Total inventory at %{stock_location} location: %{count} available'
vendors:
enterprise_feature: Multi-Vendor Marketplace is available in the Enterprise Edition
+ api_keys:
+ example_request: Example Request
+ key_revoked_message: This API key has been revoked and can no longer be used.
+ key_type_descriptions:
+ publishable: Safe to use in client-side code like mobile apps or browsers.
+ secret: Keep this secure and only use it server-side. Never expose it publicly.
+ key_types:
+ publishable: Publishable
+ secret: Secret
+ last_used_at: Last used
+ list: API Keys
+ name_placeholder: e.g. Mobile App Production
+ revoke_confirmation: Are you sure you want to revoke this API key? This action cannot be undone.
+ revoked: API key has been revoked
+ revoked_at: Revoked at
+ revoked_by: Revoked by
+ statuses:
+ active: Active
+ revoked: Revoked
+ token_warning: Store this key securely. It will be shown only this once.
+ usage: Usage
+ usage_instructions:
+ publishable: Use this key for client-side requests. It can be safely included in your frontend code.
+ secret: Use this key for server-side requests only. Keep it confidential and never expose it in client-side code.
webhook_deliveries:
delivered_at: Delivered at
delivery_details: Delivery Details
diff --git a/admin/config/routes.rb b/admin/config/routes.rb
index d2628a76e1..f00c3ba7a1 100644
--- a/admin/config/routes.rb
+++ b/admin/config/routes.rb
@@ -267,6 +267,11 @@ Spree::Core::Engine.add_routes do
# developer tools
resources :oauth_applications
+ resources :api_keys, except: :destroy do
+ member do
+ put :revoke
+ end
+ end
resources :webhook_endpoints do
resources :webhook_deliveries, only: [:index, :show]
end
diff --git a/admin/spec/controllers/spree/admin/api_keys_controller_spec.rb b/admin/spec/controllers/spree/admin/api_keys_controller_spec.rb
new file mode 100644
index 0000000000..a7a24f9d70
--- /dev/null
+++ b/admin/spec/controllers/spree/admin/api_keys_controller_spec.rb
@@ -0,0 +1,246 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Spree::Admin::ApiKeysController, type: :controller do
+ stub_authorization!
+ render_views
+
+ let(:store) { @default_store }
+
+ describe 'GET #index' do
+ subject(:index) { get :index }
+
+ let!(:api_keys) { create_list(:api_key, 3, store: store) }
+ let!(:other_store_keys) { create_list(:api_key, 2, store: create(:store)) }
+
+ it 'renders the index template' do
+ index
+
+ expect(response).to render_template(:index)
+ end
+
+ it 'assigns api keys for current store only' do
+ index
+
+ expect(assigns[:collection]).to contain_exactly(*api_keys)
+ end
+ end
+
+ describe 'GET #show' do
+ subject(:show) { get :show, params: { id: api_key.id } }
+
+ let(:api_key) { create(:api_key, store: store) }
+
+ it 'renders the show template' do
+ show
+
+ expect(response).to render_template(:show)
+ end
+
+ it 'assigns the api key' do
+ show
+
+ expect(assigns[:api_key]).to eq(api_key)
+ end
+ end
+
+ describe 'GET #new' do
+ subject(:new_action) { get :new }
+
+ it 'renders the new template' do
+ new_action
+
+ expect(response).to render_template(:new)
+ end
+
+ it 'assigns a new api key' do
+ new_action
+
+ expect(assigns[:api_key]).to be_a_new(Spree::ApiKey)
+ end
+ end
+
+ describe 'POST #create' do
+ subject(:create_key) { post :create, params: { api_key: key_params } }
+
+ let(:key_params) do
+ {
+ name: 'My API Key',
+ key_type: 'publishable'
+ }
+ end
+
+ it 'creates a new api key' do
+ expect { create_key }.to change(Spree::ApiKey, :count).by(1)
+ end
+
+ it 'sets the attributes correctly' do
+ create_key
+
+ api_key = Spree::ApiKey.last
+ expect(api_key.name).to eq('My API Key')
+ expect(api_key.key_type).to eq('publishable')
+ expect(api_key.store).to eq(store)
+ end
+
+ it 'generates a token with correct prefix' do
+ create_key
+
+ api_key = Spree::ApiKey.last
+ expect(api_key.token).to start_with('pk_')
+ end
+
+ it 'redirects to show page' do
+ create_key
+
+ expect(response).to redirect_to(spree.admin_api_key_path(Spree::ApiKey.last))
+ end
+
+ context 'with secret key type' do
+ let(:key_params) do
+ {
+ name: 'Secret Key',
+ key_type: 'secret'
+ }
+ end
+
+ it 'generates a token with sk_ prefix' do
+ create_key
+
+ api_key = Spree::ApiKey.last
+ expect(api_key.token).to start_with('sk_')
+ end
+ end
+
+ context 'with invalid params' do
+ let(:key_params) { { name: '' } }
+
+ it 'does not create an api key' do
+ expect { create_key }.not_to change(Spree::ApiKey, :count)
+ end
+
+ it 'renders the new template' do
+ create_key
+
+ expect(response).to render_template(:new)
+ end
+ end
+ end
+
+ describe 'GET #edit' do
+ subject(:edit) { get :edit, params: { id: api_key.id } }
+
+ let(:api_key) { create(:api_key, store: store) }
+
+ it 'renders the edit template' do
+ edit
+
+ expect(response).to render_template(:edit)
+ end
+
+ it 'assigns the api key' do
+ edit
+
+ expect(assigns[:api_key]).to eq(api_key)
+ end
+ end
+
+ describe 'PUT #update' do
+ subject(:update_key) { put :update, params: { id: api_key.id, api_key: key_params } }
+
+ let!(:api_key) { create(:api_key, store: store, name: 'Old Name') }
+
+ let(:key_params) do
+ {
+ name: 'New Name'
+ }
+ end
+
+ it 'updates the api key' do
+ update_key
+
+ api_key.reload
+ expect(api_key.name).to eq('New Name')
+ end
+
+ it 'redirects to show page' do
+ update_key
+
+ expect(response).to redirect_to(spree.admin_api_key_path(api_key))
+ end
+
+ context 'with invalid params' do
+ let(:key_params) { { name: '' } }
+
+ it 'does not update the api key' do
+ update_key
+
+ api_key.reload
+ expect(api_key.name).to eq('Old Name')
+ end
+
+ it 'renders the edit template' do
+ update_key
+
+ expect(response).to render_template(:edit)
+ end
+ end
+
+ context 'when trying to change key_type' do
+ let!(:api_key) { create(:api_key, :publishable, store: store, name: 'Old Name') }
+ let(:key_params) { { key_type: 'secret' } }
+
+ it 'does not change the key type (key_type is not in permitted attributes)' do
+ update_key
+
+ api_key.reload
+ expect(api_key.key_type).to eq('publishable')
+ end
+ end
+ end
+
+ describe 'DELETE #destroy' do
+ subject(:destroy_key) { delete :destroy, params: { id: api_key.id } }
+
+ let!(:api_key) { create(:api_key, store: store) }
+
+ it 'deletes the api key' do
+ expect { destroy_key }.to change(Spree::ApiKey, :count).by(-1)
+ end
+
+ it 'redirects to index' do
+ destroy_key
+
+ expect(response).to redirect_to(spree.admin_api_keys_path)
+ end
+ end
+
+ describe 'PUT #revoke' do
+ subject(:revoke_key) { put :revoke, params: { id: api_key.id } }
+
+ let!(:api_key) { create(:api_key, store: store) }
+
+ it 'revokes the api key' do
+ expect(api_key.active?).to be true
+
+ revoke_key
+
+ api_key.reload
+ expect(api_key.active?).to be false
+ expect(api_key.revoked_at).to be_present
+ end
+
+ it 'redirects to show page' do
+ revoke_key
+
+ expect(response).to redirect_to(spree.admin_api_key_path(api_key))
+ end
+
+ it 'sets the flash message' do
+ revoke_key
+
+ expect(flash[:success]).to be_present
+ end
+ end
+end