basica 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3327b0583b781fbc1fe0713836e95c3f7274a66
+  data.tar.gz: 7a5f68e27845f98138b08ffedf0b6fad7fe7b0e2
+SHA512:
+  metadata.gz: 40d018c2414e3819961c62181a5a5975e9081081a6f017cd4cf1d1649d500f85bd328ea476a96e9ef63ea9c3de44589b87c8cfc896b7c50e9902cb2b3f3ed432
+  data.tar.gz: 8bf891f0394218003c2b067b4bcca66a85b61564219f78ddb196a02b4a3261fb7abe24fed29c1189a73d005ba802721631ccf83da2cff2f0c54782abbd6b98fb

data/.gems

@@ -0,0 +1 @@
+cutest -v 1.2.0

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Michel Martens
+
+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,78 @@
+basica
+======
+
+Basic authentication library.
+
+Description
+-----------
+
+Basic authentication library suited for Cuba apps.
+
+## Usage
+
+Include the Basica module in your application, then call it
+by passing the `env` hash (should be available in every Rack
+based application) and a block. If the `env` hash contains the
+`HTTP_AUTHORIZATION` header, then the username and password will
+be passed to the block.
+
+The result of the method call to `basic_auth` will be that of
+the block. If the `HTTP_AUTHORIZATION` header is not found, a
+`RuntimeError` is raised.
+
+## Example
+
+First, an example of Basica in the wild:
+
+```ruby
+require "basica"
+
+include Basica
+
+header = "Basic %s" % Base64.encode64("foo:bar")
+
+result = basic_auth("HTTP_AUTHORIZATION" => header) do |user, pass|
+  user == "foo" && pass == "bar"
+end
+
+if result
+  # The right credentials were provided.
+end
+```
+
+Now an example of how to use it with [Cuba][cuba] and
+[Shield][shield]:
+
+```ruby
+Cuba.plugin Basica
+
+Cuba.define do
+  on env["HTTP_AUTHORIZATION"].nil? do
+    res.status = 401
+    res.headers["WWW-Authenticate"] = 'Basic realm="MyApp"'
+    res.write "Unauthorized"
+  end
+
+  basic_auth(env) do |user, pass|
+    login(User, user, pass)
+  end
+
+  on authenticated(User) do
+    run Users
+  end
+end
+```
+
+Note that the previous example assumes you have already required
+Cuba, Shield, Basica, and that you have a User model defined.
+
+[cuba]: http://cuba.is
+[shield]: http://cyx.github.io/shield/
+
+## Installation
+
+Install it using rubygems.
+
+```
+$ gem install basica
+```

data/basica.gemspec

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+Gem::Specification.new do |s|
+  s.name              = "basica"
+  s.version           = "0.0.1"
+  s.summary           = "Basic authentication library."
+  s.description       = "Basic authentication library suited for Cuba apps."
+  s.authors           = ["Michel Martens"]
+  s.email             = ["michel@soveran.com"]
+  s.homepage          = "https://github.com/soveran/basica"
+  s.files             = `git ls-files`.split("\n")
+  s.license           = "MIT"
+end

data/lib/basica.rb

@@ -0,0 +1,14 @@
+require "base64"
+
+module Basica
+  def basic_auth(env)
+    if env["HTTP_AUTHORIZATION"]
+      auth = env["HTTP_AUTHORIZATION"].split(" ")[1]
+      user, pass = Base64.decode64(auth).split(":")
+
+      yield user, pass
+    else
+      raise "Bad request"
+    end
+  end
+end

data/test/basica_test.rb

@@ -0,0 +1,32 @@
+require File.expand_path("../lib/basica", File.dirname(__FILE__))
+include Basica
+
+scope do
+  setup do
+    "Basic %s" % Base64.encode64("foo:bar")
+  end
+
+  test "correct credentials" do |header|
+    result = basic_auth("HTTP_AUTHORIZATION" => header) do |user, pass|
+      user == "foo" && pass == "bar"
+    end
+
+    assert_equal true, result
+  end
+
+  test "incorrect credentials" do |header|
+    result = basic_auth("HTTP_AUTHORIZATION" => header) do |user, pass|
+      user == "foo" && pass == "baz"
+    end
+
+    assert_equal false, result
+  end
+
+  test "bad request" do
+    assert_raise RuntimeError do
+      result = basic_auth(Hash.new) do |user, pass|
+        user == "foo" && pass == "baz"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: basica
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michel Martens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-03 00:00:00.000000000 Z
+dependencies: []
+description: Basic authentication library suited for Cuba apps.
+email:
+- michel@soveran.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gems
+- LICENSE
+- README.md
+- basica.gemspec
+- lib/basica.rb
+- test/basica_test.rb
+homepage: https://github.com/soveran/basica
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Basic authentication library.
+test_files: []