omniauth-headers 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 97c2ad6c92c4502a769470c52c71b86e1215d360
+  data.tar.gz: d289cd6190fdf9a00a922ca03410febc9c7ea71f
+SHA512:
+  metadata.gz: 63826504586a2f5acb9d4e1cdcd16aaece64c96456ca4332425d9ee3ac67d1ecb4e8d62348d177915e0bd1ed47a80abb185e7b9ca94bc11d8d52078286f8fc33
+  data.tar.gz: 04dd9fe48c302b2b04a85e980fb4ec18a33d0c25b746afb55cb6d246f4e6342b6d899623e0cf50dc076f202e72ecf5ce7bf07a51595bd3243e9c4595a4fbd256

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.14

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 JasonK
+
+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,71 @@
+[![Build Status](https://travis-ci.org/jasonmk/omniauth-headers.svg?branch=master)](https://travis-ci.org/jasonmk/omniauth-headers)
+
+# OmniAuth::Strategies::Headers
+
+A VERY simple OmniAuth strategy to pull user information from headers. This is useful in
+situations where you have an authenticating reverse proxy in front of your application
+that places user information into the request headers.
+
+Technically speaking, you probably don't need omniauth in this case since the whole
+redirect/callback system in unnecessary (every request has the user information already),
+however, if your application uses multiple different authentication schemes, you may find
+it easier to use this than trying to swap omniauth in and out.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-headers'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-headers
+
+## Usage
+
+As a middleware in your Rack application:
+
+```ruby
+  require 'omniauth'
+  use OmniAuth::Strategies::Headers,
+    headers: { uid: 'HTTP_USER_ID', email: 'HTTP_EMAIL' },
+    uid_field: :uid
+```
+
+or in your Rails application:
+
+in Gemfile:
+ 
+```ruby
+  gem 'omniauth-headers'
+```
+
+in config/initializers/omniauth.rb
+
+```ruby
+  Rails.application.config.middleware.use OmniAuth::Builder do
+    provider :headers,
+      headers: { uid: 'HTTP_USER_ID', email: 'HTTP_EMAIL' },
+      uid_field: :uid
+  end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jasonmk/omniauth-headers.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "omniauth/headers"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/omniauth-headers.rb

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

data/lib/omniauth-headers/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Headers
+    VERSION = "0.1.1"
+  end
+end

data/lib/omniauth/strategies/headers.rb

@@ -0,0 +1,27 @@
+require 'omniauth'
+
+module OmniAuth
+  module Strategies
+    class Headers
+      include OmniAuth::Strategy
+
+      option :headers, {uid: 'HTTP_USER_ID', email: 'HTTP_EMAIL'}
+      option :uid_field, :uid
+
+      def request_phase
+        redirect callback_url
+      end
+
+      uid do
+        request.env[options.headers[options.uid_field]]
+      end
+
+      info do
+        options.headers.inject({}) do |hash, field|
+          hash[field[0]] = request.env[field[1]]
+          hash
+        end
+      end
+    end
+  end
+end

data/omniauth-headers.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "omniauth-headers/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-headers"
+  spec.version       = Omniauth::Headers::VERSION
+  spec.authors       = ["Jason M. Kusar"]
+  spec.email         = ["jason@kusar.net"]
+
+  spec.summary       = %q{A simple OmniAuth strategy to read authentication from headers.}
+  spec.description   = %q{A VERY simple OmniAuth strategy to pull header information placed by an authenticating reverse proxy.}
+  spec.homepage      = "https://github.com/jasonmk/omniauth-headers"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'omniauth', '>= 1.0'
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'pry'
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-headers
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jason M. Kusar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-26 00:00:00.000000000 Z
+dependencies:
+- !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: pry
+  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: A VERY simple OmniAuth strategy to pull header information placed by
+  an authenticating reverse proxy.
+email:
+- jason@kusar.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/omniauth-headers.rb
+- lib/omniauth-headers/version.rb
+- lib/omniauth/strategies/headers.rb
+- omniauth-headers.gemspec
+homepage: https://github.com/jasonmk/omniauth-headers
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: A simple OmniAuth strategy to read authentication from headers.
+test_files: []