tire-suggest_plugin 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 419896fca18e0300dbe135351d5d89e5d3828e44
+  data.tar.gz: a9f50303c4abff70d8b101fa11d5c336b38e4b07
+SHA512:
+  metadata.gz: d062e70347a01ca62de67394dc60a18bcc98b420b1c439d930281fdca1802499d1b6a32e3625a817813940d798997d2ff1e1f6b48048412bd88e0845166d7b77
+  data.tar.gz: d4d960d992d999adf95eb539a112d342aa683cadb2e7682951233e768475cd5dfd3946f20a62778ba61a543413f35939087348769308509f39d512856cbff3b0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tire-suggest-plugin.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dmitry Zhlobo
+
+MIT License
+
+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.md

@@ -0,0 +1,24 @@
+# Tire for [Suggester Plugin for Elasticsearch](https://github.com/spinscale/elasticsearch-suggest-plugin)
+
+Addition for [Tire](https://github.com/karmi/tire) to work with suggester plugin for elasticsearch: https://github.com/spinscale/elasticsearch-suggest-plugin.
+
+Now it's just *build-it-fast-and-check-if-it-works* version. Stay tune for updates.
+
+## Usage
+
+### Searching for suggestions
+
+```ruby
+Tire.suggest('cars', field: 'name.suggest', term: 'au').suggestions
+#=> ["audi", "audi 100", "audi 200", "audi 80", "audi 90", "audi a2", "audi a3", "audi a4", "audi a5", "audi a6"]
+```
+
+### Searching by several indices
+
+```ruby
+Tire.suggest ['cars', 'ads'] do
+  field 'name'
+  term 'bmw x'
+end.suggestions
+#=> ["bmw x3", "bmw x5"]
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/tire/suggest_plugin/params.rb

@@ -0,0 +1,33 @@
+module Tire::SuggestPlugin
+  AVAILABLE_PARAMS = [:field, :term, :size]
+  class Params < Struct.new(*AVAILABLE_PARAMS)
+
+    def initialize(params={})
+      AVAILABLE_PARAMS.each do |param_name|
+        send("#{param_name}=", params[param_name])
+      end
+    end
+
+    AVAILABLE_PARAMS.each do |param_name|
+      define_method(param_name) do |value=nil|
+        if value.nil?
+          super()
+        else
+          send("#{param_name}=", value)
+        end
+      end
+    end
+
+    def to_json
+      MultiJson.dump(self.to_hash)
+    end
+
+    def to_hash
+      result = {}
+      AVAILABLE_PARAMS.each do |param_name|
+        result[param_name] = send(param_name)
+      end
+      result
+    end
+  end
+end

data/lib/tire/suggest_plugin/suggestions.rb

@@ -0,0 +1,7 @@
+module Tire::SuggestPlugin
+  class Suggestions < Array
+    def initialize(response={})
+      super(response['suggestions'])
+    end
+  end
+end

data/lib/tire/suggest_plugin/version.rb

@@ -0,0 +1,5 @@
+module Tire
+  module SuggestPlugin
+    VERSION = "0.0.1"
+  end
+end

data/lib/tire/suggest_plugin.rb

@@ -0,0 +1,42 @@
+require 'tire'
+require 'tire/suggest_plugin/version'
+require 'tire/suggest_plugin/params'
+require 'tire/suggest_plugin/suggestions'
+
+module Tire::SuggestPlugin
+  class SuggestRequiestFailed < StandardError; end
+
+  class Suggest
+    def initialize(indices=nil, options={}, &block)
+      @indices = Array(indices)
+
+      @params = Params.new(options)
+      if block_given?
+        block.arity < 1 ? @params.instance_eval(&block) : block.call(@params)
+      end
+    end
+
+    def suggestions
+      @suggestions or (perform and @suggestions)
+    end
+
+    def perform
+      response = Tire::Configuration.client.get(self.url, @params.to_json)
+      if response.failure?
+        STDERR.puts "[REQUEST FAILED] #{self.to_curl}\n"
+        raise SuggestRequestFailed, response.to_s
+      end
+      @suggestions = Suggestions.new(MultiJson.load(response.body))
+    end
+
+    def url
+      path = ['/', @indices.join(','), '_suggest'].join('/').squeeze('/')
+      Tire::Configuration.url + path
+    end
+
+    def to_curl
+      params_to_json_escaped = @params.to_json.gsub("'", '\u0027')
+      "curl -X GET '#{url}' -d '#{params_to_json_escaped}'"
+    end
+  end
+end

data/lib/tire-suggest_plugin.rb

@@ -0,0 +1,15 @@
+require 'tire/suggest_plugin'
+
+module Tire
+  module DSL
+    def suggest(indices=nil, options={}, &block)
+      if block_given?
+        Tire::SuggestPlugin::Suggest.new(indices, options, &block)
+      elsif options.respond_to?(:to_hash)
+        Tire::SuggestPlugin::Suggest.new(indices, options.to_hash)
+      else
+        raise ArgumentError, "Please pass a Ruby Hash or an object with `to_hash` method, not #{options.class}"
+      end
+    end
+  end
+end

data/tire-suggest_plugin.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tire/suggest_plugin/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tire-suggest_plugin"
+  spec.version       = Tire::SuggestPlugin::VERSION
+  spec.authors       = ["Dmitry Zhlobo"]
+  spec.email         = ["dima.zhlobo@gmail.com"]
+  spec.description   = "Addition for Tire to work with suggester plugin for elasticsearch"
+  spec.summary       = "Addition for Tire to work with suggester plugin for elasticsearch"
+  spec.homepage      = "https://github.com/twinslash/tire-suggest-plugin"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "tire", "~> 0.5.8"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: tire-suggest_plugin
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dmitry Zhlobo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tire
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.8
+description: Addition for Tire to work with suggester plugin for elasticsearch
+email:
+- dima.zhlobo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tire-suggest_plugin.rb
+- lib/tire/suggest_plugin.rb
+- lib/tire/suggest_plugin/params.rb
+- lib/tire/suggest_plugin/suggestions.rb
+- lib/tire/suggest_plugin/version.rb
+- tire-suggest_plugin.gemspec
+homepage: https://github.com/twinslash/tire-suggest-plugin
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: Addition for Tire to work with suggester plugin for elasticsearch
+test_files: []