algoliasearch 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,15 @@
---- 
-SHA1: 
-  data.tar.gz: f1833d8ef8fe5af6c44ce31e169929b7c84b049c
-  metadata.gz: e02ffcaf7597034df5b829752a7b8cc2069cbd19
-SHA512: 
-  data.tar.gz: b5a0bcf7afb047ffb0cc5a9b53a770e48c586a912fa03d1c49a3a7ef007be42e08dcd7fea13ca5c61e459256537f74a35ef7e4fcab5411f3eaaf2f2cffdaaf74
-  metadata.gz: 536122b2dc1a59f5e50f09819af7b3b996c2b8ca0e1093534a799e4d5f4a5108e66402c16389882c965a7cbf15e4ab65528f29244359511fb4e4dbdcc75b99c6
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MDg3MGEyNjMwMzgwMWE4YTFlNDNiOWM1NjI3NTE3MDBiYjczNWQ5YQ==
+  data.tar.gz: !binary |-
+    NmM2ZTA5Y2U2Y2RhZjNkOWZjY2ExMGZmODVhYzk5OTJiMGE0NTUzMg==
+SHA512:
+  metadata.gz: !binary |-
+    YzU1M2ZmMzlkYzRmM2I2NWZmMGI5MGVkZGM2ZGRmYjlhOGEwNjA0YmU4M2Fj
+    Yzc4OTdlODc4ODZjOWI2ZDI1MWQzNjI3YzY1ZGI3NGQwZDhlMGQwYjYwYTc2
+    OTM1MjE1OThhNjg4OWM1MTk2OGY4YzZlYTYzNzU3NWZmODlmOTg=
+  data.tar.gz: !binary |-
+    MmNiNWI5OTZjOTU2MzIxM2VjZDI4MTM0N2Y5Mjg1Y2I2OWY5NzcwZTUzOGY3
+    NDY2ZTFlN2M5Y2IxMTM0NWFlM2U5ZGM5ZDhhOTBjYTViMjBjYjQ3Y2UxYWYy
+    ZWNhNjIxZjUyZjM0OWUyNmNjZjk0OTE5ZmUyMzFlOTQ3NzE0N2I=

data/Gemfile.lock

@@ -1,34 +1,67 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    addressable (2.3.4)
-    crack (0.3.2)
+    addressable (2.3.5)
+    builder (3.2.2)
+    crack (0.4.1)
+      safe_yaml (~> 0.9.0)
     curb (0.8.4)
-    diff-lcs (1.1.3)
-    git (1.2.5)
-    jeweler (1.8.4)
+    diff-lcs (1.2.4)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.19)
+    httpauth (0.2.0)
+    jeweler (1.8.7)
+      builder
       bundler (~> 1.0)
       git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
       rake
       rdoc
     json (1.8.0)
-    rake (10.0.4)
-    rdoc (3.12.2)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    multi_json (1.8.0)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (4.0.1)
       json (~> 1.4)
     redgreen (1.2.2)
-    rspec (2.11.0)
-      rspec-core (~> 2.11.0)
-      rspec-expectations (~> 2.11.0)
-      rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.1)
-    rspec-expectations (2.11.3)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.2)
-    shoulda-context (1.0.2)
-    test-unit (2.5.4)
-    webmock (1.9.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    safe_yaml (0.9.7)
+    shoulda-context (1.1.5)
+    test-unit (2.5.5)
+    webmock (1.13.0)
       addressable (>= 2.2.7)
-      crack (>= 0.1.7)
+      crack (>= 0.3.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -29,8 +29,8 @@ Setup
 -------------
 To setup your project, follow these steps:
 
- 2. Install AlgoliaSearch using <code>gem install algoliasearch</code>.
- 2. Initialize the client with your ApplicationID and API-Key (you can find all of them on your Algolia account).
+ 1. Install AlgoliaSearch using <code>gem install algoliasearch</code>.
+ 2. Initialize the client with your ApplicationID and API-Key. You can find all of them on [your Algolia account](http://www.algolia.com/users/edit).
 
 ```ruby
 require 'rubygems'
@@ -254,7 +254,7 @@ You can retrieve all settings using the `getSettings` function. The result will
  * **attributesToIndex**: (array of strings) the list of fields you want to index.<br/>By default all textual attributes of your objects are indexed, but you should update it to get optimal results.<br/>This parameter has two important uses:
   * *Limits the attributes to index*.<br/>For example if you store a binary image in base64, you want to store it and be able to retrieve it but you don't want to search in the base64 string.
   * *Controls part of the ranking*.<br/>Matches in attributes at the beginning of the list will be considered more important than matches in attributes further down the list. 
- * **ranking**: (array of strings) controls the way hits are sorted.<br/>We have five available criteria:
+ * **ranking**: (array of strings) controls the way hits are sorted.<br/>We have six available criteria:
   * **typo**: sort according to number of typos,
   * **geo**: sort according to decreasing distance when performing a geo-location based search,
   * **proximity**: sort according to the proximity of query words in hits, 
@@ -308,7 +308,7 @@ res = index.add_object!({"firstname" => "Jimmie",
                          "lastname" => "Barninger"})
 ```
 
-If you want to ensure multiple objects have been indexed, you can only check the biggest taskID.
+If you want to ensure multiple objects have been indexed, you can only check the biggest taskID with `wait_task`.
 
 Batch writes
 -------------

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.2

data/algoliasearch.gemspec

@@ -2,14 +2,15 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+# stub: algoliasearch 1.0.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "algoliasearch"
-  s.version = "1.0.0"
+  s.version = "1.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Algolia"]
-  s.date = "2013-08-05"
+  s.date = "2013-09-17"
   s.description = "A simple Ruby client for the algolia.com REST API"
   s.email = "contact@algolia.com"
   s.extra_rdoc_files = [
@@ -17,7 +18,6 @@ Gem::Specification.new do |s|
     "README.md"
   ]
   s.files = [
-    "contacts.json",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "algoliasearch.gemspec",
+    "contacts.json",
     "lib/algolia/client.rb",
     "lib/algolia/error.rb",
     "lib/algolia/index.rb",
@@ -34,7 +35,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/algolia/algoliasearch-client-ruby"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "2.0.5"
+  s.rubygems_version = "2.1.3"
   s.summary = "A simple Ruby client for the algolia.com REST API"
 
   if s.respond_to? :specification_version then

data/lib/algolia/index.rb

@@ -208,9 +208,23 @@ 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
     
+    #
+    # Delete an object from the index and wait end of indexing
+    # 
+    # @param objectID the unique identifier of object to delete
+    #
+    def delete_object!(objectID)
+      res = delete_object(objectID)
+      wait_task(res["taskID"])
+      return res
+    end
+    
     #
     # Set settings for this index
     # 

metadata

@@ -1,94 +1,135 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: algoliasearch
-version: !ruby/object:Gem::Version 
-  version: 1.0.0
+version: !ruby/object:Gem::Version
+  version: 1.0.2
 platform: ruby
-authors: 
+authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-08-05 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: curb
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - &id002 
-      - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id002
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: jeweler
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id002
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: test-unit
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id002
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id002
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: shoulda-context
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id002
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: webmock
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id002
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: redgreen
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id002
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redgreen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id009
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A simple Ruby client for the algolia.com REST API
 email: contact@algolia.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
 - README.md
-files: 
-- contacts.json
+files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -96,33 +137,34 @@ files:
 - Rakefile
 - VERSION
 - algoliasearch.gemspec
+- contacts.json
 - lib/algolia/client.rb
 - lib/algolia/error.rb
 - lib/algolia/index.rb
 - lib/algolia/protocol.rb
 - lib/algoliasearch.rb
 homepage: http://github.com/algolia/algoliasearch-client-ruby
-licenses: 
+licenses:
 - MIT
 metadata: {}
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id002
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id002
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.3
 signing_key: 
 specification_version: 4
 summary: A simple Ruby client for the algolia.com REST API
 test_files: []
-