alchemy_spree 0.3.0 → 1.0.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 953d2bd54c42ee048850217613a981122584dfc8
-  data.tar.gz: a5e80e786905bf2798eb05b204e0bc07ea78ffac
+  metadata.gz: c85623e15a5d44f28558ce70f514589423e5418c
+  data.tar.gz: faeeec7cef1249a91eaa03bfba29f35f7c577198
 SHA512:
-  metadata.gz: c2e878aa1e0ea152da467326b319d7f8de8d7dab31b1fbdbf32936a90dd6ddf7653e16a81890e421fde2ebcd68dbd83dc4f4f4b83a11c0696109d4a63f1d9bec
-  data.tar.gz: 3fe19a7605050fa4ac334a256fc7306506e9660784121b80ace70b419368cd6ea5053a507a39989cc2dd3dcc1fdc10dda48ba17c3f744ea655ad5aff83e9f040
+  metadata.gz: 300e1ba2611427bf96a7a697485d2d7a5fd9cd65821a48ba2102b8ef81c391d37dc0b36ef0e34ea2e9f182ae6df071346379dc6b0d11212e1e4c243a152e852f
+  data.tar.gz: e49b7e103f6341e765ca5e2e6c82b460815968c098744a017a662c98f768f15845282af4d84a5d43f8cf91c2a90b8fedc0067d5a2ca630ccf3589567e536c95b

data/README.md

@@ -18,7 +18,7 @@ This version runs with Spreecommerce 2.1 and above.
 
 ## Alchemy
 
-This version runs with Alchemy 3.0
+This version runs with Alchemy 3.0 and above.
 
 ## Installation
 
@@ -28,48 +28,126 @@ Add this line to your application's Gemfile:
 gem 'alchemy_spree', github: 'magiclabs/alchemy_spree', branch: 'master'
 ```
 
-And then execute:
+Install the gem with:
 
-```sh
-$ bundle
+```shell
+$ bundle install
 ```
 
-Install the migrations:
+### Authentication system installation
 
-```sh
-$ rake alchemy_spree:install:migrations
-```
+Both Alchemy 3.0 and Spree come without an authentication system in place. You will need to choose an authentication system yourself. There are 3 available options. Whichever you choose, you need to instruct Spree & Alchemy about your choice of authentication system.
 
-Migrate the database:
+Here are the steps for each option:
 
-```sh
-$ rake db:migrate
+#### 1. Option: Use [Spree Auth Devise](https://github.com/spree/spree_auth_devise)
+
+**Recommended for:**
+  - An existing Spree installation (`gem 'spree_auth_devise'` should already be in your Gemfile).
+  - You are just adding Alchemy
+
+To use Spree Auth Devise, instruct Alchemy to use the `Spree::User` class:
+
+```ruby
+# config/initializers/alchemy.rb
+
+# Tell Alchemy to use the Spree::User class
+Alchemy.user_class_name = 'Spree::User'
+Alchemy.current_user_method = :spree_current_user
+
+# Load the Spree.user_class decorator for Alchemy roles
+require 'alchemy/spree/spree_user_decorator'
+
+# Include the Spree controller helpers to render the
+# alchemy pages within the default Spree layout
+Alchemy::BaseHelper.send :include, Spree::BaseHelper
+Alchemy::BaseController.send :include, Spree::Core::ControllerHelpers::Common
+Alchemy::BaseController.send :include, Spree::Core::ControllerHelpers::Store
 ```
 
-### Authentication system installation
+#### 2. Option: Use [Alchemy Devise](https://github.com/magiclabs/alchemy-devise)
 
-Since Alchemy 3.0 has dropped the authentication from its core, you will need to choose one authentication system. The easiest choice is to use the [alchemy-devise gem](https://github.com/magiclabs/alchemy-devise).
+**Recommended for:**
+  - An existing Alchemy installation
+  - You don't have an authentication system and don't want to role an authentication system on your own.
 
-To install alchemy-devise:
+Add `alchemy-devise` to your `Gemfile`
 
 ```ruby
 # Gemfile
 gem 'alchemy-devise', '~> 2.0'
 ```
 
-And then execute:
+and install it:
 
-```sh
-$ bundle
+```shell
+$ bundle install
+$ bundle exec rails g alchemy:devise:install
+```
+
+Run the Spree installer:
+
+*NOTE*: Skip this if you already have a running Spree installation.
+
+```shell
+$ bundle exec rails g spree:install
 ```
 
