algoliasearch 1.8.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac8623995ca3e9c6b72fe9fbd383b5299bab50bb
-  data.tar.gz: bd8674170dc90b586d95b84f464821e81c2557e0
+  metadata.gz: 249bdbdfe9306f6396363418d097060519a2b666
+  data.tar.gz: 29cd2a19ac2652eb9b19ec9a6e1a4e74aa9d6faf
 SHA512:
-  metadata.gz: e8ad094f497aa8055eaafb7b16404112c150da2d561a9d1eb47e3211b61ebc9594b52d146032032454930e9a98e3a305cea0f1b351c2efb09628527e50f02700
-  data.tar.gz: 6ab947d1f2ab8c2cb4d018e2333f8ae7dbb18dd021e4f320cb93a307042b228050cc4a2f162fa02a75ed06e0cffd50420e4ec1f3d8893bb6238f1fe8e9e4ace1
+  metadata.gz: c5fdf482ba1c5734c95009719c836132b7e1e18d810a7959d6d48bd767669648e8d75221103f2080359cbe8d611c17575b42da65ddfc60b22ed76a1a0e88e4ce
+  data.tar.gz: c1ddb83fbc011fb659831ba67545d7ed2b65ed8d2320fc16f76749d46a097a7cc22b92e44908eff216d636ecdf3f0d49b3f43ac9178f72a65dc1d5b0eba03e35

data/ChangeLog

@@ -1,5 +1,8 @@
 CHANGELOG
 
+2016-04-14 1.8.1
+      * Ensure we're using an absolute path for the `ca-bundle.crt` file (could fix some `OpenSSL::X509::StoreError: system lib` errors)
+
 2016-04-06 1.8.0
       * Upgraded to httpclient 2.7.1 (includes ruby 2.3.0 deprecation fixes)
       * Upgraded WebMock URLs

data/README.md

