solidus_social 1.0.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3fe49d36ea644340c59c66b5e8506ab57a466f6c
-  data.tar.gz: d42af370d565407ebdbccbe60d32fbcbef814478
+SHA256:
+  metadata.gz: a86b6cfe4109e24c01c128b99b42a23c5387001a642acbdb4ae78d0efbf5e108
+  data.tar.gz: 116bca0155aa00db87caac0c00a59bbc2139729e2addd378d7159641ba424613
 SHA512:
-  metadata.gz: 836eb284a9553b79eec6a3738a50cb30cb37162dad469fccee63ec153b4b7c888268d8beae8564a47efae281811c0f14f9ebf1f5f72136092eb32655428f4b79
-  data.tar.gz: 9b458f66b04f4ab4be83f0d4c151f5096cce9ff51790a2b9de95bba362e14e602d3fd392ae817491970ca4a6bd6cc55eb4c9eb30e788a615b566632ccd9e11b1
+  metadata.gz: 3d37b9986abcee5ddd8dd82c003f92b5a497ccbe36c619268f20fc390db9375dd88a05a4536942418afc4193e147fd82028b136d4578cd8888157daa4ea5ce7c
+  data.tar.gz: 737587a8380670d75146924a52a3794bf628679e6b1701129b10f88fbace10259920b5654b9108f7ba0859a739f529d2c5249afc5e91941cd6016b7ccfc6708b

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_social/version.rb'
+  message: Bump SolidusSocial to %{version}
+  tag: true

data/.gitignore

@@ -1,18 +1,16 @@
+*.gem
 \#*
 *~
 .#*
 .DS_Store
 .idea
 .project
+.sass-cache
+coverage
+Gemfile.lock
 tmp
 nbproject
+pkg
 *.swp
 spec/dummy
-.rvmrc
-.bundle
-Gemfile.lock
-coverage
-.ruby-version
-.ruby-gemset
-.node-version
-.phantom-version
+spec/examples.txt

data/.rspec

@@ -1,3 +1,3 @@
---colour
--r spec_helper
--f documentation
+--color
+--format documentation
+--require spec_helper

data/.rubocop.yml

@@ -1,8 +1,4 @@
----
-inherit_from: .hound.yml
+require:
+  - solidus_dev_support/rubocop
 
-AllCops:
-  Exclude:
-    - spec/dummy/**/*
-    - bin/*
-    - Guardfile
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,42 @@
+Metrics/LineLength:
+  Enabled: true
+  Max: 160
+
+Rails/FilePath:
+  Enabled: false
+
+RSpec/AnyInstance:
+  Enabled: false
+
+RSpec/ContextWording:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Enabled: false
+
+RSpec/InstanceVariable:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
+Style/NestedParenthesizedCalls:
+  Enabled: false
+
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,35 @@
-## Solidus Social 1.0.0
+## Unreleased
 
-*   Renamed SpreeSocial to SolidusSocial
-*   Relaxed versions to support solidus 1.0+
-*   Port of https://github.com/DynamoMTL/spree_social's solidus branch
+## v1.3.0
+
+- Migrated factories from FactoryGirl to FactoryBot
+- Add support for Solidus 2.4+
+- Reduced compatible versions of `solidus_core` to 2.x
+- Removed the deprecated `icon:` argument from admin buttons
+- Fixed an issue when using Safari to authenticate
+- `Spree::UserRegistrationsController` and `Spree.user_class` are now decorated by
+  prepending modules in the `SolidusSocial::Spree` namespace instead of using `class_eval`
+- Development of the extension is not relying on `solidus_dev_support` and CircleCI
+- Moved the Facebook strategy patch to it's own prepended module
+
+## v1.2.0
+
+- Switched to using the install generator to import the solidus social
+  initializer into apps. **Please run `bin/rails generate solidus_social:install`
+  in order to upgrade.**
+- Removed the `SolidusSocial::OAUTH_PROVIDERS` constant in favour of
+  the `Spree::AuthenticationMethod.providers_options` class
+  method. This is populated using the `Spree::SocialConfig#providers` Hash.
+- Added support for Rails 5.1.
+- Added Italian translations
+
+## v1.1.0
+
+- Added support for Solidus 2/Rails 5
+- Bugfixes
+
+## v1.0.0
+
+- Renamed SpreeSocial to SolidusSocial
+- Relaxed versions to support solidus 1.0+
+- Port of https://github.com/DynamoMTL/spree_social's solidus branch

data/Gemfile

@@ -1,7 +1,30 @@
+# 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.: `gem 'pry-debug'`.
+send :eval_gemfile, 'Gemfile-local' if File.exist? 'Gemfile-local'

data/{LICENSE.md → LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2014 John Dyer and other contributors
+Copyright (c) 2014-2020 John Dyer and other contributors
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,
@@ -9,7 +9,7 @@ are permitted provided that the following conditions are met:
     * 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 Spree nor the names of its contributors may be used to
+    * 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.
 

data/README.md

@@ -1,137 +1,188 @@
-# Solidus Social
+SolidusSocial
+=============
 
-[![Build Status](https://travis-ci.org/solidusio-contrib/solidus_social.svg?branch=master)](https://travis-ci.org/solidusio-contrib/solidus_social)
+[![CircleCI](https://circleci.com/gh/solidusio-contrib/solidus_social.svg?style=svg)](https://circleci.com/gh/solidusio-contrib/solidus_social)
 [![Code Climate](https://codeclimate.com/github/solidusio-contrib/solidus_social/badges/gpa.svg)](https://codeclimate.com/github/solidusio-contrib/solidus_social)
 
-Core for all social media related functionality for Solidus.
-The Solidus Social gem handles authorization, account creation and association through social media sources such as Twitter and Facebook.
-This gem is beta at best and should be treated as such.
-Features and code base will change rapidly as this is under active development.
-Use with caution.
+Social login support for Solidus. Solidus Social handles authorization, account
+creation and association through third-party services. Currently Twitter,
+Facebook, Github, Google OAuth2, and Amazon are available out of the box.
 
----
+Installation
+------------
 
-## Setup for Production
+Add solidus_social to your Gemfile:
 
-Add this extension to your `Gemfile`:
 ```ruby
 gem 'solidus_social'
 ```
 
-Then run:
-```sh
-$ bundle && bundle exec rails g solidus_social:install
-$ bundle exec rake db:migrate
-```
-
-Preference(optional): By default url will be '/users/auth/:provider'. If you wish to modify the url to: '/member/auth/:provider', '/profile/auth/:provider', or '/auth/:provider' then you can do this accordingly in your **config/initializers/spree.rb** file as described below -
+Bundle your dependencies and run the installation generator:
 
-```ruby
-Spree::SocialConfig[:path_prefix] = 'member' # for /member/auth/:provider
-Spree::SocialConfig[:path_prefix] = 'profile' # for /profile/auth/:provider
-Spree::SocialConfig[:path_prefix] = '' # for /auth/:provider
+```shell
+bundle
+bundle exec rails g solidus_social:install
+bundle exec rails db:migrate
 ```
 
----
+This will install a new initializer `config/initializers/solidus_social.rb` into
+your project that allows you to setup the services you want configured for your app.
 
-## Spree Setup to Utilize OAuth Sources
+Optional: By default the login path will be '/users/auth/:provider'. If you
+want something else, configure it in `config/initializers/solidus_social.rb`.
 
-Login as an admin user and navigate to Configuration > Social Authentication Methods
 
-Click on the New Authentication Method button to enter the key obtained from their respective source, (See below for instructions on setting up the various providers).
+Using OAuth Sources
+-------------------
 
-Multiple key entries can now be entered based on the rails environment. This allows for portability and the lack of need to check in your key to your repository. You also have the ability to enable and disable sources. These setting will be reflected on the client UI as well.
+Login as an admin user and navigate to Configuration > Social Authentication Methods
 
-Alternatively you can ship keys as environment variables and create these Authentication Method records on application boot via an initializer. Below is an example for facebook.
-
-```ruby
-# Ensure our environment is bootstrapped with a facebook connect app
-if ActiveRecord::Base.connection.table_exists? 'spree_authentication_methods'
-  Spree::AuthenticationMethod.where(environment: Rails.env, provider: 'facebook').first_or_create do |auth_method|
-    auth_method.api_key = ENV['FACEBOOK_APP_ID']
-    auth_method.api_secret = ENV['FACEBOOK_APP_SECRET']
-    auth_method.active = true
-  end
-end
-```
+Click "New Authentication Method" and choose one of your configured providers.
 
 **You MUST restart your application after configuring or updating an authentication method.**
 
----
-
-## Setup the Applications at the Respective Sources
+Registering Your Application
+----------------------------
 
-OAuth Applications @ Facebook, Twitter and / or Github are supported out of the box but you will need to setup applications are each respective site as follows for public use and for development.
+Facebook, Twitter, Github, Google OAuth2, and Amazon are supported out of the
+box but, you will need to register your application with each of the sites you
+want to use.
 
-> All URLs must be in the form of domain.tld you may add a port as well for development
+When setting up development applications, keep in mind that most services do
+not support `localhost` for your URL/domain. You will need to us a regular
+domain (i.e.  `domain.tld`, `hostname.local`) or an IP addresses (`127.0.0.1`).
+Make sure you specifity the right IP address.
 
 ### Facebook
 
 [Facebook / Developers / Apps][2]
 
-1. Name the app what you will and agree to the terms.
-2. Fill out the capcha
-3. Under the Web Site tab
-4. Site URL: http://your_computer.local:3000 for development / http://your-site.com for production
-5. Site domain: your-computer.local / your-site.com respectively
+1. Name the app and agree to the terms.
+2. Fill out the capcha.
+3. Under the "Web Site" tab enter:
+  - Site URL: `http://yourhostname.local:3000` for development and
+    `http://your-site.com` for production
+  - Site domain: `yourhostname.local` and `your-site.com` respectively
 
 ### Twitter
 
 [Twitter / Application Management / Create an application][3]
 
-1. Name and Description must be filled in with something
-2. Application Website: http://your_computer.local:3000 for development / http://your-site.com for production
-3. Application Type: Browser
-4. Callback URL: http://your_computer.local:3000 for development / http://your-site.com for production
-5. Default Access Type: Read & Write
-6. Save Application
+1. Fill in the name and description.
+2. Fill in the rest of the details:
+  - Application Website: `http://yourhostname.local:3000` for development and
+    `http://your-site.com` for production
+  - Application Type: "Browser"
+  - Callback URL: `http://yourhostname.local:3000` for development and
+    `http://your-site.com` for production
+  - Default Access Type: "Read & Write"
+6. Save the application.
 
 ### Github
 
 [Github / Applications / Register a new OAuth application][4]
 
-1. Name The Application
-2. Main URL: http://your_computer.local:3000 for development / http://your-site.com for production
-3. Callback URL: http://your_computer.local:3000 for development / http://your-site.com for production
-4. Click Create
-
-> This does not seem to be a listed Github item right now. To View and / or edit your applications goto [http://github.com/account/applications](http://github.com/account/applications)
+1. Name the application.
+2. Fill in the details
+  - Main URL: `http://yourhostname.local:3000` for development and
+    `http://your-site.com` for production
+  - Callback URL: `http://yourhostname.local:3000` for development and
+    `http://your-site.com` for production
+4. Click Create.
 
 ### Amazon
 
 [Amazon / App Console / Register a new OAuth application][10]
 
-1. Register New Application
-2. Name the Application, provide description and URL for Privacy Policy
-3. Click Save
-4. Add Your site under Web Settings > Allowed Return URLs (example: http://localhost:3000/users/auth/amazon/callback)
+1. Register New Application.
+2. Name the Application, provide description and URL for Privacy Policy.
+3. Click Save.
+4. Add Your site under Web Settings > Allowed Return URLs (example:
+   `http://localhost:3000/users/auth/amazon/callback`)
 
 > The app console is available at [https://login.amazon.com/manageApps](https://login.amazon.com/manageApps)
 
-### Other OAuth sources that are currently supported
+### Google OAuth2
+[Google / APIs / Credentials/ Create Credential](https://console.developers.google.com/)
+
+1. In the APIs and Services dashboard, visit 'Credentials' on the side, then select 'Create Credentials' and 'Oauth client ID'.
+2. Name the Application, select "Web Application" as a type.
+3. Under "Authorized redirect URIs", add your site (example:
+   `http://localhost:3000/users/auth/google_oauth2/callback`)
+
+> More info: [https://developers.google.com/identity/protocols/OAuth2](https://developers.google.com/identity/protocols/OAuth2)
+
+### Other OAuth Providers
 
-* Google (OAuth)
+Other OAuth providers are supported, given that there is an [OmniAuth
+strategy][12] for them. (If there isn't, you can [write one][13].)
 
-## Adding other OAuth sources
+#### LinkedIn Example
 
-It is easy to add any OAuth source, given there is an OmniAuth strategy gem for it (and if not, you can easily [write one by yourself](https://github.com/intridea/omniauth/wiki/Strategy-Contribution-Guide). For instance, if you want to add authorization via LinkedIn, the steps will be:
+1. Add `gem "omniauth-linkedin"` to your Gemfile and run `bundle install`.
+2. In `config/initializers/solidus_social.rb` add and initialize a new provider
+   for SolidusSocial:
 
-1. Add `gem "omniauth-linkedin"` to your Gemfile, run `bundle install`.
-2. In an initializer file, e.g. `config/initializers/devise.rb`, add and init a new provider for SolidusSocial:
+   ```ruby
 
-        SolidusSocial::OAUTH_PROVIDERS << ['LinkedIn', 'linkedin']
-        SolidusSocial.init_provider('linkedin')
+     config.providers = {
+       # The configuration key has to match your omniauth strategy.
+       linkedin: {
+         api_key: ENV['LINKEDIN_API_KEY'],
+         api_secret: ENV['LINKEDIN_API_SECRET'],
+       },
+       # More providers here
+   ```
+3. Activate your provider as usual.
+4. Do **one** of the following:
 
-3. Activate your provider as usual (via initializer or admin interface).
-4. Override `spree/users/social` view to render OAuth links in preferred way for a new one to be displayed. Or alternatively, include to your CSS a definition for `.icon-spree-linkedin-circled` and an embedded icon font for LinkedIn from [fontello.com](http://fontello.com/) (the way existing icons for Facebook, Twitter, etc are implemented). You can also override CSS classes for other providers, `.icon-spree-<provider>-circled`, to use different font icons or classic background images, without having to override views.
+   - Override the `spree/users/social` view to render OAuth links to display
+     your LinkedIn link.
+   - Include in your CSS a definition for `.icon-spree-linkedin-circled` and an
+     embedded icon font for LinkedIn from [Fontello][14] (the way existing
+     icons for Facebook, Twitter, etc are implemented). You can also override
+     CSS classes for other providers, `.icon-spree-<provider>-circled`, to use
+     different font icons or classic background images, without having to
+     override views.
 
----
+Documentation
+-------------
 
-## Contributing
+API documentation is available [on RubyDoc.info][15].
+
+Contributing
+------------
 
 See corresponding [guidelines][11].
 
----
+Testing
+-------
+
+First bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run specs, and [Rubocop](https://github.com/bbatsov/rubocop) static code analysis. The dummy app can be regenerated by using `rake test_app`.
+
+```shell
+bundle
+bin/rake
+```
+
+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_social/factories'
+```
+
+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
+```
+
+License
+-------
 
 Copyright (c) 2014 [John Dyer][7] and [contributors][8], released under the [New BSD License][9]
 
@@ -143,6 +194,10 @@ Copyright (c) 2014 [John Dyer][7] and [contributors][8], released under the [New
 [6]: https://github.com/solidusio-contrib/solidus_social/issues
 [7]: https://github.com/LBRapid
 [8]: https://github.com/solidusio-contrib/solidus_social/graphs/contributors
-[9]: https://github.com/solidusio-contrib/solidus_social/blob/master/LICENSE.md
+[9]: https://github.com/solidusio-contrib/solidus_social/blob/master/LICENSE
 [10]: https://login.amazon.com/manageApps
 [11]: https://github.com/solidusio-contrib/solidus_social/blob/master/CONTRIBUTING.md
+[12]: https://github.com/intridea/omniauth/wiki/List-of-Strategies
+[13]: https://github.com/intridea/omniauth/wiki/Strategy-Contribution-Guide
+[14]: http://fontello.com/
+[15]: http://www.rubydoc.info/github/solidusio-contrib/solidus_social/