-Finally, you'll need to instruct Spree accordingly:
+Then run the spree custom user generator:
+
+```shell
+$ bundle exec rails g spree:custom_user Alchemy::User
+```
+
+Now you'll need to instruct Spree to use the Alchemy User class:
 
 ```ruby
 # config/initializers/spree.rb
+...
 Spree.user_class = "Alchemy::User"
+require 'alchemy/spree/alchemy_user_decorator'
+...
 ```
 
+and tell Spree about Alchemy's path helpers:
+
+```ruby
+# lib/spree/authentication_helpers.rb
+    ...
+    def spree_login_path
+      alchemy.login_path
+    end
+
+    def spree_signup_path
+      alchemy.signup_path
+    end
+
+    def spree_logout_path
+      alchemy.logout_path
+    end
+    ...
+```
+
+#### 3. Option: Build their own authentication
+
+Please follow the [spree custom authentication](https://guides.spreecommerce.com/developer/authentication.html) and the [Alchemy custom authentication](http://guides.alchemy-cms.com/edge/custom_authentication.html) guides in order to integrate your custom user with Spree and Alchemy.
+
+#### In either case
+
+Install the migrations
+
+```shell
+$ bundle exec rake alchemy_spree:install:migrations
+```
+
+Run the installer of Alchemy
+
+```shell
+$ bundle exec rake alchemy:install
+```
+
+and follow the on screen instructions.
+
 ## Usage
 
 ### Create a new Element for Alchemy

data/alchemy_spree.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["tvd@magiclabs.de"]
   gem.description   = %q{A Alchemy CMS and Spree connector}
   gem.summary       = %q{The World's Most Flexible E-Commerce Platform meets The World's Most Flexible Content Management System!}
-  gem.homepage      = "https://github.com/AlchemyCMS/alchemy_spree"
+  gem.homepage      = "https://github.com/magiclabs/alchemy_spree"
   gem.license       = 'BSD New'
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")
@@ -15,6 +15,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Alchemy::Spree::VERSION
 
-  gem.add_dependency('alchemy_cms', ['~> 3.0.0'])
-  gem.add_dependency('spree', ['>= 2.1', '< 2.3'])
+  gem.add_dependency('alchemy_cms', ['>= 3.1.0.rc1', '< 3.2'])
+  gem.add_dependency('spree', ['>= 2.3', '< 3.0'])
 end

data/lib/alchemy/spree/ability.rb

@@ -4,11 +4,10 @@ module Alchemy
       include CanCan::Ability
 
       def initialize(user)
-        if user && user.is_admin?
+        if user && user.alchemy_roles.include?('admin')
           can :index, :alchemy_admin_spree
         end
       end
-
     end
   end
 end

data/{app/models/alchemy/user_decorator.rb → lib/alchemy/spree/alchemy_user_decorator.rb}

@@ -7,5 +7,4 @@ Alchemy::User.class_eval do
       ::Spree::Role.where('1 = 0') # aka. empty relation
     end
   end
-
 end

data/lib/alchemy/spree/engine.rb

@@ -7,11 +7,6 @@ module Alchemy
     class Engine < ::Rails::Engine
       engine_name 'alchemy_spree'
 
-      initializer 'spree.user_class', after: 'alchemy.include_authentication_helpers' do
-        ::Spree.user_class = "Alchemy::User"
-        require File.join(File.dirname(__FILE__), '../../spree/authentication_helpers')
-      end
-
       def self.activate
         Dir.glob(File.join(File.dirname(__FILE__), "../../../app/**/*_decorator*.rb")) do |c|
           Rails.configuration.cache_classes ? require(c) : load(c)

data/lib/alchemy/spree/spree_user_decorator.rb

@@ -0,0 +1,10 @@
+Spree::User.class_eval do
+
+  def alchemy_roles
+    if has_spree_role?(:admin)
+      %w(admin)
+    else
+      []
+    end
+  end
+end

data/lib/alchemy/spree/version.rb

@@ -1,5 +1,5 @@
 module Alchemy
   module Spree
-    VERSION = "0.3.0"
+    VERSION = "1.0.0.beta"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alchemy_spree
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0.beta
 platform: ruby
 authors:
 - Thomas von Deyen
@@ -14,36 +14,42 @@ dependencies:
   name: alchemy_cms
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0.rc1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0.rc1
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: spree
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '2.3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '3.0'
 description: A Alchemy CMS and Spree connector
 email:
 - tvd@magiclabs.de
@@ -64,7 +70,6 @@ files:
 - app/controllers/spree/user_sessions_controller_decorator.rb
 - app/models/alchemy/essence_spree_product.rb
 - app/models/alchemy/essence_spree_taxon.rb
-- app/models/alchemy/user_decorator.rb
 - app/views/alchemy/admin/spree/index.html.erb
 - app/views/alchemy/essences/_essence_spree_product_editor.html.erb
 - app/views/alchemy/essences/_essence_spree_product_view.html.erb
@@ -73,14 +78,14 @@ files:
 - config/initializers/alchemy.rb
 - config/routes.rb
 - db/migrate/20120229160509_create_alchemy_essence_spree_products.rb
-- db/migrate/20131029215548_add_spree_fields_to_custom_user_table.rb
 - db/migrate/20131030140218_create_alchemy_essence_spree_taxons.rb
 - lib/alchemy/spree/ability.rb
 - lib/alchemy/spree/alchemy_language_store.rb
+- lib/alchemy/spree/alchemy_user_decorator.rb
 - lib/alchemy/spree/engine.rb
+- lib/alchemy/spree/spree_user_decorator.rb
 - lib/alchemy/spree/version.rb
 - lib/alchemy_spree.rb
-- lib/spree/authentication_helpers.rb
 - script/rails
 - test/alchemy_spree_test.rb
 - test/dummy/Rakefile
@@ -116,7 +121,7 @@ files:
 - test/dummy/script/rails
 - test/integration/navigation_test.rb
 - test/test_helper.rb
-homepage: https://github.com/AlchemyCMS/alchemy_spree
+homepage: https://github.com/magiclabs/alchemy_spree
 licenses:
 - BSD New
 metadata: {}
@@ -131,9 +136,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.3

data/db/migrate/20131029215548_add_spree_fields_to_custom_user_table.rb

@@ -1,7 +0,0 @@
-class AddSpreeFieldsToCustomUserTable < ActiveRecord::Migration
-  def up
-    add_column "alchemy_users", :spree_api_key, :string, :limit => 48
-    add_column "alchemy_users", :ship_address_id, :integer
-    add_column "alchemy_users", :bill_address_id, :integer
-  end
-end

data/lib/spree/authentication_helpers.rb

@@ -1,29 +0,0 @@
-module Spree
-  module AuthenticationHelpers
-    def self.included(receiver)
-      receiver.send :helper_method, :spree_login_path
-      receiver.send :helper_method, :spree_signup_path
-      receiver.send :helper_method, :spree_logout_path
-      receiver.send :helper_method, :spree_current_user
-    end
-
-    def spree_current_user
-      current_user
-    end
-
-    def spree_login_path
-      alchemy.login_path
-    end
-
-    def spree_signup_path
-      alchemy.signup_path
-    end
-
-    def spree_logout_path
-      alchemy.logout_path
-    end
-  end
-end
-
-ApplicationController.send :include, Spree::AuthenticationHelpers
-Spree::Api::BaseController.send :include, Spree::AuthenticationHelpers