algoliasearch 1.1.17 → 1.1.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14d536f146b031e91b22b0fa8fd6ae490d5313ca
-  data.tar.gz: 6363a928bb6e679e51b55e73fffdc5b8fdea4b6a
+  metadata.gz: ed9bdf3f12f211dae2feda61a34a774cd2290cfd
+  data.tar.gz: f90d402531a97f525a1d6e653afd4dc306e91bdf
 SHA512:
-  metadata.gz: d618bbb9d33e9af749ba5a0b5a61bb7c94f3c3af1680d28969eb080df1ebc3abb9ccc48f5bb7e0c455eca13ba4080a8af18ea82c955c0ac00f58644253be1fba
-  data.tar.gz: 4492f1024fe3bdaeacc0523ea0d3e99cc63db2d03cbbc8c8ab5a19cc58b8bcad18f790a23708744e91b9db14d9ba5fe69badfc06bb41c2ccc434d27c31d3777e
+  metadata.gz: 3d14cde3da631f5d2dbd769749103c2b27b26e700c2e8626b35581c72b820e945a6d1cce524a09a40b655ed6b64e3819144daf8b0e960de003ecdaef4b640dbe
+  data.tar.gz: 16d7cb85403471dad4b9b1a8f494d8ba72b11bc08b712a228682367bf5189cdfbaff45a21960ef0082add8a4a31b0e4c5202c9e579bf0700cb5b820601887b3a

data/ChangeLog

@@ -1,5 +1,9 @@
 CHANGELOG
 
+2014-01-06  1.1.18
+
+      * Fixed batch request builder (broken since last refactoring)
+
 2014-01-02  1.1.17
 
       * Ability to use IP rate limit behind a proxy forwarding the end-user's IP

data/README.md

@@ -427,7 +427,8 @@ You can also create an API Key with advanced restrictions:
  * Add a validity period: the key will be valid only for a specific period of time (in seconds),
  * Specify the maximum number of API calls allowed from an IP address per hour. Each time an API call is performed with this key, a check is performed. If the IP at the origin of the call did more than this number of calls in the last hour, a 403 code is returned. Defaults to 0 (no rate limit). This parameter can be used to protect you from attempts at retrieving your entire content by massively querying the index.
 
-  Note: If you are sending the query through your servers, you must use the `Algolia.enable_rate_limit_forward("TheAdminAPIKey", "EndUserIP", "APIKeyWithRateLimit")` function to enable rate-limit.
+  Note: If you are sending the query through your servers, you must use the `Algolia.with_rate_limits("EndUserIP", "APIKeyWithRateLimit") do ... end` block to enable rate-limit.
+
  * Specify the maximum number of hits this API key can retrieve in one call. Defaults to 0 (unlimited). This parameter can be used to protect you from attempts at retrieving your entire content by massively querying the index.
 
 ```ruby

data/algoliasearch.gemspec

@@ -2,15 +2,15 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: algoliasearch 1.1.17 ruby lib
+# stub: algoliasearch 1.1.18 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "algoliasearch"
-  s.version = "1.1.17"
+  s.version = "1.1.18"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Algolia"]
-  s.date = "2014-01-02"
+  s.date = "2014-01-06"
   s.description = "A simple Ruby client for the algolia.com REST API"
   s.email = "contact@algolia.com"
   s.extra_rdoc_files = [

data/lib/algolia/client.rb

@@ -29,22 +29,7 @@ module Algolia
       exceptions = []
       thread_local_hosts.each do |host|
         begin
-          session = host["session"]
-          session.url = host["base_url"] + uri
-          case method
-          when :GET
-            session.http_get
-          when :POST
-            session.post_body = data
-            session.http_post
-          when :PUT
-            session.put(data)
-          when :DELETE
-            session.http_delete
-          end
-          if session.response_code >= 400 || session.response_code < 200
-            raise AlgoliaProtocolError.new(session.response_code, "Cannot #{method} to #{session.url}: #{session.body_str} (#{session.response_code})")
-          end
+          session = perform_request(host, uri, method, data)
           return JSON.parse(session.body_str)
         rescue AlgoliaProtocolError => e
           raise if e.code != Protocol::ERROR_TIMEOUT and e.code != Protocol::ERROR_UNAVAILABLE
@@ -74,24 +59,46 @@ module Algolia
 
     # this method returns a thread-local array of sessions
     def thread_local_hosts
-      if Thread.current[:algolia_hosts].nil?
-        Thread.current[:algolia_hosts] = hosts.map do |host|
-          hinfo = {}
-          hinfo["base_url"] = "http#{@ssl ? 's' : ''}://#{host}"
-          hinfo["host"] = host
-          hinfo["session"] = Curl::Easy.new do |s|
-            s.headers[Protocol::HEADER_API_KEY]  = api_key
-            s.headers[Protocol::HEADER_APP_ID]   = application_id
-            s.headers["Content-Type"]            = "application/json; charset=utf-8"
-            s.headers["User-Agent"]              = "Algolia for Ruby #{::Algolia::VERSION}"
-            s.verbose                            = true if @debug
-            s.cacert                             = File.join File.dirname(__FILE__), '..', '..', 'resources', 'ca-bundle.crt'
-            s.encoding                           = ''
-          end
-          hinfo
-        end
+      Thread.current[:algolia_hosts] ||= hosts.map do |host|
+        hinfo = {}
+        hinfo["base_url"] = "http#{@ssl ? 's' : ''}://#{host}"
+        hinfo["host"] = host
+        hinfo["session"] = init_session
+        hinfo
       end
-      Thread.current[:algolia_hosts]
+    end
+
+    private
+    def perform_request(host, uri, method, data)
+        session = host["session"]
+        session.url = host["base_url"] + uri
+        case method
+        when :GET
+          session.http_get
+        when :POST
+          session.post_body = data
+          session.http_post
+        when :PUT
+          session.put(data)
+        when :DELETE
+          session.http_delete
+        end
+        if session.response_code >= 400 || session.response_code < 200
+          raise AlgoliaProtocolError.new(session.response_code, "Cannot #{method} to #{session.url}: #{session.body_str} (#{session.response_code})")
+        end
+        session;
+    end
+
+    def init_session
+      s = Curl::Easy.new
+      s.headers[Protocol::HEADER_API_KEY]  = api_key
+      s.headers[Protocol::HEADER_APP_ID]   = application_id
+      s.headers["Content-Type"]            = "application/json; charset=utf-8"
+      s.headers["User-Agent"]              = "Algolia for Ruby #{::Algolia::VERSION}"
+      s.verbose                            = true if @debug
+      s.cacert                             = File.join File.dirname(__FILE__), '..', '..', 'resources', 'ca-bundle.crt'
+      s.encoding                           = ''
+      s
     end
 
   end

data/lib/algolia/index.rb

@@ -49,13 +49,7 @@ module Algolia
     # @param objs the array of objects to add inside the index. 
     #  Each object is represented by an associative array
     def add_objects(objs)
-      check_array objs
-      requests = []
-      objs.each do |obj|
-        check_object obj, true
-        requests.push({"action" => "addObject", "body" => obj})
-      end
-      request = {"requests" => requests};
+      request = build_batch('addObject', objs, false)
       Algolia.client.post(Protocol.batch_uri(name), request.to_json)
     end
     
@@ -143,7 +137,7 @@ module Algolia
     # @param hitsPerPage: Pagination parameter used to select the number of hits per page. Defaults to 1000.
     #
     def browse(page = 0, hitsPerPage = 1000)
-     Algolia.client.get(Protocol.browse_uri(name, {"page" => page, "hitsPerPage" => hitsPerPage}))
+     Algolia.client.get(Protocol.browse_uri(name, {:page => page, :hitsPerPage => hitsPerPage}))
     end
 
     #
@@ -156,7 +150,7 @@ module Algolia
       if attributesToRetrieve.nil?
         Algolia.client.get(Protocol.object_uri(name, objectID, nil))
       else
-        Algolia.client.get(Protocol.object_uri(name, objectID, {"attributes" => attributesToRetrieve}))
+        Algolia.client.get(Protocol.object_uri(name, objectID, {:attributes => attributesToRetrieve}))
       end
     end
 
@@ -182,10 +176,7 @@ module Algolia
     # @param objectID the associated objectID, if nil 'obj' must contain an 'objectID' key
     #
     def save_object(obj, objectID = nil)
-      check_object obj
-      objectID ||= obj[:objectID] || obj["objectID"]
-      raise ArgumentError.new("Missing 'objectID'") if objectID.nil?
-      Algolia.client.put(Protocol.object_uri(name, objectID), obj.to_json)
+      Algolia.client.put(Protocol.object_uri(name, get_objectID(obj, objectID)), obj.to_json)
     end
 
     # Override the content of object and wait indexing
@@ -204,15 +195,7 @@ module Algolia
     # @param objs the array of objects to save, each object must contain an 'objectID' key
     #
     def save_objects(objs)
-      check_array objs
-      requests = []
-      objs.each do |obj|
-        check_object obj, true
-        objectID = obj[:objectID] || obj["objectID"]
-        raise ArgumentError.new("Missing 'objectID'") if objectID.nil?
-        requests.push({"action" => "updateObject", "objectID" => objectID, "body" => obj})
-      end
-      request = {"requests" => requests};
+      request = build_batch('updateObject', objs, true)
       Algolia.client.post(Protocol.batch_uri(name), request.to_json)
     end
 
@@ -233,10 +216,7 @@ module Algolia
     # @param objectID the associated objectID, if nil 'obj' must contain an 'objectID' key
     #
     def partial_update_object(obj, objectID = nil)
-      check_object obj
-      objectID ||= obj[:objectID] || obj["objectID"]
-      raise ArgumentError.new("Missing 'objectID'") if objectID.nil?
-      Algolia.client.post(Protocol.partial_object_uri(name, objectID), obj.to_json)
+      Algolia.client.post(Protocol.partial_object_uri(name, get_objectID(obj, objectID)), obj.to_json)
     end
     
     #
@@ -245,15 +225,7 @@ module Algolia
     # @param objs an array of objects to update (each object must contains a objectID attribute)
     #
     def partial_update_objects(objs)
-      check_array objs
-      requests = []
-      objs.each do |obj|
-        check_object obj, true
-        objectID = obj[:objectID] || obj["objectID"]
-        raise ArgumentError.new("Missing 'objectID'") if objectID.nil?
-        requests.push({"action" => "partialUpdateObject", "objectID" => objectID, "body" => obj})
-      end
-      request = {"requests" => requests};
+      request = build_batch('partialUpdateObject', objs, true)
       Algolia.client.post(Protocol.batch_uri(name), request.to_json)
     end
 
@@ -402,7 +374,7 @@ module Algolia
     #  @param validity the number of seconds after which the key will be automatically removed (0 means no time limit for this key)
     #
     def add_user_key(acls, validity = 0, maxQueriesPerIPPerHour = 0, maxHitsPerQuery = 0)
-      Algolia.client.post(Protocol.index_keys_uri(name), {"acl" => acls, "validity" => validity, "maxQueriesPerIPPerHour" => maxQueriesPerIPPerHour.to_i, "maxHitsPerQuery" => maxHitsPerQuery.to_i}.to_json)
+      Algolia.client.post(Protocol.index_keys_uri(name), {:acl => acls, :validity => validity, :maxQueriesPerIPPerHour => maxQueriesPerIPPerHour.to_i, :maxHitsPerQuery => maxHitsPerQuery.to_i}.to_json)
     end
  
     # Delete an existing user key
@@ -426,5 +398,24 @@ module Algolia
       end
     end
 
+    def get_objectID(obj, objectID = nil)
+      check_object obj
+      objectID ||= obj[:objectID] || obj["objectID"]
+      raise ArgumentError.new("Missing 'objectID'") if objectID.nil?
+      return objectID
+    end
+
+    def build_batch(action, objs, with_object_id = false)
+      check_array objs
+      {
+        :requests => objs.map { |obj|
+          check_object obj, true
+          h = { :action => action, :body => obj }
+          h[:objectID] = get_objectID(obj).to_s if with_object_id
+          h
+        }
+      }
+    end
+
   end
 end

data/lib/algolia/protocol.rb

@@ -105,7 +105,7 @@ module Algolia
     private
     def Protocol.to_query(params)
       params.map do |k, v|
-        "#{CGI.escape(k)}=#{CGI.escape(v.to_s)}"
+        "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"
       end.join('&')
     end
     

data/lib/algolia/version.rb

@@ -1,3 +1,3 @@
 module Algolia
-  VERSION = "1.1.17"
+  VERSION = "1.1.18"
 end

data/spec/client_spec.rb

@@ -28,6 +28,15 @@ describe 'Client' do
     res["hits"].length.should eq(2)
   end
 
+  it "should save a set of objects with their ids" do
+    @index.save_objects!([
+      { :name => "objectid", :email => "objectid1@example.org", :objectID => 101 },
+      { :name => "objectid", :email => "objectid2@example.org", :objectID => 102 }
+    ])
+    res = @index.search("objectid")
+    res["hits"].length.should eq(2)
+  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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch
 version: !ruby/object:Gem::Version
-  version: 1.1.17
+  version: 1.1.18
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-02 00:00:00.000000000 Z
+date: 2014-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curb