algoliasearch 1.1.11 → 1.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee93665f54a3d1f94176ca8eaee1974067a89411
-  data.tar.gz: ff813172469ffdd3a3005753a68f36c674a351d2
+  metadata.gz: 82eae7dcf820e44290c0b6afb575fce03699c1ce
+  data.tar.gz: 8a90fe2fc6858c7fdf7714c9aa4e558bbcf39ef5
 SHA512:
-  metadata.gz: 64c1bd3eb60d2ae66b618448dba718ddce626fd5d6cecab59605d52a4cce4bba2da0048c0959b7bf6fd5a0bf7d33851cb5b933349ceccf18baff9479e2b357c4
-  data.tar.gz: d0318302d8e116ed2b604d69fb2ae10f15e61fc6a17591678cc9738b52887c8d8c738b494d7c91859d88b5ad4db51b6f0d1641a2cc99cdc04a242af0ecf6ec52
+  metadata.gz: cd24dbf3876411d88b2bbe04aa8b321d11c8314cdf6cb0b218db3c82c7cd5cfc5a107181528b28c0babc43f240065a08eb0c9d7634f4ac94daabd0644c44359c
+  data.tar.gz: 050d6f623ba9e0baf51c37389aa2b3a0827556cbd18bb924995d509087a0f688e50be649503f74574a45f4e87dc3bf74a70e15ca81cdf35c5d8448f335980bbc

data/README.md

@@ -39,6 +39,7 @@ Table of Content
 1. [Batch writes](#batch-writes)
 1. [Security / User API Keys](#security--user-api-keys)
 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)
 
 Setup
@@ -97,7 +98,7 @@ puts index.search('jim').to_json
 
 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 threw 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:
@@ -261,7 +262,9 @@ You can retrieve all settings using the `getSettings` function. The result will
   * **geo**: sort according to decreassing distance when performing a geo-location based search,
   * **proximity**: sort according to the proximity of query words in hits,
   * **attribute**: sort according to the order of attributes defined by attributesToIndex,
-  * **exact**: sort according to the number of words that are matched identical to query word (and not as a prefix),
+  * **exact**: 
+    * if the user query contains one word: sort objects having an attribute that is exactly the query word before others. For example if you search for the "V" TV show, you want to find it with the "V" query and avoid to have all popular TV show starting by the v letter before it.
+    * if the user query contains multiple words: sort according to the number of words that matched exactly (and not as a prefix).
   * **custom**: sort according to a user defined formula set in **customRanking** attribute.<br/>The standard order is ["typo", "geo", "proximity", "attribute", "exact", "custom"]
  * **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)"]`  
@@ -375,6 +378,7 @@ index.list_user_keys
 
 Each key is defined by a set of rights that specify the authorized actions. The different rights are:
  * **search**: allows to search,
+ * **browse**: allow to retrieve all index content via the browse API,
  * **addObject**: allows to add/update an object in the index,
  * **deleteObject**: allows to delete an existing object,
  * **deleteIndex**: allows to delete index content,
@@ -443,6 +447,19 @@ The move command is particularly useful is you want to update a big index atomic
 puts Algolia.move_index("MyNewIndex", "MyIndex")
 ```
 
+Backup / Retrieve all index content
+-------------
+
+You can retrieve all index content for backup purpose of for analytics using the browse method. 
+This method retrieve 1000 objects by API call and support pagination.
+
+```ruby
+# Get first page
+puts index.browse(0);
+# Get second page
+puts index.browse(1);
+```
+
 Logs
 -------------
 
@@ -466,4 +483,4 @@ You can retrieve the logs of your last 1000 API calls and browse them using the
 puts Algolia.get_logs.to_json
 # Get last 100 log entries
 puts Algolia.get_logs(0, 100).to_json
-```
+```

data/algoliasearch.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "algoliasearch"
-  s.version = "1.1.11"
+  s.version = "1.1.12"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Algolia"]
-  s.date = "2013-11-29"
+  s.date = "2013-12-05"
   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

@@ -134,6 +134,17 @@ module Algolia
       Algolia.client.get(Protocol.search_uri(name, query, encoded_params))
     end
 
+    #
+    # Browse all index content
+    #
+    # @param page Pagination parameter used to select the page to retrieve.
+    #             Page is zero-based and defaults to 0. Thus, to retrieve the 10th page you need to set page=9
+    # @param hitsPerPage: Pagination parameter used to select the number of hits per page. Defaults to 1000.
+    #
+    def browse(page = 0, hitsPerPage = 1000)
+     Algolia.client.get(Protocol.browse_uri(name, {"page" => page, "hitsPerPage" => hitsPerPage}))
+    end
+
     #
     # Get an object from this index
     # 

data/lib/algolia/protocol.rb

@@ -61,6 +61,11 @@ module Algolia
       "#{index_uri(index)}?query=#{CGI.escape(query)}&#{params}"
     end
 
+    def Protocol.browse_uri(index, params = {})
+      params = params.nil? || params.size == 0 ? "" : "?#{to_query(params)}"
+      "#{index_uri(index)}/browse#{params}"
+    end
+
     def Protocol.partial_object_uri(index, object_id)
       "#{index_uri(index)}/#{object_id}/partial"
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch
 version: !ruby/object:Gem::Version
-  version: 1.1.11
+  version: 1.1.12
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-29 00:00:00.000000000 Z
+date: 2013-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curb
@@ -113,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.12
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: A simple Ruby client for the algolia.com REST API