solidus_identifiers 0.1.0

data/lib/generators/solidus_identifiers/install/install_generator.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module SolidusIdentifiers
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :auto_run_migrations, type: :boolean, default: false
+
+      def add_javascripts; end
+
+      def add_stylesheets; end
+
+      def add_migrations
+        run 'bin/rails railties:install:migrations FROM=solidus_identifiers'
+      end
+
+      def run_migrations
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]')) # rubocop:disable Metrics/LineLength
+        if run_migrations
+          run 'bin/rails db:migrate'
+        else
+          puts 'Skipping bin/rails db:migrate, don\'t forget to run it!' # rubocop:disable Rails/Output
+        end
+      end
+    end
+  end
+end

data/lib/solidus_identifiers.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'solidus_core'
+require 'solidus_support'
+
+require 'solidus_identifiers/version'
+require 'solidus_identifiers/engine'

data/lib/solidus_identifiers/engine.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spree/core'
+require 'solidus_identifiers'
+
+module SolidusIdentifiers
+  class Engine < Rails::Engine
+    include SolidusSupport::EngineExtensions
+
+    isolate_namespace ::Spree
+
+    engine_name 'solidus_identifiers'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+  end
+end

data/lib/solidus_identifiers/factories.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :identifier_key, class: 'Spree::IdentifierKey' do
+    sequence(:name) { |n| "key_#{n}" }
+  end
+
+  factory :identifier, class: 'Spree::Identifier' do
+    sequence(:value) { |n| "extension-id-#{n}" }
+
+    association :key, factory: :identifier_key
+    association :attachable, factory: :user
+  end
+end

data/lib/solidus_identifiers/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SolidusIdentifiers
+  VERSION = '0.1.0'
+end

data/solidus_identifiers.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'lib/solidus_identifiers/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'solidus_identifiers'
+  spec.version = SolidusIdentifiers::VERSION
+  spec.authors = ['Taylor Scott']
+  spec.email = 't.skukx@gmail.com'
+
+  spec.summary = 'Map 3rd party services to a spree user'
+  spec.description = 'Map 3rd party services to a spree user.' \
+                     'These can include facebook, twitch, google, etc;'
+  spec.homepage = 'https://gitlab.com/deseretbook/packages/solidus_identifiers'
+  spec.license = 'BSD-3-Clause'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://gitlab.com/deseretbook/packages/solidus_identifiers'
+
+  spec.required_ruby_version = Gem::Requirement.new('~> 2.5')
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  files = Dir.chdir(__dir__) { `git ls-files -z`.split("\x0") }
+
+  spec.files = files.grep_v(%r{^(test|spec|features)/})
+  spec.test_files = files.grep(%r{^(test|spec|features)/})
+  spec.bindir = "exe"
+  spec.executables = files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'solidus_core', ['>= 2.0.0', '< 3']
+  spec.add_dependency 'solidus_support', '> 0.4'
+
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rails-controller-testing'
+  spec.add_development_dependency 'solidus_dev_support'
+end

