https://github.com/resultadosdigitais/omniauth-rdstation

Omniauth gem for authorizing apps on RD Station's oauth
https://github.com/resultadosdigitais/omniauth-rdstation

Last synced: about 5 hours ago
JSON representation

Omniauth gem for authorizing apps on RD Station's oauth

• Host: GitHub
• URL: https://github.com/resultadosdigitais/omniauth-rdstation
• Owner: ResultadosDigitais
• License: mit
• Created: 2018-06-14T13:09:32.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-01-08T12:48:43.000Z (almost 6 years ago)
• Last Synced: 2024-04-26T15:04:54.384Z (7 months ago)
• Language: Ruby
• Size: 13.7 KB
• Stars: 0
• Watchers: 38
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# OmniAuth RDStation

Implements an OmniAuth strategy for RD Station, based on OAuth2.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'omniauth-rdstation'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install omniauth-rdstation

## Usage

### Rails

```ruby

Rails.application.config.middleware.use OmniAuth::Builder do

  provider :rdstation, 'client-id', 'client-secret', provider_ignores_state: true

end

```

### Sinatra

```ruby

use OmniAuth::Builder do

  provider :rdstation, 'client-id', 'client-secret', provider_ignores_state: true

end

```

Note: `provider_ignores_state = true` is required because the RD Station API does not implement the state parameter validation yet. When this validation be implemented, the `provider_ignores_state` will become optional.

When the authentication succeeds, this data will be returned:

```json

{

  "provider": "rdstation",

  "uid": null,

  "info": {

  },

  "credentials": {

    "token": "my-jwt-access-token",

    "refresh_token": "my-refresh-token",

    "expires_at": 1529011030,

    "expires": true

  },

  "extra": {

  }

}

```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ResultadosDigitais/omniauth-rdstation.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).