solidus_social 1.0.0 → 1.4.0

data/lib/solidus_social.rb

@@ -1,10 +1,26 @@
-require 'spree_core'
+# frozen_string_literal: true
+
+require 'solidus_core'
+require 'solidus_support'
 require 'solidus_auth_devise'
-require 'omniauth-twitter'
-require 'omniauth-facebook'
-require 'omniauth-github'
-require 'omniauth-google-oauth2'
-require 'omniauth-amazon'
-require 'solidus_social/engine'
+
 require 'solidus_social/version'
-require 'coffee_script'
+require 'solidus_social/engine'
+
+module SolidusSocial
+  def self.configured_providers
+    ::Spree::SocialConfig.providers.keys.map(&:to_s)
+  end
+
+  def self.init_providers
+    ::Spree::SocialConfig.providers.each do |provider, credentials|
+      setup_key_for(provider, credentials[:api_key], credentials[:api_secret])
+    end
+  end
+
+  def self.setup_key_for(provider, key, secret)
+    Devise.setup do |config|
+      config.omniauth provider, key, secret, setup: true
+    end
+  end
+end

data/lib/solidus_social/engine.rb

@@ -1,69 +1,43 @@
-module SolidusSocial
-  OAUTH_PROVIDERS = [
-    %w(Facebook facebook),
-    %w(Twitter twitter),
-    %w(Github github),
-    %w(Google google_oauth2),
-    %w(Amazon amazon)
-  ]
+# frozen_string_literal: true
+
+require 'omniauth-twitter'
+require 'omniauth-facebook'
+require 'omniauth-github'
+require 'omniauth-google-oauth2'
+require 'omniauth-amazon'
+require 'deface'
+require 'coffee_script'
+require 'spree/core'
+require 'solidus_social/facebook_omniauth_strategy_ext'
 
+module SolidusSocial
   class Engine < Rails::Engine
-    engine_name 'solidus_social'
+    include SolidusSupport::EngineExtensions
 
