reindexer 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1356871b0a5fd7b52535aeccfd3e89321f52258f35bd2af5095364e5cfb0033
-  data.tar.gz: bff0c1f6e1aa496457f92a882990c976969bbb6eba507f1c8d1ef3bc622e5976
+  metadata.gz: 9590f91459e2b8bba145cf6221d6bf079b4d74208ef55e78c58cfadbb36027e7
+  data.tar.gz: 534a6a414cd6e6d094fd1e048578af9316a0fb0992c1086cebfbdd25adcbeb4d
 SHA512:
-  metadata.gz: 8b7787b34cc55fdee044122bddaabeaa6a381ccffda43e02f97e638b1d3b78f37721a9c408ba1c170575452f7fae586890326586f58cb915726c1dde5d4f6205
-  data.tar.gz: 5b90659aa0e305003f7697d70cf5ac6f7faf7752695d9580fe0fc0549e0cef17d66d51ba6679a925aaf3915b856eae8bdd02b7f109b5dfe81aa52843b110bdb6
+  metadata.gz: a2a5099af92b7341f900d010b11d43cf1993fd5d13e56775cffebf006a0b7ef30c52bac55b3db4db6e75a343e37b30b6cffa7dce08c94c2df3588a9d81376a2f
+  data.tar.gz: 2c2cd8351d533528b3a9914acf84d40b236d47a735c45b4749836a48665a60a3c944bccd42156a7340e1862096f1b0e35b1ba883f9bc3dbcdc5bc886bbff0111

data/CHANGELOG.md

@@ -5,4 +5,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Changed
+- Updates of README.md and gemspec
+
+## [0.0.2] - 2021-06-01
+### Changed
+- Get rid of useless dependency
+
+## [0.0.1] - 2021-05-02
 ### Added
+- Wrap provided arguments with the gRPC message objects
+- Building and testing gem via GitHub Actions

data/README.md

@@ -1,9 +1,11 @@
 [![Gem](https://img.shields.io/gem/v/reindexer.svg)](https://rubygems.org/gems/reindexer/)
 ![Reindexer](https://github.com/numbata/reindexer-ruby/actions/workflows/main.yml/badge.svg)
 
-# Reindexer
+# Reindexer Ruby
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/reindexer`. To experiment with that code, run `bin/console` for an interactive prompt.
+gRPC client for work with [reindexer](https://github.com/Restream/reindexer). It is still in alpha state and there are a lot of works to do. So using in a prod environment is not recomended.
+
+The gem also wraps the arguments of gRPC requests into the gRPC messages. So you should not care about the toons of nested initializations. Just give a common hash and the gem will do all the work.
 
 ## Installation
 
@@ -15,51 +17,48 @@ gem 'reindexer'
 
 And then execute:
 
-    $ bundle
+```bash
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install reindexer
+```bash
+gem install reindexer
+```
 
 ## Usage
 
-    client = ReindexerGrpc::Client.new('grpc://reindexer:16534')
-
-    client.create_database(db_name: 'test_db')
-    client.open_namespace(db_name: 'test_db', storage_options: {ns_name: 'items'})
-    client.add_index(db_name: 'test_db', ns_name: 'items', definition: {
-      name: 'id',
-      json_paths: ['id'],
-      index_type: 'hash',
-      field_type: 'int',
-      options: {
-        is_pk: true,
-        is_array: false,
-        is_dense: false,
-        is_sparse: false,
-        collate_mode: 'CollateUTF8Mode',
-        sort_order_labled: '',
-        config: ''
-      },
-      expire_after: nil
-    })
-
-    client.modify_item([
-      {db_name: 'test_db', ns_name: 'items', mode: :UPSERT, data: JSON.dump(id: 1, name: 'Name')},
-      {db_name: 'test_db', ns_name: 'items', mode: :UPSERT, data: JSON.dump(id: 2, name: 'BestName')}
-    ])
-    stream = client.select_sql(db_name: 'test_db', sql: 'SELECT * FROM items', output_flags: {with_rank: true})
-
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
+```ruby
+client = ReindexerGrpc::Client.new('grpc://reindexer:16534')
+client.create_database(db_name: 'test_db')
+client.open_namespace(db_name: 'test_db', storage_options: {ns_name: 'items'})
+client.add_index(db_name: 'test_db', ns_name: 'items', definition: {
+  name: 'id',
+  json_paths: ['id'],
+  index_type: 'hash',
+  field_type: 'int',
+  options: {
+    is_pk: true,
+    is_array: false,
+    is_dense: false,
+    is_sparse: false,
+    collate_mode: 'CollateUTF8Mode',
+    sort_order_labled: '',
+    config: ''
+  },
+  expire_after: nil
+})
+client.modify_item([
+  {db_name: 'test_db', ns_name: 'items', mode: :UPSERT, data: JSON.dump(id: 1, name: 'Name')},
+  {db_name: 'test_db', ns_name: 'items', mode: :UPSERT, data: JSON.dump(id: 2, name: 'BestName')}
+])
+stream = client.select_sql(db_name: 'test_db', sql: 'SELECT * FROM items', output_flags: {with_rank: true})
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/numbata/reindexer-ruby.
+If you have any questions about Reindexer, please use [main page](https://github.com/Restream/reindexer) of Reindexer. Feel free to report issues and contribute about Reindexer Ruby at https://github.com/numbata/reindexer-ruby.
 
 ## License
 

data/lib/reindexer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Reindexer
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reindexer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Andrei Subbota
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-02 00:00:00.000000000 Z
+date: 2021-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: google-protobuf
   requirement: !ruby/object:Gem::Requirement
@@ -150,7 +136,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
-description: A client that allows to interact with the Reindexer document-oriented
+description: A gRPC-client that allows to interact with the Reindexer document-oriented
   database
 email:
 - subbota@gmail.com
@@ -176,7 +162,7 @@ metadata:
   bug_tracker_uri: https://github.com/numbata/reindexer-ruby/issues
   changelog_uri: https://github.com/numbata/reindexer-ruby/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/numbata/reindexer-ruby
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -191,8 +177,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.16
+signing_key:
 specification_version: 4
-summary: Reindexer GRPC-client
+summary: Reindexer gRPC-client
 test_files: []