tire 0.5.4 → 0.5.5

data/lib/tire.rb

@@ -6,7 +6,8 @@ require 'cgi'
 
 require 'active_support/core_ext/object/to_param'
 require 'active_support/core_ext/object/to_query'
-require 'active_support/core_ext/hash/except.rb'
+require 'active_support/core_ext/hash/except'
+require 'active_support/json'
 
 # Ruby 1.8 compatibility
 require 'tire/rubyext/ruby_1_8' if defined?(RUBY_VERSION) && RUBY_VERSION < '1.9'

data/lib/tire/alias.rb

@@ -1,6 +1,6 @@
 module Tire
 
-  # Represents an *alias* in _ElasticSearch_. An alias may point to one or multiple
+  # Represents an *alias* in _Elasticsearch_. An alias may point to one or multiple
   # indices, for instance to separate physical indices into logical entities, where
   # each user has a "virtual index" or for setting up "sliding window" scenarios.
   #
@@ -156,7 +156,7 @@ module Tire
       type ? (@attributes[:filter] = Search::Filter.new(type, *options).to_hash and return self ) : @attributes[:filter]
     end
 
-    # Save the alias in _ElasticSearch_
+    # Save the alias in _Elasticsearch_
     #
     def save
       @response = Configuration.client.post "#{Configuration.url}/_aliases", to_json
@@ -184,7 +184,7 @@ module Tire
       { :actions => actions }
     end
 
-    # Return alias serialized in JSON for _ElasticSearch_
+    # Return alias serialized in JSON for _Elasticsearch_
     #
     def to_json(options=nil)
       as_json.to_json

data/lib/tire/dsl.rb

@@ -5,29 +5,27 @@ module Tire
       Configuration.class_eval(&block)
     end
 
-    def search(indices=nil, options={}, &block)
+    def search(indices=nil, payload={}, &block)
       if block_given?
-        Search::Search.new(indices, options, &block)
+        Search::Search.new(indices, payload, &block)
       else
-        payload = case options
-          when Hash    then
-            options
-          when String  then
-            Tire.warn "Passing the payload as a JSON string in Tire.search has been deprecated, " +
-                       "please use the block syntax or pass a plain Hash."
-            options
-          else raise ArgumentError, "Please pass a Ruby Hash or String with JSON"
-        end
-        unless options.empty?
-          Search::Search.new(indices, :payload => payload)
-        else
-          Search::Search.new(indices)
+        raise ArgumentError, "Please pass a Ruby Hash or an object with `to_hash` method, not #{payload.class}" \
+              unless payload.respond_to?(:to_hash)
+
+        # Extract URL parameters from payload
+        #
+        search_params = %w| search_type routing scroll from size timeout |
+
+        options = search_params.inject({}) do |sum,item|
+          if param = (payload.delete(item) || payload.delete(item.to_sym))
+            sum[item.to_sym] = param
+          end
+          sum
         end
+
+        options.update(:payload => payload) unless payload.empty?
+        Search::Search.new(indices, options)
       end
-    rescue Exception => error
-      STDERR.puts "[REQUEST FAILED] #{error.class} #{error.message rescue nil}\n"
-      raise
-    ensure
     end
 
     # Build and perform a [multi-search](http://elasticsearch.org/guide/reference/api/multi-search.html)

data/lib/tire/index.rb

@@ -52,9 +52,64 @@ module Tire
       alias_name ? Alias.all(@name).select { |a| a.name == alias_name }.first : Alias.all(@name)
     end
 
-    def mapping
+    # Get or update the index mapping
+    #
+    # Without arguments, returns the index mapping as a Hash
+    #
+    # When passed arguments, attempts to update the index mapping:
+    #
+    #     index.mapping 'article', properties: { body: { type: "string" } }
+    #
+    # You can pass the `ignore_conflicts` option as a part of the Hash:
+    #
+    #     index.mapping 'article', properties: { body: { type: "string" } }, ignore_conflicts: true
+    #
+    def mapping(*args)
+      args.empty? ? get_mapping : put_mapping(*args)
+    end
+
+    # Raises an exception for unsuccessful responses
+    #
+    def mapping!(*args)
+      mapping(*args)
+      raise RuntimeError, response.body unless response.success?
+    end
+
+    def get_mapping
       @response = Configuration.client.get("#{url}/_mapping")
-      MultiJson.decode(@response.body)[@name]
+      result = MultiJson.decode(@response.body)[@name]
+      @response.success? ? result : false
+    ensure
+      curl = %Q|curl -X GET "#{url}/_mapping?pretty"|
+      logged("GET MAPPING", curl)
+    end
+
+    def put_mapping(type, mapping)
+      params = {}
+      if ignore_conflicts = mapping.delete(:ignore_conflicts) || mapping.delete("ignore_conflicts")
+        params[:ignore_conflicts] = ignore_conflicts
+      end
+
+      url  = "#{self.url}/#{type}/_mapping"
+      url += "?#{params.to_param}" unless params.empty?
+
+      payload = { type => mapping }.to_json
+
+      @response = Configuration.client.put url, payload
+      result = MultiJson.decode(@response.body)
+      @response.success? ? result : false
+    ensure
+      curl = %Q|curl -X PUT "#{url}" -d '#{payload}'|
+      logged("PUT MAPPING #{type}", curl)
+    end
+
+    def delete_mapping(type)
+      url = "#{self.url}/#{type}"
+      @response = Configuration.client.delete(url)
+      @response.success?
+    ensure
+      curl = %Q|curl -X DELETE "#{url}"|
+      logged("DELETE MAPPING #{type}", curl)
     end
 
     def settings
@@ -79,10 +134,11 @@ module Tire
 
       params[:parent]  = options[:parent]  if options[:parent]
       params[:routing] = options[:routing] if options[:routing]
+      params[:replication] = options[:replication] if options[:replication]
 
       params_encoded = params.empty? ? '' : "?#{params.to_param}"
 
-      url  = id ? "#{self.url}/#{type}/#{id}#{params_encoded}" : "#{self.url}/#{type}/#{params_encoded}"
+      url  = id ? "#{self.url}/#{type}/#{Utils.escape(id)}#{params_encoded}" : "#{self.url}/#{type}/#{params_encoded}"
 
       @response = Configuration.client.post url, document
       MultiJson.decode(@response.body)
@@ -104,6 +160,8 @@ module Tire
     # Shortcut methods `bulk_store`, `bulk_delete` and `bulk_create` are available.
     #
     def bulk(action, documents, options={})
+      return false if documents.empty?
+
       # TODO: A more Ruby-like DSL notation should be supported:
       #
       #     Tire.index('myindex').bulk do
@@ -111,7 +169,7 @@ module Tire
       #       delete id: 1
       #       # ...
       #     end
-      #
+
       payload = documents.map do |document|
         type = get_type_from_document(document, :escape => false) # Do not URL-escape the _type
         id   = get_id_from_document(document)
@@ -236,20 +294,19 @@ module Tire
       end
       raise ArgumentError, "Please pass a document ID" unless id
 
-      url    = "#{self.url}/#{type}/#{id}"
+      url    = "#{self.url}/#{type}/#{Utils.escape(id)}"
       result = Configuration.client.delete url
       MultiJson.decode(result.body) if result.success?
 
     ensure
       curl = %Q|curl -X DELETE "#{url}"|
-      logged(id, curl)
+      logged("#{type}/#{id}", curl)
     end
 
     def retrieve(type, id, options={})
       raise ArgumentError, "Please pass a document ID" unless id
 
-      type      = Utils.escape(type)
-      url       = "#{self.url}/#{type}/#{id}"
+      url       = "#{self.url}/#{Utils.escape(type)}/#{Utils.escape(id)}"
 
       params    = {}
       params[:routing]    = options[:routing] if options[:routing]
@@ -271,7 +328,7 @@ module Tire
 
     ensure
       curl = %Q|curl -X GET "#{url}"|
-      logged(id, curl)
+      logged("#{type}/#{id}", curl)
     end
 
     def update(type, id, payload={}, options={})
@@ -280,7 +337,7 @@ module Tire
       raise ArgumentError, "Please pass a script or partial document in the payload hash" unless payload[:script] || payload[:doc]
 
       type      = Utils.escape(type)
-      url       = "#{self.url}/#{type}/#{id}/_update"
+      url       = "#{self.url}/#{type}/#{Utils.escape(id)}/_update"
       url      += "?#{options.to_param}" unless options.keys.empty?
       @response = Configuration.client.post url, MultiJson.encode(payload)
       MultiJson.decode(@response.body)

data/lib/tire/model/callbacks.rb

@@ -2,7 +2,7 @@ module Tire
   module Model
 
     # Main module containing the infrastructure for automatic updating
-    # of the _ElasticSearch_ index on model instance create, update or delete.
+    # of the _Elasticsearch_ index on model instance create, update or delete.
     #
     # Include it in your model: `include Tire::Model::Callbacks`
     #

data/lib/tire/model/indexing.rb

@@ -28,7 +28,7 @@ module Tire
         end
 
         # Define the [_mapping_](http://www.elasticsearch.org/guide/reference/mapping/index.html)
-        # for the corresponding index, telling _ElasticSearch_ how to understand your documents:
+        # for the corresponding index, telling _Elasticsearch_ how to understand your documents:
         # what type is which property, whether it is analyzed or no, which analyzer to use, etc.
         #
         # You may pass the top level mapping properties (such as `_source` or `_all`) as a Hash.
@@ -113,7 +113,7 @@ module Tire
             end
           end
         rescue Errno::ECONNREFUSED => e
-          STDERR.puts "Skipping index creation, cannot connect to ElasticSearch",
+          STDERR.puts "Skipping index creation, cannot connect to Elasticsearch",
                       "(The original exception was: #{e.inspect})"
           false
         end

data/lib/tire/model/naming.rb

@@ -75,7 +75,7 @@ module Tire
         #
         def document_type name=nil
           @document_type = name if name
-          @document_type || klass.model_name.underscore
+          @document_type || klass.model_name.to_s.underscore
         end
       end
 

data/lib/tire/model/percolate.rb

@@ -2,7 +2,7 @@ module Tire
   module Model
 
     # Contains support for the [percolation](http://www.elasticsearch.org/guide/reference/api/percolate.html)
-    # feature of _ElasticSearch_.
+    # feature of _Elasticsearch_.
     #
     module Percolate
 
@@ -31,7 +31,7 @@ module Tire
         # See <http://www.elasticsearch.org/guide/reference/api/index_.html> for more information.
         #
         def percolate!(pattern=true)
-          @@_percolator = pattern
+          @_percolator = pattern
           self
         end
 
@@ -57,7 +57,7 @@ module Tire
         # Returns the status or pattern of percolator for this class.
         #
         def percolator
-          defined?(@@_percolator) ? @@_percolator : nil
+          @_percolator
         end
       end
 

data/lib/tire/model/persistence.rb

@@ -1,7 +1,7 @@
 module Tire
   module Model
 
-    # Allows to use _ElasticSearch_ as a primary database (storage).
+    # Allows to use _Elasticsearch_ as a primary database (storage).
     #
     # Contains all the `Tire::Model::Search` features and provides
     # an [_ActiveModel_](http://rubygems.org/gems/activemodel)-compatible

data/lib/tire/model/persistence/attributes.rb

@@ -19,7 +19,7 @@ module Tire
           #      property :tags,      :analyzer => 'keywords', :default => []
           #    end
           #
-          # You can pass mapping definition for ElasticSearch in the options Hash.
+          # You can pass mapping definition for Elasticsearch in the options Hash.
           #
           # You can define default property values.
           #
@@ -134,7 +134,7 @@ module Tire
 
               else
                 # Strings formatted as <http://en.wikipedia.org/wiki/ISO8601> are automatically converted to Time
-                value = Time.parse(value) if value.is_a?(String) && value =~ /^\d{4}[\/\-]\d{2}[\/\-]\d{2}T\d{2}\:\d{2}\:\d{2}Z$/
+                value = Time.parse(value).utc if value.is_a?(String) && value =~ /^\d{4}[\/\-]\d{2}[\/\-]\d{2}T\d{2}\:\d{2}\:\d{2}/
                 value
             end
           end

data/lib/tire/model/persistence/storage.rb

@@ -3,7 +3,7 @@ module Tire
 
     module Persistence
 
-      # Provides infrastructure for storing records in _ElasticSearch_.
+      # Provides infrastructure for storing records in _Elasticsearch_.
       #
       module Storage
         def self.included(base)
@@ -34,7 +34,7 @@ module Tire
           end
 
           def update_index
-            send :_run_update_elasticsearch_index_callbacks do
+            run_callbacks :update_elasticsearch_index do
               if destroyed?
                 index.remove self
               else

data/lib/tire/model/search.rb

@@ -52,7 +52,7 @@ module Tire
         #     end
         #
         # This methods returns a Tire::Results::Collection instance, containing instances
-        # of Tire::Results::Item, populated by the data available in _ElasticSearch, by default.
+        # of Tire::Results::Item, populated by the data available in _Elasticsearch, by default.
         #
         # If you'd like to load the "real" models from the database, you may use the `:load` option:
         #
@@ -132,7 +132,7 @@ module Tire
           instance.class.tire.index
         end
 
