hoze 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 13ccaea71486a72b78f2c505eee8c33f6262ef22
+  data.tar.gz: 101857b73c29bfc24f96b8be3392fe76f2708da2
+SHA512:
+  metadata.gz: bf093a19e8b9f0633d73e19ae631dad346a323fd8ec5cc4174ae1040520d4ab3b98b1831fbac6cb91d0df1610796b67533ced7d8377f8f50d80a6d74b8d6f72c
+  data.tar.gz: b820e09cf639dc65e49cf919ad0859d49a13a2bdc6919125dde6765ad2d01991530809ac847b3ce419e1666d834749b5ceb7f9f3d95ec1a98092dcb55c6cdf26

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in hoze.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 pluce
+
+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,54 @@
+# Hoze
+
+Hoze is a runtime that helps implementing asynchronous jobs on top of Google Pub/Sub cloud queue system. Write your logic, Hoze takes care of plumbing.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hoze'
+```
+
+And then execute:
+
+    $ bundle install --binstubs
+
+## Usage
+
+Write a simple worker file `worker.rb`:
+
+```ruby
+Hoze.worker
+.configure do |config|
+  # You can use env variable for each property to overload hardcoded values
+  config.channel = "my.pubsub.topic" # HOZE_CONFIG_CHANNEL
+  config.key = "my.subscription.name" # HOZE_CONFIG_KEY
+  config.connector.type = "pubsub" # HOZE_CONFIG_CONNECTOR_TYPE
+  config.connector.project = "my-gcp-project" # HOZE_CONFIG_CONNECTOR_PROJECT
+  config.connector.path_to_key = "/path/to/keyfile.json" # HOZE_CONFIG_CONNECTOR_PATH_TO_KEY
+end
+.process do |message|
+  puts "Hello #{message.payload} !"
+end
+```
+
+And now run it:
+
+```shell
+bundle exec hoze worker.rb
+```
+
+## 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 tags, 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/pluce/hoze.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hoze"
+
+# 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/exe/hoze

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'hoze/cli'

data/hoze.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hoze/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hoze"
+  spec.version       = Hoze::VERSION
+  spec.authors       = ["pluce"]
+  spec.email         = ["pluce@ventadis.fr"]
+
+  spec.summary       = "Asynchronous job runtime backed by Google Pub Sub"
+  spec.description   = "Asynchronous job runtime backed by Google Pub Sub"
+  spec.homepage      = "https://github.com/pluce/hoze"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "google-cloud-pubsub", "~> 0.29.0"
+end

data/lib/hoze/cli.rb

@@ -0,0 +1,16 @@
+require "hoze"
+
+script = ARGV[0]
+
+unless script
+  puts "No worker script given"
+  exit 1
+end
+
+puts "Running with worker script #{script}"
+
+script_path = Pathname.new(script).realpath
+
+puts "Loading script from file #{script_path}"
+
+require script_path

data/lib/hoze/configuration.rb

@@ -0,0 +1,50 @@
+require "google/cloud/pubsub"
+
+module Hoze
+
+  class Configuration
+    attr_accessor :channel, :key, :auto_ack, :connector, :max_tries
+
+    def initialize
+      @connector = ConnectorConfiguration.new
+    end
+
+    def channel
+      env_config('CHANNEL') || @channel
+    end
+
+    def key
+      env_config('KEY') || @key
+    end
+
+    private
+
+    def env_config name
+      return ENV["HOZE_CONFIG_#{name}"]
+    end
+
+  end
+
+  class ConnectorConfiguration
+    attr_accessor :type, :project, :path_to_key
+
+    def type
+      env_config('TYPE') || @type
+    end
+
+    def project
+      env_config('PROJECT') || @project
+    end
+
+    def path_to_key
+      env_config('PATH_TO_KEY') || @path_to_key
+    end
+
+    private
+
+    def env_config name
+      return ENV["HOZE_CONFIG_CONNECTOR_#{name}"]
+    end
+  end
+
+end

data/lib/hoze/interface/message.rb

@@ -0,0 +1,29 @@
+module Hoze
+
+  class Message
+
+    attr_reader :payload, :timestamp, :metadata, :source, :source_message
+    
+    # Ask for more time before acknowledging
+    def delay! seconds
+      raise NotImplementedError.new("This message implementation doesn't support delay! method.")
+    end
+
+    # Acknowledge the message
+    def ack!
+      raise NotImplementedError.new("This message implementation doesn't support ack! method.")
+    end
+
+    # Release the message
+    def reject!
+      raise NotImplementedError.new("This message implementation doesn't support reject! method.")
+    end
+
+    # Retry the message
+    def retry!
+      raise NotImplementedError.new("This message implementation doesn't support retry! method.")
+    end
+
+  end
+
+end

data/lib/hoze/interface/source.rb

@@ -0,0 +1,13 @@
+module Hoze
+
+  class Source
+
+    attr_reader :engine, :channel, :key
+
+    def listen &block
+      raise NotImplementedError.new("This source implementation doesn't support listen method.")
+    end
+    
+  end
+
+end

data/lib/hoze/pubsub/message.rb

@@ -0,0 +1,47 @@
+require "hoze/interface/message"
+
+module Hoze
+
+  class PubSubMessage < Message
+
+    def initialize source_message, source
+      @payload = source_message.data
+      @timestamp = source_message.published_at
+      @metadata = source_message.attributes
+      @metadata['tries'] = (@metadata['tries'].to_i || 0) + 1
+      @source_message = source_message
+      @source = source
+      @acked = false
+    end
+
+    # Ask for more time before acknowledging
+    def delay! seconds
+      @source_message.delay! seconds
+    end
+
+    # Acknowledge the message
+    def ack!
+      @source_message.ack! unless @acked
+      @acked = true
+    end
+
+    # Release the message
+    def reject!
+      @source_message.reject!
+    end
+
+    # Retry the message
+    def retry!
+      ack!
+      retry_config = @source.max_tries || 1
+      if @metadata['tries'] < retry_config
+        puts "RETRYING: #{@metadata['tries']} / #{retry_config}"
+        @source.topic.publish_async(@payload, @metadata)
+      else
+        puts "Dead message #{@source_message.inspect}"
+      end
+    end
+
+  end
+
+end

data/lib/hoze/pubsub/source.rb

@@ -0,0 +1,62 @@
+require "hoze/interface/source"
+require "hoze/pubsub/message"
+
+module Hoze
+
+  class PubSubSource < Source
+
+    attr_reader :topic, :subscription, :max_tries
+
+    def initialize configuration
+      @engine = Google::Cloud::Pubsub.new(
+        project: configuration.connector.project,
+        credentials: configuration.connector.path_to_key
+      )
+
+      @channel = configuration.channel
+      @key = configuration.key
+
+      @topic = ensure_topic
+      @subscription = ensure_subscription
+
+      @max_tries = configuration.max_tries
+    end
+
+
+    def listen &block
+      #puts @subscription.inspect
+      subscriber = @subscription.listen do |received_message|
+        begin
+          msg = Hoze::PubSubMessage.new(received_message, self)
+          yield msg
+        rescue Exception => e
+          puts "Exception: #{e.message}"
+          raise # always reraise
+        end
+      end
+      subscriber.start
+      begin
+        puts "Starts listening"
+        while true do
+          sleep 10
+        end
+      rescue Interrupt
+        puts "Interrupted, cleaning ok"
+      ensure
+        subscriber.stop.wait!
+      end
+    end
+    
+    private
+
+    def ensure_topic
+      @engine.topic(@channel)||@engine.create_topic(@channel)
+    end
+
+    def ensure_subscription
+      @topic.subscription(@key)||@topic.subscribe(@key)
+    end
+
+  end
+
+end

data/lib/hoze/source_factory.rb

@@ -0,0 +1,22 @@
+require "google/cloud/pubsub"
+require "hoze/pubsub/source"
+
+module Hoze
+
+  class SourceFactory
+
+    def initialize
+    end
+
+    def build configuration
+      case configuration.connector.type
+      when 'pubsub'
+         Hoze::PubSubSource.new configuration
+      else
+        raise Exception.new("Connector #{configuration.connector[:type]} not implemented")
+      end
+    end
+
+  end
+
+end

data/lib/hoze/version.rb

@@ -0,0 +1,3 @@
+module Hoze
+  VERSION = "0.1.0"
+end

data/lib/hoze/worker.rb

@@ -0,0 +1,39 @@
+require 'hoze/source_factory'
+
+module Hoze
+
+  def self.worker
+    Hoze::Worker.new
+  end
+
+  class Worker
+
+    attr_accessor :source_factory
+
+    def initialize
+      @configuration = Hoze::Configuration.new
+      @source_factory = Hoze::SourceFactory.new
+    end
+
+    def configure &block
+      yield @configuration
+      puts "Configuration is: #{@configuration.inspect}"
+      self
+    end
+
+    def process &block   
+      source = @source_factory.build(@configuration)
+      
+      source.listen do |msg|
+        begin
+          msg.ack! if @configuration.auto_ack
+          result = yield msg
+        rescue Exception => e
+          msg.retry!
+          raise e
+        end
+      end
+    end
+  end
+
+end

data/lib/hoze.rb

@@ -0,0 +1,8 @@
+require "hoze/version"
+
+require "hoze/worker"
+require "hoze/configuration"
+
+module Hoze
+
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: hoze
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- pluce
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-pubsub
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.29.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.29.0
+description: Asynchronous job runtime backed by Google Pub Sub
+email:
+- pluce@ventadis.fr
+executables:
+- hoze
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/hoze
+- hoze.gemspec
+- lib/hoze.rb
+- lib/hoze/cli.rb
+- lib/hoze/configuration.rb
+- lib/hoze/interface/message.rb
+- lib/hoze/interface/source.rb
+- lib/hoze/pubsub/message.rb
+- lib/hoze/pubsub/source.rb
+- lib/hoze/source_factory.rb
+- lib/hoze/version.rb
+- lib/hoze/worker.rb
+homepage: https://github.com/pluce/hoze
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Asynchronous job runtime backed by Google Pub Sub
+test_files: []