algoliasearch 1.2.3 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c168df1007c65f3a05fdac4a6d85abb0c032307b
-  data.tar.gz: 428cd9b8e97c21fdece377ef64e5a8b78118470c
+  metadata.gz: 5f84365c51f1592ac0bd372b32ef668eae0831ec
+  data.tar.gz: 315a6fbb785510696b8a9d1717de2cf09e208fd2
 SHA512:
-  metadata.gz: a9443ef278cfc1767212702a70f7d335f18b710f77538014c6e327e0bb165ab676f1044594a323a83718efec5e4bce00efb2dd2efc209f48d2143984260a06c5
-  data.tar.gz: 9ded465bc3d8f4486c96693ea14cfecb6f0ba2a4249931f8c15fae518f3ba2bf82cd6827b0da0b9462c305a799b2fc86e7a0b6a677269dd43ba8d3adff5445da
+  metadata.gz: 3e4bf583e3651c8b02c76e8bc6a50c038c54ab40766bc14ad1ca8ad6f8608e90984827aa4f8a5474d956af1ac4ebf9e5ff48e93696132fd12bb229769ad193e3
+  data.tar.gz: 6adcdf51f0a2702b5a7adbdebae0387a6d05a2c6957a44cdb388e37c0650aba41df48223ab110dccbaf13b7b53f39f16a5b211b5bbcc991e9d57e1303b7fb49d

data/ChangeLog

@@ -1,5 +1,9 @@
 CHANGELOG
 
+2014-02-21  1.2.4
+
+      * Added delete_objects
+
 2014-02-10  1.2.3
 
       * add_object: POST request if objectID is nil OR empty

data/README.md

@@ -19,6 +19,7 @@ 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) [![Coverage Status](https://coveralls.io/repos/algolia/algoliasearch-client-ruby/badge.png)](https://coveralls.io/r/algolia/algoliasearch-client-ruby)
 
 
@@ -192,6 +193,8 @@ 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.
@@ -220,7 +223,7 @@ You can use the following optional arguments:
 
 #### 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}}`)
+ * **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
@@ -244,6 +247,7 @@ You can use the following optional arguments:
 #### Faceting parameters
  * **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**.
+ * **maxValuesPerFacet**: Limit the number of facet values returned for each facet. For example: `maxValuesPerFacet=10` will retrieve max 10 values per facet.
 
 #### Distinct parameter
  * **distinct**: If set to 1, enable the distinct feature (disabled by default) if the `attributeForDistinct` index setting is set. This feature is similar to the SQL "distinct" keyword: when enabled in a query with the `distinct=1` parameter, all hits containing a duplicate value for the attributeForDistinct attribute are removed from results. For example, if the chosen attribute is `show_name` and several hits have the same value for `show_name`, then only the best one is kept and others are removed.
@@ -289,6 +293,8 @@ The server response will look like:
 }
 ```
 
+
+
 Get an object
 -------------
 
@@ -409,6 +415,7 @@ You may want to perform multiple operations with one API call to reduce latency.
 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
+ * `delete_objects`: delete an array of objectIDs
  * `partial_update_objects`: partially update an array of objects that contain an `objectID` attribute (only specified attributes will be updated, other will remain unchanged)
 
 Example using automatic `objectID` assignement:
@@ -429,6 +436,11 @@ res = index.save_objects([{"firstname" => "Jimmie",
                            "objectID" => "myID2"}])
 ```
 
+Example that delete a set of records:
+```ruby
+res = index.delete_objects(["myID1", "myID2"])
+```
+
 Example that update only the `firstname` attribute:
 ```ruby
 res = index.partial_update_objects([{"firstname" => "Jimmie", 

data/algoliasearch.gemspec

@@ -6,12 +6,12 @@
 
 Gem::Specification.new do |s|
   s.name = "algoliasearch"
-  s.version = "1.2.3"
+  s.version = "1.2.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Algolia"]
-  s.date = "2014-01-11"
+  s.date = "2014-02-21"
   s.description = "A simple Ruby client for the algolia.com REST API"
   s.email = "contact@algolia.com"
   s.extra_rdoc_files = [

data/lib/algolia/index.rb

@@ -179,7 +179,7 @@ module Algolia
       Algolia.client.put(Protocol.object_uri(name, get_objectID(obj, objectID)), obj.to_json)
     end
 
-    # Override the content of object and wait indexing
+    # Override the content of object and wait end of indexing
     # 
     # @param obj the object to save
     # @param objectID the associated objectID, if nil 'obj' must contain an 'objectID' key
@@ -198,7 +198,7 @@ module Algolia
       batch build_batch('updateObject', objs, true)
     end
 
-    # Override the content of several objects and wait indexing
+    # Override the content of several objects and wait end of indexing
     # 
     # @param objs the array of objects to save, each object must contain an objectID attribute
     #    
@@ -228,7 +228,7 @@ module Algolia
     end
 
     #
-    # Partially Override the content of several objects
+    # Partially Override the content of several objects and wait end of indexing
     # 
     # @param objs an array of objects to update (each object must contains a objectID attribute)
     #
@@ -270,6 +270,27 @@ module Algolia
       return res
     end
 
+    #
+    # Delete several objects
+    # 
+    # @param objs an array of objectIDs
+    #
+    def delete_objects(objs)
+      check_array objs
+      batch build_batch('deleteObject', objs.map { |objectID| { objectID: objectID } }, false)
+    end
+
+    #
+    # Delete several objects and wait end of indexing
+    # 
+    # @param objs an array of objectIDs
+    #
+    def delete_objects!(objs)
+      res = delete_objects(objs)
+      wait_task(res["taskID"])
+      return res
+    end
+
     #
     # Delete the index content
     # 

data/spec/client_spec.rb

@@ -152,7 +152,17 @@ describe 'Client' do
     @index.add_object!({:firstname => "Robert"})
     res = @index.search('')
     @index.search('')['nbHits'].should eq(1)
-    object = @index.delete_object!(res['hits'][0]['objectID'])
+    @index.delete_object!(res['hits'][0]['objectID'])
+    @index.search('')['nbHits'].should eq(0)
+  end
+
+  it "should delete several objects" do
+    @index.clear
+    @index.add_object!({:firstname => "Robert1"})
+    @index.add_object!({:firstname => "Robert2"})
+    res = @index.search('')
+    @index.search('')['nbHits'].should eq(2)
+    @index.delete_objects!(res['hits'].map { |h| h['objectID'] })
     @index.search('')['nbHits'].should eq(0)
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-11 00:00:00.000000000 Z
+date: 2014-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient