algoliasearch 1.14.0 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6d01ca8470b386e201eafd5b2b9ddd4b7e27798
-  data.tar.gz: aa1805c338e64d494faa766631f893b345c49a45
+  metadata.gz: 4652471c52a7730735419658326bb7202e00a8ef
+  data.tar.gz: bb43fe5aebc4ff687e2fcc51626c08de40c4f3b7
 SHA512:
-  metadata.gz: 49325672a796719b69e9b55e712a7ebcfc40379455090269e540313a3d47498a1e6e51a7daad05565d90202897d909fe34540bf630d21e2ca50d0a30b3660a8d
-  data.tar.gz: e042c97bf502f37e88081d72589c258dadb8059bd801a0d7f590ccee8cca19895f2cfc74b99c2f33b74daec248eec7791a594c9f83703fb206478aa215d94744
+  metadata.gz: 941a2837cb2c6a8da7d88c30829badbeb0a7eb2b7ad0e23ef0dd7349a16af7142c52bd8f01be51ccea9e47bdf01756ec200649717693da222fdf04362737697f
+  data.tar.gz: 710b30782cbf1b835b80b7c8dead3f5e84ac35113aa47ebc2cd4fa16e8dac2eaf68aa73c4fb160b47a984811658ce32e09fa9ec863cd1c59efbd24870b584ad3

data/ChangeLog

@@ -1,5 +1,9 @@
 CHANGELOG
 
+2017-08-17 1.15.0
+      * Make delete_by_query not wait_task by default (also, make it mockable)
+      * Add a new delete_by_query! doing the last wait_task
+
 2017-07-31 1.14.0
       * Ability to override the underlying user-agent
 

data/Gemfile.lock

@@ -32,8 +32,8 @@ GEM
       net-http-pipeline
     highline (1.6.21)
     httpclient (2.8.3)
-    json (1.8.3)
-    json (1.8.3-java)
+    json (1.8.6)
+    json (1.8.6-java)
     launchy (2.4.3)
       addressable (~> 2.3)
     launchy (2.4.3-java)
@@ -325,4 +325,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.13.6
+   1.15.3

data/README.md

