algoliasearch 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4329565282764c298bfea3ca19ae79b950a3221
-  data.tar.gz: cec3814f851200497f6c725eb6828da43c6c42bd
+  metadata.gz: 6815aa98febd670b9ee776ed86899d1b1f813c4b
+  data.tar.gz: f5a69438b609bcbe2e70b04fb53c60c51ad007c9
 SHA512:
-  metadata.gz: 478083554dec799684b0cc34096063ae127aad3d42ca8e08a46a7b7b356819f34c487aa3776f9ac9aa5585cd0cc2cb160baadc0a7b516da6ce00b000f1b0947f
-  data.tar.gz: f0f4e50441de3d2047f07987fedabbf3ee9a22a2ed6db8ba62a55f2468fb37bd258d526ccd2bd8beed03645d1dde20400d33dd328554110e362da8560a5a94db
+  metadata.gz: 5226f954185110c75e6d6c12081139a574f9e1f6fd3579d53d92e32d48e959dde1dd2da8a4407fe0980a2b6b44852e97b0ba6eaee5ab1517ea9dbf433ed0601d
+  data.tar.gz: c2fa093f6517079ad36aba007bdcf59eb0f6f91209160aaa6c4ebc72a795c4ac44d30f47a45afb0fb41942623f262a0ddaeadaa4e789345daa503b609ee52f4c

data/ChangeLog

@@ -1,9 +1,18 @@
 CHANGELOG
 
-2014-11-29  1.3.0
+2014-11-29  1.3.1
+      * Fixed wrong deployed version (1.3.0 was based on 1.2.13 instead of 1.2.14)
 
+2014-11-29  1.3.0
       * Use algolia.net domain instead of algolia.io
 
+2014-11-10 1.2.14
+      * Force the underlying httpclient dependency to be >= 2.4 in the gemspec as well
+      * Ability to force the SSL version
+
+2014-10-22 1.2.13
+      * Fix the loop on hosts to retry when the http code is different than 200, 201, 400, 403, 404
+
 2014-10-08  1.2.12
 
       * Upgrade to httpclient 2.4

data/algoliasearch.gemspec

@@ -50,17 +50,17 @@ Gem::Specification.new do |s|
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<httpclient>, ["~> 2.3"])
+      s.add_runtime_dependency(%q<httpclient>, ["~> 2.4"])
       s.add_runtime_dependency(%q<json>, [">= 1.5.1"])
       s.add_development_dependency "travis"
       s.add_development_dependency "rake"
       s.add_development_dependency "rdoc"
     else
-      s.add_dependency(%q<httpclient>, ["~> 2.3"])
+      s.add_dependency(%q<httpclient>, ["~> 2.4"])
       s.add_dependency(%q<json>, [">= 1.5.1"])
     end
   else
-    s.add_dependency(%q<httpclient>, ["~> 2.3"])
+    s.add_dependency(%q<httpclient>, ["~> 2.4"])
     s.add_dependency(%q<json>, [">= 1.5.1"])
   end
 end

data/lib/algolia/client.rb

@@ -10,11 +10,12 @@ module Algolia
   # A class which encapsulates the HTTPS communication with the Algolia
   # API server. Uses the HTTPClient library for low-level HTTP communication.
   class Client
-    attr_reader :ssl, :hosts, :application_id, :api_key, :headers, :connect_timeout, :send_timeout, :receive_timeout, :search_timeout
+    attr_reader :ssl, :ssl_version, :hosts, :application_id, :api_key, :headers, :connect_timeout, :send_timeout, :receive_timeout, :search_timeout
 
 
     def initialize(data = {})
       @ssl             = data[:ssl].nil? ? true : data[:ssl]
+      @ssl_version     = data[:ssl_version].nil? ? nil : data[:ssl_version]
       @application_id  = data[:application_id]
       @api_key         = data[:api_key]
       @hosts           = (data[:hosts] || 1.upto(3).map { |i| "#{@application_id}-#{i}.algolia.net" }).shuffle
@@ -40,7 +41,7 @@ module Algolia
         begin
           return perform_request(host[:session], host[:base_url] + uri, method, data)
         rescue AlgoliaProtocolError => e
-          raise if e.code != Protocol::ERROR_TIMEOUT and e.code != Protocol::ERROR_UNAVAILABLE
+          raise if e.code == Protocol::ERROR_BAD_REQUEST or e.code == Protocol::ERROR_FORBIDDEN or e.code == Protocol::ERROR_NOT_FOUND
           exceptions << e
         rescue => e
           exceptions << e
@@ -76,9 +77,11 @@ module Algolia
     def thread_local_hosts(forced_timeout)
       Thread.current[:algolia_hosts] ||= {}
       Thread.current[:algolia_hosts][forced_timeout.to_s] ||= hosts.map do |host|
+        client = HTTPClient.new
+        client.ssl_config.ssl_version = @ssl_version if @ssl && @ssl_version        
         hinfo = {
           :base_url => "http#{@ssl ? 's' : ''}://#{host}",
-          :session => HTTPClient.new
+          :session => client
         }
         hinfo[:session].transparent_gzip_decompression = true
         hinfo[:session].connect_timeout = @connect_timeout if @connect_timeout

data/lib/algolia/index.rb

@@ -232,27 +232,34 @@ module Algolia
     # 
     # @param obj the object attributes to override
     # @param objectID the associated objectID, if nil 'obj' must contain an 'objectID' key
+    # @param create_if_not_exits a boolean, if true creates the object if this one doesn't exist
     #
-    def partial_update_object(obj, objectID = nil)
-      Algolia.client.post(Protocol.partial_object_uri(name, get_objectID(obj, objectID)), obj.to_json)
+    def partial_update_object(obj, objectID = nil, create_if_not_exits = true)
+      Algolia.client.post(Protocol.partial_object_uri(name, get_objectID(obj, objectID), create_if_not_exits), obj.to_json)
     end
     
     #
     # Partially Override the content of several objects
     # 
     # @param objs an array of objects to update (each object must contains a objectID attribute)
+    # @param create_if_not_exits a boolean, if true create the objects if they don't exist
     #
-    def partial_update_objects(objs)
-      batch build_batch('partialUpdateObject', objs, true)
+    def partial_update_objects(objs, create_if_not_exits = true)
+      if create_if_not_exits
+        batch build_batch('partialUpdateObject', objs, true)
+      else
+        batch build_batch('partialUpdateObjectNoCreate', objs, true)
+      end
     end
 
     #
     # Partially Override the content of several objects and wait end of indexing
     # 
     # @param objs an array of objects to update (each object must contains a objectID attribute)
+    # @param create_if_not_exits a boolean, if true create the objects if they don't exist
     #
-    def partial_update_objects!(objs)
-      res = partial_update_objects(objs)
+    def partial_update_objects!(objs, create_if_not_exits = true)
+      res = partial_update_objects(objs, create_if_not_exits)
       wait_task(res["taskID"])
       return res
     end
@@ -262,9 +269,10 @@ module Algolia
     # 
     # @param obj the attributes to override
     # @param objectID the associated objectID, if nil 'obj' must contain an 'objectID' key
+    # @param create_if_not_exits a boolean, if true creates the object if this one doesn't exist
     #
-    def partial_update_object!(obj, objectID = nil)
-      res = partial_update_object(obj, objectID)
+    def partial_update_object!(obj, objectID = nil, create_if_not_exits = true)
+      res = partial_update_object(obj, objectID, create_if_not_exits)
       wait_task(res["taskID"])
       return res
     end

data/lib/algolia/protocol.rb

@@ -27,8 +27,9 @@ module Algolia
     # HTTP ERROR CODES
     # ----------------------------------------
 
-    ERROR_TIMEOUT = 124
-    ERROR_UNAVAILABLE = 503
+    ERROR_BAD_REQUEST = 400
+    ERROR_FORBIDDEN = 403
+    ERROR_NOT_FOUND = 404
 
     # URI Helpers
     # ----------------------------------------
@@ -78,8 +79,9 @@ module Algolia
       "#{index_uri(index)}/browse#{params}"
     end
 
-    def Protocol.partial_object_uri(index, object_id)
-      "#{index_uri(index)}/#{CGI.escape(object_id)}/partial"
+    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}"
     end
     
     def Protocol.settings_uri(index)

data/lib/algolia/version.rb

@@ -1,3 +1,3 @@
 module Algolia
-  VERSION = "1.3.0"
+  VERSION = "1.3.1"
 end

data/lib/algolia/webmock.rb

@@ -9,40 +9,40 @@ end
 WebMock.disable!
 
 # list indexes
-WebMock.stub_request(:get, /.*\.algolia\.io\/1\/indexes/).to_return(:body => '{ "items": [] }')
+WebMock.stub_request(:get, /.*\.algolia\.(io|net)\/1\/indexes/).to_return(:body => '{ "items": [] }')
 # query index
-WebMock.stub_request(:get, /.*\.algolia\.io\/1\/indexes\/[^\/]+/).to_return(:body => '{}')
-WebMock.stub_request(:post, /.*\.algolia\.io\/1\/indexes\/[^\/]+\/query/).to_return(:body => '{}')
+WebMock.stub_request(:get, /.*\.algolia\.(io|net)\/1\/indexes\/[^\/]+/).to_return(:body => '{}')
+WebMock.stub_request(:post, /.*\.algolia\.(io|net)\/1\/indexes\/[^\/]+\/query/).to_return(:body => '{}')
 # delete index
-WebMock.stub_request(:delete, /.*\.algolia\.io\/1\/indexes\/[^\/]+/).to_return(:body => '{ "taskID": 42 }')
+WebMock.stub_request(:delete, /.*\.algolia\.(io|net)\/1\/indexes\/[^\/]+/).to_return(:body => '{ "taskID": 42 }')
 # clear index
-WebMock.stub_request(:post, /.*\.algolia\.io\/1\/indexes\/[^\/]+\/clear/).to_return(:body => '{ "taskID": 42 }')
+WebMock.stub_request(:post, /.*\.algolia\.(io|net)\/1\/indexes\/[^\/]+\/clear/).to_return(:body => '{ "taskID": 42 }')
 # add object
-WebMock.stub_request(:post, /.*\.algolia\.io\/1\/indexes\/[^\/]+/).to_return(:body => '{ "taskID": 42 }')
+WebMock.stub_request(:post, /.*\.algolia\.(io|net)\/1\/indexes\/[^\/]+/).to_return(:body => '{ "taskID": 42 }')
 # save object
-WebMock.stub_request(:put, /.*\.algolia\.io\/1\/indexes\/[^\/]+\/[^\/]+/).to_return(:body => '{ "taskID": 42 }')
+WebMock.stub_request(:put, /.*\.algolia\.(io|net)\/1\/indexes\/[^\/]+\/[^\/]+/).to_return(:body => '{ "taskID": 42 }')
 # partial update
-WebMock.stub_request(:put, /.*\.algolia\.io\/1\/indexes\/[^\/]+\/[^\/]+\/partial/).to_return(:body => '{ "taskID": 42 }')
+WebMock.stub_request(:put, /.*\.algolia\.(io|net)\/1\/indexes\/[^\/]+\/[^\/]+\/partial/).to_return(:body => '{ "taskID": 42 }')
 # get object
-WebMock.stub_request(:get, /.*\.algolia\.io\/1\/indexes\/[^\/]+\/[^\/]+/).to_return(:body => '{}')
+WebMock.stub_request(:get, /.*\.algolia\.(io|net)\/1\/indexes\/[^\/]+\/[^\/]+/).to_return(:body => '{}')
 # delete object
-WebMock.stub_request(:delete, /.*\.algolia\.io\/1\/indexes\/[^\/]+\/[^\/]+/).to_return(:body => '{ "taskID": 42 }')
+WebMock.stub_request(:delete, /.*\.algolia\.(io|net)\/1\/indexes\/[^\/]+\/[^\/]+/).to_return(:body => '{ "taskID": 42 }')
 # batch
-WebMock.stub_request(:post, /.*\.algolia\.io\/1\/indexes\/[^\/]+\/batch/).to_return(:body => '{ "taskID": 42 }')
+WebMock.stub_request(:post, /.*\.algolia\.(io|net)\/1\/indexes\/[^\/]+\/batch/).to_return(:body => '{ "taskID": 42 }')
 # settings
-WebMock.stub_request(:get, /.*\.algolia\.io\/1\/indexes\/[^\/]+\/settings/).to_return(:body => '{}')
-WebMock.stub_request(:put, /.*\.algolia\.io\/1\/indexes\/[^\/]+\/settings/).to_return(:body => '{ "taskID": 42 }')
+WebMock.stub_request(:get, /.*\.algolia\.(io|net)\/1\/indexes\/[^\/]+\/settings/).to_return(:body => '{}')
+WebMock.stub_request(:put, /.*\.algolia\.(io|net)\/1\/indexes\/[^\/]+\/settings/).to_return(:body => '{ "taskID": 42 }')
 # browse
-WebMock.stub_request(:get, /.*\.algolia\.io\/1\/indexes\/[^\/]+\/browse/).to_return(:body => '{}')
+WebMock.stub_request(:get, /.*\.algolia\.(io|net)\/1\/indexes\/[^\/]+\/browse/).to_return(:body => '{}')
 # operations
-WebMock.stub_request(:post, /.*\.algolia\.io\/1\/indexes\/[^\/]+\/operation/).to_return(:body => '{ "taskID": 42 }')
+WebMock.stub_request(:post, /.*\.algolia\.(io|net)\/1\/indexes\/[^\/]+\/operation/).to_return(:body => '{ "taskID": 42 }')
 # tasks
-WebMock.stub_request(:get, /.*\.algolia\.io\/1\/indexes\/[^\/]+\/task\/[^\/]+/).to_return(:body => '{ "status": "published" }')
+WebMock.stub_request(:get, /.*\.algolia\.(io|net)\/1\/indexes\/[^\/]+\/task\/[^\/]+/).to_return(:body => '{ "status": "published" }')
 # index keys
-WebMock.stub_request(:post, /.*\.algolia\.io\/1\/indexes\/[^\/]+\/keys/).to_return(:body => '{ }')
-WebMock.stub_request(:get, /.*\.algolia\.io\/1\/indexes\/[^\/]+\/keys/).to_return(:body => '{ "keys": [] }')
+WebMock.stub_request(:post, /.*\.algolia\.(io|net)\/1\/indexes\/[^\/]+\/keys/).to_return(:body => '{ }')
+WebMock.stub_request(:get, /.*\.algolia\.(io|net)\/1\/indexes\/[^\/]+\/keys/).to_return(:body => '{ "keys": [] }')
 # global keys
