riagent 0.0.2 → 0.0.3

data/lib/riagent/persistence/riak_dt_set_strategy.rb

@@ -0,0 +1,101 @@
+## -------------------------------------------------------------------
+##
+## Copyright (c) "2014" Dmitri Zagidulin
+##
+## This file is provided to you under the Apache License,
+## Version 2.0 (the "License"); you may not use this file
+## except in compliance with the License.  You may obtain
+## a copy of the License at
+##
+##   http://www.apache.org/licenses/LICENSE-2.0
+##
+## Unless required by applicable law or agreed to in writing,
+## software distributed under the License is distributed on an
+## "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+## KIND, either express or implied.  See the License for the
+## specific language governing permissions and limitations
+## under the License.
+##
+## -------------------------------------------------------------------
+
+require "riak"
+require "riagent/persistence/riak_kv_strategy"
+
+module Riagent
+  module Persistence
+    class RiakDTSetStrategy < RiakKVStrategy
+      attr_writer :key_list_set
+      
+      # Adds a key to the collection key list (usually done as part of an insert)
+      # Added as a standalone method for ease of testing
+      # @param [String] key Key to be added to list
+      def add_key(key)
+        self.key_list_set.add(key)
+      end
+      
+      # Return all the documents in the collection.
+      # Uses Riak 2.0 CRDT Set Data type to keep track of collection key list
+      # @param [Integer] results_limit Number of results returned (currently ignored)
+      # @return [Array<Riagent::ActiveDocument>] List of ActiveDocument instances
+      def all(results_limit)
+        keys = self.all_keys
+        # TODO: Trim keys to results_limit
+        all_docs_hash = self.bucket.get_many(keys)
+        all_docs_hash.values
+      end
+      
+      # Return all keys in the collection
+      # @return [Array<String>] List of all keys in the collection
+      def all_keys
+        self.key_list_set.members.to_a
+      end
+      
+      # Deletes a key from the key list (usually called by remove()).
+      def delete_key(key)
+        key_list_set = self.key_list_set.reload
+        key_list_set.remove(key)
+      end
+      
+      # Clears the key list set
+      def delete_key_list
+        # Perform a Riak DELETE operation (using the bucket type interface)
+        self.key_lists_bucket.delete self.key_list_set_name, type: 'sets'
+      end
+      
+      # Insert a document into the collection.
+      # Also inserts the document's key into the key list set.
+      # @param [RiakJson::ActiveDocument] document Document to be inserted
+      # @return [String] Document key
+      def insert(document)
+        doc_key = super
+        self.add_key(doc_key)
+        doc_key
+      end
+      
+      # Return the Crdt Set object that keeps track of keys in this collection
+      # @return [Riak::Crdt::Set]
+      def key_list_set 
+        # Note: Assumes that the Bucket Type for Sets is the default 'sets'
+        @key_list_set || Riak::Crdt::Set.new(self.key_lists_bucket, self.key_list_set_name)
+      end
+      
+      # Return the key name of the set that keeps track of keys in this collection
+      # @return [String]
+      def key_list_set_name
+        '_rg_keys_' + self.collection_name()
+      end
+      
+      # Return the bucket in which the Riagent collection key lists are kept
+      # @return [Riak::Bucket]
+      def key_lists_bucket
+        self.client.bucket('_rg_key_lists')
+      end
+      
+      def remove(document)
+        doc_key = document.key
+        super
+        self.delete_key(doc_key)
+      end
+    end
+  end
+end

data/lib/riagent/persistence/riak_kv_strategy.rb

@@ -0,0 +1,114 @@
+## -------------------------------------------------------------------
+##
+## Copyright (c) "2014" Dmitri Zagidulin
+##
+## This file is provided to you under the Apache License,
+## Version 2.0 (the "License"); you may not use this file
+## except in compliance with the License.  You may obtain
+## a copy of the License at
+##
+##   http://www.apache.org/licenses/LICENSE-2.0
+##
+## Unless required by applicable law or agreed to in writing,
+## software distributed under the License is distributed on an
+## "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+## KIND, either express or implied.  See the License for the
+## specific language governing permissions and limitations
+## under the License.
+##
+## -------------------------------------------------------------------
+
+require "riak"
+require "riagent/persistence/persistence_strategy"
+
+module Riagent
+  module Persistence
+    # General Riak Key/Value persistence strategy. 
+    # Read and Write documents as Riak objects. 
+    # The listing/indexing method will depend on subclass
+    class RiakKVStrategy < PersistenceStrategy
+      attr_writer :bucket
+      
+      # @return [Boolean] Does this persistence strategy support querying?
+      def allows_query?
+        false
+      end
+      
+      # @return [Riak::Bucket] Riak bucket associated with this model/collection
+      def bucket
+        @bucket ||= self.client.bucket(self.collection_name)
+      end
+      
+      # @return [Riak::Client] Riak client (lazy-initialized, cached in current Thread)
+      def client
+        @client ||= Riagent.riak_client  # See lib/configuration.rb
+      end
+
+      # Fetch a document by key.
+      # @param [String] key
+      # @return [ActiveDocument|nil]
+      def find(key)
+        begin
+          result = self.bucket.get(key)
+        rescue Riak::FailedRequest => fr
+          if fr.not_found?
+            result = nil
+          else
+            raise fr
+          end
+        end
+        self.from_riak_object(result)
+      end
+      
+      # Converts from a Riak::RObject instance to an instance of ActiveDocument
+      # @param [Riak::RObject] riak_object
+      # @param [Boolean] persisted Mark the document as persisted/not new?
+      # @return [ActiveDocument|nil] ActiveDocument instance, or nil if the Riak Object is nil
+      def from_riak_object(riak_object, persisted=true)
+        return nil if riak_object.nil?
+        active_doc_instance = self.model_class.from_json(riak_object.raw_data, riak_object.key)
+        if persisted
+          active_doc_instance.persist!  # Mark as persisted / not new
+        end
+        active_doc_instance.source_object = riak_object
+        active_doc_instance
+      end
+      
+      # @param [RiakJson::ActiveDocument] document Document to be inserted
+      # @return [String] Document key
+      def insert(document)
+        if document.key.present?
+          # Attempt to fetch existing object, just in case
+          riak_object = self.bucket.get_or_new(document.key)
+        else
+          riak_object = self.new_riak_object()
+        end
+        riak_object.raw_data = document.to_json_document
+        riak_object = riak_object.store
+        document.source_object = riak_object  # store the riak object in document
+        document.key = riak_object.key
+      end
+      
+      # @param [String|nil] Optional key
+      # @return [Riak::RObject] New Riak object instance for this model/collection
+      def new_riak_object(key=nil)
+        Riak::RObject.new(self.bucket, key).tap do |obj|
+          obj.content_type = "application/json"
+        end
+      end
+      
+      # Deletes the riak object that stores the document
+      # @param [RiakJson::ActiveDocument] document Document to be deleted
+      def remove(document)
+        self.new_riak_object(document.key).delete
+        document.source_object = nil
+      end
+      
+      # @param [RiakJson::ActiveDocument] document Document to be updated
+      # @return [Integer] Document key
+      def update(document)
+        self.insert(document)
+      end
+    end
+  end
+end

data/lib/riagent/persistence/riak_no_index_strategy.rb

@@ -1,6 +1,6 @@
 ## -------------------------------------------------------------------
 ##
-## Copyright (c) "2014" Dmitri Zagidulin and Basho Technologies, Inc.
+## Copyright (c) "2014" Dmitri Zagidulin
 ##
 ## This file is provided to you under the Apache License,
 ## Version 2.0 (the "License"); you may not use this file
@@ -19,13 +19,11 @@
 ## -------------------------------------------------------------------
 
 require "riak"
-require "riagent/persistence/persistence_strategy"
+require "riagent/persistence/riak_kv_strategy"
 
 module Riagent
   module Persistence
-    class RiakNoIndexStrategy < PersistenceStrategy
-      attr_writer :bucket
-      
+    class RiakNoIndexStrategy < RiakKVStrategy
       # Return all the documents in the collection.
       # Since this is a "no index" strategy, this can only be done via a streaming list keys
       # @param [Integer] results_limit Number of results returned (currently ignored)
@@ -36,87 +34,6 @@ module Riagent
           obj ? acc << obj : acc
         end
       end
-      
-      # @return [Boolean] Does this persistence strategy support querying?
-      def allows_query?
-        false
-      end
-      
-      # @return [Riak::Bucket] Riak bucket associated with this model/collection
-      def bucket
-        @bucket ||= self.client.bucket(self.collection_name)
-      end
-      
-      # @return [Riak::Client] Riak client (lazy-initialized, cached in current Thread)
-      def client
-        @client ||= Riagent.riak_client  # See lib/configuration.rb
-      end
-
-      # Fetch a document by key.
-      # @param [String] key
-      # @return [ActiveDocument|nil]
-      def find(key)
-        begin
-          result = self.bucket.get(key)
-        rescue Riak::FailedRequest => fr
-          if fr.not_found?
-            result = nil
-          else
-            raise fr
-          end
-        end
-        self.from_riak_object(result)
-      end
-      
-      # Converts from a Riak::RObject instance to an instance of ActiveDocument
-      # @param [Riak::RObject] riak_object
-      # @param [Boolean] persisted Mark the document as persisted/not new?
-      # @return [ActiveDocument|nil] ActiveDocument instance, or nil if the Riak Object is nil
-      def from_riak_object(riak_object, persisted=true)
-        return nil if riak_object.nil?
-        active_doc_instance = self.model_class.from_json(riak_object.raw_data, riak_object.key)
-        if persisted
-          active_doc_instance.persist!  # Mark as persisted / not new
-        end
-        active_doc_instance.source_object = riak_object
-        active_doc_instance
-      end
-      
-      # @param [RiakJson::ActiveDocument] document Document to be inserted
-      # @return [Integer] Document key
-      def insert(document)
-        if document.key.present?
-          # Attempt to fetch existing object, just in case
-          riak_object = self.bucket.get_or_new(document.key)
-        else
-          riak_object = self.new_riak_object()
-        end
-        riak_object.raw_data = document.to_json_document
-        riak_object = riak_object.store
-        document.source_object = riak_object  # store the riak object in document
-        document.key = riak_object.key
-      end
-      
-      # @param [String|nil] Optional key
-      # @return [Riak::RObject] New Riak object instance for this model/collection
-      def new_riak_object(key=nil)
-        Riak::RObject.new(self.bucket, key).tap do |obj|
-          obj.content_type = "application/json"
-        end
-      end
-      
-      # Deletes the riak object that stores the document
-      # @param [RiakJson::ActiveDocument] document Document to be deleted
-      def remove(document)
-        self.new_riak_object(document.key).delete
-        document.source_object = nil
-      end
-      
-      # @param [RiakJson::ActiveDocument] document Document to be updated
-      # @return [Integer] Document key
-      def update(document)
-        self.insert(document)
-      end
     end
   end
 end

data/lib/riagent/version.rb

@@ -1,6 +1,6 @@
 ## ------------------------------------------------------------------- 
 ## 
-## Copyright (c) "2014" Dmitri Zagidulin and Basho Technologies, Inc.
+## Copyright (c) "2014-2015" Dmitri Zagidulin
 ##
 ## This file is provided to you under the Apache License,
 ## Version 2.0 (the "License"); you may not use this file
@@ -19,5 +19,5 @@
 ## -------------------------------------------------------------------
 
 module Riagent
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/riagent.gemspec

@@ -28,8 +28,8 @@ Gem::Specification.new do |spec|
   spec.version       = Riagent::VERSION
   spec.authors       = ["Dmitri Zagidulin"]
   spec.email         = ["dzagidulin@gmail.com"]
-  spec.summary       = %q{Rails integration for RiakJson document store}
-  spec.description   = %q{Provides Ruby on Rails integration for RiakJson (Riak + Solr document store API)}
+  spec.summary       = %q{Rails integration for the Riak KV NoSQL database}
+  spec.description   = %q{Provides Ruby on Rails integration for the Riak KV NoSQL database (plus Solr search)}
   spec.homepage      = "https://github.com/dmitrizagidulin/riagent"
   spec.license       = "Apache 2.0"
 
@@ -39,13 +39,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "riak_json"
-  spec.add_runtime_dependency "riak-client"
+  spec.add_runtime_dependency "riak-client", "~> 2.0.0.rc1"
   spec.add_runtime_dependency "riagent-document"
   spec.add_runtime_dependency "activemodel", "~> 4.0"
   spec.add_runtime_dependency "activesupport", "~> 4.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest", "~> 4.2"
+  spec.add_development_dependency "minitest", "~> 4.7"
   spec.add_development_dependency "minitest-spec-context"
 end

data/test/config/riak.yml.example

@@ -4,16 +4,16 @@
 # Configure Riak and RiakJson connections for the client, by environment
 development:
   http_port: 8098
-  pb_port: 8097   # Protocol Buffer port
+  pb_port: 8087   # Protocol Buffer port
   host: 127.0.0.1
 
 # You should spin up another Riak instance to use as a test server
 test:
   http_port: 8098
-  pb_port: 8097
+  pb_port: 8087
   host: 127.0.0.1
 
 production:
   http_port: 8098
-  pb_port: 8097
+  pb_port: 8087
   host: 127.0.0.1

data/test/examples/models/category.rb

@@ -0,0 +1,34 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin
+##
+## This file is provided to you under the Apache License,
+## Version 2.0 (the "License"); you may not use this file
+## except in compliance with the License.  You may obtain
+## a copy of the License at
+##
+##   http://www.apache.org/licenses/LICENSE-2.0
+##
+## Unless required by applicable law or agreed to in writing,
+## software distributed under the License is distributed on an
+## "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+## KIND, either express or implied.  See the License for the
+## specific language governing permissions and limitations
+## under the License.
+##
+## -------------------------------------------------------------------
+
+class Category
+  include Riagent::ActiveDocument
+  
+  # Persist to a Riak::Bucket, keep track of keys in a server-side Set CRDT data type
+  collection_type :riak_kv, list_keys_using: :riak_dt_set
+  
+  # Explicit attributes
+  # key is an implied attribute, present in all ActiveDocument instances
+  attribute :name, String
+  attribute :description, String, default: ''
+  
+  # Validations
+  validates_presence_of :name
+end

data/test/examples/models/contact.rb

@@ -24,6 +24,9 @@
 class Contact
   include Riagent::ActiveDocument
   
+  # Persist to a Riak::Bucket, keep track of keys via a streaming List Keys operation (not recommended)
+  collection_type :riak_kv, list_keys_using: :streaming_list_keys
+  
   attribute :contact_name, String
   attribute :contact_email, String
 end

data/test/examples/models/user_preference.rb

@@ -20,8 +20,9 @@
 
 class UserPreference
   include Riagent::ActiveDocument
-  
-  collection_type :riak_no_index  # Persist to a plain Riak bucket (k/v only)
+
+  # Persist to a Riak::Bucket
+  collection_type :riak_kv
   
   # Explicit attributes
   # (key is an implied attribute, present in all ActiveDocument instances)