algolia 2.0.0.pre.beta.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4645e42bf97d367a91ac73d59c440bc8f07d34c969df2d16ca3d6fac652f14f9
-  data.tar.gz: 2188142202397e4e56dbe7b77d635b439794ebf6401472e83907ab078e593a45
+  metadata.gz: 40d3c378e402c5b99ccc924d79c5c9872d6737b1eaae852351b550a591d09ad9
+  data.tar.gz: 70d32a655666b9058f9c764d77051d03527abbbc52b0217320b03fe5cb1db78e
 SHA512:
-  metadata.gz: edb4691eaa9e505a1e014e58232edffb0c6fdb62686f52b90c597b037392e81c1af98c7e339f017ad5b1ecab916d07336cf31c734832838d7648fcab82e2fe82
-  data.tar.gz: c9d8da55b0599118d3153ca84e1bf34f909cf128c101b5480ffff64213253e45685daef451ee48e15410737319efd6dea5f75768b3e2c0af0947160b1304473e
+  metadata.gz: 22fc03fda8e648f7dea09eb475462ea3f6502cceba01b8860c31e2c5c98a2556191f235907bd7fbd0d9e9d45ed5b9692cc791f7f9dada888fa022c33e766697d
+  data.tar.gz: a8f099bd900239517cc13b91928272450947a528979d29b1aa9b455dd25703415aaa9ef2bdd0970f3a1ed657a709e2445c586d78707b726a2089da06260aabdf

data/.dockerignore

@@ -0,0 +1,38 @@
+# rspec failure tracking
+.rspec_status
+
+## MAC OS
+.DS_Store
+.idea/
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+.rvmrc
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+## PROJECT::SPECIFIC
+spec/integration_spec_conf.rb
+data.sqlite3
+
+debug.log

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# ChangeLog
+
+## [Unreleased](https://github.com/algolia/algoliasearch-client-ruby/compare/2.0.3...master)
+
+## [2.0.3](https://github.com/algolia/algoliasearch-client-ruby/compare/2.0.2...2.0.3) (2020-11-24)
+
+### Chore
+- Containerize the repo
+
+## [2.0.2](https://github.com/algolia/algoliasearch-client-ruby/compare/2.0.1...2.0.2) (2020-11-09)
+
+### Fix
+- Don't mutate index name on stripping
+
+## [2.0.1](https://github.com/algolia/algoliasearch-client-ruby/compare/2.0.0...2.0.1) (2020-11-02)
+
+### Fix
+- Simplify merge of headers in `Transport` class
+- `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/DOCKER_README.MD

@@ -0,0 +1,89 @@
+In this page you will find our recommended way of installing Docker on your machine. 
+This guide is made for OSX users.
+
+## Install docker
+
+First install Docker using [Homebrew](https://brew.sh/)
+```
+$ brew install docker
+```
+
+You can then install [Docker Desktop](https://docs.docker.com/get-docker/) if you wish, or use `docker-machine`. As we prefer the second option, we will only document this one.
+
+## Setup your docker
+
+Install `docker-machine`
+```
+$ brew install docker-machine
+```
+
+Then install [VirtualBox](https://www.virtualbox.org/) with [Homebrew Cask](https://github.com/Homebrew/homebrew-cask) to get a driver for your Docker machine
+```
+$ brew cask install virtualbox
+```
+
+You may need to enter your password and authorize the application in your `System Settings` > `Security & Privacy`.
+
+Create now a new machine, set it up as default and connect your shell to it (here we use zsh. The commands should anyway be displayed in each steps' output)
+
+```
+$ docker-machine create --driver virtualbox default
+$ docker-machine env default
+$ eval "$(docker-machine env default)"
+```
+
+Now you're all setup to use our provided Docker image!
+
+## Build the image
+
+```bash
+docker build -t algolia-ruby .
+```
+
+## Run the image
+
+You need to provide few environment variables at runtime to be able to run the [Common Test Suite](https://github.com/algolia/algoliasearch-client-specs/tree/master/common-test-suite).
+You can set them up directly in the command:
+
+```bash
+docker run -it --rm --env ALGOLIA_APP_ID=XXXXXX [...] -v $PWD:/app -w /app algolia-ruby bash
+```
+
+However, we advise you to export them in your `.bashrc` or `.zshrc`. That way, you can use [Docker's shorten syntax](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file) to set your variables.
+
+```bash
+### For external contributors, only the following env variables should be enough
+docker run -it --rm --env ALGOLIA_APPLICATION_ID_1 \
+                    --env ALGOLIA_ADMIN_KEY_1 \
+                    --env ALGOLIA_SEARCH_KEY_1 \
+-v $PWD:/app -w /app algolia-ruby bash
+
+### This is needed only to run the full test suite
+docker run -it --rm --env ALGOLIA_APPLICATION_ID_1 \
+                    --env ALGOLIA_ADMIN_KEY_1 \
+                    --env ALGOLIA_SEARCH_KEY_1 \
+                    --env ALGOLIA_APPLICATION_ID_2 \
+                    --env ALGOLIA_ADMIN_KEY_2 \
+                    --env ALGOLIA_APPLICATION_ID_MCM \
+                    --env ALGOLIA_ADMIN_KEY_MCM \
+-v $PWD:/app -w /app algolia-ruby bash
+```
+
+Once your container is running, any changes you make in your IDE are directly reflected in the container.
+
+To launch the tests, you can use one of the following commands
+```shell script
+# run only the unit tests
+bundle exec rake test:unit
+
+# run only the integration tests
+bundle exec rake test:integration
+
+# run the whole test suite
+bundle exec rake test:all
+
+# run a single test
+bundle exec rake test TEST=/full/path/to/test.rb TESTOPTS="--name=test_name"
+```
+
+Feel free to contact us if you have any questions.

data/Dockerfile

@@ -0,0 +1,7 @@
+FROM ruby:2.6.3
+
+RUN gem install bundler
+
+WORKDIR /app
+COPY . /app/
+RUN bundle install

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,51 @@
   <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)
+
+## Use the Dockerfile
+
+If you want to contribute to this project without installing all its dependencies, you can use our Docker image. Please check our [dedicated guide](DOCKER_README.MD) to learn more.
+
 ## 📄 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.has_key?(: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/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/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

@@ -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.2'.freeze
+  VERSION = '2.0.3'.freeze
 end

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

@@ -229,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.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Algolia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-19 00:00:00.000000000 Z
+date: 2020-11-24 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: []
@@ -187,16 +192,21 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".dockerignore"
 - ".github/ISSUE_TEMPLATE.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- DOCKER_README.MD
+- Dockerfile
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- SECURITY.md
 - Steepfile
 - algolia.gemspec
 - bin/console
@@ -271,13 +281,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 +299,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