omniauth_qiita 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a9fe22365dce488b67e41fcefef6074e058b1714
+  data.tar.gz: 008c6db49fcb24351600cec3f04aa98bf3989a6d
+SHA512:
+  metadata.gz: 0b7e3accddaf1f6bdae743af8d3019354055ad9f2c138a30f9b0a192dfc876547cb1c9d5f2552d3d710a63d9c2a80b4f04ff41227616bcdf862a867c3290ebdf
+  data.tar.gz: 68a982385428c80e61bfb9aa9d20dd8fd84a735e07459da68db5ca1b370558ee7949e710fe875eeede57ce89bab728e992d004c72c6ef80e0679ed11542c5367

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/tags

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby
+  - rbx-2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omniauth_qiita.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Takuya Miyamoto
+
+MIT License
+
+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,99 @@
+# OmniAuth Qiita  [![Build Status](https://secure.travis-ci.org/tmiyamon/omniauth_qiita.png?branch=master)](https://travis-ci.org/tmiyamon/omniauth_qiita)
+
+**These notes are based on master, please see tags for README pertaining to specific releases.**
+
+Qiita OAuth2 Strategy for OmniAuth.
+
+Supports the OAuth 2.0 server-side and client-side flows. Read the Qiita docs for more details: https://qiita.com/api/v2/docs
+
+## Installing
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth_qiita'
+```
+
+Then `bundle install`.
+
+## Usage
+
+`OmniAuth::Strategies::Qiita` is simply a Rack middleware. Read the OmniAuth docs for detailed instructions: https://github.com/intridea/omniauth.
+
+Here's a quick example, adding the middleware to a Rails app in `config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :qiita, ENV['QIITA_CLIENT_ID'], ENV['QIITA_CLIENT_SECRET']
+end
+```
+
+## Configuring
+
+You can configure scope option, which you pass in to the `provider` method via a `Hash`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :qiita, ENV['QIITA_CLIENT_ID'], ENV['QIITA_CLIENT_SECRET'],
+    :scope => 'read_qiita read_qiita_team write_qiita write_qiita_team'
+end
+```
+
+## Auth Hash
+
+Here's an example *Auth Hash* available in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  :provider => "qiita",
+  :uid => "tmiyamon",
+  :info => {
+    :nickname => "tmiyamon",
+    :name => "",
+    :location => "",
+    :image => "https://....",
+    :description => "",
+    :urls => {
+      :Facebook => "https://www.facebook.com/...",
+      :Github => "https://github.com/tmiyamon",
+      :Twitter => "https://twitter.com/..."
+    }
+  },
+  :credentials => {
+    :token => "abc...",
+    :expires => false
+  },
+  :extra => {
+    :raw_info => {
+      :description => "",
+      :facebook_id => "...",
+      :followers_count => 5,
+      :followees_count => 0,
+      :github_login_name => "tmiyamon",
+      :id => "tmiyamon",
+      :items_count => 3,
+      :linkedin_id => "",
+      :location => "",
+      :name => "",
+      :organization => "",
+      :profile_image_url => "https://...",
+      :twitter_screen_name => "...",
+      :website_url => ""
+    }
+  }
+}
+```
+
+The precise information available may depend on the permissions which you request.
+
+## Contributing
+
+1. Fork it ( https://github.com/tmiyamon/omniauth_qiita/fork )
+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 a new Pull Request
+
+## License
+
+This software is released under the MIT License, see LICENSE.txt.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new
+
+desc 'Default: run specs.'
+task :default => :spec

data/lib/omniauth/strategies/qiita.rb

@@ -0,0 +1,104 @@
+require 'omniauth/strategies/oauth2'
+require 'multi_json'
+
+module OmniAuth
+  module Strategies
+    class Qiita < OmniAuth::Strategies::OAuth2
+      option :name, "qiita"
+
+      DEFAULT_SCOPE = 'read_qiita'
+
+      option :client_options, {
+        :site => "https://qiita.com",
+        :authorize_url => "https://qiita.com/api/v2/oauth/authorize",
+        :token_url => '/api/v2/access_tokens'
+      }
+
+      option :token_params, {
+        parse: :json
+      }
+
+      option :authorize_options, [:scope]
+
+      uid { raw_info['id'] }
+
+      info do
+        {
+          'nickname'    => raw_info['id'],
+          'name'        => raw_info['name'],
+          'location'    => raw_info['location'],
+          'image'       => raw_info['profile_image_url'],
+          'description' => raw_info['description'],
+          'urls'        => urls(raw_info)
+        }
+      end
+
+      extra do
+        { 'raw_info' => raw_info }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('/api/v2/authenticated_user').parsed || {}
+      end
+
+      def urls(raw_info)
+        hash = {}
+
+        [
+          ['Facebook', 'facebook_id',         ->(id){"https://www.facebook.com/#{id}"}],
+          ['Github',   'github_login_name',   ->(id){"https://github.com/#{id}"}],
+          ['LinkedIn', 'linkedin_id',         ->(id){"https://www.linkedin.com/in/#{id}"}],
+          ['Twitter',  'twitter_screen_name', ->(id){"https://twitter.com/#{id}"}],
+          ['Website',  'website_url',         ->(url){url}]
+        ].each do |label, key, url_gen|
+          if raw_info.key? key and raw_info[key] and raw_info[key].length > 0
+            hash[label] = url_gen.call(raw_info[key])
+          end
+        end
+
+        hash
+      end
+
+      def authorize_params
+        super.tap do |params|
+          set_scope params
+        end
+      end
+
+      def set_scope params
+        params[:scope] ||= request.params['scope'] || DEFAULT_SCOPE
+      end
+
+      def build_params_for_access_token
+        {
+          code:          request.params['code'],
+          client_id:     options.client_id,
+          client_secret: options.client_secret
+        }
+      end
+
+      def build_request_option_for_access_token
+        {
+          headers: { 'Content-Type' => 'application/json' },
+          body:    MultiJson.dump(build_params_for_access_token),
+        }.merge(options['token_params'])
+      end
+
+      def request_access_token
+        client.request(:post, client.token_url, build_request_option_for_access_token).tap do |res|
+          res.parsed['access_token'] = res.parsed.delete('token')
+        end
+      end
+
+      def handle_access_token_response response
+        error = Error.new(response)
+        fail(error) if client.options[:raise_errors] && !(response.parsed.is_a?(Hash) && response.parsed['access_token'])
+        ::OAuth2::AccessToken.from_hash(client, response.parsed.merge(deep_symbolize(options.auth_token_params)))
+      end
+
+      def build_access_token
+        handle_access_token_response(request_access_token)
+      end
+    end
+  end
+end

data/lib/omniauth_qiita.rb

@@ -0,0 +1,2 @@
+require "omniauth_qiita/version"
+require 'omniauth/strategies/qiita'

data/lib/omniauth_qiita/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Qiita
+    VERSION = "0.1.0"
+  end
+end

data/omniauth_qiita.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth_qiita/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth_qiita"
+  spec.version       = Omniauth::Qiita::VERSION
+  spec.authors       = ["Takuya Miyamoto"]
+  spec.email         = ["miyamototakuya@gmail.com"]
+  spec.summary       = 'Qiita Oauth2 Strategy for OmniAuth'
+  spec.homepage      = "https://github.com/tmiyamon/omniauth_qiita"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'omniauth-oauth2', '~> 1.2'
+  spec.add_runtime_dependency 'multi_json', '~> 1.10'
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'webmock'
+end

data/spec/omniauth/strategies/qiita_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::Qiita do
+  let(:request) { double('Request', :params => {}, :cookies => {}, :env => {}) }
+
+  subject do
+    args = ['qiita', 'appid', 'secret', @options || {}].compact
+    OmniAuth::Strategies::Qiita.new(*args).tap do |strategy|
+      allow(strategy).to receive(:request) { request }
+    end
+  end
+
+  describe 'client options' do
+    it 'should have correct name' do
+      expect(subject.options.name).to eq('qiita')
+    end
+
+    it 'should have correct site' do
+      expect(subject.options.client_options.site).to eq('https://qiita.com')
+    end
+
+    it 'should have correct authorize url' do
+      expect(subject.options.client_options.authorize_url).to eq('https://qiita.com/api/v2/oauth/authorize')
+    end
+
+    it 'should have correct token url' do
+      expect(subject.options.client_options.token_url).to eq('/api/v2/access_tokens')
+    end
+  end
+
+  describe '#set_scope' do
+    it 'does nothing if a scope option is passed' do
+      params = { scope: 'a b c' }
+      subject.set_scope(params)
+
+      expect(params[:scope]).to eq 'a b c'
+    end
+
+    it 'sets read_qiita as default scope to scope in params' do
+      params = {}
+      subject.set_scope(params)
+
+      expect(params[:scope]).to eq 'read_qiita'
+    end
+  end
+
+  describe '#build_params_for_access_token' do
+    it "returns obtained code, client id and client secret" do
+      expect(subject.request).to receive(:params).and_return({ 'code' => '12345' })
+      expect(subject.build_params_for_access_token).to eq({ code: '12345', client_id: 'appid', client_secret: 'secret' })
+    end
+  end
+
+  describe '#build_request_option_for_access_token' do
+    it "returns request options for json request and response" do
+      params = { code: '12345', client_id: 'appid', client_secret: 'secret' }
+      response_option = { parse: :json }
+
+      expect(subject).to receive(:build_params_for_access_token).and_return(params)
+      expect(subject).to receive(:options).and_return({ 'token_params' => response_option })
+
+      expect(subject.build_request_option_for_access_token).to eq( {
+          headers: { 'Content-Type' => 'application/json' },
+          body:   MultiJson.dump(params)
+        }.merge(response_option)
+      )
+    end
+  end
+
+  describe '#urls' do
+    it "returns facebook url if facebook_id is in raw_info" do
+      expect(subject.urls({ 'facebook_id' => 'test'})).to eq({'Facebook' => 'https://www.facebook.com/test'})
+    end
+    it "returns github url if github_login_name is in raw_info" do
+      expect(subject.urls({ 'github_login_name' => 'test'})).to eq({'Github' => 'https://github.com/test'})
+    end
+    it "returns linkedin url if linkedin_id is in raw_info" do
+      expect(subject.urls({ 'linkedin_id' => 'test'})).to eq({'LinkedIn' => 'https://www.linkedin.com/in/test'})
+    end
+    it "returns twitter url if twitter_screen_name is in raw_info" do
+      expect(subject.urls({ 'twitter_screen_name' => 'test'})).to eq({'Twitter' => 'https://twitter.com/test'})
+    end
+    it "returns website url if website_url is in raw_info" do
+      expect(subject.urls({ 'website_url' => 'http://test.com'})).to eq({'Website' => 'http://test.com'})
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'simplecov'
+SimpleCov.start
+require 'rspec'
+require 'rack/test'
+require 'webmock/rspec'
+require 'omniauth'
+require 'omniauth_qiita'
+
+RSpec.configure do |config|
+  config.include WebMock::API
+  config.include Rack::Test::Methods
+  config.extend  OmniAuth::Test::StrategyMacros, :type => :strategy
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: omniauth_qiita
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takuya Miyamoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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: simplecov
+  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: webmock
+  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: 
+email:
+- miyamototakuya@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniauth/strategies/qiita.rb
+- lib/omniauth_qiita.rb
+- lib/omniauth_qiita/version.rb
+- omniauth_qiita.gemspec
+- spec/omniauth/strategies/qiita_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tmiyamon/omniauth_qiita
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Qiita Oauth2 Strategy for OmniAuth
+test_files:
+- spec/omniauth/strategies/qiita_spec.rb
+- spec/spec_helper.rb
+has_rdoc: