{"id":21820609,"url":"https://github.com/sue445/omniauth-chatwork","last_synced_at":"2025-04-14T02:53:25.911Z","repository":{"id":26803763,"uuid":"109578828","full_name":"sue445/omniauth-chatwork","owner":"sue445","description":"OmniAuth strategy for ChatWork","archived":false,"fork":false,"pushed_at":"2024-12-27T13:31:35.000Z","size":124,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-27T16:56:03.670Z","etag":null,"topics":["chatwork","gem","oauth2","omniauth","omniauth-strategy"],"latest_commit_sha":null,"homepage":"https://sue445.github.io/omniauth-chatwork/","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sue445.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-11-05T12:48:18.000Z","updated_at":"2024-12-27T13:31:38.000Z","dependencies_parsed_at":"2023-12-11T13:48:06.516Z","dependency_job_id":"b6c2e69e-283d-4cad-863a-73f7669f5f15","html_url":"https://github.com/sue445/omniauth-chatwork","commit_stats":{"total_commits":76,"total_committers":3,"mean_commits":"25.333333333333332","dds":"0.21052631578947367","last_synced_commit":"f60e15688a0ec244e797dbe68e99b370720c8a60"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sue445%2Fomniauth-chatwork","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sue445%2Fomniauth-chatwork/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sue445%2Fomniauth-chatwork/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sue445%2Fomniauth-chatwork/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sue445","download_url":"https://codeload.github.com/sue445/omniauth-chatwork/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248602316,"owners_count":21131616,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chatwork","gem","oauth2","omniauth","omniauth-strategy"],"created_at":"2024-11-27T16:37:58.586Z","updated_at":"2025-04-14T02:53:25.890Z","avatar_url":"https://github.com/sue445.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OmniAuth::Chatwork\n\nOmniAuth strategy for ChatWork\n\n[![Gem Version](https://badge.fury.io/rb/omniauth-chatwork.svg)](https://badge.fury.io/rb/omniauth-chatwork)\n[![Build Status](https://github.com/sue445/omniauth-chatwork/workflows/test/badge.svg?branch=master)](https://github.com/sue445/omniauth-chatwork/actions?query=workflow%3Atest)\n[![Maintainability](https://api.codeclimate.com/v1/badges/c28dcf54cef09425c10d/maintainability)](https://codeclimate.com/github/sue445/omniauth-chatwork/maintainability)\n[![Coverage Status](https://coveralls.io/repos/github/sue445/omniauth-chatwork/badge.svg)](https://coveralls.io/github/sue445/omniauth-chatwork)\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'omniauth-chatwork'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install omniauth-chatwork\n\n## Usage\n```ruby\nuse OmniAuth::Builder do\n  provider :chatwork, ENV[\"CLIENT_ID\"], ENV[\"CLIENT_SECRET\"]\n  # or\n  provider :chatwork, ENV[\"CLIENT_ID\"], ENV[\"CLIENT_SECRET\"], scope: [\"users.all:read\", \"rooms.all:read_write\", \"contacts.all:read_write\"]\nend\n```\n\nAnd register `https://YOURSERVER/auth/chatwork/callback` to *Redirect URI*\n\n![redirect_uri](img/redirect_uri.png)\n\n## Configuring\n* `scope` : `String` or `Array`\n  * A list of permissions you want to request from the user\n  * default is `[\"rooms.all:read_write\", \"users.profile.me:read\"]`\n  * see Appendix scope list of http://download.chatwork.com/ChatWork_API_Documentation.pdf (en) or http://developer.chatwork.com/ja/oauth.html#secAppendix (ja)\n\n## Auth Hash\nAn example auth hash available in `request.env['omniauth.auth']`:\n\n```ruby\n{\n  provider: \"chatwork\",\n  uid: 1111111,\n  info: {\n    name: \"sue445\",\n    email: \"sue445@example.com\",\n    description: \"I am cure engineer!\",\n    image: \"https://appdata.chatwork.com/avatar/ico_default_blue.png\",\n    urls: {\n      profile: \"http://github.com/sue445\"\n    }\n  },\n  credentials: {\n    token: \"XXXXXXXXXXXXXXXXXXX\",\n    refresh_token: \"XXXXXXXXXXXXXXXXXXX\",\n    expires_at: 1510504991,\n    expires: true\n  },\n  extra: {\n    raw_info: {\n      account_id: 1111111,\n      room_id: 1111111,\n      name: \"sue445\",\n      chatwork_id: \"\",\n      organization_id: 1111111,\n      organization_name: \"\",\n      department: \"\",\n      title: \"\",\n      url: \"http://github.com/sue445\",\n      introduction: \"I am cure engineer!\",\n      mail: \"\",\n      tel_organization: \"\",\n      tel_extension: \"\",\n      tel_mobile: \"\",\n      skype: \"\",\n      facebook: \"\",\n      twitter: \"\",\n      avatar_image_url: \"https://appdata.chatwork.com/avatar/ico_default_blue.png\",\n      login_mail: \"sue445@example.com\"\n    }\n  }\n}\n```\n\n## Development\n\nAfter 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.\n\nTo 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).\n\n### Run dummy app\nAt first, register `https://127.0.0.1:4567/auth/chatwork/callback` to *Redirect URI*\n\n![redirect_uri](img/redirect_uri.png)\n\n```bash\ncp .env.example .env\nvi .env\n\nbundle exec ruby spec/dummy/app.rb\n```\n\nopen https://127.0.0.1:4567/\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/sue445/omniauth-chatwork.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsue445%2Fomniauth-chatwork","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsue445%2Fomniauth-chatwork","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsue445%2Fomniauth-chatwork/lists"}