Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/pepabo/omniauth-colormeshop

OmniAuth Strategy for ColorMeShop
https://github.com/pepabo/omniauth-colormeshop

Last synced: about 1 month ago
JSON representation

OmniAuth Strategy for ColorMeShop

Awesome Lists containing this project

README

        

# OmniAuth::ColorMeShop

[![Build Status](https://travis-ci.org/pepabo/omniauth-colormeshop.svg?branch=master)](https://travis-ci.org/pepabo/omniauth-colormeshop)

OmniAuth strategy for [ColorMeShop API](http://shop-pro.jp/?mode=api).

## Usage

With Rails, set your `client_id` and `client_secret` in `config/initializers/omniauth.rb` as below:

```ruby
Rails.application.config.middleware.use OmniAuth::Builder do
provider :colormeshop, ENV['COLORMESHOP_CLIENT_ID'], ENV['COLORMESHOP_CLIENT_SECRET']
end
```

### Scopes

You can set scopes with `scope` option as below:

```ruby
Rails.application.config.middleware.use OmniAuth::Builder do
provider :colormeshop, ENV['COLORMESHOP_CLIENT_ID'], ENV['COLORMESHOP_CLIENT_SECRET'], {
scope: 'read_products write_products read_sales write_sales',
}
end
```

## Installation

Add this line to your application's Gemfile:

gem 'omniauth-colormeshop'

And then execute:

$ bundle

Or install it yourself as:

$ gem install omniauth-colormeshop

## 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