omniauth-authsch 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6390054019bf6e152495e6a2415c1ef7c4c74e91
+  data.tar.gz: edf64593e18dd1e1654e3e4f6811900ecf64c00a
+SHA512:
+  metadata.gz: 7e3d5ba9b48e38fdbd2ed3f8d475bd36a092880d5cbbb56dc59f46802159bed5151c1a9123505e5966b60480662fbb01da3f8db1f040eeb9e6fea9a4baed7e05
+  data.tar.gz: 4733ae21a3c0ebded4e891bbaae2ae532a57e000942a641961fc79093b713764fd12f847ec41ae950a785d335bd2f96292caac8db2801524a977128260684d74

data/.gitignore

@@ -0,0 +1,5 @@
+# IDE files
+.idea/
+
+# Temporary files
+*.gem

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Metrics/BlockLength:
+  ExcludedMethods: ['describe', 'context']
+Metrics/LineLength:
+  Enabled: false
+Style/FileName:
+  Enabled: false

data/Readme.md

@@ -0,0 +1,91 @@
+# OmniAuth Auth.sch Strategy
+
+Strategy to authenticate with Auth.sch in OmniAuth.
+
+Get your API key at: http://auth.sch.bme.hu
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-authsch'
+```
+
+Then `bundle install`.
+
+## Usage with Devise
+
+First define your application id and secret in `config/initializers/devise.rb`.
+
+Configuration options can be passed as the last parameter here as key/value pairs.
+
+```ruby
+config.omniauth :authsch, ENV['AUTHSCH_CLIENT'], ENV['AUTHSCH_KEY'], scope: ENV['AUTHSCH_SCOPES']
+```
+
+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`
+
+```ruby
+devise :omniauthable, omniauth_providers: [:authsch]
+```
+
+Then make sure your callbacks controller is setup in `app/controllers/users/omniauth_callbacks_controller.rb`
+
+```ruby
+class Users::OmniauthCallbacksController < Devise::OmniauthCallbacksController
+  def authsch
+    # You need to implement the method below in your model (e.g. app/models/user.rb)
+    @user = User.from_omniauth(request.env['omniauth.auth'])
+
+    if @user.persisted?
+      flash[:notice] = I18n.t 'devise.omniauth_callbacks.success', kind: 'Auth.sch'
+      sign_in_and_redirect @user, event: :authentication
+    else
+      redirect_to root_path, alert: @user.errors.full_messages.join('\n')
+    end
+  end
+end
+```
+
+and bind to or create the user in `app/models/user.rb`
+
+```ruby
+def self.from_omniauth(access_token)
+    data = access_token.info
+    user = User.where(email: data['email']).first
+
+    # Uncomment the section below if you want users to be created if they don't exist
+    # unless user
+    #     user = User.create(name: data['name'],
+    #        email: data['email'],
+    #        password: Devise.friendly_token[0,20]
+    #     )
+    # end
+    user
+end
+```
+
+For your views you can login using:
+
+```erb
+<%= link_to "Sign in with Auth.sch", user_authsch_omniauth_authorize_path %>
+```
+
+An overview is available at https://github.com/plataformatec/devise/wiki/OmniAuth:-Overview
+
+## License
+
+Copyright (c) 2017 by Zsolt Kozaroczy
+
+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/lib/omniauth-authsch.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'omniauth/authsch'

data/lib/omniauth/authsch.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'omniauth/strategies/authsch'

data/lib/omniauth/authsch/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OmniAuth
+  module Authsch
+    VERSION = '0.9.0'.freeze
+  end
+end

