Captain 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a87f2b4e2abcc01e664f29302e0362df5c43a698930de1a4cabc29872fc3da38
-  data.tar.gz: fed9edda4b7f84eb5eec174b0a289dbf9f6d4f1e7f0acf0b9f0d1dbe1bf9efb0
+  metadata.gz: 5f10388eb371f3c610c51357d7f270974bb67d8a25af262cf1b897a2b78fe086
+  data.tar.gz: c784101ffa46242b42f475b35298f0dca4e022ff5f798f4c9aef0c636ef94a44
 SHA512:
-  metadata.gz: dddc5bc597815882013be0302bd691d5d0a6965c35b56c9e6292f4c544682101a7b6e62b8d6391238c8273b4e7411c9a6357f46e2dc15746bd2e453bb58f84e3
-  data.tar.gz: cfbbf7c27f0dae1af9acb1c0ea876c624a73687a56a66bc98ac57eb05883bf9e34239df0dc3e50d78fb5ea6fee3eedd1eaf63a2d33eae2abd4afc02bbd723dcd
+  metadata.gz: ecdc0734368d616a79083a8b8ab6ced1cd13cbcecf6f1f3c1a2b558c6062e70dca980a43bebea24738100eec712049d0657962f25be0dfec62b21c9130ada277
+  data.tar.gz: d5c5c5304e056049495f42e169098a6daef774eb6b608cfcb79403198e4aef04b455f1fbbd3e2ae4ddf1a4dd4b02d57736861105d1d8c056208073a4671b222d

data/Captain.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/captain/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "Captain"
+  spec.version       = Captain::VERSION
+  spec.authors       = ["Grégory Prève", "Antoine Barranco"]
+  spec.email         = ["gregory@flatlooker.com", "antoine.barranco@flatlooker.com"]
+
+  spec.summary       = "Gem to handle incoming hooks"
+  spec.description   = "Gem to handle incoming hooks"
+  spec.homepage      = "https://github.com/Flatlooker/Captain"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Flatlooker/Captain"
+  spec.metadata["changelog_uri"] = "https://github.com/Flatlooker/Captain/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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/Gemfile

@@ -5,16 +5,11 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in Captain.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-
+gem "json"
 gem "minitest", "~> 5.0"
+gem "rake", "~> 13.0"
 
-gem "rubocop", "~> 1.21"
-
-gem 'rack'
-
-gem 'sinatra'
-
-gem 'puma'
-
-gem 'ruby_jard'
+group :development do
+  gem "rubocop", "~> 1.21"
+  gem 'ruby_jard'
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    Captain (0.0.1)
+    Captain (0.0.2)
 
 GEM
   remote: https://rubygems.org/
@@ -9,64 +9,51 @@ GEM
     ast (2.4.2)
     byebug (11.1.3)
     coderay (1.1.3)
+    json (2.6.2)
     method_source (1.0.0)
-    minitest (5.15.0)
-    mustermann (1.1.1)
-      ruby2_keywords (~> 0.0.1)
-    nio4r (2.5.8)
+    minitest (5.16.2)
     parallel (1.22.1)
-    parser (3.0.2.0)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    puma (5.6.4)
-      nio4r (~> 2.0)
-    rack (2.2.3.1)
-    rack-protection (2.2.0)
-      rack
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.5.0)
     rexml (3.2.5)
-    rubocop (1.24.1)
+    rubocop (1.31.2)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.15.1, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.15.2)
-      parser (>= 3.0.1.1)
+    rubocop-ast (1.19.1)
+      parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.5)
     ruby_jard (0.3.1)
       byebug (>= 9.1, < 12.0)
       pry (~> 0.13.0)
       tty-screen (~> 0.8.1)
-    sinatra (2.2.0)
-      mustermann (~> 1.0)
-      rack (~> 2.2)
-      rack-protection (= 2.2.0)
-      tilt (~> 2.0)
-    tilt (2.0.10)
     tty-screen (0.8.1)
-    unicode-display_width (2.1.0)
+    unicode-display_width (2.2.0)
 
 PLATFORMS
+  universal-darwin-21
+  x86_64-darwin-18
   x86_64-darwin-20
 
 DEPENDENCIES
   Captain!
