oncall 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b32fb0bf81e7eb52f7ed4a716584e5634d2109d00f68e9d99ac687576b7dafe7
-  data.tar.gz: 8896c3f2830722e034f7de93c907e5d40ac257114f49179aa875937c0a59687a
+  metadata.gz: 78f13efef7b8e1d440f5c895eaab176727a63e60575d86acf4ac27e2aac4ad51
+  data.tar.gz: 20107a1ee7f2c76212b8f82cc62f368ee4a5eac67872fb3214e61cf2603ef37d
 SHA512:
-  metadata.gz: 121096a38968f48da32314255339cef94e526a6d30a9ff31331e2e1c0f93f2d443169f3e52ec7ab44180f01904bd469d3517f7f7cf0ae532d95c4793dbbbd6bf
-  data.tar.gz: 56acd28d76bfd3a65c8a94f89f6b10052efaab80e135d41e35b8e017c0a479aae09ac960ae2c2c4bc450e6370368a6bb769a7f411be6ee623313e9c1fba8827c
+  metadata.gz: 13c56a09b37eb72ce432b59bbfb6505d314e5530ca0e4ad174df439c0e70fe3a7f9d29afba6b2bac8246c921f61cfaf5bde1175b683f7c1c969a1ae25c0b8445
+  data.tar.gz: c1077f3388f215dd5c41e6643729f59ad99060cd8e48f3003871c3e14577cb31018fb5ea2feeedb24c05a9adf2b71406bef4ec315ae77429126f99d925a4be33

data/README.md

@@ -1,11 +1,12 @@
 # 🤙 Oncall
 
+[![Build Status](https://travis-ci.org/koenwoortman/oncall.svg?branch=master)](https://travis-ci.org/koenwoortman/oncall)
 [![Gem Version](https://badge.fury.io/rb/oncall.svg)](https://badge.fury.io/rb/oncall)
 
 > Oncall is a DSL for testing JSON API's.
 
 #### Install
-```
+```sh
 $ gem install oncall
 ```
 
@@ -22,12 +23,12 @@ $ gem install oncall
 ## Get started
 
 Initialize
-```
+```sh
 $ oncall --init
 ```
 
 Add tests
-```
+```ruby
 group :user do
   header 'Content-Type' => 'application/json'
 
@@ -49,12 +50,27 @@ end
 ```
 
 Run them
-```
+```sh
 $ oncall
 ```
 
 ## Usage
 
+```
+Usage: oncall [options]
+        --env ENV                    Specify the environment to test against
+        --path PATH                  Set the path for finding tests
+        --pattern PATTERN            Load files matching pattern
+        --exclude PATTERN            Exclude files matching pattern
+        --group GROUP                Filter tests by group
+        --persist PATH               Write output to a file instead of $stdout
+        --config PATH                Path to the config file
+        --init                       Initialize your project with Oncall
+        --verbose                    Increases the verbosity level for a more detailed output
+        --version                    Display the version
+        --help                       This help message
+```
+
 
 ## Configuration
 
@@ -66,5 +82,5 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 
 ## Acknowledgments
 
-*  Inspired by [rspec](https://github.com/rspec/rspec).
-*  And using [Ruby JSON Schema Validator](https://github.com/ruby-json-schema/json-schema).
+*  Inspired by [RSpec](https://github.com/rspec/rspec).
+*  Uses [Ruby JSON Schema Validator](https://github.com/ruby-json-schema/json-schema).

data/lib/oncall.rb

@@ -9,8 +9,14 @@ require 'json-schema'
 module Oncall
   require_relative 'oncall/cli'
   require_relative 'oncall/dsl'
+  require_relative 'oncall/http'
   require_relative 'oncall/options'
-  require_relative 'oncall/invocations'
+  require_relative 'oncall/invocations/base_runner'
+  require_relative 'oncall/invocations/console_runner'
+  require_relative 'oncall/invocations/help_runner'
+  require_relative 'oncall/invocations/init_runner'
+  require_relative 'oncall/invocations/test_runner'
+  require_relative 'oncall/invocations/version_runner'
   require_relative 'oncall/test_file'
   require_relative 'oncall/reporter'
   require_relative 'oncall/version'
@@ -19,21 +25,9 @@ module Oncall
     attr_writer :options
   end
 
+  SCRIPT = 'oncall'
+
   def self.options
     @options ||= Oncall::Options.new
   end
-
-  def self.uri(path, params)
-    parts = path.split('/')
-    return '/' if parts.empty?
-
-    parts.each_with_index do |part, index|
-      if part.start_with?(':')
-        part[0] = ''
-        parts[index] = params[part.to_sym]
-      end
-    end
-
-    parts.join('/')
-  end
 end

data/lib/oncall/cli.rb

@@ -1,11 +1,9 @@
 module Oncall
   # Manage the processing of command line options
   class CLI
-    SCRIPT = 'oncall'
-
     attr_reader :args, :options
 
-    def initialize(args, options=Oncall.options)
+    def initialize(args, options = Oncall.options)
       @args = args
       @options = options
     end
@@ -15,51 +13,65 @@ module Oncall
     end
 
     def run
+      parse_cli_options
+      load_config_file
+
       begin
-        parser.parse!(args)
-      rescue OptionParser::InvalidOption => e
-        abort "#{SCRIPT}: #{e.message}\nPlease use --help for a listing of valid options"
-      rescue OptionParser::MissingArgument => e
-        abort "#{SCRIPT}: #{e.message}"
+        status = options.runner.run($stderr, $stdout)
+      rescue Exception => e
+        abort "#{Oncall::SCRIPT}: #{e.message}"
       end
 
-      status = options.runner.run($stderr, $stdout)
       exit(status) if status.is_a? Integer
     end
 
     private
 
-    def parser
+    def load_config_file
+      options.parse_config
+    rescue Exception => e
+      abort "#{Oncall::SCRIPT}: #{e.message}"
+    end
+
+    def parse_cli_options
+      option_parser.parse!(args)
+    rescue OptionParser::InvalidOption => e
+      abort "#{Oncall::SCRIPT}: #{e.message}\nPlease use --help for a listing of valid options"
+    rescue OptionParser::MissingArgument => e
+      abort "#{Oncall::SCRIPT}: #{e.message}"
+    end
+
+    def option_parser
       OptionParser.new do |opt|
-        opt.on('--env ENV', String) do |env|
+        opt.on('--env ENV', String, 'Specify the environment to test against') do |env|
           options.env= env
         end
 
-        opt.on('--path PATH', String) do |path|
+        opt.on('--path PATH', String, 'Set the path for finding tests') do |path|
           options.path= path
         end
 
-        opt.on('--pattern PATTERN', String) do |pattern|
+        opt.on('--pattern PATTERN', String, 'Load files matching pattern') do |pattern|
           options.pattern= pattern
         end
 
-        opt.on('--exclude PATTERN', String) do |pattern|
+        opt.on('--exclude PATTERN', String, 'Exclude files matching pattern') do |pattern|
           options.exclude= pattern
         end
 
-        opt.on('--group GROUP', String) do |group|
+        opt.on('--group GROUP', String, 'Filter tests by group') do |group|
           options.group= group
         end
 
-        opt.on('--persist PATH', String) do |path|
+        opt.on('--persist PATH', String, 'Write output to a file instead of $stdout') do |path|
           options.persist= path
         end
 
-        opt.on('--config PATH', String) do |path|
+        opt.on('--config PATH', String, 'Path to the config file') do |path|
           options.config= path
         end
 
-        opt.on('--init', '') do
+        opt.on('--init', 'Initialize your project with Oncall') do
           options.runner= Oncall::Invocations::InitRunner.new
         end
 
@@ -68,12 +80,16 @@ module Oncall
         #   options.runner= Oncall::Invocations::ConsoleRunner.new
         # end
 
-        opt.on('--version', '') do
+        opt.on('--verbose', 'Increases the verbosity level for a more detailed output') do
+          options.verbose= true
+        end
+
+        opt.on('--version', 'Display the version') do
           options.runner= Oncall::Invocations::VersionRunner.new
         end
 
         opt.on_tail('--help', 'This help message') do
-          options.runner= Oncall::Invocations::HelpRunner.new(parser)
+          options.runner= Oncall::Invocations::HelpRunner.new(option_parser)
         end
       end
     end

data/lib/oncall/dsl.rb

@@ -1,46 +1,30 @@
 module Oncall
   class DSL
-    private
-
-    attr_accessor :response, :request
-    attr_reader :reporter, :file, :http
-
-    public
-
     def initialize(file, reporter)
       @reporter = reporter
       @file = file
-      @http = Net::HTTP.new('localhost', 4567)
-      @headers = { 'User-Agent' => "oncall/#{Oncall::VERSION}" }
+      @http = nil
+      @headers = {}
       @params = {}
-      @query = {}
-      @response = nil
-      @request = nil
     end
 
     def to_s
-      file
+      @file
     end
 
     private
 
-    def group(name=nil, &block)
-      return reporter.empty_group(self) unless block_given?
+    def group(_name=nil, &block)
+      return @reporter.empty_group(self) unless block_given?
 
       instance_exec &block
     end
 
     def get(path, &block)
-      return reporter.empty_call(self) unless block_given?
+      return @reporter.empty_call(self) unless block_given?
 
-      uri = Oncall.uri(path, @params)
-      @request = Net::HTTP::Get.new(uri)
-
-      @headers.each do |key, value|
-        @request[key] = value
-      end
-
-      @response = http.request(request)
+      @http = Oncall::HTTP.new(path, headers: @headers, params: @params)
+      @http.get
 
       instance_exec &block
     end
@@ -48,14 +32,8 @@ module Oncall
     def post(path, &block)
       return reporter.empty_call(self) unless block_given?
 
-      uri = Oncall.uri(path, @params)
-      @request = Net::HTTP::Post.new(uri)
-
-      @headers.each do |key, value|
-        @request[key] = value
-      end
-
-      @response = http.request(request)
+      @http = Oncall::HTTP.new(path, headers: @headers, params: @params)
+      @http.post
 
       instance_exec &block
     end
@@ -73,13 +51,13 @@ module Oncall
     end
 
     def validate(expected)
-      result = JSON::Validator.validate(expected, @response.body)
-      reporter.json_schema(self, result, expected)
+      result = JSON::Validator.validate(expected, @http.response_body)
+      @reporter.json_schema(self, result, expected)
     end
 
     def status(expected)
-      result = response.code == expected.to_s
-      reporter.status(self, result, expected)
+      result = @http.response_code == expected.to_s
+      @reporter.status(self, result, expected)
     end
   end
 end

data/lib/oncall/http.rb

@@ -0,0 +1,47 @@
+module Oncall
+  class HTTP
+    attr_accessor :path, :headers, :params
+
+    def initialize(path, **opts)
+      @path = path
+      @client = Net::HTTP.new(Oncall.options.host, Oncall.options.port)
+      @headers = opts[:headers] || { 'User-Agent' => "#{Oncall::SCRIPT}/#{Oncall::VERSION}" }
+      @params = opts[:params] || {}
+      @query = opts[:query] || {}
+    end
+
+    def get
+      request = Net::HTTP::Get.new(uri)
+      @response = @client.request(request)
+    end
+
+    def post
+      request = Net::HTTP::Post.new(uri)
+      @response = @client.request(request)
+    end
+
+    def response_body
+      @response.body
+    end
+
+    def response_code
+      @response.code
+    end
+
+    private
+
+    def uri
+      parts = path.split('/')
+      return '/' if parts.empty?
+
+      parts.each_with_index do |part, index|
+        if part.start_with?(':')
+          part[0] = ''
+          parts[index] = params[part.to_sym]
+        end
+      end
+
+      parts.join('/')
+    end
+  end
+end

data/lib/oncall/invocations/base_runner.rb

@@ -0,0 +1,9 @@
+module Oncall
+  module Invocations
+    class BaseRunner
+      def run(_err, _out)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/oncall/invocations/console_runner.rb

@@ -0,0 +1,6 @@
+module Oncall
+  module Invocations
+    class ConsoleRunner < BaseRunner
+    end
+  end
+end

data/lib/oncall/invocations/help_runner.rb

@@ -0,0 +1,15 @@
+module Oncall
+  module Invocations
+    class HelpRunner < BaseRunner
+      attr_reader :parser
+
+      def initialize(parser)
+        @parser = parser
+      end
+
+      def run(_err, out)
+        out.puts parser
+      end
+    end
+  end
+end

data/lib/oncall/invocations/init_runner.rb

@@ -0,0 +1,14 @@
+module Oncall
+  module Invocations
+    class InitRunner < BaseRunner
+      def run(_err, _out)
+        config_template_path = File.join(File.dirname(__FILE__), '..', 'templates', 'oncall.yml.template')
+        template = File.read(config_template_path)
+
+        File.open(File.join(Dir.getwd, 'oncall.yml'), 'w') do |file|
+          file.write(template)
+        end
+      end
+    end
+  end
+end

data/lib/oncall/invocations/test_runner.rb

@@ -0,0 +1,40 @@
+module Oncall
+  module Invocations
+    class TestRunner < BaseRunner
+      def run(err, out)
+        reporter.report do |r|
+          suite.map { |g| g.run(r) }
+        end
+
+        reporter.success? ? 0 : 1
+      end
+
+      private
+
+      def reporter
+        @reporter ||= Oncall::Reporter.new
+      end
+
+      def suite
+        files = []
+
+        test_files.each do |file|
+          test_file = Oncall::TestFile.new(file)
+          files << test_file
+        end
+
+        files
+      end
+
+      def test_files
+        matched_files = Dir.glob(options.pattern)
+        excluded_files = Dir.glob(options.exclude)
+        matched_files - excluded_files
+      end
+
+      def options
+        Oncall.options
+      end
+    end
+  end
+end

data/lib/oncall/invocations/version_runner.rb

@@ -0,0 +1,9 @@
+module Oncall
+  module Invocations
+    class VersionRunner < BaseRunner
+      def run(_err, out)
+        out.puts "#{Oncall::SCRIPT}: v#{Oncall::VERSION}"
+      end
+    end
+  end
+end

data/lib/oncall/options.rb

@@ -1,26 +1,91 @@
 module Oncall
   class Options
-    attr_writer :runner
-    attr_accessor :env,
-                  :pattern,
+    attr_writer :runner, :config, :env
+    attr_accessor :pattern,
                   :exclude,
                   :group,
                   :persist,
-                  :config,
-                  :path
+                  :path,
+                  :verbose,
+                  :host,
+                  :port
 
     def initialize
-      @env = 'develop'
-      @pattern = '**{,/*/**}/*_oncall.rb'
+      @env = nil
+      @pattern = default_pattern
       @exclude = ''
       @group = nil
       @persist = nil
-      @config = nil
       @path = nil
+      @verbose = default_verbosity
+      @host = default_host
+      @port = default_port
     end
 
     def runner
       @runner ||= Oncall::Invocations::TestRunner.new
     end
+
+    def config
+      @config ||= config_default
+    end
+
+    def env
+      @env ||= default_env
+    end
+
+    def parse_config
+      conf_file = load_config_file
+
+      set_default_env conf_file
+      update_options conf_file
+    end
+
+    private
+
+    def update_options(conf_file)
+      raise "Expected env '#{env}' does not exist in config" unless conf_file.key? env
+
+      @domain = conf_file[env]['domain'] if conf_file[env].key? 'domain'
+      @port = conf_file[env]['port'] if conf_file[env].key? 'port'
+    end
+
+    def set_default_env(conf_file)
+      return if @env 
+
+      @env = conf_file['default'] if conf_file.key? 'default'
+    end
+
+    def load_config_file
+      YAML.load_file(config)
+    end
+
+    def default_pattern
+      '**{,/*/**}/*_oncall.rb'
+    end
+
+    def default_env
+      'develop'
+    end
+
+    def default_host
+      'localhost'
+    end
+
+    def default_port
+      3000
+    end
+
+    def default_verbosity
+      false
+    end
+
+    def config_default
+      File.join(Dir.pwd, config_file_name)
+    end
+
+    def config_file_name
+      'oncall.yml'
+    end
   end
 end

data/lib/oncall/test_file.rb

@@ -7,7 +7,7 @@ module Oncall
     end
 
     def run(reporter)
-      Oncall::DSL.new(file, reporter).instance_eval File.read(file)
+      Oncall::DSL.new(self, reporter).instance_eval File.read(file)
     end
   end
 end

data/lib/oncall/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Oncall
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oncall
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Koen Woortman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-08 00:00:00.000000000 Z
+date: 2019-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -56,16 +56,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -92,9 +92,14 @@ files:
 - bin/oncall
 - lib/oncall.rb
 - lib/oncall/cli.rb
-- lib/oncall/config.rb
 - lib/oncall/dsl.rb
-- lib/oncall/invocations.rb
+- lib/oncall/http.rb
+- lib/oncall/invocations/base_runner.rb
+- lib/oncall/invocations/console_runner.rb
+- lib/oncall/invocations/help_runner.rb
+- lib/oncall/invocations/init_runner.rb
+- lib/oncall/invocations/test_runner.rb
+- lib/oncall/invocations/version_runner.rb
 - lib/oncall/options.rb
 - lib/oncall/reporter.rb
 - lib/oncall/templates/oncall.yml.template

data/lib/oncall/config.rb

@@ -1,4 +0,0 @@
-module Oncall
-  class Config
-  end
-end

data/lib/oncall/invocations.rb

@@ -1,73 +0,0 @@
-module Oncall
-  module Invocations
-    class ConsoleRunner
-      def run(err, out); end
-    end
-
-    class HelpRunner
-      attr_reader :parser
-
-      def initialize(parser)
-        @parser = parser
-      end
-
-      def run(err, out)
-        out.puts parser
-      end
-    end
-
-    class InitRunner
-      def run(err, out)
-        config_template_path = File.join(File.dirname(__FILE__), 'templates', 'oncall.yml.template')
-        template = File.read(config_template_path)
-
-        File.open(File.join(Dir.getwd, 'oncall.yml'), 'w') do |file|
-          file.write(template)
-        end
-      end
-    end
-
-    class VersionRunner
-      def run(err, out)
-        out.puts "Oncall: v#{Oncall::VERSION}"
-      end
-    end
-
-    class TestRunner
-      def run(err, out)
-        reporter.report do |r|
-          suite.map { |g| g.run(r) }
-        end
-
-        reporter.success? ? 0 : 1
-      end
-
-      private
-
-      def reporter
-        @reporter ||= Oncall::Reporter.new
-      end
-
-      def suite
-        files = []
-
-        test_files.each do |file|
-          test_file = Oncall::TestFile.new(file)
-          files << test_file
-        end
-
-        files
-      end
-
-      def test_files
-        matched_files = Dir.glob(options.pattern)
-        excluded_files = Dir.glob(options.exclude)
-        matched_files - excluded_files
-      end
-
-      def options
-        Oncall.options
-      end
-    end
-  end
-end