openid_couchdb_store 0.0.1

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Sam Schenkman-Moore
+
+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.rdoc

@@ -0,0 +1,7 @@
+= Openid Couchdb Store
+
+A store for OpenID using CouchDB. Right now depends on CouchRest, will try to to kick that dependency later.
+
+== Copyright
+
+Copyright (c) 2010 Sam Schenkman-Moore. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "openid_couchdb_store"
+    gem.summary = %Q{OpenID store using CouchDB}
+    gem.description = %Q{OpenID store using CouchDB. Right now using Couchrest, will make more flexible later, hopefully.}
+    gem.email = "samsm@samsm.com"
+    gem.homepage = "http://github.com/samsm/openid_couchdb_store"
+    gem.authors = ["Sam Schenkman-Moore"]
+    gem.add_development_dependency "couchrest", ">= 1.0.0"
+    gem.add_development_dependency "couchrest_extended_document", ">= 1.0.0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "openid_couchdb_store #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/openid_couchdb_store.rb

@@ -0,0 +1,135 @@
+# Again, from the OpenID gem
+require 'openid'
+require 'openid/store/interface'
+require "couchrest"
+require "couchrest_extended_document"
+
+module OpenidCouchdbStore
+
+  class Association < CouchRest::ExtendedDocument
+
+    set_callback :save, :before, :generate_expires_at
+
+    view_by :server_url
+    view_by :expires_at
+    view_by :server_url_plus_handle,
+      :map =>
+        "function(doc) {
+          if (doc['couchrest-type'] == 'OpenidCouchdbStore::Association' && doc['handle']) {
+                emit(doc['server_url'] + '&' + doc['handle'], 1);
+            }
+          }"
+    def self.by_server_url_and_handle(server, handle)
+      by_server_url_plus_handle(:key => "#{server}&#{handle}")
+    end
+
+    def self.expired
+      by_expires_at(:endkey => Time.now.to_i)
+    end
+
+    def generate_expires_at
+      self['expires_at'] = self['issued'] + self['lifetime']
+    end
+
+  end
+
+  class Nonce < CouchRest::ExtendedDocument
+    view_by :timestamp
+    view_by :server_url_salt_timestamp,
+      :map =>
+        "function(doc) {
+          if (doc['couchrest-type'] == 'OpenidCouchdbStore::Nonce' &&
+              doc.server_url &&
+              doc.salt &&
+              doc.timestamp) {
+                key = doc.server_url + '&' + doc.salt + '&' + doc.timestamp
+                emit(key, 1);
+            }
+          }"
+    def self.first_nonce(server_url,timestamp,salt)
+      by_server_url_salt_timestamp(:key => "#{server_url}&#{salt}&#{timestamp}").first
+    end
+
+    def self.expired
+      by_timestamp(:endkey => Time.now.to_i)
+    end
+
+  end
+
+  class Store < OpenID::Store::Interface
+
+    def initialize(couch_database)
+      association.use_database(couch_database)
+      nonce.use_database(couch_database)
+    end
+
+    def association
+      OpenidCouchdbStore::Association
+    end
+
+    def nonce
+      OpenidCouchdbStore::Nonce
+    end
+
+    def store_association(server_url, association)
+      remove_association(server_url, association.handle)
+
+      assoc = OpenidCouchdbStore::Association.create('server_url' => server_url,
+                         'handle'     => association.handle,
+                         'secret'     => OpenID::Util.to_base64(association.secret),
+                         'issued'     => association.issued,
+                         'lifetime'   => association.lifetime,
+                         'assoc_type' => association.assoc_type)
+      assoc
+    end
+
+    def get_association(server_url, handle=nil)
+      assoc_records = if (handle.nil? or handle.empty?)
+        Association.by_server_url(server_url)
+      else
+        Association.by_server_url_and_handle(server_url,handle)
+      end
+
+      # TODO: Removed .reverse here, make sure that was reasonable.
+      assoc_records.each do |a|
+        openid_association = OpenID::Association.new(a['handle'],
+                                                     OpenID::Util.from_base64(a['secret']),
+                                                     a['issued'],
+                                                     a['lifetime'],
+                                                     a['assoc_type'])
+        if openid_association.expires_in == 0
+          a.destroy
+        else
+          return openid_association
+        end
+      end if assoc_records.any? # <- may not be needed
+
+      # Fail if there isn't an acceptable association
+      return nil
+    end
+
+    def remove_association(server_url, handle)
+      Association.by_server_url_and_handle(server_url,handle).each do |association|
+        association.destroy
+      end
+    end
+
+    def use_nonce(server_url, timestamp, salt)
+      return false if Nonce.first_nonce(server_url, timestamp,salt)
+      return false if (timestamp - Time.now.to_i).abs > OpenID::Nonce.skew
+      Nonce.create({'server_url' => server_url, 'timestamp' => timestamp, 'salt' => salt})
+      return true
+    end
+
+    def cleanup_nonces
+      nonce.expired.each {|n| n.destroy }
+    end
+
+    def cleanup_associations
+      now = Time.now.to_i
+      Association.expired.each {|a| a.destroy }
+    end
+
+  end
+
+end

data/openid_couchdb_store.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{openid_couchdb_store}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sam Schenkman-Moore"]
+  s.date = %q{2010-09-28}
+  s.description = %q{OpenID store using CouchDB. Right now using Couchrest, will make more flexible later, hopefully.}
+  s.email = %q{samsm@samsm.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/openid_couchdb_store.rb",
+     "openid_couchdb_store.gemspec",
+     "test/helper.rb",
+     "test/test_openid_couchdb_store.rb"
+  ]
+  s.homepage = %q{http://github.com/samsm/openid_couchdb_store}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{OpenID store using CouchDB}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_openid_couchdb_store.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<couchrest>, [">= 1.0.0"])
+      s.add_development_dependency(%q<couchrest_extended_document>, [">= 1.0.0"])
+    else
+      s.add_dependency(%q<couchrest>, [">= 1.0.0"])
+      s.add_dependency(%q<couchrest_extended_document>, [">= 1.0.0"])
+    end
+  else
+    s.add_dependency(%q<couchrest>, [">= 1.0.0"])
+    s.add_dependency(%q<couchrest_extended_document>, [">= 1.0.0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,111 @@
+require 'rubygems'
+require 'test/unit'
+require 'ruby-debug'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'openid_couchdb_store'
+
+class Test::Unit::TestCase
+
+  def setup
+    timestamp(true)
+  end
+
+  ##
+  ## Couch-specific database test configuration here.
+  ##
+  def teardown
+    # Couchrest doesn't cope well with design documents getting deleted mind run, so ...
+    # CouchRest.delete "http://127.0.0.1:5984/openid_store_test"
+    db.documents['rows'].each do |d|
+      unless d['id'].index('_design')
+        db.delete_doc({'_rev'=>d['value']['rev'], '_id' => d['id']})
+      end
+    end
+  end
+
+  def db
+    @db ||= CouchRest.database!("http://127.0.0.1:5984/openid_store_test")
+  end
+
+  def store
+    @store ||= OpenidCouchdbStore::Store.new(db)
+  end
+
+  def insert_old_association
+    doc = {'server_url' => server_url,
+            'handle'     => handle,
+            'secret'     => OpenID::Util.to_base64(secret),
+            'issued'     => too_old_association_timestamp,
+            'lifetime'   => lifetime,
+            'assoc_type' => assoc_type,
+            'expire_at'  => (too_old_association_timestamp + lifetime)}
+    store.association.create(doc)
+  end
+
+  def find_old_association
+    OpenidCouchdbStore::Association.all.select {|a| a['issued'] == too_old_association_timestamp}.first
+  end
+
+  def insert_old_nonce
+    store.nonce.create({'server_url' => server_url, 'timestamp' => too_old_nonce_timestamp, 'salt' => salt})
+  end
+
+  def find_old_nonce
+    store.nonce.all.select {|n| n['server_url'] == server_url && n['timestamp'] == too_old_nonce_timestamp && n['salt'] == salt }.first
+  end
+
+  ##
+  ## End of Couch-specific test config
+  ##
+
+  def too_old_nonce_timestamp
+    timestamp - (OpenID::Nonce.skew * 1.5).to_i
+  end
+
+  def too_old_association_timestamp
+    timestamp - (60*60*24*365) # year old
+  end
+
+  def store_association(opts = {})
+    association = OpenID::Association.new(handle, secret, timestamp, lifetime, assoc_type)
+    opts.each_pair {|k,v| association.send "#{k}=", v}
+    store.store_association(server_url,association)
+  end
+
+  def get_association(server_url = server_url, handle = handle)
+    store.get_association(server_url,handle)
+  end
+
+  def server_url
+    "http://localhost:98765/"
+  end
+
+  def handle
+    "{HMAC-SHA1}{4ca0a54b}{5Sx5CQ==}"
+  end
+
+  def secret
+    OpenID::Util.from_base64("5EoS1O4V+x7VkBNEekHsavgRjbk=")
+  end
+
+  def timestamp(refresh = false)
+    @timestamp = nil if refresh
+    @timestamp ||= (Time.now - 10).to_i # 10 seconds ago
+  end
+
+  def lifetime
+    1209600 # two weeks in seconds
+  end
+
+  def assoc_type
+    "HMAC-SHA1"
+  end
+
+  def salt
+    "KuIaaq"
+  end
+
+end

data/test/test_openid_couchdb_store.rb

@@ -0,0 +1,67 @@
+require 'helper'
+
+class TestOpenidCouchdbStore < Test::Unit::TestCase
+  def test_store_and_retrieve_association
+    # Make sure there isn't already an association in the database
+    assert !get_association
+
+    # Save an assocaition
+    assert store_association
+
+    # Retrieve the association
+    assert assoc = store.get_association(server_url, handle)
+
+    # Check status of secret
+    assert assoc.secret == secret
+  end
+
+  def test_remove_association
+    store_association
+
+    # Ensure an assocaition exists
+    assert get_association
+
+    # Remove a specific association
+    assert store.remove_association(server_url,handle)
+    # Confirm that the association is gone.
+    assert !get_association
+  end
+
+  def test_use_nonce
+    # If a timestamp is too old, use_nonce should return false
+    assert !store.use_nonce(server_url, too_old_nonce_timestamp, salt)
+
+    # When no nonces exist, this should return true and create a nonce record
+    assert store.use_nonce(server_url, timestamp, salt)
+
+    # After a nonce is created with a given salt/timestamp, use_nonce should return false
+    assert !store.use_nonce(server_url, timestamp, salt)
+  end
+
+  def test_cleanup_nonces
+    insert_old_nonce
+
+    # Verify nonce is inserted
+    assert find_old_nonce
+
+    # Cleanup nonces
+    assert store.cleanup_nonces
+
+    # Verify nonce was cleaned up
+    assert !find_old_nonce
+  end
+
+  def test_cleanup_associations
+    insert_old_association
+
+    # Ensure association was saved
+    assert find_old_association
+
+    # Cleanup associations
+    assert store.cleanup_associations
+
+    # Ensure association was removed
+    assert !find_old_association
+
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: openid_couchdb_store
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Sam Schenkman-Moore
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-28 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: couchrest
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: couchrest_extended_document
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id002
+description: OpenID store using CouchDB. Right now using Couchrest, will make more flexible later, hopefully.
+email: samsm@samsm.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/openid_couchdb_store.rb
+- openid_couchdb_store.gemspec
+- test/helper.rb
+- test/test_openid_couchdb_store.rb
+has_rdoc: true
+homepage: http://github.com/samsm/openid_couchdb_store
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: OpenID store using CouchDB
+test_files: 
+- test/helper.rb
+- test/test_openid_couchdb_store.rb