solidus_identifiers 0.1.0

data/Rakefile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'solidus_dev_support/rake_tasks'
+SolidusDevSupport::RakeTasks.install
+
+task default: 'extension:specs'

data/app/decorators/solidus_identifiers/spree/api/api_helpers_decorator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    module ApiHelpersDecorator
+      def self.prepended(base)
+        base::ATTRIBUTES << :identifier_attributes
+        base::ATTRIBUTES << :identifier_key_attributes
+        base.mattr_reader :identifier_attributes, :identifier_key_attributes
+      end
+
+      @@identifier_attributes = %i[id value]
+      @@identifier_key_attributes = %i[id name]
+
+      if SolidusSupport.api_available?
+        ::Spree::Api::ApiHelpers.prepend self
+      end
+    end
+  end
+end

data/app/decorators/solidus_identifiers/spree/permission_sets/user_management_decorator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Spree
+  module PermissionSets
+    module UserManagementDecorator
+      def activate!
+        super
+
+        can :manage, ::Spree::Identifier, attachable_type: Spree.user_class.to_s
+      end
+
+      ::Spree::PermissionSets::DefaultCustomer.prepend(self)
+    end
+  end
+end

data/app/decorators/solidus_identifiers/spree/permitted_attributes_decorator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Spree
+  module PermittedAttributesDecorator
+    def self.prepended(base)
+      base::ATTRIBUTES << :identifier_attributes
+      base::ATTRIBUTES << :identifier_key_attributes
+      base.mattr_reader :identifier_attributes, :identifier_key_attributes
+    end
+
+    @@identifier_attributes = %i[id value key_id attachable_id attachable_type]
+    @@identifier_key_attributes = %i[id name]
+
+    ::Spree::PermittedAttributes.prepend(self)
+  end
+end

data/app/decorators/solidus_identifiers/spree/user_decorator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Spree
+  module UserDecorator
+    def self.prepended(base)
+      base.has_many :identifiers, as: :attachable
+    end
+
+    ::Spree.user_class.prepend(self)
+  end
+end

data/app/models/spree/identifier.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Spree
+  ##
+  # Identifier to store 3rd party or external identifiers for records
+  # such as a user or product.
+  #
+  class Identifier < Spree::Base
+    scope :with_key, ->(name) { joins(:key).where(spree_identifier_keys: { name: name }) }
+
+    belongs_to :key, class_name: 'Spree::IdentifierKey', foreign_key: :key_id,
+                     inverse_of: :identifiers
+    belongs_to :attachable, polymorphic: true
+
+    validates :value, presence: true
+    validates :key_id, presence: true
+    validates :key_id, uniqueness: { scope: [:attachable_id, :attachable_type] }
+  end
+end

data/app/models/spree/identifier_key.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Spree
+  ##
+  # A Key to for determining what the identifier represents.
+  # (facebook, google, twitter)
+  #
+  class IdentifierKey < Spree::Base
+    has_many :identifiers, class_name: 'Spree::Identifier',
+                           foreign_key: :key_id,
+                           dependent: :restrict_with_exception,
+                           inverse_of: :key
+
+    validates :name, uniqueness: true
+    validates :name, presence: true
+  end
+end

data/app/views/spree/api/identifier_keys/_identifier_key.json.jbuilder

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+json.cache! [I18n.locale, identifier_key] do
+  json.call(identifier_key, *identifier_key_attributes)
+end

data/app/views/spree/api/identifier_keys/index.json.jbuilder

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+json.partial! 'spree/api/shared/pagination', pagination: @identifier_keys
+json.identifier_keys(@identifier_keys) do |identifier_key|
+  json.partial!("spree/api/identifier_keys/identifier_key", identifier_key: identifier_key)
+end

data/app/views/spree/api/identifier_keys/show.json.jbuilder

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+json.partial!("spree/api/identifier_keys/identifier_key", identifier_key: @identifier_key)

data/app/views/spree/api/identifiers/_identifier.json.jbuilder

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+json.cache! [I18n.locale, identifier] do
+  json.call(identifier, *identifier_attributes)
+
+  json.key do
+    json.partial!('spree/api/identifier_keys/identifier_key', identifier_key: identifier.key)
+  end
+
+  json.attachable do
+    json.id identifier.attachable_id
+    json.type identifier.attachable_type
+  end
+end

data/app/views/spree/api/identifiers/index.json.jbuilder

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+json.partial! 'spree/api/shared/pagination', pagination: @identifiers
+json.identifiers(@identifiers) do |identifier|
+  json.partial!("spree/api/identifiers/identifier", identifier: identifier)
+end

data/app/views/spree/api/identifiers/show.json.jbuilder

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+json.partial!("spree/api/identifiers/identifier", identifier: @identifier)

data/app/views/spree/api/users/_user.json.jbuilder

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+json.call(user, *user_attributes)
+json.bill_address do
+  if user.bill_address
+    json.partial!("spree/api/addresses/address", address: user.bill_address)
+  else
+    json.nil!
+  end
+end
+json.ship_address do
+  if user.ship_address
+    json.partial!("spree/api/addresses/address", address: user.ship_address)
+  else
+    json.nil!
+  end
+end
+
+# Custom code for Identifiers
+if can?(:admin, user)
+  json.identifiers user.identifiers do |identifier|
+    json.partial!('spree/api/identifiers/identifier', identifier: identifier)
+  end
+
+  json.flattened_identifiers do
+    user.identifiers.each do |identifier|
+      json.set! identifier.key.name, identifier.value
+    end
+  end
+end
+# End Custom

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "solidus_identifiers"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+$LOAD_PATH.unshift(*Dir["#{__dir__}/../app/*"])
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/r

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/solidus_identifiers/engine', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/bin/rake

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/sandbox

