algoliasearch 1.22.0 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 431002a3ec233966b7b7a0507662292938fd09cdbb62d1279d538d2da761ee6f
-  data.tar.gz: 6988bad4c248073ceee35d8ff9c447aeeb97c873e73b1ac41b4ab9b65099fd8c
+  metadata.gz: 7aec9582dfb81fdce4070cf4c30819075b2bc14e92ca1fa8574877533491904e
+  data.tar.gz: bf648a4405d74d8d9ef94cd2f52566d1ad77ce65ef2012c766649c60de94cafa
 SHA512:
-  metadata.gz: 6bdc28f6b84c96088f0cddf1f071c68994291d5365a612b771426052b327bad8ff11b47682bc9fe150f6128c2144e699632c6c606fd08d836a7da889824a61b7
-  data.tar.gz: 1af3a1305da6856ccd56caaeeee126170205d244ba3a0026c50308d250f31e899609f1aab36b33a4970e6eec41f25b5014e9aea9c079e622576fb83b644997a6
+  metadata.gz: c286583acd9d232476d6017c883dc93a193e327bceca68672718b224604fbb436ca832c4a9094def62a65e2a610d40ced96b165b383676707cde61d69b315cc7
+  data.tar.gz: 96f3ad4b2f8eadd48b5c080d18e39427b4782c583fdc6c027132ee6352ab521ae3fad83acb562ac22f2c05a31a205199579308651465e5ed582f0f73c573f799

data/.travis.yml

@@ -7,12 +7,12 @@ branches:
 rvm:
 - 1.8.7
 - 1.9.3
-- 2.0.0
-- 2.1.10
-- 2.2.5
-- 2.3.4
-- 2.4.1
-- 2.5.0
+- 2.0
+- 2.1
+- 2.2
+- 2.3
+- 2.4
+- 2.5
 - jruby
 - rbx-3
 

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [1.23.0](https://github.com/algolia/algoliasearch-client-ruby/releases/tag/1.23.0) (2018-06-19)
+
+* Feat(analytics): introduce new analytics class
+* Chore(rake): use unshift to keep compat with older ruby versions
+* Ruby version must be after client version in ua
+* Fix ua tests with new format
+* Rewrite ua
+* Feat(ua): add ruby version
+* Fix(syntax): this isn't php
+* Tests(mcm): use unique userid everytime
+* Tests(mcm): introduce auto_retry for more stable tests
+* Feat(client): expose waittask in the client (#302)
+* Fix(travis): always test on the latest patches (#295)
+
 ## [1.22.0](https://github.com/algolia/algoliasearch-client-ruby/releases/tag/1.22.0) (2018-05-30)
 
 * Rename license file (#297)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    algoliasearch (1.22.0)
+    algoliasearch (1.23.0)
       httpclient (~> 2.8, >= 2.8.3)
       json (>= 1.5.1)
 

data/README.md

@@ -90,7 +90,7 @@ index.add_objects(batch)
 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
-index.set_settings customRanking: ['desc(followers)']
+index.set_settings(customRanking: ['desc(followers)'])
 ```
 
 You can also configure the list of attributes you want to index by order of importance (most important first).
@@ -287,6 +287,17 @@ 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)
+
+
+
+
 ### MultiClusters
 
 - [Assign or Move userID](https://algolia.com/doc/api-reference/api-methods/assign-user-id/?language=ruby)

data/Rakefile

@@ -57,7 +57,7 @@ namespace :algolia do
     title = "## [%s](%s%s) (%s)\n\n" % [args[:version], GIT_TAG_URL, args[:version], last_commit_date]
     changes = changelog.each_line
                        .map { |line| (exceptions_regexp === line) ? nil : "* #{line.capitalize}" }
-                       .prepend(title)
+                       .unshift(title)
                        .append("\n\n")
                        .join
 

data/lib/algolia/client.rb

@@ -21,6 +21,7 @@ module Algolia
     DEFAULT_SEND_TIMEOUT    = 30
     DEFAULT_BATCH_TIMEOUT   = 120
     DEFAULT_SEARCH_TIMEOUT  = 5
+    DEFAULT_USER_AGENT      = ["Algolia for Ruby (#{::Algolia::VERSION})", "Ruby (#{RUBY_VERSION})"]
 
     def initialize(data = {})
       raise ArgumentError.new('No APPLICATION_ID provided, please set :application_id') if data[:application_id].nil?
@@ -41,7 +42,7 @@ module Algolia
         Protocol::HEADER_API_KEY => api_key,
         Protocol::HEADER_APP_ID  => application_id,
         'Content-Type'           => 'application/json; charset=utf-8',
-        'User-Agent'             => (data[:user_agent] || "Algolia for Ruby #{::Algolia::VERSION}")
+        'User-Agent'             => DEFAULT_USER_AGENT.push(data[:user_agent]).compact.join('; ')
       }
     end
 
@@ -59,6 +60,13 @@ module Algolia
       Index.new(name, self)
     end
 
+    #
+    # Initialize analytics helper
+    #
+    def init_analytics()
+      Analytics.new(self, { :headers => @headers })
+    end
+
     #
     # Allow to set custom headers
     #
@@ -155,7 +163,7 @@ module Algolia
     # @param request_options contains extra parameters to send with your query
     #
     def move_index(src_index, dst_index, request_options = {})
-      request = { 'operation' => 'move', 'destination' => dst_index };
+      request = { 'operation' => 'move', 'destination' => dst_index }
       post(Protocol.index_operation_uri(src_index), request.to_json, :write, request_options)
     end
 
@@ -168,7 +176,7 @@ module Algolia
     #
     def move_index!(src_index, dst_index, request_options = {})
       res = move_index(src_index, dst_index, request_options)
-      init_index(dst_index).wait_task(res['taskID'], WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY, request_options)
+      wait_task(dst_index, res['taskID'], WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY, request_options)
       res
     end
 
@@ -181,7 +189,7 @@ module Algolia
     # @param request_options contains extra parameters to send with your query
     #
     def copy_index(src_index, dst_index, scope = nil, request_options = {})
-      request = { 'operation' => 'copy', 'destination' => dst_index };
+      request = { 'operation' => 'copy', 'destination' => dst_index }
       request['scope'] = scope unless scope.nil?
       post(Protocol.index_operation_uri(src_index), request.to_json, :write, request_options)
     end
@@ -196,7 +204,7 @@ module Algolia
     #
     def copy_index!(src_index, dst_index, scope = nil, request_options = {})
       res = copy_index(src_index, dst_index, scope, request_options)
-      init_index(dst_index).wait_task(res['taskID'], WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY, request_options)
+      wait_task(dst_index, res['taskID'], WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY, request_options)
       res
     end
 
@@ -376,7 +384,38 @@ module Algolia
     def batch!(operations, request_options = {})
       res = batch(operations, request_options)
       res['taskID'].each do |index, taskID|
-        init_index(index).wait_task(taskID, WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY, request_options)
+        wait_task(index, taskID, WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY, request_options)
+      end
+    end
+
+    #
+    # Check the status of a task on the server.
+    # All server task are asynchronous and you can check the status of a task with this method.
+    #
+    # @param index_name the index name owning the taskID
+    # @param taskID the id of the task returned by server
+    # @param request_options contains extra parameters to send with your query
+    #
+    def get_task_status(index_name, taskID, request_options = {})
+      get(Protocol.task_uri(index_name, taskID), :read, request_options)['status']
+    end
+
+    #
+    # Wait the publication of a task on the server.
+    # All server task are asynchronous and you can check with this method that the task is published.
+    #
+    # @param index_name the index name owning the taskID
+    # @param taskID the id of the task returned by server
+    # @param time_before_retry the time in milliseconds before retry (default = 100ms)
+    # @param request_options contains extra parameters to send with your query
+    #
+    def wait_task(index_name, taskID, time_before_retry = WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY, request_options = {})
+      loop do
+        status = get_task_status(index_name, taskID, request_options)
+        if status == 'published'
+          return
+        end
+        sleep(time_before_retry.to_f / 1000)
       end
     end
 
@@ -861,6 +900,16 @@ module Algolia
     Algolia.client.batch!(requests, request_options)
   end
 
+  #
+  # Wait until task is completed by the engine
+  #
+  def Algolia.wait_task(index_name, taskID, time_before_retry = WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY, request_options = {})
+    Algolia.client.wait_task(index_name, taskID, time_before_retry, request_options)
+  end
+
+  def Algolia.get_task_status(index_name, taskID, request_options = {})
+    Algolia.client.get_task_status(index_name, taskID, request_options = {})
+  end
   #
   # Used mostly for testing. Lets you delete the api key global vars.
   #

data/lib/algolia/index.rb

@@ -272,7 +272,7 @@ module Algolia
     # @param request_options contains extra parameters to send with your query
     #
     def get_task_status(taskID, request_options = {})
-      client.get(Protocol.task_uri(name, taskID), :read, request_options)['status']
+      client.get_task_status(name, taskID, request_options)
     end
 
     #
@@ -284,13 +284,7 @@ module Algolia
     # @param request_options contains extra parameters to send with your query
     #
     def wait_task(taskID, time_before_retry = WAIT_TASK_DEFAULT_TIME_BEFORE_RETRY, request_options = {})
-      loop do
-        status = get_task_status(taskID, request_options)
-        if status == 'published'
-          return
-        end
-        sleep(time_before_retry.to_f / 1000)
-      end
+      client.wait_task(name, taskID, time_before_retry, request_options)
     end
 
     #

data/lib/algolia/protocol.rb

@@ -189,5 +189,15 @@ module Algolia
       "/#{VERSION}/clusters/mapping/search"
     end
 
+    def Protocol.ab_tests_uri(ab_test = nil)
+      ab_test = "/#{ab_test}" if ab_test
+
+      "/2/abtests" + ab_test.to_s
+    end
+
+    def Protocol.ab_tests_stop_uri(ab_test)
+      "/2/abtests/#{ab_test}/stop"
+    end
+
   end
 end

data/lib/algolia/version.rb

@@ -1,3 +1,3 @@
 module Algolia
-  VERSION = "1.22.0"
+  VERSION = "1.23.0"
 end

data/lib/algoliasearch.rb

@@ -21,3 +21,4 @@ cwd = Pathname(__FILE__).dirname
 $:.unshift(cwd.to_s) unless $:.include?(cwd.to_s) || $:.include?(cwd.expand_path.to_s)
 
 require 'algolia/index'
+require 'algolia/analytics'

data/spec/client_spec.rb

@@ -2,13 +2,6 @@
 require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
 require 'base64'
 
-# avoid concurrent access to the same index
-def safe_index_name(name)
-  return name if ENV['TRAVIS'].to_s != "true"
-  id = ENV['TRAVIS_JOB_NUMBER']
-  "TRAVIS_RUBY_#{name}-#{id}"
-end
-
 def is_include(array, attr, value)
   array.each do |elt|
     if elt[attr] == value
@@ -311,7 +304,7 @@ describe 'Client' do
     res = Algolia.list_indexes
     is_include(res['items'], 'name', safe_index_name('àlgol?a')).should eq(false)
     index.add_object!({ :name => "Robert" })
-    resAfter = Algolia.list_indexes;
+    resAfter = Algolia.list_indexes
     is_include(resAfter['items'], 'name', safe_index_name('àlgol?a')).should eq(true)
   end
 
@@ -1160,8 +1153,11 @@ describe 'Client' do
     end
 
     before(:each) do
-      @client = Algolia::Client.new :application_id => ENV['ALGOLIA_APPLICATION_ID'], :api_key => ENV['ALGOLIA_API_KEY'],
+      @client = Algolia::Client.new(
+        :application_id => ENV['ALGOLIA_APPLICATION_ID'],
+        :api_key => ENV['ALGOLIA_API_KEY'],
         :user_agent => 'test agent'
+      )
       @client.destroy # make sure the thread-local vars are reseted
     end
 
@@ -1170,7 +1166,7 @@ describe 'Client' do
         to_return(:status => 200, :body => '{}')
       @client.list_indexes
       expect(WebMock).to have_requested(:get, /https:\/\/.+-dsn.algolia(net\.com|\.net)\/1\/indexes/).
-        with(:headers => {'User-Agent' => 'test agent'})
+        with(:headers => { 'User-Agent' => "Algolia for Ruby (#{::Algolia::VERSION}); Ruby (#{RUBY_VERSION}); test agent" })
     end
 
     after(:all) do

data/spec/spec_helper.rb

@@ -20,6 +20,7 @@ require 'algoliasearch'
 require 'rspec'
 require 'webmock/rspec'
 require 'algolia/webmock'
+require 'time'
 
 raise 'missing ALGOLIA_APPLICATION_ID or ALGOLIA_API_KEY environment variables' if ENV['ALGOLIA_APPLICATION_ID'].nil? || ENV['ALGOLIA_API_KEY'].nil?
 Algolia.init :application_id => ENV['ALGOLIA_APPLICATION_ID'], :api_key => ENV['ALGOLIA_API_KEY']
@@ -35,3 +36,30 @@ RSpec.configure do |config|
     WebMock.disable!
   end
 end
+
+# avoid concurrent access to the same index
+def safe_index_name(name)
+  return name if ENV['TRAVIS'].to_s != "true"
+  id = ENV['TRAVIS_JOB_NUMBER']
+  "TRAVIS_RUBY_#{name}-#{id}"
+end
+
+def auto_retry(options = {})
+  return if !block_given?
+
+  max_retry = options[:max_retry] || 10
+  retry_count = 0
+
+  loop do
+    begin
+      return yield
+    rescue => e
+      retry_count += 1
+      if retry_count >= max_retry
+        raise e
+      else
+        sleep retry_count
+      end
+    end
+  end
+end

data/spec/stub_spec.rb

@@ -16,7 +16,7 @@ describe 'With a rate limited client' do
 
   it "should pass the right headers" do
     WebMock.stub_request(:post, %r{https://.*\.algolia\.(io|net)/1/indexes/friends/query}).
-      with(:headers => {'Content-Type'=>'application/json; charset=utf-8', 'User-Agent'=>"Algolia for Ruby #{Algolia::VERSION}", 'X-Algolia-Api-Key'=>ENV['ALGOLIA_API_KEY'], 'X-Algolia-Application-Id'=>ENV['ALGOLIA_APPLICATION_ID'], 'X-Forwarded-Api-Key'=>'ratelimitapikey', 'X-Forwarded-For'=>'1.2.3.4'}).
+      with(:headers => {'Content-Type'=>'application/json; charset=utf-8', 'User-Agent'=>"Algolia for Ruby (#{Algolia::VERSION}); Ruby (#{RUBY_VERSION})", 'X-Algolia-Api-Key'=>ENV['ALGOLIA_API_KEY'], 'X-Algolia-Application-Id'=>ENV['ALGOLIA_APPLICATION_ID'], 'X-Forwarded-Api-Key'=>'ratelimitapikey', 'X-Forwarded-For'=>'1.2.3.4'}).
       to_return(:status => 200, :body => "{ \"hits\": [], \"fakeAttribute\": 1 }", :headers => {})
     Algolia.enable_rate_limit_forward ENV['ALGOLIA_API_KEY'], "1.2.3.4", "ratelimitapikey"
     index = Algolia::Index.new("friends")
@@ -26,8 +26,8 @@ describe 'With a rate limited client' do
 
   it "should use original headers" do
     WebMock.stub_request(:post, %r{https://.*\.algolia\.(io|net)/1/indexes/friends/query}).
-      with(:headers => {'Content-Type'=>'application/json; charset=utf-8', 'User-Agent'=>"Algolia for Ruby #{Algolia::VERSION}", 'X-Algolia-Api-Key'=>ENV['ALGOLIA_API_KEY'], 'X-Algolia-Application-Id'=>ENV['ALGOLIA_APPLICATION_ID'] }).
-      to_return(:status => 200, :body => "{ \"hits\": [], \"fakeAttribute\": 2 }", :headers => {})    
+      with(:headers => {'Content-Type'=>'application/json; charset=utf-8', 'User-Agent'=>"Algolia for Ruby (#{Algolia::VERSION}); Ruby (#{RUBY_VERSION})", 'X-Algolia-Api-Key'=>ENV['ALGOLIA_API_KEY'], 'X-Algolia-Application-Id'=>ENV['ALGOLIA_APPLICATION_ID'] }).
+      to_return(:status => 200, :body => "{ \"hits\": [], \"fakeAttribute\": 2 }", :headers => {})
     Algolia.disable_rate_limit_forward
     index = Algolia::Index.new("friends")
     index.search('bar')['fakeAttribute'].should == 2
@@ -35,7 +35,7 @@ describe 'With a rate limited client' do
 
   it "should pass the right headers in the scope" do
     WebMock.stub_request(:post, %r{https://.*\.algolia\.(io|net)/1/indexes/friends/query}).
-      with(:headers => {'Content-Type'=>'application/json; charset=utf-8', 'User-Agent'=>"Algolia for Ruby #{Algolia::VERSION}", 'X-Algolia-Api-Key'=>ENV['ALGOLIA_API_KEY'], 'X-Algolia-Application-Id'=>ENV['ALGOLIA_APPLICATION_ID'], 'X-Forwarded-Api-Key'=>'ratelimitapikey', 'X-Forwarded-For'=>'1.2.3.4'}).
+      with(:headers => {'Content-Type'=>'application/json; charset=utf-8', 'User-Agent'=>"Algolia for Ruby (#{Algolia::VERSION}); Ruby (#{RUBY_VERSION})", 'X-Algolia-Api-Key'=>ENV['ALGOLIA_API_KEY'], 'X-Algolia-Application-Id'=>ENV['ALGOLIA_APPLICATION_ID'], 'X-Forwarded-Api-Key'=>'ratelimitapikey', 'X-Forwarded-For'=>'1.2.3.4'}).
       to_return(:status => 200, :body => "{ \"hits\": [], \"fakeAttribute\": 1 }", :headers => {})
     Algolia.with_rate_limits "1.2.3.4", "ratelimitapikey" do
       index = Algolia::Index.new("friends")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch
 version: !ruby/object:Gem::Version
-  version: 1.22.0
+  version: 1.23.0
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-30 00:00:00.000000000 Z
+date: 2018-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient