Giter Club home page Giter Club logo

omniauth-hubspot's Introduction

Omniauth::Hubspot

This Gem contains the Hubspot strategy for OmniAuth.

Before You Begin

You should have already installed OmniAuth into your app; if not, read the OmniAuth README to get started.

Now sign into the Hubspot Developer Dashboard and create an application. Take note of your API keys.

Using This Strategy

First start by adding this gem to your Gemfile:

gem 'omniauth-hubspot-full'

If you need to use the latest HEAD version, you can do so with:

gem 'omniauth-hubspot-full', github: 'romanos/omniauth-hubspot'

Next, tell OmniAuth about this provider. For a Rails app, your config/initializers/omniauth.rb file should look like this:

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :hubspot, 'API_KEY', 'API_SECRET', scope: 'contacts timeline'
end

Replace 'API_KEY' and 'API_SECRET' with the appropriate values you obtained earlier.

If you are using Devise then it will look like this:

Devise.setup do |config|
  # other stuff...

  config.omniauth :hubspot, ENV['HUBSPOT_APP_ID'], ENV['HUBSPOT_APP_SECRET'], scope: 'contacts timeline'

  # other stuff...
end

Scopes

Hubspot lets you choose from a few different scopes.

Hubspot Information

Querying the access token endpoint as defined here returns a basic hash of user info and allowed scopes.

{
  "token": "CJSP5qf1KhICAQEYs-gDIIGOBii1hQIyGQAf3xBKmlwHjX7OIpuIFEavB2-qYAGQsF4",
  "user": "[email protected]",
  "hub_domain": "demo.hubapi.com",
  "scopes": [
    "contacts",
    "automation",
    "oauth"
  ],
  "hub_id": 62515,
  "app_id": 456,
  "expires_in": 21588,
  "user_id": 123,
  "token_type": "access"
}

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

Special Thanks

In a rush, I borrowed heavily from kmrshntr's Slack Strategy in order to make this work. Thanks!

omniauth-hubspot's People

Contributors

romanos avatar swanson avatar tylerhansen avatar

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.