qube 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e17e737e738c791b085912c221e278754ffb10108aaf9832a917d554e5400bab
+  data.tar.gz: f74e4aa68c5f4d8cecbb2ec8b8e85ef59c25beb03b4e85470ee711052c42ae75
+SHA512:
+  metadata.gz: 3c28608fb8d3069dbe6549387772356cb8df2dbd030d48d5b236a2fc19fccc785a1da8d2bc8dc9c7f772aa1bfb55cc8eda1ee80e38f11f88818ed62b638f8b4a
+  data.tar.gz: 9d0fca0029be9543b39fb917a0f80f7b011e9dced574e98438c3fe90d9a0b4730b75ea50398e99d9dd8921c818b65a055bd7032f9e83fa235cab7473bc09b5c3

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/lua/.rocks
+/lua/*.snap
+/lua/*.xlog

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 tnt-qube
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+# qube-ruby
+
+Сlient for the Tarantool [Queue](https://github.com/tarantool/queue) for Ruby over HTTP via persistent connection. Currently supported is `take`, `put`, `ack` and will continue to add as needed.
+
+```ruby
+require 'qube'
+
+Qube.setup do |c|
+  c.api_uri    = 'http://localhost:5672/api/v1/'
+  c.api_token  = '77c04ced3f915240d0c5d8d5819f84c7' # md5 -s qube
+end
+
+queue = Qube::Queue.new
+pp queue.tube_exist?('welcome_mail') # => false
+
+tube = queue.create_tube(name: 'welcome_mail', type: 'fifo')
+pp tube # => #<Qube::Tube:0x00007fe68b159b80 ...
+
+put_status = tube.put({ name: 'Ivan Ivanov', locale: 'ru', email: 'ivan@localhost.dev' })
+pp put_status # => true
+
+task = tube.take
+pp task
+# =>
+# {
+#  "task_id" => 0,
+#     "data" => {
+#       "email" => "ivan@localhost.dev",
+#        "name" => "Ivan Ivanov",
+#      "locale" => "ru"
+#  }
+# }
+
+ack_status = tube.ack task.dig('task_id')
+pp ack_status
+# => true
+
+# Taking the each task, processing and ack it in the one step
+tube.each_task do |task|
+  pp task
+end
+
+delete_status = queue.delete_tube('welcome_mail')
+pp delete_status
+# => true
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "qube"
+
+# 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/case/base.rb

@@ -0,0 +1,41 @@
+require 'qube'
+
+Qube.setup do |c|
+  c.api_uri    = 'http://localhost:5672/api/v1/'
+  c.api_token  = '77c04ced3f915240d0c5d8d5819f84c7' # md5 -s qube
+end
+
+queue = Qube::Queue.new
+pp queue.tube_exist?('welcome_mail') # => false
+
+tube = queue.create_tube(name: 'welcome_mail', type: 'fifo')
+pp tube # => #<Qube::Tube:0x00007fe68b159b80 ...
+
+put_status = tube.put({ name: 'Ivan Ivanov', locale: 'ru', email: 'ivan@localhost.dev' })
+pp put_status # => true
+
+task = tube.take
+pp task
+# =>
+# {
+#  "task_id" => 0,
+#     "data" => {
+#       "email" => "ivan@localhost.dev",
+#        "name" => "Ivan Ivanov",
+#      "locale" => "ru"
+#  }
+# }
+
+ack_status = tube.ack(task.dig('task_id'))
+pp ack_status
+# => true
+
+# Taking the each task, processing it and ack
+tube.each_task do |task|
+  pp task
+end
+
+delete_status = queue.delete_tube('welcome_mail')
+pp delete_status
+# => true
+

data/lib/qube.rb

@@ -0,0 +1,5 @@
+require 'qube/config'
+require 'qube/transport/http'
+require 'qube/transport/client'
+require 'qube/model/queue'
+require 'qube/model/tube'

data/lib/qube/config.rb

@@ -0,0 +1,38 @@
+require 'logger'
+require 'securerandom'
+
+module Qube
+  class << self
+    attr_accessor :config
+  end
+
+  def self.setup
+    self.config ||= Config.new
+    yield config
+  end
+
+  class Config
+    attr_accessor :api_uri
+    attr_accessor :api_token
+    attr_accessor :pool_size
+    attr_accessor :timeout
+    attr_accessor :user_agent
+    attr_accessor :logger
+    attr_accessor :logger_level
+    attr_accessor :http_debug
+    attr_accessor :session
+
+    def initialize
+      @api_uri      = ENV['QUBE_API_URI']   || 'http://localhost:9191/qube/api/v1'
+      @api_token    = ENV['QUBE_API_TOKEN'] || '77c04ced3f915240d0c5d8d5819f84c7'   # bash: md5 -s qube
+      @pool_size    = 5
+      @timeout      = 2
+      @user_agent   = "QubeRubyClient/#{Qube::VERSION}"
+      @logger_level = :debug
+      @logger       = ::Logger.new STDOUT
+      @logger.level = @logger_level
+      @http_debug   = true
+      @session      = SecureRandom.uuid
+    end
+  end
+end

data/lib/qube/model/queue.rb

@@ -0,0 +1,36 @@
+require 'securerandom'
+
+module Qube
+  class Queue
+    attr_reader :tubes
+    attr_reader :statistics
+
+    def initialize
+      @config     = Qube.config
+      @client     = Client.new
+      @tubes      = nil
+      @statistics = nil
+    end
+
+    def statistics
+      @statistics ||= @client.get('statistics')&.body
+    end
+
+    def tubes
+      @tubes ||= @client.get('tubes')&.body
+    end
+
+    def create_tube(options = {})
+      Tube.new(options)
+    end
+
+    def tube_exist?(name)
+      tubes.include?(name)
+    end
+
+    def delete_tube(name)
+      @client.delete("tubes/#{name}")&.body
+    end
+
+  end
+end

data/lib/qube/model/tube.rb

@@ -0,0 +1,57 @@
+module Qube
+  class Tube
+    attr_reader :name
+
+    def initialize(options = {})
+      @config  = Qube.config
+      @client  = Client.new
+      @name    = options.delete(:name)
+      @type    = options.delete(:type)
+      @options = options.merge!(if_not_exists: true)
+      fetch_or_create_tube
+    end
+
+    # POST tubes/:name
+    def put(task, options = {})
+      response = @client.post("tubes/#{@name}", tube: @name, task: task, options: options)
+      response.code == 200
+    end
+
+    # GET tubes/:name
+    def take(timeout = 0)
+      @client.get("tubes/#{@name}", timeout: timeout)&.body
+    end
+
+    # PUT tubes/:name/:task_id/ask
+    def ack(data)
+      task_id  = data.is_a?(Hash) ? data.dig('task_id') : data
+      response = @client.put("tubes/#{@name}/#{task_id}/ack", tube: @name, task_id: task_id)
+      response.code == 200
+    end
+
+    # DELETE tubes/:name
+    def drop
+      response = @client.delete("tubes/#{@name}")
+      response.code == 200
+    end
+
+    def each_task(timeout = 0)
+      loop do
+        task = take(timeout)
+        if task.nil? || task.empty?
+          break
+        else
+          yield task
+          ack(task)
+        end
+      end
+    end
+
+    private
+
+      def fetch_or_create_tube
+        response = @client.post('tubes', tube: @name, type: @type, options: @options.compact)
+        self if response.code == 200
+      end
+  end
+end

data/lib/qube/transport/client.rb

@@ -0,0 +1,12 @@
+module Qube
+  # Just wrapper, need for the future work
+  class Client
+    def initialize
+      @transport = Qube::HTTP.new
+    end
+
+    def method_missing(m, *args)
+      @transport.send(m, *args)
+    end
+  end
+end

data/lib/qube/transport/http.rb

@@ -0,0 +1,73 @@
+require 'uri'
+require 'json'
+require 'net/http'
+require 'net/http/persistent'
+
+module Qube
+  class HTTP
+
+    VERBS = {
+      get:    Net::HTTP::Get,
+      post:   Net::HTTP::Post,
+      put:    Net::HTTP::Put,
+      delete: Net::HTTP::Delete
+    }
+
+    Response = Struct.new(:code, :body)
+
+    def initialize
+      @config     = Qube.config
+      @connection = Net::HTTP::Persistent.new
+
+      @api_uri    = @config.api_uri
+      @api_token  = @config.api_token
+      @user_agent = @config.user_agent
+      @logger     = @config.logger
+    end
+
+    def base_headers
+      {
+        'X-Auth-Token' => @api_token,
+        'User-Agent'   => @user_agent,
+        'Content-Type' => 'application/json'
+      }
+    end
+
+    def get(path, options = {})
+      execute(path, :get, options)
+    end
+
+    def post(path, options = {})
+      execute(path, :post, options)
+    end
+
+    def put(path, options = {})
+      execute(path, :put, options)
+    end
+
+    def delete(path, options = {})
+      execute(path, :delete, options)
+    end
+
+    private
+      def execute(path, method, options = {})
+        url = URI.join(@api_uri, path)
+        req = VERBS[method].new(url.request_uri)
+
+        # Build headers and body
+        options.transform_keys!(&:to_s) unless options.empty?
+        headers = base_headers.merge(options.dig('headers') || options)
+        headers.each{ |k,v| req[k] = v }
+        req.body = (options.dig('body') || options || {}).to_json
+
+        # Send request and process response
+        resp = @connection.request(url.to_s, req)
+        body = resp.body.empty? ? {} : JSON.parse(resp.body)
+        Response.new(resp.code.to_i, body)
+
+        rescue => e
+          @logger.error(e.message) if @logger
+          raise e
+      end
+  end
+end

data/lib/qube/version.rb

@@ -0,0 +1,3 @@
+module Qube
+  VERSION = "0.0.1"
+end

data/qube.gemspec

@@ -0,0 +1,23 @@
+require_relative 'lib/qube/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'qube'
+  spec.version       = Qube::VERSION
+  spec.authors       = ["Sergey Fedorov"]
+  spec.email         = ["creadone@gmail.com"]
+
+  spec.summary       = %q{Tarantool Queue client for Ruby}
+  spec.description   = %q{Ruby HTTP-client for the Message Queue based on Tarantool}
+  spec.homepage      = "https://github.com/tnt-qube/qube-ruby"
+
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+
+  spec.add_runtime_dependency 'net-http-persistent', '~> 3.1.0'
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: qube
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sergey Fedorov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-http-persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: Ruby HTTP-client for the Message Queue based on Tarantool
+email:
+- creadone@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- case/base.rb
+- lib/qube.rb
+- lib/qube/config.rb
+- lib/qube/model/queue.rb
+- lib/qube/model/tube.rb
+- lib/qube/transport/client.rb
+- lib/qube/transport/http.rb
+- lib/qube/version.rb
+- qube.gemspec
+homepage: https://github.com/tnt-qube/qube-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Tarantool Queue client for Ruby
+test_files: []