algoliasearch 1.2.5 → 1.2.7

checksums.yaml

@@ -1,7 +1,7 @@
----
-SHA1:
-  metadata.gz: ffcea70e1e16052463f966167245f0d0412bb1d1
-  data.tar.gz: a37adf050adb92682c8ddd48990b093606ba800d
-SHA512:
-  metadata.gz: fc1fbead2ee31e7e503b7864d7779c9455d99f1925de7f5ca765c0a0229dc0c4b81680a9b814c029a0b06152b8729565dae1f8ecb342a07c46f650771ec4df07
-  data.tar.gz: 79a73010bbaa3b99227c9693ea9f71ba9c6627b02faf4dd4a9f772bef98b0cb9af637e67e65049fa797d056bd22cafa6415b6a28db23164a1810c1e7a3a3288f
+--- 
+SHA1: 
+  data.tar.gz: 9ba635d167f32504ae01cdc6b161bc4af3826321
+  metadata.gz: 779df79fb8ac29c41faa695e8047406997981941
+SHA512: 
+  data.tar.gz: 4af3b2853e4efaa6c2c07b8bad88a257d6e1d138a32e9b97c98f261b0d53d1db9451af9e181bd05af4c8505d8a0a96a3254a042196938ef1f1971ea58bf28531
+  metadata.gz: 15393678441127859332d19835a3a05ac5cebb35fa567c9c9c8325f40818d021bee9fddae90fb924f98b5f80cb78c91e5e8c2f51ce2fa41521d4e3a3d4a7fb8c

data/.travis.yml

@@ -3,6 +3,7 @@ branches:
   only:
   - master
 rvm:
+- 1.8.7
 - 2.1.0
 - 2.0.0
 - 1.9.3

data/ChangeLog

@@ -1,5 +1,16 @@
 CHANGELOG
 
+2014-03-24  1.2.7
+
+      * Ruby 1.8 compatibility
+
+2014-03-19  1.2.6
+
+      * Raise an exception if no APPLICATION_ID is provided
+      * Ability to get last API call errors
+      * Ability to send multiple queries using a single API call
+      * Secured API keys generation is now based on secured HMAC-SHA256
+
 2014-02-24  1.2.5
 
       * Ability to generate secured API key from a list of tags + optional user_token

data/Gemfile

@@ -2,7 +2,7 @@ source 'http://rubygems.org'
 
 gem 'httpclient', '~> 2.3'
 gem 'json', '>= 1.5.1'
-gem 'rubysl', '~> 2.0', platform: :rbx
+gem 'rubysl', '~> 2.0', :platform => :rbx
 
 group :development do
   gem 'coveralls'

data/README.md

@@ -628,6 +628,8 @@ You can retrieve the logs of your last 1000 API calls and browse them using the
 puts Algolia.get_logs.to_json
 # Get last 100 log entries
 puts Algolia.get_logs(0, 100).to_json
+# Get last 100 errors
+puts Algolia.get_logs(0, 100, true).to_json
 ```
 
 Mock

data/algoliasearch.gemspec

@@ -6,12 +6,12 @@
 
 Gem::Specification.new do |s|
   s.name = "algoliasearch"
-  s.version = "1.2.5"
+  s.version = "1.2.7"
 
   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-02-24"
+  s.date = "2014-03-24"
   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

@@ -3,6 +3,7 @@ require 'algolia/error'
 require 'algolia/version'
 require 'json'
 require 'zlib'
+require 'openssl'
 
 module Algolia
 
@@ -111,6 +112,8 @@ module Algolia
     defaulted = { :application_id => application_id, :api_key => api_key }
     defaulted.merge!(options)
 
+    raise ArgumentError.new("No APPLICATION_ID provided, please set :application_id") if defaulted[:application_id].nil?
+
     @@client = Client.new(defaulted)
   end
 
@@ -161,7 +164,23 @@ module Algolia
       tag_filters = tag_filters.map { |t| t.is_a?(Array) ? "(#{t.join(',')})" : t }.join(',')
     end
     raise ArgumentError.new('Attribute "tag_filters" must be a list of tags') if !tag_filters.is_a?(String)
-    Digest::SHA256.hexdigest "#{private_api_key}#{tag_filters}#{user_token.to_s}"
+    OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha256'), private_api_key, "#{tag_filters}#{user_token.to_s}")
+  end
+
+  #
+  # This method allows to query multiple indexes with one API call
+  # 
+  # @param queries the array of hash representing the query and associated index name
+  # @param index_name_key the name of the key used to fetch the index_name (:index_name by default)
+  #
+  def Algolia.multiple_queries(queries, index_name_key = :index_name)
+    requests = {
+      :requests => queries.map do |query|
+        indexName = query.delete(index_name_key) || query.delete(index_name_key.to_s)
+        { :indexName => indexName, :params => Protocol.to_query(query) }
+      end
+    }
+    Algolia.client.post(Protocol.multiple_queries_uri, requests.to_json)
   end
 
   #
@@ -200,8 +219,8 @@ module Algolia
   # @param offset Specify the first entry to retrieve (0-based, 0 is the most recent log entry).
   # @param length Specify the maximum number of entries to retrieve starting at offset. Maximum allowed value: 1000.
   #
-  def Algolia.get_logs(offset = 0, length = 10)
-      Algolia.client.get(Protocol.logs(offset, length))
+  def Algolia.get_logs(offset = 0, length = 10, only_errors = false)
+      Algolia.client.get(Protocol.logs(offset, length, only_errors))
   end
 
   # List all existing user keys with their associated ACLs

data/lib/algolia/index.rb

@@ -277,7 +277,7 @@ module Algolia
     #
     def delete_objects(objs)
       check_array objs
-      batch build_batch('deleteObject', objs.map { |objectID| { objectID: objectID } }, false)
+      batch build_batch('deleteObject', objs.map { |objectID| { :objectID => objectID } }, false)
     end
 
     #

data/lib/algolia/protocol.rb

@@ -38,6 +38,10 @@ module Algolia
       "/#{VERSION}/indexes"
     end
 
+    def Protocol.multiple_queries_uri
+      "/#{VERSION}/indexes/*/queries"
+    end
+
     # Construct a uri referencing a given Algolia index
     def Protocol.index_uri(index)
       "/#{VERSION}/indexes/#{CGI.escape(index)}"
@@ -82,8 +86,8 @@ module Algolia
       "#{index_uri(index)}/clear"
     end
     
-    def Protocol.logs(offset, length)
-      "/#{VERSION}/logs?offset=#{offset}&length=#{length}"
+    def Protocol.logs(offset, length, only_errors = false)
+      "/#{VERSION}/logs?offset=#{offset}&length=#{length}&onlyErrors=#{only_errors}"
     end
 
     def Protocol.keys_uri
@@ -102,7 +106,6 @@ module Algolia
       "#{index_uri(index)}/keys"
     end
 
-    private
     def Protocol.to_query(params)
       params.map do |k, v|
         "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"

data/lib/algolia/version.rb

@@ -1,3 +1,3 @@
 module Algolia
-  VERSION = "1.2.5"
+  VERSION = "1.2.7"
 end

data/spec/client_spec.rb

@@ -8,7 +8,7 @@ def safe_index_name(name)
   "#{name}_travis-#{id}"
 end
 
-def is_present(array, attr, value)
+def is_include(array, attr, value)
   array.each do |elt|
     if elt[attr] == value
       return true
@@ -81,11 +81,11 @@ describe 'Client' do
     expect { @index.add_objects!([ [ {:name => "test"} ] ]) }.to raise_error(ArgumentError)
     expect { @index.save_object(1) }.to raise_error(ArgumentError)
     expect { @index.save_object("test") }.to raise_error(ArgumentError)
-    expect { @index.save_object({ objectID: 42 }.to_json) }.to raise_error(ArgumentError)
+    expect { @index.save_object({ :objectID => 42 }.to_json) }.to raise_error(ArgumentError)
     expect { @index.save_objects([{}, ""]) }.to raise_error(ArgumentError)
     expect { @index.save_objects([1]) }.to raise_error(ArgumentError)
     expect { @index.save_objects!([1]) }.to raise_error(ArgumentError)
-    expect { @index.save_object({ foo: 42 }) }.to raise_error(ArgumentError) # missing objectID
+    expect { @index.save_object({ :foo => 42 }) }.to raise_error(ArgumentError) # missing objectID
   end
 
   it "should be thread safe" do
@@ -130,10 +130,10 @@ describe 'Client' do
       # friends_2 does not exist
     end
     res = Algolia.list_indexes
-    is_present(res['items'], 'name', safe_index_name('àlgol?a')).should eq(false)
+    is_include(res['items'], 'name', safe_index_name('àlgol?a')).should eq(false)
     index.add_object!({ :name => "Robert" })
     resAfter = Algolia.list_indexes;
-    is_present(resAfter['items'], 'name', safe_index_name('àlgol?a')).should eq(true)
+    is_include(resAfter['items'], 'name', safe_index_name('àlgol?a')).should eq(true)
   end
 
   it "should get a object" do
@@ -214,14 +214,20 @@ describe 'Client' do
   end 
 
   it "should get logs" do
-    host = Algolia.client.send(:thread_local_hosts).first
-    puts host[:session].get(host[:base_url] + Algolia::Protocol.logs(0, 10), { :header => Algolia.client.headers }).content
-
     res = Algolia.get_logs
 
     res['logs'].size.should > 0
   end
 
+  it "should search on multipleIndex" do
+    @index.add_object!({ :name => "John Doe", :email => "john@doe.org" }, "1")
+    res = Algolia.multiple_queries([{:index_name => safe_index_name("àlgol?a"), "query" => ""}])
+    res["results"][0]["hits"].length.should eq(1)
+
+    res = Algolia.multiple_queries([{"indexName" => safe_index_name("àlgol?a"), "query" => ""}], "indexName")
+    res["results"][0]["hits"].length.should eq(1)
+  end
+
   it "shoud accept custom batch" do
     @index.clear_index! rescue "Not fatal"
     request = { "requests" => [
@@ -259,31 +265,31 @@ describe 'Client' do
     @index.add_object!({ :name => "P4", :_tags => "t3" })
     @index.add_object!({ :name => "P5", :_tags => ["t3", "t4"] })
 
-    @index.search("", { tagFilters: ["t1"] })['hits'].length.should eq(2)         # t1
-    @index.search("", { tagFilters: ["t1", "t2"] })['hits'].length.should eq(0)   # t1 AND t2
-    @index.search("", { tagFilters: ["t3", "t4"] })['hits'].length.should eq(1)   # t3 AND t4
-    @index.search("", { tagFilters: [["t1", "t2"]] })['hits'].length.should eq(3) # t1 OR t2
+    @index.search("", { :tagFilters => ["t1"] })['hits'].length.should eq(2)         # t1
+    @index.search("", { :tagFilters => ["t1", "t2"] })['hits'].length.should eq(0)   # t1 AND t2
+    @index.search("", { :tagFilters => ["t3", "t4"] })['hits'].length.should eq(1)   # t3 AND t4
+    @index.search("", { :tagFilters => [["t1", "t2"]] })['hits'].length.should eq(3) # t1 OR t2
   end
 
   it "should be facetable" do
     @index.clear!
-    @index.set_settings( { attributesForFacetting: ["f", "g"] })
+    @index.set_settings( { :attributesForFacetting => ["f", "g"] })
     @index.add_object!({ :name => "P1", :f => "f1", :g => "g1" })
     @index.add_object!({ :name => "P2", :f => "f1", :g => "g2" })
     @index.add_object!({ :name => "P3", :f => "f2", :g => "g2" })
     @index.add_object!({ :name => "P4", :f => "f3", :g => "g2" })
 
-    res = @index.search("", { facets: "f" })
+    res = @index.search("", { :facets => "f" })
     res['facets']['f']['f1'].should eq(2)
     res['facets']['f']['f2'].should eq(1)
     res['facets']['f']['f3'].should eq(1)
 
-    res = @index.search("", { facets: "f", facetFilters: ["f:f1"] })
+    res = @index.search("", { :facets => "f", :facetFilters => ["f:f1"] })
     res['facets']['f']['f1'].should eq(2)
     res['facets']['f']['f2'].should be_nil
     res['facets']['f']['f3'].should be_nil
 
-    res = @index.search("", { facets: "f", facetFilters: ["f:f1", "g:g2"] })
+    res = @index.search("", { :facets => "f", :facetFilters => ["f:f1", "g:g2"] })
     res['facets']['f']['f1'].should eq(1)
     res['facets']['f']['f2'].should be_nil
     res['facets']['f']['f3'].should be_nil
@@ -294,26 +300,28 @@ describe 'Client' do
     newIndexKey = @index.add_user_key(['search'])
     newIndexKey['key'].should_not eq("")
     resIndexAfter = @index.list_user_keys
-    resIndex['keys'].size.should eq(resIndexAfter['keys'].size - 1)
+    is_include(resIndex['keys'], 'value', newIndexKey['key']).should eq(false)
+    is_include(resIndexAfter['keys'], 'value', newIndexKey['key']).should eq(true)
     indexKey = @index.get_user_key(newIndexKey['key'])
     indexKey['acl'][0].should eq('search')
     @index.delete_user_key(newIndexKey['key'])
     sleep 1 # Dirty but temporary
     resIndexEnd = @index.list_user_keys
-    resIndex['keys'].size.should eq(resIndexEnd['keys'].size)
+    is_include(resIndexEnd['keys'], 'value', newIndexKey['key']).should eq(false)
 
 
     res = Algolia.list_user_keys
     newKey = Algolia.add_user_key(['search'])
     newKey['key'].should_not eq("")
     resAfter = Algolia.list_user_keys
-    res['keys'].size.should eq(resAfter['keys'].size - 1)
+    is_include(res['keys'], 'value', newKey['key']).should eq(false)
+    is_include(resAfter['keys'], 'value', newKey['key']).should eq(true)
     key = Algolia.get_user_key(newKey['key'])
     key['acl'][0].should eq('search')
     Algolia.delete_user_key(newKey['key'])
     sleep 1 # Dirty but temporary
     resEnd = Algolia.list_user_keys
-    res['keys'].size.should eq(resEnd['keys'].size)
+    is_include(resEnd['keys'], 'value', newKey['key']).should eq(false)
 
     
   end
@@ -567,12 +575,34 @@ describe 'Client' do
 
   it 'should generate secured api keys' do
     key = Algolia.generate_secured_api_key('my_api_key', '(public,user1)')
-    key.should eq(Digest::SHA256.hexdigest 'my_api_key(public,user1)')
+    key.should eq(OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha256'), 'my_api_key', '(public,user1)'))
     key = Algolia.generate_secured_api_key('my_api_key', '(public,user1)', 42)
-    key.should eq(Digest::SHA256.hexdigest 'my_api_key(public,user1)42')
+    key.should eq(OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha256'), 'my_api_key', '(public,user1)42'))
     key = Algolia.generate_secured_api_key('my_api_key', ['public'])
-    key.should eq(Digest::SHA256.hexdigest 'my_api_keypublic')
+    key.should eq(OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha256'), 'my_api_key', 'public'))
     key = Algolia.generate_secured_api_key('my_api_key', ['public', ['premium','vip']])
-    key.should eq(Digest::SHA256.hexdigest 'my_api_keypublic,(premium,vip)')
+    key.should eq(OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('sha256'), 'my_api_key', 'public,(premium,vip)'))
+  end 
+
+  it 'Check attributes multipleQueries' do
+    res = Algolia.multiple_queries([{:index_name => safe_index_name("àlgol?a"), "query" => ""}])
+    res.should have_key('results')
+    res['results'].should be_a(Array)
+    res['results'][0].should have_key('hits')     
+    res['results'][0]['hits'].should be_a(Array)
+    res['results'][0].should have_key('page')     
+    res['results'][0]['page'].should be_a(Integer)     
+    res['results'][0].should have_key('nbHits')     
+    res['results'][0]['nbHits'].should be_a(Integer)     
+    res['results'][0].should have_key('nbPages')     
+    res['results'][0]['nbPages'].should be_a(Integer)     
+    res['results'][0].should have_key('hitsPerPage')     
+    res['results'][0]['hitsPerPage'].should be_a(Integer)     
+    res['results'][0].should have_key('processingTimeMS')     
+    res['results'][0]['processingTimeMS'].should be_a(Integer)     
+    res['results'][0].should have_key('query')     
+    res['results'][0]['query'].should be_a(String)     
+    res['results'][0].should have_key('params')     
+    res['results'][0]['params'].should be_a(String)  
   end
 end

data/spec/spec_helper.rb

@@ -4,7 +4,7 @@ if ENV['COVERAGE']
     SimpleCov.start
 end
 
-if ENV['TRAVIS'] && RUBY_ENGINE == "ruby"
+if ENV['TRAVIS'] && Object.const_defined?(:RUBY_ENGINE) && RUBY_ENGINE == "ruby"
   require 'coveralls'
   Coveralls.wear!
 end

metadata

@@ -1,94 +1,74 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: algoliasearch
-version: !ruby/object:Gem::Version
-  version: 1.2.5
+version: !ruby/object:Gem::Version 
+  version: 1.2.7
 platform: ruby
-authors:
+authors: 
 - Algolia
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-24 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2014-03-24 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: httpclient
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.3'
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.3'
   prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.3"
   type: :runtime
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: json
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.5.1
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.5.1
   prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
   type: :runtime
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: travis
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id004 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :development
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: rake
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id004
   type: :development
-- !ruby/object:Gem::Dependency
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
   name: rdoc
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id004
   type: :development
+  version_requirements: *id006
 description: A simple Ruby client for the algolia.com REST API
 email: contact@algolia.com
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - ChangeLog
 - LICENSE.txt
 - README.md
-files:
+files: 
 - .rspec
 - .travis.yml
 - ChangeLog
@@ -112,27 +92,27 @@ files:
 - spec/spec_helper.rb
 - spec/stub_spec.rb
 homepage: http://github.com/algolia/algoliasearch-client-ruby
-licenses:
+licenses: 
 - MIT
 metadata: {}
-post_install_message:
+
+post_install_message: 
 rdoc_options: []
-require_paths:
+
+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'
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id004
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id004
 requirements: []
-rubyforge_project:
-rubygems_version: 2.2.1
-signing_key:
+
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
 specification_version: 4
 summary: A simple Ruby client for the algolia.com REST API
 test_files: []
+