pubilion 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 32330acf3d201866165a6e8b5e10b8fa458d97d49b296debbda199a88ee92270
+  data.tar.gz: aa64ea1215012ba90d25d08700c711261aaf3538aed3468587cfb226f2037197
+SHA512:
+  metadata.gz: a72c58e9dd5a8c397695914141480a6ee94ef3d920ac880a9217259b15e4693606861cd66c06bae9810d5a21c182b03f18d480e2105cb5fed45f3a0a1af93aed
+  data.tar.gz: 59fd7354d2fac6ae55c34d1d867f02ef9f8f9467f272dd84166307ba49645a7d7681ac725d90544bef168c8fa642aa01e4e7bd2027d91b48b8cced08a2569df2

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  Exclude:
+    - "example/**/*"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*_spec.rb"
+    - "pubilion.gemspec"

data/.ruby-version

@@ -0,0 +1 @@
+3.3.6

data/.solargraph.yml

@@ -0,0 +1,10 @@
+include:
+  - "**/*.rb"
+exclude:
+  - spec/**/*
+require:
+  - activejob
+  - google-cloud-pubsub
+domains: []
+reporters:
+  - rubocop

data/.yardopts

@@ -0,0 +1,4 @@
+-
+README.md
+CHANGELOG.md
+LICENSE

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - 2024-11-11
+
+- Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 LruLab
+
+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,97 @@
+# Pubilion
+
+Pubilion is a Ruby gem that provides a simple way to use ActiveJob with Cloud Pub/Sub.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pubilion'
+```
+
+And execute command:
+
+```bash
+bundle install
+```
+
+## Usage
+
+> [!NOTE]
+> This gem is built to be used with rails.
+> There is currently no usage in Plain Ruby.
+
+### Configuration
+
+1. Generate initializer file.
+
+```bash
+rails generate pubilion:install
+```
+
+2. Specify settings in the initializer file. See your `config/initializers/pubilion.rb` for details.
+
+### Message Publish
+
+1. Set queue adapter to `pub_sub`.
+
+```ruby
+# config/application.rb
+config.active_job.queue_adapter = :pub_sub
+```
+
+or
+
+```ruby
+# app/jobs/application_job.rb (or any other job file)
+class ApplicationJob < ActiveJob::Base
+  self.queue_adapter = :pub_sub
+end
+```
+
+2. Create a job class.
+
+```ruby
+# app/jobs/hello_job.rb
+class HelloJob < ApplicationJob
+  # `queue_as` is recognized as a Topic name.
+  queue_as :topic_name
+
+  def perform(*args)
+    puts "Hello, World!"
+  end
+end
+```
+
+3. Call `perform_later`.
+
+```ruby
+HelloJob.perform_later
+```
+
+### Message Subscribe
+
+> [!NOTE]
+> Currently, the worker is support only single subscription.
+> If you want to use multiple subscriptions, you need to create worker per subscription.
+
+1. Run the worker.
+
+```bash
+bundle exec rake pubilion:worker:start
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/LruLab/pubilion.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/compose.yml

@@ -0,0 +1,9 @@
+services:
+  pubsub:
+    image: gcr.io/google.com/cloudsdktool/google-cloud-cli:emulators
+    command: |
+      gcloud beta emulators pubsub start --host-port=0.0.0.0:8085
+    ports:
+      - target: 8085
+        published: 18085
+        protocol: tcp

data/exe/pubilion

@@ -0,0 +1,6 @@
+#!/use/bin/env ruby
+
+require "bundler/setup"
+require "pubilion"
+
+Pubilion::CLI.start(ARGV)

data/lib/pubilion/cli/subscription.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "thor"
+
+module Pubilion
+  class CLI < Thor
+    class Subscription < Thor
+      desc "create TOPIC_NAME SUBSCRIPTION_NAME", "Create a new subscription"
+      option :topic, required: true, desc: "The topic name"
+      def create(subscription_name)
+        topic = client.find_topic(options[:topic])
+        subscription = topic.subscribe(subscription_name)
+        puts "Subscription #{subscription.name} created."
+      end
+
+      private
+
+      def client
+        @client ||= Google::Cloud::PubSub.new(
+          project_id: Pubilion::Config.project_id,
+          credentials: Pubilion::Config.credentials
+        )
+      end
+    end
+  end
+end

data/lib/pubilion/cli/topic.rb

@@ -0,0 +1,24 @@
+# frozern_string_literal: true
+
+require "thor"
+
+module Pubilion
+  class CLI < Thor
+    class Topic < Thor
+      desc "create TOPIC_NAME", "Create a new topic"
+      def create(topic_name)
+        topic = client.create_topic(topic_name)
+        puts "Topic #{topic.name} created."
+      end
+
+      private
+
+      def client
+        @client ||= Google::Cloud::PubSub.new(
+          project_id: Pubilion::Config.project_id,
+          credentials: Pubilion::Config.credentials
+        )
+      end
+    end
+  end
+end

data/lib/pubilion/cli.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "thor"
+require "pubilion/cli/topic"
+require "pubilion/cli/subscription"
+
+module Pubilion
+  # Command Line Interface for Pubilion
+  class CLI < Thor
+    desc "subscription SUBCOMMAND ...ARGS", "Manage subscriptions"
+    subcommand "subscription", Pubilion::CLI::Subscription
+
+    desc "topic SUBCOMMAND ...ARGS", "Manage topics"
+    subcommand "topic", Pubilion::CLI::Topic
+
+    desc "version", "Print the version"
+    def version
+      puts Pubilion::VERSION
+    end
+  end
+end

data/lib/pubilion/config.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Pubilion
+  # Configuration for Pubilion
+  class Config
+    class << self
+      attr_writer :project_id, :credentials, :topic, :subscription
+
+      # Configure Pubilion.
+      #
+      # @yield [config] Configuration object
+      # @example
+      #   Pubilion::Config.configure do |config|
+      #     config.project_id = "my-project"
+      #     config.credentials = "/path/to/credentials.json"
+      #     config.topic = "my-topic"
+      #     config.subscription = "my-subscription"
+      #   end
+      # @return [void]
+      def configure
+        yield self
+      end
+
+      # Google Cloud Project ID.
+      # If it is not set, it will try to get from environment variable +PUBSUB_PROJECT_ID+.
+      # If it still unsettled, implicitly set by Google Cloud SDK.
+      #
+      # @return [String, nil]
+      def project_id
+        @project_id ||= ENV.fetch("PUBSUB_PROJECT_ID", nil)
+      end
+
+      # Credentials file path for access to Cloud Pub/Sub.
+      # If not set, it will try to get from environment variable  +GOOGLE_APPLICATION_CREDENTIALS+.
+      # If not set and +GOOGLE_APPLICATION_CREDENTIALS+ is not set, it will implicitly set by Google Cloud SDK.
+      #
+      # @return [String, nil]
+      def credentials
+        @credentials ||= ENV.fetch("GOOGLE_APPLICATION_CREDENTIALS", nil)
+      end
+
+      # Topic name of subscription.
+      # If not set, it will try to get from +PUBSUB_TOPIC+.
+      # This configuration is required for +Pubilion::Worker+.
+      #
+      # @return [String, nil]
+      def topic
+        @topic ||= ENV.fetch("PUBSUB_TOPIC", nil)
+      end
+
+      # Subscription name.
+      # If not set, it will try to get from +PUBSUB_SUBSCRIPTION+.
+      # This configuration is required for +Pubilion::Worker+.
+      #
+      # @return [String, nil]
+      def subscription
+        @subscription ||= ENV.fetch("PUBSUB_SUBSCRIPTION", nil)
+      end
+    end
+  end
+end

data/lib/pubilion/errors.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Pubilion
+  # Custom error classes for Pubilion
+  class Error < StandardError; end
+
+  # Raised when a feature is not supported by Pubilion
+  class NotSupported < Error; end
+
+  # Raised when a topic is not found in message publishing or subscribing
+  class TopicNotFound < Error; end
+end

data/lib/pubilion/extensions/active_job/queue_adapter.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module ActiveJob
+  module QueueAdapters
+    # Cloud Pub/Sub Queue Adapter  for ActiveJob
+    class PubSubAdapter
+      require "google/cloud/pubsub"
+
+      # Enqueue a job to Cloud Pub/Sub.
+      # @param job [ActiveJob::Base] the job to enqueue.
+      def enqueue(job)
+        topic = client.find_topic(job.queue_name)
+        raise Pubilion::TopicNotFound, "Topic not found: #{job.queue_name}" if topic.nil?
+
+        topic.publish(job.serialize.to_json)
+      end
+
+      # THIS METHOD IS NOT SUPPORTED.
+      # Always raise Pubilion::NotSupported.
+      # Because PubSub does not support job scheduling.
+      # If you need to schedule jobs, use a Cloud Tasks or other QueueAdapter.
+      def enqueue_at(_job, _timestamp)
+        raise Pubilion::NotSupported, <<~MSG
+          PubSub does not support job scheduling.
+          If you need to schedule jobs, use a Cloud Tasks or other QueueAdapter.
+        MSG
+      end
+
+      private
+
+      def client
+        @client ||= Google::Cloud::PubSub.new(
+          project_id: Pubilion::Config.project_id,
+          credentials: Pubilion::Config.credentials
+        )
+      end
+    end
+  end
+end

