omniauth_uoc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc611eca086f22bcba097b2c09d0ab66687df525
+  data.tar.gz: 35e4491db80795ad7cf0e858ab296942ed654d37
+SHA512:
+  metadata.gz: 48b0b51b585c7ae15b5d5763a7717385aa3c3760af761cd211f56c4d6f4c1f48d134f46cf0e3ffde0c0e261c03646b766c1a5dd3bc59fe3005a0b1ebc993ed19
+  data.tar.gz: 661a33a3619a9acdd57acf7979b72eccb2fc32dff3b35c6df0f6a8357d50baffa4edf14efcc20c46260f4bd1f44b95f2aca1f26b777161b33916c7334eddf98c

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
+.idea

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 rromerogar
+
+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,44 @@
+# omniauth_uoc
+
+The omniauth_uoc library is an OmniAuth provider that supports authentication against UOC REST apis
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'omniauth', '~> 1.0'
+    gem 'omniauth_uoc'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth_uoc
+
+## Usage
+
+You will need to configure OmniAuth to use your uoc authentication.  This is generally done in Rails in the config/initializers/omniauth.rb with:
+
+    Rails.application.config.middleware.use OmniAuth::Builder do
+        provider :uoc, :uoc_server_url=>"https://cv.uoc.edu/"
+    end
+
+## References
+
+ * OmniAuth: https://github.com/intridea/omniauth/
+ * Especially thanks to [Rob Di Marco](https://github.com/robdimarco) and his [omniauth_crowd](https://github.com/robdimarco/omniauth_crowd) project that it was inspiration for me.
+
+## Contributing
+
+1. Fork it ( https://github.com/rromerogar/omniauth_uoc/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
+
+## Copyright
+
+Copyright (c) 2014 Universitat Oberta de Catalunya. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/omniauth/strategies/uoc/configuration.rb

@@ -0,0 +1,35 @@
+require 'rack'
+
+module OmniAuth
+  module Strategies
+    class Uoc
+      class Configuration
+        DEFAULT_SESSION_URL = '%s/webapps/campusGateway/sessions'
+
+        attr_reader :session_url
+
+        def initialize(params)
+          parse_params params
+        end
+
+        private
+        IS_NOT_URL_ERROR_MESSAGE = '%s is not a valid URL'
+
+        def parse_params(options)
+          unless options.include?(:uoc_server_url)
+            raise ArgumentError.new('Either :uoc_server_url MUST be provided')
+          end
+
+          @session_url = options[:uoc_session_url] || DEFAULT_SESSION_URL % options[:uoc_server_url]
+
+          validate_is_url 'session URL', @session_url
+        end
+
+        def validate_is_url(name, possibly_a_url)
+          url = URI.parse(possibly_a_url) rescue nil
+          raise ArgumentError.new(IS_NOT_URL_ERROR_MESSAGE % name) unless url.kind_of?(URI::HTTP)
+        end
+      end
+    end
+  end
+end

data/lib/omniauth/strategies/uoc/uoc_validator.rb

@@ -0,0 +1,77 @@
+require 'multi_xml'
+require 'faraday'
+
+module OmniAuth
+  module Strategies
+    class Uoc
+      class UocValidator
+        DEFAULT_CONTENT_TYPE = 'application/xml'
+        SESSION_REQUEST_BODY = <<-BODY.strip
+<session>
+  <name>%s</name>
+  <password>%s</password>
+</session>
+BODY
+
+        def initialize(configuration, username, password)
+          @configuration, @username, @password = configuration, username, password
+          @session_uri       = URI.parse(@configuration.session_url)
+          MultiXml.parser = :nokogiri
+        end
+
+        def user_info
+          retrieve_user_info!
+        end
+
+        private
+        def retrieve_user_info!
+          response = make_session_request
+          user_info = nil
+          unless response.status.to_i != 201 || response.body.nil? || response.body == ''
+            xml = MultiXml.parse(response.body)
+            if(xml['session']['authenticated'] == 'true')
+              user_info = {
+                  :name => xml['session']['fullname'],
+                  :email => xml['session']['email'],
+                  :nickname =>xml['session']['login'],
+                  :extra => {
+                      :s => xml['session']['id'],
+                      :user_id => xml['session']['userId'],
+                      :user_number => xml['session']['userNumber'],
+                      :lang => xml['session']['lang'],
+                      :locale => xml['session']['locale'],
+                  }
+              }
+            end
+          end
+          if user_info.nil?
+            OmniAuth.logger.send(:warn, "(crowd) [retrieve_user_info!] response code: #{response.status.to_s}")
+            OmniAuth.logger.send(:warn, "(crowd) [retrieve_user_info!] response body: #{response.body}")
+          end
+          user_info
+        end
+
+        def make_session_request
+          conn = Faraday.new(:url => @session_uri.to_s) do |faraday|
+            faraday.request  :url_encoded             # form-encode POST params
+            faraday.response :logger                  # log requests to STDOUT
+            faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+          end
+
+          conn.post do |req|
+            req.headers['Content-Type'] = DEFAULT_CONTENT_TYPE
+            req.body = make_session_request_body(@username, @password)
+          end
+        end
+
+        def make_session_request_body(username,password)
+          request_body = MultiXml.parse(SESSION_REQUEST_BODY)
+          request_body['session']['name'] = username
+          request_body['session']['password'] = password
+          request_body['session'].to_xml :root => :session
+        end
+
+      end
+    end
+  end
+end

data/lib/omniauth/strategies/uoc.rb

@@ -0,0 +1,53 @@
+require 'omniauth'
+module OmniAuth
+  module Strategies
+    class Uoc
+      include OmniAuth::Strategy
+
+      autoload :Configuration, 'omniauth/strategies/uoc/configuration'
+      autoload :UocValidator, 'omniauth/strategies/uoc/uoc_validator'
+
+      def initialize(app, options = {}, &block)
+        options.symbolize_keys!()
+        super(app, {:name=> :uoc}.merge(options), &block)
+        @configuration = OmniAuth::Strategies::Uoc::Configuration.new(options)
+      end
+
+      protected
+
+      def request_phase
+        if env['REQUEST_METHOD'] == 'GET'
+          get_credentials
+        else
+          session['omniauth.uoc'] = {'username' => request['username'], 'password' => request['password']}
+          redirect callback_url
+        end
+      end
+
+      def get_credentials
+        OmniAuth::Form.build(:title => (options[:title] || 'UOC Authentication')) do
+          text_field 'Login', 'username'
+          password_field 'Password', 'password'
+        end.to_response
+      end
+
+      def callback_phase
+        creds = session.delete 'omniauth.uoc'
+        return fail!(:no_credentials) unless creds
+        validator = UocValidator.new(@configuration, creds['username'], creds['password'])
+        @user_info = validator.user_info
+
+        return fail!(:invalid_credentials) if @user_info.nil? || @user_info.empty?
+
+        super
+      end
+
+      def auth_hash
+        OmniAuth::Utils.deep_merge(super, {
+            'uid' => @user_info[:extra][:id],
+            'info' => @user_info
+        })
+      end
+    end
+  end
+end

data/lib/omniauth_uoc/version.rb

@@ -0,0 +1,3 @@
+module OmniauthUoc
+  VERSION = "0.1.0"
+end

data/lib/omniauth_uoc.rb

@@ -0,0 +1 @@
+require 'omniauth/strategies/uoc'

data/omniauth_uoc.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_uoc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'omniauth_uoc'
+  spec.version       = OmniauthUoc::VERSION
+  spec.authors       = ['rromerogar']
+  spec.email         = ['rromerogar@uoc.edu']
+  spec.summary       = %q{ OmniAuth provider that supports authentication against UOC REST apis. }
+  spec.homepage      = 'http://github.com/rromerogar/omniauth_uoc'
+  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_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_dependency 'omniauth', '~> 1.0'
+  spec.add_dependency 'multi_xml', '~> 0.5.5'
+  spec.add_dependency 'faraday', '~> 0.9.0'
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: omniauth_uoc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- rromerogar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-04 00:00:00.000000000 Z
+dependencies:
+- !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: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.5
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: 
+email:
+- rromerogar@uoc.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniauth/strategies/uoc.rb
+- lib/omniauth/strategies/uoc/configuration.rb
+- lib/omniauth/strategies/uoc/uoc_validator.rb
+- lib/omniauth_uoc.rb
+- lib/omniauth_uoc/version.rb
+- omniauth_uoc.gemspec
+homepage: http://github.com/rromerogar/omniauth_uoc
+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.1.11
+signing_key: 
+specification_version: 4
+summary: OmniAuth provider that supports authentication against UOC REST apis.
+test_files: []