algoliasearch 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA1: 
-  data.tar.gz: a974ff4aaf5416cf977a4e78115b0a7b84c850ce
-  metadata.gz: dbaece1db314ffe49265c381ceb4f41bb746fc52
-SHA512: 
-  data.tar.gz: c4961df560776a7478ba656733e9b6fb5273739c6f0331e2f4d10965e27098a5e1f5bfe860099a6e03e1ebee948d5fda802be93828fd83d7ca7e20edc94739e0
-  metadata.gz: 4db8478142afde6195bf9b61f569be4a02c0bd09d828decaf4a3ed6632495d7508652bdb33168b6f2078c433a542a59033008678b15258e4fec4b2c5de6c4abd
+---
+SHA1:
+  metadata.gz: c145379f798d496330164e5642604b8922cbe13c
+  data.tar.gz: f35c8286d93ff3ddd4cc711e4986de2b0ab94799
+SHA512:
+  metadata.gz: 2d97e9777527d24920d9083c9a85e0e0226c4711ecf9a9159d54b0436c7f9f6be5796dbca83ddc672aa397eed1002647cfed3ba597876eb4425f3151be515219
+  data.tar.gz: 6770a224524fed3eae61300e24e33bc44c98ce01d84de13dbf048a1b228550edd2c88424764552a1cab17bf3b665514143b7bce1dc8ebe28f73611499394da35

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.3)
+      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

@@ -24,6 +24,8 @@ Table of Content
 1. [Wait indexing](#wait-indexing)
 1. [Batch writes](#batch-writes)
 1. [Security / User API Keys](#security--user-api-keys)
+1. [Copy or rename an index](#copy-or-rename-an-index)
+1. [Logs](#logs)
 
 Setup
 -------------
@@ -100,6 +102,8 @@ You can use the following optional arguments:
   * **prefixAll**: all query words are interpreted as prefixes (default behavior).
   * **prefixLast**: only the last word is interpreted as a prefix. This option is recommended if you have a lot of content to speedup the processing.
   * **prefixNone**: no query word is interpreted as a prefix. This option is not recommended.
+ * **numerics**: specify the list of numeric filters you want to apply separated by a comma. The syntax of one filter is `attributeName` followed by `operand` followed by `value`. Supported operands are `<`, `<=`, `=`, `>` and `>=`. 
+ You can have multiple conditions on one attribute like for example `numerics=price>100,price<1000`.
  * **tags**: filter the query by a set of tags. You can AND tags by separating them by commas. To OR tags, you must add parentheses. For example, `tags=tag1,(tag2,tag3)` means *tag1 AND (tag2 OR tag3)*.<br/>At indexing, tags should be added in the _tags attribute of objects (for example `{"_tags":["tag1","tag2"]}` )
 
 ```ruby
@@ -251,7 +255,7 @@ You can retrieve all settings using the `getSettings` function. The result will
  * **attributesToRetrieve**: (array of strings) default list of attributes to retrieve in objects.
  * **attributesToHighlight**: (array of strings) default list of attributes to highlight.
  * **attributesToSnippet**: (array of strings) default list of attributes to snippet alongside the number of words to return (syntax is 'attributeName:nbWords')<br/>By default no snippet is computed.
- * **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:
+ * **attributesToIndex**: (array of strings) the list of fields you want to index.<br/>By default all textual and numerical 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 six available criteria:
@@ -393,3 +397,45 @@ Algolia.delete_user_key("f420238212c54dcfad07ea0aa6d5c45f")
 # Deletes an index specific key
 index.delete_user_key("71671c38001bf3ac857bc82052485107")
 ```
+
+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.
+
+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
+puts Algolia.move_index("MyNewIndex", "MyIndex")
+# Copy MyNewIndex in MyIndex
+puts Algolia.copy_index("MyNewIndex", "MyIndex")
+```
+
+Logs
+-------------
+
+You can retrieve the last logs via this API. Each log entry contains: 
+ * Timestamp in ISO-8601 format
+ * Client IP
+ * Request Headers (API-Key is obfuscated)
+ * Request URL
+ * Request method
+ * Request body
+ * Answer HTTP code
+ * Answer body
+ * SHA1 ID of entry
+
+You can retrieve the logs of your last 1000 API calls and browse them using the offset/length parameters:
+ * ***offset***: Specify the first entry to retrieve (0-based, 0 is the most recent log entry). Default to 0.
+ * ***length***: Specify the maximum number of entries to retrieve starting at offset. Defaults to 10. Maximum allowed value: 1000.
+
+```ruby
+# Get last 10 log entries
+puts Algolia.get_logs.to_json
+# Get last 100 log entries
+puts Algolia.get_logs(0, 100).to_json
+```

data/VERSION

@@ -1 +1 @@
-1.0.2
+1.1.1

data/algoliasearch.gemspec

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

data/lib/algolia/client.rb

@@ -52,7 +52,7 @@ module Algolia
             session.post_body = data
             session.http_post
           when :PUT
-            session.http_put(data)
+            session.put(data)
           when :DELETE
             session.http_delete
           end

data/lib/algolia/index.rb

@@ -76,6 +76,10 @@ module Algolia
     # @param args (optional) if set, contains an associative array with query parameters:
     #  - attributes: a string that contains attribute names to retrieve separated by a comma. 
     #    By default all attributes are retrieved.
+    #  - numerics: specify the list of numeric filters you want to apply separated by a comma. 
+    #    The syntax of one filter is `attributeName` followed by `operand` followed by `value`. 
+    #    Supported operands are `<`, `<=`, `=`, `>` and `>=`. 
+    #    You can have multiple conditions on one attribute like for example `numerics=price>100,price<1000`.
     #  - attributesToHighlight: a string that contains attribute names to highlight separated by a comma. 
     #    By default indexed attributes are highlighted.
     #  - attributesToSnippet: a string that contains the names of attributes to snippet alongside the number 
@@ -238,7 +242,7 @@ module Algolia
     #    of words to return (syntax is 'attributeName:nbWords').
     #    By default no snippet is computed.
     #  - attributesToIndex: (array of strings) the list of fields you want to index. 
-    #    By default all textual attributes of your objects are indexed, but you should update it to get optimal 
+    #    By default all textual and numerical attributes of your objects are indexed, but you should update it to get optimal 
     #    results. This parameter has two important uses:
     #       - Limit the attributes to index. 
     #         For example if you store a binary image in base64, you want to store it in the index but you 

metadata

@@ -1,93 +1,135 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: algoliasearch
-version: !ruby/object:Gem::Version 
-  version: 1.1.0
+version: !ruby/object:Gem::Version
+  version: 1.1.1
 platform: ruby
-authors: 
+authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-09-17 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-10-02 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: 
+files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -102,27 +144,27 @@ files:
 - 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
 signing_key: 
 specification_version: 4
 summary: A simple Ruby client for the algolia.com REST API
 test_files: []
-