data/lib/pubilion/extensions.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "pubilion/extensions/active_job/queue_adapter"

data/lib/pubilion/generators/install_generator.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+
+module Pubilion
+  module Generators
+    # Install generator for Pubilion.
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Copy initializer file to your application."
+
+      def copy_initializer_file
+        template "pubilion.rb", "config/initializers/pubilion.rb"
+      end
+    end
+  end
+end

data/lib/pubilion/generators/templates/pubilion.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+Pubilion::Config.configure do |config|
+  # Set Google Cloud Project ID
+  # Can be specified by the environment variable `PUBSUB_PROJECT_ID`
+  # config.project_id = "your-project-id"
+
+  # Set Google Cloud Pub/Sub topic name to subscribe
+  # Can be specified by the environment variable `PUBSUB_TOPIC`
+  # config.topic = "your-topic-name"
+
+  # Set Google Cloud Pub/Sub subscription name
+  # Can be specified by the environment variable `PUBSUB_SUBSCRIPTION`
+  # config.subscription = "your-subscription-name"
+
+  # Set Google Cloud Pub/Sub credentials file path
+  # Can be specified by the environment variable `GOOGLE_APPLICATION_CREDENTIALS`
+  # config.credentials = "/path/to/credentials.json"
+end

data/lib/pubilion/railties.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Pubilion
+  # Railtie for Pubilion.
+  #
+  # This class is used for loading rake tasks.
+  # When this gem is loaded in a Rails application, tasks in +lib/tasks+ are loaded automatically.
+  class Railtie < Rails::Railtie
+    railtie_name :pubilion
+
+    rake_tasks do
+      path = File.expand_path(__dir__)
+      Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+    end
+  end
+end

data/lib/pubilion/tasks/worker.rake

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+namespace :pubilion do
+  namespace :worker do
+    desc "Start the Pubilion worker"
+    task start: :environment do
+      Pubilion::Worker.run
+    end
+  end
+end

data/lib/pubilion/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Pubilion
+  VERSION = "0.1.0"
+end

data/lib/pubilion/worker/message_handler.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Pubilion
+  class Worker
+    # Message handler for Pubilion worker
+    class MessageHandler
+      require "active_support/inflector"
+
+      # Handle incoming message
+      def on_message(message)
+        autoreload do
+          job = deserialize(message.data)
+
+          if job.nil?
+            message.nack!
+            return
+          end
+
+          job.perform_now
+          message.ack!
+        end
+      rescue StandardError
+        message.nack!
+      end
+
+      # Handle error
+      def on_error(error)
+        # TODO: Implement error handling
+      end
+
+      private
+
+      def deserialize(payload)
+        job_data = JSON.parse(payload)
+        klass = job_data["job_class"]&.safe_constantize
+        return nil if klass.nil?
+
+        instance = klass.new
+        instance.deserialize(job_data)
+
+        instance
+      end
+
+      def autoreload(&block)
+        if defined?(Rails)
+          Rails.application.reloader.wrap(&block)
+        else
+          block.call
+        end
+      end
+    end
+  end
+end

data/lib/pubilion/worker/runner.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Pubilion
+  class Worker
+    # Runner for Pubilion worker
+    class Runner
+      WAIT_INTERVAL = 1
+      EXIT_SIGNALS = %w[SIGTERM SIGINT].freeze
+
+      attr_reader :subscriber
+
+      def initialize(config)
+        @handler = Pubilion::Worker::MessageHandler.new
+        @subscriber = Pubilion::Worker::Subscriber.new(config, @handler)
+      end
+
+      # Start worker and wait for exits.
+      def run
+        subscriber.run
+
+        wait_for_exits
+      ensure
+        subscriber.shutdown
+      end
+
+      private
+
+      def wait_for_exits(signals = EXIT_SIGNALS)
+        exit_requested = false
+        signals.each { |sig| Signal.trap(sig) { exit_requested = true } }
+
+        sleep WAIT_INTERVAL until exit_requested || subscriber.stopped?
+      end
+    end
+  end
+end

data/lib/pubilion/worker/subscriber.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Pubilion
+  class Worker
+    # Subscriber on Pubilion
+    class Subscriber
+      require "google/cloud/pubsub"
+
+      SHUTDOWN_WAIT = 20
+
+      attr_reader :config, :handler
+
+      def initialize(config, handler)
+        @config = config
+        @handler = handler
+      end
+
+      # Start streaming pull subscribe.
+      def run
+        @subscriber = subscription.listen do |message|
+          handler.on_message(message)
+        end
+
+        @subscriber.on_error do |error|
+          handler.on_error(error)
+        end
+
+        @subscriber.start
+      end
+
+      # Stop streaming pull subscribe.
+      def shutdown
+        @subscriber&.stop&.wait!(SHUTDOWN_WAIT)
+      end
+
+      # Check if subscriber is alive.
+      def alive?
+        @subscriber.started? && !@subscriber.stopped?
+      end
+
+      # Check if subscriber is stopped.
+      def stopped?
+        @subscriber.stopped?
+      end
+
+      private
+
+      def client
+        @client ||= Google::Cloud::PubSub.new(
+          project_id: config.project_id,
+          credentials: config.credentials
+        )
+      end
+
+      def topic
+        @topic ||= client.find_topic(config.topic)
+        raise Pubilion::TopicNotFound, "Topic not found: #{config.topic}" if @topic.nil?
+
+        @topic
+      end
+
+      def subscription
+        @subscription ||= topic.find_subscription(config.subscription)
+        raise Pubilion::SubscriptionNotFound, "Subscription not found: #{config.subscription}" if @subscription.nil?
+
+        @subscription
+      end
+    end
+  end
+end

data/lib/pubilion/worker.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "pubilion/worker/message_handler"
+require "pubilion/worker/subscriber"
+require "pubilion/worker/runner"
+
+module Pubilion
+  # Subscribe worker on Pubilion
+  class Worker
+    class << self
+      def run
+        Pubilion::Worker::Runner.new(Pubilion::Config).run
+      end
+    end
+  end
+end

data/lib/pubilion.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "pubilion/version"
+require "pubilion/errors"
+require "pubilion/config"
+
+require "pubilion/extensions"
+require "pubilion/worker"
+require "pubilion/cli"
+
+require "pubilion/railties" if defined?(Rails::Railtie)
+require "pubilion/generators/install_generator" if defined?(Rails::Generators)
+
+# Ruby library for performing job with Google Cloud Pub/Sub.
+module Pubilion; end

data/sig/pubilion.rbs

@@ -0,0 +1,4 @@
+module Pubilion
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: pubilion
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- KL-Lru
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-pubsub
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: ActiveJob Backend for Google Cloud Pub/Sub
+email:
+- 26233827+KL-Lru@users.noreply.github.com
+executables:
+- pubilion
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".solargraph.yml"
+- ".yardopts"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- compose.yml
+- exe/pubilion
+- lib/pubilion.rb
+- lib/pubilion/cli.rb
+- lib/pubilion/cli/subscription.rb
+- lib/pubilion/cli/topic.rb
+- lib/pubilion/config.rb
+- lib/pubilion/errors.rb
+- lib/pubilion/extensions.rb
+- lib/pubilion/extensions/active_job/queue_adapter.rb
+- lib/pubilion/generators/install_generator.rb
+- lib/pubilion/generators/templates/pubilion.rb
+- lib/pubilion/railties.rb
+- lib/pubilion/tasks/worker.rake
+- lib/pubilion/version.rb
+- lib/pubilion/worker.rb
+- lib/pubilion/worker/message_handler.rb
+- lib/pubilion/worker/runner.rb
+- lib/pubilion/worker/subscriber.rb
+- sig/pubilion.rbs
+homepage: https://github.com/LruLab/pubilion
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/LruLab/pubilion
+  source_code_uri: https://github.com/LruLab/pubilion
+  documantation_uri: https://lrulab.github.io/pubilion
+  changelog_uri: https://lrulab.github.io/pubilion/file.CHANGELOG.html
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key: 
+specification_version: 4
+summary: ActiveJob Backend for Google Cloud Pub/Sub
+test_files: []