couchpillow 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8766ff55f2a06b3e6a73581eb02a5add86407868
-  data.tar.gz: e4b22c670eefa9f68deb5f4bf5de5db8dfa03613
+  metadata.gz: ccd762815a2494ec8a42b99e4d8feebf29d77fac
+  data.tar.gz: 9b0f6be497aa1a4cc2f0647ff0179953938a4be9
 SHA512:
-  metadata.gz: d8fd8cec7c43b888807d46a1faac51ed83087b1d7a2af8a85ebff8ec517b8937a8b26bf8cb76bc06213eec4c711d4f51de41190b7c4abde78c7c21acce6cd166
-  data.tar.gz: c793792ad45b53674963350e3b740d0b3310e1a10a5b8379a387cee46692c9d1e21d79625e1c44ef13054c9071c9bf485fb218d050a641bc46928d4393bd344d
+  metadata.gz: 8771a637242a813b851b683c96fd12b8064c923ec0aafa86a491e40bf3e4d383760e4f428e756ad7518840a2990f07f5b3ff55dc4b605d7475c3a1aa3ac2e9a8
+  data.tar.gz: b4dd50c6540f695ba3f04ecf73299ce0f517563ea9843b237dd4132c49ee8944c60c81ee305afac6d3a9c2351a65b4c40ebbabaf56b3e7179281902625c59996

data/README.markdown

@@ -1,14 +1,13 @@
 # CouchPillow
 
-Light and comfortable Document integrity tool for Couchbase Server.
-
 CouchPillow is a document integrity tool for Couchbase Documents to make sure
 that all current and existing documents can work nicely with the current code.
 
 CouchPillow separates itself from the database drivers, making it light and
 independent from the implementation.  Although it is initially designed to work
-with Couchbase Server, one can easily extend this to other NoSQL drivers as
-long as they `respond_to?` the `set`, `delete`, `replace`, and `get` methods.
+with Couchbase Server, it can be easily extended to other NoSQL databases, by
+creating a driver that `respond_to?` the `set`, `delete`, `replace`, and `get`
+methods.
 
 
 ## Features
@@ -29,7 +28,7 @@ long as they `respond_to?` the `set`, `delete`, `replace`, and `get` methods.
 
     class MyDocument < CouchPillow::Document
       type :my_document
-      attribute(:stuff)
+      attribute :stuff
     end
 
     CouchPillow.db = Couchbase.connect( bucket: 'default', host: 'localhost' )
@@ -39,9 +38,9 @@ long as they `respond_to?` the `set`, `delete`, `replace`, and `get` methods.
     # {
     #   '_id': 'my_document::fb579b265cc005c47ff420a5c2a15d2b',
     #   '_type': 'my_document',
-    #   'stuff': 'hello',
     #   '_created_at': '2014-07-04 00:00:00 UTC'
     #   '_updated_at': '2014-07-04 00:00:00 UTC'
+    #   'stuff': 'hello',
     # }
 
 
@@ -50,11 +49,11 @@ Retrieving Documents:
     doc = MyDocument.get('my_document::fb579b265cc005c47ff420a5c2a15d2b')
     doc.stuff # 'hello'
 
-Specifying custom id if the auto-generated id is too confusing:
+Specifying custom id:
 
     class User < CouchPillow::Document
       type :user
-      attribute(:email)
+      attribute :email
     end
 
     CouchPillow.db = Couchbase.connect( bucket: 'default', host: 'localhost' )
@@ -65,9 +64,9 @@ Specifying custom id if the auto-generated id is too confusing:
     # {
     #   '_id': '123',
     #   '_type': 'user',
+    #   '_created_at': '2014-07-04 00:00:00 UTC'
+    #   '_updated_at': '2014-07-04 00:00:00 UTC'
     #   'email': 'john@email.com',
-    #   'created_at': '2014-07-04 00:00:00 UTC'
-    #   'updated_at': '2014-07-04 00:00:00 UTC'
     # }
 
 ### Attributes
@@ -75,12 +74,15 @@ Specifying custom id if the auto-generated id is too confusing:
 Using Attribute Directives:
 
     class User < CouchPillow::Document
-      type              :user
-      attribute(:email)
-        .required
+      type :user
 
-      attribute(:first_name)
-        .type(String)
+      attribute :email do
+        required
+      end
+
+      attribute :first_name do
+        type String
+      end
     end
 
     CouchPillow.db = Couchbase.connect( bucket: 'default', host: 'localhost' )
@@ -102,19 +104,87 @@ List of Attribute Directives:
 
 * `auto_convert`
 
-   Enables auto-conversion to the specified type. This gets ignored if `type`
-   directive is not specified.
+  Enables auto-conversion to the specified type. This gets ignored if `type`
+  directive is not specified.
 
 * `default(&block)`
 
-   Runs the block to set the default value for this attribute, if it's missing
-   or nil.
+  Runs the block to set the default value for this attribute, if it's missing
+  or nil. This is triggered on document creation and save.
 
 * `content(&block)`
 
-   Custom validation method to check the value of the attribute. This is useful
-   in cases where you only want certain values to be stored (e.g a number
-   between 1-10 only)
+  Custom validation method to check the value of the attribute. This is useful
+  in cases where you only want certain values to be stored (e.g a number
+  between 1-10 only)
+
+
+### TTL Support
+
+TTL is supported by passing options when saving the document. Using the above
+example:
+
+    doc = User.new( { :email => 'john@email.com' } )
+    doc.save! ttl: 3600
+
+
+### Multiple DB Connections Support
+
+If you have a model that's accessing a different Couchbase bucket, or a
+different Couchbase DB cluster entirely, you can specify the connections
+via the `db` directive.  Example:
+
+    CouchPillow.db = Couchbase.connect( bucket: 'default', host: 'localhost' )
+    memcached = Couchbase.connect( bucket: 'mymemcache_bucket', host: '128.128.128.128' )
+
+    class User < CouchPillow::Document
+      type :user
+
+      attribute :first_name do
+        type String
+      end
+    end
+
+    class Token < CouchPillow::Document
+      type :token
+
+      db memcached
+
+      attribute :token do
+        type String
+      end
+    end
+
+    doc = User.new( { :first_name => 'John' } )
+    doc.save! # This gets saved to the localhost/bucket
+
+    token = Token.new( token: SecureRandom.uuid )
+    doc.save! # This gets saved to the 128.128.128.128/mymemcache_bucket
+
+
+You can also specify multiple `db` directives. The first time the `db`
+directive is called, it sets that connection as the primary connection, as the
+above example shows. Any subsequent calls will insert that DB connection as
+secondary connections, which will only be trigger on write (`save!`, `update!`,
+and `delete!`).
+
+
+    class Token < CouchPillow::Document
+      type :token
+
+      db primary_connection
+      db migration
+      db backup
+
+      attribute :token do
+        type String
+      end
+    end
+
+
+This can be useful as part of a migration process where you want to save
+incoming data to another cluster while keeping the old one active.
+
 
 
 ### Migration
@@ -124,7 +194,7 @@ after a migration.
 
     class User < CouchPillow::Document
       rename :username, :nickname
-      attribute(:nickname)
+      attribute :nickname
     end
     u = User.new( { :username => 'jdoe' } )
     u.nickname # 'jdoe'
@@ -138,11 +208,11 @@ as it reads them.
 
 ## Design Docs and Views
 
-What about Design Docs and Views? They are outside the scope of CouchPillow.
+Design Docs and Views are outside the scope of CouchPillow.
 However, given a design doc named `my_design_doc` and a View named `by_email`,
 that returns documents as values, you can easily use it like this:
 
     CouchPillow.db.design_docs['my_design_doc'].
-      by_email(:body => { :key => 'john@email.com' }).map do |v|
-        new User(v.doc, v.id)
+      by_email(:key => 'john@email.com').map do |v|
+        User.new(v.doc, v.id)
       end

data/couchpillow.gemspec

@@ -14,6 +14,10 @@ Gem::Specification.new do |s|
   s.test_files = `git ls-files -- {test}/*`.split("\n")
   s.require_paths = ["lib"]
 
+  s.required_ruby_version = '~> 2.0'
+
+  s.add_runtime_dependency 'celluloid', '~> 0.16'
+
   s.add_development_dependency 'minitest',  '~> 5.3'
   s.add_development_dependency 'mocha', '~> 1.1'
   s.add_development_dependency 'rake', '~> 10.3'

data/lib/couchpillow/document.rb

@@ -8,21 +8,25 @@ module CouchPillow
 
     RESERVED_KEYS = %i[_id _type _created_at _updated_at]
 
-    DEFAULT_TYPE = "default".freeze
+    DEFAULT_TYPE = "couchpillow".freeze
 
 
-    attribute(:_created_at)
-      .required
-      .type(Time).auto_convert
-      .default { Time.now.utc }
+    attribute :_created_at do
+      required
+      type Time
+      auto_convert
+      default { Time.now.utc }
+    end
 
-    attribute(:_updated_at)
-      .required
-      .type(Time).auto_convert
-      .default { Time.now.utc }
+    attribute :_updated_at do
+      required
+      type Time
+      auto_convert
+      default { Time.now.utc }
+    end
 
 
-    def initialize hash = {}, id = "#{self.class._type}::#{SecureRandom.hex}"
+    def initialize hash = {}, id = "#{self.class.doc_type}::#{SecureRandom.hex}"
       @data = self.class.symbolize(hash)
 
       @id = id
@@ -30,6 +34,8 @@ module CouchPillow
       @data[:_created_at] ||= time
       @data[:_updated_at] = time
 
+      @futures = []
+
       rename!
       whitelist!
       assign_defaults!
@@ -47,13 +53,6 @@ module CouchPillow
     end
 
 
-    # @private
-    #
-    def timestamp!
-      @data[:_updated_at] = Time.now.utc
-    end
-
-
     # Save this document to the server
     #
     def save! opts = {}
@@ -62,16 +61,38 @@ module CouchPillow
       timestamp!
       validate!
       to_save = @data.merge({
-        :_type => self.class._type
+        :_type => self.class.doc_type
       })
-      CouchPillow.db.set(@id, to_save, opts)
+
+      # write to all connections
+      result = self.class.default_db.set(@id, to_save, opts)
+
+      unless self.class.secondary_dbs.empty?
+        @futures << Celluloid::Future.new do
+          self.class.secondary_dbs.each do |db|
+            db.set(@id, to_save, opts)
+          end
+        end
+      end
+
+      result
     end
 
 
     # Delete this document from the server.
     #
     def delete!
-      CouchPillow.db.delete @id
+      result = self.class.default_db.delete @id
+
+      unless self.class.secondary_dbs.empty?
+        @futures << Celluloid::Future.new do
+          self.class.secondary_dbs.each do |db|
+            db.delete @id
+          end
+        end
+      end
+
+      result
     end
 
 
@@ -84,9 +105,20 @@ module CouchPillow
       timestamp!
       validate!
       to_save = @data.merge({
-        :_type => self.class._type
+        :_type => self.class.doc_type
       })
-      CouchPillow.db.replace @id, to_save
+
+      result = self.class.default_db.replace @id, to_save
+
+      unless self.class.secondary_dbs.empty?
+        @futures << Celluloid::Future.new do
+          self.class.secondary_dbs.each do |db|
+            db.replace @id, to_save
+          end
+        end
+      end
+
+      result
     end
 
 
@@ -100,21 +132,50 @@ module CouchPillow
       end
       rename!
       whitelist!
+      auto_convert!
     end
 
 
+    # Check if this Document has the key
+    #
     def has? key
       @data.has_key?(key)
     end
 
 
+    # Convert this Document to a JSON string
+    #
     def to_json *a
       to_hash.to_json(*a)
     end
 
 
+    # Convert this Document to a Hash
+    #
     def to_hash
-      { :_id => @id, :_type => self.class._type }.merge!(@data)
+      { :_id => @id, :_type => self.class.doc_type }.merge!(@data)
+    end
+
+
+    # Helper to get the type of this Document.
+    # Can't really name this `type`. Need to avoid name conflict with Ruby's own `type` method.
+    #
+    def doc_type
+      self.class.doc_type
+    end
+
+
+    # Blocks until all pending tasks has completed. 
+    # Returns the result of those tasks in an array.
+    #
+    def wait
+      result = []
+      until @futures.empty?
+        f = @futures.shift
+        result << f.value
+      end
+
+      result
     end
 
 
@@ -138,7 +199,7 @@ module CouchPillow
     end
 
 
-    # Assign default value
+    # Assign default values.
     #
     def assign_defaults!
       self.class.attributes.each do |k, attr|
@@ -157,13 +218,12 @@ module CouchPillow
 
 
     # Go through each attribute, and validate the values.
-    # Validation also perform auto-conversion if auto-conversion is enabled
-    # for that attribute.
+    # Validation also perform auto-conversion if auto-conversion is enabled for that attribute.
     #
     def validate!
       self.class.attributes.each do |k, attr|
         if has?(k)
-          @data[k] = attr.validate(@data[k]) if has?(k)
+          @data[k] = attr.validate(@data[k])
         else
           @data[k] = attr.trigger_default_directive if attr.has_default?
           raise ValidationError, "Attribute '#{k}' is required" if attr.required? && !has?(k)
@@ -179,24 +239,14 @@ module CouchPillow
     end
 
 
-    def _type
-      self.class._type
-    end
-
-
-    def _id
-      @id
-    end
-
-
     # Get a Document given an id.
     #
     # @return nil if not found or Document is of a different type.
     #
     def self.get id
-      result = CouchPillow.db.get(id) and
+      result = default_db.get(id) and
         type = result[:_type] || result["_type"] and
-        type == _type and
+        type == doc_type and
         new(result, id) or
         nil
     end
@@ -220,10 +270,37 @@ module CouchPillow
     end
 
 
+    # Set a DB connection. Overrides the default CouchPillow.db connection
+    # for the first time this method gets called. Subsequent calls will set
+    # secondary connections, which will only be used for write only.
+    #
+    # Example:
+    #    db primary_db # use for both read and write
+    #    db backup_db1 # write only
+    #    db backup_db2 # write only
+    #
+    def self.db conn
+      # set the primary db connection
+      @primary_db ||= conn
+
+      # insert as backup db connections
+      if conn && @primary_db && conn != @primary_db
+        secondary_dbs << conn
+      end
+    end
+
+
     private
 
 
-    def self._type
+    # Timestamp this document
+    #
+    def timestamp!
+      @data[:_updated_at] = Time.now.utc
+    end
+
+
+    def self.doc_type
       @type ||= DEFAULT_TYPE
     end
 
@@ -233,6 +310,16 @@ module CouchPillow
     end
 
 
+    def self.default_db
+      @default_db ||= (@primary_db || CouchPillow.db)
+    end
+
+
+    def self.secondary_dbs
+      @secondary_dbs ||= []
+    end
+
+
     def self.symbolize hash
       hash.inject({}) do |memo,(k,v)|
         memo[k.to_sym] = v

data/lib/couchpillow/version.rb

@@ -1,5 +1,5 @@
 module CouchPillow
   GEM_NAME = "couchpillow"
   NAME = "CouchPillow"
-  VERSION = "0.4.3"
+  VERSION = "0.4.4"
 end

data/lib/couchpillow.rb

@@ -1,9 +1,12 @@
 require 'securerandom'
 require 'json'
 require 'time'
+require 'celluloid/autostart'
 
 module CouchPillow
 
+  Celluloid.logger = nil
+
   def self.db= driver
     @db = driver
   end

data/test/test_document.rb

@@ -33,7 +33,7 @@ class TestDocument < Minitest::Test
 
   def test_default_type
     d = Document.new({}, "1")
-    assert_equal "default", d._type
+    assert_equal "couchpillow", d.doc_type
   end
 
 
@@ -41,7 +41,7 @@ class TestDocument < Minitest::Test
     d = Class.new(Document) do
       type 'test'
     end.new
-    assert_equal "test", d._type
+    assert_equal "test", d.doc_type
   end
 
 
@@ -124,14 +124,14 @@ class TestDocument < Minitest::Test
   def test_to_json
     mock_time
     d = Document.new({}, "1")
-    assert_equal "{\"_id\":\"1\",\"_type\":\"default\",\"_created_at\":\"#{mock_time.to_s}\",\"_updated_at\":\"#{mock_time.to_s}\"}", d.to_json
+    assert_equal "{\"_id\":\"1\",\"_type\":\"couchpillow\",\"_created_at\":\"#{mock_time.to_s}\",\"_updated_at\":\"#{mock_time.to_s}\"}", d.to_json
   end
 
 
   def test_to_hash
     mock_time
     d = Document.new({}, "1")
-    assert_equal({ :_id => "1", :_created_at => mock_time, :_type => "default", :_updated_at => mock_time }, d.to_hash)
+    assert_equal({ :_id => "1", :_created_at => mock_time, :_type => "couchpillow", :_updated_at => mock_time }, d.to_hash)
   end
   
 
@@ -201,7 +201,7 @@ class TestDocument < Minitest::Test
     k = klass.new
     k.foo = 100
     k.save!
-    k_id = k._id
+    k_id = k.id
 
     d = klass.get(k_id)
     assert_equal 100, d.foo
@@ -210,6 +210,7 @@ class TestDocument < Minitest::Test
 
   def test_get_returns_nil
     CouchPillow.db.expects(:get).with('123').returns(nil)
+    Document.expects(:default_db).returns(CouchPillow.db)
     d = Document.get('123')
     assert_equal nil, d
   end
@@ -338,6 +339,25 @@ class TestDocument < Minitest::Test
   end
 
 
+  def test_auto_convert_triggers_on_update
+    d = Class.new(Document) do
+      type 'test'
+
+      attribute :foo do
+        type(String)
+        auto_convert
+      end
+
+      attribute :not_auto do
+        type Integer
+      end
+    end.new( foo: 1, not_auto: "100" )
+
+    d.update( foo: 1776 )
+    assert_equal "1776", d.foo
+  end
+
+
   def test_dsl_style
     d = Class.new(Document) do
       type 'test'
@@ -393,4 +413,77 @@ class TestDocument < Minitest::Test
     d.save! ttl: 100
   end
 
+
+  def test_custom_db_connection
+    conn1 = FakeCouchbaseServer.new
+
+    d = Class.new(Document) do
+      type 'test'
+
+      db conn1
+
+      attribute :foo do
+        type String
+        auto_convert
+        required
+        default { "tester" }
+      end
+
+
+      def initialize doc = {}
+        super(doc, "1")
+      end
+
+    end.new
+    d.foo = "hello"
+    d.save!
+
+    fromdefdb = CouchPillow.db.get("1")
+    assert_nil fromdefdb
+
+    fromprimdb = conn1.get("1")
+    assert_equal "hello", fromprimdb[:foo]
+  end
+
+
+  def test_multiple_db_connections
+    db1 = FakeCouchbaseServer.new
+    db2 = FakeCouchbaseServer.new
+    db3 = FakeCouchbaseServer.new
+
+    d = Class.new(Document) do
+      type 'test'
+
+      db db1
+      db db2
+      db db3
+
+      attribute :foo do
+        type String
+        auto_convert
+        required
+        default { "tester" }
+      end
+
+
+      def initialize doc = {}
+        super(doc, "1")
+      end
+
+    end.new
+    d.foo = "hello"
+    d.save!
+
+    res = d.wait
+
+    data = db1.get("1")
+    assert_equal "hello", data[:foo]
+
+    data = db2.get("1")
+    assert_equal "hello", data[:foo]
+
+    data = db3.get("1")
+    assert_equal "hello", data[:foo]
+  end
+
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: couchpillow
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Albert Tedja
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-11 00:00:00.000000000 Z
+date: 2015-03-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: celluloid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -83,9 +97,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="