interceptors 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '076710813e9e517742bb3a92db2e062d63908d6e66ce2686fba366861dceff78'
+  data.tar.gz: b8dec78267d96a79c68463d912601ec2d5d514cffef9096fa98574fd2f9aa5c1
+SHA512:
+  metadata.gz: ee6a7c1b9036259bd69fd9f2075ccc342b641dae13446a8ec240533ca55c6fa2c37ae6f2ab114cca080837043d1bfcd3a2c809a5db5fa773229b33b2ff422af5
+  data.tar.gz: 3e487d4624bb0f755dc15eadd6e9f42b811a733734dd0a813b6c76550198ab5506d47be56048ebf6abc569ecb016956808224d32c8aee17cc61a12c8e82f087f

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.idea
+
+# 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.4.3
+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 laerti.papa@xing.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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in interceptors.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    interceptors (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (12.3.2)
+    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
+  interceptors!
+  rake
+  rspec
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Laerti Papa
+
+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,52 @@
+# Interceptors
+
+[Pedestal](http://pedestal.io/reference/interceptors) like interceptors pipe and filter service objects in Ruby. Common use cases like http service objects or multiple steps business workflow. 
+
+## Installation
+
+Add     this line to your application's Gemfile:
+
+```ruby
+gem 'interceptors'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install interceptors
+
+## Overview
+
+TBD
+
+## Usage examples
+
+Create your interceptors by extending `Interceptors::Base` class and define one of `on_enter`, `on_leave` or `on_error` method based on your use case. Register each one of them to an `Interceptors::Executor` instance and send `#call` message on it. Implement your logic in each interceptor service per use case.
+
+
+```ruby
+
+``` 
+
+## 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/laertispappas/interceptors. 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 Interceptors project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/interceptors/blob/master/CODE_OF_CONDUCT.md).
+
+## Acknowledgments

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 "interceptors"
+
+# 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/interceptors.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "interceptors/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "interceptors"
+  spec.version       = Interceptors::VERSION
+  spec.authors       = ["Laerti Papa"]
+  spec.email         = ["laerti.papa@xing.com"]
+
+  spec.summary       = %q{Pedestal like interceptors service objects in Ruby}
+  spec.description   = %q{Pedestal like interceptors service objects in Ruby, aka pipe and filter architecture}
+  spec.homepage      = "https://www.github.com/laertispappas/interceptors"
+  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"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/interceptors.rb

@@ -0,0 +1,14 @@
+require "interceptors/version"
+
+require "interceptors/ds/node"
+require "interceptors/ds/stack"
+require "interceptors/middleware"
+require "interceptors/executor"
+require "interceptors/base"
+require "interceptors/context"
+
+module Interceptors
+  def self.root
+    Pathname.new(File.expand_path('../..', __FILE__))
+  end
+end

data/lib/interceptors/base.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Interceptors
+  class Base
+    def on_enter(ctx)
+      ctx
+    end
+
+    def on_leave(ctx)
+      ctx
+    end
+
+    def on_error(ctx)
+      ctx
+    end
+  end
+end

data/lib/interceptors/context.rb

@@ -0,0 +1,6 @@
+require "ostruct"
+
+module Interceptors
+  class Context < OpenStruct
+  end
+end

data/lib/interceptors/ds/errors.rb

@@ -0,0 +1,15 @@
+module Interceptors
+  module DS
+    module Errors
+      Error = Class.new(StandardError)
+      class NullValueNotAllowedError < Error; end
+      class NoSuchElementException < Error; end
+
+      private
+
+      def assert!(item)
+        raise NullValueNotAllowedError, "A value must not be null in the dequeue" if item.nil?
+      end
+    end
+  end
+end

data/lib/interceptors/ds/node.rb

@@ -0,0 +1,12 @@
+module Interceptors
+  module DS
+    class Node
+      attr_accessor :next, :item
+
+      def initialize(item)
+        @item = item
+        @next = nil
+      end
+    end
+  end
+end

data/lib/interceptors/ds/stack.rb

@@ -0,0 +1,30 @@
+require_relative "./errors"
+
+module Interceptors
+  module DS
+    class Stack
+      include DS::Errors
+
+      def initialize
+        @head = nil
+      end
+
+      def push(item)
+        assert!(item)
+        old_head = @head
+        @head = Node.new(item)
+        @head.next = old_head
+      end
+
+      def pop
+        raise NoSuchElementException if empty?
+
+        @head.item.tap { @head = @head.next }
+      end
+
+      def empty?
+        @head.nil?
+      end
+    end
+  end
+end

data/lib/interceptors/executor.rb

@@ -0,0 +1,45 @@
+module Interceptors
+  class Executor
+    attr_reader :middleware, :context
+
+    def initialize(context = Context.new)
+      @middleware = Middleware.new
+      @context = context
+    end
+
+    def register(interceptor)
+      middleware.enqueue(interceptor)
+    end
+
+    def call
+      while (interceptor, step = fetch_next)
+        with_exception_handling(interceptor) do
+          interceptor.public_send(step, context)
+        end
+      end
+
+      context
+    end
+
+    private
+
+    def fetch_next
+      if context[:error]
+        [middleware.pop, :on_error] unless middleware.on_leave.empty?
+      elsif !middleware.on_enter.empty?
+        interceptor = middleware.dequeue
+        middleware.push(interceptor)
+        [interceptor, :on_enter]
+      elsif !middleware.on_leave.empty?
+        [middleware.pop, :on_leave]
+      end
+    end
+
+    def with_exception_handling(interceptor)
+      yield
+    rescue StandardError => e
+      context[:error] = e
+      context[:error_raised_at] = interceptor.class.name
+    end
+  end
+end

data/lib/interceptors/middleware.rb

@@ -0,0 +1,28 @@
+module Interceptors
+  class Middleware
+    attr_reader :on_enter, :on_leave
+
+    def initialize
+      @on_enter = Queue.new
+      @on_leave = DS::Stack.new
+    end
+
+    # Queue operations
+    def enqueue(element)
+      on_enter.push(element)
+    end
+
+    def dequeue
+      on_enter.pop
+    end
+
+    # Stack operations
+    def push(element)
+      on_leave.push(element)
+    end
+
+    def pop
+      on_leave.pop
+    end
+  end
+end

data/lib/interceptors/version.rb

@@ -0,0 +1,3 @@
+module Interceptors
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: interceptors
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Laerti Papa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: Pedestal like interceptors service objects in Ruby, aka pipe and filter
+  architecture
+email:
+- laerti.papa@xing.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
+- interceptors.gemspec
+- lib/interceptors.rb
+- lib/interceptors/base.rb
+- lib/interceptors/context.rb
+- lib/interceptors/ds/errors.rb
+- lib/interceptors/ds/node.rb
+- lib/interceptors/ds/stack.rb
+- lib/interceptors/executor.rb
+- lib/interceptors/middleware.rb
+- lib/interceptors/version.rb
+homepage: https://www.github.com/laertispappas/interceptors
+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: Pedestal like interceptors service objects in Ruby
+test_files: []