karafka-avro 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ba576321bfb1956e8bce5828444014e8c01c9906d77a28a86d68bce6133ee01b
+  data.tar.gz: 104572fc3df381456342d8710e0692b123223771b0ceb0bc18ca4fb5ba06ff3d
+SHA512:
+  metadata.gz: a515d76a256189f8645abf52a110791fc6e7648c3af880a50924f7b7177a346882b31d76a6ab8ab81405e14cd8829ed11dde31b6abac86e5d7e245e2dde79a2a
+  data.tar.gz: f622c3bcf2b35c2f13da30efb539dc44a9d6ffab1aeb34b8911b48d53a98fd6bf8c6239b01e34ae42ff87c8756f44545d60b49c4cb4857d873697ee3d4c6fd16

data/.coditsu/ci.yml

@@ -0,0 +1,3 @@
+repository_id: 'de4631da-634e-4f79-a220-a0731a9a324e'
+api_key: <%= ENV['CODITSU_API_KEY'] %>
+api_secret: <%= ENV['CODITSU_API_SECRET'] %>

data/.diffend.yml

@@ -0,0 +1,3 @@
+project_id: '686c6c83-5d8e-4cfd-a0ee-913877fd6ab3'
+shareable_id: 'a7604420-758e-400b-b3ff-133005e61291'
+shareable_key: 'ee858629-1dfb-44dd-8bd6-26b1c4f45b3a'

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+open_collective: karafka

data/.github/workflows/ci.yml

@@ -0,0 +1,71 @@
+name: ci
+
+on:
+  pull_request:
+  push:
+  schedule:
+    - cron:  '0 1 * * *'
+
+jobs:
+  specs:
+    runs-on: ubuntu-latest
+    needs: diffend
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '3.0'
+          - '2.7'
+          - '2.6'
+          - '2.5'
+        include:
+          - ruby: '3.0'
+            coverage: 'true'
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install package dependencies
+        run: "[ -e $APT_DEPS ] || sudo apt-get install -y --no-install-recommends $APT_DEPS"
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{matrix.ruby}}
+      - name: Install latest bundler
+        run: |
+          gem install bundler --no-document
+      - name: Bundle install
+        run: |
+          bundle install --jobs 4 --retry 3
+      - name: Run all tests
+        env:
+          GITHUB_COVERAGE: ${{matrix.coverage}}
+        run: bundle exec rspec
+
+  diffend:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+      - name: Install latest bundler
+        run: gem install bundler --no-document
+      - name: Install Diffend plugin
+        run: bundle plugin install diffend
+      - name: Bundle Secure
+        run: bundle secure
+
+  coditsu:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Run Coditsu
+        run: \curl -sSL https://api.coditsu.io/run/ci | bash

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/vendor/
+/spec/reports/
+/tmp/
+.idea/
+
+# rspec failure tracking
+.rspec_status
+
+*.gem
+.coditsu/local.yml

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+3.0.1

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Karafka Avro Parser changelog
+
+## master
+- [#9](https://github.com/karafka/avro/pull/9) drop support for ruby 2.3
+- [#2](https://github.com/karafka/avro/pull/2) only support ruby 2.6, 2.5, 2.4
+
+## 0.2
+- [#1](https://github.com/karafka/avro/pull/1) allow schema name to be optional when using a registry
+
+## 0.1
+- initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+plugin 'diffend'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in karafka-avro-parser.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    karafka-avro-parser (0.2.0)
+      avro_turf (~> 0.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    avro (1.9.2)
+      multi_json
+    avro_turf (0.11.0)
+      avro (>= 1.7.7, < 1.10)
+      excon (~> 0.45)
+    diff-lcs (1.4.4)
+    excon (0.80.1)
+    multi_json (1.15.0)
+    rake (13.0.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  x86_64-darwin
+  x86_64-darwin-19
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (~> 2)
+  karafka-avro-parser!
+  rake
+  rspec
+
+BUNDLED WITH
+   2.2.16

data/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,78 @@
+# Karafka::Avro::Parser
+
+Karafka Parser for [Apache Avro](http://avro.apache.org/). It uses the great [AvroTurf](https://github.com/dasch/avro_turf) gem by under the hood.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'karafka-avro-parser'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Thanks to Karafka's modular design, you only have to define a `parser` the moment you draw your consumer groups.
+
+### Example with Schema Folder
+
+```ruby
+Karafka::Parsers::Avro.schemas_path = 'app/schemas'
+
+App.consumer_groups.draw do
+  consumer_group :my_consumer_group do
+    topic :my_topic do
+      consumer AvroConsumer
+      parser Karafka::Parsers::Avro.from_path('schema_name')
+    end
+  end
+end
+```
+
+### Example with a Codec
+
+```ruby
+Karafka::Parsers::Avro.schemas_path = 'app/schemas'
+
+App.consumer_groups.draw do
+  consumer_group :my_consumer_group do
+    topic :my_topic do
+      consumer AvroConsumer
+      parser Karafka::Parsers::Avro.from_path('schema_name', codec: 'deflate')
+    end
+  end
+end
+```
+
+### Example with Schema Registry
+
+```ruby
+Karafka::Parsers::Avro.registry_url = 'http://my-registry:8081/'
+
+App.consumer_groups.draw do
+  consumer_group :my_consumer_group do
+    topic :my_topic do
+      consumer AvroConsumer
+      parser Karafka::Parsers::Avro.from_registry('schema_name')
+    end
+  end
+end
+```
+
+*Note: `schema_name` is not specifically required when using a schema registry, as the schema id is contained within the message, it can be passed in optionally if you are using one schema per topic*
+
+## Note on contributions
+
+First, thank you for considering contributing to Karafka! It's people like you that make the open source community such a great community!
+
+Each pull request must pass all the RSpec specs and meet our quality requirements.
+
+To check if everything is as it should be, we use [Coditsu](https://coditsu.io) that combines multiple linters and code analyzers for both code and documentation. Once you're done with your changes, submit a pull request.
+
+Coditsu will automatically check your work against our quality standards. You can find your commit check results on the [builds page](https://app.coditsu.io/karafka/commit_builds) of Karafka organization.
+
+[![coditsu](https://coditsu.io/assets/quality_bar.svg)](https://app.coditsu.io/karafka-avro/commit_builds)

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+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 "karafka/avro/parser"
+
+# 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(__FILE__)

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/karafka-avro-parser.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'karafka/parsers/avro/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'karafka-avro-parser'
+  spec.version       = Karafka::Parsers::Avro::VERSION
+  spec.authors       = ['Kacper Madej']
+  spec.email         = %w[kacperoza@gmail.com]
+  spec.homepage      = 'https://github.com/karafka/avro'
+  spec.summary       = 'Apache Avro support for Karafka'
+  spec.description   = ''
+  spec.license       = 'LGPL-3.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = %w[lib]
+
+  spec.required_ruby_version = '>= 2.5.0'
+
+  spec.add_dependency 'avro_turf', '~> 0.8'
+
+  spec.add_development_dependency 'bundler', '~> 2'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/karafka-avro-parser.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'karafka/parsers/avro'

data/lib/karafka/parsers/avro.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'avro_turf'
+require 'avro_turf/messaging'
+
+require_relative 'avro/parser'
+require_relative 'avro/version'
+
+module Karafka
+  module Parsers
+    module Avro
+      def self.registry_url=(registry_url)
+        @registry_url = registry_url
+      end
+
+      def self.schemas_path=(schemas_path)
+        @schemas_path = schemas_path
+      end
+
+      def self.from_registry(schema_name = nil)
+        raise ArgumentError, 'You have to specify registry_path first' if @registry_url.nil?
+
+        Parser.new(AvroTurf::Messaging.new(registry_url: @registry_url), schema_name)
+      end
+
+      def self.from_path(schema_name, codec: nil)
+        raise ArgumentError, 'You have to specify schemas_path first' if @schemas_path.nil?
+
+        Parser.new(AvroTurf.new(schemas_path: @schemas_path, codec: codec), schema_name)
+      end
+    end
+  end
+end

data/lib/karafka/parsers/avro/parser.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'avro_turf'
+require 'avro_turf/messaging'
+
+module Karafka
+  module Parsers
+    module Avro
+      class Parser
+        attr_reader :avro, :schema_name
+
+        def initialize(avro, schema_name)
+          @avro = avro
+          @schema_name = schema_name
+        end
+
+        def parse(content)
+          avro.decode(content, schema_name: schema_name)
+        end
+
+        def generate(content)
+          avro.encode(content, schema_name: schema_name)
+        end
+      end
+    end
+  end
+end

data/lib/karafka/parsers/avro/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Parsers
+    module Avro
+      VERSION = '0.2.0'
+    end
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: karafka-avro
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Kacper Madej
+- Tomasz Pajor
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: avro_turf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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'
+description: ''
+email:
+- kacperoza@gmail.com
+- tomek@polishgeeks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coditsu/ci.yml"
+- ".diffend.yml"
+- ".github/FUNDING.yml"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- karafka-avro-parser.gemspec
+- lib/karafka-avro-parser.rb
+- lib/karafka/parsers/avro.rb
+- lib/karafka/parsers/avro/parser.rb
+- lib/karafka/parsers/avro/version.rb
+homepage: https://github.com/karafka/avro
+licenses:
+- LGPL-3.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Apache Avro support for Karafka
+test_files: []