-    config.autoload_paths += %W(#{config.root}/lib)
+    isolate_namespace ::Spree
 
-    initializer 'solidus_social.environment', before: 'spree.environment' do
-      Spree::SocialConfig = Spree::SocialConfiguration.new
-    end
+    engine_name 'solidus_social'
 
-    def self.activate
-      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
-        Rails.configuration.cache_classes ? require(c) : load(c)
-      end
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
     end
 
-    config.to_prepare(&method(:activate).to_proc)
-  end
+    USER_DECORATOR_PATH = root.join(
+      "app/decorators/models/solidus_social/spree/user_decorator.rb"
+    ).to_s
 
-  # Setup all OAuth providers
-  def self.init_provider(provider)
-    return unless ActiveRecord::Base.connection.table_exists?('spree_authentication_methods')
-    key, secret = nil
-    Spree::AuthenticationMethod.where(environment: ::Rails.env).each do |auth_method|
-      next unless auth_method.provider == provider
-      key = auth_method.api_key
-      secret = auth_method.api_secret
-      Rails.logger.info("[Spree Social] Loading #{auth_method.provider.capitalize} as authentication source")
+    initializer 'solidus_social.environment', before: 'spree.environment' do
+      ::Spree::SocialConfig = ::Spree::SocialConfiguration.new
     end
-    setup_key_for(provider.to_sym, key, secret)
-  end
 
-  def self.setup_key_for(provider, key, secret)
-    Devise.setup do |config|
-      config.omniauth provider, key, secret, setup: true
-    end
-  end
-end
-
-module OmniAuth
-  module Strategies
-    class Facebook < OAuth2
-      MOBILE_USER_AGENTS =  'palm|blackberry|nokia|phone|midp|mobi|symbian|chtml|ericsson|minimo|' \
-                            'audiovox|motorola|samsung|telit|upg1|windows ce|ucweb|astel|plucker|' \
-                            'x320|x240|j2me|sgh|portable|sprint|docomo|kddi|softbank|android|mmp|' \
-                            'pdxgw|netfront|xiino|vodafone|portalmmm|sagem|mot-|sie-|ipod|up\\.b|' \
-                            'webos|amoi|novarra|cdm|alcatel|pocket|ipad|iphone|mobileexplorer|' \
-                            'mobile'
-      def request_phase
-        options[:scope] ||= 'email'
-        options[:info_fields] ||= 'email'
-        options[:display] = mobile_request? ? 'touch' : 'page'
-        super
-      end
+    initializer 'solidus_social.decorate_spree_user' do |app|
+      next unless app.respond_to?(:reloader)
 
-      def mobile_request?
-        ua = Rack::Request.new(@env).user_agent.to_s
-        ua.downcase =~ Regexp.new(MOBILE_USER_AGENTS)
+      app.reloader.after_class_unload do
+        # Reload and decorate the spree user class immediately after it is
+        # unloaded so that it is available to devise when loading routes
+        load USER_DECORATOR_PATH
       end
     end
   end

data/lib/solidus_social/facebook_omniauth_strategy_ext.rb

@@ -0,0 +1,25 @@
+module SolidusSocial
+  # Patch the Facebook strategy discriminating between mobile and desktop.
+  module FacebookOmniauthStrategyExt
+    MOBILE_USER_AGENTS =  'palm|blackberry|nokia|phone|midp|mobi|symbian|chtml|ericsson|minimo|' \
+                          'audiovox|motorola|samsung|telit|upg1|windows ce|ucweb|astel|plucker|' \
+                          'x320|x240|j2me|sgh|portable|sprint|docomo|kddi|softbank|android|mmp|' \
+                          'pdxgw|netfront|xiino|vodafone|portalmmm|sagem|mot-|sie-|ipod|up\\.b|' \
+                          'webos|amoi|novarra|cdm|alcatel|pocket|ipad|iphone|mobileexplorer|' \
+                          'mobile'
+
+    def request_phase
+      options[:scope] ||= 'email'
+      options[:info_fields] ||= 'email'
+      options[:display] = mobile_request? ? 'touch' : 'page'
+      super
+    end
+
+    def mobile_request?
+      ua = Rack::Request.new(@env).user_agent.to_s
+      ua.downcase =~ Regexp.new(MOBILE_USER_AGENTS)
+    end
+
+    OmniAuth::Strategies::Facebook.prepend self
+  end
+end

data/lib/solidus_social/factories.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+end

data/lib/solidus_social/version.rb

@@ -1,18 +1,5 @@
-module SolidusSocial
-  module_function
-
-  # Returns the version of the currently loaded SolidusSocial as a
-  # <tt>Gem::Version</tt>.
-  def version
-    Gem::Version.new VERSION::STRING
-  end
+# frozen_string_literal: true
 
-  module VERSION
-    MAJOR = 1
-    MINOR = 0
-    TINY  = 0
-    PRE   = nil
-
-    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
-  end
+module SolidusSocial
+  VERSION = '1.4.0'
 end

data/solidus_social.gemspec

@@ -1,47 +1,44 @@
-lib = File.expand_path('../lib/', __FILE__)
-$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
-
-require 'solidus_social/version'
-
-Gem::Specification.new do |s|
-  s.platform    = Gem::Platform::RUBY
-  s.name        = 'solidus_social'
-  s.version     = SolidusSocial.version
-  s.summary     = 'Adds social network login services (OAuth) to Spree'
-  s.description = s.summary
-  s.required_ruby_version = '>= 1.9.3'
-
-  s.author   = 'John Dyer'
-  s.email    = 'jdyer@spreecommerce.com'
-  s.homepage = 'http://www.spreecommerce.com'
-  s.license  = 'BSD-3'
-
-  s.files        = `git ls-files`.split("\n")
-  s.test_files   = `git ls-files -- spec/*`.split("\n")
-  s.require_path = 'lib'
-  s.requirements << 'none'
-
-  s.add_runtime_dependency 'solidus_core', ["~> 1.0"]
-  s.add_runtime_dependency 'omniauth'
-  s.add_runtime_dependency 'oa-core'
-  s.add_runtime_dependency 'omniauth-twitter'
-  s.add_runtime_dependency 'omniauth-facebook'
-  s.add_runtime_dependency 'omniauth-github'
-  s.add_runtime_dependency 'omniauth-google-oauth2'
-  s.add_runtime_dependency 'omniauth-amazon'
-
-  s.add_development_dependency 'capybara', '~> 2.4.1'
-  s.add_development_dependency 'database_cleaner', '1.3.0'
-  s.add_development_dependency 'rspec-rails', '~> 3.1.0'
-  s.add_development_dependency 'factory_girl', '~> 4.4'
-  s.add_development_dependency 'pry-rails'
-  s.add_development_dependency 'selenium-webdriver', '>= 2.41.0'
-  s.add_development_dependency 'poltergeist', '~> 1.5.0'
-  s.add_development_dependency 'simplecov', '~> 0.9.0'
-  s.add_development_dependency 'sqlite3', '~> 1.3.10'
-  s.add_development_dependency 'coffee-rails'
-  s.add_development_dependency 'sass-rails'
-  s.add_development_dependency 'guard-rspec'
-  s.add_development_dependency 'rubocop', '>= 0.24.1'
-  s.add_development_dependency 'rake', '< 11'
+# frozen_string_literal: true
+
+require_relative 'lib/solidus_social/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'solidus_social'
+  spec.version = SolidusSocial::VERSION
+  spec.authors = ['John Dyer']
+  spec.email = 'jdyer@spreecommerce.com'
+
+  spec.summary = 'Adds social network login services (OAuth) to Solidus'
+  spec.homepage = 'https://github.com/solidusio-contrib/solidus_social#readme'
+  spec.license = 'BSD-3-Clause'
+
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/solidusio-contrib/solidus_social'
+  spec.metadata['changelog_uri'] = 'https://github.com/solidusio-contrib/solidus_social/blob/master/CHANGELOG.md'
+
+  spec.required_ruby_version = '>= 2.4'
+
+  # 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 'deface'
+  spec.add_dependency 'oa-core'
+  spec.add_dependency 'omniauth'
+  spec.add_dependency 'omniauth-amazon'
+  spec.add_dependency 'omniauth-facebook'
+  spec.add_dependency 'omniauth-github'
+  spec.add_dependency 'omniauth-google-oauth2'
+  spec.add_dependency 'omniauth-twitter'
+  spec.add_dependency 'solidus_auth_devise'
+  spec.add_dependency 'solidus_core', ['>= 2.0.0', '< 4']
+  spec.add_dependency 'solidus_support', '~> 0.5'
+
+  spec.add_development_dependency 'solidus_dev_support'
 end

data/spec/controllers/spree/omniauth_callbacks_controller_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe Spree::OmniauthCallbacksController, type: :controller do
   let(:user) { create(:user) }
   let(:omni_params) { double('omni', :[] => nil).as_null_object }
@@ -45,18 +47,19 @@ RSpec.describe Spree::OmniauthCallbacksController, type: :controller do
     end
   end
 
-  context '#callback' do
+  describe '#callback' do
     context 'when user is authenticated' do
       before do
         allow(controller).to receive(:spree_current_user).and_return(user)
       end
 
-      it_should_behave_like 'denied_permissions'
+      it_behaves_like 'denied_permissions'
 
       context 'when existing user_authentication' do
         let(:user_authentication) { double('user_authentication', user: user) }
+
         before do
-          allow(Spree::UserAuthentication).to receive(:find_by_provider_and_uid).and_return(user_authentication)
+          allow(Spree::UserAuthentication).to receive(:find_by).and_return(user_authentication)
         end
 
         it 'does not need to create the user_authentication' do
@@ -77,7 +80,7 @@ RSpec.describe Spree::OmniauthCallbacksController, type: :controller do
 
       context 'when no existing user_authentication' do
         before do
-          allow(Spree::UserAuthentication).to receive(:find_by_provider_and_uid).and_return(nil)
+          allow(Spree::UserAuthentication).to receive(:find_by).and_return(nil)
         end
 
         it 'creates a new user_authentication' do
@@ -96,7 +99,7 @@ RSpec.describe Spree::OmniauthCallbacksController, type: :controller do
           controller.twitter
         end
 
-        it_should_behave_like 'associate_order'
+        it_behaves_like 'associate_order'
       end
     end
 
@@ -105,12 +108,13 @@ RSpec.describe Spree::OmniauthCallbacksController, type: :controller do
         allow(controller).to receive(:spree_current_user).and_return(nil)
       end
 
-      it_should_behave_like 'denied_permissions'
+      it_behaves_like 'denied_permissions'
 
       context 'when existing user_authentication' do
         let(:user_authentication) { double('user_authentication', user: user) }
+
         before do
-          allow(Spree::UserAuthentication).to receive(:find_by_provider_and_uid).and_return(user_authentication)
+          allow(Spree::UserAuthentication).to receive(:find_by).and_return(user_authentication)
         end
 
         it 'does not need to create the user_authentication' do
@@ -131,8 +135,9 @@ RSpec.describe Spree::OmniauthCallbacksController, type: :controller do
 
       context 'when no existing user_authentication' do
         let(:user) { Spree::User.new }
+
         before do
-          allow(Spree::UserAuthentication).to receive(:find_by_provider_and_uid).and_return(nil)
+          allow(Spree::UserAuthentication).to receive(:find_by).and_return(nil)
           allow(controller).to receive(:auth_hash).and_return('provider' => 'facebook', 'info' => { 'email' => 'spree@gmail.com' }, 'uid' => '123')
         end
 
@@ -141,13 +146,41 @@ RSpec.describe Spree::OmniauthCallbacksController, type: :controller do
             expect(controller).to receive(:sign_in_and_redirect)
             expect { controller.twitter }.to change(Spree::User, :count).by(1)
           end
+
+          context 'when `Spree.user_class` has changed' do
+            before do
+              @previous_user_class = Spree.user_class.to_s
+              Spree.user_class = Spree::LegacyUser.to_s
+
+              # the application was initialized with Spree::User, so some
+              # some methods do not exist on LegacyUser. In practice, this will
+              # not happen as Spree.user_class will not change on the fly like
+              # this.
+              # this statement simply stubs the required missing method
+              allow_any_instance_of(Spree::LegacyUser)
+                .to receive(:apply_omniauth)
+            end
+
+            after do
+              # in order to not affect other tests, restore the original class
+              Spree.user_class = @previous_user_class
+            end
+
+            it 'creates a new user' do
+              expect(Spree::User).not_to receive :new
+              expect_any_instance_of(Spree::User).not_to receive :save
+
+              expect { controller.twitter }
+                .to change(Spree::LegacyUser, :count).by(1)
+            end
+          end
         end
 
         context 'email belongs to existing user' do
           before { @user = create(:user, email: 'spree@gmail.com') }
 
           it 'does not create new user' do
-            expect { controller.twitter }.to_not change(Spree::User, :count)
+            expect { controller.twitter }.not_to change(Spree::User, :count)
           end
 
           it 'assigns authentication to existing user' do

data/spec/features/spree/admin/authentication_methods_configuration_spec.rb

@@ -1,77 +1,71 @@
-RSpec.feature 'Admin Authentication Methods', :js do
+# frozen_string_literal: true
+
+RSpec.describe 'Admin Authentication Methods', :js do
   stub_authorization!
 
   context 'elements' do
-    scenario 'has configuration tab' do
+    it 'has configuration tab' do
       visit spree.admin_path
       click_link 'Settings'
-      expect(page).to have_text 'SOCIAL AUTHENTICATION METHODS'
+      expect(page).to have_text(/Social Authentication Methods/i)
     end
   end
 
   context 'when no auth methods exists' do
-    background do
+    before do
       visit spree.admin_path
       click_link 'Settings'
       click_link 'Social Authentication Methods'
     end
 
-    scenario 'can create new' do
-      expect(page).to have_text 'NO AUTHENTICATION METHODS FOUND, ADD ONE!'
+    it 'can create new' do
+      expect(page).to have_text /NO AUTHENTICATION METHODS FOUND, ADD ONE!/i
 
       click_link 'New Authentication Method'
-      expect(page).to have_text 'BACK TO AUTHENTICATION METHODS LIST'
-      select 'Test', from: 'authentication_method[environment]'
+      expect(page).to have_text /BACK TO AUTHENTICATION METHODS LIST/i
+      select2 'Test', from: 'Environment'
       select2 'Github', from: 'Social Provider'
-      fill_in 'API Key', with: 'KEY123'
-      fill_in 'API Secret', with: 'SEC123'
 
       click_button 'Create'
       expect(page).to have_text 'successfully created!'
     end
-
-    scenario 'does not save with empty fields' do
-      click_link 'New Authentication Method'
-      click_button 'Create'
-      expect(page).to have_text 'errors prohibited this record from being saved'
-    end
   end
 
   context 'when auth method exists' do
-    given!(:authentication_method) do
+    let!(:authentication_method) do
       Spree::AuthenticationMethod.create!(
         provider: 'facebook',
         api_key: 'fake',
         api_secret: 'fake',
         environment: Rails.env,
-        active: true)
+        active: true
+      )
     end
 
-    background do
+    before do
       visit spree.admin_path
       click_link 'Settings'
       click_link 'Social Authentication Methods'
     end
 
-    scenario 'can be updated' do
+    it 'can be updated' do
       within_row(1) do
         click_icon :edit
       end
 
-      fill_in 'API Key', with: 'fake'
-      fill_in 'API Secret', with: 'fake'
+      find('#authentication_method_active_false').click
 
       click_button 'Update'
       expect(page).to have_text 'successfully updated!'
     end
 
-    scenario 'can be deleted' do
-      within_row(1) do
-        click_icon :trash
+    it 'can be deleted' do
+      accept_confirm do
+        within_row(1) do
+          click_icon :trash
+        end
       end
 
-      page.driver.browser.switch_to.alert.accept unless Capybara.javascript_driver == :poltergeist
-
       expect(page).to have_text 'successfully removed!'
       expect(page).not_to have_text authentication_method.provider
     end