roda-basic-auth 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a25fb1b57a71764743f9d4169d1efc47d8c81398
+  data.tar.gz: e4e737198c5e7061ceafbe629883d5369005b6df
+SHA512:
+  metadata.gz: 0f91e96f8dcf050dcfbf1d65205f75c03298f428cb75ddfe2290ff1c3bbe02eea23d04302c47f64ad72135f97076d0aa2e1c7fbbaa707b2425bb79cc3aca9131
+  data.tar.gz: 0d15fefcbd2f733b4e2356ce3604e40dd294158ebc40c70ae8896ac60021741b7d250537c508fdb57a4724362585b421feb71359f4183e44b8aec887995d1de5

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Amadeus Folego
+
+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 @@
+# Roda Basic Authentication
+
+Adds functionality for simple http authentication with Roda.
+
+## Configuration
+
+Configure your Roda application to use this plugin:
+
+```ruby
+plugin :basic_auth
+```
+
+You can pass global options, in this context they'll be shared between all
+basic\_auth calls.
+
+```ruby
+plugin :basic_auth, authenticator: proc {|user, pass| [user, pass] == %w[foo bar]},
+                    realm: 'Restricted Area' # default
+```
+
+## Usage
+
+Call `r.basic_auth` when you want to authenticate the user, it halts the
+request with 401 response code if the authenticator is false.
+
+You can specify the local authenticator with a block:
+
+```ruby
+r.basic_auth { |user, pass| [user, pass] == %w[foo bar] }
+```
+
+## Warden
+
+To avoid having your 401 responses intercepted by warden, you need to configure
+the unauthenticated callback that is called just before the request is halted:
+
+```ruby
+plugin :basic_auth, unauthorized: proc {|r| r.env['warden'].custom_failure! }
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/badosu/roda-basic-auth.
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "roda/plugins/basic_auth"
+
+# 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

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/roda/plugins/basic_auth/version.rb

@@ -0,0 +1,7 @@
+require 'roda'
+
+module Roda::RodaPlugins
+  module BasicAuth
+    VERSION = "0.1.0"
+  end
+end

data/lib/roda/plugins/basic_auth.rb

@@ -0,0 +1,53 @@
+require "roda"
+require "roda/plugins/basic_auth/version"
+
+module Roda::RodaPlugins
+  module BasicAuth
+    DEFAULTS = {
+      realm: "Restricted Area",
+      unauthorized_headers: proc do |opts|
+        {'Content-Type' => 'text/plain',
+         'Content-Length' => '0',
+         'WWW-Authenticate' => ('Basic realm="%s"' % opts[:realm])}
+      end,
+      bad_request_headers: proc do |opts|
+        {'Content-Type' => 'text/plain', 'Content-Length' => '0'}
+      end
+    }
+
+    def self.configure(app, opts={})
+      plugin_opts = (app.opts[:basic_auth] ||= DEFAULTS)
+      app.opts[:basic_auth] = plugin_opts.merge(opts)
+      app.opts[:basic_auth].freeze
+    end
+
+    module RequestMethods
+      def basic_auth(opts={}, &authenticator)
+        auth_opts = roda_class.opts[:basic_auth].merge(opts)
+        authenticator ||= auth_opts[:authenticator]
+
+        raise "Must provide an authenticator block" if authenticator.nil?
+
+        auth = Rack::Auth::Basic::Request.new(env)
+
+        unless auth.provided?
+          auth_opts[:unauthorized].call(self) if auth_opts[:unauthorized]
+          halt [401, auth_opts[:unauthorized_headers].call(auth_opts), []]
+        end
+
+        unless auth.basic?
+          halt [400, auth_opts[:bad_request_headers].call(auth_opts), []]
+        end
+
+        if authenticator.call(*auth.credentials)
+          env['REMOTE_USER'] = auth.username
+        else
+          auth_opts[:unauthorized].call(self) if auth_opts[:unauthorized]
+          halt [401, auth_opts[:unauthorized_headers].call(auth_opts), []]
+        end
+      end
+    end
+  end
+
+  register_plugin(:basic_auth, BasicAuth)
+end

data/roda-basic-auth.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'roda/plugins/basic_auth/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "roda-basic-auth"
+  spec.version       = Roda::RodaPlugins::BasicAuth::VERSION
+  spec.authors       = ["Amadeus Folego"]
+  spec.email         = ["amadeusfolego@gmail.com"]
+
+  spec.summary       = %q{Adds basic authentication methods to Roda}
+  spec.description   = %q{Adds basic authentication methods to Roda}
+  spec.homepage      = "https://github.com/badosu/basic-roda-auth"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "roda", "~> 2.0"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: roda-basic-auth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Amadeus Folego
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: roda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Adds basic authentication methods to Roda
+email:
+- amadeusfolego@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/roda/plugins/basic_auth.rb
+- lib/roda/plugins/basic_auth/version.rb
+- roda-basic-auth.gemspec
+homepage: https://github.com/badosu/basic-roda-auth
+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: Adds basic authentication methods to Roda
+test_files: []