zoo_stream 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5d5084bcfadb74a25b5785fc889a3605b7d0a4e3
-  data.tar.gz: 2587fbe749549481ce91f58c15c83b6a68eca3ad
+SHA256:
+  metadata.gz: 840b8164e0225138893da451f94169ce96e3ecf3e8642b078a3206385842fd1b
+  data.tar.gz: b5d03163fcde4ff05db0f8e6d0fa42261f98f35252a7bc7da1e1dd7968be9711
 SHA512:
-  metadata.gz: d3307473a4cb936f74a8197a2756c1dd13621617129124c4aa832ec70636b4f4285cfe523ec3cfb2d70db8d7205d65457d49a7b7eeeb00f0ee8d81e70494996a
-  data.tar.gz: 3419bd72756056f44ff6fe96b50814f415d16495634ab059e01f21a4002558dc01fbf1a9def7ec4b9de298e81a54ed6643a79dbc57c5079a80c38e8756517b4e
+  metadata.gz: 8ba86397902d56d2ec3bde85c86acbb98fd4a555e2179850a189e17170483bbedec6df97d580f61b0a9f8bfaff1ba8fc400366beefd7bd2fb673c162dca6c5c7
+  data.tar.gz: 454f9406e4e1c264f63213bbd6659dc5c3d25c6be44f887b4e0096649f8f3a938a7968f3d6bc80b5313c43c6ff9566920c1cb6de083c76568243c25faad4f62e

data/.github/workflows/run_tests_CI.yml

@@ -0,0 +1,17 @@
+name: Zooni CI
+on:
+  pull_request:
+  push: { branches: master }
+jobs:
+  test:
+    name: Run Tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.1
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rspec

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# 1.1.0
+
+* Ruby 3 compatibility
+    - Update aws-sdk to v3 and only install service specific aws-sdk-kinesis
+
+# 1.0.1
+
+* Made compatible down to Ruby 2.0.0
+
+# 1.0.0
+
+* Initial release

data/Dockerfile

@@ -0,0 +1,19 @@
+FROM ruby:3.1-slim
+
+WORKDIR /app
+
+RUN apt-get update && apt-get -y upgrade && \
+    apt-get install --no-install-recommends -y \
+      # git is required for installing gems
+      git && \
+      apt-get clean && rm -rf /var/lib/apt/lists/*
+
+# ensure we use a newer version of rubygems / bundler
+RUN gem update --system
+
+ADD ./Gemfile /app/
+ADD ./zoo_stream.gemspec /app/
+ADD ./ /app
+
+RUN bundle config --global jobs `cat /proc/cpuinfo | grep processor | wc -l | xargs -I % expr % - 1`
+RUN bundle install

data/README.md

@@ -28,7 +28,7 @@ You can either configure this gem using environment variables:
 Or programmatically (not recommended):
 
 ```ruby
-ZooStream.publisher = ZooStream::KinesisPublisher.new("zooniverse-production")
+ZooStream.publisher = ZooStream::KinesisPublisher.new(stream_name: "zooniverse-production")
 ZooStream.source = "my-application"
 ```
 
@@ -51,10 +51,22 @@ If you don't set a stream name, **this gem will silently ignore all `#publish` m
 
 ## 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.
+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).
 
+Use docker & compose to setup the dev env
+
+```shell
+docker-compose build
+```
+
+Run a bash shell inside the new container
+
+```shell
+docker-compose run --service-ports --rm zoo_stream bash
+```
+
 ## 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.

data/docker-compose.yml

@@ -0,0 +1,11 @@
+version: '3'
+services:
+  zoo_stream:
+    build:
+      context: .
+    volumes:
+      - ./:/app
+      - gem_cache:/usr/local/bundle
+
+volumes:
+  gem_cache:

data/lib/zoo_stream/kinesis_publisher.rb

@@ -1,4 +1,4 @@
-require 'aws-sdk'
+require 'aws-sdk-kinesis'
 
 module ZooStream
   class KinesisPublisher
@@ -9,7 +9,9 @@ module ZooStream
       @client = client
     end
 
-    def publish(event, shard_by:)
+    def publish(event, shard_by: nil)
+      raise ArgumentError, "Must specify shard_by" unless shard_by
+
       client.put_record(
         stream_name: stream_name,
         partition_key: shard_by,

data/lib/zoo_stream/version.rb

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

data/lib/zoo_stream.rb

@@ -9,7 +9,10 @@ module ZooStream
   # @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)
+  def self.publish(event: nil, data: nil, linked: {}, shard_by: nil)
+    raise ArgumentError, "Must specify event" unless event
+    raise ArgumentError, "Must specify data" unless data
+
     return unless publisher
     event = Event.new(source, event, data, linked)
     publisher.publish(event, shard_by: (shard_by || event.type).to_s)

data/zoo_stream.gemspec

@@ -19,9 +19,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'aws-sdk'
+  spec.add_dependency 'aws-sdk-kinesis', '~> 1'
 
-  spec.add_development_dependency "bundler", "~> 1.11"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 2.2'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
 end

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: zoo_stream
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Marten Veldthuis
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-02-23 00:00:00.000000000 Z
+date: 2025-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: aws-sdk
+  name: aws-sdk-kinesis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 description: A wrapper around AWS Kinesis client to make sure all our applications
   publish messages with a consistent format.
 email:
@@ -74,16 +74,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/run_tests_CI.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- docker-compose.yml
 - lib/zoo_stream.rb
 - lib/zoo_stream/event.rb
 - lib/zoo_stream/kinesis_publisher.rb
@@ -93,7 +96,7 @@ homepage: https://github.com/zooniverse/zoo_stream
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -108,9 +111,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Simplified and customized Kinesis publisher
 test_files: []

data/.travis.yml

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