Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/v-kolesnikov/omniauth-amplifr

Omniauth OAuth2 middleware for Amplifr.com
https://github.com/v-kolesnikov/omniauth-amplifr

amplifr oauth2 omniauth

Last synced: 10 days ago
JSON representation

Omniauth OAuth2 middleware for Amplifr.com

Awesome Lists containing this project

README

        

[![Gem Version](https://badge.fury.io/rb/omniauth-amplifr.svg)](https://badge.fury.io/rb/omniauth-amplifr)
[![Build Status](https://travis-ci.org/v-kolesnikov/omniauth-amplifr.svg?branch=master)](https://travis-ci.org/v-kolesnikov/omniauth-amplifr)

# OmniAuth Amplifr

[OmniAuth](https://github.com/omniauth/omniauth) [OAuth2](https://github.com/intridea/omniauth-oauth2) strategy for [Amplifr](https://amplifr.com)

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'omniauth-amplifr'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install omniauth-amplifr

## Usage

### Rails

```ruby
# config/initializers/omniauth.rb

Rails.application.config.middleware.use OmniAuth::Builder do
provider :amplifr,
ENV['AMPLIFR_APP_CLIENT_ID'],
ENV['AMPLIFR_APP_CLIENT_SECRET'],
client_options: {
site: ENV['AMPLIFR_URL']
}
end
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/omniauth-amplifr. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

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