gps-job 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 502f52d768ebf9e42c239b93e3bd0b544038b0141166453514fca5b79a938abf
+  data.tar.gz: ff39db2c0858766e4f13f54122a3a94535e4292e392511f25f8b212dc1614082
+SHA512:
+  metadata.gz: 69de08171bd39098566e0ffcf5dcf853c49c919d7e8068d6ac259ca12fb594991744a132f5d7f85b2571dea35ba7d5a65c537575722adb698efa8af123cdff9b
+  data.tar.gz: 980b69efaf87c9f2b62f7d4511650ea867e6b0a04451b712ae97d4b5e510dd34ca752fd090bc9db66969191534f6eb4534e0837f7d1ece0711047eb418741013

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Victor Antoniazzi
+
+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,61 @@
+# Google Pub/Sub job  
+
+Google Cloud Pub/Sub adapter and worker for ActiveJob.
+
+## Usage
+
+```ruby
+gem 'gps-job'
+```
+
+First, change the ActiveJob backend.
+
+``` ruby
+require 'gps/job/adapter'
+
+Rails.application.config.active_job.queue_adapter = :google_cloud_pubsub
+```
+
+Start the worker
+
+``` sh
+$ rake gps:worker
+```
+
+Write the Job class and code to use it.
+
+``` ruby
+class MyJob < ApplicationJob
+  def perform(name)
+    puts "How are you?"
+  end
+end
+```
+
+## Google Pub/Sub Emulator
+
+https://cloud.google.com/pubsub/docs/emulator
+
+``` sh
+$ gcloud beta emulators pubsub start
+```
+
+## Contributing
+
+``` sh
+$ bin/setup
+```
+
+I :heart: Open source!
+
+[Follow github guides for forking a project](https://guides.github.com/activities/forking/)
+
+[Follow github guides for contributing open source](https://guides.github.com/activities/contributing-to-open-source/#contributing)
+
+## Code Status
+
+[![Build Status](https://travis-ci.org/vgsantoniazzi/gps-job.svg?branch=master)](https://travis-ci.org/vgsantoniazzi/gps-job)
+
+## License
+
+Gem is released under the [MIT license](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+import 'lib/tasks/gps/worker.rake'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+  t.warning = false
+end
+
+task default: :test

data/lib/gps/job.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'rails'
+require 'google/cloud/pubsub'
+require 'gps/job/railtie'
+
+module Gps
+  module Job
+    class << self
+      attr_writer :configuration, :metrics
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      def metrics
+        @metrics ||= Metrics.new
+      end
+    end
+
+    def self.configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+
+    def self.topic
+      pubsub.topic(configuration.queue) || pubsub.create_topic(configuration.queue)
+    end
+
+    def self.pubsub
+      Google::Cloud.new(
+        Gps::Job.configuration.project_id,
+        Gps::Job.configuration.credentials
+      ).pubsub
+    end
+
+    autoload :Configuration, 'gps/job/configuration'
+    autoload :Metrics, 'gps/job/metrics'
+    autoload :Worker, 'gps/job/worker'
+    autoload :Adapter, 'gps/job/adapter'
+  end
+end

data/lib/gps/job/adapter.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ActiveJob
+  module QueueAdapters
+    class GoogleCloudPubsubAdapter
+      def enqueue(job, attributes = {})
+        Gps::Job.configuration.logger&.info "Google Pub/Sub Enqueued job #{job.inspect}"
+        Gps::Job.topic.publish(job_data(job, attributes).to_json)
+      end
+
+      def enqueue_at(job, timestamp)
+        enqueue(job, timestamp: timestamp)
+      end
+
+      private
+
+      def job_data(job, attributes)
+        info = job.serialize
+        info['at'] = attributes[:timestamp] if attributes[:timestamp].to_i > Time.now.to_i
+        info
+      end
+    end
+  end
+end

data/lib/gps/job/configuration.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Gps
+  module Job
+    class Configuration
+      attr_accessor :logger, :queue, :project_id, :credentials, :event_name
+
+      def initialize
+        @logger = Logger.new(STDOUT)
+        @queue = :default
+        @project_id = :default
+        @credentials = '~/.google/keyfile.json'
+        @event_name = 'perform.gps_job'
+      end
+    end
+  end
+end

data/lib/gps/job/metrics.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Gps
+  module Job
+    class Metrics
+      attr_accessor :total_duration, :total_count
+
+      def initialize
+        @total_duration = 0
+        @total_count = 0
+      end
+    end
+  end
+end

data/lib/gps/job/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Gps
+  module Job
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        load 'tasks/gps/worker.rake'
+      end
+    end
+  end
+end

data/lib/gps/job/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Gps
+  module Job
+    VERSION = '0.1.0'
+  end
+end

data/lib/gps/job/worker.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Gps
+  module Job
+    class Worker
+      def self.run_worker!
+        Gps::Job.configuration.logger&.info 'Google Pub/Sub Worker running.'
+        subscribe_to_active_support_instrumentation!
+        subscribe_to_google_pub_sub!
+      end
+
+      def self.subscribe_to_active_support_instrumentation!
+        ActiveSupport::Notifications.subscribe(Gps::Job.configuration.event_name) do |_name, started, finished, _unique_id, data|
+          Gps::Job.configuration.logger&.info "Finished job: #{data}"
+          Gps::Job.metrics.total_duration += (finished - started)
+          Gps::Job.metrics.total_count += 1
+        end
+      end
+
+      def self.subscribe_to_google_pub_sub!
+        subscription.listen do |message|
+          data = JSON.parse(message.data)
+          if perform_now?(data)
+            message.acknowledge!
+            perform_job(data)
+          end
+        end
+      end
+
+      def self.perform_now?(data)
+        data['at'].to_i < Time.now.to_i
+      end
+
+      def self.perform_job(data)
+        Gps::Job.configuration.logger&.info "Started Job: #{data}"
+        ActiveSupport::Notifications.instrument(Gps::Job.configuration.event_name, data) do
+          data.fetch('job_class').constantize.perform_now(*data.fetch('arguments'))
+        end
+      end
+
+      def self.subscription
+        Gps::Job.topic.subscription(Gps::Job.configuration.queue) ||
+          Gps::Job.topic.subscribe(Gps::Job.configuration.queue)
+      end
+    end
+  end
+end

data/lib/tasks/gps/worker.rake

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'gps/job'
+
+namespace :gps do
+  task :worker do
+    Rails.application.initialize! if defined?(Rails)
+    Gps::Job::Worker.run_worker!
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: gps-job
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Victor Antoniazzi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.5
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-pubsub
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+description: Google Pub/Sub Active Job Adapter
+email:
+- vgsantoniazzi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/gps/job.rb
+- lib/gps/job/adapter.rb
+- lib/gps/job/configuration.rb
+- lib/gps/job/metrics.rb
+- lib/gps/job/railtie.rb
+- lib/gps/job/version.rb
+- lib/gps/job/worker.rb
+- lib/tasks/gps/worker.rake
+homepage: http://github.com/vgsantoniazzi/gps-job
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.10
+signing_key: 
+specification_version: 4
+summary: Google Pub/Sub Active Job Adapter
+test_files: []