omniauth-fitcvut-oauth2 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a338c1de42892ba2c19656b8b6dd9df3101fce9d
+  data.tar.gz: 0e6f0b87961d3e445ca0492080a46c57ee49c023
+SHA512:
+  metadata.gz: 99ac933ab83282a1420d53bb4f5ae903aef562ce73a64074f78a4daac44e17d1a6247cb0c60cfa1703ca3e7873d6c8c585c5fe67e1a1d3c971091d09da9241d8
+  data.tar.gz: 359e1c77625baaddabf7d0f89f02a264d3bfb6f99c14edc0675336b62b8980fcd9600f696dbd837ab207732e2eb2890d1de9cc6b4c21cfe1cbac586f4b2d63c1

data/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+gemspec
+
+gem 'omniauth-oauth2', :git => 'git://github.com/intridea/omniauth-oauth2.git'

data/README.md

@@ -0,0 +1,73 @@
+# OmniAuth CTU FIT
+
+This gem contains the ČVUT/CTU FIT OAuth 2.0 strategy for OmniAuth 1.0.
+
+## Installing
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-fitcvut-oauth2', '~> 0.1.0'
+```
+
+Then `bundle install`.
+
+## Basic Usage
+
+    use OmniAuth::Builder do
+    	provider "fitcvut", ENV['FIT_APP_ID'], ENV['FIT_APP_SECRET']
+    end
+
+## Auth Hash
+
+Here's an example *Auth Hash* available in `request.env['omniauth.auth']`:
+```ruby
+{
+  "provider" => "fitcvut",
+  "uid" => "username",
+  "info" => {
+    "name" => "username",
+    "email" => "username@fit.cvut.cz"
+  },
+  "credentials" => {
+    "token" => "0000000-0000-0000-0000-000000000000",
+    "refresh_token": "0000000-0000-0000-0000-000000000000",
+    "expires_at": 1442689203,
+    "expires": true
+  },
+  "extra" => {
+    "raw_info" => {
+      "client_id": "00000000-0000-0000-0000-000000000000",
+      "scope": [],
+      "audience": [],
+      "client_authorities": [
+        "ROLE_CLIENT"
+      ],
+      "expires_in": 7772621,
+      "user_id": "username",
+      "user_email": "username@fit.cvut.cz",
+      "user_authorities": [
+        "ROLE_R",
+        "ROLE_E",
+        "ROLE_L",
+        "ROLE_S",
+        "ROLE_U",
+        "ROLE__",
+        "ROLE_O"
+      ],
+      "client_only": false
+    }
+  }
+}
+```
+
+## License
+
+Copyright (c) 2015 by Dominik Jancik based on
+Copyright (c) 2011 by Lee Martin and SoundCloud 
+
+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/Rakefile

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

data/example/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+gem 'sinatra'
+gem 'omniauth-fitcvut-oauth2', :path => '../'

data/example/config.ru

@@ -0,0 +1,27 @@
+require 'bundler/setup'
+require 'sinatra/base'
+require 'omniauth-fitcvut-oauth2'
+
+class App < Sinatra::Base
+  get '/' do
+    redirect '/auth/fitcvut_oauth2'
+  end
+
+  get '/auth/:provider/callback' do
+    content_type 'application/json'
+    MultiJson.encode(request.env)
+  end
+  
+  get '/auth/failure' do
+    content_type 'application/json'
+    MultiJson.encode(request.env)
+  end
+end
+
+use Rack::Session::Cookie
+
+use OmniAuth::Builder do
+  provider :fitcvut_oauth2, ENV['APP_ID'], ENV['APP_SECRET']
+end
+
+run App.new

data/lib/omniauth-fitcvut-oauth2.rb

@@ -0,0 +1 @@
+require 'omniauth/fitcvut_oauth2'

data/lib/omniauth/fitcvut_oauth2.rb

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

data/lib/omniauth/fitcvut_oauth2/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module FITCVUTOauth2
+    VERSION = "0.1.0"
+  end
+end

data/lib/omniauth/strategies/fitcvut_oauth2.rb

@@ -0,0 +1,39 @@
+require 'omniauth/strategies/oauth2'
+
+module OmniAuth
+  module Strategies
+    class FITCVUTOauth2 < OmniAuth::Strategies::OAuth2
+      DEFAULT_SCOPE = 'non-expiring'
+
+      option :name, "fitcvut_oauth2"
+
+      option :client_options, {
+        :site => 'https://auth.fit.cvut.cz',
+        :authorize_url => '/oauth/oauth/authorize',
+        :token_url => '/oauth/oauth/token'
+      }
+
+      uid{ raw_info['user_id'] }
+
+      info do
+        {
+            :name => raw_info['user_id'],
+            :email => raw_info['user_email']
+        }
+      end
+
+      extra do
+        {
+            'raw_info' => raw_info
+        }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get("/oauth/api/v1/tokeninfo?token=#{access_token.token}").parsed
+        @raw_info
+      end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'fitcvut_oauth2', 'FITCVUTOauth2'

data/omniauth-fitcvut-oauth2.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'omniauth/fitcvut_oauth2/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'omniauth-fitcvut-oauth2'
+  s.version  = OmniAuth::FITCVUTOauth2::VERSION
+  s.authors  = ['Dominik Jančík']
+  s.email    = %w(jancidom@fit.cvut.cz magnet.cz@gmail.com)
+  s.summary  = 'CTU FIT OAuth2 OmniAuth 1.0 strategy'
+  s.homepage = 'https://github.com/MagNetCZ/omniauth-fitcvut-oauth2'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'omniauth-oauth2', '~> 1.3.0'
+
+  s.add_development_dependency 'rspec', '~> 3.3.0'
+  s.add_development_dependency 'rake'
+end

data/spec/omniauth/strategies/fitcvut_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+require 'omniauth-fitcvut-oauth2'
+
+describe OmniAuth::Strategies::FITCVUTOauth2 do
+  let(:request) do
+    double('request',
+            :params => {},
+            :cookies => {},
+            :env => {})
+  end
+
+  subject do
+    OmniAuth::Strategies::FITCVUTOauth2.new(nil, @options || {}).tap do |strategy|
+      strategy.stub(:request => request)
+    end
+  end
+
+  it_should_behave_like 'an oauth2 strategy'
+
+  describe '#client' do
+    it 'should have the correct FITCVUTOauth2 site' do
+      expect(subject.client.site).to eq('https://auth.fit.cvut.cz')
+    end
+
+    it 'should have the correct authorization url' do
+      expect(subject.client.options[:authorize_url]).to eq('/oauth/oauth/authorize')
+    end
+
+    it 'should have the correct token url' do
+      expect(subject.client.options[:token_url]).to eq('/oauth/oauth/token')
+    end
+  end
+
+  describe '#callback_path' do
+    it 'should have the correct callback path' do
+      expect(subject.callback_path).to eq('/auth/fitcvut_oauth2/callback')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+require 'rspec'
+Dir[File.expand_path('../support/**/*', __FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+end

data/spec/support/shared_examples.rb

@@ -0,0 +1,37 @@
+# NOTE it would be useful if this lived in omniauth-oauth2 eventually
+shared_examples 'an oauth2 strategy' do
+  describe '#client' do
+    it 'should be initialized with symbolized client_options' do
+      @options = { :client_options => { 'authorize_url' => 'https://example.com' } }
+      subject.client.options[:authorize_url].should == 'https://example.com'
+    end
+  end
+
+  # describe '#authorize_params' do
+    # it 'should include any authorize params passed in the :authorize_params option' do
+    #   @options = { :authorize_params => { :foo => 'bar', :baz => 'zip' } }
+    #   subject.authorize_params['foo'].should eq('bar')
+    #   subject.authorize_params['baz'].should eq('zip')
+    # end
+
+    # it 'should include top-level options that are marked as :authorize_options' do
+    #   @options = { :authorize_options => [:scope, :foo], :scope => 'bar', :foo => 'baz' }
+    #   subject.authorize_params['scope'].should eq('bar')
+    #   subject.authorize_params['foo'].should eq('baz')
+    # end
+  # end
+
+  describe '#token_params' do
+    it 'should include any authorize params passed in the :authorize_params option' do
+      @options = { :token_params => { :foo => 'bar', :baz => 'zip' } }
+      expect(subject.token_params['foo']).to eq('bar')
+      expect(subject.token_params['baz']).to eq('zip')
+    end
+
+    it 'should include top-level options that are marked as :authorize_options' do
+      @options = { :token_options => [:scope, :foo], :scope => 'bar', :foo => 'baz' }
+      expect(subject.token_params['scope']).to eq('bar')
+      expect(subject.token_params['foo']).to eq('baz')
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-fitcvut-oauth2
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dominik Jančík
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !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'
+description: 
+email:
+- jancidom@fit.cvut.cz
+- magnet.cz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- example/Gemfile
+- example/config.ru
+- lib/omniauth-fitcvut-oauth2.rb
+- lib/omniauth/fitcvut_oauth2.rb
+- lib/omniauth/fitcvut_oauth2/version.rb
+- lib/omniauth/strategies/fitcvut_oauth2.rb
+- omniauth-fitcvut-oauth2.gemspec
+- spec/omniauth/strategies/fitcvut_spec.rb
+- spec/spec_helper.rb
+- spec/support/.keep
+- spec/support/shared_examples.rb
+homepage: https://github.com/MagNetCZ/omniauth-fitcvut-oauth2
+licenses: []
+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.5
+signing_key: 
+specification_version: 4
+summary: CTU FIT OAuth2 OmniAuth 1.0 strategy
+test_files: []