solidus_identifiers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0170823488af18e57ed09e826fad553f200549e564728c3ebecf7beb72425c07'
+  data.tar.gz: fd69cb5668dee36fcd26e893573d9b4f6af8ad5210cac2f8a53cead71de2ddfa
+SHA512:
+  metadata.gz: 7badff5c06e5abc81d0fdcbb164d0a949de3856c0876272b7d96b226b045f725df79af73e3a69979c7e057b357cd5fdedcb573d42710e6e2c0b9a4f3cea853f3
+  data.tar.gz: fad42bcc10e9d681192666225a75d7e0a8e29d4cc21e481dd3adfa9466dab64a2e1a28fdc97d826294225f79b60708aa072f015ddac7d0106fb44eefe2568b4b

data/.circleci/config.yml

@@ -0,0 +1,35 @@
+version: 2.1
+
+orbs:
+  # Always take the latest version of the orb, this allows us to
+  # run specs against Solidus supported versions only without the need
+  # to change this configuration every time a Solidus version is released
+  # or goes EOL.
+  solidusio_extensions: solidusio/extensions@volatile
+
+jobs:
+  run-specs-with-postgres:
+    executor: solidusio_extensions/postgres
+    steps:
+      - solidusio_extensions/run-tests
+  run-specs-with-mysql:
+    executor: solidusio_extensions/mysql
+    steps:
+      - solidusio_extensions/run-tests
+
+workflows:
+  "Run specs on supported Solidus versions":
+    jobs:
+      - run-specs-with-postgres
+      - run-specs-with-mysql
+  "Weekly run specs against master":
+    triggers:
+      - schedule:
+          cron: "0 0 * * 4" # every Thursday
+          filters:
+            branches:
+              only:
+                - master
+    jobs:
+      - run-specs-with-postgres
+      - run-specs-with-mysql

data/.gem_release.yml

@@ -0,0 +1,5 @@
+bump:
+  recurse: false
+  file: 'lib/solidus_identifiers/version.rb'
+  message: Bump SolidusIdentifiers to %{version}
+  tag: true

data/.github/stale.yml

@@ -0,0 +1,17 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 60
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+# Label to use when marking an issue as stale
+staleLabel: wontfix
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.swp
+spec/dummy
+spec/examples.txt
+/sandbox
+.rvmrc
+.ruby-version
+.ruby-gemset
+.byebug_history

data/.gitlab/ci.yml

@@ -0,0 +1,63 @@
+image: ruby:latest
+
+stages:
+  - test
+
+cache:
+  paths:
+    - vendor/ruby
+
+variables:
+  DATABASE_CLEANER_ALLOW_REMOTE_DATABASE_URL: 'true'
+  DATABASE_URL: postgres://runner@postgres:5432/gitlab-test
+  DB: postgresql
+  POSTGRES_HOST: postgres
+  POSTGRES_USER: runner
+  POSTGRES_PASSWORD: ""
+  POSTGRES_HOST_AUTH_METHOD: trust
+  RAILS_ENV: test
+
+before_script:
+  - curl -sL https://deb.nodesource.com/setup_10.x | bash -
+  - curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add -
+  - echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list
+  - apt-get update
+  - apt-get install -qy yarn
+
+  - ruby -v  # Print out ruby version for debugging
+  - gem install bundler  --no-document    # Bundler is not installed with the image
+  - bundle config set path 'vendor/ruby'
+  - bundle install -j $(nproc) # Install dependencies into ./vendor/ruby
+
+.rspec:
+  stage: test
+  services:
+    - postgres:latest
+  script:
+    - echo "Running specs for ${SOLIDUS_BRANCH}"
+    - bundle exec rake
+
+rubocop:
+  script:
+    - bundle exec rubocop
+
+rspec:solidus-master:
+  extends: .rspec
+  variables:
+    SOLIDUS_BRANCH: master
+
+rspec:solidus-v2.10:
+  extends: .rspec
+  variables:
+    SOLIDUS_BRANCH: v2.10
+
+rspec:solidus-v2.9:
+  extends: .rspec
+  variables:
+    SOLIDUS_BRANCH: v2.9
+
+rspec:solidus-v2.8:
+  extends: .rspec
+  variables:
+    SOLIDUS_BRANCH: v2.8
+  

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,17 @@
+require:
+  - solidus_dev_support/rubocop
+
+AllCops:
+  Exclude:
+    - sandbox/**/*
+    - spec/dummy/**/*
+    - vendor/**/*
+
+Style/ClassVars:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+branch = ENV.fetch('SOLIDUS_BRANCH', 'master')
+gem 'solidus', github: 'solidusio/solidus', branch: branch
+
+# Needed to help Bundler figure out how to resolve dependencies,
+# otherwise it takes forever to resolve them.
+# See https://github.com/bundler/bundler/issues/6677
+gem 'rails', '>0.a'
+
+# Provides basic authentication functionality for testing parts of your engine
+gem 'solidus_auth_devise'
+
+case ENV['DB']
+when 'mysql'
+  gem 'mysql2'
+when 'postgresql'
+  gem 'pg'
+else
+  gem 'sqlite3'
+end
+
+gemspec
+
+# Use a local Gemfile to include development dependencies that might not be
+# relevant for the project or for other contributors, e.g. pry-byebug.
+#
+# We use `send` instead of calling `eval_gemfile` to work around an issue with
+# how Dependabot parses projects: https://github.com/dependabot/dependabot-core/issues/1658.
+send(:eval_gemfile, 'Gemfile-local') if File.exist? 'Gemfile-local'

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2020 [name of plugin creator]
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Solidus nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,396 @@
+SolidusIdentifiers
+==================
+
+Welcome to solidus identifiers. This is a simple gem for managing 3rd party identifier for user, products etc.
+The identifiers are polymorphic so they can be applied to any record.
+
+Installation
+------------
+
+Add solidus_identifiers to your Gemfile:
+
+```ruby
+gem 'solidus_identifiers'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bundle
+bundle exec rails g solidus_identifiers:install
+```
+
+Usage
+-----
+
+**Create a Key**
+
+Keys are unique by name
+
+```ruby
+Spree::IdentifierKey.create! name: 'facebook-uuid'
+Spree::IdentifierKey.create! name: 'google-uuid'
+Spree::IdentifierKey.create! name: 'twitter-uuid'
+Spree::IdentifierKey.create! name: 'braintree-customer-id'
+Spree::IdentifierKey.create! name: 'stripe-customer-id'
+
+Spree::IdentifierKey.create! name: 'stripe-customer-id'
+#=> Error! ActiveRecord::RecordNotUnique
+```
+
+**Create an Identifier**
+
+Identifiers are unique by a composite key of `(key, attachable_id, attachable_type)`.
+For example, a user can only have one identifier of a specific key.
+
+```ruby
+user = Spree::User.find(10)
+key = Spree::IdentifierKey.find_by(name: 'facebook-uuid')
+
+identifier = Spree::Identifier.create!(attachable: user, key: key, value: 'xxxx-xxxx-xxxx')
+identifier.attachable == user
+#=> true
+
+user.reload
+user.identifiers
+#=> [<Spree::Identifier xxx>]
+
+Spree::Identifier.create!(attachable: user, key: key, value: 'yyyy-yyyy-yyyy')
+#=> Error! ActiveRecord::RecordNotUnique
+```
+
+**Note**
+
+Identifiers are polymorphic however right now only the `Spree::User` has an association back to the
+`Spree::Identifier`. If you'd like to add an association from another class you can do something like:
+
+```ruby
+module ProductDecorator
+  def self.prepended(base)
+    base.has_many :identifiers, as: :attachable
+  end
+
+  ::Spree.Product.prepend(self)
+end
+
+product = Spree::Product.first
+product.identifiers
+```
+
+API
+---
+
+### Identifier Keys
+
+#### Get all Keys
+
+**Header Parameters**
+
+| Name          | Type   | Required | Description                |
+| ------------- | ------ | -------- | -------------------------- |
+| Authorization | string | required | The spree api key          |
+| Content-Type  | string | required | Must be `application/json` |
+
+**Query Parameters**
+
+None
+
+**Body Parameters**
+
+None
+
+**Request**
+
+`GET /api/identifier_keys`
+
+```json
+{}
+```
+
+**Response**
+
+```json
+{
+  "count": 1,
+  "total_count": 1,
+  "current_page": 1,
+  "pages": 1,
+  "per_page": 25,
+  "identifier_keys": [
+    {
+      "id": 1,
+      "name": "facebook-uuid"
+    },
+    {
+      "id": 2,
+      "name": "google-uuid"
+    }
+  ]
+}
+```
+
+#### Create an Identifier Key
+
+**Header Parameters**
+
+| Name          | Type   | Required | Description                |
+| ------------- | ------ | -------- | -------------------------- |
+| Authorization | string | required | The spree api key          |
+| Content-Type  | string | required | Must be `application/json` |
+
+**Query Parameters**
+
+None
+
+**Body Parameters**
+
+| Name           | Type          | Required | Description               |
+| -------------- | ------------- | -------- | ------------------------- |
+| identifier_key | IdentifierKey | required | The identifier key object |
+
+**IdentifierKey Parameters**
+
+| Name | Type   | Required | Description          |
+| ---- | ------ | -------- | -------------------- |
+| name | string | required | The name for the key |
+
+**Request**
+
+`GET /api/identifier_keys`
+
+```json
+{
+ "identifier_key": {
+  "name": "google-uuid"
+ }
+}
+```
+
+**Response**
+
+```json
+{
+    "id": 2,
+    "name": "google-uuid"
+}
+```
+
+### Identifiers
+
+#### Get all identifiers
+
+**Header Parameters**
+
+| Name          | Type   | Required | Description                |
+| ------------- | ------ | -------- | -------------------------- |
+| Authorization | string | required | The spree api key          |
+| Content-Type  | string | required | Must be `application/json` |
+
+**Query Parameters**
+
+None
+
+**Body Parameters**
+
+None
+
+**Request**
+
+`GET /api/identifiers`
+
+```json
+{}
+```
+
+**Response**
+
+```json
+{
+  "count": 2,
+  "total_count": 2,
+  "current_page": 1,
+  "pages": 1,
+  "per_page": 25,
+  "identifiers": [
+    {
+      "id": 1,
+      "value": "1111-2222-3333",
+      "key": {
+        "id": 1,
+        "name": "facebook-uuid"
+      },
+      "attachable": {
+        "id": 1,
+        "type": "Spree::User"
+      }
+    },
+    {
+      "id": 2,
+      "value": "1234-1234-1234",
+      "key": {
+        "id": 2,
+        "name": "google-uuid"
+      },
+      "attachable": {
+        "id": 1,
+        "type": "Spree::User"
+      }
+    }
+  ]
+}
+```
+
+#### Get single identifier
+
+**Header Parameters**
+
+| Name          | Type   | Required | Description                |
+| ------------- | ------ | -------- | -------------------------- |
+| Authorization | string | required | The spree api key          |
+| Content-Type  | string | required | Must be `application/json` |
+
+**Query Parameters**
+
+| Name | Type    | Required | Description              |
+| ---- | ------- | -------- | ------------------------ |
+| id   | integer | required | The id of the identifier |
+
+**Body Parameters**
+
+None
+
+**Request**
+
+`GET /api/identifiers/{id}`
+
+```json
+{}
+```
+
+**Response**
+
+```json
+{
+  "id": 1,
+  "value": "1111-2222-3333",
+  "key": {
+    "id": 1,
+    "name": "facebook-uuid"
+  },
+  "attachable": {
+    "id": 1,
+    "type": "Spree::User"
+  }
+}
+```
+
+#### Create an Identifier
+
+**Header Parameters**
+
+| Name          | Type   | Required | Description                |
+| ------------- | ------ | -------- | -------------------------- |
+| Authorization | string | required | The spree api key          |
+| Content-Type  | string | required | Must be `application/json` |
+
+**Query Parameters**
+
+None
+
+**Body Parameters**
+
+| Name            | Type    | Required | Description                           |
+| --------------- | ------- | -------- | ------------------------------------- |
+| key_id          | integer | required | The id of the Identifier Key          |
+| attachable_id   | integer | required | The id of the attachable record       |
+| attachable_type | string  | required | The type of the attachable record     |
+| value           | string  | required | The value to assign to the identifier |
+
+**Identifier Parameters**
+
+| Name | Type   | Required | Description          |
+| ---- | ------ | -------- | -------------------- |
+| name | string | required | The name for the key |
+
+**Request**
+
+`POST /api/identifiers`
+
+```json
+{
+  "identifier": {
+    "key_id": "2",
+    "value": "1234-1234-1234",
+    "attachable_type": "Spree::User",
+    "attachable_id": 1,
+ }
+}
+```
+
+**Response**
+
+```json
+{
+  "id": 2,
+  "value": "1234-1234-1234",
+  "key": {
+    "id": 2,
+    "name": "google-uuid"
+  },
+  "attachable": {
+    "id": 1,
+    "type": "Spree::User"
+  }
+}
+```
+
+Testing/Developing
+-------
+
+First bundle your dependencies, then run `bin/rake`. `bin/rake` will default to building the dummy app if it does not exist, then it will run specs. The dummy app can be regenerated by using `bin/rake extension:test_app`.
+
+```shell
+bundle
+bin/rake
+```
+
+To run [Rubocop](https://github.com/bbatsov/rubocop) static code analysis run
+
+```shell
+bundle exec rubocop
+```
+
+When testing your application's integration with this extension you may use its factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'solidus_identifiers/factories'
+```
+
+Sandbox app
+-----------
+
+To run this extension in a sandboxed Solidus application you can run `bin/sandbox`
+The path for the sandbox app is `./sandbox` and `bin/rails` will forward any Rails command
+to `sandbox/bin/rails`.
+
+Example:
+
+```shell
+$ bin/rails server
+=> Booting Puma
+=> Rails 6.0.2.1 application starting in development
+* Listening on tcp://127.0.0.1:3000
+Use Ctrl-C to stop
+```
+
+Releasing
+---------
+
+Your new extension version can be released using `gem-release` like this:
+
+```shell
+bundle exec gem bump -v VERSION --tag --push --remote upstream && gem release
+```
+
+Copyright (c) 2020 [name of extension creator], released under the New BSD License