-        # Updates the index in _ElasticSearch_.
+        # Updates the index in _Elasticsearch_.
         #
         # On model instance create or update, it will store its serialized representation in the index.
         #
@@ -141,7 +141,7 @@ module Tire
         # It will also execute any `<after|before>_update_elasticsearch_index` callback hooks.
         #
         def update_index
-          instance.send :_run_update_elasticsearch_index_callbacks do
+          instance.run_callbacks :update_elasticsearch_index do
             if instance.destroyed?
               index.remove instance
             else
@@ -158,7 +158,7 @@ module Tire
         #
         # If you don't define any mapping, the model is serialized as-is.
         #
-        # If you do define the mapping for _ElasticSearch_, only attributes
+        # If you do define the mapping for _Elasticsearch_, only attributes
         # declared in the mapping are serialized.
         #
         # For properties declared with the `:as` option, the passed String or Proc
@@ -191,15 +191,15 @@ module Tire
 
         def matches
           instance.instance_eval do
-            @attributes ||= {}
-            @attributes['tire__matches']
+            @tire__attributes ||= {}
+            @tire__attributes['matches']
           end
         end
 
         def matches=(value)
           instance.instance_eval do
-            @attributes ||= {}
-            @attributes['tire__matches'] = value
+            @tire__attributes ||= {}
+            @tire__attributes['matches'] = value
           end
         end
 

data/lib/tire/multi_search.rb

@@ -218,12 +218,12 @@ module Tire
         end
 
         def perform
-          @responses = Configuration.client.get(url + params, to_payload)
-          if @responses.failure?
+          @response = Configuration.client.get(url + params, to_payload)
+          if @response.failure?
             STDERR.puts "[REQUEST FAILED] #{to_curl}\n"
-            raise SearchRequestFailed, @responses.to_s
+            raise SearchRequestFailed, @response.to_s
           end
-          @json     = MultiJson.decode(@responses.body)
+          @json     = MultiJson.decode(@response.body)
           @results  = Tire::Search::Multi::Results.new @searches, @json['responses']
           return self
         ensure

data/lib/tire/rubyext/ruby_1_8.rb

@@ -1 +1 @@
-require 'tire/rubyext/uri_escape'
+require 'tire/rubyext/uri_escape' unless defined?(URI.encode_www_form_component) && defined?(URI.decode_www_form_component)

data/lib/tire/search.rb

@@ -48,7 +48,7 @@ module Tire
       end
 
       def params
-        options = @options.except(:wrapper)
+        options = @options.except(:wrapper, :payload)
         options.empty? ? '' : '?' + options.to_param
       end
 

data/lib/tire/search/scan.rb

@@ -34,7 +34,7 @@ module Tire
     #       query { term 'author.exact', 'John Smith' }
     #     end
     #
-    # See ElasticSearch documentation for further reference:
+    # See Elasticsearch documentation for further reference:
     #
     # * http://www.elasticsearch.org/guide/reference/api/search/search-type.html
     # * http://www.elasticsearch.org/guide/reference/api/search/scroll.html

data/lib/tire/tasks.rb

@@ -76,7 +76,7 @@ namespace :tire do
       if defined?(Kaminari) && klass.respond_to?(:page)
         klass.instance_eval do
           def paginate(options = {})
-            page(options[:page]).per(options[:per_page]).to_a
+            page(options[:page]).per(options[:per_page])
           end
         end
       end unless klass.respond_to?(:paginate)

data/lib/tire/version.rb

@@ -1,18 +1,14 @@
 module Tire
-  VERSION   = "0.5.4"
+  VERSION   = "0.5.5"
 
   CHANGELOG =<<-END
     IMPORTANT CHANGES LATELY:
 
-    * Added the support for the Count API
-    * Escape single quotes in `to_curl` serialization
-    * Added JRuby compatibility
-    * Added proper `as_json` support for `Results::Collection` and `Results::Item` classes
-    * Added extracting the `routing` information in the `Index#store` method
-    * Refactored the `update_index` method for search and persistence integration
-    * Cast collection properties in Model::Persistence as empty Array by default
-    * Allow passing `:index` option to `MyModel.import`
-    * Update to Mocha ~> 0.13
-    * Update to MultiJson ~> 1.3
+    * Improved documentation
+    * Improved isolation of Tire methods in model integrations
+    * Improved handling of times/dates in `Model::Persistence`
+    * Added support for "Put Mapping" and "Delete mapping" APIs
+    * Added escaping document IDs in URLs
+    * Allowed passing URL options when passing search definition as a Hash
   END
 end