nats_streaming_listener 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2280bc9d4f28523cddab17e15c7493ccc7af43395bc7d27f1dedd05c5d3f3f24
+  data.tar.gz: 8de857acc15151932d822bbb0366dfefafb1e004a0a024f1d79846e518e0aeb3
+SHA512:
+  metadata.gz: fe95fa7eb8ebf7dae4c2d753bbb4251a3b057541256cba42a379c10d3d26c8e8ded4e7988aec03e6abd01ed4d4e405305bdf0c26f72fa9e562f3a3381b8512dd
+  data.tar.gz: d7ec78160017652d30d6a44822992ecd98679bc48fa521da07d60c63224fb26485ce27e1560786d8dd0608f810ec17171d60eb71898398b9a481f492d4eead31

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at gophan1992@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in nats_streaming_listener.gemspec
+gemspec
+gem 'nats_listener_core'

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    nats_streaming_listener (0.1.0)
+      google-protobuf (~> 3.6)
+      nats-streaming (~> 0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    google-protobuf (3.7.1)
+    nats-pure (0.5.0)
+    nats-streaming (0.2.2)
+      google-protobuf (~> 3)
+      nats-pure (~> 0)
+    nats_listener_core (0.1.1)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  nats_listener_core
+  nats_streaming_listener!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Igor Pavlov
+
+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,88 @@
+# NatsStreamingListener
+
+This gem implements functionality of nats-listener with nats streaming.
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nats_streaming_listener'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nats_streaming_listener
+
+## Usage
+
+### Creating client
+```ruby
+NatsStreamingListener::Client.current = NatsStreamingListener::Client.new(
+  logger: Ougai::Logger.new(STDOUT),
+  skip: false,
+  catch_errors: true,
+  catch_provider: Rollbar
+)
+```
+All arguments are optional.
+`logger` - logger that you can pass to application. It will be called to debug messages.
+`skip` - skip calls. Useful for tests
+`catch_errors` - catch errors, log them and pass to `catch_provider`
+`catch_provider` - provider that is called when error occurs, e.g. Rollbar.
+
+### Establishing connection
+```ruby
+NatsListener::Client.current.establish_connection(
+    service_name: [YOUR SERVICE NAME], 
+    nats: { servers: [NATS_SERVERS_URLS] }, # Options passed to nats connector
+    cluster_name: [YOUR_CLUSTER_NAME], # Cluster of nats-streaming that you're connecting to
+    client_id: [CLIENT_ID] # Id of a client(nats-streaming works with unique client_id)
+)
+```
+### Subscribers
+
+For using subscribers we offer one quite simple way:
+1. Create `subscribers` folder.
+2. Create your own subscriber derived from `NatsStreamingListener::Subscriber` 
+3. Load and subscribe all subscribers, e.g.
+```ruby
+path = Rails.root.join('app', 'subscribers', '*.rb')
+
+Dir.glob(path) do |entry|
+  entry.split('/').last.split('.').first.camelize.constantize.new.subscribe
+end
+```
+
+#### Protobuf strategy
+By default all nats-streaming messages are processed with protobuf. But if you want - you can use our own small wrapper that handles some info and pass it into nats-streaming.
+```ruby
+2.3.3 :006 > require 'nats_streaming_listener'
+=> true
+2.3.3 :006 > m = NatsStreaming::NatsMessage.new(sender_service_name: 'ololo', receiver_action_name: 'ololo1', receiver_action_parameters:[1,2,3].map(&:to_s), message_timestamp: Time.now.utc.to_i, transaction_id: 'unique')
+ => #<NatsListener::NatsMessage sender_service_name="ololo" receiver_action_name="ololo1" receiver_action_parameters=["1", "2", "3"] message_timestamp=1538902717 transaction_id="unique"> 
+2.3.3 :007 > m.serialize
+ => "\n\x05ololo\x12\x06ololo1\x1A\x011\x1A\x012\x1A\x013 \xBD\x95\xE7\xDD\x05*\x06unique" 
+```
+
+
+## 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](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/nats_streaming_listener. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the NatsStreamingListener project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/nats_streaming_listener/blob/master/CODE_OF_CONDUCT.md).

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 "nats_streaming_listener"
+
+# 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/definitions/nats_listener/nats_message.proto

@@ -0,0 +1,8 @@
+package NatsStreamingListener;
+message NatsMessage {
+  optional string sender_service_name = 1;
+  optional string receiver_action_name = 2;
+  repeated string receiver_action_parameters = 3;
+  optional int64 message_timestamp = 4;
+  optional string transaction_id = 5;
+}

data/lib/nats_streaming_listener/nats_message.pb.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message 'NatsStreamingListener.NatsMessage' do
+    optional :sender_service_name, :string, 1
+    optional :receiver_action_name, :string, 2
+    repeated :receiver_action_parameters, :string, 3
+    optional :message_timestamp, :int64, 4
+    optional :transaction_id, :string, 5
+  end
+end
+
+# Message class offered to be used with protobuf serialization
+module NatsStreamingListener
+  MESSAGE_CLASS = 'NatsStreamingListener.NatsMessage'
+  NatsMessage = Google::Protobuf::DescriptorPool.generated_pool
+                                                .lookup(MESSAGE_CLASS)
+                                                .msgclass
+end

data/lib/nats_streaming_listener/streaming_client.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'stan/client'
+require 'nats_listener_core'
+
+module NatsStreamingListener
+  # Implementation of Nats-streaming client
+  class StreamingClient <  NatsListenerCore::AbstractClient
+    # Use this opts:
+    # @!attribute :logger - logger used in this service
+    # @!attribute :skip - flag attribute used to skip connections(useful for testing)
+    # @!attribute :catch_errors - used to catch errors around subscribers/connections(be careful with it!)
+    # @!attribute :catch_provider - this class will be called with catch_provider.error(e)
+    # @!attribute :disable_nats - if something is passed to that attribute - nats won't be initialized
+
+    def initialize(opts = {})
+      @nats = STAN::Client.new unless opts[:disable_nats] # Create nats client
+      @logger =  NatsListenerCore::ClientLogger.new(opts)
+      @skip = opts[:skip] || false
+      @client_catcher =  NatsListenerCore::ClientCatcher.new(opts)
+    end
+
+    # Use this opts for connection:
+    # @!attribute :cluster_name - name of nats-streaming cluster that we connect to
+    # @!attribute :nats - nats connection info(example: ```{servers: 'nats://127.0.0.1:4223'}```)
+    # @!attribute :service_name - name of current service
+    # @!attribute :client_id - current service client id(optional)
+
+    def establish_connection(config = {})
+      return if skip
+
+      @config = config.to_h
+      begin
+        # Connect nats to provided configuration
+        nats.connect(cluster_name, client_name, config)
+        true
+      rescue StandardError => exception
+        log(action: :connection_failed, message: exception)
+        false
+      end
+    end
+
+    def client_name
+      "#{service_name}-#{config.fetch(:client_id) { :client_id }}"
+    end
+
+    def cluster_name
+      config.fetch(:cluster_name) { :cluster_name }
+    end
+
+    def request(subject, message, opts = {})
+      with_connection do
+        log(action: :request, message: message)
+        nats.request(subject, message, opts)
+      end
+    end
+
+    def disconnected?
+      nats&.nats&.status.to_i.zero?
+    end
+
+    def reestablish_connection
+      establish_connection(config) if disconnected?
+    end
+  end
+end

data/lib/nats_streaming_listener/streaming_subscriber.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'nats_listener_core'
+
+module NatsStreamingListener
+  # Base subscriber using nats-streaming
+  class StreamingSubscriber <  NatsListenerCore::AbstractSubscriber
+    class << self
+      def client
+        NatsStreamingListener::StreamingClient.current
+      end
+    end
+  end
+end

data/lib/nats_streaming_listener/version.rb

@@ -0,0 +1,3 @@
+module NatsStreamingListener
+  VERSION = "0.1.0"
+end

data/lib/nats_streaming_listener.rb

@@ -0,0 +1,8 @@
+require 'nats_streaming_listener/version'
+require 'nats_streaming_listener/streaming_client'
+require 'nats_streaming_listener/streaming_subscriber'
+require 'nats_streaming_listener/nats_message.pb'
+
+module NatsStreamingListener
+  # Your code goes here...
+end

data/nats_streaming_listener.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nats_streaming_listener/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nats_streaming_listener"
+  spec.version       = NatsStreamingListener::VERSION
+  spec.authors       = ["Igor Pavlov"]
+  spec.email         = ["gophan1992@gmail.com"]
+
+  spec.summary       = %q{Nats streaming functionality support for nats-listener gem.}
+  spec.description   = %q{Nats streaming client and subscriber implementation.}
+  spec.homepage      = "https://github.com/beastia/nats_streaming_listener"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency 'google-protobuf', '~> 3.6'
+  spec.add_dependency 'nats-streaming', '~> 0.2'
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: nats_streaming_listener
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Igor Pavlov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: google-protobuf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: nats-streaming
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Nats streaming client and subscriber implementation.
+email:
+- gophan1992@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- definitions/nats_listener/nats_message.proto
+- lib/nats_streaming_listener.rb
+- lib/nats_streaming_listener/nats_message.pb.rb
+- lib/nats_streaming_listener/streaming_client.rb
+- lib/nats_streaming_listener/streaming_subscriber.rb
+- lib/nats_streaming_listener/version.rb
+- nats_streaming_listener.gemspec
+homepage: https://github.com/beastia/nats_streaming_listener
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Nats streaming functionality support for nats-listener gem.
+test_files: []