omniauth-msunet 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a21a6b4d182d5f9129a14cef0496abed047b0108
+  data.tar.gz: de5580ca752046186002776b60efc97defaa5934
+SHA512:
+  metadata.gz: 5b0461aa0b26b2ae14afdc6d19e273a09f97514853c2297164258f985d53a65b7b1af6e7c4a7bd867d282c4709da345bfeaaa7b8e09d20471ce1e662fa3a54c3
+  data.tar.gz: d59b7537dec540d090b75d070c71f046730ee34672de23b1e0d6e4bcce031e7fd515335248a632c3e9e7848150ec4ca52e618f57301f874be96b7f3065295e9d

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+/pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+### 1.0.0
+
+Bug fixes
+
+None
+
+Enhancements
+
+None
+

data/Gemfile

@@ -0,0 +1,12 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-msunet.gemspec
+gemspec
+
+group :development, :test do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+  gem 'rb-fsevent'
+  gem 'growl'
+end

data/LICENSE.md

@@ -0,0 +1,7 @@
+COPYRIGHT © 2013
+MICHIGAN STATE UNIVERSTIY BOARD OF TRUSTEES
+ALL RIGHTS RESERVED
+
+PERMISSION IS GRANTED TO USE, COPY AND REDISTRIBUTE THIS SOFTWARE FOR NONCOMMERCIAL EDUCATION AND RESEARCH PURPOSES, SO LONG AS NO FEE IS CHARGED, AND SO LONG AS THE COPYRIGHT NOTICE ABOVE, THIS GRANT OF PERMISSION, AND THE DISCLAIMER BELOW APPEAR IN ALL COPIES MADE; AND SO LONG AS THE NAME OF MICHIGAN STATE UNIVERSITY IS NOT USED IN ANY ADVERTISING OR PUBLICITY PERTAINING TO THE USE OR DISTRIBUTION OF THIS SOFTWARE WITHOUT SPECIFIC, WRITTEN PRIOR AUTHORIZATION.  PERMISSION TO MODIFY OR OTHERWISE CREATE DERIVATIVE WORKS OF THIS SOFTWARE IS NOT GRANTED.
+
+THIS SOFTWARE IS PROVIDED AS IS, WITHOUT REPRESENTATION AS TO ITS FITNESS FOR ANY PURPOSE, AND WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE MICHIGAN STATE UNIVERSITY BOARD OF TRUSTEES SHALL NOT BE LIABLE FOR ANY DAMAGES, INCLUDING SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, WITH RESPECT TO ANY CLAIM ARISING OUT OF OR IN CONNECTION WITH THE USE OF THE SOFTWARE, EVEN IF IT HAS BEEN OR IS HEREAFTER ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

data/README.md