data/spec/controllers/spree/api/identifier_keys_controller_spec.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Spree::Api::IdentifierKeysController, type: :request do
+  subject { response }
+
+  # Setup
+  let(:user) { create(:user) }
+
+  let(:headers) do
+    { 'ACCEPT': 'application/json' }
+  end
+
+  custom_authorization! do |_|
+    can [:manage], ::Spree::IdentifierKey
+  end
+
+  before do
+    allow(Spree.user_class).to receive(:find_by).with(hash_including(:spree_api_key)) { user }
+  end
+  # End Setup
+
+  # Spree::Api::IdentifierKeysController#index
+  describe 'GET /api/identifier_keys' do
+    let(:path) { '/api/identifier_keys' }
+
+    before do
+      FactoryBot.create_list(:identifier_key, 5)
+
+      get path, headers: headers
+    end
+
+    it { is_expected.to have_http_status(:ok) }
+
+    it 'must render correct templates' do
+      expect(response).to render_template(:index)
+      expect(response).to render_template('identifier_keys/_identifier_key')
+      expect(response).to render_template('spree/api/shared/_pagination')
+    end
+
+    it 'must respond with correct content type' do
+      expect(response.content_type).to include 'application/json'
+    end
+  end
+
+  # Spree::Api::IdentifierKeysController#show
+  describe 'GET /api/identifier_keys/:id' do
+    let(:identifier_key) { create(:identifier_key) }
+    let(:path) { "/api/identifier_keys/#{identifier_key.to_param}" }
+
+    before do
+      get path, headers: headers
+    end
+
+    it { is_expected.to have_http_status(:ok) }
+
+    it 'must render correct templates' do
+      expect(response).to render_template(:show)
+      expect(response).to render_template('identifier_keys/_identifier_key')
+    end
+
+    it 'must respond with correct content type' do
+      expect(response.content_type).to include 'application/json'
+    end
+  end
+
+  # Spree::Api::IdentifierKeysController#new
+  describe 'GET /api/identifier_keys/new' do
+    let(:path) { '/api/identifier_keys/new' }
+
+    before do
+      get path, headers: headers
+    end
+
+    it { is_expected.to have_http_status(:ok) }
+
+    it 'must render correct templates' do
+      expect(response).to render_template(nil)
+    end
+
+    it 'must respond with correct content type' do
+      expect(response.content_type).to include 'application/json'
+    end
+  end
+
+  # Spree::Api::IdentifierKeysController#create
+  describe 'POST /api/identifier_keys' do
+    let(:path) { '/api/identifier_keys' }
+
+    before do
+      post path, headers: headers, params: {
+        identifier_key: {
+          name: 'test'
+        }
+      }
+    end
+
+    it { is_expected.to have_http_status(:created) }
+
+    it 'must render correct templates' do
+      expect(response).to render_template(:show)
+      expect(response).to render_template('identifier_keys/_identifier_key')
+    end
+
+    it 'must respond with correct content type' do
+      expect(response.content_type).to include 'application/json'
+    end
+  end
+
+  # Spree::Api::IdentifierKeysController#update
+  describe 'PUT /api/identifier_keys/:id' do
+    let(:identifier_key) { create(:identifier_key) }
+    let(:path) { "/api/identifier_keys/#{identifier_key.to_param}" }
+
+    before do
+      put path, headers: headers, params: {
+        identifier_key: {
+          name: 'test'
+        }
+      }
+    end
+
+    it { is_expected.to have_http_status(:ok) }
+
+    it 'must render correct templates' do
+      expect(response).to render_template(:show)
+      expect(response).to render_template('identifier_keys/_identifier_key')
+    end
+
+    it 'must respond with correct content type' do
+      expect(response.content_type).to include 'application/json'
+    end
+  end
+
+  # Spree::Api::IdentifierKeysController#delete
+  describe 'DELETE /api/identifier_keys' do
+    let(:identifier_key) { create(:identifier_key) }
+    let(:path) { "/api/identifier_keys/#{identifier_key.to_param}" }
+
+    before do
+      delete path, headers: headers
+    end
+
+    it { is_expected.to have_http_status(:no_content) }
+
+    it 'renders correct templates' do
+      expect(response).to render_template(nil)
+    end
+  end
+end