@@ -26,12 +26,19 @@ You can find the full reference on [Algolia's website](https://www.algolia.com/d
 1. **[Quick Start](#quick-start)**
 
     * [Initialize the client](#initialize-the-client)
-    * [Push data](#push-data)
-    * [Search](#search)
-    * [Configure](#configure)
-    * [Frontend search](#frontend-search)
 
-1. **[Getting Help](#getting-help)**
+1. **[Push data](#push-data)**
+
+
+1. **[Configure](#configure)**
+
+
+1. **[Search](#search)**
+
+
+1. **[Search UI](#search-ui)**
+
+    * [index.html](#indexhtml)
 
 
 
@@ -41,6 +48,7 @@ You can find the full reference on [Algolia's website](https://www.algolia.com/d
 
 
 
+
 ## Install
 
 Install AlgoliaSearch using:
@@ -59,95 +67,133 @@ In 30 seconds, this quick start tutorial will show you how to index and search o
 
 ### Initialize the client
 
-You first need to initialize the client. For that you need your **Application ID** and **API Key**.
-You can find both of them on [your Algolia account](https://www.algolia.com/api-keys).
+To begin, you will need to initialize the client. In order to do this you will need your **Application ID** and **API Key**.
+You can find both on [your Algolia account](https://www.algolia.com/api-keys).
 
 ```ruby
 require 'rubygems'
 require 'algoliasearch'
 
-Algolia.init :application_id => "YourApplicationID",
-             :api_key        => "YourAPIKey"
+Algolia.init application_id: 'YourApplicationID',
+             api_key:        'YourAPIKey'
 ```
 
-### Push data
+## Push data
 
-Without any prior configuration, you can start indexing [500 contacts](https://github.com/algolia/algoliasearch-client-csharp/blob/master/contacts.json) in the ```contacts``` index using the following code:
+Without any prior configuration, you can start indexing [500 contacts](https://raw.githubusercontent.com/algolia/datasets-public/master/contacts.json) in the ```contacts``` index using the following code:
 ```ruby
-index = Algolia::Index.new("contacts")
-batch = JSON.parse(File.read("contacts.json"))
+index = Algolia::Index.new('contacts')
+batch = JSON.parse(File.read('contacts.json'))
 index.add_objects(batch)
 ```
 
-### Search
+## Configure
 
-You can now search for contacts using firstname, lastname, company, etc. (even with typos):
+Settings can be customized to fine tune the search behavior. For example, you can add a custom sort by number of followers to further enhance the built-in relevance:
 
 ```ruby
-# search by firstname
-puts index.search('jimmie').to_json
-# search a firstname with typo
-puts index.search('jimie').to_json
-# search for a company
-puts index.search('california paint').to_json
-# search for a firstname & company
-puts index.search('jimmie paint').to_json
+index.set_settings customRanking: ['desc(followers)']
 ```
 
-### Configure
+You can also configure the list of attributes you want to index by order of importance (most important first).
 
-Settings can be customized to tune the search behavior. For example, you can add a custom sort by number of followers to the already great built-in relevance:
+**Note:** The Algolia engine is designed to suggest results as you type, which means you'll generally search by prefix.
+In this case, the order of attributes is very important to decide which hit is the best:
 
 ```ruby
-index.set_settings({"customRanking" => ["desc(followers)"]})
+index.set_settings searchableAttributes: %w(
+  lastname
+  firstname
+  company
+  email
+  city
+  address
+)
 ```
 
-You can also configure the list of attributes you want to index by order of importance (first = most important):
+## Search
 
-**Note:** Since the engine is designed to suggest results as you type, you'll generally search by prefix.
-In this case the order of attributes is very important to decide which hit is the best:
+You can now search for contacts using `firstname`, `lastname`, `company`, etc. (even with typos):
 
 ```ruby
-index.set_settings({"searchableAttributes" => ["lastname", "firstname", "company",
-                                            "email", "city", "address"]})
+# search by firstname
+puts index.search('jimmie').to_json
+# search a firstname with typo
+puts index.search('jimie').to_json
+# search for a company
+puts index.search('california paint').to_json
+# search for a firstname & company
+puts index.search('jimmie paint').to_json
 ```
 
-### Frontend search
+## Search UI
+
+**Warning:** If you are building a web application, you may be more interested in using one of our
+[frontend search UI librairies](https://www.algolia.com/doc/guides/search-ui/search-libraries/)
 
-**Note:** If you are building a web application, you may be more interested in using our [JavaScript client](https://github.com/algolia/algoliasearch-client-javascript) to perform queries.
+The following example shows how to build a front-end search quickly using
+[InstanSearch.js](https://community.algolia.com/instantsearch.js/)
 
-It brings two benefits:
-  * Your users get a better response time by not going through your servers
-  * It will offload unnecessary tasks from your servers
+### index.html
 
 ```html
-<script src="https://cdn.jsdelivr.net/algoliasearch/3/algoliasearch.min.js"></script>
-<script>
-var client = algoliasearch('ApplicationID', 'apiKey');
-var index = client.initIndex('indexName');
-
-// perform query "jim"
-index.search('jim', searchCallback);
-
-// the last optional argument can be used to add search parameters
-index.search(
-  'jim', {
-    hitsPerPage: 5,
-    facets: '*',
-    maxValuesPerFacet: 10
-  },
-  searchCallback
+<!doctype html>
+<head>
+  <meta charset="UTF-8">
+  <link rel="stylesheet" href="https://cdn.jsdelivr.net/instantsearch.js/1/instantsearch.min.css">
+</head>
+<body>
+  <header>
+    <div>
+       <input id="search-input" placeholder="Search for products">
+       <!-- We use a specific placeholder in the input to guides users in their search. -->
+    
+  </header>
+  <main>
+      
+      
+  </main>
+
+  <script type="text/html" id="hit-template">
+    
+      <p class="hit-name">{{{_highlightResult.firstname.value}}} {{{_highlightResult.lastname.value}}}</p>
+    
+  </script>
+
+  <script src="https://cdn.jsdelivr.net/instantsearch.js/1/instantsearch.min.js"></script>
+  <script src="app.js"></script>
+</body>
+```
+
+### app.js
+
+```js
+var search = instantsearch({
+  // Replace with your own values
+  appId: 'YourApplicationID',
+  apiKey: 'YourSearchOnlyAPIKey', // search only API key, no ADMIN key
+  indexName: 'contacts',
+  urlSync: true
+});
+
+search.addWidget(
+  instantsearch.widgets.searchBox({
+    container: '#search-input'
+  })
 );
 
-function searchCallback(err, content) {
-  if (err) {
-    console.error(err);
-    return;
-  }
+search.addWidget(
+  instantsearch.widgets.hits({
+    container: '#hits',
+    hitsPerPage: 10,
+    templates: {
+      item: document.getElementById('hit-template').innerHTML,
+      empty: "We didn't find any results for the search <em>\"{{query}}\"</em>"
+    }
+  })
+);
 
-  console.log(content);
-}
-</script>
+search.start();
 ```
 
 ## Getting Help

data/lib/algolia/index.rb

@@ -405,13 +405,28 @@ module Algolia
       params.delete('attributesToRetrieve')
 
       params[:hitsPerPage] = 1000
+      params[:distinct] = false
       params[:attributesToRetrieve] = ['objectID']
+      last_task = nil
       loop do
         res = search(query, params)
         break if res['hits'].empty?
-        res = delete_objects(res['hits'].map { |h| h['objectID'] })
-        wait_task res['taskID']
+        last_task = delete_objects(res['hits'].map { |h| h['objectID'] })
+        break if res['hits'].size < 1000
       end
+      last_task
+    end
+
+    #
+    # Delete all objects matching a query and wait end of indexing
+    #
+    # @param query the query string
+    # @param params the optional query parameters
+    #
+    def delete_by_query!(query, params = nil)
+      res = delete_by_query(query, params)
+      wait_task(res['taskID']) if res
+      res
     end
 
     #

data/lib/algolia/version.rb

@@ -1,3 +1,3 @@
 module Algolia
-  VERSION = "1.14.0"
+  VERSION = "1.15.0"
 end

data/spec/client_spec.rb

@@ -241,7 +241,7 @@ describe 'Client' do
     @index.add_object({:firstname => "Robert1"})
     @index.add_object!({:firstname => "Robert2"})
     @index.search('')['nbHits'].should eq(2)
-    @index.delete_by_query('rob')
+    @index.delete_by_query!('rob')
     @index.search('')['nbHits'].should eq(0)
   end
 

data/spec/mock_spec.rb

@@ -21,6 +21,7 @@ describe 'With a mocked client' do
     index.browse
     index.clear
     index.delete
+    index.delete_by_query 'test'
   end
 
   after(:all) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.15.0
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-31 00:00:00.000000000 Z
+date: 2017-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient