Google::Pubsub::Enhancer

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/google/pubsub/enhancer. To experiment with that code, run bin/console for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

Installation

Add this line to your application's Gemfile:

gem 'google-pubsub-enhancer'

And then execute:

$ bundle

Or install it yourself as:

$ gem install google-pubsub-enhancer

Usage

require 'google_pubsub_enhancer'

app = GooglePubsubEnhancer.new do

  # you can get your messages from env[:received_messages]
  # Be aware of the messages you got are pubsub objects. You van get your messages by calling map(&:data) on it.
  use YourMiddleware
  use GooglePubsubEnhancer::Publisher,
    short_topic_name: short_topic_name,
    messages: messages_key_you_declare
end

app.run(subscription_name)

ENV

To configure how much message should be pulled, use the GOOGLE_PUBSUB_ENHANCER_MAX_PULL_SIZE env variable with an integer value

Test

You can test your enhancer like:

require 'spec_helper'

describe YourApplication do

  #include the test framework for end to end testing
  include GooglePubsubEnhancer::Spec

  #set messages that come from a topic
  let(:messages) {[JSON.dump({foo:1}), JSON.dump({bar:2})]}

  it "should do the magic you write into" do

    app = GooglePubsubEnhancer.new do

      # in this case the test middleware creates messages from pubsub objects
      use YourMiddleware, -> env do
        env[:messages_key] = env[:received_messages].map do |msg|
          JSON.parse msg.data
        end
      end

      use GooglePubsubEnhancer::Middleware::Publisher,
        short_topic_name: 'short_topic_name',
        messages: :messages_key
    end

    # the only expectation you need
    expect_publish_called_with({"foo" => 1})
    expect_publish_called_with({"bar" => 2})

    app.run 'subscription_short_name'
  end
end

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/google-pubsub-enhancer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.