basica 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3327b0583b781fbc1fe0713836e95c3f7274a66
-  data.tar.gz: 7a5f68e27845f98138b08ffedf0b6fad7fe7b0e2
+  metadata.gz: 596643c3a44ac35fd6e6ba9709a306572019250d
+  data.tar.gz: 599e38abf05f1cdf834ba289bc26f41554a3ce6f
 SHA512:
-  metadata.gz: 40d018c2414e3819961c62181a5a5975e9081081a6f017cd4cf1d1649d500f85bd328ea476a96e9ef63ea9c3de44589b87c8cfc896b7c50e9902cb2b3f3ed432
-  data.tar.gz: 8bf891f0394218003c2b067b4bcca66a85b61564219f78ddb196a02b4a3261fb7abe24fed29c1189a73d005ba802721631ccf83da2cff2f0c54782abbd6b98fb
+  metadata.gz: a24e48bc8a045eec458c091cd264516e7c8699245a79f476c6ae1371ab9a081a2f96827063d1b645c2597508b686b7cafe05b691506a8549a06ae8e1178ecdf4
+  data.tar.gz: 1ebaa93abba947828f65e7554c4b0bdfa1247490fb07a4546e77b03a9f9a44811bdfee0f46e766834c01252e800553865dfc6840417c52cecee391c47d7e21d0

data/CONTRIBUTING

@@ -0,0 +1,19 @@
+This code tries to solve a particular problem with a very simple
+implementation. We try to keep the code to a minimum while making
+it as clear as possible. The design is very likely finished, and
+if some feature is missing it is possible that it was left out on
+purpose. That said, new usage patterns may arise, and when that
+happens we are ready to adapt if necessary.
+
+A good first step for contributing is to meet us on IRC and discuss
+ideas. We spend a lot of time on #lesscode at freenode, always ready
+to talk about code and simplicity. If connecting to IRC is not an
+option, you can create an issue explaining the proposed change and
+a use case. We pay a lot of attention to use cases, because our
+goal is to keep the code base simple. Usually the result of a
+conversation is the creation of a different tool.
+
+Please don't start the conversation with a pull request. The code
+should come at last, and even though it may help to convey an idea,
+more often than not it draws the attention to a particular
+implementation.

data/README.md

@@ -6,10 +6,6 @@ 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
@@ -31,7 +27,9 @@ include Basica
 
 header = "Basic %s" % Base64.encode64("foo:bar")
 
-result = basic_auth("HTTP_AUTHORIZATION" => header) do |user, pass|
+env = { "HTTP_AUTHORIZATION" => header }
+
+result = basic_auth(env) do |user, pass|
   user == "foo" && pass == "bar"
 end
 
@@ -47,12 +45,6 @@ Now an example of how to use it with [Cuba][cuba] and
 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
@@ -60,6 +52,12 @@ Cuba.define do
   on authenticated(User) do
     run Users
   end
+
+  on default do
+    res.status = 401
+    res.headers["WWW-Authenticate"] = 'Basic realm="MyApp"'
+    res.write "Unauthorized"
+  end
 end
 ```
 

data/basica.gemspec

@@ -2,9 +2,9 @@
 
 Gem::Specification.new do |s|
   s.name              = "basica"
-  s.version           = "0.0.1"
+  s.version           = "1.0.0"
   s.summary           = "Basic authentication library."
-  s.description       = "Basic authentication library suited for Cuba apps."
+  s.description       = "Basic authentication library for Rack applications."
   s.authors           = ["Michel Martens"]
   s.email             = ["michel@soveran.com"]
   s.homepage          = "https://github.com/soveran/basica"

data/lib/basica.rb

@@ -1,14 +1,16 @@
 require "base64"
 
 module Basica
-  def basic_auth(env)
-    if env["HTTP_AUTHORIZATION"]
-      auth = env["HTTP_AUTHORIZATION"].split(" ")[1]
-      user, pass = Base64.decode64(auth).split(":")
+  HTTP_AUTHORIZATION = "HTTP_AUTHORIZATION".freeze
 
-      yield user, pass
-    else
-      raise "Bad request"
+  def basic_auth(env)
+    http_auth = env.fetch(HTTP_AUTHORIZATION) do
+      return nil
     end
+
+    cred = http_auth.split(" ")[1]
+    user, pass = Base64.decode64(cred).split(":")
+
+    yield(user, pass) || nil
   end
 end

data/test/basica_test.rb

@@ -1,4 +1,5 @@
-require File.expand_path("../lib/basica", File.dirname(__FILE__))
+require_relative "../lib/basica"
+
 include Basica
 
 scope do
@@ -19,14 +20,14 @@ scope do
       user == "foo" && pass == "baz"
     end
 
-    assert_equal false, result
+    assert_equal nil, result
   end
 
   test "bad request" do
-    assert_raise RuntimeError do
-      result = basic_auth(Hash.new) do |user, pass|
-        user == "foo" && pass == "baz"
-      end
+    result = basic_auth(Hash.new) do |user, pass|
+      user == "foo" && pass == "baz"
     end
+
+    assert_equal nil, result
   end
 end

metadata

@@ -1,23 +1,24 @@
 --- !ruby/object:Gem::Specification
 name: basica
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Michel Martens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-03 00:00:00.000000000 Z
+date: 2016-03-22 00:00:00.000000000 Z
 dependencies: []
-description: Basic authentication library suited for Cuba apps.
+description: Basic authentication library for Rack applications.
 email:
 - michel@soveran.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gems
+- ".gems"
+- CONTRIBUTING
 - LICENSE
 - README.md
 - basica.gemspec
@@ -33,17 +34,17 @@ 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
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Basic authentication library.