omniauth-jinshuju 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 06e0e63bdb6bd2c2655750e6bda8fc63c33db643
+  data.tar.gz: 71f1a2ddc46c6d6263528060a591abb95060675f
+SHA512:
+  metadata.gz: 946a6fe035f261c3345b2a72683851708b50cd84165525caf6291db07c31c0d836f31fe574b353fb4e939e19139cf0c1c9d85b6ed7e281e9da0c29706dec6937
+  data.tar.gz: f97322df303d927debbc883f7d66ccdbbe26c046c2e06bf5f6d5bdf69776b7305eb36a1fabfc7ad1c753ef58f4332d02c4c271f3221769b966f240cdb84e48c4

data/.codeclimate.yml

@@ -0,0 +1,12 @@
+---
+engines:
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - lib/**/*
+  - "**.rb"
+exclude_paths: 
+- spec/**/*

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do 
+  gem 'codeclimate-test-reporter'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Michael Chen and AdMaster Inc.
+
+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,76 @@
+# OmniAuth::Strategies::Jinshuju
+
+OAuth2 Strategy for [Jinshuju](https://jinshuju.net/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+
+```ruby
+gem 'omniauth-jinshuju', git: 'git@github.com:jinshuju/omniauth-jinshuju.git'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+You need `client_id` & `client_secret`.
+
+Here's an example for adding the middleware to a Rails app in config/initializers/omniauth.rb:
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :jinshuju, ENV["JINSHUJU_CLIENT_ID"], ENV["JINSHUJU_CLIENT_SECRET"]
+end
+```
+
+Or If your are using devise add follwing in config/initializers/devise.rb
+```ruby
+config.omniauth :jinshuju, ENV["JINSHUJU_CLIENT_ID"], ENV["JINSHUJU_CLIENT_SECRET"]
+```
+
+Then add the following to 'config/routes.rb' so the callback routes are defined.
+
+```ruby
+devise_for :users, :controllers => { :omniauth_callbacks => "users/omniauth_callbacks" }
+```
+
+Make sure your model is omniauthable. Generally this is "/app/models/user.rb"
+
+## Sample Auth Hash
+```ruby
+{
+  "provider"=>"jinshuju",
+  "uid"=>"123456",
+  "info"=> {
+    "name"=>"xiaojin",
+    "email"=>"user@email.com",
+  },
+  "extra"=> {
+    "raw_info"=> {
+      "type"=>"user",
+      "id"=>"123456",
+      "name"=>"xiaojin",
+      "login"=>"user@email.com"
+    }
+  }
+}
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome. This project is intended to be a safe, welcoming space for collaboration.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes along with test cases (`git commit -am 'Add some feature'`)
+4. If possible squash your commits to one commit if they all belong to same feature.
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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/lib/omniauth-jinshuju.rb

@@ -0,0 +1 @@
+require File.join('omniauth', 'jinshuju')

data/lib/omniauth/jinshuju.rb

@@ -0,0 +1 @@
+require File.join('omniauth', 'strategies', 'jinshuju')

data/lib/omniauth/jinshuju/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Jinshuju
+    VERSION = '0.0.1'
+  end
+end

data/lib/omniauth/strategies/jinshuju.rb

@@ -0,0 +1,45 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class Jinshuju < OmniAuth::Strategies::OAuth2
+
+      option :name, 'jinshuju'
+
+      option :client_options, {
+        site: 'https://api.jinshuju.net',
+        authorize_url: 'https://account.jinshuju.net/oauth/authorize',
+        token_url: 'https://account.jinshuju.net/oauth/token'
+      }
+
+      option :authorize_params, {scope: 'public'}
+      option :token_params, {
+        parse: :json
+      }
+
+      uid do
+        raw_info['id']
+      end
+
+      info do
+        {
+          nickname: raw_info['nickname'],
+          email: raw_info['email']
+        }
+      end
+
+      extra do
+        {
+          :raw_info => raw_info
+        }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('v4/me').parsed
+      end
+
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'jinshuju', 'Jinshuju'

data/omniauth-jinshuju.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth/jinshuju/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'omniauth-jinshuju'
+  spec.version       = OmniAuth::Jinshuju::VERSION
+  spec.authors       = ['Michael Chen']
+  spec.email         = ['michael.chen@admaster.com.cn']
+
+  spec.summary       = %q{Offical Jinshuju OAuth2 strategy for OmniAuth}
+  spec.description   = %q{Offical Jinshuju OAuth2 strategy for OmniAuth}
+  spec.homepage      = 'https://github.com/jinshuju/omniauth-jinshuju'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'omniauth-oauth2', '~> 1.3.1'
+
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+end

data/spec/omniauth/strategies/jinshuju_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+require 'omniauth-jinshuju'
+
+describe OmniAuth::Strategies::Jinshuju do
+  let(:request) { double('Request', :params => {}, :cookies => {}, :env => {}) }
+  let(:app) {
+    lambda do
+      [200, {}, ["Hello."]]
+    end
+  }
+
+  subject do
+    OmniAuth::Strategies::Jinshuju.new(app, 'appid', 'secret', @options || {}).tap do |strategy|
+      allow(strategy).to receive(:request) {
+        request
+      }
+    end
+  end
+
+  before do
+    OmniAuth.config.test_mode = true
+  end
+
+  after do
+    OmniAuth.config.test_mode = false
+  end
+
+  it 'has a version number' do
+    expect(OmniAuth::Jinshuju::VERSION).not_to be nil
+  end
+
+  describe '#client_options' do
+    it 'has correct site' do
+      expect(subject.client.site).to eq('https://api.jinshuju.net')
+    end
+
+    it 'has correct authorize_url' do
+      expect(subject.client.options[:authorize_url]).to eq('https://account.jinshuju.net/oauth/authorize')
+    end
+
+    it 'has correct token_url' do
+      expect(subject.client.options[:token_url]).to eq('https://account.jinshuju.net/oauth/token')
+    end
+  end
+
+  describe '#callback_path' do
+    it 'has the correct callback path' do
+      expect(subject.callback_path).to eq('/auth/jinshuju/callback')
+    end
+  end
+
+  describe '#uid' do
+    before :each do
+      allow(subject).to receive(:raw_info) { { 'id' => 'uid' } }
+    end
+
+    it 'returns the id from raw_info' do
+      expect(subject.uid).to eq('uid')
+    end
+  end
+
+  describe '#info' do
+    before :each do
+      allow(subject).to receive(:raw_info) { {} }
+    end
+
+    context 'has all the necessary fields' do
+      it { expect(subject.info).to have_key :nickname }
+      it { expect(subject.info).to have_key :email }
+    end
+  end
+
+  describe '#extra' do
+    before :each do
+      allow(subject).to receive(:raw_info) { { status: 'active' } }
+    end
+
+    it { expect(subject.extra[:raw_info]).to eq({ status: 'active' }) }
+  end
+
+  describe '#raw_info' do
+    before :each do
+      access_token = double('access token')
+      response = double('response', :parsed => { status: 'active' })
+      expect(access_token).to receive(:get).with('v4/me').and_return(response)
+      allow(subject).to receive(:access_token) { access_token }
+    end
+
+    it 'returns parsed response from access token' do
+      expect(subject.send(:raw_info)).to eq({ status: 'active' })
+    end
+  end
+
+  describe '#access_token' do
+    before :each do
+      response = double('access token',
+        access_token: 'access_token',
+        refresh_token: 'refresh_token',
+        expires_in: 3600,
+        expires_at: 12345,
+      ).as_null_object
+      allow(subject).to receive(:access_token) { response }
+    end
+
+    it { expect(subject.access_token.access_token).to eq('access_token') }
+    it { expect(subject.access_token.expires_in).to eq(3600) }
+    it { expect(subject.access_token.expires_at).to eq(12345) }
+    it { expect(subject.access_token.refresh_token).to eq('refresh_token') }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+require 'omniauth/jinshuju'

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-jinshuju
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Chen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-21 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.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: Offical Jinshuju OAuth2 strategy for OmniAuth
+email:
+- michael.chen@admaster.com.cn
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/omniauth-jinshuju.rb
+- lib/omniauth/jinshuju.rb
+- lib/omniauth/jinshuju/version.rb
+- lib/omniauth/strategies/jinshuju.rb
+- omniauth-jinshuju.gemspec
+- spec/omniauth/strategies/jinshuju_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jinshuju/omniauth-jinshuju
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Offical Jinshuju OAuth2 strategy for OmniAuth
+test_files:
+- spec/omniauth/strategies/jinshuju_spec.rb
+- spec/spec_helper.rb