gcpc 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d26d83b3ad1b3c23b83aa62eb8742e522eaa14df00d608e33b639848354081db
+  data.tar.gz: 74366ee318ca77cb08baaaf0d99c3021f72e30b744cc38cd66d6fb0bc33dc6b6
+SHA512:
+  metadata.gz: f2c90798e86df808662e2906e2ab5b073b102a7aacfb77803dd63f37b72fb559822e0b1b91d9afdd2f929fa6b02ed6f6714df7ca67fa17a74fd3491a2dd5840d
+  data.tar.gz: 4f659b9666d194f9317ab16cee630ba1698168557af6c9ea6bc15fa34e9ee399c3f31ae50fa6ace1db2511cb4192d487e7412ba37043aed590cd75cedd705f5a

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,19 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.2
+before_install:
+  - gem install bundler -v 1.17.2
+jobs:
+  include:
+    - name: 'test'
+      script:
+        - bundle exec rspec
+    - name: 'test with a emulator'
+      before_install:
+        # Start a Cloud Pub/Sub emulator. See https://cloud.google.com/pubsub/docs/emulator
+        - docker run -d -p 8085:8085 -it google/cloud-sdk:latest gcloud beta emulators pubsub start --host-port=0.0.0.0:8085
+      script:
+        - bundle exec rspec --tag emulator

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 gcpc.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: .
+  specs:
+    gcpc (0.0.4)
+      google-cloud-pubsub
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    google-cloud-core (1.3.0)
+      google-cloud-env (~> 1.0)
+    google-cloud-env (1.1.0)
+      faraday (~> 0.11)
+    google-cloud-pubsub (0.36.0)
+      concurrent-ruby (~> 1.0)
+      google-cloud-core (~> 1.2)
+      google-gax (~> 1.3)
+      googleapis-common-protos (>= 1.3.9, < 2.0)
+      grpc-google-iam-v1 (~> 0.6.9)
+    google-gax (1.6.3)
+      google-protobuf (~> 3.2)
+      googleapis-common-protos (>= 1.3.5, < 2.0)
+      googleauth (>= 0.6.2, < 0.10.0)
+      grpc (>= 1.7.2, < 2.0)
+      rly (~> 0.2.3)
+    google-protobuf (3.8.0)
+    googleapis-common-protos (1.3.9)
+      google-protobuf (~> 3.0)
+      googleapis-common-protos-types (~> 1.0)
+      grpc (~> 1.0)
+    googleapis-common-protos-types (1.0.4)
+      google-protobuf (~> 3.0)
+    googleauth (0.8.1)
+      faraday (~> 0.12)
+      jwt (>= 1.4, < 3.0)
+      memoist (~> 0.16)
+      multi_json (~> 1.11)
+      os (>= 0.9, < 2.0)
+      signet (~> 0.7)
+    grpc (1.21.0)
+      google-protobuf (~> 3.7)
+      googleapis-common-protos-types (~> 1.0)
+    grpc-google-iam-v1 (0.6.9)
+      googleapis-common-protos (>= 1.3.1, < 2.0)
+      grpc (~> 1.0)
+    jwt (2.2.1)
+    memoist (0.16.0)
+    method_source (0.9.2)
+    multi_json (1.13.1)
+    multipart-post (2.1.1)
+    os (1.0.1)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.1.0)
+    rake (10.5.0)
+    rly (0.2.3)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    signet (0.11.0)
+      addressable (~> 2.3)
+      faraday (~> 0.9)
+      jwt (>= 1.5, < 3.0)
+      multi_json (~> 1.10)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  gcpc!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.2)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Nao Minami
+
+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,161 @@
+# Gcpc
+
+**G**oogle **C**loud **P**ub/Sub **C**lient for Ruby.
+
+Gcpc provides the implementation of the publisher / subscriber for [Google Cloud Pub/Sub](https://cloud.google.com/pubsub/). You can add some functionality to the publisher / subscriber as interceptors.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gcpc'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gcpc
+
+## Usage
+
+`gcpc` have publisher and subscriber implementation of Google Cloud Pub/Sub.
+
+### Publisher
+
+To use `Gcpc::Publisher`, pleaese initialize `Gcpc::Publisher` with some configurations.
+
+```ruby
+publisher = Gcpc::Publisher.new(
+  project_id:  "<project id>",
+  topic:       "<topic name>",
+  credentials: "/path/to/credentials",
+)
+```
+
+Then, simply call `Gcpc::Publisher#publish` to post a message!
+
+```ruby
+publisher.publish("<message payload>")
+```
+
+#### Interceptors
+
+By using interceptors, you can add some functionality to the publisher.
+
+For example, you can add logging functionality by adding `LogInterceptor` as shown below.
+
+```ruby
+class LogInterceptor < Gcpc::Publisher::BaseInterceptor
+  MyLogger = Logger.new(STDOUT)
+
+  # @param [String] data
+  # @param [Hash] attributes
+  def publish(data, attributes)
+    MyLogger.info "[Interceptor Log] publish data: \"#{data}\", attributes: #{attributes}"
+    yield data, attributes
+  end
+end
+
+publisher = Gcpc::Publisher.new(
+  project_id:   "<project id>",
+  topic:        "<topic name>",
+  interceptors: [LogInterceptor],
+  credentials:  "/path/to/credentials",
+)
+
+publisher.publish("<message payload>")
+```
+
+#### Publisher Example
+A full example code is in [publisher-example](./examples/publisher-example). Please see it.
+
+### Subscriber
+
+To use `Gcpc::Subscriber`, pleaese initialize `Gcpc::Subscriber` with some configurations.
+
+```ruby
+subscriber = Gcpc::Subscriber.new(
+  project_id:   "<project id>",
+  subscription: "<subscription name>",
+  credentials:  "/path/to/credentials",
+)
+```
+
+Then, call `Gcpc::Subscriber#handle` to register a handler. A registered handler executes `#handle` callback for each published message.
+
+```ruby
+class NopHandler < Gcpc::Subscriber::BaseHandler
+  # @param [String] data
+  # @param [Hash] attributes
+  # @param [Google::Cloud::Pubsub::ReceivedMessage] message
+  def handle(data, attributes, message)
+    # Do nothing. Consume only.
+  end
+end
+
+subscriber.handle(NopHandler)
+```
+
+To start subscribing, please call `Gcpc::Subscriber#start`. It does not return, and run subscribing loops in it.
+
+```ruby
+subscriber.run
+```
+
+#### Signal Handling
+
+By default, you can stop a subscriber process by sending `SIGINT`, `SIGTERM`, or `SIGKILL` signals.
+
+If you want to use other signals, please pass signals to `#run`.
+
+```ruby
+subscriber.run(['SIGINT', 'SIGTERM', 'SIGSTOP', 'SIGTSTP'])
+```
+
+#### Interceptors
+
+By using interceptors, you can add some functionality to the subscriber.
+
+For example, you can add logging functionality by adding `LogInterceptor` as shown below.
+
+```ruby
+class LogInterceptor < Gcpc::Subscriber::BaseInterceptor
+  MyLogger = Logger.new(STDOUT)
+
+  # @param [String] data
+  # @param [Hash] attributes
+  # @param [Google::Cloud::Pubsub::ReceivedMessage] message
+  def handle(data, attributes, message)
+    MyLogger.info "[Interceptor Log] subscribed a message: #{message}"
+    yield data, attributes, message
+  end
+end
+
+subscriber = Gcpc::Subscriber.new(
+  project_id:   "<project id>",
+  subscription: "<subscription name>",
+  interceptors: [LogInterceptor],
+  credentials:  "/path/to/credentials",
+)
+```
+
+#### Subscriber Example
+A full example code is in [subscriber-example](./examples/subscriber-example). Please see it.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` 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/south37/gcpc.
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gcpc"
+
+# 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.
+
+require "pry"
+Pry.start

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/examples/publisher-example/README.md

@@ -0,0 +1,11 @@
+## publisher example
+
+An example code of `Gcpc::Publisher`.
+
+If you want to try `Gcpc`, please execute commands below in the root of this repository.
+
+```
+$ gcloud beta emulators pubsub start  # Please install Cloud Pub/Sub emulator from https://cloud.google.com/pubsub/docs/emulator for executing this.
+$ bundle exec ruby examples/subscriber-example/subscriber-example.rb
+$ bundle exec ruby examples/publisher-example/publisher-example.rb
+```

data/examples/publisher-example/publisher-example.rb

@@ -0,0 +1,35 @@
+require "gcpc"
+
+# Please execute commands below.
+#
+# ```
+# $ gcloud beta emulators pubsub start
+# $ bundle exec ruby examples/subscriber-example/subscriber-example.rb
+# $ bundle exec ruby examples/publisher-example/publisher-example.rb
+# ```
+
+PROJECT_ID = "project-example-1"
+TOPIC_NAME = "topic-example-1"
+
+class LogInterceptor < Gcpc::Publisher::BaseInterceptor
+  MyLogger = Logger.new(STDOUT)
+
+  def publish(data, attributes)
+    MyLogger.info "[Interceptor Log] publish data: \"#{data}\", attributes: #{attributes}"
+    yield data, attributes
+  end
+end
+
+def main
+  publisher = Gcpc::Publisher.new(
+    project_id:    PROJECT_ID,
+    topic:         TOPIC_NAME,
+    interceptors:  [LogInterceptor],
+    emulator_host: "localhost:8085",
+  )
+  data = ARGV[0] || "message payload"
+  attributes = { publisher: "publisher-example" }
+  publisher.publish(data, attributes)
+end
+
+main

data/examples/subscriber-example/README.md

@@ -0,0 +1,11 @@
+## subscriber example
+
+An example code of `Gcpc::Subscriber`.
+
+If you want to try `Gcpc`, please execute commands below in the root of this repository.
+
+```
+$ gcloud beta emulators pubsub start  # Please install Cloud Pub/Sub emulator from https://cloud.google.com/pubsub/docs/emulator for executing this.
+$ bundle exec ruby examples/subscriber-example/subscriber-example.rb
+$ bundle exec ruby examples/publisher-example/publisher-example.rb
+```

data/examples/subscriber-example/subscriber-example.rb

@@ -0,0 +1,73 @@
+require "gcpc"
+
+# Please execute commands below.
+#
+# ```
+# $ gcloud beta emulators pubsub start
+# $ bundle exec ruby examples/subscriber-example/subscriber-example.rb
+# $ bundle exec ruby examples/publisher-example/publisher-example.rb
+# ```
+
+PROJECT_ID = "project-example-1"
+TOPIC_NAME = "topic-example-1"
+SUBSCRIPTION_NAME = "subscription-example-1"
+
+MyLogger = Logger.new(STDOUT)
+
+class LogInterceptor < Gcpc::Subscriber::BaseInterceptor
+  def handle(data, attributes, message)
+    MyLogger.info "[Interceptor Log] #{message.inspect}"
+    MyLogger.info "[Interceptor Log] data: #{data}"
+    MyLogger.info "[Interceptor Log] attributes: #{attributes}"
+    yield data, attributes, message
+  end
+end
+
+class LogHandler < Gcpc::Subscriber::BaseHandler
+  def handle(data, attributes, message)
+    MyLogger.info "[Handler Log] #{message.inspect}"
+    MyLogger.info "[Handler Log] data: #{data}"
+    MyLogger.info "[Handler Log] attributes: #{attributes}"
+  end
+end
+
+# We create topic and subscription only for demonstration.
+def with_setup_subscription(&block)
+  project = Google::Cloud::Pubsub.new(
+    project_id:    PROJECT_ID,
+    emulator_host: "localhost:8085",
+  )
+  if (topic = project.topic(TOPIC_NAME)).nil?
+    # Create a topic if necessary
+    topic = project.create_topic(TOPIC_NAME)
+  end
+  if (subscription = topic.subscription(SUBSCRIPTION_NAME)).nil?
+    # Create a subscription if necessary
+    subscription = topic.create_subscription(SUBSCRIPTION_NAME)
+  end
+
+  yield
+
+ensure
+  topic.delete
+  subscription.delete
+end
+
+def run
+  subscriber = Gcpc::Subscriber.new(
+    project_id:    PROJECT_ID,
+    subscription:  SUBSCRIPTION_NAME,
+    interceptors:  [LogInterceptor],
+    emulator_host: "localhost:8085",
+  )
+  subscriber.handle(LogHandler)
+  subscriber.run
+end
+
+def main
+  with_setup_subscription do
+    run
+  end
+end
+
+main

data/gcpc.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "gcpc/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gcpc"
+  spec.version       = Gcpc::VERSION
+  spec.authors       = ["Nao Minami"]
+  spec.email         = ["south37777@gmail.com"]
+
+  spec.summary       = %q{Google Cloud Pub/Sub Client}
+  spec.description   = %q{Google Cloud Pub/Sub Client}
+  spec.homepage      = "https://github.com/south37/gcpc"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "pry"
+  spec.add_runtime_dependency "google-cloud-pubsub"
+end

data/lib/gcpc.rb

@@ -0,0 +1,6 @@
+require "gcpc/version"
+require "gcpc/publisher"
+require "gcpc/subscriber"
+
+module Gcpc
+end

data/lib/gcpc/publisher.rb

@@ -0,0 +1,42 @@
+require "gcpc/publisher/base_interceptor"
+require "gcpc/publisher/engine"
+require "gcpc/publisher/topic_client"
+
+module Gcpc
+  class Publisher
+    # @param [String] project_id
+    # @param [String] topic
+    # @param [String, Google::Cloud::Pubsub::Credentials, nil] credentials Path
+    #     of keyfile or Google::Cloud::Pubsub::Credentials or nil.
+    # @param [String, nil] emulator_host Emulator's host or nil.
+    # @param [<#publish>] interceptors
+    def initialize(
+      project_id:,
+      topic:,
+      credentials:   nil,
+      emulator_host: nil,
+      interceptors:  []
+    )
+      topic_client = TopicClient.new(
+        project_id:    project_id,
+        topic_name:    topic,
+        credentials:   credentials,
+        emulator_host: emulator_host,
+      )
+
+      t = topic_client.get
+      if t.nil?
+        raise "Getting topic \"#{topic}\" from project \"#{project_id}\" failed! The topic \"#{topic}\" does not exist!"
+      end
+
+      @engine = Engine.new(
+        topic:        t,
+        interceptors: interceptors,
+      )
+    end
+
+    extend Forwardable
+
+    def_delegators :@engine, :publish
+  end
+end

data/lib/gcpc/publisher/base_interceptor.rb

@@ -0,0 +1,14 @@
+# Interceptor must implement #publish. Gcpc::Publisher::BaseHandler is a base
+# class to implement such a class. You don't have to inherit this, this is only
+# for indicating interface.
+module Gcpc
+  class Publisher
+    class BaseInterceptor
+      # @param [String] data
+      # @param [Hash] attributes
+      def publish(data, attributes, &block)
+        yield data, attributes
+      end
+    end
+  end
+end

data/lib/gcpc/publisher/engine.rb

@@ -0,0 +1,48 @@
+module Gcpc
+  class Publisher
+    class Engine
+      # @param [Google::Cloud::Pubsub::Topic] topic
+      # @param [<#publish>] interceptors
+      def initialize(topic:, interceptors:)
+        @topic        = topic
+        @interceptors = interceptors.map { |i| (i.class == Class) ? i.new : i }
+      end
+
+      # @param [String] data
+      # @param [Hash] attributes
+      def publish(data, attributes = {})
+        d = data.dup
+        a = attributes.dup
+
+        intercept!(@interceptors, d, a) do |dd, aa|
+          publish_message(dd, aa)
+        end
+      end
+
+    private
+
+      # @param [<#publish>] interceptors
+      # @param [String] data
+      # @param [Hash] attributes
+      # @param [Proc] block
+      def intercept!(interceptors, data, attributes, &block)
+        if interceptors.size == 0
+          return yield(data, attributes)
+        end
+
+        i    = interceptors.first
+        rest = interceptors[1..-1]
+
+        i.publish(data, attributes) do |d, a|
+          intercept!(rest, d, a, &block)
+        end
+      end
+
+      # @param [String] data
+      # @param [Hash] attributes
+      def publish_message(data, attributes)
+        @topic.publish(data, attributes)
+      end
+    end
+  end
+end

data/lib/gcpc/publisher/topic_client.rb

@@ -0,0 +1,33 @@
+module Gcpc
+  class Publisher
+    class TopicClient
+      DEFAULT_CONNECT_TIMEOUT = 5
+
+      # @param [String] project_id
+      # @param [String] topic_name
+      # @param [Google::Cloud::Pubsub::Credentials, String, nil]
+      # @param [String, nil] emulator_host
+      def initialize(project_id:, topic_name:, credentials:, emulator_host:, connect_timeout: DEFAULT_CONNECT_TIMEOUT)
+        project = Google::Cloud::Pubsub.new(
+          project_id:    project_id,
+          credentials:   credentials,
+          emulator_host: emulator_host,
+        )
+        @project         = project
+        @topic_name      = topic_name
+        @connect_timeout = connect_timeout
+      end
+
+      # @return [Google::Cloud::Pubsub::Topic]
+      def get
+        t = nil
+        Timeout.timeout(@connect_timeout) do
+          t = @project.topic(@topic_name)
+        end
+        t
+      rescue Timeout::Error => e
+        raise "Getting topic \"#{@topic_name}\" from project \"#{@project.project_id}\" timed out!"
+      end
+    end
+  end
+end

data/lib/gcpc/subscriber.rb

@@ -0,0 +1,50 @@
+require "gcpc/subscriber/base_handler"
+require "gcpc/subscriber/base_interceptor"
+require "gcpc/subscriber/default_logger"
+require "gcpc/subscriber/engine"
+require "gcpc/subscriber/subscription_client"
+
+module Gcpc
+  class Subscriber
+    # @param [String] project_id
+    # @param [String] subscription
+    # @param [String, Google::Cloud::Pubsub::Credentials, nil] credentials Path
+    #     of keyfile or Google::Cloud::Pubsub::Credentials or nil.
+    # @param [String, nil] emulator_host Emulator's host or nil.
+    # @param [<#handle, #on_error>] interceptors
+    # @param [bool] ack_immediately
+    # @param [Logger] logger
+    def initialize(
+      project_id:,
+      subscription:,
+      credentials:     nil,
+      emulator_host:   nil,
+      interceptors:    [],
+      ack_immediately: false,
+      logger:          DefaultLogger
+    )
+      subscription_client = SubscriptionClient.new(
+        project_id:        project_id,
+        subscription_name: subscription,
+        credentials:       credentials,
+        emulator_host:     emulator_host,
+      )
+
+      s = subscription_client.get
+      if s.nil?
+        raise "Getting subscription \"#{subscription}\" from project \"#{project_id}\" failed! The subscription \"#{subscription}\" does not exist!"
+      end
+
+      @engine = Engine.new(
+        subscription:    s,
+        interceptors:    interceptors,
+        ack_immediately: ack_immediately,
+        logger:          logger,
+      )
+    end
+
+    extend Forwardable
+
+    def_delegators :@engine, :handle, :run, :stop
+  end
+end

data/lib/gcpc/subscriber/base_handler.rb

@@ -0,0 +1,21 @@
+# Handler must implement #handle and can implement #on_error.
+# Gcpc::Subscriber::BaseHandler is a base class to implement such a class.
+# You don't have to inherit this, this is only for indicating interface.
+module Gcpc
+  class Subscriber
+    class BaseHandler
+      # @param [String] data
+      # @param [Hash] attributes
+      # @param [Google::Cloud::Pubsub::ReceivedMessage] message
+      def handle(data, attributes, message)
+        raise NotImplementedError.new("You must implement #{self.class}##{__method__}")
+      end
+
+      # You don't need to implement #on_error if it is not necessary.
+      # @param [Exception] error
+      # def on_error(error)
+      #   raise NotImplementedError.new("You must implement #{self.class}##{__method__}")
+      # end
+    end
+  end
+end

data/lib/gcpc/subscriber/base_interceptor.rb

@@ -0,0 +1,23 @@
+# Interceptor must implement #handle and can implement #on_error.
+# Gcpc::Subscriber::BaseHandler is a base class to implement such a class.
+# You don't have to inherit this, this is only for indicating interface.
+module Gcpc
+  class Subscriber
+    class BaseInterceptor
+      # @param [String] data
+      # @param [Hash] attributes
+      # @param [Google::Cloud::Pubsub::ReceivedMessage] message
+      # @param [Proc] block
+      def handle(data, attributes, message, &block)
+        yield data, attributes, message
+      end
+
+      # You don't need to implement #on_error is it is not necessary.
+      # @param [Exception] error
+      # @param [Plock] block
+      # def on_error(error, &block)
+      #   yield error
+      # end
+    end
+  end
+end

data/lib/gcpc/subscriber/default_logger.rb

@@ -0,0 +1,7 @@
+require 'logger'
+
+module Gcpc
+  class Subscriber
+    DefaultLogger = Logger.new(STDOUT)
+  end
+end

data/lib/gcpc/subscriber/engine.rb

@@ -0,0 +1,144 @@
+require "gcpc/subscriber/handle_engine"
+
+module Gcpc
+  class Subscriber
+    class Engine
+      WAIT_INTERVAL = 1
+
+      # @param [Google::Cloud::Pubsub::Subscription] subscription
+      # @param [<#handle, #on_error>] interceptors
+      # @param [bool] ack_immediately
+      # @param [Logger] logger
+      def initialize(
+        subscription:,
+        interceptors:    [],
+        ack_immediately: false,
+        logger:          DefaultLogger
+      )
+
+        @subscription    = subscription
+        @interceptors    = interceptors
+        @ack_immediately = ack_immediately
+        @logger          = logger
+
+        @subscriber      = nil  # @subscriber is created by calling `#run`
+        @handler         = nil  # @handler must be registered by `#handle`
+
+        @stopped_mutex = Mutex.new
+        @stopped       = false
+      end
+
+      # @param [<String>] signals Signals which are used to shutdown subscriber
+      #     gracefully.
+      def run(signals = ['SIGTERM', 'SIGINT'])
+        if @handler.nil?
+          raise "You must register handler by #handle before calling #run"
+        end
+
+        @logger.info("Starting to subscribe a subscription \"#{@subscription.name}\", will wait for background threads to start...")
+
+        @subscriber = @subscription.listen do |message|
+          handle_message(message)
+        end
+        @subscriber.on_error do |err|
+          handle_error(err)
+        end
+        @subscriber.start
+
+        @logger.info("Started")
+
+        loop_until_receiving_signals(signals)
+      end
+
+      def stop
+        if @subscriber.nil?
+          raise "You must call #run before stopping"
+        end
+
+        @stopped_mutex.synchronize do
+          # `#stop` may be called multiple times. Only first call can proceed.
+          return if @stopped
+          @stopped = true
+        end
+
+        @logger.info('Stopping, will wait for background threads to exit')
+
+        @subscriber.stop
+        @subscriber.wait!
+
+        @logger.info('Stopped, background threads are shutdown')
+      end
+
+      # We support registrion of only one handler
+      # @param [#handle, #on_error, Class] handler
+      def handle(handler)
+        @handler = HandleEngine.new(
+          handler:      handler,
+          interceptors: @interceptors,
+        )
+      end
+
+    private
+
+      def loop_until_receiving_signals(signals)
+        signal_received = false
+        signals.each do |signal|
+          Signal.trap(signal) { signal_received = true }
+        end
+        while !(signal_received || stopped?)
+          sleep WAIT_INTERVAL
+        end
+
+        stop unless stopped?
+      end
+
+      # @param [Google::Cloud::Pubsub::ReceivedMessage] message
+      def handle_message(message)
+        ack(message) if @ack_immediately
+
+        begin
+          worker_info("Started hanlding message")
+          @handler.handle(message)
+          worker_info("Finished hanlding message successfully")
+        rescue => e
+          nack(message) if !@ack_immediately
+          raise e  # exception is handled in `#handle_error`
+        end
+
+        ack(message) if !@ack_immediately
+      end
+
+      def ack(message)
+        message.ack!
+        worker_info("Acked message")
+      end
+
+      def nack(message)
+        message.nack!
+        worker_info("Nacked message")
+      end
+
+      # @param [Exception] error
+      def handle_error(error)
+        worker_error(error)
+        @handler.on_error(error)
+      end
+
+      # @param [String] message
+      def worker_info(message)
+        @logger.info("[Worker #{Thread.current.object_id}] #{message}")
+      end
+
+      # @param [Exception] error
+      def worker_error(error)
+        e_str = "#{error.message}"
+        e_str += "\n#{error.backtrace.join("\n")}" if error.backtrace
+        @logger.error("[Worker #{Thread.current.object_id}] #{e_str}")
+      end
+
+      def stopped?
+        @stopped_mutex.synchronize { @stopped }
+      end
+    end
+  end
+end

data/lib/gcpc/subscriber/handle_engine.rb

@@ -0,0 +1,83 @@
+module Gcpc
+  class Subscriber
+    # HandleEngine handle messages and exceptions with interceptors.
+    class HandleEngine
+      # @param [#handle, #on_error, Class] handler
+      # @param [<#handle, #on_error, Class>] interceptors
+      def initialize(handler:, interceptors:)
+        @handler      = (handler.class == Class) ? handler.new : handler
+        @interceptors = interceptors.map { |i| (i.class == Class) ? i.new : i }
+      end
+
+      # @param [Google::Cloud::Pubsub::ReceivedMessage] message
+      def handle(message)
+        d = message.data.dup
+        a = message.attributes.dup
+
+        intercept_message!(@interceptors, d, a, message) do |dd, aa, m|
+          handle_message(dd, aa, m)
+        end
+      end
+
+      # @param [Exception] error
+      def on_error(error)
+        intercept_error!(@interceptors, error) do |e|
+          handle_on_error(e)
+        end
+      end
+
+    private
+
+      # @param [<#handle>] interceptors
+      # @param [String] data
+      # @param [Hash] attributes
+      # @param [Google::Cloud::Pubsub::ReceivedMessage] message
+      # @param [Proc] block
+      def intercept_message!(interceptors, data, attributes, message, &block)
+        if interceptors.size == 0
+          return yield(data, attributes, message)
+        end
+
+        i    = interceptors.first
+        rest = interceptors[1..-1]
+
+        i.handle(data, attributes, message) do |d, a, m|
+          intercept_message!(rest, d, a, m, &block)
+        end
+      end
+
+      # @param [<#on_error>] interceptors
+      # @param [Exception] error
+      # @param [Proc] block
+      def intercept_error!(interceptors, error, &block)
+        return yield(error) if interceptors.size == 0
+
+        i    = interceptors.first
+        rest = interceptors[1..-1]
+
+        if !i.respond_to?(:on_error)
+          # If #on_error is not implemented in the interceptor, it is simply
+          # skipped.
+          return intercept_error!(rest, error, &block)
+        end
+
+        i.on_error(error) do |e|
+          intercept_error!(rest, e, &block)
+        end
+      end
+
+      # @param [String] data
+      # @param [Hash] attributes
+      # @param [Google::Cloud::Pubsub::ReceivedMessage] message
+      def handle_message(data, attributes, message)
+        @handler.handle(data, attributes, message)
+      end
+
+      # @param [Exception] error
+      def handle_on_error(error)
+        return if !@handler.respond_to?(:on_error)
+        @handler.on_error(error)
+      end
+    end
+  end
+end

data/lib/gcpc/subscriber/subscription_client.rb

@@ -0,0 +1,35 @@
+require "google/cloud/pubsub"
+
+module Gcpc
+  class Subscriber
+    class SubscriptionClient
+      DEFAULT_CONNECT_TIMEOUT = 5
+
+      # @param [String] project_id
+      # @param [String] subscription_name
+      # @param [Google::Cloud::Pubsub::Credentials, String, nil]
+      # @param [String, nil] emulator_host
+      def initialize(project_id:, subscription_name:, credentials:, emulator_host:, connect_timeout: DEFAULT_CONNECT_TIMEOUT)
+        project = Google::Cloud::Pubsub.new(
+          project_id:    project_id,
+          credentials:   credentials,
+          emulator_host: emulator_host,
+        )
+        @project           = project
+        @subscription_name = subscription_name
+        @connect_timeout   = connect_timeout
+      end
+
+      # @return [Google::Cloud::Pubsub::Subscription]
+      def get
+        t = nil
+        Timeout.timeout(@connect_timeout) do
+          t = @project.subscription(@subscription_name)
+        end
+        t
+      rescue Timeout::Error => e
+        raise "Getting subscription \"#{@subscription_name}\" from project \"#{@project.project_id}\" timed out!"
+      end
+    end
+  end
+end

data/lib/gcpc/version.rb

@@ -0,0 +1,3 @@
+module Gcpc
+  VERSION = "0.0.4"
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: gcpc
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Nao Minami
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: google-cloud-pubsub
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Google Cloud Pub/Sub Client
+email:
+- south37777@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/publisher-example/README.md
+- examples/publisher-example/publisher-example.rb
+- examples/subscriber-example/README.md
+- examples/subscriber-example/subscriber-example.rb
+- gcpc.gemspec
+- lib/gcpc.rb
+- lib/gcpc/publisher.rb
+- lib/gcpc/publisher/base_interceptor.rb
+- lib/gcpc/publisher/engine.rb
+- lib/gcpc/publisher/topic_client.rb
+- lib/gcpc/subscriber.rb
+- lib/gcpc/subscriber/base_handler.rb
+- lib/gcpc/subscriber/base_interceptor.rb
+- lib/gcpc/subscriber/default_logger.rb
+- lib/gcpc/subscriber/engine.rb
+- lib/gcpc/subscriber/handle_engine.rb
+- lib/gcpc/subscriber/subscription_client.rb
+- lib/gcpc/version.rb
+homepage: https://github.com/south37/gcpc
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Google Cloud Pub/Sub Client
+test_files: []