tire 0.3.2 → 0.3.3

data/.gitignore

@@ -9,4 +9,5 @@ coverage/
 scratch/
 examples/*.html
 *.log
-.rvmrc
+.rvmrc
+tags

data/README.markdown

@@ -356,7 +356,7 @@ When you now save a record:
                    :published_on => Time.now
 ```
 
-it is automatically added into the index, because of the included callbacks.
+it is automatically added into an index called 'articles', because of the included callbacks.
 (You may want to skip them in special cases, like when your records are indexed via some external
 mechanism, let's say a _CouchDB_ or _RabbitMQ_
 [river](http://www.elasticsearch.org/blog/2010/09/28/the_river.html).
@@ -687,6 +687,8 @@ Of course, not all validations or `ActionPack` helpers will be available to your
 but if you can live with that, you've just got a schema-free, highly-scalable storage
 and retrieval engine for your data.
 
+This will result in Article instances being stored in an index called 'test_articles' when used in tests but in the index 'development_articles' when used in the development environment.
+
 Please be sure to peruse the [integration test suite](https://github.com/karmi/tire/tree/master/test/integration)
 for examples of the API and _ActiveModel_ integration usage.
 

data/lib/tire.rb

@@ -6,7 +6,8 @@ require 'tire/rubyext/hash'
 require 'tire/rubyext/symbol'
 require 'tire/logger'
 require 'tire/configuration'
-require 'tire/client'
+require 'tire/http/response'
+require 'tire/http/client'
 require 'tire/search'
 require 'tire/search/query'
 require 'tire/search/sort'

data/lib/tire/configuration.rb

@@ -7,7 +7,7 @@ module Tire
     end
 
     def self.client(klass=nil)
-      @client = klass || @client || Client::RestClient
+      @client = klass || @client || HTTP::Client::RestClient
     end
 
     def self.wrapper(klass=nil)

data/lib/tire/http/client.rb

@@ -0,0 +1,51 @@
+module Tire
+
+  module HTTP
+
+    module Client
+
+      class RestClient
+
+        def self.get(url, data=nil)
+          perform ::RestClient::Request.new(:method => :get, :url => url, :payload => data).execute
+        rescue Exception => e
+          Response.new e.http_body, e.http_code
+        end
+
+        def self.post(url, data)
+          perform ::RestClient.post(url, data)
+        rescue Exception => e
+          Response.new e.http_body, e.http_code
+        end
+
+        def self.put(url, data)
+          perform ::RestClient.put(url, data)
+        rescue Exception => e
+          Response.new e.http_body, e.http_code
+        end
+
+        def self.delete(url)
+          perform ::RestClient.delete(url)
+        rescue Exception => e
+          Response.new e.http_body, e.http_code
+        end
+
+        def self.head(url)
+          perform ::RestClient.head(url)
+        rescue Exception => e
+          Response.new e.http_body, e.http_code
+        end
+
+        private
+
+        def self.perform(response)
+          Response.new response.body, response.code, response.headers
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/tire/http/clients/curb.rb

@@ -0,0 +1,55 @@
+require 'curb'
+
+module Tire
+
+  module HTTP
+
+    module Client
+
+      class Curb
+        @client = ::Curl::Easy.new
+        # @client.verbose = true
+
+        def self.get(url, data=nil)
+          @client.url = url
+          @client.post_body = data
+          # FIXME: Curb cannot post bodies with GET requests?
+          #        Roy Fielding seems to approve:
+          #        <http://tech.groups.yahoo.com/group/rest-discuss/message/9962>
+          @client.http_post
+          Response.new @client.body_str, @client.response_code
+        end
+
+        def self.post(url, data)
+          @client.url = url
+          @client.post_body = data
+          @client.http_post
+          Response.new @client.body_str, @client.response_code
+        end
+
+        def self.put(url, data)
+          @client.url = url
+          @client.put_data = data
+          @client.http_put
+          Response.new @client.body_str, @client.response_code
+        end
+
+        def self.delete(url)
+          @client.url = url
+          @client.http_delete
+          Response.new @client.body_str, @client.response_code
+        end
+
+        def self.head(url)
+          @client.url = url
+          @client.http_head
+          Response.new @client.body_str, @client.response_code
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/tire/http/response.rb

@@ -0,0 +1,23 @@
+module Tire
+
+  module HTTP
+
+    class Response
+      attr_reader :body, :code, :headers
+
+      def initialize(body, code, headers={})
+        @body, @code, @headers = body, code.to_i, headers
+      end
+
+      def success?
+        code > 0 && code < 400
+      end
+
+      def failure?
+        ! success?
+      end
+    end
+
+  end
+
+end

data/lib/tire/index.rb

@@ -9,30 +9,24 @@ module Tire
     end
 
     def exists?
-      !!Configuration.client.head("#{Configuration.url}/#{@name}")
-    rescue Exception => error
-      false
+      Configuration.client.head("#{Configuration.url}/#{@name}").success?
     end
 
     def delete
-      # FIXME: RestClient does not return response for DELETE requests?
       @response = Configuration.client.delete "#{Configuration.url}/#{@name}"
-      return @response.body =~ /error/ ? false : true
-    rescue Exception => error
-      false
+      return @response.success?
     ensure
       curl = %Q|curl -X DELETE "#{Configuration.url}/#{@name}"|
-      logged(error, 'DELETE', curl)
+      logged(@response.body, 'DELETE', curl)
     end
 
     def create(options={})
       @options = options
       @response = Configuration.client.post "#{Configuration.url}/#{@name}", MultiJson.encode(options)
-    rescue Exception => error
-      false
+      @response.success? ? @response : false
     ensure
       curl = %Q|curl -X POST "#{Configuration.url}/#{@name}" -d '#{MultiJson.encode(options)}'|
-      logged(error, 'CREATE', curl)
+      logged(@response.body, 'CREATE', curl)
     end
 
     def mapping
@@ -83,16 +77,16 @@ module Tire
       count = 0
 
       begin
-        Configuration.client.post("#{Configuration.url}/_bulk", payload.join("\n"))
+        response = Configuration.client.post("#{Configuration.url}/_bulk", payload.join("\n"))
+        raise RuntimeError, "#{response.code} > #{response.body}" if response.failure?
+        response
       rescue Exception => error
         if count < tries
           count += 1
-          STDERR.puts "[ERROR] #{error.message}:#{error.http_body rescue nil}, retrying (#{count})..."
+          STDERR.puts "[ERROR] #{error.message}, retrying (#{count})..."
           retry
         else
-          STDERR.puts "[ERROR] Too many exceptions occured, giving up..."
-          STDERR.puts "Response: #{error.http_body rescue nil}"
-          raise
+          STDERR.puts "[ERROR] Too many exceptions occured, giving up. The HTTP response was: #{error.message}"
         end
       ensure
         curl = %Q|curl -X POST "#{Configuration.url}/_bulk" -d '{... data omitted ...}'|
@@ -135,7 +129,7 @@ module Tire
       raise ArgumentError, "Please pass a document ID" unless id
 
       result = Configuration.client.delete "#{Configuration.url}/#{@name}/#{type}/#{id}"
-      MultiJson.decode(result) if result
+      MultiJson.decode(result.body) if result.success?
     end
 
     def retrieve(type, id)

data/lib/tire/model/naming.rb

@@ -9,6 +9,9 @@ module Tire
 
         # Get or set the index name for this model, based on arguments.
         #
+        # By default, uses ActiveSupport inflection, so a class named `Article`
+        # will be stored in the `articles` index.
+        #
         # To get the index name:
         #
         #     Article.index_name
@@ -19,13 +22,51 @@ module Tire
         #
         def index_name name=nil
           @index_name = name if name
-          @index_name || klass.model_name.plural
+          @index_name || [index_prefix, klass.model_name.plural].compact.join('_')
         end
 
-        # Get the document type for this model, based on the class name.
+        # Set or get index prefix for all models or for a specific model.
         #
-        def document_type
-          klass.model_name.singular
+        # To set the prefix for all models (preferably in an initializer inside Rails):
+        #
+        #     Tire::Model::Search.index_prefix Rails.env
+        #
+        # To set the prefix for specific model:
+        #
+        #     class Article
+        #       # ...
+        #       index_prefix 'my_prefix'
+        #     end
+        #
+        # TODO: Maybe this would be more sane with ActiveSupport extensions such as `class_attribute`?
+        #
+        @@__index_prefix__ = nil
+        def index_prefix(*args)
+          # Uses class or instance variable depending on the context
+          if args.size > 0
+            value = args.pop
+            self.is_a?(Module) ? ( @@__index_prefix__ = value ) : ( @__index_prefix__ = value )
+          end
+          self.is_a?(Module) ? ( @@__index_prefix__ || nil ) : ( @__index_prefix__ || @@__index_prefix__ || nil )
+        end
+        extend self
+
+        # Get or set the document type for this model, based on arguments.
+        #
+        # By default, uses ActiveSupport inflection, so a class named `Article`
+        # will be stored as the `article` type.
+        #
+        # To get the document type:
+        #
+        #     Article.document_type
+        #
+        # To set the document type:
+        #
+        #     Article.document_type 'my-custom-type'
+        #
+        def document_type name=nil
+          @document_type = name if name
+          @document_type || klass.model_name.singular
         end
       end
 

data/lib/tire/model/persistence.rb

@@ -44,6 +44,12 @@ module Tire
           include Persistence::Attributes::InstanceMethods
 
           include Persistence::Storage
+
+          ['_score', '_type', '_index', '_version', 'sort', 'highlight', 'matches'].each do |attr|
+            define_method("#{attr}=") { |value| @attributes ||= {}; @attributes[attr] = value }
+            define_method("#{attr}")  { @attributes[attr] }
+          end
+
         end
 
       end

data/lib/tire/model/search.rb

@@ -19,6 +19,12 @@ module Tire
     #
     module Search
 
+      # Alias for Tire::Model::Naming::ClassMethods.index_prefix
+      #
+      def self.index_prefix(*args)
+        Naming::ClassMethods.index_prefix(*args)
+      end
+
       module ClassMethods
 
         # Returns search results for a given query.
@@ -152,6 +158,14 @@ module Tire
           end
         end
 
+        def matches
+          @attributes['matches']
+        end
+
+        def matches=(value)
+          @attributes ||= {}; @attributes['matches'] = value
+        end
+
       end
 
       module Loader
@@ -192,13 +206,6 @@ module Tire
         include Tire::Model::Percolate::InstanceMethods
         include InstanceMethods
 
-        ['_score', '_type', '_index', '_version', 'sort', 'highlight', 'matches'].each do |attr|
-          # TODO: Find a sane way to add attributes like _score for ActiveRecord -
-          #       `define_attribute_methods [attr]` does not work in AR.
-          define_method("#{attr}=") { |value| @attributes ||= {}; @attributes[attr] = value }
-          define_method("#{attr}")  { @attributes[attr] }
-        end
-
         INTERFACE = public_instance_methods.map(&:to_sym) - Object.public_instance_methods.map(&:to_sym)
 
         attr_reader :instance
@@ -267,6 +274,7 @@ module Tire
         Results::Item.send :include, Loader
       end
 
+      
     end
 
   end

data/lib/tire/results/pagination.rb

@@ -7,8 +7,12 @@ module Tire
         @total
       end
 
+      def per_page
+        (@options[:per_page] || @options[:size] || 10 ).to_i
+      end
+
       def total_pages
-        ( @total.to_f / (@options[:per_page] || @options[:size] || 10 ).to_i ).ceil
+        ( @total.to_f / per_page ).ceil
       end
 
       def current_page
@@ -27,6 +31,10 @@ module Tire
         current_page < total_pages ? (current_page + 1) : nil
       end
 
+      def offset
+        per_page * (current_page - 1)
+      end
+
       def out_of_bounds?
         current_page > total_pages
       end

data/lib/tire/search.rb

@@ -68,14 +68,15 @@ module Tire
 
       def perform
         @response = Configuration.client.get(@url, self.to_json)
+        if @response.failure?
+          STDERR.puts "[REQUEST FAILED] #{self.to_curl}\n"
+          return false
+        end
         @json     = MultiJson.decode(@response.body)
         @results  = Results::Collection.new(@json, @options)
-        self
-      rescue Exception => error
-        STDERR.puts "[REQUEST FAILED] #{self.to_curl}\n"
-        raise
+        return self
       ensure
-        logged(error)
+        logged
       end
 
       def to_curl
@@ -104,21 +105,20 @@ module Tire
 
           Configuration.logger.log_request '_search', indices, to_curl
 
-          code = @response ? @response.code : error.message
           took = @json['took'] rescue nil
 
           if Configuration.logger.level.to_s == 'debug'
             # FIXME: Depends on RestClient implementation
-            body = if @response
+            body = if @json
               defined?(Yajl) ? Yajl::Encoder.encode(@json, :pretty => true) : MultiJson.encode(@json)
             else
-              error.http_body rescue ''
+              @response.body
             end
           else
             body = ''
           end
 
-          Configuration.logger.log_response code, took, body
+          Configuration.logger.log_response @response.code, took, body
         end
       end