tinia 0.0.3

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

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

data/Gemfile

@@ -0,0 +1,23 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "aws_cloud_search"
+gem "rails", "~> 2.3"
+
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "guard-rspec"
+  gem "jeweler", "~> 1.8.3"
+  gem "mocha"
+  gem "rdoc", "~> 3.12"
+  gem "rspec", "~> 2.8.0"
+  gem "ruby-debug19", :require => "ruby-debug"
+  gem "simplecov"
+  gem "sqlite3"
+  gem "yard", "~> 0.7"
+end

data/Gemfile.lock

@@ -0,0 +1,95 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (2.3.14)
+      actionpack (= 2.3.14)
+    actionpack (2.3.14)
+      activesupport (= 2.3.14)
+      rack (~> 1.1.0)
+    activerecord (2.3.14)
+      activesupport (= 2.3.14)
+    activeresource (2.3.14)
+      activesupport (= 2.3.14)
+    activesupport (2.3.14)
+    archive-tar-minitar (0.5.2)
+    aws_cloud_search (0.0.1)
+      faraday_middleware (>= 0.8.0)
+    columnize (0.3.6)
+    diff-lcs (1.1.3)
+    faraday (0.8.0)
+      multipart-post (~> 1.1)
+    faraday_middleware (0.8.7)
+      faraday (>= 0.7.4, < 0.9)
+    ffi (1.0.11)
+    git (1.2.5)
+    guard (1.0.1)
+      ffi (>= 0.5.0)
+      thor (~> 0.14.6)
+    guard-rspec (0.7.0)
+      guard (>= 0.10.0)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.6)
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    metaclass (0.0.1)
+    mocha (0.10.5)
+      metaclass (~> 0.0.1)
+    multi_json (1.3.2)
+    multipart-post (1.1.5)
+    rack (1.1.3)
+    rails (2.3.14)
+      actionmailer (= 2.3.14)
+      actionpack (= 2.3.14)
+      activerecord (= 2.3.14)
+      activeresource (= 2.3.14)
+      activesupport (= 2.3.14)
+      rake (>= 0.8.3)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+    simplecov (0.6.2)
+      multi_json (~> 1.3)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    sqlite3 (1.3.5)
+    thor (0.14.6)
+    yard (0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aws_cloud_search
+  bundler (~> 1.0.0)
+  guard-rspec
+  jeweler (~> 1.8.3)
+  mocha
+  rails (~> 2.3)
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)
+  ruby-debug19
+  simplecov
+  sqlite3
+  yard (~> 0.7)

data/Guardfile

@@ -0,0 +1,19 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2, :opts => "--format nested" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Dan Langevin
+
+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,130 @@
+= Tinia
+
+A Rails interface for Amazon CloudSearch
+
+Tinia allows you to easily index and search data using Amazon's hosted Solr service, CloudSearch.  Its basic
+workflow is that after_save we send data to CloudSearch and after_destroy we remove that data.
+
+== Installing tinia
+
+In Rails 3
+
+  # Gemfile
+  gem "tinia"
+
+In Rails 2
+  
+  # config/environment.rb
+  config.gem "tinia"
+
+  # config/initializers/nimbus.rb
+  Tinia.activate_active_record!
+
+== Activating the Model
+
+In order to activate a given model, you call the indexed_with_tinia class method.  You must also supply a
+tinia_domain.  The tinia_domain is inheritable, so subclasses will use the same tinia_domain
+as their parent.
+
+  class User < ActiveRecord::Base
+    indexed_with_cloud_search do |config|
+      config.cloud_search_domain = "users-xkdkdksl485d8d0d"
+    end
+  end
+
+== Indexing data 
+
+In order to define the fields that you want indexed, you must define a cloud_search_data method, which returns a hash
+of indexed data.  You can call any necessary methods to generate this data.
+
+  class User < ActiveRecord::Base
+
+    indexed_with_cloud_search do |config|
+      config.cloud_search_domain = "users-xkdkdksl485d8d0d"
+    end
+
+    def cloud_search_data
+      {
+        "name" => self.name,
+        "age" => self.age,
+        "fathers_name" => self.father.name,
+        "mothers_name" => self.mother.name
+      }
+    end
+  
+  end
+
+Each time a record is saved, the index for that record will be updated.  When the record is destroyed, it is removed
+from the index.
+
+== Indexing a collection
+
+When installing tinia, you will need to build your initial index.  The index is built by finding each record and
+adding it to a batched uploader.  This is done for efficiency (but large collections will still be kind of slow).
+
+The re-indexer uses find_each and takes the same arguments as that method.
+
+  # Eager load associated data
+  Client.cloud_search_reindex(:include => [:mother, :father])
+
+== Searching
+
+Searching is implemented as a named_scope with extensions to hold meta data about the result set
+
+  res = Client.cloud_search("Dan") # => will search our collection for records with a type of Client that matches the query "Dan"
+  
+  Client.cloud_search("Dan").recent # => applies the 'recent' scope to our conditions generated by a result from CloudSearch
+
+=== Pagination
+
+CloudSearch/Solr offers built-in pagination, which Tinia provides access to.  For example
+
+  # default options
+  res = User.cloud_search("Dan")
+  res.current_page # => 1
+  res.per_page # => 20
+  res.offset # => 0
+  res.total_pages # => 5
+  res.total_entries # => 89
+
+  # with additional options
+  res = User.cloud_search("Dan", :page => 2, :per_page => 30)
+  res.current_page # => 2
+  res.per_page # => 30
+  res.offset # => 30
+  res.total_pages # => 3
+  res.total_entries # => 89
+
+=== WillPaginate
+
+Tinia offers drop-in integration with will_paginate. Results of any Tinia search will work with the will_paginate 
+view helpers
+
+  # app/controllers/users_controller.rb
+  class UsersController < ApplicationController
+    # GET /users
+    def list
+      @users = User.cloud_search(params[:q])
+    end
+  end
+
+  # app/views/users/list.html
+  = will_paginate(@users)
+
+
+
+== Contributing to Tinia
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Dan Langevin and Lifebooker. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "tinia"
+  gem.homepage = "http://github.com/dlangevin/tinia"
+  gem.license = "MIT"
+  gem.summary = %Q{Rails integration for CloudSearch}
+  gem.description = %Q{Rails integration for CloudSearch}
+  gem.email = "dan.langevin@lifebooker.com"
+  gem.authors = ["Dan Langevin"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.0.3

data/lib/tinia.rb

@@ -0,0 +1,48 @@
+require 'aws_cloud_search'
+require 'tinia/connection'
+require 'tinia/exceptions'
+require 'tinia/index'
+require 'tinia/search'
+
+if defined?(Rails)
+  require 'tinia/railtie'
+end
+
+module Tinia
+
+  def self.connection(domain = "default")
+    @connections ||= {}
+    @connections[domain] ||= AWSCloudSearch::CloudSearch.new(domain)
+  end
+
+  # activate for ActiveRecord
+  def self.activate_active_record!
+    ::ActiveRecord::Base.send(:extend, Tinia::ActiveRecord)
+  end
+
+  module ActiveRecord
+
+    # activation method for an AR class
+    def indexed_with_cloud_search(&block)
+      mods = [
+        Tinia::Connection,
+        Tinia::Index,
+        Tinia::Search
+      ]
+      mods.each do |mod|
+        unless self.included_modules.include?(mod)
+          self.send(:include, mod) 
+        end
+      end
+      # config block
+      yield(self) if block_given?
+
+      # ensure config is all set
+      unless self.cloud_search_domain.present?
+        raise Tinia::MissingSearchDomain.new(self)
+      end
+    end
+
+  end
+
+end

data/lib/tinia/connection.rb

@@ -0,0 +1,24 @@
+module Tinia
+  module Connection
+
+    def self.included(klass)
+      klass.send(:extend, ClassMethods)
+      klass.class_eval do
+        class_inheritable_accessor :cloud_search_domain
+      end
+    end
+
+    module ClassMethods
+
+      # accessor for the cloud search connection
+      def cloud_search_connection
+        @cloud_search_connection ||= begin
+          Tinia.connection(
+            self.cloud_search_domain
+          )
+        end
+      end
+
+    end
+  end
+end

data/lib/tinia/exceptions.rb

@@ -0,0 +1,8 @@
+module Tinia
+  class MissingSearchDomain < Exception
+    # constructor
+    def initialize(klass)
+      super("You must define a cloud_search_domain for #{klass}")
+    end
+  end
+end

data/lib/tinia/index.rb

@@ -0,0 +1,112 @@
+module Tinia
+  module Index
+
+    def self.included(klass)
+      klass.send(:include, InstanceMethods)
+      klass.send(:extend, ClassMethods)
+      klass.class_eval do
+        cattr_accessor :in_cloud_search_batch_documents
+        self.in_cloud_search_batch_documents = false
+
+        # set up our callbacks
+        after_save(:add_to_cloud_search)
+        after_destroy(:delete_from_cloud_search)
+      end
+    end
+
+    module InstanceMethods
+
+      # add ourself as a document to CloudSearch
+      def add_to_cloud_search
+        self.class.cloud_search_add_document(
+          self.cloud_search_document
+        )
+      end
+
+      # empty implementation - re-implement 
+      # or we might end up doing some meta-programming here
+      def cloud_search_data
+        {}
+      end
+
+      # wrapper for a fully formed AWSCloudSearch::Document
+      def cloud_search_document
+        AWSCloudSearch::Document.new.tap do |d|
+          d.id = self.id
+          d.lang = "en"
+          d.version = self.updated_at.to_i
+          # class name
+          d.add_field("type", self.class.base_class.name)
+          self.cloud_search_data.each_pair do |k,v|
+            d.add_field(k.to_s, v.to_s)
+          end
+        end
+      end
+
+      # add ourself as a document to CloudSearch
+      def delete_from_cloud_search
+        self.class.cloud_search_delete_document(
+          self.cloud_search_document
+        )
+      end
+
+    end
+
+    module ClassMethods
+
+      # class method to add documents
+      def cloud_search_add_document(doc)
+        self.cloud_search_batcher_command(:add_document, doc)
+      end
+
+     # class method to add documents
+      def cloud_search_delete_document(doc)
+        self.cloud_search_batcher_command(:delete_document, doc)
+      end
+
+      # perform all add/delete operations within a buffered
+      # DocumentBatcher
+      def cloud_search_batch_documents(&block)
+        begin
+          self.in_cloud_search_batch_documents = true
+          yield
+          # final flush for any left over documents
+          self.cloud_search_document_batcher.flush
+        ensure
+          self.in_cloud_search_batch_documents = false
+        end
+      end
+
+      # reindex the entire collection
+      def cloud_search_reindex(*args)
+        self.cloud_search_batch_documents do
+          self.find_each(*args) do |record|
+            record.add_to_cloud_search
+          end
+        end
+      end
+
+      # new instance of AWSCloudSearch::DocumentBatcher
+      def cloud_search_document_batcher
+        @cloud_search_document_batcher ||= begin
+          self.cloud_search_connection.new_batcher
+        end
+      end
+
+      protected
+      # send a command to the batcher and then conditionally flush
+      # depending on whether we are in a cloud_search_batch_documents
+      # block
+      def cloud_search_batcher_command(command, doc)
+        # send the command to our batcher
+        self.cloud_search_document_batcher.send(command, doc)
+
+        # if we are not in a batch_documents block, flush immediately
+        unless self.in_cloud_search_batch_documents
+          self.cloud_search_document_batcher.flush
+        end
+      end
+    end
+
+  end
+end