goodyear 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5c0e7a5df2d732be684ff4696771e3f6746a363c
+  data.tar.gz: 731af182b52f774cd37d02ce2f05755c4addd351
+SHA512:
+  metadata.gz: 87df72d054ec674f2b3b06e8ebb747001dc7a7ed709627a7dcfad7848337dcc478f12c3d3141737f0f60a04def4f6183073274bdb38aed32e758554e940b509a
+  data.tar.gz: 57ee26b0a4f0cfa3f2038980ad235b084b56aca6e5807ad3f8527f7e0a07747d48d92e3c1ed6622008b3a76a3cd515e975f942b01d8da09e3a7e3b1aea3bf850

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 goodyear.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Spencer Markowski
+
+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,171 @@
+# Goodyear
+
+Adds ActiveRecord-like query interface to Tire.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'goodyear'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install goodyear
+
+## Usage
+
+
+```ruby
+class SomeModel < Tire
+    include Goodyear::ElasticQuery
+end
+```
+
+#### Better persistence via dynamic attributes. 
+
+Including `Goodyear::Persistence` in your model means you don't have to worry about defining everything with Tire's `#property` method. 
+
+```ruby
+class SomeModel < Tire
+    include Goodyear::ElasticQuery
+    include Goodyear::Persistence
+end
+```
+
+
+### Query Builder
+
+#### where()
+
+```ruby
+SomeModel.where( published: true, topic: "goats")
+```
+
+#### or()
+
+```ruby
+SomeModel.where(status: 'inactive').or.where( retired: true)
+```
+
+#### sort()
+
+Orders results by field
+
+```ruby
+SomeModel.where( published: true, name: "Candy").sort(:score, :desc)
+```
+
+#### fields()
+
+Specify fields to include in results
+
+```ruby
+SomeModel.where( published: true, name: "Candy").fields(:published, :name, :score)
+```
+
+#### first()
+
+Sets size to 1 and fetches the first result. Returns `SomeModel`
+
+```ruby
+SomeModel.where( published: true, name: "Candy").first
+```
+
+#### last()
+
+Returns the last result
+
+```ruby
+SomeModel.where( published: true).last
+```
+
+
+#### fetch()
+
+Exectues the query and returns `TireCollection`
+
+```ruby
+SomeModel.where( published: true).size(100).sort(:score, :desc)
+```
+
+
+#### routing(id)
+
+Sets routing to id in search options and returns `SomeModel`
+
+```ruby
+SomeModel.routing(10).where( published: true)
+```
+
+#### count
+
+Sets search_type to 'count' in search options, fetches and returns total
+
+```ruby
+SomeModel.where( published: true).count
+```
+
+#### search_options(options = {})
+
+Sets search options. Overwrites previously set values
+
+```ruby
+SomeModel.search_options(routing: 1, search_type: 'count').where( published: true).fetch
+```
+
+
+### Scopes
+
+Add chainable scopes just like you do in ActiveRecord. 
+
+```ruby
+class SomeModel
+  include Tire::Model::Persistence
+  include ActiveRecord::Callbacks
+  include Goodyear::ElasticQuery
+  include Goodyear::Persistence
+...
+  scope :published, -> { where published: true }
+end
+```
+
+### Facets
+
+Terms facet
+```ruby
+SomeModel.where(created_at: 1.year.ago).facet('top_users') { terms 'users', size: 50 }
+```
+
+Or maybe a date histogram facet:
+```ruby
+SomeModel.facet('stats') { date :created_at, interval: "1m", 
+                           pre_zone_adjust_large_interval: true, 
+                           time_zone: "-0500"}
+```
+
+
+
+### Query Filters
+
+```ruby
+SomeModel.where(width: 10).filter(:range,  {height: { gte: 10, lte: 200} })
+```
+
+There's also a convenience method for Exists filters. 
+
+```ruby
+SomeModel.has_field?(:width).where(width:10)
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/goodyear.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'goodyear/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "goodyear"
+  spec.version       = Goodyear::VERSION
+  spec.authors       = ["Spencer Markowski"]
+  spec.email         = ["spencer@theablefew.com"]
+  spec.description   = %q{ActiveRecord-like query interface for tire}
+  spec.summary       = %q{ActiveRecord-like query interface for tire}
+  spec.homepage      = "https://github.com/theablefew/goodyear"
+  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"
+end

data/lib/goodyear/boolean_methods.rb

@@ -0,0 +1,8 @@
+module Goodyear
+  module BooleanMethods
+    def or
+      self.add_query_segment
+      return self
+    end
+  end
+end

data/lib/goodyear/enumerable.rb

@@ -0,0 +1,23 @@
+module Goodyear
+  module Enumerable
+     def each &block
+        fetch.results.each do |result|
+          if block_given?
+            block.call result
+          else
+            yield result
+          end
+        end
+      end
+
+     def collect &block
+       fetch.results.collect do |result|
+         if block_given? 
+           block.call result
+         else
+           yield result
+         end
+       end
+     end
+  end
+end

data/lib/goodyear/facet_methods.rb

@@ -0,0 +1,9 @@
+module Goodyear
+  module FacetMethods
+    def facet(name, options = {}, &block)
+      @_facets ||= []
+      @_facets << {name: name, args: options, l: block}
+      return self
+    end
+  end
+end

data/lib/goodyear/filter_methods.rb

@@ -0,0 +1,21 @@
+module Goodyear
+  module FilterMethods
+    def filter(name, options = {}, &block)
+      @_filters ||= []
+      @_filters << {name: name, args: options, l: block}
+      return self
+    end
+
+    def has_field?(field)
+      filter :exists, {field: field}
+      return self
+    end
+
+    def query_filter(name,  options = {})
+      @_query_filters ||= []
+      @_query_filters << {name: name,  options: options}
+      self
+    end
+
+  end
+end

data/lib/goodyear/finder_methods.rb

@@ -0,0 +1,61 @@
+module Goodyear
+  module FinderMethods
+    def where(*query)
+      serialize_arguments(query)
+      return self
+    end
+
+    def fields(*f)
+      @_fields ||= []
+      @_fields = f.collect(&:to_s)
+      return self
+    end
+
+    def size(size)
+      @_size = size
+      return self
+    end
+
+    def sort(*sort_order)
+      @_sort = sort_order.compact
+      return self
+    end
+    alias :order :sort
+
+    def highlight(fields)
+      @_highlights = fields
+      return self
+    end
+
+    def first
+      self.size(1) #maybe more performant?
+      self.fetch.first
+    end
+
+    def last
+      self.size(1).fetch.results.last
+    end
+
+    def all
+      self.size(9999).fetch
+    end
+
+    protected
+    def add_query_segment
+      @query_segments ||= []
+      @query_segments << @_and
+      @_and = []
+    end
+
+    private
+    def serialize_arguments(q)
+      @_and ||= []
+      q.each do |arg|
+        arg.each_pair { |k,v|  @_and << "#{k}:#{v}" } if arg.class == Hash
+        @_and << arg if arg.class == String
+      end
+    end
+
+
+  end
+end

data/lib/goodyear/persistence.rb

@@ -0,0 +1,13 @@
+module Goodyear
+  module Persistence
+    def initialize(attrs={})
+        attrs.each do |attr, value|
+            # call Tire's property method if it hasn't been set explicitly
+            self.class.property attr unless self.class.property_types.keys.include? attr
+            # set instance variable
+            instance_variable_set("@#{attr}", value) 
+        end
+        super attrs
+    end
+  end
+end

data/lib/goodyear/query.rb

@@ -0,0 +1,51 @@
+module Goodyear
+  class Query
+    def initialize(q,f,s, sort, highlights, facets, filters, query_filters)
+      @q = q || []
+      @f = f || []
+      @s = s || []
+      @sort = sort || []
+      @highlights = highlights || []
+      @facets = facets
+      @filters = filters
+      @query_filters = query_filters || []
+    end
+
+    def facets
+      @facets || []
+    end
+
+    def filters
+      @filters || []
+    end
+
+    def query
+      @q
+    end
+
+    def fields
+      @f
+    end
+
+    def highlights
+      @highlights
+    end
+
+    def size
+      @s
+    end
+
+    def sort
+      @sort
+    end
+
+    def query_filters
+     @query_filters
+    end
+
+
+    private
+
+
+  end
+end

data/lib/goodyear/query_cache.rb

@@ -0,0 +1,44 @@
+module Goodyear
+  module QueryCache
+
+    def store
+     @query_cache ||= setup_store!
+    end
+
+    def cache_query(query)
+      cache_key = sha(query)
+      Goodyear.force_cache
+      result = if store.exist?(cache_key) && Goodyear.force_cache
+          ActiveSupport::Notifications.instrument "cache.query.elasticsearch", name: self.name, query: query
+          store.fetch cache_key
+        else
+          res = []
+          ActiveSupport::Notifications.instrument "query.elasticsearch", name: self.name, query: query do
+            res = yield
+          end
+          store.write(cache_key, res) if Goodyear.force_cache
+          res
+        end
+      result.dup
+    end
+
+
+    private
+
+    def sha(str)
+      Digest::SHA256.new.hexdigest(str)
+    end
+
+    def setup_store!
+     case Rails.application.config.goodyear_cache_store
+     when :redis_store
+       ActiveSupport::Cache::RedisStore
+     when :memory_store
+       ActiveSupport::Cache::MemoryStore
+     else
+       ActiveSupport::Cache::MemoryStore
+     end.new(namespace: 'elasticsearch', expires_in: Rails.application.config.goodyear_expire_cache_in)
+    end
+
+  end
+end

data/lib/goodyear/query_methods.rb

@@ -0,0 +1,127 @@
+require 'goodyear/query'
+require 'goodyear/finder_methods'
+require 'goodyear/facet_methods'
+require 'goodyear/filter_methods'
+require 'goodyear/boolean_methods'
+require 'goodyear/query_cache'
+require 'goodyear/enumerable'
+
+module Goodyear
+  module QueryMethods
+    include Goodyear::FinderMethods
+    include Goodyear::BooleanMethods
+    include Goodyear::FacetMethods
+    include Goodyear::FilterMethods
+    include Goodyear::QueryCache
+
+    def fetch
+      es = self.perform
+      options = {wrapper: self, type: document_type}
+      options.merge!( @_search_options ) unless @_search_options.nil?
+
+      @_search_options = nil
+
+      tire = Tire::Search::Search.new(self.index_name, options)
+      if es.query_filters.empty?
+        tire.query { string es.query } unless es.query.blank?
+      else
+        tire.query do
+          filtered do
+            query { string es.query } unless es.query.blank?
+            es.query_filters.each { |f| filter(f[:name], f[:options]) }
+          end
+        end
+      end
+
+      tire.sort{ by *es.sort } unless es.sort.blank?
+      tire.size( es.size ) unless es.size.nil?
+      tire.fields( es.fields ) unless es.fields.empty?
+      tire.highlight( es.highlights ) unless es.highlights.empty?
+
+      es.filters.each do |f|
+        tire.filter(f[:name], f[:args], &f[:l])
+      end
+
+      es.facets.each do |f|
+        tire.facet(f[:name], f[:args], &f[:l] )
+      end
+
+      cache_query(tire.to_curl) { tire.version(true).results }
+
+    end
+
+    def perform
+      construct_query
+      esq = Query.new(@_query, @_fields, @_size, @_sort, @_highlights, @_facets, @_filters, @_query_filters)
+      clean
+      return esq
+    end
+
+    def search_options(options)
+      @_search_options = options
+      self
+    end
+
+    def search_type(type)
+      @_search_options ||= {}
+      @_search_options.merge! search_type: type
+      self
+    end
+
+    def count
+      search_type 'count'
+      fetch.total
+    end
+
+    def results
+      fetch.results
+    end
+
+    def routing(r)
+      @_search_options ||= {}
+      @_search_options.merge! routing: r
+      self
+    end
+
+    def scope(name, scope_options = {})
+      name = name.to_sym
+
+      scope_proc = lambda do |*args|
+        options = scope_options.respond_to?(:call) ? scope_options.call(*args) : scope_options
+      end
+
+      singleton_class.send(:define_method, name, &scope_proc)
+    end
+
+    alias :to_query :perform
+
+    def reset_query
+      clean
+    end
+
+    private
+
+    def clean
+      @_fields = []
+      @_and    = []
+      @_size   =  nil
+      @_sort   = []
+      @_or     = []
+      @_facets = []
+      @_filters = []
+      @_highlights = []
+      @query_segments = []
+      @_query_filters = nil
+    end
+
+    def construct_query
+      @query_segments ||= []
+      @query_segments << @_and
+      @_query = @query_segments.collect do |segment| 
+        next if segment.nil?
+        segment.uniq.join(" AND ")
+      end.join(" OR ")
+    end
+
+  end
+end

data/lib/goodyear/railtie.rb

@@ -0,0 +1,27 @@
+module Goodyear
+  class Railtie < Rails::Railtie
+    include ActionView::Helpers::NumberHelper
+    def time_diff(start, finish)
+      begin
+        ((finish.to_time - start.to_time) * 1000).to_s(:rounded, precision: 5, strip_insignificant_zeros: true)
+      rescue
+        number_with_precision((finish.to_time - start.to_time) * 1000, precision: 5, strip_insignificant_zeros: true)
+      end
+    end
+
+    ActiveSupport::Notifications.subscribe 'query.elasticsearch' do |name, start, finish, id, payload|
+      Rails.logger.info(["#{payload[:name]}".bright, "(#{time_diff(start,finish)}ms)",payload[:query]].join(" ").color(:yellow))
+    end 
+
+    ActiveSupport::Notifications.subscribe 'cache.query.elasticsearch' do |name, start, finish, id, payload|
+      Rails.logger.info(["#{payload[:name]}".bright, "CACHE".color(:magenta).bright ,"(#{time_diff(start,finish)}ms)", payload[:query]].join(" ").color(:yellow))
+    end
+
+    initializer 'goodyear.set_defaults' do
+      config.goodyear_cache_store = :redis_store
+      config.goodyear_expire_cache_in = 15.minutes
+      #config.goodyear_perform_caching = true
+    end
+
+  end
+end

data/lib/goodyear/version.rb

@@ -0,0 +1,3 @@
+module Goodyear
+  VERSION = "0.1.0"
+end

data/lib/goodyear.rb

@@ -0,0 +1,28 @@
+require 'goodyear/railtie' if defined?(Rails)
+require "goodyear/version"
+require "goodyear/query_methods"
+require 'goodyear/persistence'
+
+module Goodyear
+  mattr_accessor :force_cache
+  @@force_cache = false
+
+  module ElasticQuery
+
+      def self.included(base)
+        base.extend(Goodyear::QueryMethods)
+      end
+
+      def escape_id
+        id.gsub('-','\\-')
+      end
+  end
+
+  def self.cache
+    Goodyear.force_cache = true
+    lm = yield
+    Goodyear.force_cache = false
+    lm
+  end
+end
+

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: goodyear
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Spencer Markowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-25 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'
+description: ActiveRecord-like query interface for tire
+email:
+- spencer@theablefew.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- goodyear.gemspec
+- lib/goodyear.rb
+- lib/goodyear/boolean_methods.rb
+- lib/goodyear/enumerable.rb
+- lib/goodyear/facet_methods.rb
+- lib/goodyear/filter_methods.rb
+- lib/goodyear/finder_methods.rb
+- lib/goodyear/persistence.rb
+- lib/goodyear/query.rb
+- lib/goodyear/query_builder.rb
+- lib/goodyear/query_cache.rb
+- lib/goodyear/query_methods.rb
+- lib/goodyear/railtie.rb
+- lib/goodyear/version.rb
+homepage: https://github.com/theablefew/goodyear
+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.6
+signing_key: 
+specification_version: 4
+summary: ActiveRecord-like query interface for tire
+test_files: []