@@ -0,0 +1,52 @@
+# OmniAuth MSUnet
+
+This is the official OmniAuth strategy gem for authenticating to [Michigan State University](http://www.msu.edu) MSUnet using OAuth2. To use this gem you'll need the following:
+
+* Contact MSU IT Services at 517-432-6200 to request to register your application.
+* Provide IT Services with a callback URL, which is where to send successful MSUnet authentication requests back to your application.  Note: this must be a HTTPS address.
+* Receive a `client_id` token and `client_secret` token specific for your application.
+
+## Installation
+
+To install this gem you need to add it to your Gemfile as follows:
+```gem 'omniauth-msunet', :git => 'https://gitlab.msu.edu/tm/omniauth-msunet.git'```
+
+## Basic Usage
+
+If this is your applications first OmniAuth strategy then you will need to create the file config/initializers/omniauth.rb, otherwise update your existing one.
+
+```
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :msunet, "replace_with_client_id", "replace_with_client_secret"
+end
+```
+
+Next you need to setup some routes to handle the callback and if it's a success or failure.  You could use something like the following in your config/routes.rb file
+
+```
+match 'auth/:provider/callback', to: 'sessions#create'
+match 'auth/failure', to: redirect('/')
+match 'signout', to: 'sessions#destroy', as: 'signout'
+```
+
+Finally restart your server for all of the changes to take effect.  You can now browse to your apps URL `https://0.0.0.0/auth/msunet` to login.
+
+Once the login is completed you should receive the following hash that you can access:
+
+```
+{
+"provider":"msunet",
+"uid":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+"info":{
+  "name":"John Sparty",
+  "email":"sparty@msu.edu",
+  "first_name":"John",
+  "last_name":"Sparty",
+  "description":"MSUNet OAuth2 Auth-n"
+  }
+}
+```
+
+## License
+
+Please see the LICENSE.md file.

data/lib/omniauth-msunet.rb

@@ -0,0 +1,3 @@
+require 'omniauth-oauth2'
+require 'omniauth-msunet/version'
+require 'omniauth/strategies/msunet'

data/lib/omniauth-msunet/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module MSUnet
+    VERSION = "0.5.0"
+  end
+end

data/lib/omniauth/strategies/msunet.rb

@@ -0,0 +1,40 @@
+require 'omniauth-oauth2'
+require 'multi_json'
+
+module OmniAuth
+  module Strategies
+    class MSUnet < OmniAuth::Strategies::OAuth2
+      option :client_options, {
+        site: "https://oauth.dev.ais.msu.edu",
+        authorize_path: "/oauth/authorize",
+        authorize_url: "/oauth/authorize",
+        token_url: "/oauth/token"
+      }
+
+      uid do
+        raw_info['uid'].to_s
+      end
+
+      info do
+        {
+          name: raw_info['info']['name'].to_s || raw_info['name'].to_s,
+          first_name: raw_info['info']['first_name'].to_s || raw_info['first_name'].to_s,
+          last_name: raw_info['info']['last_name'].to_s || raw_info['last_name'].to_s,
+          email: raw_info['info']['email'].to_s || raw_info['email'].to_s,
+          netid: raw_info['info']['email'].to_s || raw_info['email'].to_s
+        }
+      end
+
+      extra do
+        { :raw_info => raw_info }
+      end
+
+      def raw_info
+        @raw_info ||= MultiJson.load(access_token.get("/oauth/me?access_token=#{access_token.token}").body)
+      end
+
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'msunet', 'MSUnet'

data/omniauth-msunet.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/omniauth-msunet/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Troy Murray"]
+  gem.email         = ["tm@msu.edu"]
+  gem.summary       = %q{Michigan State University MSUnet OmniAuth strategy.}
+  gem.description   = %q{Official OmniAuth strategy for authenticating against the Michigan State University MSUnet OAuth2 provider.}
+  gem.homepage      = "https://gitlab.msu.edu/msu-middleware-group/omniauth-msunet"
+  gem.license       = 'MSU'
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "omniauth-msunet"
+  gem.require_paths = ["lib"]
+  gem.version       = OmniAuth::MSUnet::VERSION
+
+  gem.add_dependency 'omniauth', '~> 1.1'
+  gem.add_dependency 'omniauth-oauth2', '~> 1.1'
+  gem.add_dependency 'multi_json', '~> 1.7'
+  gem.add_development_dependency 'rspec', '~> 2.7'
+  gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'webmock'
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-msunet
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Troy Murray
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !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: Official OmniAuth strategy for authenticating against the Michigan State
+  University MSUnet OAuth2 provider.
+email:
+- tm@msu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE.md
+- README.md
+- lib/omniauth-msunet.rb
+- lib/omniauth-msunet/version.rb
+- lib/omniauth/strategies/msunet.rb
+- omniauth-msunet.gemspec
+homepage: https://gitlab.msu.edu/msu-middleware-group/omniauth-msunet
+licenses:
+- MSU
+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.0.6
+signing_key: 
+specification_version: 4
+summary: Michigan State University MSUnet OmniAuth strategy.
+test_files: []