algoliasearch-rails 1.5.2 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be6d06df4e6fd61f5f9daaf332cac49de42870a6
-  data.tar.gz: de4d74b403c0e516906c246675bd3fa0f0b9addc
+  metadata.gz: 8feeca38d2aa84b13c89e975e579b7456808a757
+  data.tar.gz: 049c7c330a2983dc20bfdbc4f37ade5bb99b990c
 SHA512:
-  metadata.gz: 4d945380296434a3f38af3ec53742b0939f08dd599e2392f75e3615f1a3fc801c48b57a2715170df8139b48d0b36ad1f975d34f3686b779804ddcdc4538d2405
-  data.tar.gz: 6909f7711b56635e99c8ebe3c260a957c36c4c68126acd9a317c0edb07cae0c3c3ff779b733e8a9dc4cad469bcdc17d20eac8e98b78c3f6107257e7df41f28e5
+  metadata.gz: fb011991d9d67bd2f928f6f87b95b8c4e0a187659c5a235fe2aee09e1ba17606720c609dcfaef7911de6cf9d4cebb0bb4d24417df7cd42b81b595519345bb859
+  data.tar.gz: 5f1580a4c50586325fabeb28d8099344d643d2bcf46fdcb5a2dd9a27852b169bb3f628fe60d54959400832d6448814baa15bcdacb326f26a31e20de67dbe4d39

data/ChangeLog

@@ -1,5 +1,10 @@
 CHANGELOG
 
+2013-12-05  1.6.1
+
+      * ```add_attribute``` can now be used to add extra attributes in addition to the existing ones
+      * Use the ```geoloc``` and ```tags``` methods to generate the associated ```_tags``` and ```_geoloc``` attributes
+
 2013-12-05  1.5.2
 
       * object's attributes must be fetched unscoped to ensure associations will not be impacted by the conditions

data/README.md

@@ -17,6 +17,8 @@ Table of Content
 1. [Quick Start](#quick-start)
 1. [Options](#options)
 1. [Indexing](#indexing)
+1. [Tags](#tags)
+1. [Geo-search](#geo-search)
 1. [Search settings](#search-settings)
 1. [Typeahead UI](#typeahead-ui)
 1. [Note on testing](#note-on-testing)
@@ -70,7 +72,7 @@ class Contact < ActiveRecord::Base
 end
 ```
 
-You can either specify the attributes to send (here we restrict to <code>:first_name, :last_name, :email</code>) or not (in that case, all attributes are sent).
+You can either specify the attributes to send (here we restricted to <code>:first_name, :last_name, :email</code>) or not (in that case, all attributes are sent).
 
 ```ruby
 class Product < ActiveRecord::Base
@@ -82,6 +84,23 @@ class Product < ActiveRecord::Base
 end
 ```
 
+You can also use the <code>add_attribute</code> method, to send all model attributes + extra ones:
+
+```ruby
+class Product < ActiveRecord::Base
+  include AlgoliaSearch
+
+  algoliasearch do
+    # all attributes + extra_attr will be sent
+    add_attribute :extra_attr
+  end
+
+  def extra_attr
+    "extra_val"
+  end
+end
+```
+
 ```ruby
 p Contact.search("jon doe")
 ```
@@ -204,6 +223,53 @@ To clear an index, use the <code>clear_index!</code> class method:
 Contact.clear_index!
 ```
 
+Tags
+-----
+
+Use the <code>tags</code> method to add tags to your record:
+
+```ruby
+class Contact < ActiveRecord::Base
+  include AlgoliaSearch
+
+  algoliasearch do
+    tags ['trusted']
+  end
+end
+```
+
+or using dynamical values:
+
+```ruby
+class Contact < ActiveRecord::Base
+  include AlgoliaSearch
+
+  algoliasearch do
+    tags do
+      [first_name.blank? || last_name.blank? ? 'partial' : 'full', has_valid_email? ? 'valid_email' : 'invalid_email']
+    end
+  end
+end
+```
+
+At query time, specify <code>{ tagFilters: 'tagvalue' }</code> or <code>{ tagFilters: ['tagvalue1', 'tagvalue2'] }</code> as search parameters to restrict the result set to specific tags.
+
+Geo-Search
+-----------
+
+Use the <code>geoloc</code> method to localize your record:
+
+```ruby
+class Contact < ActiveRecord::Base
+  include AlgoliaSearch
+
+  algoliasearch do
+    tags ['trusted']
+  end
+end
+```
+
+At query time, specify <code>{ aroundLatLng: "37.33, -121.89", aroundRadius: 50000 }</code> as search parameters to restrict the result set to 50KM around San Jose.
 
 Search settings
 ----------

data/VERSION

@@ -1 +1 @@
-1.5.2
+1.6.1

data/algoliasearch-rails.gemspec

@@ -2,14 +2,15 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+# stub: algoliasearch-rails 1.6.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "algoliasearch-rails"
-  s.version = "1.5.2"
+  s.version = "1.6.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Algolia"]
-  s.date = "2013-12-05"
+  s.date = "2013-12-12"
   s.description = "AlgoliaSearch integration to your favorite ORM"
   s.email = "contact@algolia.com"
   s.extra_rdoc_files = [
@@ -47,7 +48,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/algolia/algoliasearch-rails"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "2.0.12"
+  s.rubygems_version = "2.1.11"
   s.summary = "AlgoliaSearch integration to your favorite ORM"
 
   if s.respond_to? :specification_version then

data/lib/algoliasearch-rails.rb

@@ -64,14 +64,39 @@ module AlgoliaSearch
       raise ArgumentError.new('Cannot pass multiple attribute names if block given') if block_given? and names.length > 1
       @attributes ||= {}
       names.each do |name|
-        @attributes[name] = block_given? ? Proc.new { |o| o.instance_eval(&block) } : Proc.new { |o| o.send(name) }
+        @attributes[name.to_s] = block_given? ? Proc.new { |o| o.instance_eval(&block) } : Proc.new { |o| o.send(name) }
       end
     end
+    alias :attributes :attribute
+
+    def add_attribute(*names, &block)
+      raise ArgumentError.new('Cannot pass multiple attribute names if block given') if block_given? and names.length > 1
+      @additional_attributes ||= {}
+      names.each do |name|
+        @additional_attributes[name.to_s] = block_given? ? Proc.new { |o| o.instance_eval(&block) } : Proc.new { |o| o.send(name) }
+      end
+    end
+    alias :add_attributes :add_attribute
 
     def get_attributes(object)
       object.class.unscoped do
-        return object.attributes if @attributes.nil? or @attributes.length == 0
-        Hash[@attributes.map { |name, value| [name.to_s, value.call(object) ] }]
+        res = @attributes.nil? || @attributes.length == 0 ? object.attributes :
+          Hash[@attributes.map { |name, value| [name.to_s, value.call(object) ] }]
+        @additional_attributes.each { |name, value| res[name.to_s] = value.call(object) } if @additional_attributes
+        res
+      end
+    end
+
+    def geoloc(lat_attr, lng_attr)
+      add_attribute :_geoloc do |o|
+        { lat: o.send(lat_attr).to_f, lng: o.send(lng_attr).to_f }
+      end
+    end
+
+    def tags(*args, &block)
+      add_attribute :_tags do |o|
+        v = block_given? ? o.instance_eval(&block) : args
+        v.is_a?(Array) ? v : [v]
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch-rails
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.6.1
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-05 00:00:00.000000000 Z
+date: 2013-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -148,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.12
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: AlgoliaSearch integration to your favorite ORM