meilisearch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c31820aca925f28c1e53011587a9f6f2d9dfd210425ee3e1bce4c6e2728cb655
+  data.tar.gz: a74b7e2540093dc1f7fc65f5da4259cd2c07e17460ce2497be66899559cd0137
+SHA512:
+  metadata.gz: 9b07704bb782d34b98b68b39e6a243f2882e22bc088e1ea3d66ca89f5371efa6843aa7a9b58251d3a9d0acb68825b65e61037a70f9b1ca0cd0e7e6a614aad5a3
+  data.tar.gz: c3a1018f981315a8e55135074ac88c688e94c8fab6ce0d2544c0db587d3ba3e9a91e24771455ddf32716c283931092c751ce4d7a413b45e9a26deaf4894f153e

data/lib/meilisearch/client/documents.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module MeiliSearch
+  class Client
+    module Documents
+      def add_documents(index_name, documents)
+        documents.each_slice(1000).map do |slice|
+          post "/indexes/#{index_name}/documents", slice
+        end
+      end
+
+      def document(index_name, document_uid)
+        get "/indexes/#{index_name}/documents/#{document_uid}"
+      end
+
+      def get_all_documents(index_name)
+        get "/indexes/#{index_name}/documents"
+      end
+
+      def batch_documents
+        raise NotImplementedError
+      end
+
+      def update_documents
+        raise NotImplementedError
+      end
+
+      def delete_one_document(index_name, document_uid)
+        delete "/indexes/#{index_name}/documents/#{document_uid}"
+      end
+
+      def delete_multiple_documents(index_name, document_uids)
+        post "/indexes/#{index_name}/documents/delete", document_uids
+      end
+
+      def clear_all_documents(index_name)
+        delete "/indexes/#{index_name}/documents"
+      end
+    end
+  end
+end

data/lib/meilisearch/client/health.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module MeiliSearch
+  class Client
+    module Health
+      def is_healthy?
+        get '/health'
+        true
+      rescue StandardError
+        false
+      end
+
+      def health
+        get '/health'
+      end
+
+      def update_health(bool)
+        put '/health', health: bool
+      end
+    end
+  end
+end

data/lib/meilisearch/client/indexes.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module MeiliSearch
+  class Client
+    module Indexes
+      def indexes
+        get '/indexes'
+      end
+
+      def index(index_uid)
+        get "/indexes/#{index_uid}"
+      end
+
+      def create_index(index_uid, schema = nil)
+        if schema.nil?
+          post "/indexes/#{index_uid}"
+        else
+          post "/indexes/#{index_uid}", schema
+        end
+      end
+
+      def update_index(index_uid, schema = nil)
+        put "/indexes/#{index_uid}", schema
+      end
+
+      def delete_index(index_uid)
+        delete "/indexes/#{index_uid}"
+      end
+    end
+  end
+end

data/lib/meilisearch/client/keys.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module MeiliSearch
+  class Client
+    module Keys
+      def keys
+        get '/keys'
+      end
+
+      def key(key_hash)
+        get "/keys/#{key_hash}"
+      end
+
+      def create_key(options = {})
+        post '/keys', options
+      end
+
+      def update_key(key_hash, options = {})
+        put "/keys/#{key_hash}", options
+      end
+
+      def delete_key(key_hash)
+        delete "/keys/#{key_hash}"
+      end
+    end
+  end
+end

data/lib/meilisearch/client/objects.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module MeiliSearch
+  class Client
+    module Objects
+      def add_objects(index_name, objects)
+        if objects.size <= 1000
+          post "/indexes/#{index_name}/objects", objects
+        else
+          objects.each_slice(1000) do |slice|
+            post "/indexes/#{index_name}/objects", slice
+          end
+        end
+      end
+
+      def object(index_name, object_identifier)
+        get "/indexes/#{index_name}/objects/#{object_identifier}"
+      end
+
+      def browse(index_name)
+        get "/indexes/#{index_name}/objects"
+      end
+
+      def batch_objects
+        raise NotImplementedError
+      end
+
+      def update_objects
+        raise NotImplementedError
+      end
+
+      def delete_objects(index_name, object_ids)
+        delete "/indexes/#{index_name}/objects", object_ids
+      end
+    end
+  end
+end

data/lib/meilisearch/client/prepare.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module MeiliSearch
+  class Client
+    module Prepare
+      def rollout
+        put '/prepare/rollout'
+      end
+    end
+  end
+end

data/lib/meilisearch/client/search.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module MeiliSearch
+  class Client
+    module Search
+      def search(index_uid, query, options = {})
+        get "/indexes/#{index_uid}/search", { q: query }.merge(options)
+      end
+    end
+  end
+end

data/lib/meilisearch/client/stats.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module MeiliSearch
+  class Client
+    module Stats
+      def version
+        get '/version'
+      end
+
+      def sysinfo
+        get '/sys-info'
+      end
+
+      def stats
+        get '/stats'
+      end
+
+      def stats_index(index_uid)
+        get "/stats/#{index_uid}"
+      end
+
+      def number_of_documents_in_index(index_uid)
+        stats_index(index_uid)['numberOfDocuments']
+      end
+
+      def index_is_indexing?(index_uid)
+        stats_index(index_uid)['isIndexing']
+      end
+
+      def index_last_update(index_uid)
+        stats_index(index_uid)['lastUpdate']
+      end
+
+      def index_fields_frequency(index_uid)
+        stats_index(index_uid)['fieldsFrequency']
+      end
+    end
+  end
+end

data/lib/meilisearch/client.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require 'httparty'
+
+require 'meilisearch/error'
+require 'meilisearch/client/keys'
+require 'meilisearch/client/stats'
+require 'meilisearch/client/health'
+require 'meilisearch/client/indexes'
+require 'meilisearch/client/documents'
+require 'meilisearch/client/prepare'
+require 'meilisearch/client/search'
+
+module MeiliSearch
+  class Client
+    include HTTParty
+
+    include MeiliSearch::Client::Keys
+    include MeiliSearch::Client::Stats
+    include MeiliSearch::Client::Health
+    include MeiliSearch::Client::Indexes
+    include MeiliSearch::Client::Documents
+    include MeiliSearch::Client::Prepare
+    include MeiliSearch::Client::Search
+
+    def initialize(url, api_key = nil)
+      # api_key is is for basic api authorization
+      @headers = {}
+      @headers['X-Meili-Api-Key'] = api_key if api_key
+      @headers['Content-Type'] = 'application/json'
+      @base_url = url
+    end
+
+    def get(path = '', query = {})
+      response = self.class.get(
+        (@base_url + path),
+        query: query,
+        headers: @headers
+      )
+      validate(response)
+    end
+
+    def post(path = '', body = nil)
+      if body.nil?
+        response = self.class.post(
+          (@base_url + path),
+          headers: @headers
+        )
+      else
+        response = self.class.post(
+          (@base_url + path),
+          body: body.to_json,
+          headers: @headers
+        )
+      end
+      validate(response)
+    end
+
+    def put(path = '', body = {})
+      response = self.class.put(
+        (@base_url + path),
+        body: body.to_json,
+        headers: @headers
+      )
+      validate(response)
+    end
+
+    def delete(path = '')
+      response = self.class.delete(
+        (@base_url + path),
+        headers: @headers
+      )
+      validate(response)
+    end
+
+    private
+
+    def validate(response)
+      unless response.success?
+        raise ClientError, "#{response.code}: #{response.message}\n#{response.body}"
+      end
+
+      response.parsed_response
+    end
+  end
+end

data/lib/meilisearch/dataset.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module MeiliSearch
+  # This class represents the dataset we can index
+  class Dataset
+    class NotEnumerable < StandardError; end
+    class CannotDetermineHeader < StandardError; end
+    class ExtensionNotRecognized < StandardError; end
+
+    attr_accessor :data
+
+    def self.new_from_s3(s3_file)
+      filename = s3_file.filename.to_s
+      if filename.match?(/.csv$/)
+        data = CSV.parse(s3_file.download, headers: true)
+      elsif filename.match?(/.json$/)
+        data = JSON.parse(s3_file.download)
+      else
+        raise Dataset::ExtensionNotRecognized
+      end
+      new(data)
+    end
+
+    def initialize(data)
+      @data = data
+      raise Dataset::NotEnumerable unless enumerable?
+    end
+
+    def clean
+      encode_to_utf8
+      replace_nil_values
+      @data
+    end
+
+    def headers
+      if @data.class == Array
+        @data.first.keys
+      elsif @data.class == CSV::Table
+        @data.headers
+      else
+        raise CannotDetermineHeader
+      end
+    end
+
+    def schema
+      schema = headers.map do |attribute|
+        [attribute, [:indexed, :displayed]]
+      end.to_h
+
+      # Find first attribute containing id
+      identifier = headers.detect { |attribute| attribute[/id/i] }
+
+      # Then give it the :identifier attribute
+      schema[identifier].push :identifier
+      schema
+    end
+
+    private
+
+    def replace_nil_values
+      @data = @data.map do |record|
+        record.each do |key, value|
+          record[key] = '' if value.nil?
+        end
+      end
+    end
+
+    def encode_to_utf8
+      @data = @data.map(&:to_h).map(&:to_utf8)
+    end
+
+    def enumerable?
+      @data.respond_to? :each
+    end
+  end
+end

data/lib/meilisearch/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module MeiliSearch
+  class MeiliSearchError < StandardError; end
+  class ClientError < MeiliSearchError; end
+end

data/lib/meilisearch/version.rb

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

data/lib/meilisearch.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'meilisearch/version'
+require 'meilisearch/client'
+
+module MeiliSearch
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: meilisearch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Meili
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+description: A simple ruby client for Meilisearch API. See https://github.com/meilisearch/MeiliDB
+email: bonjour@meilisearch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/meilisearch.rb
+- lib/meilisearch/client.rb
+- lib/meilisearch/client/documents.rb
+- lib/meilisearch/client/health.rb
+- lib/meilisearch/client/indexes.rb
+- lib/meilisearch/client/keys.rb
+- lib/meilisearch/client/objects.rb
+- lib/meilisearch/client/prepare.rb
+- lib/meilisearch/client/search.rb
+- lib/meilisearch/client/stats.rb
+- lib/meilisearch/dataset.rb
+- lib/meilisearch/error.rb
+- lib/meilisearch/version.rb
+homepage: https://github.com/meilisearch/ruby-meili-api
+licenses:
+- MIT
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A simple ruby client for Meilisearch API
+test_files: []