0.0
Low commit activity in last 3 years
No release in over a year
An OmniAuth strategy for join.me
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 5.0
~> 2.0
~> 13.0

Runtime

 Project Readme

OmniAuth join.me Strategy

A join.me OAuth2 strategy for OmniAuth.

For more details, read the join.me documentation.

Installation

Add this line to your application's Gemfile:

gem "omniauth-joinme"

And then execute:

$ bundle

Or install it yourself as:

$ gem install omniauth-joinme

Usage

Register your application with join.me to receive an API key: https://developer.join.me/member/register

This is an example that you might put into a Rails initializer at config/initializers/omniauth.rb:

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :joinme, ENV["JOINME_CLIENT_ID"], ENV["JOINME_SECRET"]
end

You can now access the OmniAuth join.me OAuth2 URL: /auth/joinme.

Granting Additional Permissions to Your Application

With the join.me API, you have the ability to specify which permissions you want users to grant your application. For more details, read the join.me documentation.

By default, omniauth-joinme requests the following permissions:

"user_info"

You can configure the scope option:

provider :joinme, ENV["JOINME_CLIENT_ID"], ENV["JOINME_SECRET"], scope: "user_info start_meeting"

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

License

The gem is available as open source under the terms of the MIT License.