sonic-ruby 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 481516faf364a56439e535dfe4bcfbadb957b2c736a1f1db0a2731ff9e949c45
-  data.tar.gz: df5508697fbc38eb549b1bc9c9c9b4eba6c4cc62e5a59519e0cc44fe2fa9fa92
+  metadata.gz: 11f88ebf448e0353b9a260f54f223b9013bf184079f350e6ec9fe23782d3b274
+  data.tar.gz: 4522c74a64130e54a6990355999575f9e557fa51a59ae9b847a162acd182a8c4
 SHA512:
-  metadata.gz: 2a572c3d807069ef41574e60a9ee6df12d8b5bbc2ffd6893e97659c2b1c1ec741b3fbd04e4031b8cc9654415553f150ed45781417c80a3fc1f980b73574b0489
-  data.tar.gz: 4dd866ce47e4f63e2a520ad9bd39fa99a5b3d8e678366c1276be95b2543e7685fc2f67876b118223e84b4ece4dbfb935617a5f38f5d8a22623007ad1b4924a53
+  metadata.gz: b7fde18e4818984c29d07354706a907e04664eca736fe17bbe5584212532520009a41162cd86a7807cc1f316dd707fc34f44e4294439f231b1c8fef38c134ac7
+  data.tar.gz: 378de35eb10db30414aa16dc0c746b44b748c94ac74790ced01729c3ed4330eba245ff17b1f815644a935401ebcc84eeebc1e6a62e1982a3ba45d972f449b3e2

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,97 @@
+# sonic-ruby
+
+[![Gem Version](https://badge.fury.io/rb/sonic-ruby.svg)](https://badge.fury.io/rb/sonic-ruby)
+[![Build Status](https://travis-ci.com/atipugin/sonic-ruby.svg?branch=master)](https://travis-ci.com/atipugin/sonic-ruby)
+[![Maintainability](https://api.codeclimate.com/v1/badges/dcbb9919a64c96fb629c/maintainability)](https://codeclimate.com/github/atipugin/sonic-ruby/maintainability)
+
+A Ruby client for [Sonic search backend](https://github.com/valeriansaliou/sonic).
+
+## Installation
+
+Add following line to your Gemfile:
+
+```ruby
+gem 'sonic-ruby'
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it system-wide:
+
+```shell
+$ gem install sonic-ruby
+```
+
+## Usage
+
+Start with creating new client:
+
+```ruby
+client = Sonic::Client.new('localhost', 1491, 'SecretPassword')
+```
+
+Now you can use `#channel` method in order to connect to specific channels:
+
+```ruby
+control = client.channel(:control)
+ingest = client.channel(:ingest)
+search = client.channel(:search)
+```
+
+[Learn more about Sonic Channels](https://github.com/valeriansaliou/sonic/blob/master/PROTOCOL.md).
+
+## Indexing
+
+```ruby
+# Init `ingest` channel
+ingest = client.channel(:ingest)
+
+# Add data to index
+ingest.push('users', 'all', 1, 'Alexander Tipugin')
+# => true
+
+# Remove data from index
+ingest.pop('users', 'all', 1, 'Alexander Tipugin')
+# => 2
+
+# Count collection/bucket/object items
+ingest.count('users', 'all', 1)
+# => 1
+
+# Flush entire collection
+ingest.flushc('users')
+# => 1
+
+# Flush entire bucket inside collection
+ingest.flushb('users', 'all')
+# => 1
+
+# Flush specific object inside bucket
+ingest.flusho('users', 'all', 1)
+# => 2
+```
+
+## Searching
+
+```ruby
+# Init `search` channel
+search = client.channel(:search)
+
+# Find indexed object by term
+search.query('users', 'all', 'tipugin')
+# => 1
+
+# Auto-complete word
+search.suggest('users', 'all', 'alex')
+# => alexander
+```
+
+## TODO
+
+- [ ] Take into account maximum buffer size.
+- [ ] Consider using connection pool.
+- [x] Return more meaningful responses from commands (i.e. bool `true` instead of string `OK`, int `1` instead of string `RESULT 1` etc).

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'bundler/setup'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = %w[lib/**/*.rb]
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'pry'
+
+require File.expand_path('../../lib/sonic', __FILE__)
+
+Pry.start

data/lib/sonic-ruby.rb

@@ -0,0 +1 @@
+require 'sonic'

data/lib/sonic.rb

@@ -0,0 +1,7 @@
+require 'socket'
+
+require 'sonic/version'
+require 'sonic/client'
+require 'sonic/channels'
+require 'sonic/connection'
+require 'sonic/errors'

data/lib/sonic/channels.rb

@@ -0,0 +1,4 @@
+require 'sonic/channels/base'
+require 'sonic/channels/control'
+require 'sonic/channels/ingest'
+require 'sonic/channels/search'

data/lib/sonic/channels/base.rb

@@ -0,0 +1,48 @@
+module Sonic
+  module Channels
+    class Base
+      attr_reader :connection
+
+      def initialize(connection)
+        @connection = connection
+      end
+
+      def ping
+        execute('PING')
+      end
+
+      def help(manual)
+        execute('HELP', manual)
+      end
+
+      def quit
+        execute('QUIT')
+        connection.disconnect
+      end
+
+      private
+
+      def execute(*args)
+        connection.write(*args.join(' '))
+        yield if block_given?
+        type_cast_response(connection.read)
+      end
+
+      def quote(value)
+        "\"#{value}\""
+      end
+
+      def type_cast_response(value)
+        if value == 'OK'
+          true
+        elsif value.start_with?('RESULT ')
+          value.split(' ').last.to_i
+        elsif value.start_with?('EVENT ')
+          value.split(' ')[3..-1].join(' ')
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/sonic/channels/control.rb

@@ -0,0 +1,9 @@
+module Sonic
+  module Channels
+    class Control < Base
+      def trigger(action)
+        execute('TRIGGER', action)
+      end
+    end
+  end
+end

data/lib/sonic/channels/ingest.rb

@@ -0,0 +1,32 @@
+module Sonic
+  module Channels
+    class Ingest < Base
+      def push(collection, bucket, object, text, lang = nil)
+        arr = [collection, bucket, object, quote(text)]
+        arr << "LANG(#{lang})" if lang
+
+        execute('PUSH', *arr)
+      end
+
+      def pop(collection, bucket, object, text)
+        execute('POP', collection, bucket, object, quote(text))
+      end
+
+      def count(collection, bucket = nil, object = nil)
+        execute('COUNT', *[collection, bucket, object].compact)
+      end
+
+      def flushc(collection)
+        execute('FLUSHC', collection)
+      end
+
+      def flushb(collection, bucket)
+        execute('FLUSHB', collection, bucket)
+      end
+
+      def flusho(collection, bucket, object)
+        execute('FLUSHO', collection, bucket, object)
+      end
+    end
+  end
+end

data/lib/sonic/channels/search.rb

@@ -0,0 +1,25 @@
+module Sonic
+  module Channels
+    class Search < Base
+      def query(collection, bucket, terms, limit = nil, offset = nil, lang = nil) # rubocop:disable Metrics/ParameterLists, Metrics/LineLength
+        arr = [collection, bucket, quote(terms)]
+        arr << "LIMIT(#{limit})" if limit
+        arr << "OFFSET(#{offset})" if offset
+        arr << "LANG(#{lang})" if lang
+
+        execute('QUERY', *arr) do
+          connection.read # ...
+        end
+      end
+
+      def suggest(collection, bucket, word, limit = nil)
+        arr = [collection, bucket, quote(word)]
+        arr << "LIMIT(#{limit})" if limit
+
+        execute('SUGGEST', *arr) do
+          connection.read # ...
+        end
+      end
+    end
+  end
+end

data/lib/sonic/client.rb

@@ -0,0 +1,24 @@
+module Sonic
+  class Client
+    def initialize(host, port, password = nil)
+      @host = host
+      @port = port
+      @password = password
+    end
+
+    def channel(type)
+      channel_class(type).new(Connection.connect(@host, @port, type, @password))
+    end
+
+    private
+
+    def channel_class(type)
+      case type.to_sym
+      when :control then Channels::Control
+      when :ingest then Channels::Ingest
+      when :search then Channels::Search
+      else raise ArgumentError, "`#{type}` channel type is not supported"
+      end
+    end
+  end
+end

data/lib/sonic/connection.rb

@@ -0,0 +1,42 @@
+module Sonic
+  class Connection
+    def self.connect(*args)
+      connection = new(*args)
+      connection if connection.connect
+    end
+
+    def initialize(host, port, channel_type, password = nil)
+      @host = host
+      @port = port
+      @channel_type = channel_type
+      @password = password
+    end
+
+    def connect
+      read # ...
+      write(['START', @channel_type, @password].compact.join(' '))
+      read.start_with?('STARTED ')
+    end
+
+    def disconnect
+      socket.close
+    end
+
+    def read
+      data = socket.gets.chomp
+      raise ServerError, data if data.start_with?('ERR ')
+
+      data
+    end
+
+    def write(data)
+      socket.puts(data)
+    end
+
+    private
+
+    def socket
+      @socket ||= TCPSocket.open(@host, @port)
+    end
+  end
+end

data/lib/sonic/errors.rb

@@ -0,0 +1,4 @@
+module Sonic
+  class Error < StandardError; end
+  class ServerError < Error; end
+end

data/lib/sonic/version.rb

@@ -0,0 +1,3 @@
+module Sonic
+  VERSION = '0.2.2'.freeze
+end

data/sonic-ruby.gemspec

@@ -0,0 +1,19 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'sonic/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'sonic-ruby'
+  spec.version = Sonic::VERSION
+  spec.summary = 'Ruby client for Sonic'
+  spec.authors = ['Alexander Tipugin']
+  spec.files = `git ls-files -z`.split("\x0").reject { |f|
+    f.match(%r{^(test|spec|features)/})
+  } - ['.rubocop.yml', '.travis.yml', 'Gemfile.lock', '.gitignore', '.rspec']
+
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop', '~> 0.66.0'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sonic-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Alexander Tipugin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-01 00:00:00.000000000 Z
+date: 2019-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -71,7 +71,23 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- lib/sonic-ruby.rb
+- lib/sonic.rb
+- lib/sonic/channels.rb
+- lib/sonic/channels/base.rb
+- lib/sonic/channels/control.rb
+- lib/sonic/channels/ingest.rb
+- lib/sonic/channels/search.rb
+- lib/sonic/client.rb
+- lib/sonic/connection.rb
+- lib/sonic/errors.rb
+- lib/sonic/version.rb
+- sonic-ruby.gemspec
 homepage: 
 licenses: []
 metadata: {}