username_password 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/README.rdoc

@@ -0,0 +1,57 @@
+== UsernamePassword
+
+* http://github.com/baconpat/username_password
+
+== DESCRIPTION:
+  
+Simple library for command line tools to request a username and password. If
+an "auth_file" is specified the input will be written to an encrypted file
+and will be read on future invocations - meaning the user does not have 
+to type in their username/password every time.
+
+This was specifically written to simplify writing and running simple scripts 
+and command line tools that access a web service sitting behind basic HTTP
+authentication.
+
+== SYNOPSIS:
+
+  require 'username_password'
+  credentials = UsernamePassword.get
+     
+In irb:
+  > require 'username_password'
+  > UsernamePassword.get
+  Username: joe224
+  Password: secret
+   => {:password=>"secret", :username=>"joe224"}
+   
+Specify a file where the username/password can be written to to prevent having
+to type them in every time a script is run
+  
+  require 'username_password'
+  UsernamePassword.auth_file = "/tmp/authfile"
+  UsernamePassword.get
+  
+== LICENSE:
+
+The MIT License
+
+Copyright (c) 2010 Patrick Bacon
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/username_password/version.rb

@@ -0,0 +1,3 @@
+module UsernamePassword
+  VERSION = "0.0.1"
+end

data/lib/username_password.rb

@@ -0,0 +1,52 @@
+require 'highline'
+require 'ezcrypto'
+
+module UsernamePassword
+  @@input_io = $stdin
+  @@output_io = $stderr
+  @@auth_file = nil
+  
+  # Set the IO object to use for input
+  def self.input=(io)
+    @@input_io = io
+  end
+
+  # Set the IO object to use for output
+  def self.output=(io)
+    @@output_io = io
+  end
+  
+  # Set the location of a file to save the username/password (encrypted) so the user
+  # won't have to type it in every time
+  def self.auth_file=(path)
+    @@auth_file = path
+  end
+  
+  # Asks the user for a username/password. If an auth_file has been specified
+  # the results will be saved to that file and the user will not have to 
+  # type the information in again.
+  def self.get
+    return read_file if @@auth_file && File.exists?(@@auth_file)
+    
+    highline = HighLine.new(@@input_io, @@output_io)
+    username = highline.ask("Username: ")
+    password = highline.ask("Password: ") { |q| q.echo = false }
+    
+    result = {:username => username, :password => password}
+    save_file(result) if @@auth_file
+    result
+  end
+  
+  private
+  def self.save_file(hash) #:nodoc:#
+    File.open(@@auth_file, 'w') { |file| file.write encryption.encrypt64(YAML.dump(hash)) }
+  end
+  
+  def self.read_file #:nodoc:#
+    YAML.load(encryption.decrypt64(File.read(@@auth_file)))
+  end
+  
+  def self.encryption #:nodoc:#
+    EzCrypto::Key.with_password(%|(FrDx&M(44;{TxU]RtYk69Khma6Li2KFCU:V6jj*YizpM4GiRd|, "salty")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require "bundler/setup"
+require 'rspec'
+require 'username_password'

data/spec/username_password_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+require 'fileutils'
+require 'tmpdir'
+
+describe UsernamePassword do
+  let(:input) { StringIO.new }
+  let(:output) { StringIO.new }
+  let(:auth_file) { File.join(Dir.tmpdir, "uptestfile") }
+  subject { UsernamePassword }
+  
+  before do
+    UsernamePassword.input = input
+    UsernamePassword.output = output
+  end
+  
+  after do
+    UsernamePassword.auth_file = nil
+    FileUtils.rm_f(auth_file) if File.exists?(auth_file)
+  end
+  
+  it "asks for a username and password" do
+    input << "joe224\n"
+    input << "secret\n"
+    input.rewind
+    
+    result = UsernamePassword.get
+    result[:username].should == "joe224"
+    result[:password].should == "secret"
+    
+    output.string.should == "Username: Password: \n"
+  end
+  
+  it "can save the entered username and password to a file that is used in later calls" do
+    UsernamePassword.auth_file = auth_file
+    
+    input << "joe224\n"
+    input << "secret\n"
+    input.rewind
+    UsernamePassword.get
+
+    # Prevent writing to output
+    output.close
+
+    3.times do
+      UsernamePassword.get.should == {:username => 'joe224', :password => 'secret'}
+    end
+  end
+  
+  it 'does not save the username password in plaintext' do
+    UsernamePassword.auth_file = auth_file
+    input << "joe224\n"
+    input << "secret\n"
+    input.rewind
+    UsernamePassword.get
+    
+    file_contents = File.read(auth_file)
+    file_contents.should_not =~ /joe224/
+    file_contents.should_not =~ /secret/
+  end
+end

data/username_password.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "username_password/version"
+
+Gem::Specification.new do |s|
+  s.name        = "username_password"
+  s.version     = UsernamePassword::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Patrick Bacon"]
+  s.email       = ["bacon@atomicobject.com"]
+  s.summary     = %q{Simple authentication gem to ask user for username/password and save to a file if desired}
+  s.description = %q{Simple authentication gem to ask user for username/password and save to a file if desired}
+  s.homepage    = "http://github.com/baconpat/username_password"
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency "highline", "~> 1"
+  s.add_dependency "ezcrypto"
+  
+  s.add_development_dependency "rspec", "~> 2"
+  s.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification 
+name: username_password
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Patrick Bacon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-02 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        version: "1"
+  type: :runtime
+  name: highline
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  name: ezcrypto
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        version: "2"
+  type: :development
+  name: rspec
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: rake
+  prerelease: false
+  version_requirements: *id004
+description: Simple authentication gem to ask user for username/password and save to a file if desired
+email: 
+- bacon@atomicobject.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/username_password.rb
+- lib/username_password/version.rb
+- spec/spec_helper.rb
+- spec/username_password_spec.rb
+- username_password.gemspec
+has_rdoc: true
+homepage: http://github.com/baconpat/username_password
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simple authentication gem to ask user for username/password and save to a file if desired
+test_files: 
+- spec/spec_helper.rb
+- spec/username_password_spec.rb