algoliasearch 1.23.2 → 1.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 898fdf039d30438b0bccedd74cef5c7a4b665d92c351f63ce779db7be8b29256
-  data.tar.gz: 7ccdd7ccd3ebddb4f7ab10aaa4ce2d403e55e1032e16f4864b6a3802857e2809
+  metadata.gz: 6656588b81231ae7bff38c4b5fc55bb36194233505bc493107dd3dd9526ae86d
+  data.tar.gz: c64bf649901a0ea9f5ac1997b55f9917cc719bf59a956ea0db7b751268838700
 SHA512:
-  metadata.gz: a1046362fa13b0646f799eeeb26bf1dbef4f0de91433a7a882aa59f65637b6501f488dbfca44b745fb4164e388c09f65185c100bdc4f792c46f095233cd433c8
-  data.tar.gz: e390cc59d90d8685801bd359b5c5a2721040f1a733ab54eb9202fa8f38995e7e43151f48d994deacaf22fdd4d004537c038b92c83872f9e4359d848260e6d1de
+  metadata.gz: c19eb997c9a08b5e1219296756d99c61f9d22af53d06c9589537418d94755e030def9ebebbf8357670b081e1229d77cc674c795fa33c953bb7dc6dde6d3f26c6
+  data.tar.gz: 025ba93db32d9d3b6aa478dd638207ad84ec97df681c5807dbfc858ff88a8e2e77ef637e7eaa2b02738d6b47859c5b923cf02d3a74afa1b917062e7b8ba757cd

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [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))
+* Feat(replace-all-methods): adds `replace_all_rules`, `replace_all_objects` and `replace_all_synonyms` to search index ([#323](https://github.com/algolia/algoliasearch-client-ruby/pull/323))
+* Feat(scoped-copy-methods): adds `copy_settings`, `copy_synonyms` and `copy_rules` to search client ([#322](https://github.com/algolia/algoliasearch-client-ruby/pull/322))
+
 ## [1.23.2](https://github.com/algolia/algoliasearch-client-ruby/releases/tag/1.23.2) (2018-06-19)
 
 * Fix(analytics): gem without new analytics class (#306)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    algoliasearch (1.23.1)
+    algoliasearch (1.23.2)
       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.2)
-    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)
+    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)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
-    docile (1.3.0)
+    docile (1.3.1)
     ethon (0.11.0)
       ffi (>= 1.3.0)
-    faraday (0.14.0)
+    faraday (0.15.3)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.12.2)
       faraday (>= 0.7.4, < 1.0)
-    ffi (1.9.23)
+    ffi (1.9.25)
     ffi2-generators (0.1.1)
     gh (0.15.1)
       addressable (~> 2.4.0)
@@ -36,12 +36,11 @@ GEM
       net-http-persistent (~> 2.9)
       net-http-pipeline
     hashdiff (0.3.7)
-    highline (1.6.21)
+    highline (1.7.10)
     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)
@@ -50,22 +49,20 @@ GEM
       json
       websocket (~> 1.0)
     rake (12.3.1)
-    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)
+    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)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
     rubysl (2.2.0)
       rubysl-abbrev (~> 2.0)
       rubysl-base64 (~> 2.0)
@@ -246,7 +243,7 @@ GEM
     rubysl-singleton (2.0.0)
     rubysl-socket (2.2.1)
       rubysl-fcntl (~> 2.0)
-    rubysl-stringio (2.2)
+    rubysl-stringio (2.3)
     rubysl-strscan (2.0.0)
     rubysl-sync (2.0.0)
     rubysl-syslog (2.1.0)
@@ -274,11 +271,11 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    term-ansicolor (1.2.2)
-      tins (~> 0.8)
-    thor (0.18.1)
-    tins (0.13.2)
-    travis (1.8.8)
+    term-ansicolor (1.7.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    tins (1.20.2)
+    travis (1.8.9)
       backports
       faraday (~> 0.9)
       faraday_middleware (~> 0.9, >= 0.9.1)
@@ -289,11 +286,11 @@ GEM
       typhoeus (~> 0.6, >= 0.6.8)
     typhoeus (0.8.0)
       ethon (>= 0.8.0)
-    webmock (3.3.0)
+    webmock (3.4.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
-    websocket (1.2.5)
+    websocket (1.2.8)
 
 PLATFORMS
   ruby
@@ -310,4 +307,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.16.2
+   1.17.1

data/README.md

@@ -173,7 +173,7 @@ var search = instantsearch({
   appId: 'YourApplicationID',
   apiKey: 'YourSearchOnlyAPIKey', // search only API key, no ADMIN key
   indexName: 'contacts',
-  urlSync: true,
+  routing: true,
   searchParameters: {
     hitsPerPage: 10
   }
@@ -209,10 +209,10 @@ search.start();
 
 ### Search
 
-- [Search an index](https://algolia.com/doc/api-reference/api-methods/search/?language=ruby)
+- [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)
-- [Browse an index](https://algolia.com/doc/api-reference/api-methods/browse/?language=ruby)
+- [Browse index](https://algolia.com/doc/api-reference/api-methods/browse/?language=ruby)
 
 
 
@@ -276,12 +276,12 @@ search.start();
 
 ### Query rules
 
-- [Save a single rule](https://algolia.com/doc/api-reference/api-methods/rules-save/?language=ruby)
-- [Batch save multiple rules](https://algolia.com/doc/api-reference/api-methods/rules-save-batch/?language=ruby)
-- [Get a rule](https://algolia.com/doc/api-reference/api-methods/rules-get/?language=ruby)
-- [Delete a single rule](https://algolia.com/doc/api-reference/api-methods/rules-delete/?language=ruby)
-- [Clear all rules](https://algolia.com/doc/api-reference/api-methods/rules-clear/?language=ruby)
-- [Search for rules](https://algolia.com/doc/api-reference/api-methods/rules-search/?language=ruby)
+- [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)
 
 
@@ -289,11 +289,11 @@ search.start();
 
 ### A/B Test
 
-- [Add an A/B test](https://algolia.com/doc/api-reference/api-methods/add-ab-test/?language=ruby)
-- [Get an A/B test](https://algolia.com/doc/api-reference/api-methods/get-ab-test/?language=ruby)
-- [List A/B tests](https://algolia.com/doc/api-reference/api-methods/get-ab-tests/?language=ruby)
-- [Stop an A/B test](https://algolia.com/doc/api-reference/api-methods/stop-ab-test/?language=ruby)
-- [Delete an A/B test](https://algolia.com/doc/api-reference/api-methods/delete-ab-test/?language=ruby)
+- [Add A/B test](https://algolia.com/doc/api-reference/api-methods/add-ab-test/?language=ruby)
+- [Get A/B test](https://algolia.com/doc/api-reference/api-methods/get-ab-test/?language=ruby)
+- [List A/B tests](https://algolia.com/doc/api-reference/api-methods/list-ab-tests/?language=ruby)
+- [Stop A/B test](https://algolia.com/doc/api-reference/api-methods/stop-ab-test/?language=ruby)
+- [Delete A/B test](https://algolia.com/doc/api-reference/api-methods/delete-ab-test/?language=ruby)
 
 
 

data/algoliasearch.gemspec

@@ -43,6 +43,7 @@ Gem::Specification.new do |s|
     "algoliasearch.gemspec",
     "contacts.json",
     "lib/algolia/analytics.rb",
+    "lib/algolia/account_client.rb",
     "lib/algolia/client.rb",
     "lib/algolia/error.rb",
     "lib/algolia/index.rb",
@@ -51,6 +52,7 @@ Gem::Specification.new do |s|
     "lib/algolia/webmock.rb",
     "lib/algoliasearch.rb",
     "resources/ca-bundle.crt",
+    "spec/account_client_spec.rb",
     "spec/client_spec.rb",
     "spec/mock_spec.rb",
     "spec/spec_helper.rb",

data/lib/algolia/account_client.rb

@@ -0,0 +1,99 @@
+require 'algolia/error'
+
+module Algolia
+  #
+  # A class which encapsulates the HTTPS communication with the Algolia
+  # API server for cross-app operations.
+  #
+  class AccountClient
+    class << self
+      #
+      # Copies settings, synonyms, rules and objects from the source index to the
+      # destination index. The replicas of the source index should not be copied.
+      #
+      # Throw an exception if the destination index already exists
+      # Throw an exception if the indices are on the same application
+      #
+      # @param source_index the source index object
+      # @param destination_index the destination index object
+      # @param request_options contains extra parameters to send with your query
+      #
+      def copy_index(source_index, destination_index, request_options = {})
+        raise AlgoliaError.new('The indexes are in the same application. Use Algolia::Client.copy_index instead.') if source_index.client.application_id == destination_index.client.application_id
+
+        begin
+          settings = destination_index.get_settings()
+        rescue AlgoliaError
+          # Destination index does not exists. We can proceed.
+        else
+          raise AlgoliaError.new("Destination index already exists. Please delete it before copying index across applications.")
+        end
+
+        responses = []
+
+        settings = source_index.get_settings()
+        responses << destination_index.set_settings(settings, {}, request_options)
+
+        synonyms = []
+        source_index.export_synonyms(100, request_options) do |synonym|
+          synonym.delete('_highlightResult')
+          synonyms << synonym
+        end
+
+        responses << destination_index.batch_synonyms(synonyms, false, false, request_options)
+
+        rules = []
+        source_index.export_rules(100, request_options) do |rule|
+          rule.delete('_highlightResult')
+          rules << rule
+        end
+        responses << destination_index.batch_rules(rules, false, false, request_options)
+
+        # Copy objects
+        responses = []
+        batch = []
+        batch_size = 1000
+        count = 0
+
+        source_index.browse()['hits'].each do |obj|
+          batch << obj
+          count += 1
+
+          if count == batch_size
+            responses << destination_index.save_objects(batch, request_options)
+            batch = []
+            count = 0
+          end
+        end
+
+        if batch.any?
+          responses << destination_index.save_objects(batch, request_options)
+        end
+
+        responses
+      end
+
+      #
+      # The method copy settings, synonyms, rules and objects from the source index
+      # to the destination index and wait end of indexing. The replicas of the
+      # source index should not be copied
+      #
+      # Throw an exception if the destination index already exists
+      # Throw an exception if the indices are on the same application
+      #
+      # @param source_index the source index object
+      # @param destination_index the destination index object
+      # @param request_options contains extra parameters to send with your query
+      #
+      def copy_index!(source_index, destination_index, request_options = {})
+        responses = self.copy_index(source_index, destination_index, request_options)
+
+        responses.each do |res|
+          destination_index.wait_task(res['taskID'], WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY, request_options)
+        end
+
+        responses
+      end
+    end
+  end
+end

data/lib/algolia/client.rb

@@ -208,6 +208,78 @@ module Algolia
       res
     end
 
+    #
+    # Copy an existing index settings.
+    #
+    # @param src_index the name of index to copy.
+    # @param dst_index the new index name that will contains a copy of srcIndexName's settings (destination's settings will be overriten if it already exist).
+    # @param request_options contains extra parameters to send with your query
+    #
+    def copy_settings(src_index, dst_index, request_options = {})
+      copy_index(src_index, dst_index, ['settings'], request_options)
+    end
+
+    #
+    # Copy an existing index settings and wait until the copy has been processed.
+    #
+    # @param src_index the name of index to copy.
+    # @param dst_index the new index name that will contains a copy of srcIndexName settings (destination settings will be overriten if it already exist).
+    # @param request_options contains extra parameters to send with your query
+    #
+    def copy_settings!(src_index, dst_index, request_options = {})
+      res = copy_settings(src_index, dst_index, request_options)
+      wait_task(dst_index, res['taskID'], WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY, request_options)
+      res
+    end
+
+    #
+    # Copy an existing index synonyms.
+    #
+    # @param src_index the name of index to copy.
+    # @param dst_index the new index name that will contains a copy of srcIndexName's synonyms (destination's synonyms will be overriten if it already exist).
+    # @param request_options contains extra parameters to send with your query
+    #
+    def copy_synonyms(src_index, dst_index, request_options = {})
+      copy_index(src_index, dst_index, ['synonyms'], request_options)
+    end
+
+    #
+    # Copy an existing index synonyms and wait until the copy has been processed.
+    #
+    # @param src_index the name of index to copy.
+    # @param dst_index the new index name that will contains a copy of srcIndexName synonyms (destination synonyms will be overriten if it already exist).
+    # @param request_options contains extra parameters to send with your query
+    #
+    def copy_synonyms!(src_index, dst_index, request_options = {})
+      res = copy_synonyms(src_index, dst_index, request_options)
+      wait_task(dst_index, res['taskID'], WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY, request_options)
+      res
+    end
+
+    #
+    # Copy an existing index rules.
+    #
+    # @param src_index the name of index to copy.
+    # @param dst_index the new index name that will contains a copy of srcIndexName's rules (destination's rules will be overriten if it already exist).
+    # @param request_options contains extra parameters to send with your query
+    #
+    def copy_rules(src_index, dst_index, request_options = {})
+      copy_index(src_index, dst_index, ['rules'], request_options)
+    end
+
+    #
+    # Copy an existing index rules and wait until the copy has been processed.
+    #
+    # @param src_index the name of index to copy.
+    # @param dst_index the new index name that will contains a copy of srcIndexName rules (destination rules will be overriten if it already exist).
+    # @param request_options contains extra parameters to send with your query
+    #
+    def copy_rules!(src_index, dst_index, request_options = {})
+      res = copy_rules(src_index, dst_index, request_options)
+      wait_task(dst_index, res['taskID'], WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY, request_options)
+      res
+    end
+
     #
     # Delete an index
     # @param name the name of the index to delete
@@ -740,6 +812,72 @@ module Algolia
     Algolia.client.copy_index!(src_index, dst_index, scope, request_options)
   end
 
+  #
+  # Copy an existing index settings.
+  #
+  # @param src_index the name of index to copy.
+  # @param dst_index the new index name that will contains a copy of src_index_name settings (destination settings will be overriten if it already exist).
+  # @param request_options contains extra parameters to send with your query
+  #
+  def Algolia.copy_settings(src_index, dst_index, request_options = {})
+    Algolia.client.copy_settings(src_index, dst_index, request_options)
+  end
+
+  #
+  # Copy an existing index settings and wait until the copy has been processed.
+  #
+  # @param src_index the name of index to copy.
+  # @param dst_index the new index name that will contains a copy of src_index_name settings (destination settings will be overriten if it already exist).
+  # @param request_options contains extra parameters to send with your query
+  #
+  def Algolia.copy_settings!(src_index, dst_index, request_options = {})
+    Algolia.client.copy_settings!(src_index, dst_index, request_options)
+  end
+
+  #
+  # Copy an existing index synonyms.
+  #
+  # @param src_index the name of index to copy.
+  # @param dst_index the new index name that will contains a copy of src_index_name synonyms (destination synonyms will be overriten if it already exist).
+  # @param request_options contains extra parameters to send with your query
+  #
+  def Algolia.copy_synonyms(src_index, dst_index, request_options = {})
+    Algolia.client.copy_synonyms(src_index, dst_index, request_options)
+  end
+
+  #
+  # Copy an existing index synonyms and wait until the copy has been processed.
+  #
+  # @param src_index the name of index to copy.
+  # @param dst_index the new index name that will contains a copy of src_index_name synonyms (destination synonyms will be overriten if it already exist).
+  # @param request_options contains extra parameters to send with your query
+  #
+  def Algolia.copy_synonyms!(src_index, dst_index, request_options = {})
+    Algolia.client.copy_synonyms!(src_index, dst_index, request_options)
+  end
+
+  #
+  # Copy an existing index rules.
+  #
+  # @param src_index the name of index to copy.
+  # @param dst_index the new index name that will contains a copy of src_index_name rules (destination rules will be overriten if it already exist).
+  # @param request_options contains extra parameters to send with your query
+  #
+  def Algolia.copy_rules(src_index, dst_index, request_options = {})
+    Algolia.client.copy_rules(src_index, dst_index, request_options)
+  end
+
+  #
+  # Copy an existing index rules and wait until the copy has been processed.
+  #
+  # @param src_index the name of index to copy.
+  # @param dst_index the new index name that will contains a copy of src_index_name rules (destination rules will be overriten if it already exist).
+  # @param request_options contains extra parameters to send with your query
+  #
+  def Algolia.copy_rules!(src_index, dst_index, request_options = {})
+    Algolia.client.copy_rules!(src_index, dst_index, request_options)
+  end
+
   #
   # Delete an index
   #

data/lib/algolia/index.rb

@@ -333,6 +333,76 @@ module Algolia
       res
     end
 
+    #
+    # Override the current objects by the given array of objects and wait end of indexing. Settings,
+    # synonyms and query rules are untouched. The objects are replaced without any downtime.
+    #
+    # @param objects the array of objects to save
+    # @param request_options contains extra parameters to send with your query
+    #
+    def replace_all_objects(objects, request_options = {})
+      safe = request_options[:safe] || request_options['safe'] || false
+      request_options.delete(:safe)
+      request_options.delete('safe')
+
+      tmp_index = @client.init_index(@name + '_tmp_' + rand(10000000).to_s)
+
+      responses = []
+
+      scope = ['settings', 'synonyms', 'rules']
+      res = @client.copy_index(@name, tmp_index.name, scope, request_options)
+      responses << res
+
+      if safe
+        wait_task(res['taskID'], WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY, request_options)
+      end
+
+      batch = []
+      batch_size = 1000
+      count = 0
+
+      objects.each do |object|
+        batch << object
+        count += 1
+        if count == batch_size
+          res = tmp_index.add_objects(batch, request_options)
+          responses << res
+          batch = []
+          count = 0
+        end
+      end
+
+      if batch.any?
+        res = tmp_index.add_objects(batch, request_options)
+        responses << res
+      end
+
+      if safe
+        responses.each do |res|
+          tmp_index.wait_task(res['taskID'], WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY, request_options)
+        end
+      end
+
+      res = @client.move_index(tmp_index.name, @name, request_options)
+      responses << res
+
+      if safe
+        wait_task(res['taskID'], WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY, request_options)
+      end
+
+      responses
+    end
+
+    #
+    # Override the current objects by the given array of objects and wait end of indexing
+    #
+    # @param objects the array of objects to save
+    # @param request_options contains extra parameters to send with your query
+    #
+    def replace_all_objects!(objects, request_options = {})
+      replace_all_objects(objects, request_options.merge(:safe => true))
+    end
+
     #
     # Update partially an object (only update attributes passed in argument)
     #
@@ -915,6 +985,29 @@ module Algolia
       res
     end
 
+    #
+    # Replace synonyms in the index by the given array of synonyms
+    #
+    # @param synonyms the array of synonyms to add
+    # @param request_options contains extra parameters to send with your query
+    #
+    def replace_all_synonyms(synonyms, request_options = {})
+      forward_to_replicas = request_options[:forwardToReplicas] || request_options['forwardToReplicas'] || false
+      batch_synonyms(synonyms, forward_to_replicas, true, request_options)
+    end
+
+    #
+    # Replace synonyms in the index by the given array of synonyms and wait the end of indexing
+    #
+    # @param synonyms the array of synonyms to add
+    # @param request_options contains extra parameters to send with your query
+    #
+    def replace_all_synonyms!(synonyms, request_options = {})
+      res = replace_all_synonyms(synonyms, request_options)
+      wait_task(res['taskID'], WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY, request_options)
+      res
+    end
+
     #
     # Export the full list of synonyms
     # Accepts an optional block to which it will pass each synonym
@@ -1069,6 +1162,29 @@ module Algolia
       return res
     end
 
+    #
+    # Replace rules in the index by the given array of rules
+    #
+    # @param rules the array of rules to add
+    # @param request_options contains extra parameters to send with your query
+    #
+    def replace_all_rules(rules, request_options = {})
+      forward_to_replicas = request_options[:forwardToReplicas] || request_options['forwardToReplicas'] || false
+      batch_rules(rules, forward_to_replicas, true, request_options)
+    end
+
+    #
+    # Replace rules in the index by the given array of rules and wait the end of indexing
+    #
+    # @param rules the array of rules to add
+    # @param request_options contains extra parameters to send with your query
+    #
+    def replace_all_rules!(rules, request_options = {})
+      res = replace_all_rules(rules, request_options)
+      wait_task(res['taskID'], WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY, request_options)
+      res
+    end
+
     #
     # Export the full list of rules
     # Accepts an optional block to which it will pass each rule

data/lib/algolia/version.rb

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

data/lib/algoliasearch.rb

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

data/spec/account_client_spec.rb

@@ -0,0 +1,92 @@
+# encoding: UTF-8
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+require 'securerandom'
+
+describe 'Account client' do
+  before(:all) do
+    client_1 = Algolia::Client.new({
+                                       :application_id => ENV['ALGOLIA_APPLICATION_ID_1'],
+                                       :api_key => ENV['ALGOLIA_ADMIN_KEY_1']
+                                   })
+
+    @index_1 = client_1.init_index(index_name('account_client_1'))
+
+    client_2 = Algolia::Client.new({
+                                       :application_id => ENV['ALGOLIA_APPLICATION_ID_1'],
+                                       :api_key => ENV['ALGOLIA_ADMIN_KEY_1']
+                                   })
+
+    @index_2 = client_2.init_index(index_name('account_client_2'))
+
+    client_3 = Algolia::Client.new({
+                                       :application_id => ENV['ALGOLIA_APPLICATION_ID_2'],
+                                       :api_key => ENV['ALGOLIA_ADMIN_KEY_2']
+                                   })
+
+    @index_3 = client_3.init_index(index_name('account_client_3'))
+
+    @index_1.delete_index rescue 'not fatal'
+    @index_2.delete_index rescue 'not fatal'
+    @index_3.delete_index rescue 'not fatal'
+  end
+
+  after(:all) do
+    @index_1.delete_index rescue 'not fatal'
+    @index_2.delete_index rescue 'not fatal'
+    @index_3.delete_index rescue 'not fatal'
+  end
+
+  it 'should not allow operations in the same application' do
+    expect {
+      Algolia::AccountClient.copy_index!(@index_1, @index_2)
+    }.to raise_exception(
+             Algolia::AlgoliaError,
+             'The indexes are in the same application. Use Algolia::Client.copy_index instead.'
+         )
+  end
+
+  it 'should perform a cross app copy index and assert that destination must not exist' do
+
+    @index_1.save_objects! ([
+        {:objectID => 'one'},
+    ])
+
+    @index_1.batch_rules! ([
+        {
+            :objectID => 'one',
+            :condition => {:pattern => 'test', :anchoring => 'contains'},
+            :consequence => {:params => {:query => 'this is better'}}
+        }
+    ])
+
+    @index_1.batch_synonyms! ([
+        {:objectID => 'one', :type => 'synonym', :synonyms => ['San Francisco', 'SF']}
+    ])
+
+    @index_1.set_settings! ({:searchableAttributes => ['objectID']})
+
+    Algolia::AccountClient.copy_index!(@index_1, @index_3)
+
+    res = @index_3.search('');
+    res['nbHits'].should eq(1)
+    res['hits'][0]['objectID'].should eq('one')
+
+    res = @index_3.search_rules('')['hits']
+    res.size.should eq(1)
+    res[0]['objectID'].should eq('one')
+
+    res = @index_3.search_synonyms('')['hits']
+    res.size.should eq(1)
+    res[0]['objectID'].should eq('one')
+
+    @index_3.get_settings['searchableAttributes'].should eq(['objectID'])
+
+    expect {
+      Algolia::AccountClient.copy_index!(@index_1, @index_3)
+    }.to raise_exception(
+             Algolia::AlgoliaError,
+             'Destination index already exists. Please delete it before copying index across applications.'
+         )
+  end
+end
+

data/spec/client_spec.rb

@@ -249,6 +249,17 @@ describe 'Client' do
     res["hits"].length.should eq(2)
   end
 
+  it "should replace all objects" do
+    @index.save_objects!([{:objectID => '1'}, {:objectID => '2'}])
+    @index.replace_all_objects!([{'color' => 'black'}, {:objectID => '4', 'color' => 'green'}])
+
+    res = @index.search('')
+    res["hits"].length.should eq(2)
+    res = @index.search('black')
+    res["hits"][0]['color'].should eq('black')
+    @index.get_object('4')['color'].should eq('green')
+  end
+
   it "should throw an exception if invalid argument" do
     expect { @index.add_object!([ {:name => "test"} ]) }.to raise_error(ArgumentError)
     expect { @index.add_objects!([ [ {:name => "test"} ] ]) }.to raise_error(ArgumentError)
@@ -262,6 +273,10 @@ describe 'Client' do
   end
 
   it "should be thread safe" do
+    @index.clear!
+    @index.add_object!({ :name => "John Doe", :email => "john@doe.org" })
+    @index.add_object!({ :name => "John Doe", :email => "john@doe.org" })
+
     threads = []
     64.times do
       t = Thread.new do
@@ -430,6 +445,66 @@ describe 'Client' do
     index.delete_index!
   end
 
+  it "should copy only settings" do
+    index = Algolia::Index.new(safe_index_name("àlgol?à"))
+    begin
+      @index.clear_index
+      Algolia.delete_index index.name
+    rescue
+    end
+
+    res = @index.set_settings!({
+                                   'searchableAttributes' => ['one'],
+                               })
+
+    @index.wait_task(res['taskID'])
+    Algolia.copy_settings!(@index.name, index.name)
+    @index.delete_index!
+
+    index.get_settings['searchableAttributes'].should eq(['one'])
+    index.delete_index!
+  end
+
+  it "should copy only synonyms" do
+    index = Algolia::Index.new(safe_index_name("àlgol?à"))
+    begin
+      @index.clear_index
+      Algolia.delete_index index.name
+    rescue
+    end
+
+    @index.save_synonym!('foo', {
+        :objectID => 'foo', :synonyms => ['car', 'vehicle', 'auto'], :type => 'synonym',
+    })
+
+    Algolia.copy_synonyms!(@index.name, index.name)
+    @index.delete_index!
+
+    index.get_synonym('foo')['objectID'].should eq('foo')
+    index.delete_index!
+  end
+
+  it "should copy only rules" do
+    index = Algolia::Index.new(safe_index_name("àlgol?à"))
+    begin
+      @index.clear_index
+      Algolia.delete_index index.name
+    rescue
+    end
+
+    @index.save_rule!('bar', {
+        :objectID => 'bar',
+        :condition => {:pattern => 'test', :anchoring => 'contains'},
+        :consequence => {:params => {:query => 'this is better'}}
+    })
+
+    Algolia.copy_rules!(@index.name, index.name)
+    @index.delete_index!
+
+    index.get_rule('bar')['objectID'].should eq('bar')
+    index.delete_index!
+  end
+
   it "should copy parts of the index only" do
     index = Algolia::Index.new(safe_index_name("àlgol?à"))
     begin
@@ -1056,6 +1131,22 @@ describe 'Client' do
     @index.search_synonyms('')['nbHits'].should eq(0)
   end
 
+  it "should replace all synonyms" do
+    @index.batch_synonyms! ([
+        {:objectID => '1', :type => 'synonym', :synonyms => ['San Francisco', 'SF']},
+        {:objectID => '2', :type => 'altCorrection1', :word => 'foo', :corrections => ['st']}
+    ])
+
+    @index.replace_all_synonyms! ([
+        {:objectID => '3', :type => 'synonym', :synonyms => ['San Francisco', 'SF']},
+        {:objectID => '4', :type => 'altCorrection1', :word => 'bar', :corrections => ['st']}
+    ])
+
+    synonym = @index.get_synonym('4')['objectID'].should eq('4')
+    synonyms_search = @index.search_synonyms('')['hits']
+    synonyms_search.size.should eq(2)
+  end
+
   it 'should test Query Rules' do
     rule_1 = {
       :objectID => '42',
@@ -1100,6 +1191,29 @@ describe 'Client' do
     @index.search_rules('')['nbHits'].should eq(0)
   end
 
+  it "should replace all rules" do
+    rule_1 = {
+        :objectID => '1',
+        :condition => {:pattern => 'test', :anchoring => 'contains'},
+        :consequence => {:params => {:query => 'this is better'}}
+    }
+    rule_2 = {
+        :objectID => '2',
+        :condition => {:pattern => 'Pura', :anchoring => 'contains'},
+        :consequence => {:params => {:query => 'Pura Vida'}}
+    }
+
+    @index.batch_rules! [rule_1, rule_2]
+
+    rule_1[:objectID] = '3'
+    rule_2[:objectID] = '4'
+    @index.replace_all_rules!([rule_1, rule_2])
+
+    @index.get_rule('4')['objectID'].should eq('4')
+    rules_search = @index.search_rules('')['hits']
+    rules_search.size.should eq(2)
+  end
+
   it 'should not save a query rule with an empty objectID' do
     rule = {
       :objectID => '',

data/spec/spec_helper.rb

@@ -44,6 +44,15 @@ def safe_index_name(name)
   "TRAVIS_RUBY_#{name}-#{id}"
 end
 
+# avoid concurrent access to the same index and follows the CTS standards.
+def index_name(name)
+  date = DateTime.now.strftime('%Y-%m-%d_%H:%M:%S')
+
+  instance = ENV['TRAVIS'].to_s == 'true' ? ENV['TRAVIS_JOB_NUMBER'] : 'unknown'
+
+  'ruby_%s_%s_%s' % [date, instance, name]
+end
+
 def auto_retry(options = {})
   return if !block_given?
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch
 version: !ruby/object:Gem::Version
-  version: 1.23.2
+  version: 1.24.0
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-19 00:00:00.000000000 Z
+date: 2018-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -105,6 +105,7 @@ files:
 - Rakefile
 - algoliasearch.gemspec
 - contacts.json
+- lib/algolia/account_client.rb
 - lib/algolia/analytics.rb
 - lib/algolia/client.rb
 - lib/algolia/error.rb
@@ -114,6 +115,7 @@ files:
 - lib/algolia/webmock.rb
 - lib/algoliasearch.rb
 - resources/ca-bundle.crt
+- spec/account_client_spec.rb
 - spec/client_spec.rb
 - spec/mock_spec.rb
 - spec/spec_helper.rb
@@ -143,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: A simple Ruby client for the algolia.com REST API