omniauth-magento 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f117f804c4f090da24f4a13c085075bb8c6ac3e
-  data.tar.gz: 679f4e455f8caea92a25c90bcbe66a2f5d497b65
+  metadata.gz: 35ecc46b30899582767672d0d2547d9f99af3653
+  data.tar.gz: dcd44bb8bdd75b1cb0475448fe1bc534a5712d33
 SHA512:
-  metadata.gz: 136cb231a7f1b8ef01572186ce1502add4920d5d194ce74cbb07d1f70edf8dbcfc1477ef2ce0201b7d787d730da106776b8f32336f475e88917b396b4a550bba
-  data.tar.gz: 56317faab80cb7d83d6c36d64d0b59abfc36e5ae52f841979acde09c8949b7709591a000bd1cfd881827edaa3220e14438c51efe0ef8a806fb5e3fc1cd76e675
+  metadata.gz: b9f9fc91ec0b3ce347ade68b46946aff9cf958cadea69c838055332fbbc2ce0a5fb53b5fe062918f0a58a0f12d753dd13f34c4bc42bb033b5b5b478f91d61283
+  data.tar.gz: a1112d61860c8e5a691c08d3fde8c69bac25673099854bcc8e43b8241c1de3306d1d7443496943e98453188057a94424fa54f923880a9c1a347e321f8c4f4398

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-magento.gemspec
+gemspec

data/README.md

@@ -0,0 +1,86 @@
+# Omniauth::Magento
+
+An Omniauth strategy for Magento. Works only with the newer Magento REST api (not SOAP).
+
+## Instructions on how to use with Rails
+
+### Setting up Magento
+
+* [Set up a consumer in Magento](http://www.magentocommerce.com/api/rest/authentication/oauth_configuration.html) and write down consumer key and consumer secret
+* In the Magento Admin backend, go to `System > Web Services > REST Roles`, select `Customer`, and tick `Retrieve` under `Customer`
+* In the Magento Admin backend, go to `System > Web Services > REST Attributes`, select `Customer`, and tick `Email`, `First name` and `Last name` under `Customer` > `Read`.
+
+### Setting up Rails
+
+Parts of these instructions are based on these [OmniAuth instructions](https://github.com/plataformatec/devise/wiki/OmniAuth:-Overview), which you can read in case you get stuck.
+
+* Install [Devise](https://github.com/plataformatec/devise) if you haven't installed it
+* Load this library into your Gemfile: `gem "omniauth-magento", github: "Zookal/omniauth-magento"`
+* Run `bundle install`
+* Modify `config/initializers/devise.rb`:
+
+```
+Devise.setup do |config|
+  # deactivate SSL on development environment
+  OpenSSL::SSL::VERIFY_PEER ||= OpenSSL::SSL::VERIFY_NONE if Rails.env.development? 
+  config.omniauth :magento, ENTER_YOUR_MAGENTO_CONSUMER_KEY, ENTER_YOUR_MAGENTO_CONSUMER_SECRET, { :client_options =>  { :site => ENTER_YOUR_MAGENTO_URL_WITHOUT_TRAILING_SLASH } }
+  # example:
+  # config.omniauth :magento, "12a3", "45e6", { :client_options =>  { :site => "http://localhost/magento" } }  
+```
+
+* Make sure you have the columns `first_name`, `last_name`, `magento_id` and `email` in your `User` table
+* Add this line to your view `<%= link_to "Sign in with Magento", user_omniauth_authorize_path(:magento) %>`
+* Add / replace this line in your `routes.rb` `devise_for :users, :controllers => { :omniauth_callbacks => "users/omniauth_callbacks" }`. This will be called once Magento has successfully authorized and returns to the Rails app.
+* In your folder `controllers`, create a subfolder `users`
+* In that subfolder `app/controllers/users/`, create a file `omniauth_callbacks_controller.rb` with the following code (from Devise wiki linked above):
+
+```
+class Users::OmniauthCallbacksController < Devise::OmniauthCallbacksController
+  def magento
+    # You need to implement the method below in your model (e.g. app/models/user.rb)
+    @user = User.find_for_magento_oauth(request.env["omniauth.auth"], current_user)
+
+    if @user.persisted?
+      sign_in_and_redirect @user, :event => :authentication #this will throw if @user is not activated
+      set_flash_message(:notice, :success, :kind => "magento") if is_navigational_format?
+    else
+      session["devise.magento_data"] = request.env["omniauth.auth"]
+      redirect_to new_user_registration_url
+    end
+  end
+end
+```
+
+* Set up your User model to be omniauthable `:omniauthable, :omniauth_providers => [:magento]` and to contain the `find_for_magento_oauth` method (from Devise wiki linked above)
+
+```
+class User < ActiveRecord::Base  
+  devise :database_authenticatable, :registerable, :recoverable,
+         :rememberable, :trackable, :validatable, :timeoutable,
+         :omniauthable, :omniauth_providers => [:magento]  
+
+  def self.find_for_magento_oauth(auth, signed_in_resource=nil)
+    user = User.find_by(magento_id: auth.uid)
+    unless user
+      user = User.create!(
+        first_name: auth.info.first_name,                           
+        last_name:  auth.info.last_name,
+        magento_id: auth.uid,
+        email:      auth.info.email,
+        password:   Devise.friendly_token[0,20]
+      )
+    end
+    user
+  end         
+end
+```
+
+### Authenticating
+
+* Start your Rails server
+* Start your Magento server
+* Log into Magento with a customer (not admin) account
+* In your Rails app, go to the view where you pasted this line `<%= link_to "Sign in with Magento", user_omniauth_authorize_path(:magento) %>`
+* Click on the link
+* You now should be directed to a Magento view where you are prompted to authorize access to the Magento user account
+* Once you have confirmed, you should get logged into Rails and redirected to the callback URL specified above. The User model should also create a database entry when the user logs in for the first time.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/omniauth/magento.rb

@@ -0,0 +1,2 @@
+require 'omniauth/magento/version'
+require 'omniauth/strategies/magento'

data/lib/omniauth/magento/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Magento
+    VERSION = "0.0.3"
+  end
+end

data/lib/omniauth/strategies/magento.rb

@@ -0,0 +1,33 @@
+require 'omniauth/strategies/oauth'
+require 'multi_json'
+
+module OmniAuth
+  module Strategies
+    class Magento < OmniAuth::Strategies::OAuth
+      option :name, "magento"
+      
+      option :client_options, {
+        :access_token_path  => "/oauth/token",
+        :authorize_path     => "/oauth/authorize",
+        :request_token_path => "/oauth/initiate",
+      }
+      
+      # set uid
+      uid { raw_info.keys.first.to_i }
+
+      # set additional info
+      info do
+        {
+          'first_name' => raw_info.values.first["firstname"],
+          'last_name' => raw_info.values.first["lastname"],
+          'email' => raw_info.values.first["email"]
+        }
+      end
+
+      # get info about current user
+      def raw_info
+        @raw_info ||= MultiJson.decode(access_token.get('/api/rest/customers').body)
+      end    
+    end
+  end
+end

data/omniauth-magento.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth/magento/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'omniauth-magento'
+  spec.version       = Omniauth::Magento::VERSION
+  spec.summary       = 'Omniauth strategy for Magento'
+  spec.homepage      = 'https://github.com/Zookal/omniauth-magento'
+  spec.email         = "michael@zookal.com"
+  spec.authors       = ['Chris Baynes', 'Daniel Mahlow', 'Michael Imstepf']
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_runtime_dependency 'omniauth-oauth', '~> 1.0'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-magento
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Chris Baynes
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-08 00:00:00.000000000 Z
+date: 2013-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,7 +59,15 @@ email: michael@zookal.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/omniauth/magento.rb
+- lib/omniauth/magento/version.rb
+- lib/omniauth/strategies/magento.rb
+- omniauth-magento.gemspec
 homepage: https://github.com/Zookal/omniauth-magento
 licenses:
 - MIT