data/spec/controllers/spree/api/identifiers_controller_spec.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Spree::Api::IdentifiersController, type: :request do
+  subject { response }
+
+  # Setup
+  let(:user) { create(:user) }
+
+  let(:headers) do
+    { 'ACCEPT': 'application/json' }
+  end
+
+  custom_authorization! do |_|
+    can [:manage], ::Spree::Identifier
+  end
+
+  before do
+    allow(Spree.user_class).to receive(:find_by).with(hash_including(:spree_api_key)) { user }
+  end
+  # End Setup
+
+  # Spree::Api::IdentifiersController#index
+  describe 'GET /api/identifiers' do
+    let(:path) { '/api/identifiers' }
+
+    before do
+      FactoryBot.create_list(:identifier, 5)
+
+      get path, headers: headers
+    end
+
+    it { is_expected.to have_http_status(:ok) }
+
+    it 'must render correct templates' do
+      expect(response).to render_template(:index)
+      expect(response).to render_template('identifiers/_identifier')
+      expect(response).to render_template('spree/api/shared/_pagination')
+    end
+
+    it 'must respond with correct content type' do
+      expect(response.content_type).to include 'application/json'
+    end
+  end
+
+  # Spree::Api::IdentifiersController#show
+  describe 'GET /api/identifiers/:id' do
+    let(:identifier) { create(:identifier) }
+    let(:path) { "/api/identifiers/#{identifier.to_param}" }
+
+    before do
+      get path, headers: headers
+    end
+
+    it { is_expected.to have_http_status(:ok) }
+
+    it 'must render correct templates' do
+      expect(response).to render_template(:show)
+      expect(response).to render_template('identifiers/_identifier')
+    end
+
+    it 'must respond with correct content type' do
+      expect(response.content_type).to include 'application/json'
+    end
+  end
+
+  # Spree::Api::IdentifiersController#new
+  describe 'GET /api/identifiers/new' do
+    let(:path) { '/api/identifiers/new' }
+
+    before do
+      get path, headers: headers
+    end
+
+    it { is_expected.to have_http_status(:ok) }
+
+    it 'must render correct templates' do
+      expect(response).to render_template(nil)
+    end
+
+    it 'must respond with correct content type' do
+      expect(response.content_type).to include 'application/json'
+    end
+  end
+
+  # Spree::Api::IdentifiersController#create
+  describe 'POST /api/identifiers' do
+    let(:path) { '/api/identifiers' }
+    let(:identifier_key) { FactoryBot.create(:identifier_key) }
+    let(:attachable) { FactoryBot.create(:user) }
+
+    before do
+      post path, headers: headers, params: {
+        identifier: {
+          value: 'test',
+          key_id: identifier_key.id,
+          attachable_id: attachable.id,
+          attachable_type: attachable.class.to_s
+        }
+      }
+    end
+
+    it { is_expected.to have_http_status(:created) }
+
+    it 'must render correct templates' do
+      expect(response).to render_template(:show)
+      expect(response).to render_template('identifiers/_identifier')
+    end
+
+    it 'must respond with correct content type' do
+      expect(response.content_type).to include 'application/json'
+    end
+  end
+
+  # Spree::Api::IdentifiersController#update
+  describe 'PUT /api/identifiers/:id' do
+    let(:identifier) { create(:identifier) }
+    let(:path) { "/api/identifiers/#{identifier.to_param}" }
+    let(:identifier_key) { FactoryBot.create(:identifier_key) }
+    let(:attachable) { FactoryBot.create(:user) }
+
+    before do
+      put path, headers: headers, params: {
+        identifier: {
+          value: 'test',
+          key_id: identifier_key.id,
+          attachable_id: attachable.id,
+          attachable_type: attachable.class.to_s
+        }
+      }
+    end
+
+    it { is_expected.to have_http_status(:ok) }
+
+    it 'must render correct templates' do
+      expect(response).to render_template(:show)
+      expect(response).to render_template('identifiers/_identifier')
+    end
+
+    it 'must respond with correct content type' do
+      expect(response.content_type).to include 'application/json'
+    end
+  end
+
+  # Spree::Api::IdentifiersController#delete
+  describe 'DELETE /api/identifiers' do
+    let(:identifier) { create(:identifier ) }
+    let(:path) { "/api/identifiers/#{identifier.to_param}" }
+
+    before do
+      delete path, headers: headers
+    end
+
+    it { is_expected.to have_http_status(:no_content) }
+
+    it 'renders correct templates' do
+      expect(response).to render_template(nil)
+    end
+  end
+end

data/spec/models/spree/identifier_key_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Spree::IdentifierKey, type: :model do
+  subject(:key) { instance }
+
+  let(:instance) { FactoryBot.build(:identifier_key) }
+
+  describe 'validations' do
+    it { is_expected.to be_valid }
+
+    it 'must be unique' do
+      name = 'my-key'
+
+      described_class.create!(name: name)
+      expect { described_class.create!(name: name) }.
+        to raise_error ActiveRecord::RecordInvalid
+    end
+  end
+end