algoliasearch 1.1.15 → 1.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24e44bd6f2d0d045a075065b88349b5ea57dec1d
-  data.tar.gz: 171671f8ae4eb263e94eabd10634c34c3d3b535e
+  metadata.gz: 9a5b805f07b381464702a5730df66afaf269deab
+  data.tar.gz: 20ec0ac8649ed6260de80004ffc71bda15f04f3c
 SHA512:
-  metadata.gz: f368ba248cd7d98bb6fdbdceacaca32e914aa3d2095b0a109c6cf60fed173177a9e23fb3cc09700465907fefbe25e902e455336f1fb5129235a51d1033458d26
-  data.tar.gz: 4b9322065da7cd0cd59c48b813da27772b73f260591b2fb58ee77d38e245fa5e010933c77376844b0abb6aacdd38ea80ddc51aea73bd84763c338bd05ae1b512
+  metadata.gz: ca22ebe2ea6f5bf41069c668119981da77bb2f36b982b1f4b12a8097bf0fcce98944664fd4f8d9ced69211eaca2f6ed56c6a171fc2544e6b05c873de1896363f
+  data.tar.gz: 0502436b3c8f7ba247595b97aa7ac3d47ba172631dfd2267e8804544524ccbcac2161c76eee07473f407d3dc3b0b40109b62be5a91a643214da4b9b7ed69922f

data/.travis.yml

@@ -5,7 +5,6 @@ branches:
 rvm:
 - 2.0.0
 - 1.9.3
-- rbx-2.2.1
 env:
   global:
   - secure: lBLtTjQyeJW7+TWgGmf1mmsXgUzsTnq3/KHvCk+BvOGwoHXTBR1Y6yiczWWHEP4/wBeXXm31xUQC+VoYc/7Ev/2NNB/mqlXAgGw+D0nwQriNXjYt1WV6lQvyoiaUzQ+w+7VahWdx0LuKvSYI+khe8M8BfHQqYacu0VlpAUnjb2I=

data/ChangeLog

@@ -1,5 +1,11 @@
 CHANGELOG
 
+2013-12-16  1.1.16
+
+      * Add arguments type-checking
+      * Normalize save_object/partial_update/add_object signatures
+      * Force dependencies versions
+
 2013-12-16  1.1.15
 
       * Embed ca-bundle.crt

data/Gemfile

@@ -1,15 +1,15 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
-gem "curb"
+gem 'curb', '~> 0.8'
+gem 'json', '>= 1.5.1'
 
 group :development do
-	gem "bundler"
-  gem "jeweler"
-  gem "travis"
+  gem 'jeweler'
+  gem 'travis'
 end
 
 group :test do 
-  gem 'rspec'
+  gem 'rspec', '>= 2.5.0'
   gem 'autotest'
   gem 'autotest-fsevent'
   gem 'redgreen'

data/Gemfile.lock

@@ -1,28 +1,28 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    ZenTest (4.9.4)
+    ZenTest (4.9.5)
     addressable (2.3.5)
     autotest (4.4.6)
       ZenTest (>= 4.4.1)
-    autotest-fsevent (0.2.8)
+    autotest-fsevent (0.2.9)
       sys-uname
     autotest-growl (0.2.16)
     backports (3.3.5)
     builder (3.2.2)
-    coderay (1.0.9)
+    coderay (1.1.0)
     crack (0.4.1)
       safe_yaml (~> 0.9.0)
     curb (0.8.5)
-    diff-lcs (1.2.4)
-    ethon (0.6.1)
+    diff-lcs (1.2.5)
+    ethon (0.6.2)
       ffi (>= 1.3.0)
       mime-types (~> 1.18)
     faraday (0.8.8)
       multipart-post (~> 1.2.0)
     faraday_middleware (0.9.0)
       faraday (>= 0.7.4, < 0.9)
-    ffi (1.9.0)
+    ffi (1.9.3)
     gh (0.13.0)
       addressable
       backports
@@ -39,7 +39,7 @@ GEM
       nokogiri (~> 1.5.2)
       oauth2
     hashie (2.0.5)
-    highline (1.6.19)
+    highline (1.6.20)
     httpauth (0.2.0)
     jeweler (1.8.8)
       builder
@@ -50,19 +50,18 @@ GEM
       nokogiri (= 1.5.10)
       rake
       rdoc
-    json (1.8.0)
+    json (1.8.1)
     jwt (0.1.8)
       multi_json (>= 1.5)
-    launchy (2.3.0)
+    launchy (2.4.2)
       addressable (~> 2.3)
     method_source (0.8.2)
-    mime-types (1.25)
+    mime-types (1.25.1)
     multi_json (1.8.2)
     multi_xml (0.5.5)
     multipart-post (1.2.0)
     net-http-persistent (2.9)
     net-http-pipeline (1.0.1)
-    netrc (0.7.7)
     nokogiri (1.5.10)
     oauth2 (0.9.2)
       faraday (~> 0.8)
@@ -71,15 +70,14 @@ GEM
       multi_json (~> 1.0)
       multi_xml (~> 0.5)
       rack (~> 1.2)
-    pry (0.9.12.2)
-      coderay (~> 1.0.5)
+    pry (0.9.12.4)
+      coderay (~> 1.0)
       method_source (~> 0.8)
       slop (~> 3.4)
-    pusher-client (0.3.1)
-      ruby-hmac (~> 0.4.0)
+    pusher-client (0.4.0)
       websocket (~> 1.0.0)
     rack (1.5.2)
-    rake (10.1.0)
+    rake (10.1.1)
     rdoc (4.0.1)
       json (~> 1.4)
     redgreen (1.2.2)
@@ -87,31 +85,28 @@ GEM
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
       rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.5)
-    rspec-expectations (2.14.3)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.3)
-    ruby-hmac (0.4.0)
+    rspec-mocks (2.14.4)
     safe_yaml (0.9.7)
-    slop (3.4.6)
+    slop (3.4.7)
     sys-uname (0.9.2)
       ffi (>= 1.0.0)
-    terminal-notifier (1.5.1)
-    travis (1.5.5)
+    travis (1.6.6)
+      addressable (~> 2.3)
       backports
       faraday (~> 0.8.7)
       faraday_middleware (~> 0.9)
       gh (~> 0.13)
       highline (~> 1.6)
       launchy (~> 2.1)
-      netrc (~> 0.7)
       pry (~> 0.9)
-      pusher-client (~> 0.3, >= 0.3.1)
-      terminal-notifier (>= 1.4.2)
+      pusher-client (~> 0.4)
       typhoeus (~> 0.6)
-    typhoeus (0.6.5)
-      ethon (~> 0.6.1)
-    webmock (1.13.0)
+    typhoeus (0.6.7)
+      ethon (~> 0.6.2)
+    webmock (1.16.1)
       addressable (>= 2.2.7)
       crack (>= 0.3.2)
     websocket (1.0.7)
@@ -123,10 +118,10 @@ DEPENDENCIES
   autotest
   autotest-fsevent
   autotest-growl
-  bundler
-  curb
+  curb (~> 0.8)
   jeweler
+  json (>= 1.5.1)
   redgreen
-  rspec
+  rspec (>= 2.5.0)
   travis
   webmock

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.15 ruby lib
+# stub: algoliasearch 1.1.16 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "algoliasearch"
-  s.version = "1.1.15"
+  s.version = "1.1.16"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Algolia"]
-  s.date = "2013-12-16"
+  s.date = "2013-12-20"
   s.description = "A simple Ruby client for the algolia.com REST API"
   s.email = "contact@algolia.com"
   s.extra_rdoc_files = [
@@ -51,19 +51,19 @@ 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<curb>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_runtime_dependency(%q<curb>, ["~> 0.8"])
+      s.add_runtime_dependency(%q<json>, [">= 1.5.1"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<travis>, [">= 0"])
     else
-      s.add_dependency(%q<curb>, [">= 0"])
-      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<curb>, ["~> 0.8"])
+      s.add_dependency(%q<json>, [">= 1.5.1"])
       s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<travis>, [">= 0"])
     end
   else
-    s.add_dependency(%q<curb>, [">= 0"])
-    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<curb>, ["~> 0.8"])
+    s.add_dependency(%q<json>, [">= 1.5.1"])
     s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<travis>, [">= 0"])
   end

data/lib/algolia/index.rb

@@ -12,20 +12,20 @@ module Algolia
     
     # Delete an index
     # 
-    # return an object of the form array(:deletedAt => "2013-01-18T15:33:13.556Z")
+    # return an hash of the form { "deletedAt" => "2013-01-18T15:33:13.556Z" }
     def delete
       Algolia.client.delete(Protocol.index_uri(name))
     end
 
     # Add an object in this index
     # 
-    # @param content contains the object to add inside the index. 
+    # @param obj the object to add to the index. 
     #  The object is represented by an associative array
     # @param objectID (optional) an objectID you want to attribute to this object 
-    #  (if the attribute already exist the old object will be overwrite)
+    #  (if the attribute already exist the old object will be overridden)
     def add_object(obj, objectID = nil)
-      raise ArgumentError.new("argument must not be an array") if obj.is_a?(Array)
-      if objectID == nil
+      check_object obj
+      if objectID.nil?
         Algolia.client.post(Protocol.index_uri(name), obj.to_json)
       else
         Algolia.client.put(Protocol.object_uri(name, objectID), obj.to_json)        
@@ -34,10 +34,10 @@ module Algolia
     
     # Add an object in this index and wait end of indexing
     # 
-    # @param content contains the object to add inside the index. 
+    # @param obj the object to add to the index.
     #  The object is represented by an associative array
     # @param objectID (optional) an objectID you want to attribute to this object 
-    #  (if the attribute already exist the old object will be overwrite)
+    #  (if the attribute already exist the old object will be overridden)
     def add_object!(obj, objectID = nil)
       res = add_object(obj, objectID)
       wait_task(res["taskID"])
@@ -46,27 +46,23 @@ module Algolia
 
     # Add several objects in this index
     # 
-    # @param content contains the object to add inside the index. 
-    #  The object is represented by an associative array
-    # @param objectID (optional) an objectID you want to attribute to this object 
-    #  (if the attribute already exist the old object will be overwrite)
+    # @param objs the array of objects to add inside the index. 
+    #  Each object is represented by an associative array
     def add_objects(objs)
-        raise ArgumentError.new("argument must be an array of object") if !objs.is_a?(Array)
-        requests = []
-        objs.each do |obj|
-            raise ArgumentError.new("argument must be an array of object") if obj.is_a?(Array)
-            requests.push({"action" => "addObject", "body" => obj})
-        end
-        request = {"requests" => requests};
-        Algolia.client.post(Protocol.batch_uri(name), request.to_json)
+      check_array objs
+      requests = []
+      objs.each do |obj|
+        check_object obj, true
+        requests.push({"action" => "addObject", "body" => obj})
+      end
+      request = {"requests" => requests};
+      Algolia.client.post(Protocol.batch_uri(name), request.to_json)
     end
     
     # Add several objects in this index and wait end of indexing
     # 
-    # @param content contains the object to add inside the index. 
-    #  The object is represented by an associative array
-    # @param objectID (optional) an objectID you want to attribute to this object 
-    #  (if the attribute already exist the old object will be overwrite)
+    # @param objs the array of objects to add inside the index. 
+    #  Each object is represented by an associative array
     def add_objects!(obj)
       res = add_objects(obj)
       wait_task(res["taskID"])
@@ -152,7 +148,7 @@ module Algolia
     # @param attributesToRetrieve (optional) if set, contains the list of attributes to retrieve as a string separated by ","
     #
     def get_object(objectID, attributesToRetrieve = nil)
-      if attributesToRetrieve == nil
+      if attributesToRetrieve.nil?
         Algolia.client.get(Protocol.object_uri(name, objectID, nil))
       else
         Algolia.client.get(Protocol.object_uri(name, objectID, {"attributes" => attributesToRetrieve}))
@@ -169,46 +165,55 @@ module Algolia
       loop do
         status = Algolia.client.get(Protocol.task_uri(name, taskID))["status"]
         if status == "published"
-            return
+          return
         end
         sleep(timeBeforeRetry.to_f / 1000)
       end
     end
 
-    # Override the content of object
+    # Override the content of an object
     # 
-    # @param object contains the object to save, the object must contains an objectID attribute
+    # @param obj the object to save
+    # @param objectID the associated objectID, if nil 'obj' must contain an 'objectID' key
     #
-    def save_object(obj)
-      Algolia.client.put(Protocol.object_uri(name, obj["objectID"]), obj.to_json)
+    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)
     end
 
     # Override the content of object and wait indexing
     # 
-    # @param object contains the object to save, the object must contains an objectID attribute
+    # @param obj the object to save
+    # @param objectID the associated objectID, if nil 'obj' must contain an 'objectID' key
     #    
-    def save_object!(obj)
-      res = save_object(obj)
+    def save_object!(obj, objectID = nil)
+      res = save_object(obj, objectID)
       wait_task(res["taskID"])
       return res
     end
 
     # Override the content of several objects
     # 
-    # @param object contains the object to save, the object must contains an objectID attribute
+    # @param objs the array of objects to save, each object must contain an 'objectID' key
     #
     def save_objects(objs)
-        requests = []
-        objs.each do |obj|
-            requests.push({"action" => "updateObject", "objectID" => obj["objectID"], "body" => obj})
-        end
-        request = {"requests" => requests};
-        Algolia.client.post(Protocol.batch_uri(name), request.to_json)
+      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};
+      Algolia.client.post(Protocol.batch_uri(name), request.to_json)
     end
 
     # Override the content of several objects and wait indexing
     # 
-    # @param object contains the object to save, the object must contains an objectID attribute
+    # @param objs the array of objects to save, each object must contain an objectID attribute
     #    
     def save_objects!(objs)
       res = save_objects(objs)
@@ -219,46 +224,53 @@ module Algolia
     #
     # Update partially an object (only update attributes passed in argument)
     # 
