tanker 0.0.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gem 'jeweler'
+gem 'will_paginate', '>= 2.3.15'
+
+group :test do
+  gem 'rspec', '>= 2.0.0.beta.22' 
+end
+
+

data/Gemfile.lock

@@ -0,0 +1,32 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    gemcutter (0.6.1)
+    git (1.2.5)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.6)
+    rspec (2.0.0.beta.22)
+      rspec-core (= 2.0.0.beta.22)
+      rspec-expectations (= 2.0.0.beta.22)
+      rspec-mocks (= 2.0.0.beta.22)
+    rspec-core (2.0.0.beta.22)
+    rspec-expectations (2.0.0.beta.22)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.22)
+      rspec-core (= 2.0.0.beta.22)
+      rspec-expectations (= 2.0.0.beta.22)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    will_paginate (2.3.15)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler
+  rspec (>= 2.0.0.beta.22)
+  will_paginate

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 @kidpollo
+
+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,17 @@
+= tanker
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 @kidpollo. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "tanker"
+    gem.summary = %Q{IndexTank integration to your favorite orm}
+    gem.description = %Q{IndexTank is a great search indexing service, this gem tries to make any orm keep in sync with indextank with ease}
+    gem.email = "kidpollo@gmail.com"
+    gem.homepage = "http://github.com/kidpollo/tanker"
+    gem.authors = ["@kidpollo"]
+    gem.add_development_dependency "rspec", ">= 2.0.0.beta.22"
+    gem.add_dependency 'will_paginate', '>= 2.3.15'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tanker #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/lib/indextank_client.rb

@@ -0,0 +1,256 @@
+require 'net/http'
+require 'uri'
+require 'rubygems'
+require 'json'
+
+module IndexTank
+
+    private
+
+    class RestClient
+        def GET(path, params={})
+            path = "#{path}?#{to_query(params)}" if params
+            request = Net::HTTP::Get.new "#{@uri}#{path}"
+            authorize request
+            return execute(request)
+        end
+
+        def PUT(path, body={})
+            request = Net::HTTP::Put.new "#{@uri}#{path}"
+            authorize request
+            request.body = body.to_json if body
+            return execute(request)
+        end
+
+        def DELETE(path, params={})
+            path = "#{path}?#{to_query(params)}" if params
+            request = Net::HTTP::Delete.new "#{@uri}#{path}"
+            authorize request
+            return execute(request)
+        end
+
+        private
+
+        def to_query(params)
+            require 'cgi' unless defined?(CGI) && defined?(CGI::escape)
+            r = ''
+            params.each do |k,v|
+                r << "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}&"
+            end
+            return r
+        end
+
+        def authorize(req)
+            req.basic_auth(@uri.user, @uri.password)
+        end
+
+        def execute(req)
+            res = Net::HTTP.new(@uri.host).start { |http| http.request(req) }
+            if res.is_a? Net::HTTPSuccess
+                if res.body.nil? or res.body.empty?
+                    return res.code, nil
+                else
+                    begin
+                        return res.code, JSON.parse(res.body)
+                    rescue
+                        raise "Invalid JSON response: #{res.body}"
+                    end
+                end
+            elsif res.is_a? Net::HTTPUnauthorized
+                raise SecurityError, "Authorization required"
+            elsif res.is_a? Net::HTTPBadRequest
+                raise ArgumentError, res.body
+            else
+                raise HttpCodeException.new(res.code, res.body)
+            end
+        end
+
+    end
+
+    public
+
+    class ApiClient < RestClient
+        def initialize(api_url)
+            @uri = URI.parse(api_url)
+        end
+
+        def get_index(name)
+            require 'cgi' unless defined?(CGI) && defined?(CGI::escape)
+            return IndexClient.new("#{@uri}/v1/indexes/#{CGI.escape(name)}")
+        end
+
+        def create_index(name)
+            index = get_index(name)
+            index.create_index()
+            return index
+        end
+
+        def delete_index(name)
+            return get_index(name).delete_index()
+        end
+
+        def list_indexes()
+            code, indexes = GET "/v1/indexes"
+            return indexes.map do |name,metadata| IndexClient.new "#{@uri}/v1/indexes/#{name}", metadata end
+        end
+    end
+
+    class IndexClient < RestClient
+        def initialize(index_url, metadata=nil)
+            @uri = URI.parse(index_url)
+            @metadata = metadata
+        end
+
+        def code
+            return metadata['code']
+        end
+
+        def running?
+            return metadata!['started']
+        end
+
+        def creation_time
+            return metadata['creation_time']
+        end
+
+        def size
+            return metadata['size']
+        end
+
+        def exists?
+            begin
+                metadata!
+                return true
+            rescue HttpCodeException
+                if $!.code == "404"
+                    return false
+                end
+                raise
+            end
+        end
+
+        # the options argument may contain a :variables key
+        # with a Hash from variable numbers to their float values
+        # this variables can be used in the scoring functions
+        # when sorting a search
+        def add_document(docid, fields, options={})
+            options.merge!( :docid => docid, :fields => fields )
+            code, r = PUT "/docs", options
+            return r
+        end
+
+        def update_variables(docid, variables, options={})
+            options.merge!( :docid => docid, :variables => variables )
+            code, r = PUT "/docs/variables", options
+            return r
+        end
+
+        def delete_document(docid, options={})
+            options.merge!( :docid => docid )
+            code, r = DELETE "/docs", options
+            return r
+        end
+
+        # the options argument may contain an :index_code definition to override
+        # this instance's default index_code
+        def promote(docid, query, options={})
+            options.merge!( :docid => docid, :query => query )
+            code, r = PUT "/promote", options
+            return r
+        end
+
+
+        # the options argument may contain an :index_code definition to override
+        # this instance's default index_code
+        # it can also contain any of the following:
+        #   :start => an int with the number of results to skip
+        #   :len => an int with the number of results to return
+        #   :snippet => a comma separated list of field names for which a snippet
+        #               should be returned. (requires an index that supports snippets)
+        #   :fetch => a comma separated list of field names for which its content
+        #             should be returned. (requires an index that supports storage)
+        #   :function => an int with the index of the scoring function to be used
+        #                for this query
+        def search(query, options={})
+            options = { :start => 0, :len => 10 }.merge(options)
+            options.merge!( :q => query )
+            begin
+                code, r = GET "/search", options
+                return r
+            rescue HttpCodeException
+                raise
+            end
+        end
+
+        def add_function(function_index, definition, options={})
+            options.merge!( :definition => definition )
+            code, r = PUT "/functions/#{function_index}", options
+            return r
+        end
+
+        def del_function(function_index, options={})
+            code, r = DELETE "/functions/#{function_index}", options
+            return r
+        end
+
+        def list_functions(options={})
+            code, r = GET "/functions"
+            return r
+        end
+
+        def create_index()
+            begin
+                code, r = PUT ""
+                raise IndexAlreadyExists if code == "204"
+                return r
+            rescue HttpCodeException
+                if $!.code == "409"
+                    puts $!.code
+                    raise TooManyIndexes
+                end
+                raise
+            end
+        end
+
+        def delete_index()
+            code, r = DELETE ""
+            return r
+        end
+
+        def metadata
+            metadata! if @metadata.nil?
+            return @metadata
+        end
+
+        def metadata!
+            code, @metadata = GET ""
+            return @metadata
+        end
+
+    end
+
+    class IndexAlreadyExists < StandardError
+    end
+    class TooManyIndexes < StandardError
+    end
+
+    class HttpCodeException < StandardError
+        def initialize(code, message)
+            @code = code
+            @message = message
+            super("#{code}: #{message}")
+        end
+
+        attr_accessor :code
+        attr_accessor :message
+    end
+
+    class HerokuClient < ApiClient
+        def initialize()
+            super(ENV['HEROKUTANK_API_URL'])
+        end
+    end
+
+
+end
+

data/lib/tanker/configuration.rb

@@ -0,0 +1,15 @@
+module Tanker
+
+  module Configuration
+
+    def configuration
+     @@configuration || raise(NotConfigured, "Please configure Tanker. Set Tanker.configuration = {:url => ''}")
+    end
+
+    def configuration=(new_configuration)
+      @@configuration = new_configuration
+    end
+
+  end
+
+end

data/lib/tanker.rb

@@ -0,0 +1,97 @@
+require "rubygems"
+require "bundler"
+require 'indextank_client'
+
+require 'tanker/configuration'
+require 'will_paginate/collection'
+
+Bundler.setup :default
+
+module Tanker
+
+  class NotConfigured < StandardError; end
+  class NoBlockGiven < StandardError; end
+
+  autoload :Configuration, 'tanker/configuration'
+
+  extend Configuration
+
+  class << self
+    def included(klass)
+      klass.instance_variable_set('@tanker_configuration', configuration)
+      klass.instance_variable_set('@tanker_indexes', [])
+      klass.send :include, InstanceMethods
+      klass.extend ClassMethods
+
+      class << klass
+        define_method(:per_page) { 10 } unless respond_to?(:per_page)
+      end
+
+    end
+  end
+
+  # these are the class methods added when Tanker is included
+  module ClassMethods
+
+    attr_reader :tanker_indexes, :index_name
+
+    def tankit(name, &block)
+      if block_given?
+        @index_name = name
+        self.instance_exec(&block)
+      else
+        raise(NoBlockGiven, 'Please provide a block')
+      end
+    end
+
+    def indexes(field)
+      @tanker_indexes << field
+    end
+
+  end
+
+  # these are the instace methods included que
+  module InstanceMethods
+
+    def tanker_indexes
+      self.class.tanker_indexes
+    end
+
+    def api
+      @api ||= IndexTank::ApiClient.new(Tanker.configuration[:url])
+    end
+
+    def index
+      @index ||= api.get_index(self.class.index_name)
+    end
+
+    def search_tank(query, page = 1, per_page = self.class.per_page)
+
+      results = index.search(query, :start => page, :len => per_page )
+      ids = results[:results].map{|res| res[:docid]}
+
+      @entries = WillPaginate::Collection.create(page, per_page) do |pager|
+        result = self.class.find(ids)
+        # inject the result array into the paginated collection:
+        pager.replace(result)
+
+        unless pager.total_entries
+          # the pager didn't manage to guess the total count, do it manually
+          pager.total_entries = results[:matches]
+        end
+      end
+    end
+    def update_tank_indexes
+      hash = {}
+      tanker_indexes.each do |idx|
+        hash[idx] = self.send(idx.to_s)
+      end
+      index.add_document(id, hash)
+    end
+
+    def delete_tank_indexes
+      index.delete_document(id)
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+Bundler.setup :test
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'tanker'
+require 'rspec'
+
+Rspec.configure do |c|
+  c.mock_with :rspec
+end

data/spec/tanker_spec.rb

@@ -0,0 +1,118 @@
+require 'spec_helper'
+
+Tanker.configuration = {:url => 'http://api.indextank.com'}
+
+class Dummy
+
+end
+
+
+class Person
+  include Tanker
+
+  tankit 'persons' do
+    indexes :name
+  end
+
+  def id
+    1
+  end
+
+  def name
+    'paco'
+  end
+end
+
+describe Tanker do
+
+  it 'sets configuration' do
+    conf =  {:url => 'http://api.indextank.com'}
+    Tanker.configuration = conf
+
+    Tanker.configuration.should == conf
+  end
+
+  it 'checks for configuration when the module is included' do
+    Tanker.configuration = nil
+
+    lambda {
+      Dummy.send(:include, Tanker)
+    }.should raise_error(Tanker::NotConfigured)
+  end
+
+  it 'should requiquire a block when seting up tanker model' do
+    Tanker.configuration = {:url => 'http://api.indextank.com'}
+    Dummy.send(:include, Tanker)
+    lambda {
+      Dummy.send(:tankit, 'dummy index')
+    }.should raise_error(Tanker::NoBlockGiven)
+  end
+
+  it 'should set indexable fields' do
+    Tanker.configuration = {:url => 'http://api.indextank.com'}
+    Dummy.send(:include, Tanker)
+    Dummy.send(:tankit, 'dummy index') do
+      indexes :field
+    end
+
+    dummy_instance = Dummy.new
+    dummy_instance.tanker_indexes.include?(:field).should == true
+  end
+
+  describe 'tanker instance' do
+    it 'should create an api instance' do
+      person = Person.new
+
+      person.api.class.should == IndexTank::ApiClient
+    end
+
+    it 'should create a connexion to index tank' do
+      person = Person.new
+
+      person.index.class.should == IndexTank::IndexClient
+    end
+
+    it 'should be able to perform a seach query' do
+      person = Person.new
+
+      person.index.should_receive(:search).and_return(
+        {
+          :matches => 1,
+          :results => [{
+            :docid => 1,
+            :name  => 'pedro'
+          }],
+          :search_time => 1
+        }
+      )
+
+      person.class.should_receive(:find).and_return(
+      [person]
+      )
+
+      collection = person.search_tank('hey!')
+      collection.class.should == WillPaginate::Collection
+      collection.total_entries.should == 1
+      collection.total_pages.should == 1
+      collection.per_page.should == 10
+      collection.current_page.should == 1
+    end
+
+    it 'should be able to update the index' do
+      person = Person.new
+
+      person.index.should_receive(:add_document)
+
+      person.update_tank_indexes
+    end
+
+    it 'should be able to delete de document from the index' do
+      person = Person.new
+
+      person.index.should_receive(:delete_document)
+
+      person.delete_tank_indexes
+    end
+
+  end
+end

data/tanker.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{tanker}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["@kidpollo"]
+  s.date = %q{2010-10-04}
+  s.description = %q{IndexTank is a great search indexing service, this gem tries to make any orm keep in sync with indextank with ease}
+  s.email = %q{kidpollo@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "Gemfile",
+     "Gemfile.lock",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "autotest/discover.rb",
+     "lib/indextank_client.rb",
+     "lib/tanker.rb",
+     "lib/tanker/configuration.rb",
+     "spec/spec_helper.rb",
+     "spec/tanker_spec.rb",
+     "tanker.gemspec"
+  ]
+  s.homepage = %q{http://github.com/kidpollo/tanker}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{IndexTank integration to your favorite orm}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/tanker_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 2.0.0.beta.22"])
+      s.add_runtime_dependency(%q<will_paginate>, [">= 2.3.15"])
+    else
+      s.add_dependency(%q<rspec>, [">= 2.0.0.beta.22"])
+      s.add_dependency(%q<will_paginate>, [">= 2.3.15"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 2.0.0.beta.22"])
+    s.add_dependency(%q<will_paginate>, [">= 2.3.15"])
+  end
+end
+

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: tanker
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- "@kidpollo"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-04 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 22
+        version: 2.0.0.beta.22
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: will_paginate
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 15
+        version: 2.3.15
+  type: :runtime
+  version_requirements: *id002
+description: IndexTank is a great search indexing service, this gem tries to make any orm keep in sync with indextank with ease
+email: kidpollo@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- autotest/discover.rb
+- lib/indextank_client.rb
+- lib/tanker.rb
+- lib/tanker/configuration.rb
+- spec/spec_helper.rb
+- spec/tanker_spec.rb
+- tanker.gemspec
+has_rdoc: true
+homepage: http://github.com/kidpollo/tanker
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: IndexTank integration to your favorite orm
+test_files: 
+- spec/spec_helper.rb
+- spec/tanker_spec.rb