typesense 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7938337742ce5b45e214069abd8f70bcabd0a247ad47dec68f5f48b43a1841c7
+  data.tar.gz: b71fd0346976e30ce637a42e16496b650bdfba80ba7e012f5d712c4a169decc2
+SHA512:
+  metadata.gz: ee805aefbcea10f4275b5aac9efeace0e5bf422bd4d30911ea67223ce8e334264bb4731927a98aca7990fbe2890d7a18357e0c530d85f46d30ae8c5435766a7e
+  data.tar.gz: 546ba5bd5f554bad1c16e97e5cb3c37cf0945324f269b9b0273fb3e85ffc5b79c672bea80779b8347da2660b7db78f76d761fc90211c05470f581e0060a21bae

data/.circleci/config.yml

@@ -0,0 +1,67 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.4.1-node-browsers
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+#      # Download and cache dependencies
+#      - restore_cache:
+#          keys:
+#          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+#          # fallback to using the latest cache if no exact match is found
+#          - v1-dependencies-
+
+      - run:
+          name: update bundler
+          command: |
+            gem install bundler
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+#      - save_cache:
+#          paths:
+#            - ./vendor/bundle
+#          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      - run:
+          name: lint
+          command: |
+            rubocop
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+
+            bundle exec rspec --format documentation \
+                            --format RspecJunitFormatter \
+                            --out /tmp/test-results/rspec.xml
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results
+      - store_artifacts:
+          path: coverage
+          destination: coverage

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--order rand
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,12 @@
+inherit_from: .rubocop_todo.yml
+
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: "2.4"
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'Gemfile'
+    - 'typesense.gemspec'

data/.rubocop_todo.yml

@@ -0,0 +1,66 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-03-17 15:11:06 -0700 using RuboCop version 0.53.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
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Lint/ShadowedException:
+  Exclude:
+    - 'lib/typesense/api_call.rb'
+
+# Offense count: 3
+Metrics/AbcSize:
+  Max: 37
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 13
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 35
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 14
+
+# 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.
+RSpec/MultipleExpectations:
+  Max: 2
+
+# Offense count: 9
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/typesense.rb'
+    - 'lib/typesense/api_call.rb'
+    - 'lib/typesense/client.rb'
+    - 'lib/typesense/collection.rb'
+    - 'lib/typesense/collections.rb'
+    - 'lib/typesense/configuration.rb'
+    - 'lib/typesense/debug.rb'
+    - 'lib/typesense/document.rb'
+    - 'lib/typesense/documents.rb'
+
+# Offense count: 92
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 245

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in typesense.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2018 Wreally Studios Inc. <contact@wreally.com> http://wreally.com
+
+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
+
+    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

@@ -0,0 +1,40 @@
+# Typesense Ruby Library [![CircleCI](https://circleci.com/gh/typesense/typesense-ruby.svg?style=shield&circle-token=063f2179925b0b37d540126f6c96f6e1fe23f1b9)](https://circleci.com/gh/typesense/typesense-ruby)
+
+
+Ruby client library for accessing the [Typesense HTTP API](https://github.com/typesense/typesense).
+
+Follows the API spec [here](https://github.com/typesense/typesense-api-spec).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'typesense'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install typesense
+
+## Usage
+
+You'll find detailed documentation here: [https://typesense.org/api/](https://typesense.org/api/)
+
+Here are some examples that show you how the Ruby client works: [examples](examples)
+
+Tests are also a good place to know how the the library works internally: [spec](spec)
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [typesense/typesense-ruby](https://github.com/typesense/typesense-ruby).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'typesense'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/collections_and_documents.rb

@@ -0,0 +1,251 @@
+# frozen_string_literal: true
+
+##
+# These examples walk you through all the operations you can do on a collection and a document
+# Search is specifically covered in another file in the examples folder
+
+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
+#
+# Start the read replica
+#   $ docker run -p 8109:8109  -it -v/tmp/typesense-data-read-replica-1/:/data -it typesense/typesense:0.8.0-rc1 --data-dir /data --api-key=wxyz --listen-port 8109 --master http://localhost:8108
+
+##
+# Create a client
+typesense = Typesense::Client.new(
+  master_node:        {
+    host:     'localhost',
+    port:     8108,
+    protocol: 'http',
+    api_key:  'abcd'
+  },
+  read_replica_nodes: [
+    {
+      host:     'localhost',
+      port:     8109,
+      protocol: 'http',
+      api_key:  'wxyz'
+    }
+  ],
+  timeout_seconds:    10
+)
+
+##
+# 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'
+}
+
+collection = typesense.collections.create(schema)
+ap collection
+
+# {
+#   "name"                  => "companies",
+#   "fields"                => [
+#     [0] {
+#       "name" => "company_name",
+#       "type" => "string"
+#     },
+#     [1] {
+#       "name" => "num_employees",
+#       "type" => "int32"
+#     },
+#     [2] {
+#       "name"  => "country",
+#       "type"  => "string",
+#       "facet" => true
+#     }
+#   ],
+#   "default_sorting_field" => "num_employees"
+# }
+
+##
+# Retrieve a collection
+collection = typesense.collections['companies'].retrieve
+ap collection
+
+# {
+#   "default_sorting_field" => "num_employees",
+#   "fields"                => [
+#     [0] {
+#       "facet" => false,
+#       "name"  => "company_name",
+#       "type"  => "string"
+#     },
+#     [1] {
+#       "facet" => false,
+#       "name"  => "num_employees",
+#       "type"  => "int32"
+#     },
+#     [2] {
+#       "facet" => true,
+#       "name"  => "country",
+#       "type"  => "string"
+#     }
+#   ],
+#   "name"                  => "companies",
+#   "num_documents"         => 0
+# }
+
+##
+# Retrieve all collections
+collections = typesense.collections.retrieve
+ap collections
+
+# [
+#   [0] {
+#     "default_sorting_field" => "num_employees",
+#     "fields"                => [
+#       [0] {
+#         "facet" => false,
+#         "name"  => "company_name",
+#         "type"  => "string"
+#       },
+#       [1] {
+#         "facet" => false,
+#         "name"  => "num_employees",
+#         "type"  => "int32"
+#       },
+#       [2] {
+#         "facet" => true,
+#         "name"  => "country",
+#         "type"  => "string"
+#       }
+#     ],
+#     "name"                  => "companies",
+#     "num_documents"         => 0
+#   }
+# ]
+
+##
+# Delete a collection
+#   Deletion returns the schema of the collection after deletion
+collection = typesense.collections['companies'].delete
+ap collection
+
+# {
+#   "default_sorting_field" => "num_employees",
+#   "fields"                => [
+#     [0] {
+#       "facet" => false,
+#       "name"  => "company_name",
+#       "type"  => "string"
+#     },
+#     [1] {
+#       "facet" => false,
+#       "name"  => "num_employees",
+#       "type"  => "int32"
+#     },
+#     [2] {
+#       "facet" => true,
+#       "name"  => "country",
+#       "type"  => "string"
+#     }
+#   ],
+#   "name"                  => "companies",
+#   "num_documents"         => 0
+# }
+
+# Let's create the collection again for use in our remaining examples
+typesense.collections.create(schema)
+
+##
+# Create (index) a document
+document = {
+  'id'            => '124',
+  'company_name'  => 'Stark Industries',
+  'num_employees' => 5215,
+  'country'       => 'USA'
+}
+
+document = typesense.collections['companies'].documents.create(document)
+ap document
+
+# {
+#   "company_name"  => "Stark Industries",
+#   "country"       => "USA",
+#   "id"            => "124",
+#   "num_employees" => 5215
+# }
+
+##
+# Retrieve a document
+document = typesense.collections['companies'].documents['124'].retrieve
+ap document
+
+# {
+#   "company_name"  => "Stark Industries",
+#   "country"       => "USA",
+#   "id"            => "124",
+#   "num_employees" => 5215
+# }
+
+##
+# Delete a document
+#   Deleting a document, returns the document after deletion
+document = typesense.collections['companies'].documents['124'].delete
+ap document
+
+# {
+#   "company_name"  => "Stark Industries",
+#   "country"       => "USA",
+#   "id"            => "124",
+#   "num_employees" => 5215
+# }
+
+# Let's create two documents again for use in our remaining examples
+typesense.collections['companies'].documents.create(
+  'id' => '124',
+  'company_name' => 'Stark Industries',
+  'num_employees' => 5215,
+  'country' => 'USA'
+)
+
+typesense.collections['companies'].documents.create(
+  'id' => '125',
+  'company_name' => 'Acme Corp',
+  'num_employees' => 1002,
+  'country' => 'France'
+)
+
+##
+# Export all documents in a collection in JSON Lines format
+#   We use JSON Lines format for performance reasons. You can choose to parse selected lines (elements in the array) as needed.
+array_of_json_strings = typesense.collections['companies'].documents.export
+ap array_of_json_strings
+
+# [
+# [0] "{\"company_name\":\"Stark Industries\",\"country\":\"USA\",\"id\":\"124\",\"num_employees\":5215}",
+# [1] "{\"company_name\":\"Acme Corp\",\"country\":\"France\",\"id\":\"125\",\"num_employees\":1002}"
+# ]
+
+##
+# Cleanup
+# Drop the collection
+typesense.collections['companies'].delete

data/examples/search.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+##
+# These examples walk you through operations specifically related to search
+
+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
+#
+# Start the read replica
+#   $ docker run -p 8109:8109  -it -v/tmp/typesense-data-read-replica-1/:/data -it typesense/typesense:0.8.0-rc1 --data-dir /data --api-key=wxyz --listen-port 8109 --master http://localhost:8108
+
+##
+# Create a client
+typesense = Typesense::Client.new(
+  master_node:        {
+    host:     'localhost',
+    port:     8108,
+    protocol: 'http',
+    api_key:  'abcd'
+  },
+  read_replica_nodes: [
+    {
+      host:     'localhost',
+      port:     8109,
+      protocol: 'http',
+      api_key:  'wxyz'
+    }
+  ],
+  timeout_seconds:    10
+)
+
+##
+# 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'
+)
+
+##
+# Search for documents
+results = typesense.collections['companies'].documents.search(
+  'q' => 'Stark',
+  'query_by' => 'company_name'
+)
+ap results
+
+# {
+#   "facet_counts"   => [],
+#   "found"          => 2,
+#   "hits"           => [
+#     [0] {
+#       "document"  => {
+#         "company_name"  => "Stark Industries",
+#         "country"       => "USA",
+#         "id"            => "124",
+#         "num_employees" => 5215
+#       },
+#       "highlight" => {
+#         "company_name" => "<mark>Stark</mark> Industries"
+#       }
+#     },
+#     [1] {
+#       "document"  => {
+#         "company_name"  => "Stark Corp",
+#         "country"       => "USA",
+#         "id"            => "127",
+#         "num_employees" => 1031
+#       },
+#       "highlight" => {
+#         "company_name" => "<mark>Stark</mark> Corp"
+#       }
+#     }
+#   ],
+#   "page"           => 1,
+#   "search_time_ms" => 0
+# }
+
+##
+# Search for more documents
+results = typesense.collections['companies'].documents.search(
+  'q' => 'Inc',
+  'query_by'  => 'company_name',
+  'filter_by' => 'num_employees:<100',
+  'sort_by'   => 'num_employees:desc'
+)
+ap results
+
+# {
+#   "facet_counts"   => [],
+#   "found"          => 1,
+#   "hits"           => [
+#     [0] {
+#       "document"  => {
+#         "company_name"  => "Doofenshmirtz Inc",
+#         "country"       => "Tri-State Area",
+#         "id"            => "126",
+#         "num_employees" => 2
+#       },
+#       "highlight" => {
+#         "company_name" => "Doofenshmirtz <mark>Inc</mark>"
+#       }
+#     }
+#   ],
+#   "page"           => 1,
+#   "search_time_ms" => 0
+# }
+
+##
+# Search for more documents
+results = typesense.collections['companies'].documents.search(
+  'q'        => 'Non-existent',
+  'query_by' => 'company_name'
+)
+ap results
+
+# {
+#   "found"          => 0,
+#   "hits"           => [],
+#   "page"           => 1,
+#   "search_time_ms" => 0
+# }
+
+##
+# Cleanup
+# Drop the collection
+typesense.collections['companies'].delete

data/lib/typesense.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Typesense
+end
+
+require_relative 'typesense/version'
+require_relative 'typesense/configuration'
+require_relative 'typesense/client'
+require_relative 'typesense/api_call'
+require_relative 'typesense/collections'
+require_relative 'typesense/collection'
+require_relative 'typesense/documents'
+require_relative 'typesense/document'
+require_relative 'typesense/debug'
+require_relative 'typesense/error'

data/lib/typesense/api_call.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require 'httparty'
+
+module Typesense
+  class ApiCall
+    include HTTParty
+
+    API_KEY_HEADER_NAME = 'X-TYPESENSE-API-KEY'
+
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    def post(endpoint, parameters = {})
+      perform_with_error_handling(:do_not_use_read_replicas) do
+        self.class.post(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
+
+    def get_unparsed_response(endpoint, parameters = {})
+      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,
+                         headers: default_headers
+                       ))
+      end
+    end
+
+    def delete(endpoint, parameters = {})
+      perform_with_error_handling(:do_not_use_read_replicas) do
+        self.class.delete(uri_for(endpoint),
+                          default_options.merge(
+                            query:   parameters,
+                            headers: default_headers
+                          ))
+      end.parsed_response
+    end
+
+    private
+
+    def uri_for(endpoint, node = :master, node_index = 0)
+      if node == :read_replica
+        "#{@configuration.read_replica_nodes[node_index][:protocol]}://#{@configuration.read_replica_nodes[node_index][:host]}:#{@configuration.read_replica_nodes[node_index][:port]}#{endpoint}"
+      else
+        "#{@configuration.master_node[:protocol]}://#{@configuration.master_node[:host]}:#{@configuration.master_node[:port]}#{endpoint}"
+      end
+    end
+
+    def perform_with_error_handling(use_read_replicas = :do_not_use_read_replicas)
+      @configuration.validate!
+
+      node       = :master
+      node_index = -1
+
+      begin
+        response_object = yield node, node_index
+
+        return response_object if response_object.response.code_type <= Net::HTTPSuccess # 2xx
+
+        error_klass = if response_object.response.code_type <= Net::HTTPBadRequest # 400
+                        Error::RequestMalformed
+                      elsif response_object.response.code_type <= Net::HTTPUnauthorized # 401
+                        Error::RequestUnauthorized
+                      elsif response_object.response.code_type <= Net::HTTPNotFound # 404
+                        Error::ObjectNotFound
+                      elsif response_object.response.code_type <= Net::HTTPConflict # 409
+                        Error::ObjectAlreadyExists
+                      elsif response_object.response.code_type <= Net::HTTPUnprocessableEntity # 422
+                        Error::ObjectUnprocessable
+                      elsif response_object.response.code_type <= Net::HTTPServerError # 5xx
+                        Error::ServerError
+                      else
+                        Error
+                      end
+
+        raise error_klass, response_object.parsed_response['message']
+      rescue Net::ReadTimeout, Net::OpenTimeout,
+             EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError,
+             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) &&
+           !@configuration.read_replica_nodes.nil?
+          node = :read_replica
+          node_index += 1
+
+          retry unless @configuration.read_replica_nodes[node_index].nil?
+        end
+
+        raise
+      end
+    end
+
+    def default_options
+      {
+        timeout: @configuration.timeout_seconds
+      }
+    end
+
+    def default_headers
+      {
+        API_KEY_HEADER_NAME.to_s => @configuration.master_node[:api_key]
+      }
+    end
+  end
+end

data/lib/typesense/client.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Typesense
+  class Client
+    attr_reader :configuration
+    attr_reader :collections
+    attr_reader :debug
+
+    def initialize(options = {})
+      @configuration ||= Configuration.new(options)
+      @collections   = Collections.new(@configuration)
+      @debug         = Debug.new(@configuration)
+    end
+  end
+end

data/lib/typesense/collection.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Typesense
+  class Collection
+    attr_reader :documents
+
+    def initialize(configuration, name)
+      @configuration = configuration
+      @name          = name
+      @documents     = Documents.new(@configuration, @name)
+    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}/#{@name}"
+    end
+  end
+end

data/lib/typesense/collections.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Typesense
+  class Collections
+    RESOURCE_PATH = '/collections'
+
+    def initialize(configuration)
+      @configuration = configuration
+      @collections   = {}
+    end
+
+    def create(schema)
+      ApiCall.new(@configuration).post(RESOURCE_PATH, schema)
+    end
+
+    def retrieve
+      ApiCall.new(@configuration).get(RESOURCE_PATH)
+    end
+
+    def [](collection_name)
+      @collections[collection_name] ||= Collection.new(@configuration, collection_name)
+    end
+  end
+end

data/lib/typesense/configuration.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Typesense
+  class Configuration
+    attr_accessor :master_node
+    attr_accessor :read_replica_nodes
+    attr_accessor :timeout_seconds
+
+    def initialize(options = {})
+      @master_node = options[:master_node] || {
+        host:     'localhost',
+        port:     '8108',
+        protocol: 'http'
+      }
+
+      @read_replica_nodes = options[:read_replica_nodes] || []
+      @timeout_seconds    = options[:timeout_seconds] || 10
+    end
+
+    def validate!
+      if @master_node.nil? ||
+         node_missing_parameters?(@master_node)
+        raise Error::MissingConfiguration, 'Missing required configuration. Ensure that master_node[:protocol], master_node[:host], master_node[:port] and master_node[:api_key] are set.'
+      end
+
+      if !@read_replica_nodes.nil? &&
+         @read_replica_nodes.any? { |node| node_missing_parameters?(node) }
+        raise Error::MissingConfiguration, 'Missing required configuration for read_replica_nodes. Ensure that read_replica_nodes[][:protocol], read_replica_nodes[][:host], read_replica_nodes[][:port] and read_replica_nodes[][:api_key] are set.'
+      end
+    end
+
+    private
+
+    def node_missing_parameters?(node)
+      %i[protocol host port api_key].any? { |attr| node.send(:[], attr).nil? }
+    end
+  end
+end

data/lib/typesense/debug.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Typesense
+  class Debug
+    RESOURCE_PATH = '/debug'
+
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    def retrieve
+      ApiCall.new(@configuration).get(RESOURCE_PATH)
+    end
+  end
+end

data/lib/typesense/document.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Typesense
+  class Document
+    def initialize(configuration, collection_name, document_id)
+      @configuration   = configuration
+      @collection_name = collection_name
+      @document_id     = document_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}#{Documents::RESOURCE_PATH}/#{@document_id}"
+    end
+  end
+end

data/lib/typesense/documents.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Typesense
+  class Documents
+    RESOURCE_PATH = '/documents'
+
+    def initialize(configuration, collection_name)
+      @configuration   = configuration
+      @collection_name = collection_name
+      @documents       = {}
+    end
+
+    def create(document)
+      ApiCall.new(@configuration).post(endpoint_path, document)
+    end
+
+    def export
+      ApiCall.new(@configuration).get_unparsed_response(endpoint_path('export')).split("\n")
+    end
+
+    def search(search_parameters)
+      ApiCall.new(@configuration).get(endpoint_path('search'), search_parameters)
+    end
+
+    def [](document_id)
+      @documents[document_id] ||= Document.new(@configuration, @collection_name, document_id)
+    end
+
+    private
+
+    def endpoint_path(operation = nil)
+      "#{Collections::RESOURCE_PATH}/#{@collection_name}#{Documents::RESOURCE_PATH}#{operation.nil? ? '' : '/' + operation}"
+    end
+  end
+end

