delayed_rabbit 0.1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dacae11a213b6fb4a5e38990cd2667a447a5404c87996d4f3cc519b3d55e943
-  data.tar.gz: b7372e3ab221c15fc15d759379d9fcc290931193c4bc18e5e3fcb49d3211da04
+  metadata.gz: 66189b91092000fe55f71ff901f90ffcd208deccc57d819fdc389010db465928
+  data.tar.gz: 8c845d00436f5a5f5d521aface9f97b5941a904937a473710f7f975a4d6562af
 SHA512:
-  metadata.gz: dd439f723913b5c917711bd2e258eb7241cf6c7eb63f1f2b2f21ef8e8a981aaa1af1e98ae883c422b3975f22fa517a968c564af4e81f8d796f16801a4d739351
-  data.tar.gz: 52342b65ff0a262378938d9a69eef7b40c643d3ef2b47b5369b4a897b0c372a3fdb7be3b511e4a6d31dddfc4a7ac63fa7da125b8554b28b169ba873152d873fa
+  metadata.gz: 4e06ed9cfb919d2bf9d7b08e36422c03f87275d599e51638211b5cd0f4f2c739ec1554b7f6ce7fe27ba1c9cb39c2d81e5f38f96552252c92ac50c63a9242dd68
+  data.tar.gz: 816d0d49023b58081a7e9ddf8c681ce6d0d742c962b5620c658ec8a48d9b87bc42d2ea900d3d41db3b3ba52c5bf412d76c2919cb1ccdeaba81b5bf7cbc360d51

data/README.md

@@ -51,36 +51,122 @@ Or install it yourself as:
 gem install delayed_rabbit
 ```
 
-## Usage
+## Rails Integration
 
-### Basic Usage
+### 1. Install the Gem
+
+Add to your Gemfile:
+
+```ruby
+gem 'delayed_rabbit'
+```
+
+### 2. Run the Installer
+
+Run the generator to set up configuration files:
+
+```bash
+rails generate delayed_rabbit:install
+```
+
+This will create:
+- `config/initializers/delayed_rabbit.rb` - Main configuration file
+- `config/rabbitmq.yml` - Environment-specific RabbitMQ settings
+
+### 3. Configure RabbitMQ
+
+Edit `config/rabbitmq.yml` with your RabbitMQ settings:
+
+```yaml
+development:
+  host: localhost
+  port: 5672
+  user: guest
+  password: guest
+  vhost: /
+
+production:
+  host: <%= ENV['RABBITMQ_HOST'] %>
+  port: <%= ENV['RABBITMQ_PORT'] || 5672 %>
+  user: <%= ENV['RABBITMQ_USER'] %>
+  password: <%= ENV['RABBITMQ_PASSWORD'] %>
+  vhost: <%= ENV['RABBITMQ_VHOST'] || '/' %>
+```
+
+### 4. Use in Your Application
+
+#### In Models/Services
+
+```ruby
+class UserNotifier
+  def self.send_welcome_notification(user)
+    DelayedRabbit::JobPublisher.publish(
+      {
+        type: "welcome_email",
+        user_id: user.id,
+        email: user.email
+      },
+      delay_ms: 5000,  # 5 seconds delay
+      routing_key: "notifications.welcome"
+    )
+  end
+end
+```
+
+#### In Controllers
+
+```ruby
+class UsersController < ApplicationController
+  def create
+    user = User.create(user_params)
+    UserNotifier.send_welcome_notification(user)
+    redirect_to root_path, notice: 'User created successfully'
+  end
+end
+```
+
+#### Using Rake Tasks
+
+The gem provides a rake task for testing:
+
+```bash
+# Enqueue a test job with 5 second delay
+bundle exec rake delayed_rabbit:enqueue_test_job[5000]
+
+# Enqueue a notification job
+bundle exec rake jobs:enqueue_notification[5000,123]
+```
+
+## Usage (Non-Rails)
+
+If you're not using Rails:
 
 ```ruby
 require 'delayed_rabbit'
 
-# Create a publisher with custom connection options
-publisher = DelayedRabbit::JobPublisher.new(
-  connection_options: {
+# Configure manually
+DelayedRabbit.configure do |config|
+  config.connection_options = {
     host: "localhost",
     port: 5672,
     user: "guest",
-    password: "guest",
-    vhost: "/"
+    password: "guest"
   }
-)
+end
 
-# Publish a job with 5000ms (5 seconds) delay
-job_data = {
-  type: "email_notification",
-  recipient: "user@example.com",
-  subject: "Delayed Email",
-  body: "This email was sent after a delay"
-}
+# Create a publisher
+publisher = DelayedRabbit::JobPublisher.new
 
-# Publish with custom routing key
-publisher.publish(job_data, delay_ms: 5000, routing_key: "notifications.email")
+# Publish a job
+publisher.publish(
+  {
+    type: "email_notification",
+    recipient: "user@example.com"
+  },
+  delay_ms: 5000
+)
 
-# Close the connection when done
+# Close connection
 publisher.close
 ```
 

data/delayed_rabbit.gemspec

@@ -3,12 +3,12 @@ require_relative "lib/delayed_rabbit/version"
 Gem::Specification.new do |spec|
   spec.name          = "delayed_rabbit"
   spec.version       = DelayedRabbit::VERSION
-  spec.authors       = ["Your Name"]
-  spec.email         = ["your.email@example.com"]
+  spec.authors       = ["ShekharBora"]
+  spec.email         = ["chandu42011@gmail.com"]
 
   spec.summary       = "A lightweight Ruby gem for scheduling delayed background jobs using RabbitMQ"
   spec.description   = "delayed_rabbit provides a simple interface for scheduling background jobs with delays using RabbitMQ's delayed message exchange plugin"
-  spec.homepage      = "https://github.com/yourusername/delayed_rabbit"
+  spec.homepage      = "https://github.com/shekharbora/delayed_rabbit"
   spec.license       = "MIT"
   spec.required_ruby_version = "~> 3.2"
 
@@ -31,6 +31,8 @@ Gem::Specification.new do |spec|
   # Development dependencies
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "mocha", "~> 1.14"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "rails", ">= 6.0.0"
 end

data/lib/delayed_rabbit/railtie.rb

@@ -0,0 +1,35 @@
+require "delayed_rabbit"
+
+module DelayedRabbit
+  class Railtie < Rails::Railtie
+    config.after_initialize do
+      DelayedRabbit.configure do |config|
+        config.connection_options = {
+          host: Rails.application.config_for(:rabbitmq)&.dig(:host) || "localhost",
+          port: Rails.application.config_for(:rabbitmq)&.dig(:port) || 5672,
+          user: Rails.application.config_for(:rabbitmq)&.dig(:user) || "guest",
+          password: Rails.application.config_for(:rabbitmq)&.dig(:password) || "guest",
+          vhost: Rails.application.config_for(:rabbitmq)&.dig(:vhost) || "/"
+        }
+        
+        config.exchange_options = {
+          type: Rails.application.config_for(:rabbitmq)&.dig(:exchange_type) || "x-delayed-message",
+          durable: true,
+          arguments: {"x-delayed-type" => "topic"}
+        }
+        
+        config.queue_options = {
+          durable: true,
+          arguments: {
+            "x-dead-letter-exchange" => "delayed_jobs",
+            "x-dead-letter-routing-key" => "delayed_jobs"
+          }
+        }
+      end
+    end
+
+    rake_tasks do
+      load "tasks/delayed_rabbit.rake"
+    end
+  end
+end

data/lib/delayed_rabbit/version.rb

@@ -1,3 +1,3 @@
 module DelayedRabbit
-  VERSION = "0.1.0"
+  VERSION = "1.1.0"
 end

data/lib/delayed_rabbit.rb

@@ -1,6 +1,39 @@
 require "delayed_rabbit/version"
 require "delayed_rabbit/job_publisher"
+require "delayed_rabbit/railtie" if defined?(Rails)
 
 module DelayedRabbit
-  # Your code goes here...
+  class << self
+    attr_accessor :configuration
+  
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration) if block_given?
+    end
+  end
+
+  class Configuration
+    attr_accessor :connection_options, :exchange_options, :queue_options
+
+    def initialize
+      @connection_options = {
+        host: "localhost",
+        port: 5672,
+        user: "guest",
+        password: "guest"
+      }
+      @exchange_options = {
+        type: "x-delayed-message",
+        durable: true,
+        arguments: {"x-delayed-type" => "topic"}
+      }
+      @queue_options = {
+        durable: true,
+        arguments: {
+          "x-dead-letter-exchange" => "delayed_jobs",
+          "x-dead-letter-routing-key" => "delayed_jobs"
+        }
+      }
+    end
+  end
 end

data/lib/generators/delayed_rabbit/install/templates/initializer.rb

@@ -0,0 +1,30 @@
+# Configure Delayed Rabbit
+DelayedRabbit.configure do |config|
+  # Connection settings
+  config.connection_options = {
+    host: ENV['RABBITMQ_HOST'] || "localhost",
+    port: ENV['RABBITMQ_PORT'] || 5672,
+    user: ENV['RABBITMQ_USER'] || "guest",
+    password: ENV['RABBITMQ_PASSWORD'] || "guest",
+    vhost: ENV['RABBITMQ_VHOST'] || "/",
+    automatic_recovery: true,
+    network_recovery_interval: 10
+  }
+
+  # Exchange settings
+  config.exchange_options = {
+    type: "x-delayed-message",
+    durable: true,
+    arguments: {"x-delayed-type" => "topic"}
+  }
+
+  # Queue settings
+  config.queue_options = {
+    durable: true,
+    arguments: {
+      "x-dead-letter-exchange" => "delayed_jobs",
+      "x-dead-letter-routing-key" => "delayed_jobs",
+      "x-message-ttl" => 3600000  # 1 hour TTL
+    }
+  }
+end

data/lib/generators/delayed_rabbit/install/templates/rabbitmq.yml

@@ -0,0 +1,44 @@
+development:
+  host: localhost
+  port: 5672
+  user: guest
+  password: guest
+  vhost: /
+  exchange_type: x-delayed-message
+
+  # Optional settings
+  automatic_recovery: true
+  network_recovery_interval: 10
+
+  # Queue settings
+  message_ttl: 3600000  # 1 hour TTL
+
+test:
+  host: localhost
+  port: 5672
+  user: guest
+  password: guest
+  vhost: /
+  exchange_type: x-delayed-message
+
+  # Optional settings
+  automatic_recovery: false
+  network_recovery_interval: 10
+
+  # Queue settings
+  message_ttl: 3600000  # 1 hour TTL
+
+production:
+  host: <%= ENV['RABBITMQ_HOST'] %>
+  port: <%= ENV['RABBITMQ_PORT'] || 5672 %>
+  user: <%= ENV['RABBITMQ_USER'] %>
+  password: <%= ENV['RABBITMQ_PASSWORD'] %>
+  vhost: <%= ENV['RABBITMQ_VHOST'] || '/' %>
+  exchange_type: x-delayed-message
+
+  # Optional settings
+  automatic_recovery: true
+  network_recovery_interval: 10
+
+  # Queue settings
+  message_ttl: 3600000  # 1 hour TTL

data/lib/generators/delayed_rabbit/install_generator.rb

@@ -0,0 +1,17 @@
+require "rails/generators"
+
+module DelayedRabbit
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def copy_initializer
+        template "initializer.rb", "config/initializers/delayed_rabbit.rb"
+      end
+
+      def create_rabbitmq_config
+        template "rabbitmq.yml", "config/rabbitmq.yml"
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delayed_rabbit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.1.0
 platform: ruby
 authors:
-- Your Name
+- ShekharBora
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-06-14 00:00:00.000000000 Z
+date: 2025-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -53,21 +53,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,10 +94,24 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
 description: delayed_rabbit provides a simple interface for scheduling background
   jobs with delays using RabbitMQ's delayed message exchange plugin
 email:
-- your.email@example.com
+- chandu42011@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -93,16 +121,20 @@ files:
 - example.rb
 - lib/delayed_rabbit.rb
 - lib/delayed_rabbit/job_publisher.rb
+- lib/delayed_rabbit/railtie.rb
 - lib/delayed_rabbit/version.rb
+- lib/generators/delayed_rabbit/install/templates/initializer.rb
+- lib/generators/delayed_rabbit/install/templates/rabbitmq.yml
+- lib/generators/delayed_rabbit/install_generator.rb
 - tasks/delayed_rabbit.rake
-homepage: https://github.com/yourusername/delayed_rabbit
+homepage: https://github.com/shekharbora/delayed_rabbit
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/yourusername/delayed_rabbit
-  source_code_uri: https://github.com/yourusername/delayed_rabbit
-  changelog_uri: https://github.com/yourusername/delayed_rabbit/blob/master/CHANGELOG.md
+  homepage_uri: https://github.com/shekharbora/delayed_rabbit
+  source_code_uri: https://github.com/shekharbora/delayed_rabbit
+  changelog_uri: https://github.com/shekharbora/delayed_rabbit/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: