basic_auth_credentials 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+group :development do
+  gem "rspec"
+  gem 'redcarpet'
+  gem "yard"
+  gem "bundler"
+  gem "jeweler"
+end

data/Gemfile.lock

@@ -0,0 +1,34 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.3)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    redcarpet (2.1.1)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    yard (0.8.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  jeweler
+  redcarpet
+  rspec
+  yard

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 John Wilger
+
+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,40 @@
+# BasicAuthCredentials
+
+BasicAuthCredentials is a very simple, small object that turns an
+HTTP basic auth header into a user ID and a password.
+
+```ruby
+# these two lines create the same string that an HTTP client (such
+# as a web browser) would send in the Authorization header.
+encoded_credentials = Base64.encode64('my_username:my_password')
+http_header_value = "Basic #{encoded_credentials}"
+
+# And this is how you would decode that header value. Pretty simple.
+credentials = BasicAuthCredentials.new(http_header_value)
+credentials.user_id
+#=> 'my_username'
+credentials.password
+#=> 'my_password'
+```
+
+## Contributing to BasicAuthCredentials
+ 
+* Check out the latest master to make sure the feature hasn't been
+  implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't
+  requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it
+  in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you
+  want to have your own version, or is otherwise necessary, that is
+  fine, but please isolate to its own commit so I can cherry-pick around
+  it.
+
+## Copyright
+
+Copyright (c) 2012 John Wilger. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "basic_auth_credentials"
+  gem.homepage = "http://github.com/jwilger/basic_auth_credentials"
+  gem.license = "MIT"
+  gem.summary = %Q{Decodes HTTP Basic Auth headers}
+  gem.description = %Q{A simple class that takes an HTTP Basic Auth header value and decodes it into a user_id and password}
+  gem.email = "johnwilger@gmail.com"
+  gem.authors = ["John Wilger"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/basic_auth_credentials.rb

@@ -0,0 +1,12 @@
+require 'base64'
+
+class BasicAuthCredentials
+  attr_reader :user_id, :password
+
+  def initialize(encoded_credentials)
+    encoded_credentials ||= ''
+    encoded_credentials.sub!(/^Basic\s+/, '')
+    decoded = Base64.decode64(encoded_credentials)
+    @user_id, @password = decoded.split(':', 2)
+  end
+end

data/spec/basic_auth_credentials_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe BasicAuthCredentials do
+  def basic_auth_header(user_id, password)
+    encoded_part = Base64.encode64("#{user_id}:#{password}")
+    "Basic #{encoded_part}"
+  end
+
+  it 'turns an HTTP Basic Auth "Authorization" header into a user_id and a password' do
+    header = basic_auth_header('nobody@example.com', 'This is my password!')
+    credentials = BasicAuthCredentials.new(header)
+    credentials.user_id.should == 'nobody@example.com'
+    credentials.password.should == 'This is my password!'
+  end
+
+  it 'gives a nil user_id and password if initialized with nil' do
+    credentials = BasicAuthCredentials.new(nil)
+    credentials.user_id.should == nil
+    credentials.password.should == nil
+  end
+
+  it 'gives a nil user_id and password if initialized with a blank string' do
+    credentials = BasicAuthCredentials.new('')
+    credentials.user_id.should == nil
+    credentials.password.should == nil
+  end
+
+  it 'can handle a password that has a colon in it' do
+    header = basic_auth_header('nobody@example.com', 'password:with:colons')
+    credentials = BasicAuthCredentials.new(header)
+    credentials.user_id.should == 'nobody@example.com'
+    credentials.password.should == 'password:with:colons'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'basic_auth_credentials'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: basic_auth_credentials
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- John Wilger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple class that takes an HTTP Basic Auth header value and decodes
+  it into a user_id and password
+email: johnwilger@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/basic_auth_credentials.rb
+- spec/basic_auth_credentials_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/jwilger/basic_auth_credentials
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4302718667029166781
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Decodes HTTP Basic Auth headers
+test_files: []