flow_trace 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 50ebe544f55d1350e9003e1a928d0d8c30caf47d92c266d8e305601fba78be4c
+  data.tar.gz: 199afc61f1924e28b91a4b55780ed0d8b4f360660fefffca17fb465525f996a6
+SHA512:
+  metadata.gz: a0605fbe71a8019118a8566665569c729d5141aed5fbf362cae1235491b4e41a470ba6d1f6c68f346403b5b4b0178e7ea6b3e28580737ea598a436dc194f4835
+  data.tar.gz: d75dcab402c01420f9fc91c2d9a09d1b290e1d10c6976ebbfae1cef0889abd252fc8ae6c14f85699544920b22a1dc943cae269d5ffb7f464499341f059b3a944

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+  DisplayCopNames:    true
+  DisplayStyleGuide:  true
+  StyleGuideCopsOnly: true
+  TargetRubyVersion:  2.6
+
+Metrics/LineLength:
+  Max: 120
+
+Documentation:
+  Enabled: false
+
+FrozenStringLiteralComment:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Exclude:
+    - spec/**/*_spec.rb

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# v0.0.1 2019-11-15
+
+Initial release (Proof of Concept). ([kirillshevch](https://github.com/kirillshevch/flow_trace/pull/1))

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in flow_trace.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,94 @@
+PATH
+  remote: .
+  specs:
+    flow_trace (0.0.1)
+      dry-configurable
+      http
+      sinatra
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.0)
+    byebug (11.0.1)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    dry-configurable (0.9.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.7)
+    dry-core (0.4.9)
+      concurrent-ruby (~> 1.0)
+    ffi (1.11.2)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    http (4.2.0)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.0)
+      http-parser (~> 1.2.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.1.1)
+    http-parser (1.2.1)
+      ffi-compiler (>= 1.0, < 2.0)
+    jaro_winkler (1.5.4)
+    mustermann (1.0.3)
+    parallel (1.19.0)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    public_suffix (4.0.1)
+    rack (2.0.7)
+    rack-protection (2.0.7)
+      rack
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.76.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    sinatra (2.0.7)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.7)
+      tilt (~> 2.0)
+    tilt (2.0.10)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.6)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  byebug
+  flow_trace!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Kirill Shevchenko
+
+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,72 @@
+# FlowTrace
+
+Brand new remote app inspecting tool. Declare feature steps and receive params, stack trace and whatever you want.
+
+* Look into what happens on you *staging* environments
+* Doesn't have payloads for tests, debugging, bug fix? Get data during reproducing feature flow.
+
+## Installation
+
+Add this line to your application's Gemfile and then execute `bundle install`:
+
+```ruby
+gem 'flow_trace'
+```
+
+## Usage
+
+1. Configuration
+
+Use `https` proxy (for example `ngrok`) to local `4567` port.
+
+`config/initializers/flow_trace.rb`
+```ruby
+FlowTrace::Settings.configure do |config|
+  config.proxy_url = 'http://0000000.ngrok.io'
+end
+```
+
+2. Declare remote flow
+
+```ruby
+FlowTrace::Step.call(:flow_name, :step_name, {})
+```
+
+3. Start receive messages (locally)
+
+```
+bundle exec flow_trace
+```
+
+## Use case
+
+How to use this? For example declare step by step your To-Do tasks create flow:
+
+```ruby
+class TasksController < ApplicationController
+  def create
+    FlowTrace::Step.call(:todo_create, :controller_receive, params)
+    
+    result = TaskCreator.call(current_user, params).success?
+    if result.success?
+      
+    else
+    
+    end
+  end
+end
+```
+
+```ruby
+class TaskCreator
+  
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kirillshevch/flow_trace.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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/flow_trace

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+# Always look in the lib directory of this gem
+# first when searching the load path
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+
+require 'flow_trace/server'
+
+FlowTrace::Server.run!

data/flow_trace.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flow_trace/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'flow_trace'
+  spec.version       = FlowTrace::VERSION
+  spec.authors       = ['Kirill Shevchenko']
+  spec.email         = ['hello@kirillshevch.com']
+
+  spec.summary       = 'Brand new remote app inspecting tool'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/kirillshevch/flow_trace'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/kirillshevch/flow_trace'
+  spec.metadata['changelog_uri'] = 'https://github.com/kirillshevch/flow_trace/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = 'flow_trace'
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'http'
+  spec.add_dependency 'sinatra'
+  spec.add_dependency 'dry-configurable'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'byebug'
+end

data/lib/flow_trace.rb

@@ -0,0 +1,8 @@
+require 'http'
+require 'flow_trace/version'
+require 'flow_trace/settings'
+require 'flow_trace/step'
+
+module FlowTrace
+  class Error < StandardError; end
+end

data/lib/flow_trace/server.rb

@@ -0,0 +1,10 @@
+require 'sinatra'
+require 'byebug'
+
+module FlowTrace
+  class Server < ::Sinatra::Base
+    post '/' do
+      p params
+    end
+  end
+end

data/lib/flow_trace/settings.rb

@@ -0,0 +1,7 @@
+module FlowTrace
+  class Settings
+    extend ::Dry::Configurable
+
+    setting :proxy_url, 'http://localhost:4567'
+  end
+end

data/lib/flow_trace/step.rb

@@ -0,0 +1,29 @@
+module FlowTrace
+  class Step
+    attr_reader :flow, :step, :options
+
+    def self.call(*args)
+      new(*args).call
+    end
+
+    def initialize(flow, step, **options)
+      @flow = flow
+      @step = step
+      @options = options
+    end
+
+    def call
+      HTTP.post(FlowTrace::Settings.config.proxy_url, json: payload)
+    end
+
+    private
+
+    def payload
+      {
+        flow: flow,
+        step: step,
+        options: options
+      }
+    end
+  end
+end

data/lib/flow_trace/version.rb

@@ -0,0 +1,3 @@
+module FlowTrace
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: flow_trace
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kirill Shevchenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: rubocop
+  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: byebug
+  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: Brand new remote app inspecting tool
+email:
+- hello@kirillshevch.com
+executables:
+- flow_trace
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/flow_trace
+- flow_trace.gemspec
+- lib/flow_trace.rb
+- lib/flow_trace/server.rb
+- lib/flow_trace/settings.rb
+- lib/flow_trace/step.rb
+- lib/flow_trace/version.rb
+homepage: https://github.com/kirillshevch/flow_trace
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kirillshevch/flow_trace
+  source_code_uri: https://github.com/kirillshevch/flow_trace
+  changelog_uri: https://github.com/kirillshevch/flow_trace/blob/master/CHANGELOG.md
+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: Brand new remote app inspecting tool
+test_files: []