+  json
   minitest (~> 5.0)
-  puma
-  rack
   rake (~> 13.0)
   rubocop (~> 1.21)
   ruby_jard
-  sinatra
 
 BUNDLED WITH
-   2.2.30
+   2.3.18

data/README.md

@@ -43,21 +43,31 @@ The gem is available as open source under the terms of the [MIT License](https:/
 Everyone interacting in the Captain project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/Captain/blob/master/CODE_OF_CONDUCT.md).
 
 ```ruby
-require 'ruby_jard'
-require_relative "./lib/Captain.rb"
-require_relative "./lib/hooks_controller.rb"
-
-Captain.define_hook('test')
-Captain.define_hook('yo')
-
+# myapp.rb
 require 'sinatra'
-require_relative 'lib/hooks_controller'
+require 'ruby_jard'
+require '../lib/captain'
+
+class HookTest
+  def perform
+    {
+      status: 200,
+      body: { text: "Hello World!" }
+    }
+  end
 
-class App < Sinatra::Base
-  get "/hooks/*" do
-    HooksController.new.call(@env)
+  def save
+    puts 'the hook is save.'
   end
 end
 
-run App
+hook_type = proc do |url, content|
+  HookTest
+end
+Captain.config[:url_root] = '/hooks'
+Captain.define_hook('/test_event', hook_type)
+
+get "/hooks/*" do
+  HooksController.new.call(@env, @params)
+end
 ```

data/bin/console

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require "bundler/setup"
-require "Captain"
+require "captain"
 
 # 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.

data/config.ru

@@ -2,8 +2,8 @@ require 'sinatra'
 
 class App < Sinatra::Base
   get "/hooks/*" do
-    HooksController.new.call(@env)
+    Captain::EventsDispatcher.new.call(@env, { name: 'Test::ComplexEvent' })
   end
 end
 
-run App
+run App 

data/lib/Captain/errors.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Captain
+  class CaptainError < StandardError
+    attr_accessor :message
+
+    def initialize(message = nil)
+      @message = message
+      super
+    end
+  end
+
+  class NoExistingHookType < MLClientError
+  end
+
+  class NoMethodPerform < MLClientError
+  end
+
+  class NoExistingHook < MLClientError
+  end
+
+  class TooManyMatchedHooksError < MLClientError
+  end
+end

data/lib/Captain/events_dispatcher.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Captain
+  class EventsDispatcher
+    def call(env, params)
+      matched_event = matched_events env['REQUEST_PATH']
+
+      format_response(status: 404, body: { response: "Unknown hook route ! (#{env['PATH_INFO']})" }) if matched_event.nil?
+
+      event = retrieve_event matched_event, params
+      event.save if event.respond_to?(:save)
+      format_response **event.perform
+    end
+
+    private
+
+    def matched_events(url)
+      raise NoExistingEvent if Captain.events.size.zero?
+
+      matched_events = Captain.events.select do |event|
+        event[:url] == url
+      end
+
+      raise TooManyMatchedEventsError if matched_events.size > 1
+
+      matched_events.first
+    end
+
+    def retrieve_event(matched_event, params)
+      event_type = matched_event[:event_type]
+      case event_type.class   
+      when Proc
+        event_type.call(matched_event[:url], params).new
+      when Class
+        event_type.new
+      end
+    end
+
+    def format_response(status:, body:, format: 'application/json')
+      [status, { 'Content-Type' => format }, body.to_json]
+    end
+  end
+end

data/lib/Captain/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Captain
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/captain.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "captain/version"
+require_relative "./captain/events_dispatcher"
+
+module Captain
+  class << self
+    attr_accessor :events
+    attr_accessor :config
+
+    def define_hook(url, event_type)
+      raise NoMethodPerform if !event_type.nil? && event_type.respond_to?(:perform)
+
+      events << {url: "#{Captain.config[:url_root]}#{url}", event_type: event_type}
+    end
+  end
+
+  Captain.config = {}
+  Captain.config[:url_root] = '/hooks'
+  Captain.events = []
+end

