algoliasearch 1.2.11 → 1.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 128d59909c267e976baa312097edd9519eb92a6f
-  data.tar.gz: e770982f18181545c66310809c06998401f61ac7
+  metadata.gz: ce03495d8a65c3fc3df2ecce17d405ea3b06ec10
+  data.tar.gz: ce3aca4b079c7ae6c904bc72ed8a717e4d6d052f
 SHA512:
-  metadata.gz: df02e9a483a05a462ee68994d8dfb90021540e85da394805906481126730c3b402b3fb409c4dbcf973b05def05ed8c363208d5838a2cc3ae8535982903f31528
-  data.tar.gz: 76d1f9897e16c3c919e8db4cf508eaff64f92b04bba77f87cd974d7d544c7aff6eef2c3d8b3acfdd6e5a4fe287466ab6d840368b00b363ec8bed6e2e169dc1fb
+  metadata.gz: 496951be33beaee2a259bdacd641774f7718644ac5f36b2d70b71420e715db3f6db3341de6ff8a955224cf46e184f13421ab3d26a76765a747f88526001ce5b9
+  data.tar.gz: 782d7260a5083a9d2c34006694cd94d393f8ec658a20fd209eca9b352a286df0cd081f46c179e4578f2d01a4e6c34a32aa5664dae79bb45e8522f77a06384699

data/ChangeLog

@@ -1,5 +1,14 @@
 CHANGELOG
 
+2014-10-08  1.2.12
+
+      * Upgrade to httpclient 2.4
+      * Do not reset the timeout on each requests
+
+2014-09-14  1.2.11
+
+      * Ability to update API keys
+
 2014-08-22  1.2.10
 
       * Using Digest to remove "Digest::Digest is deprecated; Use Digest" warning (author: @dglancy)

data/Gemfile

@@ -1,6 +1,6 @@
 source 'http://rubygems.org'
 
-gem 'httpclient', '~> 2.3'
+gem 'httpclient', '~> 2.4'
 gem 'json', '>= 1.5.1'
 gem 'rubysl', '~> 2.0', :platform => :rbx
 

data/Gemfile.lock

@@ -37,7 +37,7 @@ GEM
       net-http-persistent (>= 2.7)
       net-http-pipeline
     highline (1.6.21)
-    httpclient (2.3.4.1)
+    httpclient (2.4.0)
     json (1.8.1)
     json (1.8.1-java)
     launchy (2.4.2)
@@ -325,7 +325,7 @@ DEPENDENCIES
   autotest-fsevent
   autotest-growl
   coveralls
-  httpclient (~> 2.3)
+  httpclient (~> 2.4)
   json (>= 1.5.1)
   mime-types (< 2.0)
   rake

data/README.md

@@ -148,6 +148,8 @@ puts index.search('jim').to_json
 
 
 
+
+
 Documentation
 ================
 
@@ -255,10 +257,10 @@ You can use the following optional arguments:
   * **prefixAll**: all query words are interpreted as prefixes,
   * **prefixLast**: only the last word is interpreted as a prefix (default behavior),
   * **prefixNone**: no query word is interpreted as a prefix. This option is not recommended.
- * **removeWordsIfNoResult**: This option to select a strategy to avoid having an empty result page. There is three different option:
-  * **LastWords**: when a query does not return any result, the last word will be added as optional (the process is repeated with n-1 word, n-2 word, ... until there is results),
-  * **FirstWords**: when a query does not return any result, the first word will be added as optional (the process is repeated with second word, third word, ... until there is results),
-  * **None**: No specific processing is done when a query does not return any result (default behavior).
+ * **removeWordsIfNoResults**: This option to select a strategy to avoid having an empty result page. There is three different option:
+  * **lastWords**: when a query does not return any result, the last word will be added as optional (the process is repeated with n-1 word, n-2 word, ... until there is results),
+  * **firstWords**: when a query does not return any result, the first word will be added as optional (the process is repeated with second word, third word, ... until there is results),
+  * **none**: No specific processing is done when a query does not return any result (default behavior).
  * **typoTolerance**: if set to false, disable the typo-tolerance. Defaults to true.
  * **minWordSizefor1Typo**: the minimum number of characters in a query word to accept one typo in this word.<br/>Defaults to 4.
  * **minWordSizefor2Typos**: the minimum number of characters in a query word to accept two typos in this word.<br/>Defaults to 8.

data/algoliasearch.gemspec

@@ -6,12 +6,12 @@
 
 Gem::Specification.new do |s|
   s.name = "algoliasearch"
-  s.version = "1.2.11"
+  s.version = "1.2.12"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Algolia"]
-  s.date = "2014-08-22"
+  s.date = "2014-10-08"
   s.description = "A simple Ruby client for the algolia.com REST API"
   s.email = "contact@algolia.com"
   s.extra_rdoc_files = [

data/lib/algolia/client.rb

@@ -36,9 +36,9 @@ module Algolia
     # and will return the parsed JSON body on success, if there is one.
     def request(uri, method, data = nil, timeout = nil)
       exceptions = []
-      thread_local_hosts.each do |host|
+      thread_local_hosts(timeout).each do |host|
         begin
-          return perform_request(host[:session], host[:base_url] + uri, method, data, timeout)
+          return perform_request(host[:session], host[:base_url] + uri, method, data)
         rescue AlgoliaProtocolError => e
           raise if e.code != Protocol::ERROR_TIMEOUT and e.code != Protocol::ERROR_UNAVAILABLE
           exceptions << e
@@ -58,55 +58,57 @@ module Algolia
     end
 
     def put(uri, body = {}, timeout = nil)
-      request(uri, :PUT, body)
+      request(uri, :PUT, body, timeout)
     end
 
     def delete(uri, timeout = nil)
-      request(uri, :DELETE)
+      request(uri, :DELETE, nil, timeout)
     end
 
     private
 
-    # this method returns a thread-local array of sessions
-    def thread_local_hosts
-      Thread.current[:algolia_hosts] ||= hosts.map do |host|
+    # This method returns a thread-local array of sessions
+    # 
+    # Since the underlying httpclient library resets the connections pool
+    # if you change any of its attributes, we cannot change the timeout
+    # of an HTTP session dynamically. That being said, having 1 pool per
+    # timeout appears to be the only acceptable solution
+    def thread_local_hosts(forced_timeout)
+      Thread.current[:algolia_hosts] ||= {}
+      Thread.current[:algolia_hosts][forced_timeout.to_s] ||= hosts.map do |host|
         hinfo = {
           :base_url => "http#{@ssl ? 's' : ''}://#{host}",
           :session => HTTPClient.new
         }
         hinfo[:session].transparent_gzip_decompression = true
         hinfo[:session].connect_timeout = @connect_timeout if @connect_timeout
-        hinfo[:session].send_timeout = @send_timeout if @send_timeout
-        hinfo[:session].receive_timeout = @receive_timeout if @receive_timeout
+        if forced_timeout
+          hinfo[:session].send_timeout = hinfo[:session].receive_timeout = forced_timeout
+        else
+          hinfo[:session].send_timeout = @send_timeout if @send_timeout
+          hinfo[:session].receive_timeout = @receive_timeout if @receive_timeout
+        end
         hinfo[:session].ssl_config.add_trust_ca File.join(File.dirname(__FILE__), '..', '..', 'resources', 'ca-bundle.crt')
         hinfo
       end
     end
 
     private
-    def perform_request(session, url, method, data, timeout)
-      original_send_timeout = session.send_timeout
-      original_receive_timeout = session.receive_timeout
-      begin
-        session.send_timeout = session.receive_timeout = timeout if timeout
-        response = case method
-        when :GET
-          session.get(url, { :header => @headers })
-        when :POST
-          session.post(url, { :body => data, :header => @headers })
-        when :PUT
-          session.put(url, { :body => data, :header => @headers })
-        when :DELETE
-          session.delete(url, { :header => @headers })
-        end
-        if response.code >= 400 || response.code < 200
-          raise AlgoliaProtocolError.new(response.code, "Cannot #{method} to #{url}: #{response.content} (#{response.code})")
-        end
-        return JSON.parse(response.content)
-      ensure
-        session.send_timeout = original_send_timeout
-        session.receive_timeout = original_receive_timeout
+    def perform_request(session, url, method, data)
+      response = case method
+      when :GET
+        session.get(url, { :header => @headers })
+      when :POST
+        session.post(url, { :body => data, :header => @headers })
+      when :PUT
+        session.put(url, { :body => data, :header => @headers })
+      when :DELETE
+        session.delete(url, { :header => @headers })
+      end
+      if response.code >= 400 || response.code < 200
+        raise AlgoliaProtocolError.new(response.code, "Cannot #{method} to #{url}: #{response.content} (#{response.code})")
       end
+      return JSON.parse(response.content)
     end
 
   end
@@ -347,7 +349,7 @@ module Algolia
 
   # Used mostly for testing. Lets you delete the api key global vars.
   def Algolia.destroy
-    @@client = nil
+    @@client = Thread.current[:algolia_hosts] = nil
     self
   end
 

data/lib/algolia/version.rb

@@ -1,3 +1,3 @@
 module Algolia
-  VERSION = "1.2.11"
+  VERSION = "1.2.12"
 end

data/spec/client_spec.rb

@@ -614,13 +614,13 @@ describe 'Client' do
 
   it 'should generate secured api keys' do
     key = Algolia.generate_secured_api_key('my_api_key', '(public,user1)')
-    key.should eq(OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha256'), 'my_api_key', '(public,user1)'))
+    key.should eq(OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), 'my_api_key', '(public,user1)'))
     key = Algolia.generate_secured_api_key('my_api_key', '(public,user1)', 42)
-    key.should eq(OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha256'), 'my_api_key', '(public,user1)42'))
+    key.should eq(OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), 'my_api_key', '(public,user1)42'))
     key = Algolia.generate_secured_api_key('my_api_key', ['public'])
-    key.should eq(OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha256'), 'my_api_key', 'public'))
+    key.should eq(OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), 'my_api_key', 'public'))
     key = Algolia.generate_secured_api_key('my_api_key', ['public', ['premium','vip']])
-    key.should eq(OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha256'), 'my_api_key', 'public,(premium,vip)'))
+    key.should eq(OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), 'my_api_key', 'public,(premium,vip)'))
   end 
 
   it 'Check attributes multipleQueries' do

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch
 version: !ruby/object:Gem::Version
-  version: 1.2.11
+  version: 1.2.12
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-22 00:00:00.000000000 Z
+date: 2014-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.1
 - !ruby/object:Gem::Dependency
   name: travis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   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
@@ -89,8 +89,8 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
-- .rspec
-- .travis.yml
+- ".rspec"
+- ".travis.yml"
 - ChangeLog
 - Gemfile
 - Gemfile.lock
@@ -121,17 +121,17 @@ require_paths:
 - lib
 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.4.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A simple Ruby client for the algolia.com REST API