riagent 0.0.1

data/lib/riagent/active_document.rb

@@ -0,0 +1,53 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin and Basho Technologies, Inc.
+##
+## 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 'active_support/concern'
+require "active_model"
+require "active_model/naming"
+require 'riagent/document'
+require 'riagent/conversion'
+require 'riagent/persistence'
+require 'riagent/associations'
+require 'riagent/search_schema'
+
+module Riagent
+  module ActiveDocument
+    extend ActiveSupport::Concern
+    extend ActiveModel::Naming
+    include ActiveModel::Validations
+    
+    included do
+      include Riagent::Document
+      include Riagent::Conversion
+      include Riagent::Persistence
+      include Riagent::Associations
+      extend Riagent::SearchSchema
+    end
+    
+    module ClassMethods
+      # Returns string representation for the collection name
+      # Used to determine the RiakJson::Collection name, or the Riak Bucket name
+      # Uses ActiveModel::Naming functionality to derive the name
+      def collection_name
+        self.model_name.plural
+      end
+    end
+  end
+end

data/lib/riagent/associations.rb

@@ -0,0 +1,119 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin and Basho Technologies, Inc.
+##
+## 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 "active_support/concern"
+
+module Riagent
+  module Associations
+    extend ActiveSupport::Concern
+    
+    module ClassMethods
+      def has_many(name, options={})
+        query_type = options[:using]
+        target_class = options[:class]
+        case query_type
+        when :solr
+          has_many_using_solr(name, target_class, query_type, options)
+        else
+          raise ArgumentError, ":using query type not supported"
+        end
+      end
+      
+      # Create a has_many association where the collection will be loaded
+      # via RiakJson Solr queries.
+      def has_many_using_solr(name, target_class, query_type, options)
+        target_getter_method = "#{name}".to_sym
+        
+        # Create a <target name>_cache attribute accessors
+        # These will be used to store the actual loaded collection
+        target_cache_attribute = "#{name}_cache".to_sym
+        attr_accessor target_cache_attribute
+        
+        # Create the getter method
+        define_method(target_getter_method) do
+          # First, check to see if the target collection has already been loaded/cached
+#          cached_collection = send(target_cache_attribute)
+#          if cached_collection.nil?
+#            
+#            source_key_value = send(:key)  # Get the source (parent) id
+#            cached_collection = target_class.find(target_key)
+#            send(target_setter_method, cached_collection)  # Cache the loaded target collection
+#          end
+#          cached_value
+        end
+        
+        target_setter_method = "#{name}=".to_sym
+        
+        # Create the setter method=
+        define_method(target_setter_method) do | target |
+        end
+      end
+      
+      def has_one(name, options={})
+        target_key_attribute = "#{name}_key"
+        target_class = options[:class]
+        
+        # Create a <target name>_key attribute, 
+        attribute target_key_attribute, String, default: ''
+        
+        # Create a <target name>_cache attribute accessors
+        # These will be used to store the actual instance of the target
+        target_cache_attribute = "#{name}_cache".to_sym
+        attr_accessor target_cache_attribute
+          
+        target_getter_method = "#{name}".to_sym
+        target_setter_method = "#{name}=".to_sym
+        
+        # Create the setter method=
+        define_method(target_setter_method) do | target |
+          # Only assignments of the correct target class are allowed
+          unless target.kind_of? target_class
+            raise ArgumentError, "Invalid argument type #{target.class}, #{target_class} expected."
+          end
+          target_key = target ? target.key : nil
+          attribute_setter = "#{target_key_attribute}=".to_sym
+          send(attribute_setter, target_key)
+          attribute_cache_getter = "#{target_cache_attribute}="
+          send(attribute_cache_getter, target)
+        end
+
+        # Create the getter method
+        define_method(target_getter_method) do
+          # First, check to see if the target instance has already been loaded/cached
+          cached_value = send(target_cache_attribute)
+          if cached_value.nil?
+            target_key = send(target_key_attribute)
+            cached_value = target_class.find(target_key)
+            send(target_setter_method, cached_value)  # Cache the loaded target instance
+          end
+          cached_value
+        end
+        
+        # Create build_<target> method
+        build_helper_method = "build_#{name}".to_sym
+        define_method(build_helper_method) do | attributes |
+          target_instance = target_class.new attributes
+          target_instance.key = self.key # The target object gets the source's key by default
+          send(target_setter_method, target_instance)
+        end
+      end
+    end
+  end
+end

data/lib/riagent/configuration.rb

@@ -0,0 +1,73 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin and Basho Technologies, Inc.
+##
+## 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 "active_support/concern"
+
+module Riagent
+  module Configuration
+    def config
+      @config ||= {}
+    end
+
+    def config=(value)
+      @config = value
+    end
+    
+    def config_for(environment=:development)
+      if self.config.present?
+        env_config = self.config[environment.to_s]
+      else
+        env_config = {
+          'host' => ENV['RIAK_HOST'],
+          'http_port' => ENV['RIAK_HTTP_PORT'],
+          'pb_port' => ENV['RIAK_PB_PORT']
+        }
+      end
+      env_config
+    end
+    
+    def init_clients(environment=:development)
+      self.init_riak_json_client(environment)
+    end
+    
+    def init_riak_json_client(environment=:development)
+      env_config = self.config_for(environment)
+      client = RiakJson::Client.new(env_config['host'], env_config['http_port'])
+      self.riak_json_client = client
+    end
+    
+    def load_config_file(config_file_path)
+      config_file = File.expand_path(config_file_path)
+      config_hash = YAML.load(ERB.new(File.read(config_file)).result)
+      self.config = config_hash
+    end
+    
+    # @return [RiakJson::Client] The client for the current thread.
+    def riak_json_client
+      Thread.current[:riak_json_client] ||= nil
+    end
+  
+    # Sets the client for the current thread.
+    # @param [RiakJson::Client] value the client
+    def riak_json_client=(value)
+      Thread.current[:riak_json_client] = value
+    end
+  end
+end

data/lib/riagent/conversion.rb

@@ -0,0 +1,83 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin and Basho Technologies, Inc.
+##
+## 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 'active_model'
+require 'active_model/conversion'
+
+module Riagent
+  module Conversion
+    # Has this document been deleted?
+    # Required by ActiveModel::Conversion API
+    # @return [Boolean]
+    def destroyed?
+      @destroyed ||= false
+    end
+    
+    # Is this a new, unsaved document?
+    # Required by ActiveModel::Conversion API
+    # @return [Boolean]
+    def new_record?
+      !persisted?
+    end
+    
+    # Mark the document as saved/persisted
+    # Called by +save+, and when instantiating query results (see ::Persistence)
+    def persist!
+      @persisted = true
+    end
+    
+    # Has this document been saved to RiakJson?
+    # Required by ActiveModel::Conversion API
+    # @return [Boolean]
+    def persisted?
+      @persisted ||= false
+    end
+    
+    # Returns an Enumerable of all key attributes if any is set, or +nil+ if
+    # the document is not persisted
+    # Required by ActiveModel::Conversion API
+    def to_key
+      self.new_record? ? nil : [self.key]
+    end
+    
+    # Returns an instance of an ActiveModel object (ie, itself)
+    # Required by ActiveModel::Conversion API
+    def to_model
+      self
+    end
+    
+    # Returns a +string+ representing the object's key suitable for use in URLs,
+    # or +nil+ if <tt>persisted?</tt> is +false+.
+    # Required by ActiveModel::Conversion API
+    # @return [String, nil]
+    def to_param
+      self.key
+    end
+    
+    # Returns a +string+ identifying the path associated with the object.
+    # ActionPack uses this to find a suitable partial to represent the object.
+    # Used in Rails helper methods such as +link_to+
+    # Required by ActiveModel::Conversion API
+    # @return [String]
+    def to_partial_path
+      "#{self.class.collection_name}/#{self.key}"
+    end
+  end
+end

data/lib/riagent/errors.rb

@@ -0,0 +1,33 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin and Basho Technologies, Inc.
+##
+## 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.
+##
+## -------------------------------------------------------------------
+
+module Riagent
+  # Generic Riagent exception class
+  class RiagentError < StandardError
+  end
+  
+  # Raised by <tt>save!</tt> when a document does not pass validation
+  class InvalidDocumentError < RiagentError
+    attr_reader :document # :nodoc:
+    def initialize(document) # :nodoc:
+      @document = document
+    end
+  end
+end

data/lib/riagent/persistence/riak_json_strategy.rb

@@ -0,0 +1,62 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin and Basho Technologies, Inc.
+##
+## 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_json"
+require "active_support/concern"
+
+module Riagent
+  module Persistence
+    module RiakJsonStrategy
+      extend ActiveSupport::Concern
+      
+      module ClassMethods
+        def client
+          @client ||= Riagent.riak_json_client
+        end
+        
+        def client=(client)
+          @client = client
+        end
+        
+        # Returns a RiakJson::Collection instance for this document
+        def collection
+          @collection ||= self.client.collection(self.collection_name)
+        end
+        
+        # Sets the RiakJson::Collection instance for this document
+        def collection=(collection_obj)
+          @collection = collection_obj
+        end
+        
+        # Converts from a RiakJson::Document instance to an instance of ActiveDocument
+        # @return [ActiveDocument, nil] ActiveDocument instance, or nil if the Document is nil
+        def from_rj_document(doc, persisted=false)
+          return nil if doc.nil?
+          active_doc_instance = self.instantiate(doc.attributes)
+          active_doc_instance.key = doc.key
+          if persisted
+            active_doc_instance.persist!  # Mark as persisted / not new
+          end
+          active_doc_instance
+        end
+      end
+    end
+  end
+end

data/lib/riagent/persistence.rb

@@ -0,0 +1,166 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin and Basho Technologies, Inc.
+##
+## 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 "active_support/concern"
+require "riagent/persistence/riak_json_strategy"
+
+module Riagent
+  module Persistence
+    extend ActiveSupport::Concern
+    
+    included do
+      extend ActiveModel::Callbacks
+      define_model_callbacks :create, :update, :save, :destroy
+    end
+    
+    # Delete the document from its collection
+    def destroy
+      run_callbacks(:destroy) do
+        self.class.collection.remove(self)
+        @destroyed = true
+      end
+    end
+    
+    # Performs validations and saves the document
+    # The validation process can be skipped by passing <tt>validate: false</tt>.
+    # Also triggers :before_create / :after_create type callbacks
+    # @return [String] Returns the key for the inserted document
+    def save(options={:validate => true})
+      context = new_record? ? :create : :update
+      return false if options[:validate] && !valid?(context)
+      
+      run_callbacks(context) do
+        result = self.class.collection.insert(self)
+        self.persist!
+        result
+      end
+    end
+    
+    # Attempts to validate and save the document just like +save+ but will raise a +Riagent::InvalidDocumentError+
+    # exception instead of returning +false+ if the doc is not valid.
+    def save!(options={:validate => true})
+      unless save(options)
+        raise Riagent::InvalidDocumentError.new(self)
+      end
+      true
+    end
+    
+    # Update an object's attributes and save it
+    def update(attrs)
+      run_callbacks(:update) do
+        self.attributes = attrs
+        self.save
+      end
+    end
+    
+    # Perform an update(), raise an error if the doc is not valid
+    def update!(attrs)
+      unless update(attrs)
+        raise Riagent::InvalidDocumentError.new(self)
+      end
+      true
+    end
+    
+    # Update attributes (alias for update() for Rails versions < 4)
+    def update_attributes(attrs)
+      self.update(attrs)
+    end
+    
+    module ClassMethods
+      # Returns all documents (within results/pagination limit) 
+      #  from a collection.
+      # Implemented instead of all() to get around current RiakJson API limitations
+      # @param [String,Symbol] Name of a document field
+      # @param [Integer] Optional results limit
+      # @return [Array] of ActiveDocument instances
+      def all_for_field(field_name, results_limit=1000)
+        query = {
+            field_name => {'$regex' => "/.*/"},
+            '$per_page'=>results_limit
+        }.to_json
+        result = self.collection.find_all(query)
+        if result.present?
+          result.documents.map {|doc| self.from_rj_document(doc, persisted=true) }
+        end
+      end
+      
+      # Determines the document's persistence strategy
+      # Valid options: [:riak_json]
+      # Usage:
+      # <code>
+      # class SomeModel
+      #   include Riagent::ActiveDocument
+      #   collection_type :riak_json  # persist to a RiakJson::Collection
+      # end
+      # </code>
+      def collection_type(coll_type)
+        @collection_type = coll_type
+        case @collection_type
+        when :riak_json
+          self.persistence_strategy = :riak_json
+          include Riagent::Persistence::RiakJsonStrategy
+        end
+      end
+      
+      # Load a document by key.
+      def find(key)
+        return nil if key.nil? or key.empty?
+        doc = self.collection.find_by_key(key)
+        self.from_rj_document(doc, persisted=true)
+      end
+      
+      # Return the first document that matches the query
+      def find_one(query)
+        if query.kind_of? Hash
+          query = query.to_json
+        end
+        doc = self.collection.find_one(query)
+        if doc.present?
+          self.from_rj_document(doc, persisted=true) 
+        end
+      end
+      
+      def get_collection_type
+        @collection_type ||= nil
+      end
+      
+      def persistence_strategy
+        @persistence_strategy ||= nil
+      end
+      
+      def persistence_strategy=(strategy)
+        @persistence_strategy = strategy
+      end
+      
+      # Return all documents that match the query
+      def where(query)
+        if query.kind_of? Hash
+          query = query.to_json
+        end
+        result = self.collection.find_all(query)
+        if result.present?
+          result.documents.map do |doc| 
+            self.from_rj_document(doc, persisted=true)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/riagent/railtie.rb

@@ -0,0 +1,35 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin and Basho Technologies, Inc.
+##
+## 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 'rails/railtie'
+require 'riak_json'
+
+module Riagent
+  # Railtie for Rails integration and initialization
+  class Railtie < Rails::Railtie
+    initializer "riagent.configure_rails_initialization" do
+      config_file = Rails.root.join('config', 'riak.yml')
+      if File.exist?(config_file)
+        Riagent.load_config_file(config_file)
+        Riagent.init_clients(Rails.env)  # Set up the client for the current environment
+      end
+    end
+  end
+end

data/lib/riagent/search_schema.rb

@@ -0,0 +1,58 @@
+## ------------------------------------------------------------------- 
+## 
+## Copyright (c) "2014" Dmitri Zagidulin and Basho Technologies, Inc.
+##
+## 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.
+##
+## -------------------------------------------------------------------
+
+module Riagent
+  # Generates RiakJson::CollectionSchema objects (translated into Solr schemas by RiakJson)
+  # from annotated document attributes.
+  # Usage:
+  # <code>
+  #   class SampleModel
+  #     include Riagent::ActiveDocument
+  #     collection_type :riak_json
+  #     attribute :name, required: true, search_index: { as: :text }
+  #   end
+  #   puts SampleModel.schema.inspect
+  #   # => <RiakJson::CollectionSchema:0x000001050eef10 @fields=[{:name=>"name", :type=>"text", :require=>true}]>
+  #
+  #   SampleModel.save_solr_schema()  # sets that schema for the collection
+  # </code>
+  module SearchSchema
+    # Returns a CollectionSchema instance, derived from the document attributes
+    def schema
+      schema = RiakJson::CollectionSchema.new
+      self.attribute_set.each do | attribute |
+        if attribute.options.include? :search_index
+          field_type = attribute.options[:search_index][:as]
+          schema.add_field(field_type, attribute.options[:name], attribute.options[:required])
+        end
+      end
+      schema
+    end
+    
+    # Saves the generated Solr indexing schema to RiakJson.
+    # Usage:
+    # <code>
+    #   SampleModel.save_solr_schema()
+    # </code>
+    def save_solr_schema
+      self.collection.set_schema(self.schema)
+    end
+  end
+end