algoliasearch 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1673fe77906c67ae24f6f8beeb96c744df33a9c
-  data.tar.gz: cbdae006907dc974cc70d14c1827b03f11326523
+  metadata.gz: 3e76972bfa991277d06f88eb6a26127541bf6f39
+  data.tar.gz: 77fcd139aea3c16ea07954bc8f2c2aa5170d5188
 SHA512:
-  metadata.gz: ae2decbf23a90d5d2d35231ebba879e33c30b9b83b93dc17354ebb7d4d087fa61ec12f2ad3536b2c15e2b575590d1420633bf7b0236429ea5ae1db7c56148e07
-  data.tar.gz: 6ad7e4b1fadf61a650dfed354817676da07740695c9417bfcbdb21af5746aa5d1fb2ea12f9a07ef48772c3a31a0cca1bce80ea51bd338f4190ef019216222f37
+  metadata.gz: 7ccb1980654aec274dec37804170e22b930234df9d9c09e1acf7a690ba78d5311e730516f7ce012b7114f199a5c02399740071cc8ca6c47da916bf960752c322
+  data.tar.gz: b03060f3cefaa2407ed0307350bd32ff597d2e6c356b3704dd9ba9bdb86c5b70aaffd523e69e923d961985b1990f23e406ef2d80968223738dc75600d8d07298

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+branches:
+  only:
+  - master
+rvm:
+- 2.0.0
+- 1.9.3
+- rbx-19mode
+env:
+  global:
+  - secure: lBLtTjQyeJW7+TWgGmf1mmsXgUzsTnq3/KHvCk+BvOGwoHXTBR1Y6yiczWWHEP4/wBeXXm31xUQC+VoYc/7Ev/2NNB/mqlXAgGw+D0nwQriNXjYt1WV6lQvyoiaUzQ+w+7VahWdx0LuKvSYI+khe8M8BfHQqYacu0VlpAUnjb2I=
+  - secure: mtXQd2Tre01/I2e2MtD0Nu0nocKL9bLozN3v0qZdACpwSwAE1lr8EmAGIZUJp/FbqISOXcjMTmnjvhqp+gw6SE7pdO7vzzzuoJUVi50IrasoBFV97S+lX091n4D4/BDnP906qeA+/1apcIFwk4+8SNgrsIUcZui2eMjP3YunM4g=

data/Gemfile

@@ -5,6 +5,7 @@ gem "curb"
 group :development do
 	gem "bundler"
   gem "jeweler"
+  gem "travis"
 end
 
 group :test do 

data/Gemfile.lock

@@ -8,12 +8,26 @@ GEM
     autotest-fsevent (0.2.8)
       sys-uname
     autotest-growl (0.2.16)
+    backports (3.3.4)
     builder (3.2.2)
+    coderay (1.0.9)
     curb (0.8.4)
     diff-lcs (1.2.4)
+    ethon (0.6.1)
+      ffi (>= 1.3.0)
+      mime-types (~> 1.18)
     faraday (0.8.8)
       multipart-post (~> 1.2.0)
+    faraday_middleware (0.9.0)
+      faraday (>= 0.7.4, < 0.9)
     ffi (1.9.0)
+    gh (0.13.0)
+      addressable
+      backports
+      faraday (~> 0.8)
+      multi_json (~> 1.0)
+      net-http-persistent (>= 2.7)
+      net-http-pipeline
     git (1.2.6)
     github_api (0.10.1)
       addressable
@@ -37,9 +51,16 @@ GEM
     json (1.8.0)
     jwt (0.1.8)
       multi_json (>= 1.5)
+    launchy (2.3.0)
+      addressable (~> 2.3)
+    method_source (0.8.2)
+    mime-types (1.25)
     multi_json (1.8.0)
     multi_xml (0.5.5)
     multipart-post (1.2.0)
+    net-http-persistent (2.9)
+    net-http-pipeline (1.0.1)
+    netrc (0.7.7)
     nokogiri (1.5.10)
     oauth2 (0.9.2)
       faraday (~> 0.8)
@@ -48,6 +69,13 @@ GEM
       multi_json (~> 1.0)
       multi_xml (~> 0.5)
       rack (~> 1.2)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pusher-client (0.3.1)
+      ruby-hmac (~> 0.4.0)
+      websocket (~> 1.0.0)
     rack (1.5.2)
     rake (10.1.0)
     rdoc (4.0.1)
@@ -61,8 +89,26 @@ GEM
     rspec-expectations (2.14.3)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.3)
+    ruby-hmac (0.4.0)
+    slop (3.4.6)
     sys-uname (0.9.2)
       ffi (>= 1.0.0)
+    terminal-notifier (1.5.1)
+    travis (1.5.4)
+      backports
+      faraday (~> 0.8.7)
+      faraday_middleware (~> 0.9)
+      gh (~> 0.13)
+      highline (~> 1.6)
+      launchy (~> 2.1)
+      netrc (~> 0.7)
+      pry (~> 0.9)
+      pusher-client (~> 0.3, >= 0.3.1)
+      terminal-notifier (>= 1.4.2)
+      typhoeus (~> 0.6)
+    typhoeus (0.6.5)
+      ethon (~> 0.6.1)
+    websocket (1.0.7)
 
 PLATFORMS
   ruby
@@ -76,3 +122,4 @@ DEPENDENCIES
   jeweler
   redgreen
   rspec
+  travis

data/README.md

@@ -1,8 +1,9 @@
 Algolia Search API Client for Ruby
 ==================
 
-This Ruby client let you easily use the Algolia Search API from your backend.
-The service is currently in Beta, you can request an invite on our [website](http://www.algolia.com/pricing/).
+This Ruby client let you easily use the Algolia Search API from your backend. It wraps [Algolia's REST API](http://www.algolia.com/doc/rest_api).
+
+[![Build Status](https://travis-ci.org/algolia/algoliasearch-client-ruby.png?branch=master)](https://travis-ci.org/algolia/algoliasearch-client-ruby) [![Gem Version](https://badge.fury.io/rb/algoliasearch.png)](http://badge.fury.io/rb/algoliasearch) [![Code Climate](https://codeclimate.com/github/algolia/algoliasearch-client-ruby.png)](https://codeclimate.com/github/algolia/algoliasearch-client-ruby)
 
 Table of Content
 -------------
@@ -91,16 +92,16 @@ You can use the following optional arguments:
  * **attributes**: a string that contains the names of attributes to retrieve separated by a comma.<br/>By default all attributes are retrieved.
  * **attributesToHighlight**: a string that contains the names of attributes to highlight separated by a comma.<br/>By default indexed attributes are highlighted. Numerical attributes cannot be highlighted. A **matchLevel** is returned for each highlighted attribute and can contain: "full" if all the query terms were found in the attribute, "partial" if only some of the query terms were found, or "none" if none of the query terms were found.
  * **attributesToSnippet**: a string that contains the names of attributes to snippet alongside the number of words to return (syntax is 'attributeName:nbWords'). Attributes are separated by a comma (Example: "attributesToSnippet=name:10,content:10").<br/>By default no snippet is computed.
- * **minWordSizeForApprox1**: the minimum number of characters in a query word to accept one typo in this word.<br/>Defaults to 3.
- * **minWordSizeForApprox2**: the minimum number of characters in a query word to accept two typos in this word.<br/>Defaults to 7.
+ * **minWordSizefor1Typo**: the minimum number of characters in a query word to accept one typo in this word.<br/>Defaults to 3.
+ * **minWordSizefor2Typos**: the minimum number of characters in a query word to accept two typos in this word.<br/>Defaults to 7.
  * **getRankingInfo**: if set to 1, the result hits will contain ranking information in _rankingInfo attribute.
  * **page**: *(pagination parameter)* page to retrieve (zero base).<br/>Defaults to 0.
  * **hitsPerPage**: *(pagination parameter)* number of hits per page.<br/>Defaults to 10.
  * **aroundLatLng**: search for entries around a given latitude/longitude (specified as two floats separated by a comma).<br/>For example `aroundLatLng=47.316669,5.016670`).<br/>You can specify the maximum distance in meters with the **aroundRadius** parameter (in meters) and the precision for ranking with **aroundPrecision** (for example if you set aroundPrecision=100, two objects that are distant of less than 100m will be considered as identical for "geo" ranking parameter).<br/>At indexing, you should specify geoloc of an object with the _geoloc attribute (in the form `{"_geoloc":{"lat":48.853409, "lng":2.348800}}`)
  * **insideBoundingBox**: search entries inside a given area defined by the two extreme points of a rectangle (defined by 4 floats: p1Lat,p1Lng,p2Lat,p2Lng).<br/>For example `insideBoundingBox=47.3165,4.9665,47.3424,5.0201`).<br/>At indexing, you should specify geoloc of an object with the _geoloc attribute (in the form `{"_geoloc":{"lat":48.853409, "lng":2.348800}}`)
  * **queryType**: select how the query words are interpreted:
-  * **prefixAll**: all query words are interpreted as prefixes (default behavior).
-  * **prefixLast**: only the last word is interpreted as a prefix. This option is recommended if you have a lot of content to speedup the processing.
+  * **prefixAll**: all query words are interpreted as prefixes,
+  * **prefixLast**: only the last word is interpreted as a prefix (default behavior),
   * **prefixNone**: no query word is interpreted as a prefix. This option is not recommended.
  * **numerics**: specify the list of numeric filters you want to apply separated by a comma. The syntax of one filter is `attributeName` followed by `operand` followed by `value`. Supported operands are `<`, `<=`, `=`, `>` and `>=`. 
  You can have multiple conditions on one attribute like for example `numerics=price>100,price<1000`.
@@ -249,15 +250,15 @@ Index Settings
 
 You can retrieve all settings using the `getSettings` function. The result will contains the following attributes:
 
- * **minWordSizeForApprox1**: (integer) the minimum number of characters to accept one typo (default = 3).
- * **minWordSizeForApprox2**: (integer) the minimum number of characters to accept two typos (default = 7).
+ * **minWordSizefor1Typo**: (integer) the minimum number of characters to accept one typo (default = 3).
+ * **minWordSizefor2Typos**: (integer) the minimum number of characters to accept two typos (default = 7).
  * **hitsPerPage**: (integer) the number of hits per page (default = 10).
  * **attributesToRetrieve**: (array of strings) default list of attributes to retrieve in objects.
  * **attributesToHighlight**: (array of strings) default list of attributes to highlight.
  * **attributesToSnippet**: (array of strings) default list of attributes to snippet alongside the number of words to return (syntax is 'attributeName:nbWords')<br/>By default no snippet is computed.
  * **attributesToIndex**: (array of strings) the list of fields you want to index.<br/>By default all textual and numerical attributes of your objects are indexed, but you should update it to get optimal results.<br/>This parameter has two important uses:
   * *Limits the attributes to index*.<br/>For example if you store a binary image in base64, you want to store it and be able to retrieve it but you don't want to search in the base64 string.
-  * *Controls part of the ranking*.<br/>Matches in attributes at the beginning of the list will be considered more important than matches in attributes further down the list. 
+  * *Controls part of the ranking*.<br/>Matches in attributes at the beginning of the list will be considered more important than matches in attributes further down the list. In one attribute, matching text at the beginning of the attribute will be considered more important than text after, you can disable this behavior if you add your attribute inside `unordered(AttributeName)`, for example `attributesToIndex:["title", "unordered(text)"]`.
  * **ranking**: (array of strings) controls the way hits are sorted.<br/>We have six available criteria:
   * **typo**: sort according to number of typos,
   * **geo**: sort according to decreasing distance when performing a geo-location based search,
@@ -269,8 +270,8 @@ You can retrieve all settings using the `getSettings` function. The result will
  * **customRanking**: (array of strings) lets you specify part of the ranking.<br/>The syntax of this condition is an array of strings containing attributes prefixed by asc (ascending order) or desc (descending order) operator.
  For example `"customRanking" => ["desc(population)", "asc(name)"]`
  * **queryType**: select how the query words are interpreted:
-  * **prefixAll**: all query words are interpreted as prefixes (default behavior).
-  * **prefixLast**: only the last word is interpreted as a prefix. This option is recommended if you have a lot of content to speedup the processing.
+  * **prefixAll**: all query words are interpreted as prefixes,
+  * **prefixLast**: only the last word is interpreted as a prefix (default behavior),
   * **prefixNone**: no query word is interpreted as a prefix. This option is not recommended.
 
 You can easily retrieve settings or update them:

data/Rakefile

@@ -32,8 +32,6 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
-task :default => :test
-
 require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
@@ -42,3 +40,8 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/VERSION

@@ -1 +1 @@
-1.1.2
+1.1.3

data/algoliasearch.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "algoliasearch"
-  s.version = "1.1.2"
+  s.version = "1.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Algolia"]
-  s.date = "2013-10-02"
+  s.date = "2013-10-15"
   s.description = "A simple Ruby client for the algolia.com REST API"
   s.email = "contact@algolia.com"
   s.extra_rdoc_files = [
@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".rspec",
+    ".travis.yml",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
@@ -47,15 +48,18 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<curb>, [">= 0"])
       s.add_development_dependency(%q<bundler>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<travis>, [">= 0"])
     else
       s.add_dependency(%q<curb>, [">= 0"])
       s.add_dependency(%q<bundler>, [">= 0"])
       s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<travis>, [">= 0"])
     end
   else
     s.add_dependency(%q<curb>, [">= 0"])
     s.add_dependency(%q<bundler>, [">= 0"])
     s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<travis>, [">= 0"])
   end
 end
 

data/lib/algolia/client.rb

@@ -7,33 +7,17 @@ module Algolia
   # A class which encapsulates the HTTPS communication with the Algolia
   # API server. Uses the Curb (Curl) library for low-level HTTP communication.
   class Client
-    attr_accessor :hosts
-    attr_accessor :ssl
-    attr_accessor :application_id
-    attr_accessor :api_key
+    attr_reader :hosts
+    attr_reader :application_id
+    attr_reader :api_key
 
     def initialize(data = {})
       @ssl            = data[:ssl].nil? ? true : data[:ssl]
       @application_id = data[:application_id]
       @api_key        = data[:api_key]
       @gzip           = data[:gzip].nil? ? false : data[:gzip]
-      rhosts          = (data[:hosts] || 1.upto(3).map { |i| "#{@application_id}-#{i}.algolia.io" }).shuffle
-      
-      @hosts = []
-      rhosts.each do |host|
-        hinfo = {}
-        hinfo["base_url"] = "http#{@ssl ? 's' : ''}://#{host}"
-        hinfo["host"] = host
-        hinfo["session"] = Curl::Easy.new(@base_url) do |s|
-          s.headers[Protocol::HEADER_API_KEY]  = @api_key
-          s.headers[Protocol::HEADER_APP_ID]   = @application_id
-          s.headers["Content-Type"]            = "application/json; charset=utf-8"
-          s.headers["Accept"]                  = "Accept-Encoding: gzip,deflate" if @gzip
-          s.headers["User-Agent"]              = "Algolia for Ruby"
-          s.verbose                            = true if data[:debug]
-        end
-        @hosts << hinfo
-      end
+      @hosts          = (data[:hosts] || 1.upto(3).map { |i| "#{@application_id}-#{i}.algolia.io" }).shuffle
+      @debug          = data[:debug]
     end
 
     # Perform an HTTP request for the given uri and method
@@ -41,7 +25,7 @@ module Algolia
     # AlgoliaProtocolError if the response has an error status code,
     # and will return the parsed JSON body on success, if there is one.
     def request(uri, method, data = nil)
-      @hosts.each do |host|
+      thread_local_hosts.each do |host|
         begin
           session = host["session"]
           session.url = host["base_url"] + uri
@@ -86,6 +70,29 @@ module Algolia
       request(uri, :DELETE)
     end
 
+    private
+
+    # this method returns a thread-local array of sessions
+    def thread_local_hosts
+      if Thread.current[:hosts].nil?
+        Thread.current[:hosts] = hosts.map do |host|
+          hinfo = {}
+          hinfo["base_url"] = "http#{@ssl ? 's' : ''}://#{host}"
+          hinfo["host"] = host
+          hinfo["session"] = Curl::Easy.new do |s|
+            s.headers[Protocol::HEADER_API_KEY]  = api_key
+            s.headers[Protocol::HEADER_APP_ID]   = application_id
+            s.headers["Content-Type"]            = "application/json; charset=utf-8"
+            s.headers["Accept"]                  = "Accept-Encoding: gzip,deflate" if @gzip
+            s.headers["User-Agent"]              = "Algolia for Ruby"
+            s.verbose                            = true if @debug
+          end
+          hinfo
+        end
+      end
+      Thread.current[:hosts]
+    end
+
   end
 
   # Module methods

data/lib/algolia/index.rb

@@ -89,9 +89,9 @@ module Algolia
     #    of words to return (syntax is 'attributeName:nbWords'). 
     #    Attributes are separated by a comma (Example: "attributesToSnippet=name:10,content:10").
     #    By default no snippet is computed.
-    #  - minWordSizeForApprox1: the minimum number of characters in a query word to accept one typo in this word. 
+    #  - minWordSizefor1Typo: the minimum number of characters in a query word to accept one typo in this word. 
     #    Defaults to 3.
-    #  - minWordSizeForApprox2: the minimum number of characters in a query word to accept two typos in this word.
+    #  - minWordSizefor2Typos: the minimum number of characters in a query word to accept two typos in this word.
     #     Defaults to 7.
     #  - getRankingInfo: if set to 1, the result hits will contain ranking information in 
     #     _rankingInfo attribute
@@ -106,8 +106,8 @@ module Algolia
     #    For example insideBoundingBox=47.3165,4.9665,47.3424,5.0201).
     #    At indexing, geoloc of an object should be set with _geoloc attribute containing lat and lng attributes (for example {"_geoloc":{"lat":48.853409, "lng":2.348800}})
     #  - queryType: select how the query words are interpreted:
-    #      - prefixAll: all query words are interpreted as prefixes (default behavior).
-    #      - prefixLast: only the last word is interpreted as a prefix. This option is recommended if you have a lot of content to speedup the processing.
+    #      - prefixAll: all query words are interpreted as prefixes,
+    #      - prefixLast: only the last word is interpreted as a prefix (default behavior),
     #       - prefixNone: no query word is interpreted as a prefix. This option is not recommended.
     #  - tags filter the query by a set of tags. You can AND tags by separating them by commas. To OR tags, you must add parentheses. For example, tags=tag1,(tag2,tag3) means tag1 AND (tag2 OR tag3).
     #    At indexing, tags should be added in the _tags attribute of objects (for example {"_tags":["tag1","tag2"]} )
@@ -236,8 +236,8 @@ module Algolia
     # Set settings for this index
     # 
     # @param settigns the settings object that can contains :
-    #  - minWordSizeForApprox1 (integer) the minimum number of characters to accept one typo (default = 3)
-    #  - minWordSizeForApprox2: (integer) the minimum number of characters to accept two typos (default = 7)
+    #  - minWordSizefor1Typo (integer) the minimum number of characters to accept one typo (default = 3)
+    #  - minWordSizefor2Typos: (integer) the minimum number of characters to accept two typos (default = 7)
     #  - hitsPerPage: (integer) the number of hits per page (default = 10)
     #  - attributesToRetrieve: (array of strings) default list of attributes to retrieve for objects
     #  - attributesToHighlight: (array of strings) default list of attributes to highlight
@@ -253,6 +253,9 @@ module Algolia
     #       - Control part of the ranking (see the ranking parameter for full explanation). 
     #         Matches in attributes at the beginning of the list will be considered more important than matches 
     #         in attributes further down the list.
+    #         In one attribute, matching text at the beginning of the attribute will be considered more important than text after, 
+    #         you can disable this behavior if you add your attribute inside `unordered(AttributeName)`, 
+    #         for example `attributesToIndex:["title", "unordered(text)"]`.
     #  - ranking: (array of strings) controls the way results are sorted. 
     #     We have four available criteria: 
     #       - typo (sort according to number of typos), 
@@ -263,8 +266,8 @@ module Algolia
     #       - custom which is user defined
     #     (the standard order is ["typo", "geo", "proximity", "attribute", "exact", "custom"])
     #  - queryType: select how the query words are interpreted:
-    #      - prefixAll: all query words are interpreted as prefixes (default behavior).
-    #      - prefixLast: only the last word is interpreted as a prefix. This option is recommended if you have a lot of content to speedup the processing.
+    #      - prefixAll: all query words are interpreted as prefixes,
+    #      - prefixLast: only the last word is interpreted as a prefix (default behavior),
     #       - prefixNone: no query word is interpreted as a prefix. This option is not recommended.
     #  - customRanking: (array of strings) lets you specify part of the ranking. 
     #    The syntax of this condition is an array of strings containing attributes prefixed 

data/spec/client_spec.rb

@@ -26,4 +26,18 @@ describe 'Client' do
     expect { @index.add_objects!([ [ {:name => "test"} ] ]) }.to raise_error(ArgumentError)
   end
 
+  it "should be thread safe" do
+    threads = []
+    64.times do
+      t = Thread.new do
+        10.times do
+          res = @index.search("john")
+          res["hits"].length.should eq(1)
+        end
+      end
+      threads << t
+    end
+    threads.each { |t| t.join }
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-02 00:00:00.000000000 Z
+date: 2013-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curb
@@ -52,6 +52,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: travis
+  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: A simple Ruby client for the algolia.com REST API
 email: contact@algolia.com
 executables: []
@@ -61,6 +75,7 @@ extra_rdoc_files:
 - README.md
 files:
 - .rspec
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt