mongo_tanker 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongo_tanker.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 JD Hendrickson
+
+MIT License
+
+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.md

@@ -0,0 +1,29 @@
+# MongoTanker
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongo_tanker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongo_tanker
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/mongo_tanker.rb

@@ -0,0 +1,53 @@
+require "mongo_tanker/version"
+require "mongo_tanker/tank/index"
+require "mongo_tanker/orm/mongoid"
+
+## Require workers
+require "mongo_tanker/workers/sidekiq_workers/add_to_index_worker"
+require "mongo_tanker/workers/sidekiq_workers/remove_from_index_worker"
+
+module MongoTanker
+  ## Public Index Tank URL
+  mattr_accessor :public_url
+  @@public_url = ENV['INDEXTANK_PUBLIC_URL']
+
+  ## Private Index Tank URL
+  mattr_accessor :private_url
+  @@private_url = ENV['INDEXTANK_PRIVATE_URL']
+
+  ## Default index name (default: Rails.env)
+  mattr_accessor :default_index
+  @@default_index = Rails.env
+
+  ## Unique indexing key
+  ## This is used for development and/or shared environments that may be
+  ## writing to the same single index.  This way, you can index the data
+  ## with a unique key that can be used to retrive that data as well
+  mattr_accessor :index_key
+  @@index_key = nil
+
+  ## Process in the background?
+  ## If you are running Sidekiq, setting this value to true will run workers
+  ## push updates to your indexes.  If set to false, then standard callbacks
+  ## will be used on your models instead.
+  mattr_accessor :run_in_the_background
+  @@run_in_the_background = false
+
+  ## This is for later use
+  mattr_accessor :background_engine
+  @@background_engine = :sidekiq
+
+  ## Queue Name to use (default is nil - default of the engine)
+  mattr_accessor :queue_name
+  @@queue_name = nil
+
+  def self.queue_name=(value)
+    @@queue_name = value.to_s.downcase.parameterize.underscore.to_sym
+  end
+
+  # Default way to setup Devise. Run rails generate devise_install to create
+  # a fresh initializer with all configuration values.
+  def self.setup
+    yield self
+  end
+end

data/lib/mongo_tanker/orm/mongoid.rb

@@ -0,0 +1,155 @@
+##
+##
+module MongoTanker
+  module ORM
+    module Mongoid
+      extend ActiveSupport::Concern
+
+      included do
+        after_save    :mongo_tanker_add_to_index!
+        after_destroy :mongo_tanker_remove_from_index!
+      end
+
+      ## Class Methods ---------------------------------
+
+      module ClassMethods
+        ##
+        # searchify
+        # set searchify parameters for the model implementing this concern.
+        #
+        # Options
+        # ===============================
+        # :doc_id
+        # Name of a Rails route to use as the doc_id
+        #
+        # :use_route_as_doc_id (default: true)
+        # Set to false if the :doc_id value should be treated as string
+        #
+        # :index (default: MongoTanker.default_index)
+        # Name of the Searchify index this resource will be indexed against.
+        #
+        # :sync_mode (default: true)
+        # Automatically execute indexing push/removal
+        #  Options:
+        #   :all     - auto push & remove from indexes
+        #   :none    - do nothing automatically
+        #   :push    - only perform index pushes automatically
+        #   :remove  - only remove from indexes automatically
+        #
+        def mongo_tanker( options={} )
+          @mongo_tanker           = @mongo_tanker || {}
+
+          default_options         = {
+            :doc_id_route         => @mongo_tanker.fetch(:doc_id_route, nil),
+            :index_name           => @mongo_tanker.fetch(:index_name, MongoTanker.default_index),
+            :sync_mode            => @mongo_tanker.fetch(:sync_mode, :all)
+          }
+
+          @mongo_tanker = default_options.merge options
+          return @mongo_tanker
+        end
+
+        ## Map document
+        def mongo_tanker_document_defaults
+          fields = {
+          }
+
+          return fields
+        end
+      end
+
+      ## Instance Methods ---------------------------------
+
+      ## mongo_tanker_doc_id
+      #  Build the mongo_tank doc id based on settings and rules
+      #
+      # TODO: This could probably be enhanced to allow for even more
+      # ways of building the doc id
+      def mongo_tanker_document_id
+        return @mongo_tanker_doc_id ||= (
+          doc_id_route = self.class.mongo_tanker[:doc_id_route]
+
+          if (doc_id_route)
+            @mongo_tanker_doc_id = Rails.application.routes.url_helpers.send(doc_id_route.to_sym, self.id.to_s)
+          else
+            @mongo_tanker_doc_id = self.id.to_s
+          end
+        )
+      end
+
+      ## to_mongo_tanker_document
+      #  Returns the actual document structure for this particular MongoDB document
+      #
+      def to_mongo_tanker_document
+        document = {
+          :id         => self.id.to_s,
+          :text       => self.mongo_tanker_meta_data,
+          :match      => "all",
+          :group      => self.class.name.pluralize.underscore.parameterize,
+          :group_name => self.class.name.pluralize.underscore.humanize.titleize,
+          :bo_type    => self.class.name
+        }
+
+        document[:index_key] = MongoTanker.index_key unless MongoTanker.index_key.nil?
+
+        document.merge!(mongo_tanker_document_map) if self.respond_to?(:mongo_tanker_document_map, true)
+
+        return document
+      end
+
+      ##
+      # mongo_tank_meta_data
+      # Returns a string with all of the meta data for this mongo document.
+      #
+      # By default, this will be empty.  You must define a protected "mongo_tanker_meta_map" method
+      # which will return an array of the field values to be returned.
+      #
+      def mongo_tanker_meta_data
+        meta_data = [] | ((self.respond_to?(:mongo_tanker_meta_map, true)) ? mongo_tanker_meta_map : [])
+        return meta_data.flatten.join(" ")
+      end
+
+      private # -------------------------------------------
+
+      def mongo_tanker_add_to_index!
+        if MongoTanker.run_in_the_background
+          mongo_tanker_add_to_index_in_the_bg!
+        else
+          index_name  = self.class.mongo_tanker[:index_name]
+          index       = MongoTanker::Tank::Index.open(index_name)
+
+          index.document(self.mongo_tanker_document_id).add(self.to_mongo_tanker_document)
+        end
+      end
+
+      def mongo_tanker_remove_from_index!
+        if MongoTanker.run_in_the_background
+          mongo_tanker_remove_from_index_in_the_bg!
+        else
+          index_name  = self.class.mongo_tanker[:index_name]
+          index       = MongoTanker::Tank::Index.open(index_name)
+
+          index.document(self.mongo_tanker_document_id).delete
+        end
+      end
+
+      def mongo_tanker_add_to_index_in_the_bg!
+        case(MongoTanker.background_engine.to_s.downcase.to_sym)
+        when :sidekiq
+          Sidekiq::Client.enqueue(MongoTanker::Workers::SidekiqWorkers::AddToIndexWorker, self.class.name, self.id.to_s)
+        else
+          throw "Sidekiq is currently the only supported background processing engine."
+        end
+      end
+
+      def mongo_tanker_remove_from_index_in_the_bg!
+        case(MongoTanker.background_engine.to_s.downcase.to_sym)
+        when :sidekiq
+          Sidekiq::Client.enqueue(MongoTanker::Workers::SidekiqWorkers::RemoveFromIndexWorker, self.class.name, self.mongo_tanker_document_id)
+        else
+          throw "Sidekiq is currently the only supported background processing engine."
+        end
+      end
+    end
+  end
+end

data/lib/mongo_tanker/tank/index.rb

@@ -0,0 +1,24 @@
+require 'indextank'
+
+##
+module MongoTanker
+  module Tank
+    class Index
+      def self.open(index_name, scope = 'private')
+        url       = (scope == 'private') ? MongoTanker.private_url : MongoTanker.public_url
+        client    = IndexTank::Client.new url
+        index     = client.indexes index_name
+
+        unless index.exists?
+          index.add :public_search => true
+
+          while not index.running?
+            sleep 0.5
+          end
+        end
+
+        return index
+      end
+    end
+  end
+end

data/lib/mongo_tanker/version.rb

@@ -0,0 +1,3 @@
+module MongoTanker
+  VERSION = "0.1.0"
+end

data/lib/mongo_tanker/workers/sidekiq_workers/add_to_index_worker.rb

@@ -0,0 +1,22 @@
+require 'sidekiq'
+
+module MongoTanker
+  module Workers
+    module SidekiqWorkers
+      class AddToIndexWorker
+        include Sidekiq::Worker
+
+        sidekiq_options :queue => :indexing
+
+        def perform(resource_name, resource_id)
+          klass       = resource_name.to_s.constantize
+          resource    = klass.find resource_id
+          index_name  = klass.mongo_tanker[:index_name]
+          index       = MongoTanker::Tank::Index.open(index_name)
+
+          index.document(resource.mongo_tanker_document_id).add(resource.to_mongo_tanker_document)
+        end
+      end
+    end
+  end
+end

data/lib/mongo_tanker/workers/sidekiq_workers/remove_from_index_worker.rb

@@ -0,0 +1,21 @@
+require 'sidekiq'
+
+module MongoTanker
+  module Workers
+    module SidekiqWorkers
+      class RemoveFromIndexWorker
+        include Sidekiq::Worker
+
+        sidekiq_options :queue => :indexing
+
+        def perform(resource_name, doc_id)
+          klass       = resource_name.to_s.constantize
+          index_name  = klass.mongo_tanker[:index_name]
+          index       = MongoTanker::Tank::Index.open(index_name)
+
+          index.document(doc_id).delete()
+        end
+      end
+    end
+  end
+end

data/mongo_tanker.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongo_tanker/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "mongo_tanker"
+  gem.version       = MongoTanker::VERSION
+  gem.authors       = ["JD Hendrickson"]
+  gem.email         = ["jd@digitalopera.com"]
+  gem.description   = "Simple DSL for using an IndexTank search provider with Mongoid"
+  gem.summary       = "Simple DSL for using an IndexTank search provider with Mongoid"
+  gem.homepage      = "https://github.com/digitalopera/mongotanker"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "mongoid",       "~> 3.0.0"
+  gem.add_dependency "indextank",     "~> 1.0.12"
+  gem.add_dependency "activesupport", "~> 3.2.0"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: mongo_tanker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- JD Hendrickson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-11 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: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: indextank
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.12
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: Simple DSL for using an IndexTank search provider with Mongoid
+email:
+- jd@digitalopera.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mongo_tanker.rb
+- lib/mongo_tanker/orm/mongoid.rb
+- lib/mongo_tanker/tank/index.rb
+- lib/mongo_tanker/version.rb
+- lib/mongo_tanker/workers/sidekiq_workers/add_to_index_worker.rb
+- lib/mongo_tanker/workers/sidekiq_workers/remove_from_index_worker.rb
+- mongo_tanker.gemspec
+homepage: https://github.com/digitalopera/mongotanker
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simple DSL for using an IndexTank search provider with Mongoid
+test_files: []