mongoid_signature 0.0.4

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+spec/tmp

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--format nested
+--backtrace

data/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+gemspec
+
+gem 'bson_ext', :platforms => :mri

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Connected Bits, LLC
+
+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,88 @@
+Sign mongoid documents to prevent duplicates.
+
+== Requirements
+
+* mongoid (>= 2.0.0.rc7)
+
+== Install
+
+To install mongoid_signature, simply add it to your Gemfile:
+
+  gem 'mongoid_signature'
+
+In order to get the latest development version of mongoid_signature:
+
+  gem 'mongoid_signature', :git => 'https://github.com/connectedbits/mongoid_signature.git'
+
+And then:
+  bundle install
+
+== Usage
+
+Add the <tt>include Mongoid::Signature</tt> in the model:
+
+	class User
+	  include Mongoid::Document
+	  include Mongoid::Signature
+  
+	  field :name
+	  field :email
+  
+	  references_many :posts
+	  references_many :comments
+  
+	  sign_document :include => [:name]
+	end
+
+	class Post
+	  include Mongoid::Document
+	  include Mongoid::Timestamps
+	  include Mongoid::Signature
+  
+	  field :title
+	  field :body
+	  field :published, :type => Boolean, :default => false
+  
+	  referenced_in :users
+	  embeds_many :comments  
+  
+	  sign_document :include => [:user, :title, :body]
+	end
+	
+	class Comment
+	  include Mongoid::Document
+	  include Mongoid::Timestamps
+	  include Mongoid::Signature
+
+	  field :body
+
+	  embedded_in :post
+	  referenced_in :user
+
+	  sign_document :include => [:user, :body]
+	end
+
+=== Signing
+
+This will add a <tt>signature</tt> field to your document and provide additional signature_string and sign! methods:
+
+	>> @user = User.new(:name => 'Eric')
+	=> #<User _id: 4d66a345bf354104bd000002, name: "Eric", signature: nil, email: nil>
+	>> @user.sign!
+	=> "535d6fcc4483b2d02167d2d4bc05fdff5e34f6538ac6fa897c63b11d8417e815"
+
+== Known issues
+
+See https://github.com//mongoid_signature/issues
+
+== Repository
+
+See https://github.com/connectedbits/mongoid_signature and feel free to fork it!
+
+== Contributors
+
+See a list of all contributors at https://github.com/connected/mongoid_signature/contributors. Thanks a lot everyone!
+
+== Copyright
+
+Copyright (c) 2011 Connected Bits, LLC. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,33 @@
+require "rubygems"
+require "rake"
+require "rake/rdoctask"
+require "rspec"
+require "rspec/core/rake_task"
+require 'rake/gempackagetask'
+
+gemspec = eval(File.read('mongoid_signature.gemspec'))
+Rake::GemPackageTask.new(gemspec) do |pkg|
+  pkg.gem_spec = gemspec
+end
+
+desc "build the gem and release it to rubygems.org"
+task :release => :gem do
+  sh "gem push pkg/mongoid_signature-#{gemspec.version}.gem"
+end
+
+desc 'Generate documentation for the mongoid_signature plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MongoidSignature'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Rspec::Core::RakeTask.new('spec:unit') do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+task :spec => ['spec:unit']
+
+task :default => :spec

data/lib/mongoid/signature.rb

@@ -0,0 +1,64 @@
+require 'digest/md5'
+
+module Mongoid::Signature
+  extend ActiveSupport::Concern
+  
+  included do
+    class_attribute :sign_fields
+    delegate :sign_fields, :to => "self.class"
+  end  
+  
+  def signature_string
+    sig = ''
+    self.sign_fields.each do |field|
+      if self.respond_to?(field)
+        if value = self.send(field)
+          if value.respond_to?('signature_string')
+            value = value.signature_string
+          elsif value.respond_to?('to_s')
+            value = value.to_s
+          end
+          sig << value if !value.blank?
+        end  
+      end
+      sig << ';'
+    end if self.sign_fields
+    sig
+  end
+
+  def sign!
+    sig = (Digest::MD5.new << self.signature_string).to_s
+    self.signature = sig if self.respond_to?(:signature)
+  end
+
+  def unique_signature?
+    match = self.class.where(signature: self.signature).first
+    if match.nil?
+      true
+    else
+      match._id == self._id && self.class.where(signature: self.signature).count < 2
+    end
+  end      
+
+  def validate_unique_signature
+    if unique_signature? 
+      true
+    else
+      errors.add(:base, "is a duplicate")
+      false
+    end
+  end
+  
+  module ClassMethods
+    def sign_document(options = {})
+      self.sign_fields = options[:include]
+      if options[:save_signature]
+        class_eval <<-EOV
+          field :signature, :type => String, :required => true
+          index :signature
+          before_validation :sign!
+        EOV
+      end
+    end
+  end
+end

data/lib/mongoid_signature.rb

@@ -0,0 +1 @@
+require 'mongoid/signature'

data/mongoid_signature.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name        = "mongoid_signature"
+  s.version     = "0.0.4"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Connected Bits"]
+  s.email       = ["info@connectedbits.com"]
+  s.homepage    = "http://github.com/connectedbits/mongoid_signature"
+  s.summary     = %q{Sign mongoid documents to prevent dupes}
+  s.description = %q{Makes it easy to sign Mongoid documents based on a subset of fields to prevent duplicate documents.}
+
+  s.rubyforge_project = "mongoid_signature"
+
+  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_runtime_dependency('mongoid', ['>= 2.0.0'])
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('rake')
+end

data/spec/models/comment.rb

@@ -0,0 +1,12 @@
+class Comment
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  include Mongoid::Signature
+  
+  field :body
+  
+  embedded_in :post
+  referenced_in :user
+  
+  sign_document :include => [:user, :body]
+end

data/spec/models/post.rb

@@ -0,0 +1,14 @@
+class Post
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  include Mongoid::Signature
+  
+  field :title
+  field :body
+  field :published, :type => Boolean, :default => false
+  
+  referenced_in :users
+  embeds_many :comments  
+  
+  sign_document :include => [:user, :title, :body], :save_signature => true
+end

data/spec/models/user.rb

@@ -0,0 +1,12 @@
+class User
+  include Mongoid::Document
+  include Mongoid::Signature
+  
+  field :name
+  field :email
+  
+  references_many :posts
+  references_many :comments
+  
+  sign_document :include => [:name]
+end

data/spec/signature_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe Mongoid::Signature do
+  before do
+    @user = User.new(:name => 'Eric')
+    @post = Post.new
+  end
+
+  describe "a class with save signature option" do
+    it "should have a signature field" do
+      @post.should respond_to(:signature)
+    end
+  end  
+  
+  describe "a class without save signature option" do
+    it "should not have a signature field" do
+      @user.should_not respond_to(:signature)
+    end
+  end
+  
+  describe "two instances with the same signature fields" do
+    before do
+      @post1 = Post.new(:title => 'My Great Blog Post', :body => 'I was born...')
+      @post2 = Post.new(:title => 'My Great Blog Post', :body => 'I was born...')
+      @post1.sign!
+      @post2.sign!
+    end
+
+    it "should have the same signature" do
+      @post1.signature.should  == @post2.signature
+    end 
+
+    describe "with otherwise different data" do
+      before do
+        @post1.published = true
+        @post2.published = false
+      end
+
+      it "should both have the same signature" do
+        @post1.signature.should == @post2.signature
+      end
+    end
+  end
+  
+  describe "two instances with different signature fields" do
+    before do
+      @post1 = Post.new(:title => 'My Great Blog Post', :body => 'I was born...')
+      @post2 = Post.new(:title => 'Been Busy!', :body => 'Sorry for not posting but...')
+      @post1.sign!
+      @post2.sign!
+    end
+
+    it "should not have the same signature" do
+      @post1.signature.should_not == @post2.signature
+    end 
+  end
+  
+  describe "an instance with a related document" do
+    before do
+      @post_from_user1 = Post.new(:title => 'My Great Blog Post', :body => 'I was born...', :user => User.new(:name => 'Eric'))
+      @post_from_user2 = Post.new(:title => 'My Great Blog Post', :body => 'I was born...', :user => User.new(:name => 'Dave'))
+      @post_from_user1.sign!
+      @post_from_user2.sign!
+    end
+
+    it "should not have the same signature" do
+      @post_from_user1.signature.should_not == @post_from_user2.signature
+    end 
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+MODELS = File.join(File.dirname(__FILE__), "models")
+$LOAD_PATH.unshift(MODELS)
+
+require 'mongoid'
+require 'mongoid_signature'
+require 'rspec'
+
+Mongoid.configure do |config|
+  name = "mongoid_signature_test"
+  host = "localhost"
+  config.master = Mongo::Connection.new.db(name)
+end
+
+Dir[ File.join(MODELS, "*.rb") ].sort.each { |file| require File.basename(file) }
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_signature
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Connected Bits
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !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: rake
+  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: Makes it easy to sign Mongoid documents based on a subset of fields to
+  prevent duplicate documents.
+email:
+- info@connectedbits.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/mongoid/signature.rb
+- lib/mongoid_signature.rb
+- mongoid_signature.gemspec
+- spec/models/comment.rb
+- spec/models/post.rb
+- spec/models/user.rb
+- spec/signature_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/connectedbits/mongoid_signature
+licenses: []
+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: 2726516450144486484
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2726516450144486484
+requirements: []
+rubyforge_project: mongoid_signature
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Sign mongoid documents to prevent dupes
+test_files:
+- spec/models/comment.rb
+- spec/models/post.rb
+- spec/models/user.rb
+- spec/signature_spec.rb
+- spec/spec_helper.rb