zoo_stream 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d5084bcfadb74a25b5785fc889a3605b7d0a4e3
+  data.tar.gz: 2587fbe749549481ce91f58c15c83b6a68eca3ad
+SHA512:
+  metadata.gz: d3307473a4cb936f74a8197a2756c1dd13621617129124c4aa832ec70636b4f4285cfe523ec3cfb2d70db8d7205d65457d49a7b7eeeb00f0ee8d81e70494996a
+  data.tar.gz: 3419bd72756056f44ff6fe96b50814f415d16495634ab059e01f21a4002558dc01fbf1a9def7ec4b9de298e81a54ed6643a79dbc57c5079a80c38e8756517b4e

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at marten@veldthuis.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zoo_stream.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Marten Veldthuis
+
+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,65 @@
+# ZooStream
+
+Within the Zooniverse backend infrastructure, we run a Kinesis stream so that internal agents can listen to
+what's happening inside our applications, calculate stuff on the fly and/or respond to events as they happen.
+For instance, [Nero](https://github.com/zooniverse/nero) reacts to classifications and decides when to retire
+subjects, while [ZooEventStats](https://github.com/zooniverse/zoo-event-stats) aggregates various statistics that
+get published on dashboards like [watch.zooniverse.org](http://watch.zooniverse.org).
+
+## Installation
+
+```ruby
+gem 'zoo_stream', '~> 1.0'
+```
+
+We follow SemVer.
+
+## Configuration
+
+To publish events on the stream, you'll need to set up AWS roles. In the AWS console, make sure the instance your service
+is running on is assigned an IAM role, and attach the "Kinesis-Stream-Writer" managed policy to that role. This will allow the AWS client gem to automatically get credentials with the correct access permissions.
+
+You can either configure this gem using environment variables:
+
+  * For production, set the environment variable `ZOO_STREAM_KINESIS_STREAM_NAME` to `zooniverse-production`
+  * For staging, set the environment variable `ZOO_STREAM_KINESIS_STREAM_NAME` to `zooniverse-staging`
+  * Set the environment variable `ZOO_STREAM_SOURCE` to the name of your service (keep it lowercased and whitespace-free).
+
+Or programmatically (not recommended):
+
+```ruby
+ZooStream.publisher = ZooStream::KinesisPublisher.new("zooniverse-production")
+ZooStream.source = "my-application"
+```
+
+## Usage
+
+To post an event to the Kinesis stream, call `#publish`. You need to specify the `event` type and the `data` of the event.
+Optionally, you can pass in records related to the main data under `linked`, and you can specify the `shard_by` if events
+don't need to be processed in globally consistent order, as long as they are ordered within the `shard_by`.
+
+```ruby
+ZooStream.publish(event: 'classification',
+                  data: {annotations: {}, links: {subject: 1}},
+                  linked: {subjects: [{id: 1, metadata: {}}]},
+                  shard_by: workflow.id)
+```
+
+If you don't set a stream name, **this gem will silently ignore all `#publish` messages**.
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/zooniverse/zoo_stream. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 "zoo_stream"
+
+# 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

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/lib/zoo_stream/event.rb

@@ -0,0 +1,24 @@
+module ZooStream
+  class Event
+    attr_reader :source, :type, :data, :linked, :timestamp
+
+    def initialize(source, type, data, linked, timestamp: Time.now)
+      @source, @type, @data, @linked, @timestamp = source, type, data, linked, timestamp
+    end
+
+    def to_h
+      {
+        source: source,
+        type: type,
+        version: '1.0.0',
+        timestamp: timestamp.utc.iso8601,
+        data: data,
+        linked: linked
+      }
+    end
+
+    def to_json
+      to_h.to_json
+    end
+  end
+end

data/lib/zoo_stream/kinesis_publisher.rb

@@ -0,0 +1,20 @@
+require 'aws-sdk'
+
+module ZooStream
+  class KinesisPublisher
+    attr_reader :stream_name, :client
+
+    def initialize(stream_name: ENV.fetch("ZOO_STREAM_KINESIS_STREAM_NAME"), client: Aws::Kinesis::Client.new)
+      @stream_name = stream_name
+      @client = client
+    end
+
+    def publish(event, shard_by:)
+      client.put_record(
+        stream_name: stream_name,
+        partition_key: shard_by,
+        data: event.to_json
+      )
+    end
+  end
+end

data/lib/zoo_stream/version.rb

@@ -0,0 +1,3 @@
+module ZooStream
+  VERSION = "1.0.0"
+end

data/lib/zoo_stream.rb

@@ -0,0 +1,39 @@
+require "zoo_stream/version"
+require 'zoo_stream/event'
+require "zoo_stream/kinesis_publisher"
+
+module ZooStream
+  # Publishes an event
+  #
+  # @param event [String] the event type
+  # @param data [Hash] the event data
+  # @param linked [Hash] related models to the data
+  # @param shard_by [String] if present, reader order will be guaranteed within this shard. If left blank, the entire stream will always be a single shard.
+  def self.publish(event:, data:, linked: {}, shard_by: nil)
+    return unless publisher
+    event = Event.new(source, event, data, linked)
+    publisher.publish(event, shard_by: (shard_by || event.type).to_s)
+  end
+
+  def self.publisher
+    @publisher || default_publisher
+  end
+
+  def self.publisher=(publisher)
+    @publisher = publisher
+  end
+
+  def self.source
+    @source || ENV.fetch("ZOO_STREAM_SOURCE")
+  end
+
+  def self.source=(source)
+    @source = source
+  end
+
+  def self.default_publisher
+    if ENV.key?("ZOO_STREAM_KINESIS_STREAM_NAME")
+      ZooStream::KinesisPublisher.new
+    end
+  end
+end

data/zoo_stream.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zoo_stream/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zoo_stream"
+  spec.version       = ZooStream::VERSION
+  spec.authors       = ["Marten Veldthuis"]
+  spec.email         = ["marten@zooniverse.org"]
+
+  spec.summary       = %q{Simplified and customized Kinesis publisher}
+  spec.description   = %q{A wrapper around AWS Kinesis client to make sure all our applications publish messages with a consistent format.}
+  spec.homepage      = "https://github.com/zooniverse/zoo_stream"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'aws-sdk'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: zoo_stream
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Marten Veldthuis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+description: A wrapper around AWS Kinesis client to make sure all our applications
+  publish messages with a consistent format.
+email:
+- marten@zooniverse.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/zoo_stream.rb
+- lib/zoo_stream/event.rb
+- lib/zoo_stream/kinesis_publisher.rb
+- lib/zoo_stream/version.rb
+- zoo_stream.gemspec
+homepage: https://github.com/zooniverse/zoo_stream
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Simplified and customized Kinesis publisher
+test_files: []