@@ -51,9 +51,9 @@ Table of Contents
 1. [Clear an index](#clear-an-index)
 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. [Backup / Retrieve all index content](#backup--retrieve-of-all-index-content)
+1. [Copy / Move an index](#copy--move-an-index)
+1. [Backup / Export an index](#backup--export-an-index)
+1. [API Keys](#api-keys)
 1. [Logs](#logs)
 1. [Mock](#mock)
 
@@ -1907,14 +1907,65 @@ The attribute **action** can have these values:
 - partialUpdateObjectNoCreate
 - deleteObject
 
-Security / User API Keys
+Copy / Move an index
+==================
+
+You can easily copy or rename an existing index using the `copy` and `move` commands.
+**Note**: Move and copy commands overwrite the 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 if 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 only need to:
+ 1. Import your database into a new index using [batches](#batch-writes). Let's call this new index `MyNewIndex`.
+ 1. Rename `MyNewIndex` to `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 (and overwrite it)
+puts Algolia.move_index("MyNewIndex", "MyIndex")
+```
+
+
+Backup / Export an index
+==================
+
+The `search` method cannot return more than 1,000 results. If you need to
+retrieve all the content of your index (for backup, SEO purposes or for running
+a script on it), you should use the `browse` method instead. This method lets
+you retrieve objects beyond the 1,000 limit.
+
+This method is optimized for speed. To make it fast, distinct, typo-tolerance,
+word proximity, geo distance and number of matched words are disabled. Results
+are still returned ranked by attributes and custom ranking.
+
+
+Example:
+
+```ruby
+# Iterate with a filter over the index
+index.browse({:query => "test", :numericFilters => 'i=42'}) do
+	# Do something
+end
+```
+
+
+
+
+API Keys
 ==================
 
 The ADMIN API key provides full control of all your indices.
 You can also generate user API keys to control security.
 These API keys can be restricted to a set of operations or/and restricted to a given index.
 
-To list existing keys, you can use `list_user_keys` method:
+## List API keys
+
+To list existing keys, you can use:
+
 ```ruby
 # Lists global API Keys
 Algolia.list_user_keys
@@ -1933,7 +1984,10 @@ Each key is defined by a set of permissions that specify the authorized actions.
  * **analytics**: Allowed to retrieve analytics through the analytics API.
  * **listIndexes**: Allowed to list all accessible indexes.
 
-Example of API Key creation:
+## Create API keys
+
+To create API keys:
+
 ```ruby
 # Creates a new global API key that can only perform search actions
 res = Algolia.add_user_key(["search"])
@@ -2087,7 +2141,9 @@ res = Algolia.add_user_key(params)
 puts res['key']
 ```
 
-Update the permissions of an existing key:
+## Update API keys
+
+To update the permissions of an existing key:
 ```ruby
 # Update an existing global API key that is valid for 300 seconds
 res = Algolia.update_user_key("myAPIKey", ["search"], 300)
@@ -2100,7 +2156,7 @@ puts res['key']
 res = index.update_user_key("myAPIKey", ["search"], 300, 100, 20, ['my_index1', 'my_index2'])
 puts res['key']
 ```
-Get the permissions of a given key:
+To get the permissions of a given key:
 ```ruby
 # Gets the rights of a global key
 Algolia.get_user_key("f420238212c54dcfad07ea0aa6d5c45f")
@@ -2108,7 +2164,9 @@ Algolia.get_user_key("f420238212c54dcfad07ea0aa6d5c45f")
 index.get_user_key("71671c38001bf3ac857bc82052485107")
 ```
 
-Delete an existing key:
+## Delete API keys
+
+To delete an existing key:
 ```ruby
 # Deletes a global key
 Algolia.delete_user_key("f420238212c54dcfad07ea0aa6d5c45f")
@@ -2118,7 +2176,9 @@ index.delete_user_key("71671c38001bf3ac857bc82052485107")
 
 
 
-You may have a single index containing per user data. In that case, all records should be tagged with their associated user_id in order to add a `tagFilters=user_42` filter at query time to retrieve only what a user has access to. If you're using the [JavaScript client](http://github.com/algolia/algoliasearch-client-js), it will result in a security breach since the user is able to modify the `tagFilters` you've set by modifying the code from the browser. To keep using the JavaScript client (recommended for optimal latency) and target secured records, you can generate a secured API key from your backend:
+## Secured API keys (frontend)
+
+You may have a single index containing **per user** data. In that case, all records should be tagged with their associated `user_id` in order to add a `tagFilters=user_42` filter at query time to retrieve only what a user has access to. If you're using the [JavaScript client](http://github.com/algolia/algoliasearch-client-js), it will result in a security breach since the user is able to modify the `tagFilters` you've set by modifying the code from the browser. To keep using the JavaScript client (recommended for optimal latency) and target secured records, you can generate a secured API key from your backend:
 
 ```ruby
 # generate a public API key for user 42. Here, records are tagged with:
@@ -2148,7 +2208,7 @@ You can mix rate limits and secured API keys by setting a `userToken` query para
 ```ruby
 # generate a public API key for user 42. Here, records are tagged with:
 #  - 'user_XXXX' if they are visible by user XXXX
-public_key = Algolia.generate_secured_api_key 'YourRateLimitedApiKey', {'tagFilters'=> 'user_42', 'userToken'=> 'user_42'}
+public_key = Algolia.generate_secured_api_key 'YourSearchOnlyApiKey', {'tagFilters'=> 'user_42', 'userToken'=> 'user_42'}
 ```
 
 This public API key can then be used in your JavaScript code as follow:
@@ -2169,54 +2229,6 @@ index.search('another query', function(err, content) {
 ```
 
 
-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 the 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 if 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 only need to:
- 1. Import your database into a new index using [batches](#batch-writes). Let's call this new index `MyNewIndex`.
- 1. Rename `MyNewIndex` to `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 (and overwrite it)
-puts Algolia.move_index("MyNewIndex", "MyIndex")
-```
-
-
-Backup / Retrieve of all index content
-==================
-
-The `search` method cannot return more than 1,000 results. If you need to
-retrieve all the content of your index (for backup, SEO purposes or for running
-a script on it), you should use the `browse` method instead. This method lets
-you retrieve objects beyond the 1,000 limit.
-
-This method is optimized for speed. To make it fast, distinct, typo-tolerance,
-word proximity, geo distance and number of matched words are disabled. Results
-are still returned ranked by attributes and custom ranking.
-
-
-Example:
-
-```ruby
-# Iterate with a filter over the index
-index.browse({:query => "test", :numericFilters => 'i=42'}) do
-	# Do something
-end
-```
-
-
-
-
 Logs
 ==================
 

data/lib/algolia/client.rb

@@ -389,7 +389,7 @@ module Algolia
         hinfo[:session].connect_timeout = connect_timeout
         hinfo[:session].send_timeout = send_timeout
         hinfo[:session].receive_timeout = receive_timeout
-        hinfo[:session].ssl_config.add_trust_ca File.join(File.dirname(__FILE__), '..', '..', 'resources', 'ca-bundle.crt')
+        hinfo[:session].ssl_config.add_trust_ca File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'resources', 'ca-bundle.crt'))
         hinfo
       end
     end

data/lib/algolia/version.rb

@@ -1,3 +1,3 @@
 module Algolia
-  VERSION = "1.8.0"
+  VERSION = "1.8.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.8.1
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-06 00:00:00.000000000 Z
+date: 2016-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -131,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A simple Ruby client for the algolia.com REST API