algoliasearch 1.24.0 → 1.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6656588b81231ae7bff38c4b5fc55bb36194233505bc493107dd3dd9526ae86d
-  data.tar.gz: c64bf649901a0ea9f5ac1997b55f9917cc719bf59a956ea0db7b751268838700
+  metadata.gz: 3d2c8207648db3e97139f3cfa780dd809a93261375d13200293392e3c5dfb415
+  data.tar.gz: ad0cf55c0b32e1f5626c87f2d4df527812c7c5ba04470e9cab07a75dcdb6f213
 SHA512:
-  metadata.gz: c19eb997c9a08b5e1219296756d99c61f9d22af53d06c9589537418d94755e030def9ebebbf8357670b081e1229d77cc674c795fa33c953bb7dc6dde6d3f26c6
-  data.tar.gz: 025ba93db32d9d3b6aa478dd638207ad84ec97df681c5807dbfc858ff88a8e2e77ef637e7eaa2b02738d6b47859c5b923cf02d3a74afa1b917062e7b8ba757cd
+  metadata.gz: '00897df4dc73d01b3812b3612de184acea35fa4becce5a6d175c389441a7a99bf8f22b326283cfe2d7190e4cbe4f40004a55d96d45e002acfd93fe4fd6525810'
+  data.tar.gz: 054e24efa3a634eb43847d7bb36cf82e0694461db3fa5826dc945c101527027e2ae3787685367d6afad546e183cfef4ab9c8826b30d5b883c04d9317dd1d713b

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [1.25.0](https://github.com/algolia/algoliasearch-client-ruby/releases/tag/1.25.0) (2018-12-19)
+
+**Added**
+
+* Introduce Insights client to send events to Algolia Insights API - [326](https://github.com/algolia/algoliasearch-client-ruby/issues/326)
+
+* Add `multiple_get_objects` to retrieve objects by objectID across multiple indices - [329](https://github.com/algolia/algoliasearch-client-ruby/issues/329)
+
+**Modified**
+
+* Use the correct `hitsPerPage` key when exporting index resources - [319](https://github.com/algolia/algoliasearch-client-ruby/issues/319)
+
 ## [1.24.0](https://github.com/algolia/algoliasearch-client-ruby/releases/tag/1.24.0) (2018-11-28)
 
 * Feat(adds-account-client-copy-index): adds `copy_index` to account client ([#324](https://github.com/algolia/algoliasearch-client-ruby/pull/324))

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    algoliasearch (1.23.2)
+    algoliasearch (1.24.0)
       httpclient (~> 2.8, >= 2.8.3)
       json (>= 1.5.1)
 
@@ -9,24 +9,24 @@ GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.4.0)
-    backports (3.11.4)
-    coveralls (0.8.22)
-      json (>= 1.8, < 3)
-      simplecov (~> 0.16.1)
-      term-ansicolor (~> 1.3)
-      thor (~> 0.19.4)
-      tins (~> 1.6)
+    backports (3.11.1)
+    coveralls (0.7.2)
+      multi_json (~> 1.3)
+      rest-client (= 1.6.7)
+      simplecov (>= 0.7)
+      term-ansicolor (= 1.2.2)
+      thor (= 0.18.1)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    docile (1.3.1)
+    docile (1.3.0)
     ethon (0.11.0)
       ffi (>= 1.3.0)
-    faraday (0.15.3)
+    faraday (0.14.0)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.12.2)
       faraday (>= 0.7.4, < 1.0)
-    ffi (1.9.25)
+    ffi (1.9.23)
     ffi2-generators (0.1.1)
     gh (0.15.1)
       addressable (~> 2.4.0)
@@ -36,11 +36,12 @@ GEM
       net-http-persistent (~> 2.9)
       net-http-pipeline
     hashdiff (0.3.7)
-    highline (1.7.10)
+    highline (1.6.21)
     httpclient (2.8.3)
     json (2.1.0)
     launchy (2.4.3)
       addressable (~> 2.3)
+    mime-types (1.25.1)
     multi_json (1.13.1)
     multipart-post (2.0.0)
     net-http-persistent (2.9.4)
@@ -49,20 +50,22 @@ GEM
       json
       websocket (~> 1.0)
     rake (12.3.1)
-    rdoc (6.0.4)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    rdoc (6.0.3)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
     rubysl (2.2.0)
       rubysl-abbrev (~> 2.0)
       rubysl-base64 (~> 2.0)
@@ -243,7 +246,7 @@ GEM
     rubysl-singleton (2.0.0)
     rubysl-socket (2.2.1)
       rubysl-fcntl (~> 2.0)
-    rubysl-stringio (2.3)
+    rubysl-stringio (2.2)
     rubysl-strscan (2.0.0)
     rubysl-sync (2.0.0)
     rubysl-syslog (2.1.0)
@@ -271,11 +274,11 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    term-ansicolor (1.7.0)
-      tins (~> 1.0)
-    thor (0.19.4)
-    tins (1.20.2)
-    travis (1.8.9)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
+    thor (0.18.1)
+    tins (0.13.2)
+    travis (1.8.8)
       backports
       faraday (~> 0.9)
       faraday_middleware (~> 0.9, >= 0.9.1)
@@ -286,11 +289,11 @@ GEM
       typhoeus (~> 0.6, >= 0.6.8)
     typhoeus (0.8.0)
       ethon (>= 0.8.0)
-    webmock (3.4.2)
+    webmock (3.3.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
-    websocket (1.2.8)
+    websocket (1.2.5)
 
 PLATFORMS
   ruby
@@ -307,4 +310,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.17.1
+   1.16.6

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014-Present Algolia
+Copyright (c) 2013-Present Algolia
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -48,7 +48,7 @@ You can find the full reference on [Algolia's website](https://www.algolia.com/d
 
 ## Install
 
-Install AlgoliaSearch using:
+Install the Ruby client using [RubyGems](https://rubygems.org/):
 
 ```bash
 gem install algoliasearch
@@ -99,13 +99,15 @@ You can also configure the list of attributes you want to index by order of impo
 In this case, the order of attributes is very important to decide which hit is the best:
 
 ```ruby
-index.set_settings searchableAttributes: %w(
-  lastname
-  firstname
-  company
-  email
-  city
-  address
+index.set_settings({
+  searchableAttributes: [
+    'lastname',
+    'firstname',
+    'company',
+    'email',
+    'city',
+    'address'
+  ]}
 )
 ```
 
@@ -114,13 +116,13 @@ index.set_settings searchableAttributes: %w(
 You can now search for contacts using `firstname`, `lastname`, `company`, etc. (even with typos):
 
 ```ruby
-# search by firstname
+# Search for a first name
 puts index.search('jimmie').to_json
-# search a firstname with typo
+# Search for a first name with typo
 puts index.search('jimie').to_json
-# search for a company
+# Search for a company
 puts index.search('california paint').to_json
-# search for a firstname & company
+# Search for a first name and a company
 puts index.search('jimmie paint').to_json
 ```
 
@@ -207,11 +209,19 @@ search.start();
 
 
 
+### Personalization
+
+- [Add strategy](https://algolia.com/doc/api-reference/api-methods/add-strategy/?language=ruby)
+- [Get strategy](https://algolia.com/doc/api-reference/api-methods/get-strategy/?language=ruby)
+
+
+
+
 ### Search
 
 - [Search index](https://algolia.com/doc/api-reference/api-methods/search/?language=ruby)
 - [Search for facet values](https://algolia.com/doc/api-reference/api-methods/search-for-facet-values/?language=ruby)
-- [Search multiple indexes](https://algolia.com/doc/api-reference/api-methods/multiple-queries/?language=ruby)
+- [Search multiple indices](https://algolia.com/doc/api-reference/api-methods/multiple-queries/?language=ruby)
 - [Browse index](https://algolia.com/doc/api-reference/api-methods/browse/?language=ruby)
 
 
@@ -220,10 +230,12 @@ search.start();
 ### Indexing
 
 - [Add objects](https://algolia.com/doc/api-reference/api-methods/add-objects/?language=ruby)
-- [Update objects](https://algolia.com/doc/api-reference/api-methods/update-objects/?language=ruby)
+- [Save objects](https://algolia.com/doc/api-reference/api-methods/save-objects/?language=ruby)
 - [Partial update objects](https://algolia.com/doc/api-reference/api-methods/partial-update-objects/?language=ruby)
 - [Delete objects](https://algolia.com/doc/api-reference/api-methods/delete-objects/?language=ruby)
+- [Replace all objects](https://algolia.com/doc/api-reference/api-methods/replace-all-objects/?language=ruby)
 - [Delete by](https://algolia.com/doc/api-reference/api-methods/delete-by/?language=ruby)
+- [Clear objects](https://algolia.com/doc/api-reference/api-methods/clear-objects/?language=ruby)
 - [Get objects](https://algolia.com/doc/api-reference/api-methods/get-objects/?language=ruby)
 - [Custom batch](https://algolia.com/doc/api-reference/api-methods/batch/?language=ruby)
 
@@ -234,17 +246,17 @@ search.start();
 
 - [Get settings](https://algolia.com/doc/api-reference/api-methods/get-settings/?language=ruby)
 - [Set settings](https://algolia.com/doc/api-reference/api-methods/set-settings/?language=ruby)
+- [Copy settings](https://algolia.com/doc/api-reference/api-methods/copy-settings/?language=ruby)
 
 
 
 
 ### Manage indices
 
-- [List indexes](https://algolia.com/doc/api-reference/api-methods/list-indices/?language=ruby)
+- [List indices](https://algolia.com/doc/api-reference/api-methods/list-indices/?language=ruby)
 - [Delete index](https://algolia.com/doc/api-reference/api-methods/delete-index/?language=ruby)
 - [Copy index](https://algolia.com/doc/api-reference/api-methods/copy-index/?language=ruby)
 - [Move index](https://algolia.com/doc/api-reference/api-methods/move-index/?language=ruby)
-- [Clear index](https://algolia.com/doc/api-reference/api-methods/clear-index/?language=ruby)
 
 
 
@@ -269,6 +281,8 @@ search.start();
 - [Clear all synonyms](https://algolia.com/doc/api-reference/api-methods/clear-synonyms/?language=ruby)
 - [Get synonym](https://algolia.com/doc/api-reference/api-methods/get-synonym/?language=ruby)
 - [Search synonyms](https://algolia.com/doc/api-reference/api-methods/search-synonyms/?language=ruby)
+- [Replace all synonyms](https://algolia.com/doc/api-reference/api-methods/replace-all-synonyms/?language=ruby)
+- [Copy synonyms](https://algolia.com/doc/api-reference/api-methods/copy-synonyms/?language=ruby)
 - [Export Synonyms](https://algolia.com/doc/api-reference/api-methods/export-synonyms/?language=ruby)
 
 
@@ -276,13 +290,15 @@ search.start();
 
 ### Query rules
 
-- [Save rule](https://algolia.com/doc/api-reference/api-methods/rules-save/?language=ruby)
-- [Batch rules](https://algolia.com/doc/api-reference/api-methods/rules-save-batch/?language=ruby)
-- [Get rule](https://algolia.com/doc/api-reference/api-methods/rules-get/?language=ruby)
-- [Delete rule](https://algolia.com/doc/api-reference/api-methods/rules-delete/?language=ruby)
-- [Clear rules](https://algolia.com/doc/api-reference/api-methods/rules-clear/?language=ruby)
-- [Search rules](https://algolia.com/doc/api-reference/api-methods/rules-search/?language=ruby)
-- [Export rules](https://algolia.com/doc/api-reference/api-methods/rules-export/?language=ruby)
+- [Save rule](https://algolia.com/doc/api-reference/api-methods/save-rule/?language=ruby)
+- [Batch rules](https://algolia.com/doc/api-reference/api-methods/batch-rules/?language=ruby)
+- [Get rule](https://algolia.com/doc/api-reference/api-methods/get-rule/?language=ruby)
+- [Delete rule](https://algolia.com/doc/api-reference/api-methods/delete-rule/?language=ruby)
+- [Clear rules](https://algolia.com/doc/api-reference/api-methods/clear-rules/?language=ruby)
+- [Search rules](https://algolia.com/doc/api-reference/api-methods/search-rules/?language=ruby)
+- [Replace all rules](https://algolia.com/doc/api-reference/api-methods/replace-all-rules/?language=ruby)
+- [Copy rules](https://algolia.com/doc/api-reference/api-methods/copy-rules/?language=ruby)
+- [Export rules](https://algolia.com/doc/api-reference/api-methods/export-rules/?language=ruby)
 
 
 
@@ -298,6 +314,20 @@ search.start();
 
 
 
+### Insights
+
+- [Clicked Object IDs After Search](https://algolia.com/doc/api-reference/api-methods/clicked-object-ids-after-search/?language=ruby)
+- [Clicked Object IDs](https://algolia.com/doc/api-reference/api-methods/clicked-object-ids/?language=ruby)
+- [Clicked Filters](https://algolia.com/doc/api-reference/api-methods/clicked-filters/?language=ruby)
+- [Converted Objects IDs After Search](https://algolia.com/doc/api-reference/api-methods/converted-object-ids-after-search/?language=ruby)
+- [Converted Object IDs](https://algolia.com/doc/api-reference/api-methods/converted-object-ids/?language=ruby)
+- [Converted Filters](https://algolia.com/doc/api-reference/api-methods/converted-filters/?language=ruby)
+- [Viewed Object IDs](https://algolia.com/doc/api-reference/api-methods/viewed-object-ids/?language=ruby)
+- [Viewed Filters](https://algolia.com/doc/api-reference/api-methods/viewed-filters/?language=ruby)
+
+
+
+
 ### MultiClusters
 
 - [Assign or Move userID](https://algolia.com/doc/api-reference/api-methods/assign-user-id/?language=ruby)

data/lib/algolia/client.rb

@@ -143,6 +143,18 @@ module Algolia
       post(Protocol.multiple_queries_uri(strategy), requests.to_json, :search, request_options)
     end
 
+    #
+    # Get objects by objectID across multiple indexes
+    #
+    # @param requests [
+    #         { "indexName" => index_name_1, "objectID" => "obj1" },
+    #         { "indexName" => index_name_2, "objectID" => "obj2" }
+    #     ]
+    #
+    def multiple_get_objects(requests, request_options = {})
+      post(Protocol.objects_uri, {:requests => requests}.to_json, :search, request_options)
+    end
+
     #
     # List all existing indexes
     # return an Answer object with answer in the form
@@ -491,9 +503,17 @@ module Algolia
       end
     end
 
+    def get_personalization_strategy(request_options = {})
+      get(Protocol.personalization_strategy_uri, :read, request_options)
+    end
+
+    def set_personalization_strategy(strategy, request_options = {})
+      post(Protocol.personalization_strategy_uri, strategy.to_json, :write, request_options)
+    end
+
     #
     # Multicluster management
-	#
+    #
     def list_clusters(request_options = {})
       get(Protocol.clusters_uri, :read, request_options)
     end
@@ -754,6 +774,14 @@ module Algolia
     Algolia.client.multiple_queries(queries, options, strategy)
   end
 
+  #
+  # This method allows to get objects (records) via objectID across
+  # multiple indexes with one API call
+  #
+  def Algolia.multiple_get_objects(requests, request_options = {})
+    Algolia.client.multiple_get_objects(requests, request_options)
+  end
+
   #
   # List all existing indexes
   # return an Answer object with answer in the form

data/lib/algolia/index.rb

@@ -1020,7 +1020,7 @@ module Algolia
       res = []
       page = 0
       loop do
-        curr = search_synonyms('', { :hits_per_page => hits_per_page, :page => page }, request_options)['hits']
+        curr = search_synonyms('', { :hitsPerPage => hits_per_page, :page => page }, request_options)['hits']
         curr.each do |synonym|
           res << synonym
           yield synonym if block_given?

data/lib/algolia/protocol.rb

@@ -85,7 +85,7 @@ module Algolia
 
     def Protocol.partial_object_uri(index, object_id, create_if_not_exits = true)
       params = create_if_not_exits ? '' : '?createIfNotExists=false'
-      "#{index_uri(index)}/#{CGI.escape(object_id)}/partial#{params}"
+      "#{index_uri(index)}/#{CGI.escape(object_id.to_s)}/partial#{params}"
     end
 
     def Protocol.settings_uri(index, params = {})
@@ -128,7 +128,7 @@ module Algolia
     end
 
     def Protocol.synonym_uri(index, object_id)
-      "#{synonyms_uri(index)}/#{CGI.escape(object_id)}"
+      "#{synonyms_uri(index)}/#{CGI.escape(object_id.to_s)}"
     end
 
     def Protocol.search_synonyms_uri(index)
@@ -148,7 +148,7 @@ module Algolia
     end
 
     def Protocol.rule_uri(index, object_id)
-      "#{rules_uri(index)}/#{CGI.escape(object_id)}"
+      "#{rules_uri(index)}/#{CGI.escape(object_id.to_s)}"
     end
 
     def Protocol.search_rules_uri(index)
@@ -167,6 +167,10 @@ module Algolia
       "#{index_uri(index)}/deleteByQuery"
     end
 
+    def Protocol.personalization_strategy_uri
+      "/1/recommendation/personalization/strategy"
+    end
+
     def Protocol.clusters_uri
       "/#{VERSION}/clusters"
     end

data/lib/algolia/version.rb

@@ -1,3 +1,3 @@
 module Algolia
-  VERSION = "1.24.0"
+  VERSION = "1.25.0"
 end

data/lib/algoliasearch.rb

@@ -22,4 +22,5 @@ $:.unshift(cwd.to_s) unless $:.include?(cwd.to_s) || $:.include?(cwd.expand_path
 
 require 'algolia/index'
 require 'algolia/analytics'
+require 'algolia/insights'
 require 'algolia/account_client'

data/spec/client_spec.rb

@@ -579,6 +579,28 @@ describe 'Client' do
     res["results"][0]["hits"].length.should eq(1)
   end
 
+  it "should get multiple objectIDs" do
+    index_name_1 = safe_index_name("àlgol?a-multi")
+    index_1 = Algolia::Index.new(index_name_1)
+    index_1.save_object!({:objectID => "obj1-multi-get", :name => 'test'})
+
+    index_name_2 = safe_index_name("àlgol?a-multi")
+    index_2 = Algolia::Index.new(index_name_2)
+    index_2.save_object!({:objectID => "obj2-multi-get", :name => 'another index'})
+
+    requests = [
+        { "indexName" => index_name_1, "objectID" => "obj1-multi-get" },
+        { "indexName" => index_name_2, "objectID" => "obj2-multi-get" }
+    ]
+
+    response = Algolia.multiple_get_objects(requests)
+
+    response['results'].count.should eq(2)
+
+    index_1.delete_index rescue "not fatal"
+    index_2.delete_index rescue "not fatal"
+  end
+
   it "should throw if the index_name is missing in multiple_queries" do
     expect { Algolia.multiple_queries([{"query" => ""}]) }.to raise_error(ArgumentError)
   end
@@ -1147,6 +1169,20 @@ describe 'Client' do
     synonyms_search.size.should eq(2)
   end
 
+  it 'should test synonyms Export Query' do
+    @index.batch_synonyms! [
+      { :objectID => 'city', :type => 'synonym', :synonyms => ['San Francisco', 'SF'] },
+      { :objectID => 'us', :type => 'synonym', :synonyms => ['US', 'USA', 'Untied States of America'] },
+      { :objectID => 'ie', :type => 'synonym', :synonyms => ['IE', 'IRL', 'Ireland'] },
+      { :objectID => 'street', :type => 'altCorrection1', :word => 'street', :corrections => ['st'] }
+    ]
+
+    expect(@index).to receive(:search_synonyms).and_call_original.at_least(4)
+    @index.export_synonyms(1)
+
+    @index.clear_synonyms!
+  end
+
   it 'should test Query Rules' do
     rule_1 = {
       :objectID => '42',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch
 version: !ruby/object:Gem::Version
-  version: 1.24.0
+  version: 1.25.0
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-28 00:00:00.000000000 Z
+date: 2018-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -145,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: A simple Ruby client for the algolia.com REST API