Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sue445/omniauth-chatwork
OmniAuth strategy for ChatWork
https://github.com/sue445/omniauth-chatwork
chatwork gem oauth2 omniauth omniauth-strategy
Last synced: 25 days ago
JSON representation
OmniAuth strategy for ChatWork
- Host: GitHub
- URL: https://github.com/sue445/omniauth-chatwork
- Owner: sue445
- License: mit
- Created: 2017-11-05T12:48:18.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-08-02T13:20:40.000Z (5 months ago)
- Last Synced: 2024-11-06T03:45:45.339Z (about 2 months ago)
- Topics: chatwork, gem, oauth2, omniauth, omniauth-strategy
- Language: Ruby
- Homepage: https://sue445.github.io/omniauth-chatwork/
- Size: 120 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# OmniAuth::Chatwork
OmniAuth strategy for ChatWork
[](https://badge.fury.io/rb/omniauth-chatwork)
[](https://github.com/sue445/omniauth-chatwork/actions?query=workflow%3Atest)
[](https://codeclimate.com/github/sue445/omniauth-chatwork/maintainability)
[](https://coveralls.io/github/sue445/omniauth-chatwork)
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'omniauth-chatwork'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install omniauth-chatwork
## Usage
```ruby
use OmniAuth::Builder do
provider :chatwork, ENV["CLIENT_ID"], ENV["CLIENT_SECRET"]
# or
provider :chatwork, ENV["CLIENT_ID"], ENV["CLIENT_SECRET"], scope: ["users.all:read", "rooms.all:read_write", "contacts.all:read_write"]
end
```
And register `https://YOURSERVER/auth/chatwork/callback` to *Redirect URI*
## Configuring
* `scope` : `String` or `Array`
* A list of permissions you want to request from the user
* default is `["rooms.all:read_write", "users.profile.me:read"]`
* see Appendix scope list of http://download.chatwork.com/ChatWork_API_Documentation.pdf (en) or http://developer.chatwork.com/ja/oauth.html#secAppendix (ja)
## Auth Hash
An example auth hash available in `request.env['omniauth.auth']`:
```ruby
{
provider: "chatwork",
uid: 1111111,
info: {
name: "sue445",
email: "[email protected]",
description: "I am cure engineer!",
image: "https://appdata.chatwork.com/avatar/ico_default_blue.png",
urls: {
profile: "http://github.com/sue445"
}
},
credentials: {
token: "XXXXXXXXXXXXXXXXXXX",
refresh_token: "XXXXXXXXXXXXXXXXXXX",
expires_at: 1510504991,
expires: true
},
extra: {
raw_info: {
account_id: 1111111,
room_id: 1111111,
name: "sue445",
chatwork_id: "",
organization_id: 1111111,
organization_name: "",
department: "",
title: "",
url: "http://github.com/sue445",
introduction: "I am cure engineer!",
mail: "",
tel_organization: "",
tel_extension: "",
tel_mobile: "",
skype: "",
facebook: "",
twitter: "",
avatar_image_url: "https://appdata.chatwork.com/avatar/ico_default_blue.png",
login_mail: "[email protected]"
}
}
}
```
## 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).
### Run dummy app
At first, register `https://127.0.0.1:4567/auth/chatwork/callback` to *Redirect URI*
```bash
cp .env.example .env
vi .env
bundle exec ruby spec/dummy/app.rb
```
open https://127.0.0.1:4567/
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/sue445/omniauth-chatwork.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).