escher-rack_middleware 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f27b7d7a1f8f6e9d85d291fd15ba133a0e37063
+  data.tar.gz: 273d4bb3b297d602b3fbf66a09b66950f70ec325
+SHA512:
+  metadata.gz: e6a2397b7cc05b2aa628c845362641413f4511fd51ab0f6bbed42ff9af6fce9d1947cf7c53d3366079b27b87853d9e2669b24f0dab813e95b5ff13b440421515
+  data.tar.gz: 95c7e46c73ff4d29bb616654ce3e05ad9746e758b52ebc69f83f53f9de91767bf733493d8313974f7af46f4cee243f4fe0c6a5bdbadd94c11b723a72abc3295a

data/.gitignore

@@ -0,0 +1,22 @@
+*.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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Emarsys-Technologies Ltd.
+
+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,52 @@
+# Escher::RackMiddleware
+
+Rack Middleware for ease of use escher authentication for your application
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'escher-rack_middleware'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install escher-rack_middleware
+
+## Usage
+
+```ruby
+
+
+require 'escher/rack_middleware'
+Escher::RackMiddleware.config do |c|
+
+  # the default logger use the ruby core logger with STDOUT
+  c.logger= some_logger_instance
+
+  # for read more about escher auth object initialization please visit escherauth.io
+  c.add_escher_authenticator{ Escher::Auth.new( CredentialScope, AuthOptions ) }
+
+  # this will be triggered every time a request hit your appication
+  c.add_credential_updater{ Escher::Keypool.new.get_key_db }
+
+  # this help you exclude path(s) if you dont want require authorization for every endpoint
+  c.add_exclude_path(/^\/*monitoring\//)
+
+end
+
+use Escher::RackMiddleware
+run YourAwesomeApplication
+
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/escher-rack_middleware/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

data/Rakefile

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

data/escher-rack_middleware.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'escher/rack_middleware/version'
+
+Gem::Specification.new do |spec|
+
+  spec.name          = 'escher-rack_middleware'
+  spec.version       = Escher::RackMiddleware::VERSION
+  spec.authors       = ['Adam Luzsi']
+  spec.email         = ['aluzsi@emarsys.com']
+  spec.summary       = %q{Escher authorization for rack based http servers}
+  spec.description   = %q{Escher authorization for rack based http servers with ease in a form of middleware}
+  spec.homepage      = 'https://github.com/emartech/escher-rack_middleware-ruby'
+  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_development_dependency 'spec'
+
+  spec.add_dependency 'escher', '>= 0.3.3'
+
+end

data/lib/escher/rack_middleware.rb

@@ -0,0 +1,47 @@
+require 'escher'
+class Escher::RackMiddleware
+
+  require 'escher/rack_middleware/version'
+  require 'escher/rack_middleware/logging'
+  require 'escher/rack_middleware/credential'
+  require 'escher/rack_middleware/exclude_path'
+  require 'escher/rack_middleware/authenticator'
+
+  extend Logging
+  extend Credential
+  extend ExcludePath
+  extend Authenticator
+
+  def initialize(app)
+    @app = app
+  end
+
+  def call(request_env)
+
+    unless excluded_path?(request_env['REQUEST_URI'])
+      return unauthorized_response unless authorized?(request_env)
+    end
+
+    @app.call(request_env)
+
+  end
+
+  protected
+
+  def unauthorized_response
+    response = Rack::Response.new
+    response.write 'Unauthorized'
+    response.status = 401
+    response.finish
+  end
+
+  def env_dump_string(request_env)
+    require 'yaml' unless defined?(YAML)
+    YAML.dump(request_env)
+  end
+
+  def self.config(&block)
+    block.call(self)
+  end
+
+end

data/lib/escher/rack_middleware/authenticator.rb

@@ -0,0 +1,16 @@
+module Escher::RackMiddleware::Authenticator
+
+  require 'escher/rack_middleware/authenticator/helper'
+  def self.extended(klass)
+    klass.__send__(:include,self::Helper)
+  end
+
+  def add_escher_authenticator(&escher_instance_initializer)
+    escher_authenticators.push(escher_instance_initializer)
+  end
+
+  def escher_authenticators
+    @escher_authenticators ||= []
+  end
+
+end

data/lib/escher/rack_middleware/authenticator/helper.rb

@@ -0,0 +1,33 @@
+module Escher::RackMiddleware::Authenticator::Helper
+
+  def escher_authenticators
+    self.class.escher_authenticators
+  end
+
+  def authorized?(request_env)
+    escher_authenticators.any? { |instance_init| authorized_with?(instance_init.call, request_env) }
+  end
+
+  def authorized_with?(escher_authenticator, request_env)
+
+    request_env['escher.request.api_key_id'] = escher_authenticator.authenticate(
+        Rack::Request.new(request_env),credentials
+    )
+
+    requester_succeed_log_msg = [
+        request_env['escher.request.api_key_id'],
+        request_env['REQUEST_URI']
+    ].join(' => ')
+
+    logger.debug("authentication succeeded!(#{requester_succeed_log_msg})")
+
+    true
+  rescue Escher::EscherError => ex
+
+    logger.debug("authentication failed!(#{ex.message})")
+
+    false
+
+  end
+
+end

data/lib/escher/rack_middleware/credential.rb

@@ -0,0 +1,36 @@
+module Escher::RackMiddleware::Credential
+
+  require 'escher/rack_middleware/credential/helper'
+  def self.extended(klass)
+    klass.__send__(:include,self::Helper)
+  end
+
+  def add_credential(key,value)
+    raw_credentials.merge!(key => value)
+  end
+
+  def add_credential_updater(&block)
+    raise(ArgumentError,'block was not given') unless block_given?
+    @credential_callback = block
+  end
+
+  def credentials
+    new_credentials = credential_callback.respond_to?(:call) && credential_callback.call
+    if new_credentials.is_a?(Hash)
+      raw_credentials.merge(new_credentials)
+    else
+      raw_credentials
+    end
+  end
+
+  protected
+
+  def raw_credentials
+    @credentials ||= {}
+  end
+
+  def credential_callback
+    @credential_callback ||= Proc.new{{}}
+  end
+
+end

data/lib/escher/rack_middleware/credential/helper.rb

@@ -0,0 +1,7 @@
+module Escher::RackMiddleware::Credential::Helper
+
+  def credentials
+    self.class.credentials
+  end
+  
+end

data/lib/escher/rack_middleware/exclude_path.rb

@@ -0,0 +1,18 @@
+module Escher::RackMiddleware::ExcludePath
+
+  require 'escher/rack_middleware/exclude_paths/helper'
+  def self.extended(klass)
+    klass.__send__(:include,self::Helper)
+  end
+
+  def add_exclude_paths(*paths)
+    excluded_paths.push(*paths)
+  end
+
+  alias add_exclude_path add_exclude_paths
+
+  def excluded_paths
+    @excluded_paths ||= []
+  end
+
+end

data/lib/escher/rack_middleware/exclude_paths/helper.rb

@@ -0,0 +1,17 @@
+module Escher::RackMiddleware::ExcludePath::Helper
+
+  def excluded_paths
+    @excluded_paths ||= self.class.excluded_paths.dup
+  end
+
+  def excluded_path?(path)
+    excluded_paths.any? do |matcher|
+      if matcher.is_a?(Regexp)
+        !!(path =~ matcher)
+      else
+        path == matcher.to_s
+      end
+    end
+  end
+
+end

data/lib/escher/rack_middleware/logging.rb

@@ -0,0 +1,20 @@
+module Escher::RackMiddleware::Logging
+
+  require 'escher/rack_middleware/logging/helper'
+
+  def self.extended(klass)
+    klass.__send__(:include,Helper)
+  end
+
+  def logger=(logger)
+    @logger=logger
+  end
+
+  def logger
+    @logger ||= -> {
+      require 'logger'
+      Logger.new(STDOUT)
+    }.call
+  end
+
+end

data/lib/escher/rack_middleware/logging/helper.rb

@@ -0,0 +1,7 @@
+module Escher::RackMiddleware::Logging::Helper
+
+  def logger
+    self.class.logger
+  end
+
+end

data/lib/escher/rack_middleware/version.rb

@@ -0,0 +1,2 @@
+require 'escher/rack_middleware'
+Escher::RackMiddleware::VERSION = '0.1.3'

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: escher-rack_middleware
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Adam Luzsi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-09 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: spec
+  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: escher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+description: Escher authorization for rack based http servers with ease in a form
+  of middleware
+email:
+- aluzsi@emarsys.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- escher-rack_middleware.gemspec
+- lib/escher/rack_middleware.rb
+- lib/escher/rack_middleware/authenticator.rb
+- lib/escher/rack_middleware/authenticator/helper.rb
+- lib/escher/rack_middleware/credential.rb
+- lib/escher/rack_middleware/credential/helper.rb
+- lib/escher/rack_middleware/exclude_path.rb
+- lib/escher/rack_middleware/exclude_paths/helper.rb
+- lib/escher/rack_middleware/logging.rb
+- lib/escher/rack_middleware/logging/helper.rb
+- lib/escher/rack_middleware/version.rb
+homepage: https://github.com/emartech/escher-rack_middleware-ruby
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Escher authorization for rack based http servers
+test_files: []