algolia 2.0.0.pre.beta.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70ae2ec824eed001a361d702826ad88956c6b580793bc8bb3aceda020ea8e8ea
-  data.tar.gz: bbed7b37901bf59cbc1cbf172a4ec9fa06df026988187cd1ea78fd6a3cf9dae4
+  metadata.gz: b0246ce68c04f74cbc9e5556fc6ce0732168ae80854fad5bb3c16cc136c5313f
+  data.tar.gz: b8d46fda53509732a442547eda0b1b8087127380bf4b628461aee491e85736bc
 SHA512:
-  metadata.gz: 253ebb7ccb0745b17f72526df5656ba58eb800c3ce973eaffe52e6f098758def22d425c77fe6b07f882733551d3d01f081ff80b4be6b900f7ccfcac3a2926edf
-  data.tar.gz: a5e231f9bd48361cfe12fa5b74234ad899b6ac1dbd2b46dc0b4f69a76532bebb7cc1e0f7eb9abf7930693422a124c7eb5e5f18b5798beb3eb9edd6463779d3b7
+  metadata.gz: dc78357744b82ccea9963df689b6bfce71125cde45c7605b348cb38210ca028a681c57ad9e422add37c33a1a0394681bec958e3a50a1690128b727a2d5406099
+  data.tar.gz: f56ffd3e67ca4072024f99e24447ecac30a34d252893cc585e467a6589f5ce7331f9e80cc98fe4188ea0a01d325c9f0b6cfac7a689565cbda785c5a077510692

data/.gitignore

@@ -35,4 +35,5 @@ pkg
 Gemfile.lock
 spec/integration_spec_conf.rb
 data.sqlite3
+
 debug.log

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# ChangeLog
+
+## Unreleased
+
+## [2.0.2](https://github.com/algolia/algoliasearch-client-ruby/releases/tag/2.0.2) (2020-11-09)
+
+* Fix: don't mutate index name on stripping
+
+## [2.0.1](https://github.com/algolia/algoliasearch-client-ruby/releases/tag/2.0.1) (2020-11-02)
+
+* Fix: simplify merge of headers in `Transport` class
+* Fix: `deserialize_settings` function to take into account `symbolize_keys` parameter
+
+## [2.0.0](https://github.com/algolia/algoliasearch-client-ruby/releases/tag/2.0.0) (2020-10-27)
+
+* Initial release of v2

data/README.md

@@ -6,9 +6,9 @@
   <h4 align="center">The perfect starting point to integrate <a href="https://algolia.com" target="_blank">Algolia</a> within your Ruby project</h4>
 
   <p align="center">
-    <a href="https://circleci.com/gh/algolia/algoliasearch-client-ruby/tree/release%2Fv2"><img src="https://circleci.com/gh/algolia/algoliasearch-client-ruby/tree/release%2Fv2.svg?style=shield" alt="CircleCI" /></a>
-    <a href="https://rubygems.org/gems/algoliasearch"><img src="https://badge.fury.io/rb/algoliasearch.svg" alt="Gem Version"></a>
-    <a href="https://rubygems.org/gems/algoliasearch"><img src="https://img.shields.io/badge/licence-MIT-blue.svg" alt="License"></a>
+    <a href="https://circleci.com/gh/algolia/algoliasearch-client-ruby"><img src="https://circleci.com/gh/algolia/algoliasearch-client-ruby.svg?style=shield" alt="CircleCI" /></a>
+    <a href="https://rubygems.org/gems/algolia"><img src="https://badge.fury.io/rb/algolia.svg" alt="Gem Version"></a>
+    <a href="https://rubygems.org/gems/algolia"><img src="https://img.shields.io/badge/licence-MIT-blue.svg" alt="License"></a>
   </p>
 </p>
 
@@ -18,39 +18,47 @@
   <a href="https://discourse.algolia.com" target="_blank">Community Forum</a>  •
   <a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a>  •
   <a href="https://github.com/algolia/algoliasearch-client-ruby/issues" target="_blank">Report a bug</a>  •
+  <a href="https://www.algolia.com/doc/api-client/troubleshooting/faq/ruby/" target="_blank">FAQ</a>  •
   <a href="https://www.algolia.com/support" target="_blank">Support</a>
 </p>
 
 ## ✨ Features
 
 - Thin & minimal low-level HTTP client to interact with Algolia's API
-- Supports Ruby `^1.8.7`.
+- Supports Ruby `^2.2`.
 
 ## 💡 Getting Started
 
 First, install Algolia Ruby API Client via the [RubyGems](https://rubygems.org/) package manager:
 ```bash
-gem install algoliasearch
+gem install algolia
 ```
 
 Then, create objects on your index:
 
 
 ```ruby
-Algolia.init(application_id: 'YourApplicationID',
-             api_key:        'YourAPIKey')
-index = Algolia::Index.new('your_index_name')
+client = Algolia::Search::Client.create('YourApplicationID', 'YourAPIKey')
+index = client.init_index('your_index_name')
 
-index.save_objects([objectID:  1, name: 'Foo'])
+index.save_objects([objectID: 1, name: 'Foo'])
 ```
 
 Finally, you may begin searching a object using the `search` method:
 ```ruby
-objects = index.search('Fo')
+objects = index.search('Foo')
 ```
 
 For full documentation, visit the **[Algolia Ruby API Client](https://www.algolia.com/doc/api-client/getting-started/install/ruby/)**.
 
+## ❓ Troubleshooting
+
+Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/ruby/) where you will find answers for the most common issues and gotchas with the client.
+
+## Upgrade from V1 to V2
+
+If you were using the v1 and wish to update to v2, please follow our [Upgrade Guide](upgrade_guide.md)
+
 ## 📄 License
 
 Algolia Ruby API Client is an open-sourced software licensed under the [MIT license](LICENSE.md).

data/SECURITY.md

@@ -0,0 +1,3 @@
+## Reporting a Vulnerability
+
+To report a security vulnerability, please use the [Algolia security email](security@algolia.com). Algolia will coordinate the fix and disclosure.

data/algolia.gemspec

@@ -12,14 +12,14 @@ Gem::Specification.new do |spec|
 
   spec.date        = Date.today
   spec.licenses    = ['MIT']
-  spec.summary     = 'A simple Ruby client for the algolia.com REST API (alpha release)'
-  spec.description = 'This is the alpha version of the upcoming v2 release of Algolia Client. Please keep on using the algoliasearch gem in the meantime.'
-  spec.homepage    = 'https://github.com/algolia/algoliasearch-client-ruby/tree/release/v2'
+  spec.summary     = 'A simple Ruby client for the algolia.com REST API'
+  spec.description = 'A simple Ruby client for the algolia.com REST API'
+  spec.homepage    = 'https://github.com/algolia/algoliasearch-client-ruby'
 
   spec.metadata = {
     'bug_tracker_uri' => 'https://github.com/algolia/algoliasearch-client-ruby/issues',
-    'documentation_uri' => 'http://www.rubydoc.info/gems/algolia',
-    'source_code_uri' => 'https://github.com/algolia/algoliasearch-client-ruby/tree/release/v2'
+    'documentation_uri' => 'https://www.algolia.com/doc/api-client/getting-started/install/ruby',
+    'source_code_uri' => 'https://github.com/algolia/algoliasearch-client-ruby'
   }
 
   # Specify which files should be added to the gem when it is released.
@@ -35,7 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rubocop', '<= 0.82.0'
 
-  spec.add_dependency 'faraday', '~> 0.15'
+  spec.add_dependency 'faraday', ['>= 0.15', '< 2.0']
   spec.add_dependency 'multi_json', '~> 1.0'
   spec.add_dependency 'net-http-persistent'
 

data/lib/algolia/config/base_config.rb

@@ -3,7 +3,7 @@ require 'faraday'
 module Algolia
   class BaseConfig
     attr_accessor :app_id, :api_key, :headers, :batch_size, :read_timeout, :write_timeout, :connect_timeout, :compression_type,
-                  :symbolize_keys
+                  :symbolize_keys, :use_latest_settings
 
     #
     # @option options [String] :application_id
@@ -28,12 +28,12 @@ module Algolia
         'User-Agent' => UserAgent.value
       }
 
-      @batch_size       = opts[:batch_size] || Defaults::BATCH_SIZE
-      @read_timeout     = opts[:read_timeout] || Defaults::READ_TIMEOUT
-      @write_timeout    = opts[:write_timeout] || Defaults::WRITE_TIMEOUT
-      @connect_timeout  = opts[:connect_timeout] || Defaults::CONNECT_TIMEOUT
-      @compression_type = opts[:compression_type] || Defaults::NONE_ENCODING
-      @symbolize_keys   = opts[:symbolize_keys] || true
+      @batch_size          = opts[:batch_size] || Defaults::BATCH_SIZE
+      @read_timeout        = opts[:read_timeout] || Defaults::READ_TIMEOUT
+      @write_timeout       = opts[:write_timeout] || Defaults::WRITE_TIMEOUT
+      @connect_timeout     = opts[:connect_timeout] || Defaults::CONNECT_TIMEOUT
+      @compression_type    = opts[:compression_type] || Defaults::NONE_ENCODING
+      @symbolize_keys      = opts.has_key?(:symbolize_keys) ? opts[:symbolize_keys] : true
     end
 
     def set_extra_header(key, value)

data/lib/algolia/error.rb

@@ -17,8 +17,7 @@ module Algolia
   # which is also included in the response attribute.
   #
   class AlgoliaHttpError < AlgoliaError
-    attr_accessor :code
-    attr_accessor :message
+    attr_accessor :code, :message
 
     def initialize(code, message)
       self.code    = code

data/lib/algolia/helpers.rb

@@ -52,8 +52,8 @@ module Helpers
 
   # Support to convert old settings to their new names
   #
-  def deserialize_settings(data)
-    settings = symbolize_hash(data)
+  def deserialize_settings(data, symbolize_keys)
+    settings = data
     keys     = {
       attributesToIndex: 'searchableAttributes',
       numericAttributesToIndex: 'numericAttributesForFiltering',
@@ -61,8 +61,10 @@ module Helpers
     }
 
     keys.each do |deprecated_key, current_key|
+      deprecated_key = symbolize_keys ? deprecated_key : deprecated_key.to_s
       if settings.has_key?(deprecated_key)
-        settings[current_key.to_sym] = settings.delete(deprecated_key)
+        key           = symbolize_keys ? current_key.to_sym : current_key.to_s
+        settings[key] = settings.delete(deprecated_key)
       end
     end
 

data/lib/algolia/iterators/object_iterator.rb

@@ -7,16 +7,17 @@ module Algolia
         data = {}
 
         if @response
-          if @response[:hits].length
-            @response[:hits].each do |hit|
+          parsed_response = symbolize_hash(@response)
+          if parsed_response[:hits].length
+            parsed_response[:hits].each do |hit|
               yield hit
             end
 
-            if @response[:cursor].nil?
+            if parsed_response[:cursor].nil?
               @response = nil
               raise StopIteration
             else
-              data[:cursor] = @response[:cursor]
+              data[:cursor] = parsed_response[:cursor]
             end
           end
         end

data/lib/algolia/iterators/paginator_iterator.rb

@@ -16,13 +16,15 @@ module Algolia
     def each
       loop do
         if @response
-          if @response[:hits].length
-            @response[:hits].each do |hit|
+          parsed_response = symbolize_hash(@response)
+          parsed_data     = symbolize_hash(@data)
+          if parsed_response[:hits].length
+            parsed_response[:hits].each do |hit|
               hit.delete(:_highlightResult)
               yield hit
             end
 
-            if @response[:nbHits] < @data[:hitsPerPage]
+            if parsed_response[:nbHits] < parsed_data[:hitsPerPage]
               @response = nil
               @data     = {
                 hitsPerPage: 1000,

data/lib/algolia/search_client.rb

@@ -90,11 +90,11 @@ module Algolia
       # @return [Index] new Index instance
       #
       def init_index(index_name)
-        index_name.strip!
-        if index_name.empty?
+        stripped_index_name = index_name.strip
+        if stripped_index_name.empty?
           raise AlgoliaError, 'Please provide a valid index name'
         end
-        Index.new(index_name, @transporter, @config)
+        Index.new(stripped_index_name, @transporter, @config)
       end
 
       # List all indexes of the client

data/lib/algolia/search_index.rb

@@ -115,7 +115,7 @@ module Algolia
         has_next_page = true
         while has_next_page
           request_options[:page] = page
-          res                    = search(query, request_options)
+          res                    = symbolize_hash(search(query, request_options))
 
           res[:hits].each_with_index do |hit, i|
             if callback.call(hit)
@@ -976,7 +976,7 @@ module Algolia
       def get_settings(opts = {})
         response = @transporter.read(:GET, path_encode('/1/indexes/%s/settings', @name) + handle_params({ getVersion: 2 }), {}, opts)
 
-        deserialize_settings(response)
+        deserialize_settings(response, @config.symbolize_keys)
       end
 
       # Update some index settings. Only specified settings are overridden

data/lib/algolia/transport/request_options.rb

@@ -34,7 +34,7 @@ module Algolia
       def add_headers(opts = {})
         unless opts[:headers].nil?
           opts[:headers].each do |opt, value|
-            @headers[opt.to_sym] = value
+            @headers[opt.to_s] = value
           end
           opts.delete(:headers)
         end

data/lib/algolia/transport/transport.rb

@@ -127,15 +127,12 @@ module Algolia
 
       # Generates headers from config headers and optional parameters
       #
-      # @option options [String] :headers
+      # @param request_options [RequestOptions]
       #
       # @return [Hash] merged headers
       #
       def generate_headers(request_options = {})
-        headers                                             = {}
-        extra_headers                                       = request_options.headers || {}
-        @config.headers.each { |key, val| headers[key.to_s] = val }
-        extra_headers.each { |key, val| headers[key.to_s]   = val }
+        headers = @config.headers.merge(request_options.headers)
         if request_options.compression_type == Defaults::GZIP_ENCODING
           headers['Accept-Encoding']  = Defaults::GZIP_ENCODING
         end

data/lib/algolia/version.rb

@@ -1,3 +1,3 @@
 module Algolia
-  VERSION = '2.0.0-beta.1'.freeze
+  VERSION = '2.0.2'.freeze
 end

data/test/algolia/unit/algolia_config_test.rb

@@ -4,7 +4,7 @@ require 'test_helper'
 class AlgoliaConfigTest
   describe 'set an extra header' do
     def before_all
-      @config = Algolia::AlgoliaConfig.new(app_id: 'app_id', api_key: 'api_key')
+      @config = Algolia::BaseConfig.new(application_id: 'app_id', api_key: 'api_key')
     end
 
     def test_set_extra_header

data/test/algolia/unit/helpers_test.rb

@@ -18,7 +18,26 @@ class HelpersTest
         replicas: %w(index1 index2)
       }
 
-      deserialized_settings = deserialize_settings(old_settings)
+      deserialized_settings = deserialize_settings(old_settings, true)
+      assert_equal new_settings, deserialized_settings
+    end
+
+    def test_deserialize_settings_with_string
+      old_settings = {
+        'attributesToIndex' => %w(attr1 attr2),
+        'numericAttributesToIndex' => %w(attr1 attr2),
+        'slaves' => %w(index1 index2),
+        'minWordSizefor1Typo' => 1
+      }
+
+      new_settings = {
+        'searchableAttributes' => %w(attr1 attr2),
+        'numericAttributesForFiltering' => %w(attr1 attr2),
+        'replicas' => %w(index1 index2),
+        'minWordSizefor1Typo' => 1
+      }
+
+      deserialized_settings = deserialize_settings(old_settings, false)
       assert_equal new_settings, deserialized_settings
     end
   end

data/upgrade_guide.md

@@ -43,6 +43,12 @@ client = Algolia::Search::Client.create_with_config(search_config)
 index = client.init_index('index_name')
 ```
 
+By default the keys of the response hashes are symbols. If you wish to change that for strings, use the following configuration
+```ruby
+search_config = Algolia::Search::Config.new(application_id: app_id, api_key: api_key, symbolize_keys: false)
+client = Algolia::Search::Client.create_with_config(search_config)
+```
+
 ## Search parameters and request options
 The search parameters and request options are still optional, but they are combined into a single hash instead of two. 
 For example:
@@ -66,13 +72,13 @@ index.search('query', opts)
 ### `Client`
 
 #### `set_extra_header`
-The `set_extra_header` method has been moved from the Client to the `Algolia::AlgoliaConfig` class. You have to define your extra headers on Client instantiation.
+The `set_extra_header` method has been moved from the Client to the `Algolia::BaseConfig` class. You have to define your extra headers on Client instantiation.
 ```ruby
 # Before
 client.set_extra_header('admin', 'admin-key')
 
 # After
-# `Algolia::Search::Config` inherits from `Algolia::AlgoliaConfig` 
+# `Algolia::Search::Config` inherits from `Algolia::BaseConfig` 
 config = Algolia::Search::Config.new(app_id: 'APP_ID', api_key: 'API_KEY')
 config.set_extra_header('admin', 'admin-key')
 
@@ -223,7 +229,7 @@ client.search_user_ids('query', {clusterName: 'my-cluster', hitPerPage: 12, page
 #### `pending_mappings`
 New method to check the status of your clusters' migration or user creation.
 ```ruby
-client.pending_mapping?({ retrieveMappings: true })
+client.pending_mappings?({ retrieveMappings: true })
 ``` 
 
 #### `get_logs`

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.beta.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Algolia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-19 00:00:00.000000000 Z
+date: 2020-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,16 +56,22 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.15'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.15'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -178,8 +184,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: This is the alpha version of the upcoming v2 release of Algolia Client.
-  Please keep on using the algoliasearch gem in the meantime.
+description: A simple Ruby client for the algolia.com REST API
 email:
 - support@algolia.com
 executables: []
@@ -192,11 +197,13 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- SECURITY.md
 - Steepfile
 - algolia.gemspec
 - bin/console
@@ -271,13 +278,13 @@ files:
 - test/algolia/unit/user_agent_test.rb
 - test/test_helper.rb
 - upgrade_guide.md
-homepage: https://github.com/algolia/algoliasearch-client-ruby/tree/release/v2
+homepage: https://github.com/algolia/algoliasearch-client-ruby
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/algolia/algoliasearch-client-ruby/issues
-  documentation_uri: http://www.rubydoc.info/gems/algolia
-  source_code_uri: https://github.com/algolia/algoliasearch-client-ruby/tree/release/v2
+  documentation_uri: https://www.algolia.com/doc/api-client/getting-started/install/ruby
+  source_code_uri: https://github.com/algolia/algoliasearch-client-ruby
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -289,14 +296,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
-summary: A simple Ruby client for the algolia.com REST API (alpha release)
+summary: A simple Ruby client for the algolia.com REST API
 test_files:
 - test/algolia/integration/account_client_test.rb
 - test/algolia/integration/analytics_client_test.rb