@@ -0,0 +1,84 @@
+#!/usr/bin/env bash
+
+set -e
+
+case "$DB" in
+postgres|postgresql)
+  RAILSDB="postgresql"
+  ;;
+mysql)
+  RAILSDB="mysql"
+  ;;
+sqlite|'')
+  RAILSDB="sqlite3"
+  ;;
+*)
+  echo "Invalid DB specified: $DB"
+  exit 1
+  ;;
+esac
+
+if [ ! -z $SOLIDUS_BRANCH ]
+then
+  BRANCH=$SOLIDUS_BRANCH
+else
+  BRANCH="master"
+fi
+
+extension_name="solidus_identifiers"
+
+# Stay away from the bundler env of the containing extension.
+function unbundled {
+  ruby -rbundler -e'b = proc {system *ARGV}; Bundler.respond_to?(:with_unbundled_env) ? Bundler.with_unbundled_env(&b) : Bundler.with_clean_env(&b)' -- $@
+}
+
+rm -rf ./sandbox
+unbundled bundle exec rails new sandbox --database="$RAILSDB" \
+  --skip-bundle \
+  --skip-git \
+  --skip-keeps \
+  --skip-rc \
+  --skip-spring \
+  --skip-test \
+  --skip-javascript
+
+if [ ! -d "sandbox" ]; then
+  echo 'sandbox rails application failed'
+  exit 1
+fi
+
+cd ./sandbox
+cat <<RUBY >> Gemfile
+gem 'solidus', github: 'solidusio/solidus', branch: '$BRANCH'
+gem 'solidus_auth_devise', '>= 2.1.0'
+gem 'rails-i18n'
+gem 'solidus_i18n'
+
+gem '$extension_name', path: '..'
+
+group :test, :development do
+  platforms :mri do
+    gem 'pry-byebug'
+  end
+end
+RUBY
+
+unbundled bundle install --gemfile Gemfile
+
+unbundled bundle exec rake db:drop db:create
+
+unbundled bundle exec rails generate spree:install \
+  --auto-accept \
+  --user_class=Spree::User \
+  --enforce_available_locales=true \
+  --with-authentication=false \
+  $@
+
+unbundled bundle exec rails generate solidus:auth:install
+
+echo
+echo "🚀 Sandbox app successfully created for $extension_name!"
+echo "🚀 Using $RAILSDB and Solidus $BRANCH"
+echo "🚀 Use 'export DB=[postgres|mysql|sqlite]' to control the DB adapter"
+echo "🚀 Use 'export SOLIDUS_BRANCH=<BRANCH-NAME>' to control the Solidus version"
+echo "🚀 This app is intended for test purposes."

data/bin/sandbox_rails

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+app_root = 'sandbox'
+
+unless File.exist? "#{app_root}/bin/rails"
+  warn 'Creating the sandbox app...'
+  Dir.chdir "#{__dir__}/.." do
+    system "#{__dir__}/sandbox" or begin # rubocop:disable Style/AndOr
+      warn 'Automatic creation of the sandbox app failed'
+      exit 1
+    end
+  end
+end
+
+Dir.chdir app_root
+exec 'bin/rails', *ARGV

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+gem install bundler --conservative
+bundle update
+bin/rake clobber

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: Hello world

data/config/routes.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+Spree::Core::Engine.routes.draw do
+  # Add your extension routes here
+  namespace :api do
+    resources :identifiers
+    resources :identifier_keys
+  end
+end

data/db/migrate/20200603191551_create_spree_identifier_keys.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class CreateSpreeIdentifierKeys < ActiveRecord::Migration[5.2]
+  def change
+    create_table :spree_identifier_keys do |t|
+      t.string :name, unique: true, null: false
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20200603191555_create_spree_identifiers.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class CreateSpreeIdentifiers < ActiveRecord::Migration[5.2]
+  def change
+    create_table :spree_identifiers do |t|
+      t.string :value, null: false
+      t.integer :key_id
+      t.integer :attachable_id
+      t.string :attachable_type
+      t.timestamps
+    end
+
+    add_index :spree_identifiers, [:attachable_id, :attachable_type],
+      name: 'ext_id_attachable_index'
+    add_index :spree_identifiers, [:attachable_id, :attachable_type, :key_id],
+      unique: true, name: 'ext_id_uniq_attachable_index'
+  end
+end

data/db/migrate/20200603203105_add_unique_index_to_spree_identifier_keys.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddUniqueIndexToSpreeIdentifierKeys < ActiveRecord::Migration[5.2]
+  def change
+    add_index :spree_identifier_keys, :name, unique: true
+  end
+end

data/lib/controllers/api/spree/api/identifier_keys_controller.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    class IdentifierKeysController < Spree::Api::ResourceController
+      helper ::Spree::Core::Engine.routes.url_helpers
+
+      private
+
+      def permitted_identifier_key_attributes
+        Spree::PermittedAttributes.identifier_key_attributes
+      end
+    end
+  end
+end

data/lib/controllers/api/spree/api/identifiers_controller.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Spree
+  module Api
+    class IdentifiersController < Spree::Api::ResourceController
+      helper ::Spree::Core::Engine.routes.url_helpers
+
+      private
+
+      def permitted_identifier_attributes
+        Spree::PermittedAttributes.identifier_attributes
+      end
+    end
+  end
+end