typesense 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 787ca1a4be329121969b519d1eb612c328838ea184e8505920e7775ab4f9ae71
-  data.tar.gz: 833928b07e40d987b8f864cfb89c29ba0d484a63e001150b93b9fbcb07022c74
+  metadata.gz: 6dcd2c3b6cfbf9be0a2d466eb377a55d9a419ba9334861de46cb3eefe6542d56
+  data.tar.gz: c3c6bbc4d9eb200a827d01ccbf25f2a9f660dce2237e483886237325f1ebb8eb
 SHA512:
-  metadata.gz: 58df46cbf3f36f7d5cc7af7e760660e966a17949844aba315c94f4bafd34a40a18a8bd7f91836f97dbba750464de18429704b7f8cf5b1d8099f4cef05c36601c
-  data.tar.gz: 35b72d7e825ba5f375063fcef66451f759d72f19991337290f0661da8753f774bdd8c0bea2e275c236fec0b7fcdb0e368e1fa69aa931431efbbe4d96d27713d2
+  metadata.gz: 3c76aff4123a3c2067319f6d4c168eeaf5b2f95cf50cd07fd1ab0e9c8aec9f628be408071aa52750e86e768d1751205b4da94dcfdd4246f7ccb667d2c0a1ff01
+  data.tar.gz: 9e246a32ad33a084768b8b8c0eae17c61b969296294b757936d6f157a93beeb7b2d91c046a7322676ea62a363f7a09dadb89ed01a99c6071516ef227ba515280

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/.rubocop_todo.yml

@@ -38,6 +38,10 @@ RSpec/ExampleLength:
     - 'spec/typesense/debug_spec.rb'
     - 'spec/typesense/document_spec.rb'
     - 'spec/typesense/documents_spec.rb'
+    - 'spec/typesense/override_spec.rb'
+    - 'spec/typesense/overrides_spec.rb'
+    - 'spec/typesense/alias_spec.rb'
+    - 'spec/typesense/aliases_spec.rb'
 
 # Offense count: 2
 # Configuration parameters: AggregateFailuresByDefault.
@@ -58,6 +62,10 @@ Style/Documentation:
     - 'lib/typesense/debug.rb'
     - 'lib/typesense/document.rb'
     - 'lib/typesense/documents.rb'
+    - 'lib/typesense/override.rb'
+    - 'lib/typesense/overrides.rb'
+    - 'lib/typesense/alias.rb'
+    - 'lib/typesense/aliases.rb'
 
 # Offense count: 92
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.

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).
@@ -37,4 +37,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/examples/aliases.rb

@@ -0,0 +1,80 @@
+# 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)
+
+require_relative '../lib/typesense'
+require 'awesome_print'
+
+AwesomePrint.defaults = {
+  indent: -2
+}
+
+##
+# Setup
+#
+# Start the master
+#   $ docker run -p 8108:8108  -it -v/tmp/typesense-data-master/:/data -it typesense/typesense:0.8.0-rc1 --data-dir /data --api-key=abcd --listen-port 8108 --license-key=<>
+#
+
+##
+# Create a client
+typesense = Typesense::Client.new(
+  master_node: {
+    host: 'localhost',
+    port: 8108,
+    protocol: 'http',
+    api_key: 'abcd'
+  }
+)
+
+# 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

data/examples/collections_and_documents.rb

@@ -23,39 +23,39 @@ AwesomePrint.defaults = {
 ##
 # Create a client
 typesense = Typesense::Client.new(
-  master_node:        {
-    host:     'localhost',
-    port:     8108,
+  master_node: {
+    host: 'localhost',
+    port: 8108,
     protocol: 'http',
-    api_key:  'abcd'
+    api_key: 'abcd'
   },
   read_replica_nodes: [
     {
-      host:     'localhost',
-      port:     8109,
+      host: 'localhost',
+      port: 8109,
       protocol: 'http',
-      api_key:  'wxyz'
+      api_key: 'wxyz'
     }
   ],
-  timeout_seconds:    10
+  timeout_seconds: 10
 )
 
 ##
 # Create a collection
 schema = {
-  'name'      => 'companies',
-  'fields'    => [
+  'name' => 'companies',
+  'fields' => [
     {
       'name' => 'company_name',
       'type' => 'string'
     },
     {
-      'name'  => 'num_employees',
-      'type'  => 'int32'
+      'name' => 'num_employees',
+      'type' => 'int32'
     },
     {
-      'name'  => 'country',
-      'type'  => 'string',
+      'name' => 'country',
+      'type' => 'string',
       'facet' => true
     }
   ],
@@ -178,10 +178,10 @@ typesense.collections.create(schema)
 ##
 # Create (index) a document
 document = {
-  'id'            => '124',
-  'company_name'  => 'Stark Industries',
+  'id' => '124',
+  'company_name' => 'Stark Industries',
   'num_employees' => 5215,
-  'country'       => 'USA'
+  'country' => 'USA'
 }
 
 document = typesense.collections['companies'].documents.create(document)

data/examples/overrides.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+##
+# These examples walk you through operations specifically related to overrides
+# This is a Typesense Premium feature (see: https://typesense.org/premium)
+
+require_relative '../lib/typesense'
+require 'awesome_print'
+
+AwesomePrint.defaults = {
+  indent: -2
+}
+
+##
+# Setup
+#
+# Start the master
+#   $ docker run -p 8108:8108  -it -v/tmp/typesense-data-master/:/data -it typesense/typesense:0.8.0-rc1 --data-dir /data --api-key=abcd --listen-port 8108 --license-key=<>
+
+##
+# Create a client
+typesense = Typesense::Client.new(
+  master_node: {
+    host: 'localhost',
+    port: 8108,
+    protocol: 'http',
+    api_key: 'abcd'
+  }
+)
+
+##
+# Create a collection
+schema = {
+  'name' => 'companies',
+  'fields' => [
+    {
+      'name' => 'company_name',
+      'type' => 'string'
+    },
+    {
+      'name' => 'num_employees',
+      'type' => 'int32'
+    },
+    {
+      'name' => 'country',
+      'type' => 'string',
+      'facet' => true
+    }
+  ],
+  'default_sorting_field' => 'num_employees'
+}
+
+typesense.collections.create(schema)
+
+# Let's create a couple documents for us to use in our search examples
+typesense.collections['companies'].documents.create(
+  'id' => '124',
+  'company_name' => 'Stark Industries',
+  'num_employees' => 5215,
+  'country' => 'USA'
+)
+
+typesense.collections['companies'].documents.create(
+  'id' => '127',
+  'company_name' => 'Stark Corp',
+  'num_employees' => 1031,
+  'country' => 'USA'
+)
+
+typesense.collections['companies'].documents.create(
+  'id' => '125',
+  'company_name' => 'Acme Corp',
+  'num_employees' => 1002,
+  'country' => 'France'
+)
+
+typesense.collections['companies'].documents.create(
+  'id' => '126',
+  'company_name' => 'Doofenshmirtz Inc',
+  'num_employees' => 2,
+  'country' => 'Tri-State Area'
+)
+
+##
+# Create overrides
+
+typesense.collections['companies'].overrides.create(
+  "id": 'promote-doofenshmirtz',
+  "rule": {
+    "query": 'doofen',
+    "match": 'exact'
+  },
+  "includes": [{ 'id' => '126', 'position' => 1 }]
+)
+typesense.collections['companies'].overrides.create(
+  "id": 'promote-acme',
+  "rule": {
+    "query": 'stark',
+    "match": 'exact'
+  },
+  "includes": [{ 'id' => '125', 'position' => 1 }]
+)
+
+##
+# Search for documents
+results = typesense.collections['companies'].documents.search(
+  'q' => 'doofen',
+  'query_by' => 'company_name'
+)
+ap results
+
+results = typesense.collections['companies'].documents.search(
+  'q' => 'stark',
+  'query_by' => 'company_name'
+)
+ap results
+
+results = typesense.collections['companies'].documents.search(
+  'q' => 'Inc',
+  'query_by' => 'company_name',
+  'filter_by' => 'num_employees:<100',
+  'sort_by' => 'num_employees:desc'
+)
+ap results
+
+##
+# Cleanup
+# Drop the collection
+typesense.collections['companies'].delete

data/examples/search.rb

@@ -22,39 +22,39 @@ AwesomePrint.defaults = {
 ##
 # Create a client
 typesense = Typesense::Client.new(
-  master_node:        {
-    host:     'localhost',
-    port:     8108,
+  master_node: {
+    host: 'localhost',
+    port: 8108,
     protocol: 'http',
-    api_key:  'abcd'
+    api_key: 'abcd'
   },
   read_replica_nodes: [
     {
-      host:     'localhost',
-      port:     8109,
+      host: 'localhost',
+      port: 8109,
       protocol: 'http',
-      api_key:  'wxyz'
+      api_key: 'wxyz'
     }
   ],
-  timeout_seconds:    10
+  timeout_seconds: 10
 )
 
 ##
 # Create a collection
 schema = {
-  'name'      => 'companies',
-  'fields'    => [
+  'name' => 'companies',
+  'fields' => [
     {
       'name' => 'company_name',
       'type' => 'string'
     },
     {
-      'name'  => 'num_employees',
-      'type'  => 'int32'
+      'name' => 'num_employees',
+      'type' => 'int32'
     },
     {
-      'name'  => 'country',
-      'type'  => 'string',
+      'name' => 'country',
+      'type' => 'string',
       'facet' => true
     }
   ],
@@ -135,9 +135,9 @@ ap results
 # Search for more documents
 results = typesense.collections['companies'].documents.search(
   'q' => 'Inc',
-  'query_by'  => 'company_name',
+  'query_by' => 'company_name',
   'filter_by' => 'num_employees:<100',
-  'sort_by'   => 'num_employees:desc'
+  'sort_by' => 'num_employees:desc'
 )
 ap results
 
@@ -164,7 +164,7 @@ ap results
 ##
 # Search for more documents
 results = typesense.collections['companies'].documents.search(
-  'q'        => 'Non-existent',
+  'q' => 'Non-existent',
   'query_by' => 'company_name'
 )
 ap results

data/lib/typesense.rb

@@ -11,5 +11,9 @@ require_relative 'typesense/collections'
 require_relative 'typesense/collection'
 require_relative 'typesense/documents'
 require_relative 'typesense/document'
+require_relative 'typesense/overrides'
+require_relative 'typesense/override'
+require_relative 'typesense/aliases'
+require_relative 'typesense/alias'
 require_relative 'typesense/debug'
 require_relative 'typesense/error'

data/lib/typesense/alias.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Typesense
+  class Alias
+    def initialize(configuration, name)
+      @configuration = configuration
+      @name          = name
+    end
+
+    def retrieve
+      ApiCall.new(@configuration).get(endpoint_path)
+    end
+
+    def delete
+      ApiCall.new(@configuration).delete(endpoint_path)
+    end
+
+    private
+
+    def endpoint_path
+      "#{Aliases::RESOURCE_PATH}/#{@name}"
+    end
+  end
+end

data/lib/typesense/aliases.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Typesense
+  class Aliases
+    RESOURCE_PATH = '/aliases'
+
+    def initialize(configuration)
+      @configuration = configuration
+      @aliases = {}
+    end
+
+    def upsert(alias_name, mapping)
+      ApiCall.new(@configuration).put(endpoint_path(alias_name), mapping)
+    end
+
+    def retrieve
+      ApiCall.new(@configuration).get(RESOURCE_PATH)
+    end
+
+    def [](alias_name)
+      @aliases[alias_name] ||= Alias.new(@configuration, alias_name)
+    end
+
+    private
+
+    def endpoint_path(alias_name)
+      "#{Aliases::RESOURCE_PATH}/#{alias_name}"
+    end
+  end
+end

data/lib/typesense/api_call.rb

@@ -16,12 +16,22 @@ module Typesense
       perform_with_error_handling(:do_not_use_read_replicas) do
         self.class.post(uri_for(endpoint),
                         default_options.merge(
-                          body:    parameters.to_json,
+                          body: parameters.to_json,
                           headers: default_headers.merge('Content-Type' => 'application/json')
                         ))
       end.parsed_response
     end
 
+    def put(endpoint, parameters = {})
+      perform_with_error_handling(:do_not_use_read_replicas) do
+        self.class.put(uri_for(endpoint),
+                       default_options.merge(
+                         body: parameters.to_json,
+                         headers: default_headers.merge('Content-Type' => 'application/json')
+                       ))
+      end.parsed_response
+    end
+
     def get(endpoint, parameters = {})
       get_unparsed_response(endpoint, parameters).parsed_response
     end
@@ -30,7 +40,7 @@ module Typesense
       perform_with_error_handling(:use_read_replicas) do |node, node_index|
         self.class.get(uri_for(endpoint, node, node_index),
                        default_options.merge(
-                         query:   parameters,
+                         query: parameters,
                          headers: default_headers
                        ))
       end
@@ -40,7 +50,7 @@ module Typesense
       perform_with_error_handling(:do_not_use_read_replicas) do
         self.class.delete(uri_for(endpoint),
                           default_options.merge(
-                            query:   parameters,
+                            query: parameters,
                             headers: default_headers
                           ))
       end.parsed_response
@@ -89,7 +99,7 @@ module Typesense
              Errno::EINVAL, Errno::ENETDOWN, Errno::ENETUNREACH, Errno::ENETRESET, Errno::ECONNABORTED, Errno::ECONNRESET,
              Errno::ETIMEDOUT, Errno::ECONNREFUSED, Errno::EHOSTDOWN, Errno::EHOSTUNREACH,
              Timeout::Error, Error::ServerError, HTTParty::ResponseError
-        if (use_read_replicas == :use_read_replicas || use_read_replicas == true) &&
+        if ([:use_read_replicas, true].include? use_read_replicas) &&
            !@configuration.read_replica_nodes.nil?
           node = :read_replica
           node_index += 1

data/lib/typesense/client.rb

@@ -4,12 +4,14 @@ module Typesense
   class Client
     attr_reader :configuration
     attr_reader :collections
+    attr_reader :aliases
     attr_reader :debug
 
     def initialize(options = {})
-      @configuration ||= Configuration.new(options)
-      @collections   = Collections.new(@configuration)
-      @debug         = Debug.new(@configuration)
+      @configuration = Configuration.new(options)
+      @collections = Collections.new(@configuration)
+      @aliases = Aliases.new(@configuration)
+      @debug = Debug.new(@configuration)
     end
   end
 end

data/lib/typesense/collection.rb

@@ -3,11 +3,13 @@
 module Typesense
   class Collection
     attr_reader :documents
+    attr_reader :overrides
 
     def initialize(configuration, name)
       @configuration = configuration
       @name          = name
       @documents     = Documents.new(@configuration, @name)
+      @overrides     = Overrides.new(@configuration, @name)
     end
 
     def retrieve

data/lib/typesense/configuration.rb

@@ -8,8 +8,8 @@ module Typesense
 
     def initialize(options = {})
       @master_node = options[:master_node] || {
-        host:     'localhost',
-        port:     '8108',
+        host: 'localhost',
+        port: '8108',
         protocol: 'http'
       }
 

data/lib/typesense/override.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Typesense
+  class Override
+    def initialize(configuration, collection_name, override_id)
+      @configuration   = configuration
+      @collection_name = collection_name
+      @override_id     = override_id
+    end
+
+    def retrieve
+      ApiCall.new(@configuration).get(endpoint_path)
+    end
+
+    def delete
+      ApiCall.new(@configuration).delete(endpoint_path)
+    end
+
+    private
+
+    def endpoint_path
+      "#{Collections::RESOURCE_PATH}/#{@collection_name}#{Overrides::RESOURCE_PATH}/#{@override_id}"
+    end
+  end
+end

data/lib/typesense/overrides.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Typesense
+  class Overrides
+    RESOURCE_PATH = '/overrides'
+
+    def initialize(configuration, collection_name)
+      @configuration   = configuration
+      @collection_name = collection_name
+      @overrides       = {}
+    end
+
+    def create(params)
+      ApiCall.new(@configuration).put(endpoint_path, params)
+    end
+
+    def retrieve
+      ApiCall.new(@configuration).get(endpoint_path)
+    end
+
+    def [](override_id)
+      @overrides[override_id] ||= Override.new(@configuration, @collection_name, override_id)
+    end
+
+    private
+
+    def endpoint_path(operation = nil)
+      "#{Collections::RESOURCE_PATH}/#{@collection_name}#{Overrides::RESOURCE_PATH}#{operation.nil? ? '' : '/' + operation}"
+    end
+  end
+end

data/lib/typesense/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Typesense
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/typesense.gemspec

@@ -7,7 +7,7 @@ require 'typesense/version'
 Gem::Specification.new do |spec|
   spec.name          = 'typesense'
   spec.version       = Typesense::VERSION
-  spec.authors       = ['Wreally Studios']
+  spec.authors       = ['Typesense, Inc.']
   spec.email         = ['contact@typesense.org']
 
   spec.summary       = 'Ruby Library for Typesense'
@@ -23,15 +23,17 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'awesome_print', '~> 1.8'
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'pry-byebug', '~> 3.5'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.3'
-  spec.add_development_dependency 'rubocop', '~> 0.53.0'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.24'
-  spec.add_development_dependency 'simplecov', '~> 0.15'
-  spec.add_development_dependency 'webmock', '~> 3.2'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'codecov', '~> 0.1'
+  spec.add_development_dependency 'pry-byebug', '~> 3.7'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_development_dependency 'rspec-legacy_formatters', '~> 1.0' # For codecov formatter
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.4'
+  spec.add_development_dependency 'rubocop', '~> 0.76'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.36'
+  spec.add_development_dependency 'simplecov', '~> 0.17'
+  spec.add_development_dependency 'webmock', '~> 3.7'
 
-  spec.add_dependency 'httparty', '~> 0.15'
+  spec.add_dependency 'httparty', '~> 0.17'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typesense
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
-- Wreally Studios
+- Typesense, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-04 00:00:00.000000000 Z
+date: 2019-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -30,140 +30,168 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rspec-legacy_formatters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.53.0
+        version: '0.76'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.53.0
+        version: '0.76'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: '1.36'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: '1.36'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.17'
 description: Typesense is an open source search engine for building a delightful search
   experience.
 email:
@@ -183,9 +211,13 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/aliases.rb
 - examples/collections_and_documents.rb
+- examples/overrides.rb
 - examples/search.rb
 - lib/typesense.rb
+- lib/typesense/alias.rb
+- lib/typesense/aliases.rb
 - lib/typesense/api_call.rb
 - lib/typesense/client.rb
 - lib/typesense/collection.rb
@@ -195,6 +227,8 @@ files:
 - lib/typesense/document.rb
 - lib/typesense/documents.rb
 - lib/typesense/error.rb
+- lib/typesense/override.rb
+- lib/typesense/overrides.rb
 - lib/typesense/version.rb
 - typesense.gemspec
 homepage: https://typesense.org
@@ -216,8 +250,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Ruby Library for Typesense