tlq-client 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 23e82549788eabfb735a5035d8b8f478df7e570a6b1c43338ea28714f2ef0824
+  data.tar.gz: 584f2eb0f74e20b8df96401630c5843184c15b31f48e693739f159f5ba22f42a
+SHA512:
+  metadata.gz: a2da29977ea8ea209bcd448c8928b59e58ef76c3bf0b55ce0f8008edd9a12070832eb3af46c1c5c350cefee41484a43f41dc279ab7b78effa0c928e84de05645
+  data.tar.gz: 44d102142b0750efca0db88d4f7fba9f9cf8891117c8456bf852604a0eb59d65f63b6e590b6b9a4da8ffd034449e771d230a19423a4d4a813f46f13c05684c4d

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.0] - 2025-11-26
+
+### Added
+
+- Initial release of TLQ Client gem
+- `add_message(body)` - Add a message to the queue
+- `get_messages(count)` - Retrieve messages from the queue
+- `delete_messages(ids)` - Delete processed messages
+- `retry_messages(ids)` - Return messages to the queue
+- `purge_queue` - Clear all messages
+- `health_check` - Check server status

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025
+
+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,137 @@
+# TLQ Client
+
+Ruby client for [TLQ (Tiny Little Queue)](https://tinylittlequeue.app/) message queue service.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'tlq-client'
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+Or install directly:
+
+```bash
+gem install tlq-client
+```
+
+## Usage
+
+```ruby
+require 'tlq_client'
+
+# Initialize client (defaults to localhost:1337)
+client = TLQClient.new
+# or with custom host/port
+client = TLQClient.new(host: 'queue.example.com', port: 8080)
+
+# Add messages to the queue
+message = client.add_message("Process order #123")
+puts message['id']  # => "019ac13f-3286-7f00-bcb7-c86fe88798b4"
+
+# Get messages (default: 1, max configurable on server)
+messages = client.get_messages(10)
+
+# Process messages
+messages.each do |msg|
+  begin
+    # Your processing logic here
+    process(msg['body'])
+
+    # Success - delete the message
+    client.delete_messages(msg['id'])
+  rescue => e
+    # Failed - return to queue for retry
+    client.retry_messages(msg['id'])
+  end
+end
+
+# Batch operations
+ids = messages.map { |m| m['id'] }
+client.delete_messages(ids)  # Delete multiple
+client.retry_messages(ids)   # Retry multiple
+
+# Health check
+client.health_check  # => true
+
+# Purge all messages (use with caution!)
+client.purge_queue
+```
+
+## API Reference
+
+### `TLQClient.new(host: 'localhost', port: 1337)`
+
+Creates a new client instance.
+
+### `add_message(body) → Hash`
+
+Adds a message to the queue. Returns the message object:
+
+```ruby
+{
+  'id' => 'uuid-v7',
+  'body' => 'your message',
+  'state' => 'Ready',
+  'retry_count' => 0
+}
+```
+
+### `get_messages(count = 1) → Array`
+
+Retrieves messages from the queue. Messages transition to "Processing" state and become invisible to other consumers.
+
+### `delete_messages(ids) → Boolean`
+
+Permanently removes messages from the queue. Accepts a single ID or array of IDs.
+
+### `retry_messages(ids) → Boolean`
+
+Returns messages to the queue for reprocessing. Increments `retry_count`. Accepts a single ID or array of IDs.
+
+### `purge_queue → Boolean`
+
+Removes all messages from the queue. Cannot be undone.
+
+### `health_check → Boolean`
+
+Returns `true` if the TLQ server is reachable.
+
+## Requirements
+
+- Ruby >= 2.6
+- Running [TLQ server](https://github.com/skyaktech/tlq)
+
+## Development
+
+```bash
+# Install dependencies
+bundle install
+
+# Run unit tests
+bundle exec rake test
+
+# Run integration tests (requires TLQ server)
+bundle exec rake integration
+
+# Run all tests
+bundle exec rake test_all
+```
+
+## Other Client Libraries
+
+- [Go](https://github.com/skyaktech/tlq-client-go)
+- [Node.js](https://github.com/skyaktech/tlq-client-node)
+- [Python](https://github.com/skyaktech/tlq-client-py)
+- [Rust](https://github.com/skyaktech/tlq-client-rust)
+
+## License
+
+MIT

data/lib/tlq_client/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class TLQClient
+  VERSION = "0.2.0"
+end

data/lib/tlq_client.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'net/http'
+require 'uri'
+require_relative 'tlq_client/version'
+
+class TLQClient
+  attr_reader :host, :port, :base_uri
+
+  def initialize(host: 'localhost', port: 1337)
+    @host = host
+    @port = port
+    @base_uri = "http://#{@host}:#{@port}"
+  end
+
+  # Add a message to the queue
+  def add_message(body)
+    response = post('/add', { body: body })
+    JSON.parse(response.body)
+  rescue JSON::ParserError => e
+    raise "Failed to parse response: #{e.message}"
+  rescue StandardError => e
+    raise "HTTP request failed: #{e.message}"
+  end
+
+  # Get messages from the queue
+  def get_messages(count = 1)
+    response = post('/get', { count: count })
+    parsed = JSON.parse(response.body)
+    parsed.is_a?(Array) ? parsed : Array(parsed['messages'] || parsed)
+  rescue JSON::ParserError => e
+    raise "Failed to parse response: #{e.message}"
+  rescue StandardError => e
+    raise "HTTP request failed: #{e.message}"
+  end
+
+  # Delete messages from the queue
+  def delete_messages(ids)
+    response = post('/delete', { ids: Array(ids) })
+    response.body == '"Success"'
+  rescue StandardError => e
+    raise "HTTP request failed: #{e.message}"
+  end
+
+  # Retry messages (return to queue)
+  def retry_messages(ids)
+    response = post('/retry', { ids: Array(ids) })
+    response.body == '"Success"'
+  rescue StandardError => e
+    raise "HTTP request failed: #{e.message}"
+  end
+
+  # Purge all messages from the queue
+  def purge_queue
+    response = post('/purge', {})
+    response.body == '"Success"'
+  rescue StandardError => e
+    raise "HTTP request failed: #{e.message}"
+  end
+
+  # Check server health
+  def health_check
+    uri = URI("#{@base_uri}/hello")
+    response = Net::HTTP.get_response(uri)
+    response.body == '"Hello World"'
+  rescue StandardError => e
+    raise "Health check failed: #{e.message}"
+  end
+
+  private
+
+  def post(path, data)
+    uri = URI("#{@base_uri}#{path}")
+    http = Net::HTTP.new(uri.host, uri.port)
+    request = Net::HTTP::Post.new(uri)
+    request['Content-Type'] = 'application/json'
+    request.body = JSON.generate(data)
+    http.request(request)
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: tlq-client
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Nebojsa Jakovljevic
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2025-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: A Ruby client library to interact with TLQ message queue
+email:
+- nebojsa@skyak.tech
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/tlq_client.rb
+- lib/tlq_client/version.rb
+homepage: https://tinylittlequeue.app/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://tinylittlequeue.app/
+  source_code_uri: https://github.com/skyaktech/tlq-client-ruby
+  changelog_uri: https://github.com/skyaktech/tlq-client-ruby/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Ruby client for TLQ (Tiny Little Queue)
+test_files: []