-WebMock.stub_request(:post, /.*\.algolia\.io\/1\/keys/).to_return(:body => '{ }')
-WebMock.stub_request(:get, /.*\.algolia\.io\/1\/keys/).to_return(:body => '{ "keys": [] }')
-WebMock.stub_request(:get, /.*\.algolia\.io\/1\/keys\/[^\/]+/).to_return(:body => '{ }')
-WebMock.stub_request(:delete, /.*\.algolia\.io\/1\/keys\/[^\/]+/).to_return(:body => '{ }')
+WebMock.stub_request(:post, /.*\.algolia\.(io|net)\/1\/keys/).to_return(:body => '{ }')
+WebMock.stub_request(:get, /.*\.algolia\.(io|net)\/1\/keys/).to_return(:body => '{ "keys": [] }')
+WebMock.stub_request(:get, /.*\.algolia\.(io|net)\/1\/keys\/[^\/]+/).to_return(:body => '{ }')
+WebMock.stub_request(:delete, /.*\.algolia\.(io|net)\/1\/keys\/[^\/]+/).to_return(:body => '{ }')

data/spec/client_spec.rb

@@ -42,6 +42,41 @@ describe 'Client' do
     res["hits"].length.should eq(1)
   end
 
+  it "should partial update a simple object, or add it if it doesn't exist" do
+    res = @index.search("tonny@parker.org")
+    res["hits"].length.should eq(0)
+    @index.partial_update_object!({ :email => "tonny@parker.org" }, "1")
+    res = @index.search("tonny@parker.org")
+    res["hits"].length.should eq(1)
+  end
+
+  it "should partial update a simple object, but don't add it if it doesn't exist" do
+    @index.partial_update_object!({ :email => "alex@boom.org" }, "51", false)
+    res = @index.search("alex@boom.org")
+    res["hits"].length.should eq(0)
+  end
+
+  it "should partial update a batch of objects, and add them if they don't exist" do
+    batch = [
+      { :objectID => "1", :email => "john@wanna.org" },
+      { :objectID => "2", :email => "robert@wanna.org" }
+    ]
+    @index.partial_update_objects!(batch)
+    res = @index.search("@wanna.org")
+    res["hits"].length.should eq(2)
+  end
+
+  it "should partial update a batch of objects, but don't add them if they don't exist" do
+    create_if_not_exits = false
+    batch = [
+      { :objectID => "11", :email => "john@be.org" },
+      { :objectID => "22", :email => "robert@be.org" }
+    ]
+    @index.partial_update_objects!(batch, create_if_not_exits)
+    res = @index.search("@be.org")
+    res["hits"].length.should eq(0)
+  end
+
   it "should add a set of objects" do
     @index.add_objects!([
       { :name => "Another", :email => "another1@example.org" },
@@ -685,3 +720,4 @@ describe 'Client' do
     answer['disjunctiveFacets']['stars']['****'].should eq(1)
   end
 end
+

data/spec/stub_spec.rb

@@ -10,7 +10,7 @@ describe 'With a rate limited client' do
   end
 
   it "should pass the right headers" do
-    WebMock.stub_request(:get, %r{https://.*\.algolia\.io/1/indexes/friends\?query=.*}).
+    WebMock.stub_request(:get, %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'}).
       to_return(:status => 200, :body => "{ \"hits\": [], \"fakeAttribute\": 1 }", :headers => {})
     Algolia.enable_rate_limit_forward ENV['ALGOLIA_API_KEY'], "1.2.3.4", "ratelimitapikey"
@@ -20,7 +20,7 @@ describe 'With a rate limited client' do
   end
 
   it "should use original headers" do
-    WebMock.stub_request(:get, %r{https://.*\.algolia\.io/1/indexes/friends\?query=.*}).
+    WebMock.stub_request(:get, %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 => {})    
     Algolia.disable_rate_limit_forward
@@ -29,7 +29,7 @@ describe 'With a rate limited client' do
   end
 
   it "should pass the right headers in the scope" do
-    WebMock.stub_request(:get, %r{https://.*\.algolia\.io/1/indexes/friends\?query=.*}).
+    WebMock.stub_request(:get, %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'}).
       to_return(:status => 200, :body => "{ \"hits\": [], \"fakeAttribute\": 1 }", :headers => {})
     Algolia.with_rate_limits "1.2.3.4", "ratelimitapikey" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Algolia
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement