algoliasearch 1.1.5 → 1.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dccd32ef275f4ebd7fd41df137127f959dfc82f1
-  data.tar.gz: 67b06daa971904e9528f3211b651f8f9d07d2578
+  metadata.gz: 41cdb9e15fe44adcea0c9c9d2fd06b42284ee323
+  data.tar.gz: c744385715e62c575ca066f3e01c9ac9d9fffa61
 SHA512:
-  metadata.gz: 73a1ac9d5f6a11d35b8bce3275982d01691bd2a38f65a3e48ade5c8bfc4ee4e48e729b946557b76a0cc2aa0a17414786a48d54b15ae2927880871e75c8ccb652
-  data.tar.gz: 763ab359f9c29009c182872c21616ad4403854caa4fa8cca3610a34f14524a86b7585023035020bdcad8b1c95987a7c000d7d0e9f44794d86b07144e5e226c8d
+  metadata.gz: 49577f70778667287e47dd77691a247c475fd85448562a65d6bb5d457a31bf0966c82a8e48d67cfe2cb8af465b8a3c4089e928aaab58088f37ca66cf83be766b
+  data.tar.gz: 934a7181e7815c046c362bf44f38f37a30d1c12a2a729e2555e62f37f17e64c6d453fe9581989d7db5e213c8ff6f9c0b55349e86f775b963a36faec1ed49a81d

data/ChangeLog

@@ -1,5 +1,10 @@
 CHANGELOG
 
+2013-11-07  1.1.6
+
+      * Index: clear and clear! methods can now be used the delete the whole content of an index
+      * User keys: plug new maxQueriesPerIPPerHour and maxHitsPerQuery parameters
+
 2013-10-17  1.1.5
 
       * Version is now part of the user-agent

data/README.md

@@ -405,15 +405,20 @@ Copy or rename an index
 You can easily copy or rename an existing index using the `copy` and `move` commands.
 **Note**: Move and copy commands overwrite destination index.
 
+```ruby
+# Rename MyIndex in MyIndexNewName
+puts Algolia.move_index("MyIndex", "MyIndexNewName")
+# Copy MyIndex in MyIndexCopy
+puts Algolia.copy_index("MyIndex", "MyIndexCopy")
+```
+
 The move command is particularly useful is you want to update a big index atomically from one version to another. For example, if you recreate your index `MyIndex` each night from a database by batch, you just have to:
  1. Import your database in a new index using [batches](#batch-writes). Let's call this new index `MyNewIndex`.
  1. Rename `MyNewIndex` in `MyIndex` using the move command. This will automatically override the old index and new queries will be served on the new one.
 
 ```ruby
-# Rename MyNewIndex in MyIndex
+# Rename MyNewIndex in MyIndex (and overwrite it)
 puts Algolia.move_index("MyNewIndex", "MyIndex")
-# Copy MyNewIndex in MyIndex
-puts Algolia.copy_index("MyNewIndex", "MyIndex")
 ```
 
 Logs

data/Rakefile

@@ -11,7 +11,7 @@ rescue Bundler::BundlerError => e
 end
 require 'rake'
 
-require File.join(__FILE__, '..', 'lib', 'algolia', 'version')
+require File.expand_path('../lib/algolia/version', __FILE__)
 
 require 'jeweler'
 Jeweler::Tasks.new do |gem|

data/algoliasearch.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "algoliasearch"
-  s.version = "1.1.5"
+  s.version = "1.1.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Algolia"]
-  s.date = "2013-10-17"
+  s.date = "2013-11-07"
   s.description = "A simple Ruby client for the algolia.com REST API"
   s.email = "contact@algolia.com"
   s.extra_rdoc_files = [
@@ -40,7 +40,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.3"
+  s.rubygems_version = "2.0.12"
   s.summary = "A simple Ruby client for the algolia.com REST API"
 
   if s.respond_to? :specification_version then

data/lib/algolia/client.rb

@@ -175,9 +175,11 @@ module Algolia
   #           - settings : allows to get index settings (https only)
   #           - editSettings : allows to change index settings (https only)
   #  @param validity the number of seconds after which the key will be automatically removed (0 means no time limit for this key)
+  #  @param maxQueriesPerIPPerHour the maximum number of API calls allowed from an IP address per hour (0 means unlimited)
+  #  @param maxHitsPerQuery  the maximum number of hits this API key can retrieve in one call (0 means unlimited)
   #
-  def Algolia.add_user_key(acls, validity = 0)
-      Algolia.client.post(Protocol.keys_uri, {"acl" => acls, "validity" => validity}.to_json)
+  def Algolia.add_user_key(acls, validity = 0, maxQueriesPerIPPerHour = 0, maxHitsPerQuery = 0)
+      Algolia.client.post(Protocol.keys_uri, {"acl" => acls, "validity" => validity.to_i, "maxQueriesPerIPPerHour" => maxQueriesPerIPPerHour.to_i, "maxHitsPerQuery" => maxHitsPerQuery.to_i}.to_json)
   end
 
   # Delete an existing user key

data/lib/algolia/index.rb

@@ -231,6 +231,23 @@ module Algolia
       wait_task(res["taskID"])
       return res
     end
+
+    #
+    # Delete the index content
+    # 
+    #
+    def clear
+      Algolia.client.post(Protocol.clear_uri(name), nil)
+    end
+    
+    #
+    # Delete the index content and wait end of indexing
+    #
+    def clear!
+      res = clear
+      wait_task(res["taskID"])
+      return res
+    end
     
     #
     # Set settings for this index

data/lib/algolia/protocol.rb

@@ -69,6 +69,10 @@ module Algolia
       "#{index_uri(index)}/settings"
     end
     
+    def Protocol.clear_uri(index)
+      "#{index_uri(index)}/clear"
+    end
+    
     def Protocol.logs(offset, length)
       "/#{VERSION}/logs?offset=#{offset}&length=#{length}"
     end

data/lib/algolia/version.rb

@@ -1,3 +1,3 @@
 module Algolia
-  VERSION = "1.1.5"
+  VERSION = "1.1.6"
 end

data/spec/client_spec.rb

@@ -40,4 +40,9 @@ describe 'Client' do
     threads.each { |t| t.join }
   end
 
+  it "should clear the index" do
+    @index.clear!
+    @index.search("")["hits"].length.should eq(0)
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.1.6
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-17 00:00:00.000000000 Z
+date: 2013-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curb
@@ -113,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.12
 signing_key: 
 specification_version: 4
 summary: A simple Ruby client for the algolia.com REST API