Code Monkey home page Code Monkey logo

omniauth-clover's Introduction

Omniauth::Clover

Clover OAuth2 Strategy for OmniAuth.

Supports the OAuth 2.0 server-side and client-side flows. For more information: https://www.clover.com/docs/oauth

Installation

Add this line to your application's Gemfile:

gem 'omniauth-clover'

And then execute:

$ bundle

Or install it yourself as:

$ gem install omniauth-clover

Usage

Integrates with Devise authentication:

  1. add to your config/initializers/devise.rb

    config.omniauth :clover, "APP_ID", "APP_SECRET"

client_options: (optional)

  • site: defaults to the production https://www.clover.com
  • authorize_url: defaults to '/oauth/authorize'
  • token_url: defaults to '/oauth/token'

example:

config.omniauth :clover, "APP_ID", "APP_SECRET", :client_options => {:site => 'https://dev.server.com'}
  1. make your user model omniauthable

    devise :omniauthable, :omniauth_providers => [:clover]

  2. once your user model is omniauthable and if your devise_for :user was added to config/routes.rb, you will have the following routes available:

  user_omniauth_authorize_path(provider)
  user_omniauth_callback_path(provider)
  1. create sign in link
  <%= link_to "Sign in with Clover", user_omniauth_authorize_path(:clover) %> 
  1. callback
  class Users::OmniauthCallbacksController < Devise::OmniauthCallbacksController
      def clover
          # @omniauth will have the following json available:
          # 
          # {
          #   "provider"=>"clover", 
          #   "uid" => "", 
          #   "info" => {
          #       "name" => "", "first_name"=> "", "last_name"=>"", "email"=>"", "role"=>"", 
          #       "urls" => {
          #       "Clover"=>"https://..."}
          #   }, 
          #   "credentials" => {"token"=>"", "expires"=>false}, 
          #   "extra" => {"merchant_id"=>"", "employee_id"=>"", "client_id"=>"", "code"=>""}
          # }
          @omniauth = request.env['omniauth.auth'].to_hash

          ...
      end
  end

Please visit: https://github.com/plataformatec/devise/wiki/OmniAuth:-Overview for more information.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

omniauth-clover API Documentation

omniauth-clover's People

Contributors

bigtiger avatar davidy avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

omniauth-clover's Issues

Invalid credentials

I am attempting to authorize and in the callback phase, it says invalid credentials, 401 error. I'm not really sure where the disconnect. The app id is a match. I am able to get to the sandbox location and allow my app to interact with my test merchant. But during the callback I get the error.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.