algolia 2.0.0.pre.beta.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47d18253040f91e77f82a815e90b4064c88aac2ddbacbe4c26b1dea81304d847
-  data.tar.gz: 530b601d76e6de0b4f252dc13bcce01f7446428f839cd22fb4b286a1b5a17f73
+  metadata.gz: 555e432d41a84d3031f58dc7c74acf5297df48fe693fadf977c6b15547a82d6b
+  data.tar.gz: a3fbbc9ba6552b0b432a20e34cd5cf7a311f339c2df7f7a3c549ced84f409ba0
 SHA512:
-  metadata.gz: 04c63a1fb49fcd66817e0b43f66c16b3cbe8bd044ca513409047f8709ab8cc757deb30cedaeafcddf831f98179efa9c21fdcbf4bb09a1641b9b5b7aa96d6fc8c
-  data.tar.gz: e552093cc4ab5827c8ab87e448856bfdbd68f113b8e321e928e66ceb03f8ecf96531aad902d256a6372336c9efeedd166e85165d63a0c83f0795de942a0b4eb7
+  metadata.gz: 757d57c2723f3f036bfb7faa38615fd751311e99b0a3f5e1b3c13087c53a9010af88c99a5412e31bb3e6d3cdb9201478d7100c71080b3fe948004170a870f875
+  data.tar.gz: ede51228b6bc2498b65434102f8b25b17d7db74ae74cd2b50a1ec7184f42692e4b24d94de8c621ec91a8192c924e71ac1067bfdde038a03936407f12147b6175

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# ChangeLog
+
+## Unreleased
+
+## [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/tree/release%2Fv2.svg?style=shield" alt="CircleCI" /></a>
+    <a href="https://rubygems.org/gems/algolia"><img src="https://badge.fury.io/rb/algoliasearch.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.

data/lib/algolia/config/base_config.rb

@@ -34,8 +34,6 @@ module Algolia
       @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
-      # used to avoid BC break on Rails integration, should not be documented
-      @use_latest_settings = opts.has_key?(:use_latest_settings) ? opts[:use_latest_settings] : true
     end
 
     def set_extra_header(key, value)

data/lib/algolia/helpers.rb

@@ -52,9 +52,7 @@ module Helpers
 
   # Support to convert old settings to their new names
   #
-  def deserialize_settings(data, use_latest_settings, symbolize_keys)
-    return data unless use_latest_settings
-
+  def deserialize_settings(data, symbolize_keys)
     settings = symbolize_hash(data)
     keys     = {
       attributesToIndex: 'searchableAttributes',

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, @config.use_latest_settings, @config.symbolize_keys)
+        deserialize_settings(response, @config.symbolize_keys)
       end
 
       # Update some index settings. Only specified settings are overridden

data/lib/algolia/version.rb

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

data/test/algolia/unit/helpers_test.rb

@@ -18,21 +18,10 @@ class HelpersTest
         replicas: %w(index1 index2)
       }
 
-      deserialized_settings = deserialize_settings(old_settings, true, true)
+      deserialized_settings = deserialize_settings(old_settings, true)
       assert_equal new_settings, deserialized_settings
     end
 
-    def test_deserialize_settings_with_old_settings
-      old_settings = {
-        attributesToIndex: %w(attr1 attr2),
-        numericAttributesToIndex: %w(attr1 attr2),
-        slaves: %w(index1 index2)
-      }
-
-      deserialized_settings = deserialize_settings(old_settings, false, true)
-      assert_equal old_settings, deserialized_settings
-    end
-
     def test_deserialize_settings_with_string
       old_settings = {
         'attributesToIndex' => %w(attr1 attr2),
@@ -46,7 +35,7 @@ class HelpersTest
         'replicas' => %w(index1 index2)
       }
 
-      deserialized_settings = deserialize_settings(old_settings, true, false)
+      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.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Algolia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-21 00:00:00.000000000 Z
+date: 2020-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -178,8 +178,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 +191,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 +272,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 +290,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