data/lib/omniauth/strategies/authsch.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'multi_json'
+require 'omniauth/strategies/oauth2'
+
+module OmniAuth
+  module Strategies
+    # Main class for Auth.sch strategy.
+    class Authsch < OmniAuth::Strategies::OAuth2
+      option :name, 'authsch'
+
+      option :client_options,
+             site: 'http://auth.sch.bme.hu',
+             authorize_url: '/site/login',
+             token_url: '/oauth2/token'
+
+      option :authorize_params, grant_type: 'authorization_code'
+
+      def authorize_params
+        super.tap do |params|
+          params[:scope] = request.params['scope'] if request.params['scope']
+        end
+      end
+
+      uid { raw_info['internal_id'].to_s }
+
+      info do
+        {
+          id: raw_info['internal_id'],
+          email: raw_info['mail']
+        }
+      end
+
+      extra do
+        { raw_info: raw_info }
+      end
+
+      def raw_info
+        access_token.options[:parse] = :json
+
+        url = '/api/profile'
+        params = { params: { access_token: access_token.token } }
+        @raw_info ||= MultiJson.decode(access_token.client.request(:get, url, params).body)
+      end
+    end
+  end
+end

data/omniauth-authsch.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
+require File.expand_path(
+  File.join('..', 'lib', 'omniauth', 'authsch', 'version'),
+  __FILE__
+)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'omniauth-authsch'
+  gem.version       = OmniAuth::Authsch::VERSION
+  gem.license       = 'MIT'
+  gem.summary       = 'An Auth.sch strategy for OmniAuth 1.x'
+  gem.description   = 'An Auth.sch strategy for OmniAuth 1.x. This allows you to login to Auth.sch with your ruby app.'
+  gem.authors       = ['Zsolt Kozaroczy']
+  gem.email         = ['kiskoza@sch.bme.hu']
+  gem.homepage      = 'https://github.com/kiskoza/omniauth-authsch'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.require_paths = ['lib']
+
+  gem.required_ruby_version = '>= 2.0'
+
+  gem.add_runtime_dependency 'omniauth-oauth2', '~> 1.4'
+
+  gem.add_development_dependency 'rspec', '~> 3.6'
+  gem.add_development_dependency 'rake', '~> 12.0'
+  gem.add_development_dependency 'rubocop', '~> 0.49'
+end

data/spec/omniauth/startegies/authsch_spec.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'omniauth-authsch'
+
+describe OmniAuth::Strategies::Authsch do
+  let(:request) { double('Request', params: {}, cookies: {}, env: {}) }
+  let(:app) do
+    lambda do
+      [200, {}, ['Hello.']]
+    end
+  end
+
+  subject do
+    OmniAuth::Strategies::Authsch.new(app, 'appid', 'secret', @options || {}).tap do |strategy|
+      allow(strategy).to receive(:request) do
+        request
+      end
+    end
+  end
+
+  before do
+    OmniAuth.config.test_mode = true
+  end
+
+  after do
+    OmniAuth.config.test_mode = false
+  end
+
+  describe '#client_options' do
+    it 'has correct site' do
+      expect(subject.client.site).to eq('http://auth.sch.bme.hu')
+    end
+
+    it 'has correct authorize_url' do
+      expect(subject.client.options[:authorize_url]).to eq('/site/login')
+    end
+
+    it 'has correct token_url' do
+      expect(subject.client.options[:token_url]).to eq('/oauth2/token')
+    end
+  end
+end

data/spec/rubocop_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'spec_helper'
+
+describe 'Rubocop' do
+  it 'should pass with no offenses detected' do
+    expect(`rubocop`).to include('no offenses detected')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require File.join('bundler', 'setup')
+require 'rspec'

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-authsch
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Zsolt Kozaroczy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-03 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.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+description: An Auth.sch strategy for OmniAuth 1.x. This allows you to login to Auth.sch
+  with your ruby app.
+email:
+- kiskoza@sch.bme.hu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Readme.md
+- lib/omniauth-authsch.rb
+- lib/omniauth/authsch.rb
+- lib/omniauth/authsch/version.rb
+- lib/omniauth/strategies/authsch.rb
+- omniauth-authsch.gemspec
+- spec/omniauth/startegies/authsch_spec.rb
+- spec/rubocop_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kiskoza/omniauth-authsch
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: An Auth.sch strategy for OmniAuth 1.x
+test_files: []