-    # @param obj contains the object attributes to override, the 
-    #  object must contains an objectID attribute
+    # @param obj the object attributes to override
+    # @param objectID the associated objectID, if nil 'obj' must contain an 'objectID' key
     #
-    def partial_update_object(obj)
-      Algolia.client.post(Protocol.partial_object_uri(name, obj["objectID"]), obj.to_json)
+    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)
     end
     
     #
     # Partially Override the content of several objects
     # 
-    # @param objs contains an array of objects to update (each object must contains a objectID attribute)
+    # @param objs an array of objects to update (each object must contains a objectID attribute)
     #
     def partial_update_objects(objs)
-        requests = []
-        objs.each do |obj|
-            requests.push({"action" => "partialUpdateObject", "objectID" => obj["objectID"], "body" => obj})
-        end
-        request = {"requests" => requests};
-        Algolia.client.post(Protocol.batch_uri(name), request.to_json)
+      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};
+      Algolia.client.post(Protocol.batch_uri(name), request.to_json)
     end
 
     #
     # Partially Override the content of several objects
     # 
-    # @param objs contains an array of objects to update (each object must contains a objectID attribute)
+    # @param objs an array of objects to update (each object must contains a objectID attribute)
     #
     def partial_update_objects!(objs)
-        res = partial_update_objects(obj)
-        wait_task(res["taskID"])
-        return res
+      res = partial_update_objects(obj)
+      wait_task(res["taskID"])
+      return res
     end
 
     #
     # Update partially an object (only update attributes passed in argument) and wait indexing
     # 
-    # @param obj contains the attributes to override, the 
-    #  object must contains an objectID attribute
+    # @param obj the attributes to override
+    # @param objectID the associated objectID, if nil 'obj' must contain an 'objectID' key
     #
-    def partial_update_object!(obj)
-      res = partial_update_object(obj)
+    def partial_update_object!(obj, objectID = nil)
+      res = partial_update_object(obj, objectID)
       wait_task(res["taskID"])
       return res
     end
@@ -269,9 +281,6 @@ module Algolia
     # @param objectID the unique identifier of object to delete
     #
     def delete_object(objectID)
-      if (objectID == nil || objectID.length == 0) then
-        raise AlgoliaProtocolError.new(0, "objectID is required")
-      end
       Algolia.client.delete(Protocol.object_uri(name, objectID))
     end
     
@@ -358,12 +367,12 @@ module Algolia
 
     # List all existing user keys with their associated ACLs
     def list_user_keys
-        Algolia.client.get(Protocol.index_keys_uri(name))
+      Algolia.client.get(Protocol.index_keys_uri(name))
     end
  
     # Get ACL of a user key
     def get_user_key(key)
-        Algolia.client.get(Protocol.index_key_uri(name, key))
+      Algolia.client.get(Protocol.index_key_uri(name, key))
     end
  
     #
@@ -381,12 +390,28 @@ 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
     def delete_user_key(key)
-        Algolia.client.delete(Protocol.index_key_uri(name, key))
+      Algolia.client.delete(Protocol.index_key_uri(name, key))
+    end
+
+    private
+    def check_array(objs)
+      raise ArgumentError.new("argument must be an array of objects") if !objs.is_a?(Array)
+    end
+
+    def check_object(obj, in_array = false)
+      case obj
+      when Array
+        raise ArgumentError.new(in_array ? "argument must be an array of objects" : "argument must not be an array")
+      when String, Integer, Float, TrueClass, FalseClass, NilClass
+        raise ArgumentError.new("argument must be an #{'array of' if in_array} object, got: #{obj.inspect}")
+      else
+        # ok
+      end
     end
 
   end

data/lib/algolia/version.rb

@@ -1,3 +1,3 @@
 module Algolia
-  VERSION = "1.1.15"
+  VERSION = "1.1.16"
 end

data/spec/client_spec.rb

@@ -31,6 +31,13 @@ describe 'Client' do
   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)
+    expect { @index.save_object(1) }.to raise_error(ArgumentError)
+    expect { @index.save_object("test") }.to raise_error(ArgumentError)
+    expect { @index.save_object({ objectID: 42 }.to_json) }.to raise_error(ArgumentError)
+    expect { @index.save_objects([{}, ""]) }.to raise_error(ArgumentError)
+    expect { @index.save_objects([1]) }.to raise_error(ArgumentError)
+    expect { @index.save_objects!([1]) }.to raise_error(ArgumentError)
+    expect { @index.save_object({ foo: 42 }) }.to raise_error(ArgumentError) # missing objectID
   end
 
   it "should be thread safe" do

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch
 version: !ruby/object:Gem::Version
-  version: 1.1.15
+  version: 1.1.16
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-16 00:00:00.000000000 Z
+date: 2013-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 1.5.1
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.1
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement