glass_octopus 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b1a88b4eb29013db080c1e6a08c9b6f5af6fb0b8e844805074e1101554bbe7a
-  data.tar.gz: 24d003c5d814ccec622277a87385830fbc1825d327063d2e9a5f7714a58b84a4
+  metadata.gz: 4fbc955a7cddf1c08e93db127bd2ccf5a3fb025a2a03e95bfc6ab7de54e50914
+  data.tar.gz: 85085902b9c8c4c38e2c8813f68934f9a54ccab436c21f7519de633eff4eeb83
 SHA512:
-  metadata.gz: d317a58e73e7a313ddc4cca6b2e998a1554e214c5616990f1e4e582318dfad461d102053ffce34a47cf2d90653e23de1b2c2cbdc382fff4835dfbc4078339a80
-  data.tar.gz: de289957eff59996e7055f789c34867146ecf07617dadc80b13b4dc25a7f7a4afaedd7e4bbfe84b4ef61728d4c668401a2c3d114cf3b92a0f0f6f1823a1ca949
+  metadata.gz: fe14d5ee99f0fb900b4d4b7e9454409d462c399086e30a61dfab61b7ee4a0d69ec4ef06a2d8c88d3c1d13f72e1ff65f17d1334bbe4cfb2e92448af0135b5dfc7
+  data.tar.gz: 1e7e850864f9455a64524c09d48fa9d552e9ab6a4ae91f6244ef343a6dda1d76d5a414b7daee68a0e127c0191391253b4000004f11235a653188a618a8cb032e

data/README.md

@@ -63,7 +63,27 @@ end
 
 Run it with `bundle exec ruby app.rb`
 
-For more examples look into the [examples](examples) directory.
+### Handling Avro messages with Schema Registry
+
+Glass Octopus can be used with Avro messages validated against a schema. For this, you need a running [Schema Registry](https://docs.confluent.io/current/schema-registry/docs/index.html) service.  
+You also need to have the `avro_turf` gem installed.
+
+```
+# in your Gemfile
+gem "avro_turf"
+```
+
+Add the `AvroParser` middleware with the Schema Registry URL to your app.
+
+```ruby
+# in app.rb
+app = GlassOctopus.build do
+  use GlassOctopus::Middleware::AvroParser, "http://schema_registry_url:8081"
+  ...
+end
+```
+
+For more examples look into the [example](example) directory.
 
 For the API documentation please see the [documentation site][rubydoc]
 

data/example/avro.rb

@@ -0,0 +1,26 @@
+require "bundler/setup"
+require "glass_octopus"
+
+app = GlassOctopus.build do
+  use GlassOctopus::Middleware::CommonLogger
+  use GlassOctopus::Middleware::AvroParser, "http://schema_registry_url:8081"
+
+  run Proc.new { |ctx|
+    puts "Got message: #{ctx.message.key} => #{ctx.message.value}"
+  }
+end
+
+def array_from_env(key, default:)
+  return default unless ENV.key?(key)
+  ENV.fetch(key).split(",").map(&:strip)
+end
+
+
+GlassOctopus.run(app) do |config|
+  config.adapter :ruby_kafka do |kafka|
+    kafka.broker_list = array_from_env("KAFKA_BROKER_LIST", default: %w[localhost:9092])
+    kafka.topic       = ENV.fetch("KAFKA_TOPIC", "mytopic")
+    kafka.group       = ENV.fetch("KAFKA_GROUP", "mygroup")
+    kafka.client      = { logger: config.logger }
+  end
+end

data/glass_octopus.gemspec

@@ -31,4 +31,8 @@ EOF
   spec.add_development_dependency "guard", "~> 2.14"
   spec.add_development_dependency "guard-minitest", "~> 2.4"
   spec.add_development_dependency "terminal-notifier-guard", "~> 1.7"
+  spec.add_development_dependency "ruby-kafka", "~> 0.5.2"
+  spec.add_development_dependency "avro_turf", "~> 0.8.0"
+  spec.add_development_dependency "sinatra", "~> 2.0.0"
+  spec.add_development_dependency "webmock", "~> 3.3.0"
 end

data/lib/glass_octopus/middleware/avro_parser.rb

@@ -0,0 +1,35 @@
+require "delegate"
+
+begin
+  require "avro_turf/messaging"
+rescue LoadError
+  raise "Can't find 'avro_turf' gem. Please add it to your Gemfile or install it."
+end
+
+module GlassOctopus
+  module Middleware
+    class AvroParser
+      def initialize(app, schema_registry_url, options={})
+        @app = app
+        @decoder = AvroTurf::Messaging.new(registry_url: schema_registry_url, logger: options[:logger])
+      end
+
+      def call(ctx)
+        message = @decoder.decode(ctx.message.value)
+        ctx = ContextWithAvroParsedMessage.new(ctx, message)
+        @app.call(ctx)
+      end
+
+      private
+
+      class ContextWithAvroParsedMessage < SimpleDelegator
+        attr_reader :params
+
+        def initialize(wrapped_ctx, params)
+          super(wrapped_ctx)
+          @params = params
+        end
+      end
+    end
+  end
+end

data/lib/glass_octopus/middleware.rb

@@ -3,6 +3,7 @@ module GlassOctopus
     autoload :ActiveRecord, "glass_octopus/middleware/active_record"
     autoload :CommonLogger, "glass_octopus/middleware/common_logger"
     autoload :JsonParser, "glass_octopus/middleware/json_parser"
+    autoload :AvroParser, "glass_octopus/middleware/avro_parser"
     autoload :Mongoid, "glass_octopus/middleware/mongoid"
     autoload :NewRelic, "glass_octopus/middleware/new_relic"
     autoload :Sentry, "glass_octopus/middleware/sentry"

data/lib/glass_octopus/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glass_octopus
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Tamás Michelberger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-13 00:00:00.000000000 Z
+date: 2018-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -114,6 +114,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: ruby-kafka
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+- !ruby/object:Gem::Dependency
+  name: avro_turf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
 description: |
   GlassOctopus provides a minimal, modular and adaptable interface for developing
   Kafka consumers in Ruby. In its philosophy it is very close to Rack.
@@ -135,6 +191,7 @@ files:
 - bin/rake
 - docker-compose.yml
 - example/advanced.rb
+- example/avro.rb
 - example/basic.rb
 - example/ruby_kafka.rb
 - glass_octopus.gemspec
@@ -152,6 +209,7 @@ files:
 - lib/glass_octopus/message.rb
 - lib/glass_octopus/middleware.rb
 - lib/glass_octopus/middleware/active_record.rb
+- lib/glass_octopus/middleware/avro_parser.rb
 - lib/glass_octopus/middleware/common_logger.rb
 - lib/glass_octopus/middleware/json_parser.rb
 - lib/glass_octopus/middleware/mongoid.rb
@@ -180,7 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.2
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: A Kafka consumer framework. Like Rack but for Kafka.