data/tests/captain_test.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "./tests/test_helper"
+require "rack/test"
+
+class CaptainTest < Minitest::Test
+  include Rack::Test::Methods
+
+  OUTER_APP = Rack::Builder.parse_file("./config.ru").first
+
+  def setup
+    Captain.define_hook('/test_route', Test::Event)
+    event_type = proc do |url, params|
+      params[:name]
+    end
+    Captain.define_hook('/test_complex_route', event_type)
+  end
+
+  def app
+    OUTER_APP
+  end
+
+  def test_that_it_has_a_version_number
+    refute_nil ::Captain::VERSION
+  end
+
+  def test_defined_route
+    get '/hooks/test_route'
+    puts last_response.body
+    assert_equal true, last_response.ok?
+    assert_equal 'Hello World!', last_response.body.force_encoding('UTF-8')
+  end
+
+  def tet_complex_route
+    get '/hooks/test_complex_route'
+    
+    assert_equal true, last_response.ok?
+    assert_equal 'Hello World!', last_response.body.force_encoding('UTF-8')
+  end
+
+  def tet_undefined_route
+    get '/hooks/wrong_route'
+    
+    assert_equal false, last_response.ok?
+    assert_equal "Unknown hook route ! (/hooks/wrong_route)", last_response.body.force_encoding('UTF-8')
+  end
+end

data/tests/events_dispatcher_test.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative './test_helper'
+
+class EventsDispatcherTest < Minitest::Test
+  def setup
+    Captain.define_hook('/test_route', 'Test::Event')
+  end
+
+  def test_call_returns_right_output
+    env = { 'PATH_INFO' => '/hooks/test_route' }
+    assert Captain::EventsDispatcher.new.call(env) == [200, {"Content-Type" => "text/html"}, ["Hello World!"]]
+
+    env = { 'PATH_INFO' => '/hooks/wrong_route' }
+    assert Captain::EventsDispatcher.new.call(env) == [404, {"Content-Type" => "text/html"}, ["Unknown hook route ! (/hooks/wrong_route)"]]
+  end
+end

data/tests/test.rb

@@ -0,0 +1,2 @@
+class Test
+end

data/tests/test_complex_event.rb

@@ -0,0 +1,2 @@
+class Test::ComplexEvent < Test
+end

data/tests/test_event.rb

@@ -0,0 +1,4 @@
+class Test::Event < Test
+  def perform
+  end
+end

data/tests/test_helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require_relative "../lib/captain"
+require "./lib/captain/events_dispatcher"
+require "./tests/test.rb"
+require "./tests/test_event.rb"
+require "./tests/test_complex_event.rb"
+
+require "minitest/autorun"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Captain
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Grégory Prève
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-11 00:00:00.000000000 Z
+date: 2022-08-10 00:00:00.000000000 Z
 dependencies: []
 description: Gem to handle incoming hooks
 email:
@@ -22,6 +22,8 @@ files:
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- Captain-0.0.1.gem
+- Captain.gemspec
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -30,9 +32,16 @@ files:
 - bin/console
 - bin/setup
 - config.ru
-- lib/Captain.rb
+- lib/Captain/errors.rb
+- lib/Captain/events_dispatcher.rb
 - lib/Captain/version.rb
-- lib/hooks_controller.rb
+- lib/captain.rb
+- tests/captain_test.rb
+- tests/events_dispatcher_test.rb
+- tests/test.rb
+- tests/test_complex_event.rb
+- tests/test_event.rb
+- tests/test_helper.rb
 homepage: https://github.com/Flatlooker/Captain
 licenses:
 - MIT

data/lib/Captain.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "Captain/version"
-require_relative "hooks_controller"
-require 'rack'
-
-module Captain
-  class << self
-    attr_accessor :config
-
-    def define_hook(url)
-      config[:hooks] ||= []
-      config[:hooks] << url
-    end
-  end
-
-  Captain.config = {}  
-end

data/lib/hooks_controller.rb

@@ -1,11 +0,0 @@
-require 'rack'
-
-class HooksController
-  def call(env)
-    Captain.config[:hooks].each do |hook_path|
-      return [200, {"Content-Type" => "text/html"}, ["Hello World!"]] if "/hooks/#{hook_path}" == env['PATH_INFO']
-    end
-
-    [404, {"Content-Type" => "text/html"}, ["Unknown hook route !"]]
-  end
-end