nats_listener_core 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 447b6223bfb6ffe0952e2cc13a7da52e165cc5cc294c672810226209fd867bfb
+  data.tar.gz: 6a817487166066715af83a97de716c1597a9bac3bbe751c709613d877ce0bc41
+SHA512:
+  metadata.gz: e8c82779ce957cea9cf49cc41c348298f23787394a0ab06974c87dba25440f1e4c299d1625c6aa52c5c5b44f2e4fd8f3e3cf4805908cf7c0669977c4511ef85b
+  data.tar.gz: d25c8147b479907ffe2749ea2fef5c151c2934d14d1aa77525f1a4e487bc3c9a204a7cb9f05ef87cbb9624019b4e06fdad119338f08f7588c9c6e9889921b10c

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,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in nats_listener_core.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    nats_listener_core (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    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)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  nats_listener_core!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec_junit_formatter (= 0.4.1)
+
+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,41 @@
+# NatsListenerCore
+
+This gem implements common logic for dependent gems(`nats_listener` and `nats_streaming_listener`).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nats_listener_core'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nats_listener_core
+
+## Usage
+
+It will be mentioned in `nats_listener` and `nats_streaming_listener` gems.
+
+## 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_listener_core. 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 NatsListenerCore project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/nats_listener_core/blob/master/CODE_OF_CONDUCT.md).

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,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'nats_listener_core'
+
+# 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/lib/nats_listener_core.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'nats_listener_core/version'
+require 'nats_listener_core/client_catcher'
+require 'nats_listener_core/client_logger'
+require 'nats_listener_core/abstract_client'
+require 'nats_listener_core/abstract_subscriber'
+module NatsListenerCore
+end

data/lib/nats_listener_core/abstract_client.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require_relative './client_logger'
+require_relative './client_catcher'
+
+module NatsListenerCore
+  # Abstract client for nats and nats-streaming connections
+  class AbstractClient
+    # @!method Accessor to singleton object of nats client
+    def self.current
+      @current ||= self.class.new
+    end
+
+    def self.current=(value)
+      @current = value
+    end
+
+    attr_reader :logger, :skip, :nats, :config, :client_catcher
+
+    def log(action:, message:)
+      logger.log(
+        action: action,
+        message: message,
+        service_name: service_name
+      )
+    end
+
+    def with_connection
+      return if skip
+
+      begin
+        reestablish_connection
+        yield
+        true
+      rescue StandardError => exception
+        on_rescue(exception)
+        false
+      end
+    end
+
+    def on_rescue(exception)
+      log(action: :error, message: exception)
+      client_catcher.call(exception)
+    end
+
+    # Raw method to publish subject to data
+    def publish(subject, message)
+      with_connection do
+        log(action: :publish, message: message)
+        nats.publish(subject, message)
+      end
+    end
+
+    # Raw method, beware of using it in favor of Subscribers objects
+    def subscribe(subject, opts, &callback)
+      with_connection do
+        nats.subscribe(subject, opts, &callback)
+      end
+    end
+
+    # Raw method, beware of using it in favor of Subscribers objects
+    def unsubscribe(sid)
+      with_connection do
+        nats.unsubscribe(sid)
+      end
+    end
+
+    def service_name
+      return unless config
+
+      config.fetch(:service_name) { :service_name }
+    end
+  end
+end

data/lib/nats_listener_core/abstract_subscriber.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module NatsListenerCore
+  # Abstract class for nats and nats-streaming subscriptions
+  class AbstractSubscriber
+    class << self
+      # subject method is used to define subject for subscription
+      def subject(subj)
+        const_set('SUBJECT', subj)
+      end
+
+      # count method is used to define count of publications
+      # that subscription listens to
+      # If 0 - it's infinitive
+      # Otherwise it decrements after each publication
+      def count(count = 0)
+        const_set('COUNT', count)
+      end
+    end
+
+    attr_reader :client, :sid
+
+    def initialize(client: nil)
+      klass = self.class
+      @subject = klass.const_get('SUBJECT')
+      @count = klass.const_get('COUNT')
+      @client = client || klass.client
+      @infinitive = true if @count.zero?
+    end
+
+    def subscribe(opts = {})
+      # Create subscription and delete after its finished if not infinitive
+      @sid = client.subscribe(@subject, opts) do |msg, reply, subject|
+        begin
+          around_call(msg, reply, subject)
+          destroy unless should_call?
+        rescue StandardError => exception
+          client.on_rescue(exception)
+        end
+      end
+    end
+
+    def around_call(msg, reply, subject)
+      client.log(action: :received, message: msg.to_s)
+      return unless should_call?
+
+      call(msg, reply, subject)
+      @count -= 1 unless @infinitive
+    end
+
+    def should_call?
+      @count.positive? || @infinitive
+    end
+
+    def destroy
+      client.unsubscribe(sid)
+    end
+
+    def call(_msg, _reply, _subject); end
+  end
+end

data/lib/nats_listener_core/client_catcher.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module NatsListenerCore
+  # Client configuration
+  class ClientCatcher
+    attr_reader :catch_error, :catch_provider
+
+    def initialize(opts)
+      @catch_error = opts[:catch_errors] || false
+      @catch_provider = opts[:catch_provider]
+    end
+
+    def call(exception)
+      raise exception unless catch_error
+
+      catch_provider.error(exception)
+    end
+  end
+end

data/lib/nats_listener_core/client_logger.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module NatsListenerCore
+  # Client configuration
+  class ClientLogger
+    attr_reader :logger
+
+    def initialize(opts)
+      @logger = opts[:logger]
+    end
+
+    def log(action:, message:, service_name:)
+      return unless logger
+
+      logger.info(
+        service: service_name,
+        action: action,
+        message: message
+      )
+    end
+  end
+end

data/lib/nats_listener_core/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module NatsListenerCore
+  VERSION = '0.1.1'
+end

data/nats_listener_core.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nats_listener_core/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'nats_listener_core'
+  spec.version       = NatsListenerCore::VERSION
+  spec.authors       = ['Igor Pavlov']
+  spec.email         = ['gophan1992@gmail.com']
+
+  spec.summary       = 'Base gem for nats_listener. It defines common logic for both nats and nats streaming subscribers gems.'
+  spec.description   = "This gem implements basic logic for nats listeners. It's created for modular purpose."
+  spec.homepage      = 'https://github.com/beastia/nats_listener_core'
+  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_development_dependency 'rspec_junit_formatter', '0.4.1'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: nats_listener_core
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+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: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+description: This gem implements basic logic for nats listeners. It's created for
+  modular purpose.
+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
+- lib/nats_listener_core.rb
+- lib/nats_listener_core/abstract_client.rb
+- lib/nats_listener_core/abstract_subscriber.rb
+- lib/nats_listener_core/client_catcher.rb
+- lib/nats_listener_core/client_logger.rb
+- lib/nats_listener_core/version.rb
+- nats_listener_core.gemspec
+homepage: https://github.com/beastia/nats_listener_core
+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: Base gem for nats_listener. It defines common logic for both nats and nats
+  streaming subscribers gems.
+test_files: []