omniauth-hubspot's Introduction

OmniAuth Hubspot

Hubspot OAuth2 Strategy for OmniAuth.

Read the Hubspot OAuth docs for more details:

Installing

Add to your Gemfile:

gem 'omniauth-hubspot', '~> 0.1.0', github: 'advocately/omniauth-hubspot'

Then bundle install.

Usage

OmniAuth::Strategies::Hubspot is simply a Rack middleware. Read the OmniAuth docs for detailed instructions: https://github.com/intridea/omniauth.

Here's a quick example, adding the middleware to a Rails app in config/initializers/omniauth.rb:

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :hubspot, ENV['HUBSPOT_KEY'], ENV['HUBSPOT_SECRET']
end

To start the authentication process with Hubspot you simply need to access /auth/hubspot route.

Auth Hash

Here's an example Auth Hash available in request.env['omniauth.auth']:

{
  :provider => 'hubspot',
  :uid => '342324',
  :info => {
    :email => '[email protected]',
    :name => 'Kevin Antoine'
  },
  :credentials => {
    :token => 'dG9rOmNdrWt0ZjtgzzE0MDdfNGM5YVe4MzsmXzFmOGd2MDhiMfJmYTrxOtA=', # OAuth 2.0 access_token, which you may wish to store
    :expires => false
  },
  :extra => {
    :raw_info => {
      :name => 'Kevin Antoine',
      :email => '[email protected]',
      :type => 'admin',
      :id => '342324',
      :app => {
        :id_code => 'abc123', # Company app_id
        :type => 'app',
        :secure => true # Secure mode enabled for this app
  :timezone => "Dublin",
  :name => "ProjectMap"
      },
      :avatar => {
        :image_url => "https://static.hubspotassets.com/avatars/343616/square_128/me.jpg?1454165491"
      }
    }
  }
}

omniauth-hubspot's People

Contributors

Stargazers

Watchers

omniauth-hubspot's Issues

Up to date?

Is this gem up to date?

I'm noticing the payload I'm getting back from omni auth has tokens that expire, and no data about the user

ActionController::RoutingError (No route matches [GET] "/auth/hubspot"):

I feel like the README needs an update

I had trouble hitting the very first route (/auth/hubspot) after following the README.
im working on a rails 7 application.

Comparing the README of a more popular gem, I saw they have a OmniAuth.config.allowed_request_methods = %i[get]

I think thats what helps to get through this initial error:

Started GET "/auth/hubspot" for ::1 at 2022-08-10 07:46:51 -0700
  ActiveRecord::SchemaMigration Pluck (104.4ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" ORDER BY "schema_migrations"."version" ASC

ActionController::RoutingError (No route matches [GET] "/auth/hubspot"):

Recommend Projects