algoliasearch 1.21.0 → 1.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 166a052570141d9782b6faed8c7b3731c2d4553d1628e3d7e903bb24edb276d1
-  data.tar.gz: ccb0597728f4b692b8841594a8b42d83f839a22dd1f3abf03e1caf2d52fa266f
+  metadata.gz: 431002a3ec233966b7b7a0507662292938fd09cdbb62d1279d538d2da761ee6f
+  data.tar.gz: 6988bad4c248073ceee35d8ff9c447aeeb97c873e73b1ac41b4ab9b65099fd8c
 SHA512:
-  metadata.gz: 2ed95969c8417cbd9fee0a89600965bf688d8536719ffea8481c31143796a2235b5e441392a69d8e75961e5c3dfabe34c9d6c75f12cdae8a7aac56d5e7327f2c
-  data.tar.gz: b620520144dcf52e870bd07fa1d51a3f227f9cd83e815d183bec770471a56d066afc32e898317ad5e593b5eec10b70f5cbd78d9b04ae25e509d0092a235f0b9d
+  metadata.gz: 6bdc28f6b84c96088f0cddf1f071c68994291d5365a612b771426052b327bad8ff11b47682bc9fe150f6128c2144e699632c6c606fd08d836a7da889824a61b7
+  data.tar.gz: 1af3a1305da6856ccd56caaeeee126170205d244ba3a0026c50308d250f31e899609f1aab36b33a4970e6eec41f25b5014e9aea9c079e622576fb83b644997a6

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [1.22.0](https://github.com/algolia/algoliasearch-client-ruby/releases/tag/1.22.0) (2018-05-30)
+
+* Rename license file (#297)
+* Fix release task (#294)
+* Introduce multi cluster management (#285)
+* Fix(browse): ensure cursor is passed in the body (#288)
+* Chore(md): update contribution-related files (#293)
+
 ## [1.21.0](https://github.com/algolia/algoliasearch-client-ruby/releases/tag/1.21.0) (2018-05-24)
 
 * Fix(tests): fix warning for unspecified exception (#287)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    algoliasearch (1.21.0)
+    algoliasearch (1.22.0)
       httpclient (~> 2.8, >= 2.8.3)
       json (>= 1.5.1)
 
@@ -9,7 +9,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.4.0)
-    backports (3.11.2)
+    backports (3.11.1)
     coveralls (0.7.2)
       multi_json (~> 1.3)
       rest-client (= 1.6.7)
@@ -310,4 +310,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.16.1
+   1.16.2

data/{LICENSE.txt → LICENSE}

@@ -1,7 +1,6 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2013 Algolia
-http://www.algolia.com/
+Copyright (c) 2014-Present Algolia
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -10,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Rakefile

@@ -35,7 +35,8 @@ RSpec::Core::RakeTask.new(:spec)
 task :default => :spec
 
 namespace :algolia do
-  GIT_TAG_URL = 'https://github.com/algolia/algoliasearch-client-ruby/releases/tag/'
+  GEM_VERSION_FILE = File.expand_path('../lib/algolia/version.rb', __FILE__)
+  GIT_TAG_URL      = 'https://github.com/algolia/algoliasearch-client-ruby/releases/tag/'
 
   def last_commit_date
     `git log -1 --date=short --format=%cd`.chomp
@@ -73,7 +74,8 @@ namespace :algolia do
 
   desc 'Bump gem version'
   task :semver, [:version] do |t, args|
-    File.open(File.expand_path('../lib/algolia/version.rb', __FILE__), 'w') do |file|
+
+    File.open(GEM_VERSION_FILE, 'w') do |file|
       file.write <<~SEMVER
         module Algolia
           VERSION = "#{args[:version]}"
@@ -81,6 +83,10 @@ namespace :algolia do
       SEMVER
     end
 
+    # This force to reload the file with the newest version.
+    # Hence, `gemspec.version` invoked by Bundler later on will be correct.
+    load GEM_VERSION_FILE
+
     puts "Bumped gem version from #{latest_tag} to #{args[:version]}"
   end
 

data/algoliasearch.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
 
   s.extra_rdoc_files = [
     "CHANGELOG.md",
-    "LICENSE.txt",
+    "LICENSE",
     "README.md"
   ]
   s.files = [
@@ -37,7 +37,7 @@ Gem::Specification.new do |s|
     "CHANGELOG.md",
     "Gemfile",
     "Gemfile.lock",
-    "LICENSE.txt",
+    "LICENSE",
     "README.md",
     "Rakefile",
     "algoliasearch.gemspec",

data/lib/algolia/client.rb

@@ -381,6 +381,45 @@ module Algolia
     end
 
     #
+    # Multicluster management
+	#
+    def list_clusters(request_options = {})
+      get(Protocol.clusters_uri, :read, request_options)
+    end
+
+    def list_user_ids(page = 0, hits_per_page = 20, request_options = {})
+      get(Protocol.list_ids_uri(page, hits_per_page), :read, request_options)
+    end
+
+    def get_top_user_ids(request_options = {})
+      get(Protocol.cluster_top_user_uri, :read, request_options)
+    end
+
+    def assign_user_id(user_id, cluster_name, request_options = {})
+      request_options = add_header_to_request_options(request_options, { :'X-Algolia-User-ID' => user_id})
+
+      body = { :cluster => cluster_name }
+      post(Protocol.cluster_mapping_uri, body.to_json, :write, request_options)
+    end
+
+    def get_user_id(user_id, request_options = {})
+      get(Protocol.cluster_mapping_uri(user_id), :read, request_options)
+    end
+
+    def remove_user_id(user_id, request_options = {})
+      request_options = add_header_to_request_options(request_options, { :'X-Algolia-User-ID' => user_id})
+
+      delete(Protocol.cluster_mapping_uri, :write, request_options)
+    end
+
+    def search_user_id(query, cluster_name = nil, page = nil, hits_per_page = nil, request_options = {})
+      body = { :query => query }
+      body[:clusterName] = cluster_name unless cluster_name.nil?
+      body[:page] = page unless page.nil?
+      body[:hitsPerPage] = hits_per_page unless hits_per_page.nil?
+      post(Protocol.search_user_id_uri, body.to_json, :read, request_options)
+    end
+
     # Perform an HTTP request for the given uri and method
     # with common basic response handling. Will raise a
     # AlgoliaProtocolError if the response has an error status code,
@@ -496,6 +535,20 @@ module Algolia
       return JSON.parse(response.content)
     end
 
+    def add_header_to_request_options(request_options, headers_to_add)
+      if !request_options['headers'].is_a?(Hash)
+        if request_options[:headers].is_a?(Hash)
+          request_options['headers'] = request_options[:headers]
+          request_options.delete(:headers)
+        else
+          request_options['headers'] = {}
+        end
+      end
+
+      request_options['headers'].merge!(headers_to_add)
+      request_options
+    end
+
     # Deprecated
     alias_method :list_user_keys, :list_api_keys
     alias_method :get_user_key, :get_api_key

data/lib/algolia/index.rb

@@ -228,7 +228,7 @@ module Algolia
     # @param request_options contains extra parameters to send with your query
     #
     def browse_from(cursor, hits_per_page = 1000, request_options = {})
-      client.get(Protocol.browse_uri(name, { :cursor => cursor, :hitsPerPage => hits_per_page }), :read, request_options)
+      client.post(Protocol.browse_uri(name), { :cursor => cursor, :hitsPerPage => hits_per_page }.to_json, :read, request_options)
     end
 
     #

data/lib/algolia/protocol.rb

@@ -167,5 +167,27 @@ module Algolia
       "#{index_uri(index)}/deleteByQuery"
     end
 
+    def Protocol.clusters_uri
+      "/#{VERSION}/clusters"
+    end
+
+    def Protocol.cluster_mapping_uri(user_id = nil)
+      user_id = "/#{CGI.escape(user_id)}" if user_id
+
+      "/#{VERSION}/clusters/mapping" + user_id.to_s
+    end
+
+    def Protocol.list_ids_uri(page, hits_per_page)
+      Protocol.cluster_mapping_uri+"?page=#{CGI.escape(page.to_s)}&hitsPerPage=#{CGI.escape(hits_per_page.to_s)}"
+    end
+
+    def Protocol.cluster_top_user_uri
+      "/#{VERSION}/clusters/mapping/top"
+    end
+
+    def Protocol.search_user_id_uri
+      "/#{VERSION}/clusters/mapping/search"
+    end
+
   end
 end

data/lib/algolia/version.rb

@@ -1,3 +1,3 @@
 module Algolia
-  VERSION = "1.21.0"
+  VERSION = "1.22.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algoliasearch
 version: !ruby/object:Gem::Version
-  version: 1.21.0
+  version: 1.22.0
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-24 00:00:00.000000000 Z
+date: 2018-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -92,7 +92,7 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - CHANGELOG.md
-- LICENSE.txt
+- LICENSE
 - README.md
 files:
 - ".rspec"
@@ -100,7 +100,7 @@ files:
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - algoliasearch.gemspec
@@ -142,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: A simple Ruby client for the algolia.com REST API