algoliasearch 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA1: 
-  metadata.gz: fc4ad0e747cb1f514fd118b8b1f09e787d5310cd
-  data.tar.gz: 29066a59d3003a129c446a4e14da14a8390cde6e
-SHA512: 
-  metadata.gz: 7c24ead447698bfd22333db709d541c1fa3a432c13f37c3f5cc789afc63db5edc18ec1796579cdc47012c94cd586605d05ef08e9c2e2660e9eb4f0dc0832adc6
-  data.tar.gz: f7bde31ef08f0ef03e61a46df6436c07c30b8daaf6e16719de15fb8cdf664e10c5241ba7d8ac74518ce6b1e1269e82560468e84beffb71f4d7d87c1e6d4e00cf
+---
+SHA1:
+  metadata.gz: c168df1007c65f3a05fdac4a6d85abb0c032307b
+  data.tar.gz: 428cd9b8e97c21fdece377ef64e5a8b78118470c
+SHA512:
+  metadata.gz: a9443ef278cfc1767212702a70f7d335f18b710f77538014c6e327e0bb165ab676f1044594a323a83718efec5e4bce00efb2dd2efc209f48d2143984260a06c5
+  data.tar.gz: 9ded465bc3d8f4486c96693ea14cfecb6f0ba2a4249931f8c15fae518f3ba2bf82cd6827b0da0b9462c305a799b2fc86e7a0b6a677269dd43ba8d3adff5445da

data/ChangeLog

@@ -1,5 +1,9 @@
 CHANGELOG
 
+2014-02-10  1.2.3
+
+      * add_object: POST request if objectID is nil OR empty
+
 2014-01-11  1.2.2
 
       * Expose batch requests

data/Gemfile

@@ -5,6 +5,7 @@ gem 'json', '>= 1.5.1'
 gem 'rubysl', '~> 2.0', platform: :rbx
 
 group :development do
+  gem 'coveralls'
   gem 'travis'
   gem 'rake'
   gem 'rdoc'
@@ -17,4 +18,5 @@ group :test do
   gem 'redgreen'
   gem 'autotest-growl'
   gem 'webmock'
+  gem 'simplecov'
 end

data/Gemfile.lock

@@ -10,9 +10,16 @@ GEM
     autotest-growl (0.2.16)
     backports (3.4.0)
     coderay (1.1.0)
+    coveralls (0.7.0)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
     crack (0.4.1)
       safe_yaml (~> 0.9.0)
     diff-lcs (1.2.5)
+    docile (1.1.2)
     ethon (0.6.2)
       ffi (>= 1.3.0)
       mime-types (~> 1.18)
@@ -36,6 +43,9 @@ GEM
     json (1.8.1-java)
     launchy (2.4.2)
       addressable (~> 2.3)
+    launchy (2.4.2-java)
+      addressable (~> 2.3)
+      spoon (~> 0.0.1)
     method_source (0.8.2)
     mime-types (1.25.1)
     multi_json (1.8.2)
@@ -57,6 +67,8 @@ GEM
     rdoc (4.1.0)
       json (~> 1.4)
     redgreen (1.2.2)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
@@ -268,11 +280,20 @@ GEM
     rubysl-yaml (2.0.4)
     rubysl-zlib (2.0.1)
     safe_yaml (0.9.7)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
     slop (3.4.7)
     spoon (0.0.4)
       ffi
     sys-uname (0.9.2)
       ffi (>= 1.0.0)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
+    thor (0.18.1)
+    tins (0.13.1)
     travis (1.6.6)
       addressable (~> 2.3)
       backports
@@ -299,6 +320,7 @@ DEPENDENCIES
   autotest
   autotest-fsevent
   autotest-growl
+  coveralls
   httpclient (~> 2.3)
   json (>= 1.5.1)
   rake
@@ -306,5 +328,6 @@ DEPENDENCIES
   redgreen
   rspec (>= 2.5.0)
   rubysl (~> 2.0)
+  simplecov
   travis
   webmock

data/README.md

@@ -1,6 +1,10 @@
 Algolia Search API Client for Ruby
 ==================
 
+
+
+
+
 [Algolia Search](http://www.algolia.com) is a search API that provides hosted full-text, numerical and faceted search.
 Algolia’s Search API makes it easy to deliver a great search experience in your apps & websites providing:
 
@@ -15,20 +19,23 @@ Algolia’s Search API makes it easy to deliver a great search experience in you
 
 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)
+[![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) [![Coverage Status](https://coveralls.io/repos/algolia/algoliasearch-client-ruby/badge.png)](https://coveralls.io/r/algolia/algoliasearch-client-ruby)
+
+
 
 Table of Content
 -------------
 **Get started**
 
-1. [Setup](#setup) 
+1. [Setup](#setup)
 1. [Quick Start](#quick-start)
+1. [Online documentation](#online-documentation)
 
 **Commands reference**
 
-1. [Search](#search)
 1. [Add a new object](#add-a-new-object-in-the-index)
 1. [Update an object](#update-an-existing-object-in-the-index)
+1. [Search](#search)
 1. [Get an object](#get-an-object)
 1. [Delete an object](#delete-an-object)
 1. [Index settings](#index-settings)
@@ -43,10 +50,16 @@ Table of Content
 1. [Logs](#logs)
 1. [Mock](#mock)
 
+
+
+
 Setup
 -------------
 To setup your project, follow these steps:
 
+
+
+
  1. Install AlgoliaSearch using <code>gem install algoliasearch</code>.
  2. Initialize the client with your ApplicationID and API-Key. You can find all of them on [your Algolia account](http://www.algolia.com/users/edit).
 
@@ -58,8 +71,11 @@ Algolia.init :application_id => "YourApplicationID",
              :api_key        => "YourAPIKey"
 ```
 
+
+
 Quick Start
 -------------
+
 This quick start is a 30 seconds tutorial where you can discover how to index and search objects.
 
 Without any prior-configuration, you can index [500 contacts](https://github.com/algolia/algoliasearch-client-ruby/blob/master/contacts.json) in the ```contacts``` index with the following code:
@@ -85,6 +101,7 @@ Settings can be customized to tune the search behavior. For example you can add
 ```ruby
 index.set_settings({"customRanking" => ["desc(followers)"]})
 ```
+
 You can also configure the list of attributes you want to index by order of importance (first = most important):
 ```ruby
 index.set_settings({"attributesToIndex" => ["lastname", "firstname", "company", 
@@ -97,13 +114,91 @@ puts index.search('or').to_json
 puts index.search('jim').to_json
 ```
 
+
+
+
+Online Documentation
+----------------
+
+Check our [online documentation](http://www.algolia.com/doc):
+ * [Initial Import](http://www.algolia.com/doc#InitialImport)
+ * [Ranking &amp; Relevance](http://www.algolia.com/doc#RankingRelevance)
+ * [Settings](http://www.algolia.com/doc#Settings)
+ * [Search](http://www.algolia.com/doc#Search)
+ * [Incremental Updates](http://www.algolia.com/doc#IncrementalUpdates)
+ * [Reindexing](http://www.algolia.com/doc#Reindexing)
+ * [Numeric-Search](http://www.algolia.com/doc#Numeric-Search)
+ * [Category-Search](http://www.algolia.com/doc#Category-Search)
+ * [Faceting](http://www.algolia.com/doc#Faceting)
+ * [Geo-Search](http://www.algolia.com/doc#Geo-Search)
+ * [Security](http://www.algolia.com/doc#Security)
+ * [Indexing Several Types](http://www.algolia.com/doc#IndexingSeveralTypes)
+ * [REST API](http://www.algolia.com/doc/rest)
+
+
+
+
+
+
+
+Add a new object in the Index
+-------------
+
+Each entry in an index has a unique identifier called `objectID`. You have two ways to add en entry in the index:
+
+ 1. Using automatic `objectID` assignement, you will be able to retrieve it in the answer.
+ 2. Passing your own `objectID`
+
+You don't need to explicitely create an index, it will be automatically created the first time you add an object.
+Objects are schema less, you don't need any configuration to start indexing. The settings section provide details about advanced settings.
+
+Example with automatic `objectID` assignement:
+
+```ruby
+res = index.add_object({"firstname" => "Jimmie", 
+                        "lastname" => "Barninger"})
+puts "ObjectID=" + res["objectID"]
+```
+
+Example with manual `objectID` assignement:
+
+```ruby
+res = index.add_object({"firstname" => "Jimmie", 
+                        "lastname" => "Barninger"}, "myID")
+puts "ObjectID=" + res["objectID"]
+```
+
+Update an existing object in the Index
+-------------
+
+You have two options to update an existing object:
+
+ 1. Replace all its attributes.
+ 2. Replace only some attributes.
+
+Example to replace all the content of an existing object:
+
+```ruby
+index.save_object({"firstname" => "Jimmie", 
+                   "lastname" => "Barninger",
+                   "city" => "New York",
+                   "objectID" => "myID"})
+```
+
+Example to update only the city attribute of an existing object:
+
+```ruby
+index.partial_update_object({"city" => "San Francisco", 
+                             "objectID" => "myID"})
+```
+
 Search
 -------------
-> **Opening note:** If you are building a web application, you may be more interested in using our [javascript client](https://github.com/algolia/algoliasearch-client-js) to send queries. It brings two benefits: (i) your users get a better response time by avoiding to go through your servers, and (ii) it will offload your servers of unnecessary tasks.
+ **Opening note:** If you are building a web application, you may be more interested in using our [javascript client](https://github.com/algolia/algoliasearch-client-js) to send queries. It brings two benefits: (i) your users get a better response time by avoiding to go through your servers, and (ii) it will offload your servers of unnecessary tasks.
 
-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:
+To perform a search, you just need to initialize the index and perform a call to the search function.
 
+You can use the following optional arguments:
 
 ### Query parameters
 
@@ -129,6 +224,7 @@ You can use the following optional arguments:
  * **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,
@@ -136,6 +232,7 @@ You can use the following optional arguments:
   * **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.
  * **getRankingInfo**: if set to 1, the result hits will contain ranking information in **_rankingInfo** attribute.
+ 
 
 #### 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 `>=`. 
@@ -145,7 +242,7 @@ You can use the following optional arguments:
  * **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"]`).
+ * **facetFilters**: filter the query by a list of facets. Facets are separated by commas and each facet is encoded as `attributeName:value`. To OR facets, you must add parentheses. For example: `facetFilters=(category:Book,category:Movie),author:John%20Doe`. You can also use a string array encoding (for example `[["category:Book","category:Movie"],"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**.
 
 #### Distinct parameter
@@ -192,57 +289,6 @@ The server response will look like:
 }
 ```
 
-Add a new object in the Index
--------------
-
-Each entry in an index has a unique identifier called `objectID`. You have two ways to add en entry in the index:
-
- 1. Using automatic `objectID` assignement, you will be able to retrieve it in the answer.
- 2. Passing your own `objectID`
-
-You don't need to explicitely create an index, it will be automatically created the first time you add an object.
-Objects are schema less, you don't need any configuration to start indexing. The settings section provide details about advanced settings.
-
-Example with automatic `objectID` assignement:
-
-```ruby
-res = index.add_object({"firstname" => "Jimmie", 
-                        "lastname" => "Barninger"})
-puts "ObjectID=" + res["objectID"]
-```
-
-Example with manual `objectID` assignement:
-
-```ruby
-res = index.add_object({"firstname" => "Jimmie", 
-                        "lastname" => "Barninger"}, "myID")
-puts "ObjectID=" + res["objectID"]
-```
-
-Update an existing object in the Index
--------------
-
-You have two options to update an existing object:
-
- 1. Replace all its attributes.
- 2. Replace only some attributes.
-
-Example to replace all the content of an existing object:
-
-```ruby
-index.save_object({"firstname" => "Jimmie", 
-                   "lastname" => "Barninger",
-                   "city" => "New York",
-                   "objectID" => "myID"})
-```
-
-Example to update only the city attribute of an existing object:
-
-```ruby
-index.partial_update_object({"city" => "San Francisco", 
-                             "objectID" => "myID"})
-```
-
 Get an object
 -------------
 
@@ -269,7 +315,8 @@ index.delete_object("myID")
 Index Settings
 -------------
 
-You can retrieve all settings using the `getSettings` function. The result will contains the following attributes:
+You can retrieve all settings using the `get_settings` function. The result will contains the following attributes:
+
 
 #### 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:
@@ -292,6 +339,7 @@ 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.
+ * **slaves**: The list of indexes on which you want to replicate all write operations. In order to get response times in milliseconds, we pre-compute part of the ranking during indexing. If you want to use different ranking configurations depending of the use-case, you need to create one index per ranking configuration. This option enables you to perform write operations only on this index, and to automatically update slave indexes with the same operations.
 
 #### Default query parameters (can be overwrite by query)
  * **minWordSizefor1Typo**: (integer) the minimum number of characters to accept one typo (default = 3).
@@ -329,22 +377,21 @@ You can delete an index using its name:
 
 ```ruby
 index = Algolia::Index.new("contacts")
-index.delete
+index.delete_index
 ```
 
 Clear an index
 -------------
-
 You can delete the index content without removing settings and index specific API keys with the clearIndex command:
 
 ```ruby
-index.clear
+index.clear_index
 ```
 
 Wait indexing
 -------------
 
-All write operations return a `taskID` when the job is securely stored on our infrastructure but not when the job is published in your index. Even if it's extremely fast, you can easily ensure indexing is complete using the same method with a `!`.
+All write operations return a `taskID` when the job is securely stored on our infrastructure but not when the job is published in your index. Even if it's extremely fast, you can easily ensure indexing is complete using  the same method with a `!`. 
 
 For example, to wait for indexing of a new object:
 ```ruby
@@ -352,13 +399,14 @@ res = index.add_object!({"firstname" => "Jimmie",
                          "lastname" => "Barninger"})
 ```
 
+
 If you want to ensure multiple objects have been indexed, you can only check the biggest taskID with `wait_task`.
 
 Batch writes
 -------------
 
 You may want to perform multiple operations with one API call to reduce latency.
-We expose two methods to perform batch:
+We expose three methods to perform batch:
  * `add_objects`: add an array of object using automatic `objectID` assignement
  * `save_objects`: add or update an array of object that contains an `objectID` attribute
  * `partial_update_objects`: partially update an array of objects that contain an `objectID` attribute (only specified attributes will be updated, other will remain unchanged)
@@ -389,6 +437,8 @@ res = index.partial_update_objects([{"firstname" => "Jimmie",
                                      "objectID" => "myID2"}])
 ```
 
+
+
 Security / User API Keys
 -------------
 
@@ -422,11 +472,13 @@ puts res['key']
 res = index.add_user_key(["search"])
 puts res['key']
 ```
+
 You can also create an API Key with advanced restrictions:
 
  * Add a validity period: the key will be valid only for a specific period of time (in seconds),
  * Specify the maximum number of API calls allowed from an IP address per hour. Each time an API call is performed with this key, a check is performed. If the IP at the origin of the call did more than this number of calls in the last hour, a 403 code is returned. Defaults to 0 (no rate limit). This parameter can be used to protect you from attempts at retrieving your entire content by massively querying the index.
 
+
   Note: If you are sending the query through your servers, you must use the `Algolia.with_rate_limits("EndUserIP", "APIKeyWithRateLimit") do ... end` block to enable rate-limit.
 
  * Specify the maximum number of hits this API key can retrieve in one call. Defaults to 0 (unlimited). This parameter can be used to protect you from attempts at retrieving your entire content by massively querying the index.
@@ -534,8 +586,8 @@ describe 'With a mocked client' do
     index = Algolia::Index.new("friends")
     index.add_object!({ :name => "John Doe", :email => "john@doe.org" })
     index.search('').should == {} # mocked
-    index.clear
-    index.delete
+    index.clear_index
+    index.delete_index
   end
 
   after(:each) do
@@ -544,3 +596,6 @@ describe 'With a mocked client' do
 
 end
 ```
+
+
+

data/algoliasearch.gemspec

@@ -6,7 +6,7 @@
 
 Gem::Specification.new do |s|
   s.name = "algoliasearch"
-  s.version = "1.2.2"
+  s.version = "1.2.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]

data/lib/algolia/client.rb

@@ -93,18 +93,6 @@ module Algolia
       return JSON.parse(response.content)
     end
 
-    def init_session
-      s = Curl::Easy.new
-      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["User-Agent"]              = "Algolia for Ruby #{::Algolia::VERSION}"
-      s.verbose                            = true if @debug
-      s.cacert                             = File.join File.dirname(__FILE__), '..', '..', 'resources', 'ca-bundle.crt'
-      s.encoding                           = ''
-      s
-    end
-
   end
 
   # Module methods

data/lib/algolia/index.rb

@@ -16,6 +16,7 @@ module Algolia
     def delete
       Algolia.client.delete(Protocol.index_uri(name))
     end
+    alias_method :delete_index, :delete
 
     # Add an object in this index
     # 
@@ -25,7 +26,7 @@ module Algolia
     #  (if the attribute already exist the old object will be overridden)
     def add_object(obj, objectID = nil)
       check_object obj
-      if objectID.nil?
+      if objectID.nil? || objectID.to_s.empty?
         Algolia.client.post(Protocol.index_uri(name), obj.to_json)
       else
         Algolia.client.put(Protocol.object_uri(name, objectID), obj.to_json)        
@@ -232,7 +233,7 @@ module Algolia
     # @param objs an array of objects to update (each object must contains a objectID attribute)
     #
     def partial_update_objects!(objs)
-      res = partial_update_objects(obj)
+      res = partial_update_objects(objs)
       wait_task(res["taskID"])
       return res
     end
@@ -276,6 +277,7 @@ module Algolia
     def clear
       Algolia.client.post(Protocol.clear_uri(name))
     end
+    alias_method :clear_index, :clear
     
     #
     # Delete the index content and wait end of indexing
@@ -285,6 +287,7 @@ module Algolia
       wait_task(res["taskID"])
       return res
     end
+    alias_method :clear_index!, :clear!
     
     #
     # Set settings for this index

data/lib/algolia/protocol.rb

@@ -40,15 +40,15 @@ module Algolia
 
     # Construct a uri referencing a given Algolia index
     def Protocol.index_uri(index)
-      "/#{VERSION}/indexes/#{index}"
+      "/#{VERSION}/indexes/#{CGI.escape(index)}"
     end
 
     def Protocol.batch_uri(index)
-      "/#{VERSION}/indexes/#{index}/batch"
+      "#{index_uri(index)}/batch"
     end
     
     def Protocol.index_operation_uri(index)
-      "/#{VERSION}/indexes/#{index}/operation"
+      "#{index_uri(index)}/operation"
     end
 
     def Protocol.task_uri(index, task_id)
@@ -57,7 +57,7 @@ module Algolia
     
     def Protocol.object_uri(index, object_id, params = {})
       params = params.nil? || params.size == 0 ? "" : "?#{to_query(params)}"
-      "#{index_uri(index)}/#{object_id}#{params}"
+      "#{index_uri(index)}/#{CGI.escape(object_id.to_s)}#{params}"
     end
 
     def Protocol.search_uri(index, query, params = {})
@@ -71,7 +71,7 @@ module Algolia
     end
 
     def Protocol.partial_object_uri(index, object_id)
-      "#{index_uri(index)}/#{object_id}/partial"
+      "#{index_uri(index)}/#{CGI.escape(object_id)}/partial"
     end
     
     def Protocol.settings_uri(index)

data/lib/algolia/version.rb

@@ -1,3 +1,3 @@
 module Algolia
-  VERSION = "1.2.2"
+  VERSION = "1.2.3"
 end

data/spec/client_spec.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
 
 # avoid concurrent access to the same index
@@ -7,18 +8,40 @@ def safe_index_name(name)
   "#{name}_travis-#{id}"
 end
 
+def is_present(array, attr, value)
+  array.each do |elt|
+    if elt[attr] == value
+      return true
+    end
+  end
+  return false
+end
+
 describe 'Client' do
   before(:all) do
-    @index = Algolia::Index.new(safe_index_name("friends"))
-    @index.delete rescue "not fatal"
+    @index = Algolia::Index.new(safe_index_name("àlgol?a"))
+    @index.delete_index rescue "not fatal"
+  end
+
+  after(:all) do
+    @index.delete_index rescue "not fatal"
   end
 
   it "should add a simple object" do
-    @index.add_object!({ :name => "John Doe", :email => "john@doe.org" })
+    @index.add_object!({ :name => "John Doe", :email => "john@doe.org" }, "1")
     res = @index.search("john")
     res["hits"].length.should eq(1)
   end
 
+  it "should partial update a simple object" do
+    @index.add_object!({ :name => "John Doe", :email => "john@doe.org" }, "1")
+    res = @index.search("john")
+    res["hits"].length.should eq(1)
+    @index.partial_update_object!({ :name => "Robert Doe"}, "1")
+    res = @index.search("robert")
+    res["hits"].length.should eq(1)
+  end
+
   it "should add a set of objects" do
     @index.add_objects!([
       { :name => "Another", :email => "another1@example.org" },
@@ -28,6 +51,22 @@ describe 'Client' do
     res["hits"].length.should eq(2)
   end
 
+  it "should partial update a simple object" do
+    @index.add_object!({ :name => "John Doe", :email => "john@doe.org" }, "1")
+    @index.add_object!({ :name => "John Doe", :email => "john@doe.org" }, "2")
+    res = @index.search("john")
+    res["hits"].length.should eq(2)
+    @index.partial_update_objects!([{ :name => "Robert Doe", :objectID => "1"}, { :name => "Robert Doe", :objectID => "2"}])
+    res = @index.search("robert")
+    res["hits"].length.should eq(2)
+  end
+
+  it "should save a set of objects with their ids" do
+    @index.save_object!({ :name => "objectid", :email => "objectid1@example.org", :objectID => 101 })
+    res = @index.search("objectid")
+    res["hits"].length.should eq(1)
+  end
+
   it "should save a set of objects with their ids" do
     @index.save_objects!([
       { :name => "objectid", :email => "objectid1@example.org", :objectID => 101 },
@@ -55,7 +94,7 @@ describe 'Client' do
       t = Thread.new do
         10.times do
           res = @index.search("john")
-          res["hits"].length.should eq(1)
+          res["hits"].length.should eq(2)
         end
       end
       threads << t
@@ -69,7 +108,7 @@ describe 'Client' do
         Process.fork do
           10.times do
             res = @index.search("john")
-            res["hits"].length.should eq(1)
+            res["hits"].length.should eq(2)
           end
         end
       end
@@ -82,6 +121,124 @@ describe 'Client' do
     @index.search("")["hits"].length.should eq(0)
   end
 
+  it "should have another index after" do
+    index = Algolia::Index.new(safe_index_name("àlgol?a"))
+    begin
+      index.delete_index
+      sleep 4 # Dirty but temporary
+    rescue
+      # friends_2 does not exist
+    end
+    res = Algolia.list_indexes
+    is_present(res['items'], 'name', safe_index_name('àlgol?a')).should eq(false)
+    index.add_object!({ :name => "Robert" })
+    resAfter = Algolia.list_indexes;
+    is_present(resAfter['items'], 'name', safe_index_name('àlgol?a')).should eq(true)
+  end
+
+  it "should get a object" do
+    @index.clear_index
+    @index.add_object!({:firstname => "Robert"})
+    res = @index.search('')
+    @index.search("")["nbHits"].should eq(1)
+    object = @index.get_object(res['hits'][0]['objectID'])
+    object['firstname'].should eq('Robert')
+    object = @index.get_object(res['hits'][0]['objectID'], 'firstname')
+    object['firstname'].should eq('Robert') 
+  end
+
+  it "should delete the object" do
+    @index.clear
+    @index.add_object!({:firstname => "Robert"})
+    res = @index.search('')
+    @index.search('')['nbHits'].should eq(1)
+    object = @index.delete_object!(res['hits'][0]['objectID'])
+    @index.search('')['nbHits'].should eq(0)
+  end
+
+  it "should copy the index" do
+    index = Algolia::Index.new(safe_index_name("àlgol?à"))
+    begin
+      @index.clear_index
+      index.delete_index
+    rescue
+      # friends_2 does not exist
+    end
+
+    @index.add_object!({:firstname => "Robert"})
+    @index.search('')['nbHits'].should eq(1)
+    
+    Algolia.copy_index(safe_index_name("àlgol?a"), safe_index_name("àlgol?à"))
+    @index.delete_index
+    
+    index.search('')['nbHits'].should eq(1)
+    index.delete_index
+  end
+
+  it "should move the index" do
+    @index.clear_index rescue "friends does not exist"
+    index = Algolia::Index.new(safe_index_name("àlgol?à"))
+    begin
+      index.delete_index
+    rescue
+      # friends_2 does not exist
+    end
+
+    @index.add_object!({:firstname => "Robert"})
+    @index.search('')['nbHits'].should eq(1)
+    
+    Algolia.move_index(safe_index_name("àlgol?a"), safe_index_name("àlgol?à"))
+    
+    index.search('')['nbHits'].should eq(1)
+    index.delete_index
+  end
+
+  it "should retrieve the object" do
+    @index.clear_index rescue "friends does not exist"
+    @index.add_object!({:firstname => "Robert"})
+
+    res = @index.browse
+
+    res['hits'].size.should eq(1)
+    res['hits'][0]['firstname'].should eq("Robert")
+  end 
+
+  it "should get logs" do
+    res = Algolia.get_logs
+
+    res['logs'].size.should > 0
+  end
+
+  it "shoud accept custom batch" do
+    @index.clear_index! rescue "Not fatal"
+    request = { "requests" => [
+      {
+        "action" => "addObject",
+        "body" => {"firstname" => "Jimmie", 
+        "lastname" => "Barninger"}
+      },
+      {
+        "action" => "addObject",
+        "body" => {"firstname" => "Warren", 
+        "lastname" => "Speach"}
+      },
+      {
+        "action" => "updateObject",
+        "body" => {"firstname" => "Jimmie", 
+        "lastname" => "Barninger",
+        "objectID" => "43"}
+      },
+      {
+        "action" => "updateObject",
+        "body" => {"firstname" => "Warren", 
+        "lastname" => "Speach"},
+        "objectID" => "42"
+      }
+      ]}
+    res = @index.batch(request)
+    @index.search('')['nbHits'].should eq(4)
+  end
+
   it "should allow an array of tags" do
     @index.add_object!({ :name => "P1", :_tags => "t1" })
     @index.add_object!({ :name => "P2", :_tags => "t1" })
@@ -119,4 +276,279 @@ describe 'Client' do
     res['facets']['f']['f3'].should be_nil
   end
 
+  it "should test keys" do
+    resIndex = @index.list_user_keys
+    newIndexKey = @index.add_user_key(['search'])
+    newIndexKey['key'].should_not eq("")
+    resIndexAfter = @index.list_user_keys
+    resIndex['keys'].size.should eq(resIndexAfter['keys'].size - 1)
+    indexKey = @index.get_user_key(newIndexKey['key'])
+    indexKey['acl'][0].should eq('search')
+    @index.delete_user_key(newIndexKey['key'])
+    sleep 1 # Dirty but temporary
+    resIndexEnd = @index.list_user_keys
+    resIndex['keys'].size.should eq(resIndexEnd['keys'].size)
+
+
+    res = Algolia.list_user_keys
+    newKey = Algolia.add_user_key(['search'])
+    newKey['key'].should_not eq("")
+    resAfter = Algolia.list_user_keys
+    res['keys'].size.should eq(resAfter['keys'].size - 1)
+    key = Algolia.get_user_key(newKey['key'])
+    key['acl'][0].should eq('search')
+    Algolia.delete_user_key(newKey['key'])
+    sleep 1 # Dirty but temporary
+    resEnd = Algolia.list_user_keys
+    res['keys'].size.should eq(resEnd['keys'].size)
+
+    
+  end
+
+  it "should check functions" do
+    @index.get_settings
+    @index.list_user_keys
+    Algolia.list_user_keys
+
+  end
+
+  it "should handle slash in objectId" do
+    @index.clear_index!()
+    @index.add_object!({:firstname => "Robert", :objectID => "A/go/?a"})
+    res = @index.search('')
+    @index.search("")["nbHits"].should eq(1)
+    object = @index.get_object(res['hits'][0]['objectID'])
+    object['firstname'].should eq('Robert')
+    object = @index.get_object(res['hits'][0]['objectID'], 'firstname')
+    object['firstname'].should eq('Robert') 
+
+    @index.save_object!({:firstname => "George", :objectID => "A/go/?a"})
+    res = @index.search('')
+    @index.search("")["nbHits"].should eq(1)
+    object = @index.get_object(res['hits'][0]['objectID'])
+    object['firstname'].should eq('George')
+
+    @index.partial_update_object!({:firstname => "Sylvain", :objectID => "A/go/?a"})
+    res = @index.search('')
+    @index.search("")["nbHits"].should eq(1)
+    object = @index.get_object(res['hits'][0]['objectID'])
+    object['firstname'].should eq('Sylvain')
+
+  end
+
+  it "Check attributes list_indexes:" do
+    res = Algolia.list_indexes
+    res.should have_key('items')     
+    res['items'][0].should have_key('name')    
+    res['items'][0]['name'].should be_a(String)    
+    res['items'][0].should have_key('createdAt')    
+    res['items'][0]['createdAt'].should be_a(String)    
+    res['items'][0].should have_key('updatedAt')    
+    res['items'][0]['updatedAt'].should be_a(String)    
+    res['items'][0].should have_key('entries')    
+    res['items'][0]['entries'].should be_a(Integer)    
+    res['items'][0].should have_key('pendingTask')    
+    [true, false].should include(res['items'][0]['pendingTask']) 
+  end
+
+  it 'Check attributes search : ' do
+    res = @index.search('')
+    res.should have_key('hits')     
+    res['hits'].should be_a(Array)
+    res.should have_key('page')     
+    res['page'].should be_a(Integer)     
+    res.should have_key('nbHits')     
+    res['nbHits'].should be_a(Integer)     
+    res.should have_key('nbPages')     
+    res['nbPages'].should be_a(Integer)     
+    res.should have_key('hitsPerPage')     
+    res['hitsPerPage'].should be_a(Integer)     
+    res.should have_key('processingTimeMS')     
+    res['processingTimeMS'].should be_a(Integer)     
+    res.should have_key('query')     
+    res['query'].should be_a(String)     
+    res.should have_key('params')     
+    res['params'].should be_a(String)     
+  end
+
+  it 'Check attributes delete_index : ' do
+    index = Algolia::Index.new(safe_index_name("àlgol?à2"))
+    index.add_object!({ :name => "John Doe", :email => "john@doe.org" }, "1")
+    task = index.delete_index()
+    task.should have_key('deletedAt')
+    task['deletedAt'].should be_a(String)
+    task.should have_key('taskID')
+    task['taskID'].should be_a(Integer)
+  end
+
+  it 'Check attributes clear_index : ' do
+    task = @index.clear_index
+    task.should have_key('updatedAt')
+    task['updatedAt'].should be_a(String)
+    task.should have_key('taskID')
+    task['taskID'].should be_a(Integer)
+  end
+  
+  it 'Check attributes add object : ' do
+    task = @index.add_object({ :name => "John Doe", :email => "john@doe.org" })
+    task.should have_key('createdAt')
+    task['createdAt'].should be_a(String)
+    task.should have_key('taskID')
+    task['taskID'].should be_a(Integer)
+    task.should have_key('objectID')
+    task['objectID'].should be_a(String)
+  end
+
+  it 'Check attributes add object id: ' do
+    task = @index.add_object({ :name => "John Doe", :email => "john@doe.org" }, "1")
+    task.should have_key('updatedAt')
+    task['updatedAt'].should be_a(String)
+    task.should have_key('taskID')
+    task['taskID'].should be_a(Integer)
+    #task.to_s.should eq("")
+    task.should have_key('objectID')
+    task['objectID'].should be_a(String)
+    task['objectID'].should eq("1") 
+  end
+
+  it 'Check attributes partial update: ' do
+    task = @index.partial_update_object({ :name => "John Doe", :email => "john@doe.org" }, "1")
+    task.should have_key('updatedAt')
+    task['updatedAt'].should be_a(String)
+    task.should have_key('taskID')
+    task['taskID'].should be_a(Integer)
+    task.should have_key('objectID')
+    task['objectID'].should be_a(String)
+    task['objectID'].should eq("1")
+  end
+
+  it 'Check attributes delete object: ' do
+    @index.add_object({ :name => "John Doe", :email => "john@doe.org" }, "1")
+    task = @index.delete_object("1")
+    task.should have_key('deletedAt')
+    task['deletedAt'].should be_a(String)
+    task.should have_key('taskID')
+    task['taskID'].should be_a(Integer)
+  end
+
+  it 'Check attributes add objects: ' do
+    task = @index.add_objects([{ :name => "John Doe", :email => "john@doe.org", :objectID => "1" }])
+    task.should have_key('taskID')
+    task['taskID'].should be_a(Integer)
+    task.should have_key('objectIDs')
+    task['objectIDs'].should be_a(Array)
+  end
+
+  it 'Check attributes browse: ' do
+    res = @index.browse()
+    res.should have_key('hits')
+    res['hits'].should be_a(Array)
+    res.should have_key('page')
+    res['page'].should be_a(Integer)
+    res.should have_key('nbHits')
+    res['nbHits'].should be_a(Integer)
+    res.should have_key('nbPages')
+    res['nbPages'].should be_a(Integer)
+    res.should have_key('hitsPerPage')
+    res['hitsPerPage'].should be_a(Integer)
+    res.should have_key('processingTimeMS')
+    res['processingTimeMS'].should be_a(Integer)
+    res.should have_key('query')
+    res['query'].should be_a(String)
+    res.should have_key('params')
+    res['params'].should be_a(String)
+  end
+
+  it 'Check attributes get settings: ' do
+    task = @index.set_settings({})
+    task.should have_key('taskID')
+    task['taskID'].should be_a(Integer)
+    task.should have_key('updatedAt')
+    task['updatedAt'].should be_a(String)
+  end
+
+  it 'Check attributes move_index : ' do
+    index = Algolia::Index.new(safe_index_name("àlgol?à"))
+    index2 = Algolia::Index.new(safe_index_name("àlgol?à2"))
+    index2.add_object!({ :name => "John Doe", :email => "john@doe.org" }, "1")
+    task = Algolia.move_index(safe_index_name("àlgol?à2"), safe_index_name("àlgol?à"))
+    task.should have_key('updatedAt')
+    task['updatedAt'].should be_a(String)
+    task.should have_key('taskID')
+    task['taskID'].should be_a(Integer)
+    index.delete_index
+  end
+
+  it 'Check attributes copy_index : ' do
+    index = Algolia::Index.new(safe_index_name("àlgol?à"))
+    index2 = Algolia::Index.new(safe_index_name("àlgol?à2"))
+    index2.add_object!({ :name => "John Doe", :email => "john@doe.org" }, "1")
+    task = Algolia.copy_index(safe_index_name("àlgol?à2"), safe_index_name("àlgol?à"))
+    task.should have_key('updatedAt')
+    task['updatedAt'].should be_a(String)
+    task.should have_key('taskID')
+    task['taskID'].should be_a(Integer)
+    index.delete_index
+    index2.delete_index
+  end
+
+  it 'Check attributes wait_task : ' do
+    task = @index.add_object!({ :name => "John Doe", :email => "john@doe.org" }, "1")
+    task = Algolia.client.get(Algolia::Protocol.task_uri(safe_index_name("àlgol?a"), task['objectID']))
+    task.should have_key('status')
+    task['status'].should be_a(String)
+    task.should have_key('pendingTask')
+    [true, false].should include(task['pendingTask']) 
+  end
+
+  it "Check add keys" do
+    newIndexKey = @index.add_user_key(['search'])
+    newIndexKey.should have_key('key')
+    newIndexKey['key'].should be_a(String)
+    newIndexKey.should have_key('createdAt')
+    newIndexKey['createdAt'].should be_a(String)
+    resIndex = @index.list_user_keys
+    resIndex.should have_key('keys')
+    resIndex['keys'].should be_a(Array)
+    resIndex['keys'][0].should have_key('value')
+    resIndex['keys'][0]['value'].should be_a(String)
+    resIndex['keys'][0].should have_key('acl')
+    resIndex['keys'][0]['acl'].should be_a(Array)
+    resIndex['keys'][0].should have_key('validity')
+    resIndex['keys'][0]['validity'].should be_a(Integer)
+    indexKey = @index.get_user_key(newIndexKey['key'])
+    indexKey.should have_key('value')
+    indexKey['value'].should be_a(String)
+    indexKey.should have_key('acl')
+    indexKey['acl'].should be_a(Array)
+    indexKey.should have_key('validity')
+    indexKey['validity'].should be_a(Integer)
+    task = @index.delete_user_key(newIndexKey['key'])
+    task.should have_key('deletedAt')
+    task['deletedAt'].should be_a(String)
+  end
+
+  it 'Check attributes log : ' do
+    logs = Algolia.get_logs()
+    logs.should have_key('logs')
+    logs['logs'].should be_a(Array)
+    logs['logs'][0].should have_key('timestamp')
+    logs['logs'][0]['timestamp'].should be_a(String)
+    logs['logs'][0].should have_key('method')
+    logs['logs'][0]['method'].should be_a(String)
+    logs['logs'][0].should have_key('answer_code')
+    logs['logs'][0]['answer_code'].should be_a(String)
+    logs['logs'][0].should have_key('query_body')
+    logs['logs'][0]['query_body'].should be_a(String)
+    logs['logs'][0].should have_key('answer')
+    logs['logs'][0]['answer'].should be_a(String)
+    logs['logs'][0].should have_key('url')
+    logs['logs'][0]['url'].should be_a(String)
+    logs['logs'][0].should have_key('ip')
+    logs['logs'][0]['ip'].should be_a(String)
+    logs['logs'][0].should have_key('query_headers')
+    logs['logs'][0]['query_headers'].should be_a(String)
+    logs['logs'][0].should have_key('sha1')
+    logs['logs'][0]['sha1'].should be_a(String)
+  end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,14 @@
+
+if ENV['COVERAGE']
+    require 'simplecov'
+    SimpleCov.start
+end
+
+if ENV['TRAVIS'] && RUBY_ENGINE == "ruby"
+  require 'coveralls'
+  Coveralls.wear!
+end
+
 require 'rubygems'
 Bundler.setup :test
 

metadata

@@ -1,74 +1,94 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: algoliasearch
-version: !ruby/object:Gem::Version 
-  version: 1.2.2
+version: !ruby/object:Gem::Version
+  version: 1.2.3
 platform: ruby
-authors: 
+authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2014-01-11 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: httpclient
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "2.3"
+      - !ruby/object:Gem::Version
+        version: '2.3'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
         version: 1.5.1
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: travis
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
-    - &id004 
-      - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+- !ruby/object:Gem::Dependency
+  name: travis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id004
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: rdoc
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id004
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id006
+  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: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - ChangeLog
 - LICENSE.txt
 - README.md
-files: 
+files:
 - .rspec
 - .travis.yml
 - ChangeLog
@@ -92,27 +112,27 @@ files:
 - spec/spec_helper.rb
 - spec/stub_spec.rb
 homepage: http://github.com/algolia/algoliasearch-client-ruby
-licenses: 
+licenses:
 - MIT
 metadata: {}
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id004
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id004
+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.2.1
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: A simple Ruby client for the algolia.com REST API
 test_files: []
-