data/lib/typesense/error.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Typesense
+  class Error < StandardError
+    class MissingConfiguration < Error
+    end
+
+    class ObjectAlreadyExists < Error
+    end
+
+    class ObjectNotFound < Error
+    end
+
+    class ObjectUnprocessable < Error
+    end
+
+    class RequestMalformed < Error
+    end
+
+    class RequestUnauthorized < Error
+    end
+
+    class ServerError < Error
+    end
+
+    class NoMethodError < ::NoMethodError
+    end
+  end
+end

data/lib/typesense/version.rb

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

data/typesense.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'typesense/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'typesense'
+  spec.version       = Typesense::VERSION
+  spec.authors       = ['Wreally Studios']
+  spec.email         = ['contact@typesense.org']
+
+  spec.summary       = 'Ruby Library for Typesense'
+  spec.description   = 'Typesense is an open source search engine for building a delightful search experience.'
+  spec.homepage      = 'https://github.com/typesense/typesense-ruby'
+  spec.license       = 'Apache-2.0'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  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_dependency 'httparty', '~> 0.15'
+end

metadata

@@ -0,0 +1,224 @@
+--- !ruby/object:Gem::Specification
+name: typesense
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wreally Studios
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.53.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.53.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+description: Typesense is an open source search engine for building a delightful search
+  experience.
+email:
+- contact@typesense.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/collections_and_documents.rb
+- examples/search.rb
+- lib/typesense.rb
+- lib/typesense/api_call.rb
+- lib/typesense/client.rb
+- lib/typesense/collection.rb
+- lib/typesense/collections.rb
+- lib/typesense/configuration.rb
+- lib/typesense/debug.rb
+- lib/typesense/document.rb
+- lib/typesense/documents.rb
+- lib/typesense/error.rb
+- lib/typesense/version.rb
+- typesense.gemspec
+homepage: https://github.com/typesense/typesense-ruby
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Ruby Library for Typesense
+test_files: []