omniauth-ibmisam 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7fec4a33325b6d2e600298c4d70aa2237ad0dd2d
+  data.tar.gz: e68e6589fd88293a3c85ddaad08e7a3d2982ed70
+SHA512:
+  metadata.gz: e2b66bc377d50b61c8a5ba7ee5948709a37584f2f6d270ac1fccc75acc6c709f8fc2b9f6deab2c9253b9f9cda1c68ee895ab3212e3a20bb2a709fd205355e42b
+  data.tar.gz: a4b093bb6d2ed88bf42c4244092dc266e25f4208e767c9cdd07a691a0cdc547cc0e9f7c95db80909c1100e8bbcba0a54d790d344d84f7c8e009b232cfda9ec3d

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.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/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    omniauth-ibmisam (0.0.1)
+      omniauth (~> 1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (9.0.6)
+    diff-lcs (1.2.5)
+    hashie (3.4.6)
+    omniauth (1.3.1)
+      hashie (>= 1.2, < 4)
+      rack (>= 1.0, < 3)
+    rack (2.0.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  omniauth-ibmisam!
+  rack-test (~> 0.6)
+  rspec (~> 3.5)
+
+BUNDLED WITH
+   1.13.6

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 IFAD
+
+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,47 @@
+# OmniAuth IBM-ISAM Strategy 
+
+This is a OmniAuth 1.0 compatible strategy.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'omniauth-ibmisam'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-ibmisam
+    
+## Usage
+
+Use like any other OmniAuth strategy:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :ibmisam, name: 'ibmisam', header_type: 'identity'
+end
+```
+
+### Configuration Options
+
+#### Optional
+
+Non required options:
+
+  * `name` - Defaults to `'ibmisam'`. This becomes part of the authentication request path: `/auth/[name]`.
+  * `header_type` - Defaults to `'identity'`. Can be `'eai'` or `'identity'`. 
+    * `'eai'`: a header named `'am-eai-user-id'` is expected to contain the user id (user's email). 
+    * `'identity'` (default): a header named `'iv-user'` is expected to contain the user id (user's email). 
+  
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/lib/omniauth/ibmisam.rb

@@ -0,0 +1,2 @@
+require 'omniauth/ibmisam/version'
+require 'omniauth/strategies/ibmisam'

data/lib/omniauth/ibmisam/version.rb

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

data/lib/omniauth/strategies/ibmisam.rb

@@ -0,0 +1,47 @@
+require 'omniauth'
+
+module OmniAuth
+  module Strategies
+    class Ibmisam
+      include OmniAuth::Strategy
+
+      option :header_type, 'identity'
+      option :name, 'ibmisam'
+
+      LOGOUT_PATH = '/pkmslogout'
+
+      HEADER_NAMES = { identity: 'iv-user', eai: 'am-eai-user-id' }
+
+      def request_phase
+        if uid
+          redirect callback_path
+        else
+          [401, {}, ["Unauthorized (Missing external authentication)"]]
+        end
+      end
+
+      uid do
+        HEADER_NAMES.keys.include?(header_type) ? request.env[rack_header] : nil
+      end
+
+      class ConfigurationError < StandardError; end
+
+      def self.validate_options(options)
+        if options.has_key?(:header_type) && !HEADER_NAMES.keys.include?(options[:header_type].to_sym)
+          raise(ConfigurationError, "Invalid option: #{options[:header_type]} for IBMISAM header_type. Use one of: #{HEADER_NAMES.keys.join(', ')}")
+        end
+      end
+
+      private
+        def header_type
+          options.header_type.to_sym
+        end
+
+        def rack_header
+          header = HEADER_NAMES[header_type]
+          @rack_header ||= "HTTP_#{header.gsub('-','_')}".upcase
+        end
+
+    end
+  end
+end

data/omniauth-ibmisam.gemspec

@@ -0,0 +1,25 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'omniauth/ibmisam/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "omniauth-ibmisam"
+  gem.version       = OmniAuth::Ibmisam::VERSION
+  gem.date          = %q{2017-01-16}
+  gem.authors       = ["Thimios Dimopulos"]
+  gem.email         = ["e.dimopoulos@ifad.org"]
+  gem.summary       = %q{IBM ISAM Strategy for OmniAuth}
+  gem.description   = "An omniauth strategy to be used with IBM ISAM."
+  gem.homepage      = "https://github.com/ifad/omniauth-ibmisam"
+  gem.licenses      = ['MIT']
+
+  gem.require_paths = ["lib"]
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  gem.add_dependency 'omniauth', '~> 1.3'
+
+  gem.add_development_dependency "rspec", "~> 3.5"
+  gem.add_development_dependency "rack-test", '~> 0.6'
+  gem.add_development_dependency "byebug", '~> 9.0'
+end

data/spec/omniauth/strategies/ibmisam_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::Ibmisam, type: :strategy do
+  include Rack::Test::Methods
+
+  let(:name) { "ibmisam" }
+
+  let(:request_path) { "/auth/" + name }
+
+  let(:callback_path) { "/auth/" + name + "/callback" }
+
+  let(:app) do
+    strategy_name = name
+    Rack::Builder.new do |b|
+      b.use OmniAuth::Test::PhonySession
+      b.use OmniAuth::Strategies::Ibmisam, name: strategy_name, header_type: :identity
+      b.run lambda { |env|
+        [200, {'Content-Type' => 'text/plain'}, [env.key?('omniauth.auth').to_s]]
+      }
+    end.to_app
+  end
+
+  let(:unauthorized_message) { "Unauthorized (Missing external authentication)" }
+
+  describe '#request_phase' do
+    subject { last_response }
+
+    context 'without a header' do
+      before { get request_path }
+
+      it 'does not authenticate' do
+        expect(last_response.body).to eq unauthorized_message
+      end
+    end
+
+    context 'with a header that has no value' do
+      before do
+        header('iv-user', nil)
+        get request_path
+      end
+
+      it 'responds with failure' do
+        expect(last_response.status).to eq 401
+      end
+
+      it 'includes unauthorized message' do
+        expect(last_response.body).to eq unauthorized_message
+      end
+    end
+
+    context 'with a header that has a value' do
+      before do
+        header('iv-user', 'test@example.com')
+        get request_path
+      end
+
+      it 'redirects' do
+        expect(last_response.status).to eq 302
+      end
+
+      it 'redirects to the callback' do
+        expect(last_response.location).to eq callback_path
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'bundler/setup'
+require 'rack/test'
+require 'omniauth/ibmisam'

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-ibmisam
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Thimios Dimopulos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+description: An omniauth strategy to be used with IBM ISAM.
+email:
+- e.dimopoulos@ifad.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- lib/omniauth/ibmisam.rb
+- lib/omniauth/ibmisam/version.rb
+- lib/omniauth/strategies/ibmisam.rb
+- omniauth-ibmisam.gemspec
+- spec/omniauth/strategies/ibmisam_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ifad/omniauth-ibmisam
+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.5.1
+signing_key: 
+specification_version: 4
+summary: IBM ISAM Strategy for OmniAuth
+test_files:
+- spec/omniauth/strategies/ibmisam_spec.rb
+- spec/spec_helper.rb