ya 0.1.0 → 0.2.0

data/README.rdoc

@@ -3,6 +3,22 @@
 Ya is a simple authentication module that uses a YAML flat file as its directory
 store.
 
+== Synopsis
+
+ Access = Ya.open(Rails.root + 'config' + 'access.yml')
+ 
+ Access.add('username', 'password')
+ Access.authenticate('username', 'fails')
+ # => false
+ Access.authenticate('nobody', 'fails')
+ # => nil
+ Access.authenticate('username', 'password')
+ # => { :username => { :salt => ?, :hash => ? } }
+ 
+ Access.mod('username', :meta => 'awesome')
+ Access.lookup('username')
+ # => { :username => { :salt => ?, :hash => ?, :meta => 'awesome' } }
+
 == Copyright
 
 Copyright (c) 2009 Carsten Nielsen. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/ya/digest.rb

@@ -14,13 +14,13 @@ module Ya
       ::Digest::SHA1.hexdigest("#{Time.now}-#{rand RANDOM_SEED}")
     end
 
-    def generate(login, password, attrs = {})
+    def salt_and_hash(password)
       salt = random_hash
       hash = salt_password(salt, password)
-      { :"#{login}" => { :salt => salt, :hash => hash }.merge(attrs) }
+      { :salt => salt, :hash => hash }
     end
 
-    module_function :salt_password, :random_hash, :generate
+    module_function :salt_password, :random_hash, :salt_and_hash
 
   end
 end

data/lib/ya/directory.rb

@@ -1,9 +1,9 @@
 module Ya
   class Directory
 
-    def initialize(access_file)
-      @access_file = access_file
-      FileUtils.touch(@access_file)
+    def initialize(directory_file)
+      @directory_file = directory_file
+      FileUtils.touch(@directory_file)
     end
 
     def lookup(login)
@@ -18,7 +18,19 @@ module Ya
     end
 
     def add(login, password, attrs = {})
-      dump(load.merge(Digest.generate(login, password, attrs)))
+      dump_record(login.to_sym => Digest.salt_and_hash(password).merge(attrs))
+    end
+
+    def mod(login, attrs = {})
+      record = lookup(login)
+      return nil unless record
+      dump_record(login.to_sym => record.merge(attrs))
+    end
+
+    def reset(login, new_password)
+      record = lookup(login)
+      return nil unless record
+      dump_record(login.to_sym => record.merge(Digest.salt_and_hash(new_password)))
     end
 
     def remove(login)
@@ -28,12 +40,16 @@ module Ya
 
     private
 
+    def dump_record(record)
+      dump(load.merge(record))
+    end
+
     def load
-      YAML.load_file(@access_file) || {}
+      YAML.load_file(@directory_file) || {}
     end
 
     def dump(directory)
-      File.open(@access_file, 'w') { |f| f.puts(directory.to_yaml) }
+      File.open(@directory_file, 'w') { |f| f.puts(directory.to_yaml) }
     end
 
   end

data/test/test_ya.rb

@@ -33,6 +33,42 @@ class TestYa < Test::Unit::TestCase
       FileUtils.rm('test.yml')
     end
 
+    context '#reset (for existing record)' do
+      setup { @directory.reset('heycarsten', 'passnerd') }
+
+      should 'change the password' do
+        assert @directory.authenticate('heycarsten', 'passnerd')
+      end
+
+      should 'not change anything else' do
+        assert_equal 'data', @directory.lookup('heycarsten')[:meta]
+      end
+    end
+
+    context '#reset (for nonexistant record)' do
+      setup { @directory.reset('nobody', 'password') }
+
+      should 'do nothing' do
+        assert_nil @directory.lookup('nobody')
+      end
+    end
+
+    context '#mod (for existing record)' do
+      setup { @directory.mod('heycarsten', :meta => 'face') }
+
+      should 'update the record' do
+        assert_equal 'face', @directory.lookup('heycarsten')[:meta]
+      end
+    end
+
+    context '#mod (for nonexistant record)' do
+      setup { @directory.mod('nobody', :meta => 'value') }
+
+      should 'do nothing' do
+        assert_nil @directory.lookup('nobody')
+      end
+    end
+
     context '#remove (for a record that exists)' do
       setup { @directory.remove('heycarsten') }
 
@@ -75,10 +111,9 @@ class TestYa < Test::Unit::TestCase
   context 'Ya::Digest' do
     context '.generate' do
       should 'return a hash representing a new record' do
-        record = Ya::Digest.generate('username', 'password', :extra => 'stuff')
-        assert_equal 40, record[:username][:salt].length
-        assert_equal 40, record[:username][:hash].length
-        assert_equal 'stuff', record[:username][:extra]
+        h = Ya::Digest.salt_and_hash('password')
+        assert_equal 40, h[:salt].length
+        assert_equal 40, h[:hash].length
       end
     end
 

data/ya.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ya}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Carsten Nielsen"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ya
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Carsten Nielsen