tire-contrib 0.1.2 → 0.1.3

data/.travis.yml

@@ -5,12 +5,15 @@
 language: ruby
 
 rvm:
+  - 1.8.7
   - 1.9.3
+  - 2.0.0
+  - jruby-19mode
 
 script: "bundle exec rake test"
 
-before_install:
-  - sudo service elasticsearch start
+services:
+  - elasticsearch
 
 notifications:
   disable: true

data/README.markdown

@@ -23,6 +23,10 @@ Adds support for dynamic attributes when using Tire::Model::Persistence so that
 
 Adds support for [“more like this”](http://www.elasticsearch.org/guide/reference/query-dsl/mlt-query.html) queries.
 
+### Fuzzy Like This Queries ###
+
+Adds support for [“fuzzy like this”](http://www.elasticsearch.org/guide/reference/query-dsl/flt-query.html) queries.
+
 ### Custom Filters Score ###
 
 Adds support for [“custom filters score”](http://www.elasticsearch.org/guide/reference/query-dsl/custom-filters-score-query.html) queries.
@@ -31,6 +35,10 @@ Adds support for [“custom filters score”](http://www.elasticsearch.org/guide
 
 Adds support for displaying Tire related statistics in the Rails' log.
 
+### Namespace ###
+
+Adds support for namespace all Index's of an Application
+
 -----
 
 [Karel Minarik](http://karmi.cz) and [contributors](http://github.com/karmi/tire-contrib/contributors)

data/lib/tire-contrib/version.rb

@@ -1,5 +1,5 @@
 module Tire
   module Contrib
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

data/lib/tire/model/active_model_serializer.rb

@@ -0,0 +1,68 @@
+# Active Model Serializer
+# ===================
+#
+# Author: Sergey Efremov <efremov.sergey@gmail.com>
+#
+#
+# Adds support for serialization through ActiveModel::Serializers to Tire::Model::Collection and Tire::Results::Item.
+#
+# ActiveModel::Serializers provide simple way to encapsulate serialization of ActiveModel objects.
+#
+# More info: https://github.com/rails-api/active_model_serializers
+# For Vacancy model from Tire::Result will use TireVacancySerializer, if not exist will fallback to VacancySerializer.
+#
+#
+# Usage
+# -----
+#
+# Require the component:
+#
+#     require 'tire/model/active_model_serializer'
+#
+# Example
+# -------
+#
+#     class Vacancy
+#       include Tire::Model::Search
+#
+#       # ...
+#     end
+#
+#     class VacancySerializer < ActiveModel::Serializer
+#       attributes :position, :body, :location
+#
+#       def location
+#         "#{city}, #{state}, #{country}"
+#       end
+#
+#     end
+#
+#     class VacanciesController < ApplicationController
+#
+#       def index
+#         render json: Vacancy.search(params[:term]), root: false
+#       end
+#
+#     end
+#
+# Response:
+#
+# {
+#   [
+#     {
+#       position: "Developer", body: "Some text", location: "Palo Alto, California, United States"
+#     },
+#     {
+#       position: "Designer", body: "Some text", location: "San Carlos, California, United States"
+#     }
+#   ]
+# }
+#
+#
+
+require 'active_model_serializers'
+require 'tire/model/active_model_serializer/serializer_support'
+
+Tire::Results::Collection.send(:include, ActiveModel::ArraySerializerSupport)
+Tire::Results::Item.send(:include, ActiveModel::SerializerSupport)
+Tire::Results::Item.send(:include, Tire::Model::SerializerSupport)

data/lib/tire/model/active_model_serializer/serializer_support.rb

@@ -0,0 +1,29 @@
+module Tire
+  module Model
+    module SerializerSupport
+
+      extend ActiveSupport::Concern
+
+      if "".respond_to?(:safe_constantize)
+        def tire_active_model_serializer
+          "Tire#{self.class}Serializer".safe_constantize
+        end
+      else
+        def tire_active_model_serializer
+          begin
+            "Tire#{self.class}Serializer".constantize
+          rescue NameError => e
+            raise unless e.message =~ /uninitialized constant/
+          end
+        end
+      end
+
+      # Returns a model serializer for this object considering its namespace.
+      #
+      def active_model_serializer
+        self.tire_active_model_serializer || self.class.active_model_serializer
+      end
+
+    end
+  end
+end

data/lib/tire/namespace.rb

@@ -0,0 +1,29 @@
+# Index Namespace
+# ===============
+#
+# Author: Timo Schilling <timo@schilling.io>
+#
+# This extension allows you to "namespace" index operations in Tire.
+#
+# Usage:
+# ------
+#
+#     require 'tire/namespace'
+#
+#     Tire.configure do
+#       namespace("foo")
+#     end
+#
+#     Tire.index("bar").name
+#     => "foo-bar"
+#
+#     Tire.index("bar").exists?
+#     => curl -I "http://localhost:9200/foo-bar"
+#
+require 'tire/namespace/index'
+require 'tire/namespace/configuration'
+
+module Tire
+  Index.send :include, Tire::Namespace::Index
+  Configuration.send :extend, Tire::Namespace::Configuration
+end

data/lib/tire/namespace/configuration.rb

@@ -0,0 +1,9 @@
+module Tire
+  module Namespace
+    module Configuration
+      def namespace(name = nil)
+        @namespace = name || @namespace
+      end
+    end
+  end
+end

data/lib/tire/namespace/index.rb

@@ -0,0 +1,18 @@
+module Tire
+  module Namespace
+    module Index
+      def self.included klass
+        klass.class_eval do
+
+          # Redefine the `initialize` method to prefix the index name with the namespace
+          #
+          def initialize(name, &block)
+            @name = Tire::Configuration.namespace ? "#{Tire::Configuration.namespace}-#{name}" : name
+            block.arity < 1 ? instance_eval(&block) : block.call(self) if block_given?
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/tire/queries/custom_filters_score/custom_filters_score.rb

@@ -64,6 +64,11 @@ module Tire
           @value
         end
 
+        def params(value)
+          @value[:params] = value
+          @value
+        end
+
         def to_hash
           @value[:filters] ? 
           @value : 

data/lib/tire/queries/fuzzy_like_this.rb

@@ -0,0 +1,44 @@
+# Fuzzy Like This
+# ==============
+
+# Author: Tim van de Langkruis <tim@maximum.nl> 
+# Inspired by: Mereghost <marcello.rocha@gmail.com>
+
+
+# Adds support for "fuzzy_like_this" and "fuzzt_like_this_field" queries in Tire DSL.
+
+# It hooks into the Query class and inserts the fuzzy_like_this and fuzzy_like_this_field query types.
+
+
+# Usage:
+# ------
+
+# Require the component:
+
+#     require 'tire/queries/fuzzy_like_this'
+
+# From that point on you should have the fuzzy_like_this (aliased to flt) and
+# the fuzzy_like_this_field (aliased to flt_field) queries available.
+
+
+# Example:
+# -------
+
+#     Tire.search 'articles' do
+#       query do
+#          fuzzy_like_this 'search for similar text'
+#          fuzzy_like_this_field :field_name, 'similar text'
+#       end
+#     end
+
+# For available options for these queries see:
+
+# * <http://www.elasticsearch.org/guide/reference/query-dsl/flt-query.html>
+# * <http://www.elasticsearch.org/guide/reference/query-dsl/flt-field-query.html>
+
+#
+require 'tire/queries/fuzzy_like_this/fuzzy_like_this'
+
+Tire::Search::Query.class_eval do
+  include Tire::Search::FuzzyLikeThis
+end

data/lib/tire/queries/fuzzy_like_this/fuzzy_like_this.rb

@@ -0,0 +1,28 @@
+module Tire
+  module Search
+    module FuzzyLikeThis
+      def fuzzy_like_this(like_text, options = {})
+        @value = {:flt => {:like_text => like_text}}
+        @value[:flt].update(validate_fuzzy_like_this_options(options))
+        @value
+      end
+
+      def fuzzy_like_this_field(field, like_text, options = {})
+        @value = {:flt_field => {field => {:like_text => like_text}}}
+        # :fields is invalid in this context. Better than doing some kind of meta-black magic.
+        options.delete(:fields)
+        @value[:flt_field][field].update(validate_fuzzy_like_this_options(options))
+        @value
+      end
+
+      alias_method :flt, :fuzzy_like_this
+      alias_method :flt_field, :fuzzy_like_this_field
+
+      private
+      def validate_fuzzy_like_this_options(options)
+        valid_options = [:fields, :ingore_tf, :max_query_terms, :min_similarity, :prefix_length, :boost, :analyzer]
+        options.delete_if { |key, value| !valid_options.member? key }
+      end
+    end
+  end
+end

data/test/active_model_serializer/active_model_serializer_test.rb

@@ -0,0 +1,53 @@
+require 'test_helper'
+
+require 'tire/model/active_model_serializer'
+
+class SomeClass
+  include ActiveModel::SerializerSupport
+end
+
+class SomeClassSerializer
+end
+
+class OtherClass
+  include ActiveModel::SerializerSupport
+end
+
+class TireOtherClassSerializer
+end
+
+class OtherClassSerializer
+end
+
+module Tire
+  module Model
+
+    class ActiveModelSerializerTest < Test::Unit::TestCase
+
+      context "Active model serializer integration in Tire models" do
+
+        should "return nil if no serializer exists" do
+          assert_equal nil, Tire::Results::Item.new({"_type" => "RandomClass"}).active_model_serializer
+        end
+
+        should "return a serializer" do
+          class ::Rails; end
+          assert_equal SomeClassSerializer, Tire::Results::Item.new({"_type" => "SomeClass"}).active_model_serializer
+          Object.class_eval{remove_const :Rails}
+        end
+
+        should "return a Tire prefixed serializer" do
+          class ::Rails; end
+          assert_equal TireOtherClassSerializer, Tire::Results::Item.new({"_type" => "OtherClass"}).active_model_serializer
+          Object.class_eval{remove_const :Rails}
+        end
+
+        should "be an ArraySerializer for Tire::Results::Collection" do
+          assert_equal ActiveModel::ArraySerializer, Tire::Results::Collection.new({}).active_model_serializer
+        end
+
+      end
+
+    end
+  end
+end

data/test/namespace/configuration_test.rb

@@ -0,0 +1,31 @@
+require 'tire'
+require 'tire/namespace'
+require 'shoulda'
+
+module Tire
+  module Namespace
+    class ConfigurationTest < Test::Unit::TestCase
+      context "Namespace" do
+        context "Configuration" do
+          def teardown
+            Tire::Configuration.reset
+          end
+
+          should "extend Tire::Configuration with 'namespace'" do
+            assert_nothing_raised { Tire::Configuration.namespace("foo") }
+          end
+
+          should "set namespace" do
+            Tire::Configuration.namespace("foo")
+            assert_equal "foo", Tire::Configuration.instance_variable_get(:@namespace)
+          end
+
+          should "get namespace" do
+            Tire::Configuration.instance_variable_set(:@namespace, "bar")
+            assert_equal "bar", Tire::Configuration.namespace
+          end
+        end
+      end
+    end
+  end
+end

data/test/namespace/index_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+require 'tire/namespace'
+
+module Tire
+  module Namespace
+    class IndexTest < Test::Unit::TestCase
+      context "Namespaced index" do
+        teardown { Tire::Configuration.reset }
+
+        should "return the name with the namespace" do
+          Tire.configure { namespace "foo" }
+          assert_equal "foo-bar", Tire.index("bar").name
+        end
+
+        should "return the name without the namespace" do
+          assert_equal "bar", Tire.index("bar").name
+        end
+
+        should "work with the namespaced name across the API" do
+          Tire.configure { namespace "foo" }
+          index = Tire.index('bar')
+
+          Tire::Configuration.client.expects(:head).with do |url|
+            assert_equal 'http://localhost:9200/foo-bar', url
+            true
+          end.returns(mock_response('OK'))
+
+          index.exists?
+        end
+      end
+    end
+  end
+end

data/test/queries/custom_filters_score/custom_filters_score_test.rb

@@ -89,8 +89,36 @@ module Tire
           end
         end
 
+        should "allow setting params" do
+          query = Query.new.custom_filters_score do
+            query { term :foo, 'bar' }
+            params :a => 'b'
+          end
+
+          f = query[:custom_filters_score]
+          assert_equal( { :term => { :foo => { :term => 'bar' } } }, f[:query].to_hash )
+          assert_equal( { :a => 'b' }, f[:params] )
+        end
+
+        should "allow using script parameters" do
+          score_script = "foo * 2"
+
+          query = Query.new.custom_filters_score do
+            query { string 'foo' }
+
+            params :foo => 42
+
+            filter do
+              filter :exists, :field => 'date'
+              script score_script
+            end
+          end
+
+          f = query[:custom_filters_score]
+          assert_equal 42, f[:params][:foo]
+        end
       end
+
     end
-    
   end
 end

data/test/queries/fuzzy_like_this/fuzzy_like_this_test.rb

@@ -0,0 +1,42 @@
+require 'tire'
+require 'tire/queries/fuzzy_like_this'
+require 'shoulda'
+
+module Tire
+  module Search
+    class FuzzyLikeThisTest < Test::Unit::TestCase
+      context "Fuzzy Like This queries" do
+        should "search for similar documents" do
+          assert_equal({:flt => {:like_text => 'similar text'}}, Query.new.flt('similar text'))
+        end
+      end
+
+      should "allow to pass a list of fields to a flt query" do
+        assert_equal({:flt => {:like_text => 'similar text', :fields => ['foo', 'bar.baz']}},
+                     Query.new.flt('similar text', :fields => ['foo', 'bar.baz']))
+
+        assert_equal({:flt => {:like_text => 'similar text', :fields => ['foo', 'bar.baz'], :min_similarity => 0.8}},
+                     Query.new.flt('similar text', :fields => ['foo', 'bar.baz'], :min_similarity => 0.8))
+      end
+
+     should "search for similar text on a selected field (flt_field)" do
+        assert_equal({:flt_field => {:foo => {:like_text => 'similar text'}}},
+                     Query.new.flt_field(:foo, 'similar text'))
+
+        assert_equal({:flt_field => {:foo => {:like_text => 'similar text', :min_similarity => 0.8}}},
+                     Query.new.flt_field(:foo, 'similar text', :min_similarity => 0.8))
+      end
+      
+
+      context "validate the options passed" do
+        should "drop all the invalid keys" do
+          assert_equal({:flt => {:like_text => 'similar text', :fields => ['foo', 'bar.baz']}},
+                       Query.new.flt('similar text', :fields => ['foo', 'bar.baz'], :foo => :bar))
+
+          assert_equal({:flt_field => {:foo => {:like_text => 'similar text'}}},
+                       Query.new.flt_field(:foo, 'similar text', :fields => [:bar]))
+        end
+      end
+    end
+  end
+end

data/tire-contrib.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |s|
   s.name        = "tire-contrib"
   s.version     = Tire::Contrib::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Karel Minarik", "Oliver Eilhard", "Dave Kinkead"]
-  s.email       = ["karmi@karmi.cz", "oliver.eilhard@gmail.com", "dave@kinkead.com.au"]
+  s.authors     = ["Karel Minarik", "Oliver Eilhard", "Dave Kinkead", "Sergey Efremov"]
+  s.email       = ["karmi@karmi.cz", "oliver.eilhard@gmail.com", "dave@kinkead.com.au", "efremov.sergey@gmail.com"]
   s.homepage    = ""
   s.summary     = %q{Contributions and additions for the Tire gem}
 
@@ -19,6 +19,8 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "newrelic_rpm"
 
+  s.add_development_dependency "active_model_serializers"
+
   s.add_development_dependency "turn"
   s.add_development_dependency "shoulda"
   s.add_development_dependency "mocha"

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: tire-contrib
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
 - Karel Minarik
 - Oliver Eilhard
 - Dave Kinkead
+- Sergey Efremov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-21 00:00:00.000000000 Z
+date: 2013-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tire
@@ -61,6 +62,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: turn
   requirement: !ruby/object:Gem::Requirement
@@ -162,6 +179,7 @@ email:
 - karmi@karmi.cz
 - oliver.eilhard@gmail.com
 - dave@kinkead.com.au
+- efremov.sergey@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -179,13 +197,20 @@ files:
 - lib/tire-contrib/version.rb
 - lib/tire/README.markdown
 - lib/tire/http/clients/pooled_curb.rb
+- lib/tire/model/active_model_serializer.rb
+- lib/tire/model/active_model_serializer/serializer_support.rb
 - lib/tire/model/dynamic_persistence.rb
 - lib/tire/model/dynamic_persistence/README.markdown
 - lib/tire/model/dynamic_persistence/dynamic_persistence.rb
+- lib/tire/namespace.rb
+- lib/tire/namespace/configuration.rb
+- lib/tire/namespace/index.rb
 - lib/tire/new_relic/instrumentation.rb
 - lib/tire/new_relic/model.rb
 - lib/tire/queries/custom_filters_score.rb
 - lib/tire/queries/custom_filters_score/custom_filters_score.rb
+- lib/tire/queries/fuzzy_like_this.rb
+- lib/tire/queries/fuzzy_like_this/fuzzy_like_this.rb
 - lib/tire/queries/more_like_this.rb
 - lib/tire/queries/more_like_this/more_like_this.rb
 - lib/tire/rails/logger.rb
@@ -193,11 +218,15 @@ files:
 - lib/tire/rails/logger/instrumentation.rb
 - lib/tire/rails/logger/log_subscriber.rb
 - lib/tire/rails/logger/railtie.rb
+- test/active_model_serializer/active_model_serializer_test.rb
 - test/dynamic_persistence/dynamic_persistence_test.rb
+- test/namespace/configuration_test.rb
+- test/namespace/index_test.rb
 - test/new_relic/config/newrelic.yml
 - test/new_relic/instrumentation_test.rb
 - test/new_relic/model.rb
 - test/queries/custom_filters_score/custom_filters_score_test.rb
+- test/queries/fuzzy_like_this/fuzzy_like_this_test.rb
 - test/queries/more_like_this/more_like_this_test.rb
 - test/rails/logger/active_record_article.rb
 - test/rails/logger/log_subscriber_test.rb
@@ -229,11 +258,15 @@ signing_key:
 specification_version: 3
 summary: Contributions and additions for the Tire gem
 test_files:
+- test/active_model_serializer/active_model_serializer_test.rb
 - test/dynamic_persistence/dynamic_persistence_test.rb
+- test/namespace/configuration_test.rb
+- test/namespace/index_test.rb
 - test/new_relic/config/newrelic.yml
 - test/new_relic/instrumentation_test.rb
 - test/new_relic/model.rb
 - test/queries/custom_filters_score/custom_filters_score_test.rb
+- test/queries/fuzzy_like_this/fuzzy_like_this_test.rb
 - test/queries/more_like_this/more_like_this_test.rb
 - test/rails/logger/active_record_article.rb
 - test/rails/logger/log_subscriber_test.rb