openid-store-mongoid 0.1.1 → 0.1.2

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
 ruby '1.9.3'
 
@@ -6,8 +6,9 @@ gem 'mongoid', '~>3.1'
 gem 'ruby-openid', '~>2.2.3'
 
 group :development, :test do
-  gem "rspec", "~> 2.8"
-  gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.0"
-  gem "jeweler", "~> 1.8.4"
+  gem 'rspec', '~> 2.8'
+  gem 'yard', '~> 0.8'
+  gem 'redcarpet', '~> 2.2'
+  gem 'bundler', '~> 1.0'
+  gem 'jeweler', '~> 1.8.4'
 end

data/Gemfile.lock

@@ -28,6 +28,7 @@ GEM
     rake (10.0.3)
     rdoc (3.12.1)
       json (~> 1.4)
+    redcarpet (2.2.2)
     rspec (2.12.0)
       rspec-core (~> 2.12.0)
       rspec-expectations (~> 2.12.0)
@@ -38,6 +39,7 @@ GEM
     rspec-mocks (2.12.2)
     ruby-openid (2.2.3)
     tzinfo (0.3.35)
+    yard (0.8.4.1)
 
 PLATFORMS
   ruby
@@ -46,6 +48,7 @@ DEPENDENCIES
   bundler (~> 1.0)
   jeweler (~> 1.8.4)
   mongoid (~> 3.1)
-  rdoc (~> 3.12)
+  redcarpet (~> 2.2)
   rspec (~> 2.8)
   ruby-openid (~> 2.2.3)
+  yard (~> 0.8)

data/Rakefile

@@ -35,12 +35,5 @@ task :default => :spec
 
 task :test => :spec
 
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "temp #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/openid/store/models/association.rb

@@ -2,10 +2,13 @@ require 'mongoid'
 require 'openid/association'
 
 module OpenID::Store
+  # Wrapper class for an OpenID::Association object.
   class Association
     include Mongoid::Document
     field :secret, :type => Moped::BSON::Binary
 
+    # Create an OpenID::Association object from this object.
+    # @return [OpenID::Association] Child object created from this document.
     def from_record
       OpenID::Association.new(handle, secret.to_s, Time.at(issued), lifetime, assoc_type)
     end

data/lib/openid/store/models/nonce.rb

@@ -2,6 +2,7 @@ require 'mongoid'
 require 'openid'
 
 module OpenID::Store
+  # Wrapper class for an OpenID::Nonce object.
   class Nonce
     include Mongoid::Document
   end

data/lib/openid/store/mongoid_store.rb

@@ -5,13 +5,22 @@ require 'moped/bson/binary'
 require 'openid/store/models/nonce'
 require 'openid/store/models/association'
 
+# Module OpenID::Store is used for all OpenID Store types. Also helps distinguishes
+# the Association/Nonce wrappers from OpenID::Association and OpenID::Nonce.
 module OpenID::Store
+  # OpenID Store class which uses Mongoid to store and access Association and Nonce data.
   class MongoidStore < OpenID::Store::Interface
+    # Cleans up any expired Nonce and Association data
+    # @note Not run as part of the normal process, must be run manually if desired.
     def self.cleanup
       cleanup_nonces
       cleanup_associations
     end
 
+    # Gets the Association for the given server url and handle.
+    # @param [String] server_url URL of the server making the request
+    # @param handle The handle associated with the Association
+    # @note Called internally by OpenID.
     def get_association(server_url, handle = nil)
       assns = query_associations(server_url, handle)
 
@@ -27,11 +36,13 @@ module OpenID::Store
       return nil
     end
 
+    # Stores an Association for the given server url and OpenID::Association.
+    # @param [String] server_url URL of the server making the request
+    # @param [OpenID::Association] assoc Object to use to create Association
+    # @note Called internally by OpenID.
     def store_association(server_url, assoc)
       remove_association(server_url, assoc.handle)
 
-      # BSON::Binary is used because secrets raise an exception
-      # due to character encoding
       Association.create(:server_url => server_url,
                          :handle     => assoc.handle,
                          :secret     => Moped::BSON::Binary.new(:generic, assoc.secret),
@@ -40,6 +51,11 @@ module OpenID::Store
                          :assoc_type => assoc.assoc_type)
     end
 
+    # Creates a Nonce for the given information.
+    # @param [String] server_url URL of the server making the request
+    # @param timestamp Time the Nonce was created.
+    # @param [String] salt Random string to uniquify Nonces. 
+    # @return True if the given nonce has not been created before and the timestamp is valid, False otherwise.
     def use_nonce(server_url, timestamp, salt)
       return false if any_nonces?(server_url, timestamp, salt) || delta_beyond_skew?(timestamp)
       Nonce.create(:server_url => server_url, :timestamp => timestamp, :salt => salt)
@@ -76,7 +92,7 @@ module OpenID::Store
     end
 
     def self.cleanup_associations
-      Association.for_js("(this.issued + this.lifetime) > ti", ti: Time.now.to_i).delete
+      Association.for_js("(this.issued + this.lifetime) < ti", ti: Time.now.to_i).delete
     end
   end
 end

data/openid-store-mongoid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "openid-store-mongoid"
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Larry Price"]
-  s.date = "2013-02-23"
+  s.date = "2013-02-27"
   s.description = "Use a Mongoid database to store OpenID consumer data."
   s.email = "larry.price.dev@gmail.com"
   s.extra_rdoc_files = [
@@ -46,14 +46,16 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<mongoid>, ["~> 3.1"])
       s.add_runtime_dependency(%q<ruby-openid>, ["~> 2.2.3"])
       s.add_development_dependency(%q<rspec>, ["~> 2.8"])
-      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<yard>, ["~> 0.8"])
+      s.add_development_dependency(%q<redcarpet>, ["~> 2.2"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
     else
       s.add_dependency(%q<mongoid>, ["~> 3.1"])
       s.add_dependency(%q<ruby-openid>, ["~> 2.2.3"])
       s.add_dependency(%q<rspec>, ["~> 2.8"])
-      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<yard>, ["~> 0.8"])
+      s.add_dependency(%q<redcarpet>, ["~> 2.2"])
       s.add_dependency(%q<bundler>, ["~> 1.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
     end
@@ -61,7 +63,8 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<mongoid>, ["~> 3.1"])
     s.add_dependency(%q<ruby-openid>, ["~> 2.2.3"])
     s.add_dependency(%q<rspec>, ["~> 2.8"])
-    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<yard>, ["~> 0.8"])
+    s.add_dependency(%q<redcarpet>, ["~> 2.2"])
     s.add_dependency(%q<bundler>, ["~> 1.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openid-store-mongoid
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-23 00:00:00.000000000 Z
+date: 2013-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
@@ -60,13 +60,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.8'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -74,7 +74,23 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -145,7 +161,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2320968285031314853
+      hash: -1746080449216916929
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: