algoliasearch 1.1.12 → 1.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82eae7dcf820e44290c0b6afb575fce03699c1ce
-  data.tar.gz: 8a90fe2fc6858c7fdf7714c9aa4e558bbcf39ef5
+  metadata.gz: 38bb8e365cc6921a1820890441f95ae1941783ce
+  data.tar.gz: 455d9b1dbce92bfac9ded41bf71ac43756a0f434
 SHA512:
-  metadata.gz: cd24dbf3876411d88b2bbe04aa8b321d11c8314cdf6cb0b218db3c82c7cd5cfc5a107181528b28c0babc43f240065a08eb0c9d7634f4ac94daabd0644c44359c
-  data.tar.gz: 050d6f623ba9e0baf51c37389aa2b3a0827556cbd18bb924995d509087a0f688e50be649503f74574a45f4e87dc3bf74a70e15ca81cdf35c5d8448f335980bbc
+  metadata.gz: f2c7e270e4211d32ef496a2ca67f566d646ccf78fe0fc1d055c3cada84f4977162fc7a0604feb0c30ca4379964918686ef7232dc1554fc860a5c4777377eb99f
+  data.tar.gz: 85b6b8642797de0d8a41880f001476127ae0541029ce0e38870ecd12da6ffb047a377075eaba0accd8ae65b2984422307be0cd44120ab1b6d4d366ca917bca0d

data/ChangeLog

@@ -1,5 +1,13 @@
 CHANGELOG
 
+2013-12-10  1.1.13
+
+      * WebMock integration
+
+2013-12-05  1.1.12
+
+      * Add browse command
+
 2013-11-29  1.1.11
 
       * Remove rubysl (rbx required dependencies)

data/Gemfile

@@ -14,4 +14,5 @@ group :test do
   gem 'autotest-fsevent'
   gem 'redgreen'
   gem 'autotest-growl'
+  gem 'webmock'
 end

data/Gemfile.lock

@@ -11,6 +11,8 @@ GEM
     backports (3.3.5)
     builder (3.2.2)
     coderay (1.0.9)
+    crack (0.4.1)
+      safe_yaml (~> 0.9.0)
     curb (0.8.5)
     diff-lcs (1.2.4)
     ethon (0.6.1)
@@ -90,6 +92,7 @@ GEM
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.3)
     ruby-hmac (0.4.0)
+    safe_yaml (0.9.7)
     slop (3.4.6)
     sys-uname (0.9.2)
       ffi (>= 1.0.0)
@@ -108,6 +111,9 @@ GEM
       typhoeus (~> 0.6)
     typhoeus (0.6.5)
       ethon (~> 0.6.1)
+    webmock (1.13.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
     websocket (1.0.7)
 
 PLATFORMS
@@ -123,3 +129,4 @@ DEPENDENCIES
   redgreen
   rspec
   travis
+  webmock

data/README.md

@@ -41,6 +41,7 @@ Table of Content
 1. [Copy or rename an index](#copy-or-rename-an-index)
 1. [Backup / Retrieve all index content](#backup--retrieve-all-index-content)
 1. [Logs](#logs)
+1. [Mock](#mock)
 
 Setup
 -------------
@@ -103,29 +104,49 @@ Search
 To perform a search, you just need to initialize the index and perform a call to the search function.<br/>
 You can use the following optional arguments:
 
+
+### Query parameters
+
+#### Full Text Search parameters
+
+ * **query**: (string) The instant-search query string, all words of the query are interpreted as prefixes (for example "John Mc" will match "John Mccamey" and "Johnathan Mccamey"). If no query parameter is set, retrieves all objects.
+ * **queryType**: select how the query words are interpreted, it can be one of the following value:
+  * **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.
+ * **optionalWords**: a string that contains the list of words that should be considered as optional when found in the query. The list of words is comma separated.
+ * **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.
+
+#### Pagination parameters
+
  * **page**: (integer) Pagination parameter used to select the page to retrieve.<br/>Page is zero-based and defaults to 0. Thus, to retrieve the 10th page you need to set `page=9`
  * **hitsPerPage**: (integer) Pagination parameter used to select the number of hits per page. Defaults to 20.
+
+#### Geo-search parameters
+
+ * **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}}`)
+
+#### Parameters to control results content
  * **attributesToRetrieve**: a string that contains the list of object attributes you want to retrieve (let you minimize the answer size).<br/> Attributes are separated with a comma (for example `"name,address"`), you can also use a string array encoding (for example `["name","address"]` ). By default, all attributes are retrieved. You can also use `*` to retrieve all values when an **attributesToRetrieve** setting is specified for your index.
  * **attributesToHighlight**: a string that contains the list of attributes you want to highlight according to the query. Attributes are separated by a comma. You can also use a string array encoding (for example `["name","address"]`). If an attribute has no match for the query, the raw value is returned. By default all indexed text attributes are highlighted. You can use `*` if you want to highlight all textual attributes. Numerical attributes are not 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,
   * **none**: if none of the query terms were found.
  * **attributesToSnippet**: a string that contains the list 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/>You can also use a string array encoding (Example: `attributesToSnippet: ["name:10","content:10"]`). By default no snippet is computed.
- * **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.
- * **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}}`)
+
+#### Numeric search parameters
  * **numericFilters**: a string that contains 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 `numericFilters=price>100,price<1000`. You can also use a string array encoding (for example `numericFilters: ["price>100","price<1000"]`).
- * **tagFilters**: 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)*. You can also use a string array encoding, for example `tagFilters: ["tag1",["tag2","tag3"]]` means *tag1 AND (tag2 OR tag3)*.<br/>At indexing, tags should be added in the **_tags** attribute of objects (for example `{"_tags":["tag1","tag2"]}`).
+
+#### Category search parameters
+ * **tagFilters**: 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)*. You can also use a string array encoding, for example `tagFilters: ["tag1",["tag2","tag3"]]` means *tag1 AND (tag2 OR tag3)*.<br/>At indexing, tags should be added in the **_tags** attribute of objects (for example `{"_tags":["tag1","tag2"]}`). 
+
+#### Faceting parameters
  * **facetFilters**: filter the query by a list of facets. Facets are separated by commas and each facet is encoded as `attributeName:value`. For example: `facetFilters=category:Book,author:John%20Doe`. You can also use a string array encoding (for example `["category:Book","author:John%20Doe"]`).
  * **facets**: List of object attributes that you want to use for faceting. <br/>Attributes are separated with a comma (for example `"category,author"` ). You can also use a JSON string array encoding (for example `["category","author"]` ). Only attributes that have been added in **attributesForFaceting** index setting can be used in this parameter. You can also use `*` to perform faceting on all attributes specified in **attributesForFaceting**.
- * **queryType**: select how the query words are interpreted, it can be one of the following value:
-  * **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.
- * **optionalWords**: a string that contains the list of words that should be considered as optional when found in the query. The list of words is comma separated.
 
 ```ruby
 index = Algolia::Index.new("contacts")
@@ -247,12 +268,7 @@ Index Settings
 
 You can retrieve all settings using the `getSettings` function. The result will contains the following attributes:
 
- * **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. If set to null, all attributes are retrieved.
- * **attributesToHighlight**: (array of strings) default list of attributes to highlight. If set to null, all indexed attributes are highlighted.
- * **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. If set to null, no snippet is computed.
+#### Indexing parameters
  * **attributesToIndex**: (array of strings) the list of fields you want to index.<br/>If set to null, 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:
   * *Limit 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.
   * *Control part of the ranking*.<br/>(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)"]`.
@@ -272,6 +288,14 @@ For example `"customRanking" => ["desc(population)", "asc(name)"]`
   * **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.
+
+#### Default query parameters (can be overwrite by query)
+ * **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. If set to null, all attributes are retrieved.
+ * **attributesToHighlight**: (array of strings) default list of attributes to highlight. If set to null, all indexed attributes are highlighted.
+ * **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. If set to null, no snippet is computed.
  * **highlightPreTag**: (string) Specify the string that is inserted before the highlighted parts in the query result (default to "&lt;em&gt;").
  * **highlightPostTag**: (string) Specify the string that is inserted after the highlighted parts in the query result (default to "&lt;/em&gt;").
  * **optionalWords**: (array of strings) Specify a list of words that should be considered as optional when found in the query.
@@ -358,7 +382,7 @@ Example that update only the `firstname` attribute:
 res = index.partial_update_objects([{"firstname" => "Jimmie", 
                                      "objectID" => "SFO"},
                                     {"firstname" => "Warren", 
-                                     "objectID" => "myID2"}]);
+                                     "objectID" => "myID2"}])
 ```
 
 Security / User API Keys
@@ -455,9 +479,9 @@ This method retrieve 1000 objects by API call and support pagination.
 
 ```ruby
 # Get first page
-puts index.browse(0);
+puts index.browse(0)
 # Get second page
-puts index.browse(1);
+puts index.browse(1)
 ```
 
 Logs
@@ -484,3 +508,32 @@ puts Algolia.get_logs.to_json
 # Get last 100 log entries
 puts Algolia.get_logs(0, 100).to_json
 ```
+
+Mock
+-------------
+
+For testing purpose, you may want to mock Algolia's API calls. We provide a [WebMock](https://github.com/bblimke/webmock) configuration that you can use including `algolia/webmock`:
+
+```ruby
+require 'algolia/webmock'
+
+describe 'With a mocked client' do
+
+  before(:each) do
+    WebMock.enable!
+  end
+
+  it "shouldn't perform any API calls here" do
+    index = Algolia::Index.new("friends")
+    index.add_object!({ :name => "John Doe", :email => "john@doe.org" })
+    index.search('').should == {} # mocked
+    index.clear
+    index.delete
+  end
+
+  after(:each) do
+    WebMock.disable!
+  end
+
+end
+```

data/algoliasearch.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 1.1.13 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "algoliasearch"
-  s.version = "1.1.12"
+  s.version = "1.1.13"
 
   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-10"
   s.description = "A simple Ruby client for the algolia.com REST API"
   s.email = "contact@algolia.com"
   s.extra_rdoc_files = [
@@ -33,14 +34,16 @@ Gem::Specification.new do |s|
     "lib/algolia/index.rb",
     "lib/algolia/protocol.rb",
     "lib/algolia/version.rb",
+    "lib/algolia/webmock.rb",
     "lib/algoliasearch.rb",
     "spec/client_spec.rb",
+    "spec/mock_spec.rb",
     "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/algolia/algoliasearch-client-ruby"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "2.0.12"
+  s.rubygems_version = "2.1.11"
   s.summary = "A simple Ruby client for the algolia.com REST API"
 
   if s.respond_to? :specification_version then

data/lib/algolia/client.rb

@@ -76,8 +76,8 @@ module Algolia
 
     # 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|
+      if Thread.current[:algolia_hosts].nil?
+        Thread.current[:algolia_hosts] = hosts.map do |host|
           hinfo = {}
           hinfo["base_url"] = "http#{@ssl ? 's' : ''}://#{host}"
           hinfo["host"] = host
@@ -92,7 +92,7 @@ module Algolia
           hinfo
         end
       end
-      Thread.current[:hosts]
+      Thread.current[:algolia_hosts]
     end
 
   end

data/lib/algolia/version.rb

@@ -1,3 +1,3 @@
 module Algolia
-  VERSION = "1.1.11"
+  VERSION = "1.1.13"
 end

data/lib/algolia/webmock.rb

@@ -0,0 +1,48 @@
+begin
+  require 'webmock'
+rescue LoadError
+  puts 'WebMock was not found, please add "gem \'webmock\'" to your Gemfile.'
+  exit 1
+end
+
+# disable by default
+WebMock.disable!
+
+# list indexes
+WebMock.stub_request(:get, /.*\.algolia\.io\/1\/indexes/).to_return(:body => '{ "items": [] }')
+# query index
+WebMock.stub_request(:get, /.*\.algolia\.io\/1\/indexes\/[^\/]+/).to_return(:body => '{}')
+WebMock.stub_request(:post, /.*\.algolia\.io\/1\/indexes\/[^\/]+\/query/).to_return(:body => '{}')
+# delete index
+WebMock.stub_request(:delete, /.*\.algolia\.io\/1\/indexes\/[^\/]+/).to_return(:body => '{ "taskID": 42 }')
+# clear index
+WebMock.stub_request(:post, /.*\.algolia\.io\/1\/indexes\/[^\/]+\/clear/).to_return(:body => '{ "taskID": 42 }')
+# add object
+WebMock.stub_request(:post, /.*\.algolia\.io\/1\/indexes\/[^\/]+/).to_return(:body => '{ "taskID": 42 }')
+# save object
+WebMock.stub_request(:put, /.*\.algolia\.io\/1\/indexes\/[^\/]+\/[^\/]+/).to_return(:body => '{ "taskID": 42 }')
+# partial update
+WebMock.stub_request(:put, /.*\.algolia\.io\/1\/indexes\/[^\/]+\/[^\/]+\/partial/).to_return(:body => '{ "taskID": 42 }')
+# get object
+WebMock.stub_request(:get, /.*\.algolia\.io\/1\/indexes\/[^\/]+\/[^\/]+/).to_return(:body => '{}')
+# delete object
+WebMock.stub_request(:delete, /.*\.algolia\.io\/1\/indexes\/[^\/]+\/[^\/]+/).to_return(:body => '{ "taskID": 42 }')
+# batch
+WebMock.stub_request(:post, /.*\.algolia\.io\/1\/indexes\/[^\/]+\/batch/).to_return(:body => '{ "taskID": 42 }')
+# settings
+WebMock.stub_request(:get, /.*\.algolia\.io\/1\/indexes\/[^\/]+\/settings/).to_return(:body => '{}')
+WebMock.stub_request(:put, /.*\.algolia\.io\/1\/indexes\/[^\/]+\/settings/).to_return(:body => '{ "taskID": 42 }')
+# browse
+WebMock.stub_request(:get, /.*\.algolia\.io\/1\/indexes\/[^\/]+\/browse/).to_return(:body => '{}')
+# operations
+WebMock.stub_request(:post, /.*\.algolia\.io\/1\/indexes\/[^\/]+\/operation/).to_return(:body => '{ "taskID": 42 }')
+# tasks
+WebMock.stub_request(:get, /.*\.algolia\.io\/1\/indexes\/[^\/]+\/task\/[^\/]+/).to_return(:body => '{ "status": "published" }')
+# index keys
+WebMock.stub_request(:post, /.*\.algolia\.io\/1\/indexes\/[^\/]+\/keys/).to_return(:body => '{ }')
+WebMock.stub_request(:get, /.*\.algolia\.io\/1\/indexes\/[^\/]+\/keys/).to_return(:body => '{ "keys": [] }')
+# global keys
+WebMock.stub_request(:post, /.*\.algolia\.io\/1\/keys/).to_return(:body => '{ }')
+WebMock.stub_request(:get, /.*\.algolia\.io\/1\/keys/).to_return(:body => '{ "keys": [] }')
+WebMock.stub_request(:get, /.*\.algolia\.io\/1\/keys\/[^\/]+/).to_return(:body => '{ }')
+WebMock.stub_request(:delete, /.*\.algolia\.io\/1\/keys\/[^\/]+/).to_return(:body => '{ }')

data/spec/mock_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+require 'algolia/webmock'
+
+describe 'With a mocked client' do
+
+  before(:each) do
+    WebMock.enable!
+    Thread.current[:algolia_hosts] = nil # reset Curb::Easy objects
+  end
+
+  it "should add a simple object" do
+    index = Algolia::Index.new("friends")
+    index.add_object!({ :name => "John Doe", :email => "john@doe.org" })
+    index.search('').should == {} # mocked
+    index.list_user_keys
+    index.browse
+    index.clear
+    index.delete
+  end
+
+  after(:each) do
+    WebMock.disable!
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch
 version: !ruby/object:Gem::Version
-  version: 1.1.12
+  version: 1.1.13
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-05 00:00:00.000000000 Z
+date: 2013-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curb
@@ -90,8 +90,10 @@ files:
 - lib/algolia/index.rb
 - lib/algolia/protocol.rb
 - lib/algolia/version.rb
+- lib/algolia/webmock.rb
 - lib/algoliasearch.rb
 - spec/client_spec.rb
+- spec/mock_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/algolia/algoliasearch-client-ruby
 licenses:
@@ -113,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: A simple Ruby client for the algolia.com REST API