omniauth-chatwork 0.1.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b283578d6148059a0bf0d23632db6ec3adfbb1d1
+  data.tar.gz: 655378c2a5ba57312af63d63db237d23057b774c
+SHA512:
+  metadata.gz: 4c1570a1f2339e71fcf37be3a5395e6dbce826deb757d3390ccaec88a09a69d73ae36d36c5fe65446bf944ef982011d0c13f677b7913defae35712a269152877
+  data.tar.gz: b1bcab061bd52c4c8887cffa1820b5eebfd4ad93b5c4008c664f9ba5c59eae269a0cd73758a7c03cf2e9071f47443d51495af3f2f2a448ad3b1ac7bf69d6577d

data/.env.example

@@ -0,0 +1,6 @@
+CLIENT_ID=
+CLIENT_SECRET=
+
+# verbose logging for faraday
+# ref. https://github.com/intridea/oauth2/blob/v1.4.0/lib/oauth2/client.rb#L95
+# OAUTH_DEBUG=true

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock
+.env

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in omniauth-chatwork.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 sue445
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,108 @@
+# OmniAuth::Chatwork
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/omniauth/chatwork`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## 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
+```
+
+## Configuring
+* `scope` : `String` or `Array`
+  * A list of permissions you want to request from the user
+  * default is `["rooms.all:read_write"]`
+  * 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: "sue445@example.com",
+    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: "sue445@example.com"
+    }
+  }
+}
+```
+
+## 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
+```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).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "omniauth/chatwork"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/omniauth-chatwork.rb

@@ -0,0 +1 @@
+require "omniauth/chatwork"

data/lib/omniauth/chatwork.rb

@@ -0,0 +1,8 @@
+require "omniauth/chatwork/version"
+require "omniauth/strategies/chatwork"
+
+module OmniAuth
+  module Chatwork
+    # Your code goes here...
+  end
+end

data/lib/omniauth/chatwork/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Chatwork
+    VERSION = "0.1.0.beta1"
+  end
+end

data/lib/omniauth/strategies/chatwork.rb

@@ -0,0 +1,70 @@
+require "omniauth/strategies/oauth2"
+require "faraday"
+
+module OmniAuth
+  module Strategies
+    class Chatwork < ::OmniAuth::Strategies::OAuth2
+      DEFAULT_SCOPE = "rooms.all:read_write"
+
+      option :client_options, {
+        site:          "https://api.chatwork.com/v2",
+        authorize_url: "https://www.chatwork.com/packages/oauth2/login.php",
+        token_url:     "https://oauth.chatwork.com/token",
+        auth_scheme:   :basic_auth,
+      }
+
+      uid { raw_info["account_id"] }
+
+      info do
+        # via. https://github.com/omniauth/omniauth/wiki/Auth-Hash-Schema
+        {
+          "name" => raw_info["name"],
+          "email" => raw_info["login_mail"],
+          "description" => raw_info["introduction"],
+          "image" => raw_info["avatar_image_url"],
+          "urls" => {
+            "profile" => raw_info["url"],
+          },
+        }
+      end
+
+      extra do
+        hash = {}
+        hash["raw_info"] = raw_info unless skip_info?
+        hash
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get("me").parsed || {}
+      end
+
+      # You can pass +scope+ params to the auth request, if you need to set them dynamically.
+      # You can also set these options in the OmniAuth config :authorize_params option.
+      #
+      # For example: /auth/chatwork?scope=rooms.all:read_write
+      def authorize_params
+        super.tap do |params|
+          %w[scope].each do |v|
+            if request.params[v]
+              params[v.to_sym] = request.params[v]
+            end
+          end
+
+          params[:scope] ||= DEFAULT_SCOPE
+          params[:scope] = Array(params[:scope]).join(" ")
+        end
+      end
+
+      def build_access_token
+        verifier = request.params["code"]
+        client.auth_code.get_token(verifier, {:redirect_uri => access_token_callback_url}.merge(token_params.to_hash(:symbolize_keys => true)), deep_symbolize(options.auth_token_params))
+      end
+
+      def access_token_callback_url
+        # Remove query string from OmniAuth::Strategy#callback_url
+        # https://github.com/omniauth/omniauth/blob/v1.7.1/lib/omniauth/strategy.rb#L438-L440
+        options[:callback_url] || (full_host + script_name + callback_path)
+      end
+    end
+  end
+end

data/omniauth-chatwork.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "omniauth/chatwork/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-chatwork"
+  spec.version       = OmniAuth::Chatwork::VERSION
+  spec.authors       = ["sue445"]
+  spec.email         = ["sue445@sue445.net"]
+
+  spec.summary       = %q{OmniAuth strategy for ChatWork}
+  spec.description   = %q{OmniAuth strategy for ChatWork}
+  spec.homepage      = "https://github.com/sue445/omniauth-chatwork"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "omniauth-oauth2"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "faraday_curl"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "sinatra"
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-chatwork
+version: !ruby/object:Gem::Version
+  version: 0.1.0.beta1
+platform: ruby
+authors:
+- sue445
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_curl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: OmniAuth strategy for ChatWork
+email:
+- sue445@sue445.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/omniauth-chatwork.rb
+- lib/omniauth/chatwork.rb
+- lib/omniauth/chatwork/version.rb
+- lib/omniauth/strategies/chatwork.rb
+- omniauth-chatwork.gemspec
+homepage: https://github.com/sue445/omniauth-chatwork
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: OmniAuth strategy for ChatWork
+test_files: []