algolia 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0246ce68c04f74cbc9e5556fc6ce0732168ae80854fad5bb3c16cc136c5313f
-  data.tar.gz: b8d46fda53509732a442547eda0b1b8087127380bf4b628461aee491e85736bc
+  metadata.gz: 40d3c378e402c5b99ccc924d79c5c9872d6737b1eaae852351b550a591d09ad9
+  data.tar.gz: 70d32a655666b9058f9c764d77051d03527abbbc52b0217320b03fe5cb1db78e
 SHA512:
-  metadata.gz: dc78357744b82ccea9963df689b6bfce71125cde45c7605b348cb38210ca028a681c57ad9e422add37c33a1a0394681bec958e3a50a1690128b727a2d5406099
-  data.tar.gz: f56ffd3e67ca4072024f99e24447ecac30a34d252893cc585e467a6589f5ce7331f9e80cc98fe4188ea0a01d325c9f0b6cfac7a689565cbda785c5a077510692
+  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

@@ -37,3 +37,4 @@ spec/integration_spec_conf.rb
 data.sqlite3
 
 debug.log
+.ruby-version

data/CHANGELOG.md

@@ -1,15 +1,22 @@
 # ChangeLog
 
-## Unreleased
+## [Unreleased](https://github.com/algolia/algoliasearch-client-ruby/compare/2.0.3...master)
 
-## [2.0.2](https://github.com/algolia/algoliasearch-client-ruby/releases/tag/2.0.2) (2020-11-09)
+## [2.0.3](https://github.com/algolia/algoliasearch-client-ruby/compare/2.0.2...2.0.3) (2020-11-24)
 
-* Fix: don't mutate index name on stripping
+### Chore
+- Containerize the repo
 
-## [2.0.1](https://github.com/algolia/algoliasearch-client-ruby/releases/tag/2.0.1) (2020-11-02)
+## [2.0.2](https://github.com/algolia/algoliasearch-client-ruby/compare/2.0.1...2.0.2) (2020-11-09)
 
-* Fix: simplify merge of headers in `Transport` class
-* Fix: `deserialize_settings` function to take into account `symbolize_keys` parameter
+### 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)
 

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

@@ -59,6 +59,10 @@ Encountering an issue? Before reaching out to support, we recommend heading to o
 
 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/lib/algolia/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Algolia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-09 00:00:00.000000000 Z
+date: 2020-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -192,6 +192,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".dockerignore"
 - ".github/ISSUE_TEMPLATE.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
@@ -199,6 +200,8 @@ files:
 - ".rubocop_todo.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- DOCKER_README.MD
+- Dockerfile
 - Gemfile
 - LICENSE
 - README.md