typesense 0.1.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 787ca1a4be329121969b519d1eb612c328838ea184e8505920e7775ab4f9ae71
-  data.tar.gz: 833928b07e40d987b8f864cfb89c29ba0d484a63e001150b93b9fbcb07022c74
+  metadata.gz: 760daa6bc1d036a79e8d956743918a6fee8956cbd2adb36c34afe6ad84d50739
+  data.tar.gz: 9a348a24b5babf261b738ba238e5e87959e66bdc3b3f5ed406e5c9749c68a84e
 SHA512:
-  metadata.gz: 58df46cbf3f36f7d5cc7af7e760660e966a17949844aba315c94f4bafd34a40a18a8bd7f91836f97dbba750464de18429704b7f8cf5b1d8099f4cef05c36601c
-  data.tar.gz: 35b72d7e825ba5f375063fcef66451f759d72f19991337290f0661da8753f774bdd8c0bea2e275c236fec0b7fcdb0e368e1fa69aa931431efbbe4d96d27713d2
+  metadata.gz: a2f0711831891fc1fadf04e7a791d46840843ef349d467acf9fd92cffd2a00aec9abb82c323ba5a3d0b18cda450902ef166107147df109222817a2db84ff08eb
+  data.tar.gz: 6199850461ca7f254805f4c27880175843cef342bb3eae13cb9d57f0c90a4e672859b095b94d04daee2f5371a6ed2785a5a443a7acd3c4791a54aa0ab64d35db

data/.circleci/config.yml

@@ -27,8 +27,10 @@ jobs:
 #          - v1-dependencies-
 
       - run:
-          name: update bundler
+          name: install bundler
           command: |
+            echo 'export BUNDLER_VERSION=$(cat Gemfile.lock | tail -1 | tr -d " ")' >> $BASH_ENV
+            source $BASH_ENV
             gem install bundler
 
       - run:
@@ -44,7 +46,7 @@ jobs:
       - run:
           name: lint
           command: |
-            rubocop
+            bundle exec rubocop
 
       # run tests!
       - run:

data/.gitignore

@@ -11,5 +11,7 @@ Gemfile.lock
 .ruby-version
 .ruby-gemset
 
+typesense-server-peers
+
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -4,9 +4,16 @@ require: rubocop-rspec
 
 AllCops:
   TargetRubyVersion: "2.4"
+  NewCops: enable
 
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
     - 'Gemfile'
     - 'typesense.gemspec'
+
+Style/Documentation:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-03-17 15:11:06 -0700 using RuboCop version 0.53.0.
+# on 2020-05-21 20:10:36 -0700 using RuboCop version 0.83.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -11,45 +11,51 @@ Lint/ShadowedException:
   Exclude:
     - 'lib/typesense/api_call.rb'
 
+# Offense count: 2
+# Configuration parameters: AllowComments.
+Lint/SuppressedException:
+  Exclude:
+    - 'examples/collections_and_documents.rb'
+    - 'examples/search.rb'
+    - 'examples/keys.rb'
+
 # Offense count: 3
+# Configuration parameters: IgnoredMethods.
 Metrics/AbcSize:
-  Max: 37
+  Max: 43
 
 # Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 184
+
+# Offense count: 3
+# Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
-  Max: 13
+  Max: 11
 
-# Offense count: 1
-# Configuration parameters: CountComments.
+# Offense count: 5
+# Configuration parameters: CountComments, ExcludedMethods.
 Metrics/MethodLength:
-  Max: 35
+  Max: 29
 
-# Offense count: 1
+# Offense count: 3
+# Configuration parameters: IgnoredMethods.
 Metrics/PerceivedComplexity:
-  Max: 14
+  Max: 11
 
-# Offense count: 13
-# Configuration parameters: Max.
-RSpec/ExampleLength:
-  Exclude:
-    - 'spec/typesense/api_call_spec.rb'
-    - 'spec/typesense/collection_spec.rb'
-    - 'spec/typesense/collections_spec.rb'
-    - 'spec/typesense/debug_spec.rb'
-    - 'spec/typesense/document_spec.rb'
-    - 'spec/typesense/documents_spec.rb'
-
-# Offense count: 2
-# Configuration parameters: AggregateFailuresByDefault.
+# Offense count: 10
 RSpec/MultipleExpectations:
-  Max: 2
+  Max: 5
 
-# Offense count: 9
+# Offense count: 13
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
     - 'test/**/*'
     - 'lib/typesense.rb'
+    - 'lib/typesense/alias.rb'
+    - 'lib/typesense/aliases.rb'
     - 'lib/typesense/api_call.rb'
     - 'lib/typesense/client.rb'
     - 'lib/typesense/collection.rb'
@@ -58,9 +64,12 @@ Style/Documentation:
     - 'lib/typesense/debug.rb'
     - 'lib/typesense/document.rb'
     - 'lib/typesense/documents.rb'
+    - 'lib/typesense/override.rb'
+    - 'lib/typesense/overrides.rb'
 
-# Offense count: 92
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# Offense count: 157
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
-Metrics/LineLength:
-  Max: 245
+Layout/LineLength:
+  Max: 312

data/LICENSE

@@ -1,13 +1,201 @@
-Copyright 2018 Wreally Studios Inc. <contact@wreally.com> http://wreally.com
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this software except in compliance with the License.
-You may obtain a copy of the License at
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-    http://www.apache.org/licenses/LICENSE-2.0
+   1. Definitions.
 
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,4 +1,4 @@
-# Typesense Ruby Library [![Gem Version](https://badge.fury.io/rb/typesense.svg)](https://badge.fury.io/rb/typesense) [![CircleCI](https://circleci.com/gh/typesense/typesense-ruby.svg?style=shield&circle-token=063f2179925b0b37d540126f6c96f6e1fe23f1b9)](https://circleci.com/gh/typesense/typesense-ruby)
+# Typesense Ruby Library [![Gem Version](https://badge.fury.io/rb/typesense.svg)](https://badge.fury.io/rb/typesense) [![CircleCI](https://circleci.com/gh/typesense/typesense-ruby.svg?style=shield&circle-token=063f2179925b0b37d540126f6c96f6e1fe23f1b9)](https://circleci.com/gh/typesense/typesense-ruby) [![codecov](https://codecov.io/gh/typesense/typesense-ruby/branch/master/graph/badge.svg)](https://codecov.io/gh/typesense/typesense-ruby)
 
 
 Ruby client library for accessing the [Typesense HTTP API](https://github.com/typesense/typesense).
@@ -29,6 +29,14 @@ Here are some examples that show you how the Ruby client works: [examples](examp
 
 Tests are also a good place to know how the the library works internally: [spec](spec)
 
+## Compatibility
+
+| Typesense Server | typesense-ruby |
+|------------------|----------------|
+| \>= v0.12.1 | \>= v0.5.0 |
+| \>= v0.12.0 | \>= v0.4.0 |
+| <= v0.11 | <= v0.3.0 |
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -37,4 +45,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at [typesense/typesense-ruby](https://github.com/typesense/typesense-ruby).
+Bug reports and pull requests are welcome on GitHub at [typesense/typesense-ruby](https://github.com/typesense/typesense-ruby).

data/codecov.yml

@@ -0,0 +1,10 @@
+coverage:
+  status:
+    project:
+      default:
+        threshold: 10%
+        target: 90%
+    patch:
+      default:
+        threshold: 10%
+        target: 80%

data/examples/aliases.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+##
+# These examples walk you through operations specifically related to aliases
+# # This is a Typesense Premium feature (see: https://typesense.org/premium)
+# Be sure to add `--license-key=<>` as a parameter, when starting a Typesense Premium server
+
+require_relative './client_initialization'
+
+# Create a collection
+create_response = @typesense.collections.create(
+  "name": 'books_january',
+  "fields": [
+    { "name": 'title', "type": 'string' },
+    { "name": 'authors', "type": 'string[]' },
+    { "name": 'authors_facet', "type": 'string[]', "facet": true },
+    { "name": 'publication_year', "type": 'int32' },
+    { "name": 'publication_year_facet', "type": 'string', "facet": true },
+    { "name": 'ratings_count', "type": 'int32' },
+    { "name": 'average_rating', "type": 'float' },
+    { "name": 'image_url', "type": 'string' }
+  ],
+  "default_sorting_field": 'ratings_count'
+)
+
+ap create_response
+
+# Create or update an existing alias
+create_alias_response = @typesense.aliases.upsert('books',
+                                                  "collection_name": 'books_january')
+ap create_alias_response
+
+# Add a book using the alias name `books`
+hunger_games_book = {
+  'id': '1', 'original_publication_year': 2008, 'authors': ['Suzanne Collins'], 'average_rating': 4.34,
+  'publication_year': 2008, 'publication_year_facet': '2008', 'authors_facet': ['Suzanne Collins'],
+  'title': 'The Hunger Games',
+  'image_url': 'https://images.gr-assets.com/books/1447303603m/2767052.jpg',
+  'ratings_count': 4_780_653
+}
+
+@typesense.collections['books'].documents.create(hunger_games_book)
+
+# Search using the alias
+ap @typesense.collections['books'].documents.search(
+  'q': 'hunger',
+  'query_by': 'title',
+  'sort_by': 'ratings_count:desc'
+)
+
+# List all aliases
+ap @typesense.aliases.retrieve
+
+# Retrieve the configuration of a specific alias
+ap @typesense.aliases['books'].retrieve
+
+# Delete an alias
+ap @typesense.aliases['books'].delete