boechat 0.0.1 → 0.1.0.pre.RC1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 666155b02a02293152a1fe3ab9f25517f47c4795224d33b0e1124d2a31adb219
-  data.tar.gz: 630e27e95ce5160648c4d4a31efa9580146ec89a9d55770b40ab2da85f85d623
+  metadata.gz: 60b8e03cd088bd8ac98206d892f0c9b4ade7809caaf2d7cc718f618ac6b332d8
+  data.tar.gz: dbe45040d76298c1583178cdb60b077b194254d8c433e9bd5ebb5595f7016f12
 SHA512:
-  metadata.gz: b6637c22a3f0b67c59af54032c45c120ad972179a3298b996584d12c609ddd6a2898e2a1a887e693c3531076423a196a3b61777ad220ead863bae7554814b70f
-  data.tar.gz: 1e79404dfd944972e195215b459ae3c41e4369a8b9b930f1210dcc1740e88f250878b750d2a04a47647c627c1464027c357a693b86f23c90f6c0fe04c2912c6d
+  metadata.gz: a41626ca7550fa8a479f4be057e5d5c696424ba808d7c8b2cd2719c09af6ba92674706d0ba5532da46f57e8014f9e026ffcd7894f5b4ed8a5a7bc4ff91fb0346
+  data.tar.gz: 1798b02cc56eff1c2824a6b0728b55d3c734c37ac066a34ab71292d71b7128c5ff3d560e8cd6b1b0c77e840a69cd53eef0140f3de58574b312fb4f5f2717b7cd

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+.yardoc
+doc/**/*

data/Gemfile.lock

@@ -3,8 +3,8 @@ PATH
   specs:
     boechat (0.0.1)
       dry-validation (~> 0.11.1)
-      oj (~> 3.5.0)
-      typhoeus (~> 1.3.0)
+      oj (~> 3.5)
+      typhoeus (~> 1.3)
 
 GEM
   remote: https://rubygems.org/
@@ -43,7 +43,6 @@ GEM
       dry-equalizer (~> 0.2)
       dry-logic (~> 0.4, >= 0.4.0)
       dry-types (~> 0.12.0)
-    dry-validation-matchers (0.4.0)
     ethon (0.11.0)
       ffi (>= 1.3.0)
     ffi (1.9.23)
@@ -89,6 +88,7 @@ GEM
     typhoeus (1.3.0)
       ethon (>= 0.9.0)
     unicode-display_width (1.3.2)
+    yard (0.9.12)
 
 PLATFORMS
   ruby
@@ -98,13 +98,13 @@ DEPENDENCIES
   bundler (~> 1.16)
   codeclimate-test-reporter
   dry-validation
-  dry-validation-matchers (~> 0.4.0)
   pry
   rake (~> 10.0)
   rspec (~> 3.0)
   rubocop
   simplecov
   typhoeus
+  yard (~> 0.9)
 
 BUNDLED WITH
    1.16.1

data/TODO.md

@@ -2,5 +2,7 @@
 
 + [DONE] Create Result class to store the result after call each request
 + [DONE] Define boechat.yml expected format and adapt config classes
++ [DONE] Fix call for multiple services, that don't run the requesters when using Typhoeus Hydra...
++ [WIP ] Refactor version validation
 + [WIP ] Write tests for Core classes
-+ [    ] Fix call for multiple services, that have error with Typhoeus Hydra...
++ [WIP ] Document the project with YARD

data/bin/boechat

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/boechat_core'
+require_relative '../lib/boechat/core/command_runner'
+
+aliases = { 'v' => 'verify', 'c' => 'console' }
+
+command = ARGV.first
+Boechat::Core::CommandRunner.call(aliases[command] || command)

data/boechat.gemspec

@@ -4,6 +4,7 @@ lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'boechat/internal/version'
 
+# rubocop:disable Metrics/BlockLength
 Gem::Specification.new do |spec|
   spec.name          = 'boechat'
   spec.version       = Boechat::Internal::VERSION
@@ -26,10 +27,11 @@ Gem::Specification.new do |spec|
   # rubocop:enable Style/GuardClause
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|bin)/}) }
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir        = 'bin'
+  spec.executables   = ['boechat']
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.5.0'
+  spec.metadata['yard.run'] = 'yri'
 
   # Dependencies that your gem needs at runtime
   spec.add_runtime_dependency 'dry-validation', '~> 0.11.1'
@@ -40,4 +42,6 @@ Gem::Specification.new do |spec|
   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 'yard', '~> 0.9'
 end
+# rubocop:enable Metrics/BlockLength

data/config/boechat.yml

@@ -3,8 +3,8 @@ services:
   - name: empresas
     base_url: http://empresasservice.ad.vagastec.com.br
     status_endpoint: status
-    http_verb: get
+    version: '>= 1.15.0'
   - name: processos
     base_url: http://qa-processosseletivosservice.ad.vagastec.com.br
     status_endpoint: healthcheck
-    http_verb: get
+    version: '> 1.14.0'

data/lib/boechat/core.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 require 'boechat/internal/version'
+require 'boechat/core/service/verifier'
+require 'pry'
 
 # :nodoc:
-module MyGem
+module Boechat
   # :nodoc:
   module Core
   end

data/lib/boechat/core/command_runner.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative './service/verifier'
+
+module Boechat
+  module Core
+    # Class responsible for run the commands passed to the boechat binary
+    class CommandRunner
+      def self.call(command)
+        if command == 'verify'
+          puts '-' * 80
+          puts 'Version Verification Result'
+          puts Boechat::Core::Service::Verifier.new.call.result
+          puts '-' * 80
+        else # runs help for help itself and any other not recognized command
+          puts "\nUSAGE:"
+          puts '  boechat [COMMAND]'
+          puts "\nCOMMANDS:"
+          puts '  h, help          # Shows help instructions'
+          puts "  v, verify        # Verifies versions of all services contained in boachat.yml file\n"
+        end
+      end
+    end
+  end
+end

data/lib/boechat/core/config/schema_validator.rb

@@ -12,8 +12,8 @@ module Boechat
             schema do
               required('name').filled(:str?)
               required('base_url').filled(:str?)
+              required('version').filled(:str?)
               optional('status_endpoint').filled(:str?)
-              optional('http_verb').filled(included_in?: %w[get post])
             end
           end
         end

data/lib/boechat/core/service/request_list.rb

@@ -1,34 +1,39 @@
 # frozen_string_literal: true
 
+require 'typhoeus'
+
 module Boechat
   module Core
     module Service
-      # Class to save all user request objects to execute them one at a time or all in parallel
+      # Class to save all user Requester objects to execute them one at a time or all in parallel
       class RequestList
-        attr_reader :requests
+        attr_reader :requesters
 
-        def initialize(requests = {})
-          @requests = requests
+        def initialize(requesters = {})
+          @requesters = requesters
         end
 
-        def call(request_identifier = nil)
-          if request_identifier.nil?
+        # @todo Add support for multiple HTTP Clients with parallel requests
+        #   Initially only Typhoeus HTTP client is supported for make multiple API calls in parallel.
+        #   It will be good to support other clients, as the user wants to configure
+        def call(requester_identifier = nil)
+          if requester_identifier.nil?
             hydra = Typhoeus::Hydra.hydra
-            requests.each_pair { |_key, request| hydra.queue(request.call) }
+            requesters.each_pair { |_key, requester| hydra.queue(requester.request) }
             hydra.run
-          elsif requests.key?(request_identifier)
-            requests[request_identifier].call
+          elsif requesters.key?(requester_identifier)
+            requesters[requester_identifier].call
           end
 
           self
         end
 
         def []=(key, requester)
-          requests[key] = requester
+          requesters[key] = requester
         end
 
         def [](key)
-          requests[key]
+          requesters[key]
         end
       end
     end

data/lib/boechat/core/service/requester.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative '../../internal/string_extensions'
+require_relative 'result'
+require_relative 'response_handler'
+require 'typhoeus'
+
+module Boechat
+  module Core
+    # Module to group all classes related to the Request/Response/Validation cycle
+    module Service
+      using StringExtensions
+
+      # Class responsible for make the request to one service
+      class Requester
+        attr_reader :request, :response, :result, :service_uri, :parameters, :body, :headers
+        BASIC_HEADER = { 'User-Agent' => 'Boechat - API Version Verifier' }.freeze
+
+        def initialize(service_uri, parameters: nil, body: nil, headers: nil)
+          @service_uri = service_uri
+          @parameters = parameters
+          @body = body
+          @headers = headers
+          @request = Typhoeus::Request.new(@service_uri, method: :get, params: @parameters,
+                                                         body: @body, headers: http_header)
+          @request.on_complete do |res|
+            @response = res
+            @result = Result.new(ResponseHandler.call(res))
+          end
+        end
+
+        def call
+          @request.run
+        end
+
+        private
+
+        def http_header
+          return BASIC_HEADER.merge(@headers) if @headers
+          BASIC_HEADER
+        end
+      end
+    end
+  end
+end

data/lib/boechat/core/service/response_handler.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'oj'
+require 'json'
+require_relative '../../internal/string_extensions'
+
+module Boechat
+  module Core
+    # Module to group all classes related to the Request/Response/Validation cycle
+    module Service
+      using StringExtensions
+
+      # Class responsible for handle the response after Request has been called
+      class ResponseHandler
+        HTTP_UNPROCESSABLE_ENTITY = 422
+
+        class << self
+          def call(response)
+            raise ArgumentError, 'Argument must respond to :body and :code' unless valid_response(response)
+            body = response.body
+
+            return response_error(response) if body.empty?
+            return response_invalid_format unless body.valid_json?
+            Oj.load(body, symbol_keys: true).merge(status: response.code)
+          end
+
+          private
+
+          def valid_response(response)
+            response.respond_to?(:body) && response.respond_to?(:code)
+          end
+
+          def response_error(response)
+            code = response.code
+
+            case code
+            when 404
+              Oj.load({ error: 'Not Found', status: code }.to_json, symbol_keys: true)
+            when 500
+              Oj.load({ error: 'Service Internal Error', status: code }.to_json, symbol_keys: true)
+            else
+              Oj.load({ error: 'Service Unexpected Error', status: code }.to_json, symbol_keys: true)
+            end
+          end
+
+          def response_invalid_format
+            Oj.load({ error: 'Invalid JSON format', status: HTTP_UNPROCESSABLE_ENTITY }.to_json, symbol_keys: true)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/boechat/core/service/result.rb

@@ -14,11 +14,14 @@ module Boechat
         end
 
         def success?
-          @parsed_response && @parsed_response[:status] < 400
+          @parsed_response &&
+            @parsed_response[:status].positive? &&
+            @parsed_response[:status] < 400
         end
 
         def failure?
-          @parsed_response && @parsed_response[:status] >= 400
+          @parsed_response.nil? ||
+            (@parsed_response[:status].zero? || @parsed_response[:status] >= 400)
         end
       end
     end

data/lib/boechat/core/service/verifier.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require_relative './request'
+require_relative './requester'
 require_relative './request_list'
+require_relative './verifier_result'
 require_relative '../config/reader'
 require 'typhoeus'
 require 'json'
@@ -11,27 +12,37 @@ module Boechat
     module Service
       # Class responsible for call the endpoints and return all the results
       class Verifier
-        attr_reader :config, :request_list
+        attr_reader :config, :request_list, :result
 
         def initialize
-          @config = ConfigReader.new.call.config
+          @config = Config::Reader.new.call.config
+          @request_list = RequestList.new
           build_request_list
         end
 
         def call(service = nil)
           @request_list.call(service)
+          @result = VerifierResult.call(self)
+
+          self
         end
 
         private
 
         def build_request_list
-          @request_list = RequestList.new
+          @config['services'].each_with_index do |service, index|
+            identifier = service['name'] || index.to_s
+            url = build_url(service)
 
-          @config['services'].each do |service|
-            key, value = service.first
-            @request_list.requests[key] = Request.new(value['url'])
+            @request_list.requesters[identifier] = Requester.new(url)
           end
         end
+
+        def build_url(service)
+          base_url = service['base_url']
+          url = base_url.end_with?('/') ? base_url : "#{base_url}/"
+          "#{url}#{service['status_endpoint']}"
+        end
       end
     end
   end

data/lib/boechat/core/service/verifier_result.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative './requester'
+require_relative './request_list'
+require_relative '../../internal/errors'
+require 'typhoeus'
+require 'json'
+
+module Boechat
+  module Core
+    module Service
+      # Class responsible for call the endpoints and return all the results
+      class VerifierResult
+        include Internal
+
+        attr_reader :verifier, :output
+
+        class << self
+          def call(verifier)
+            raise BoechatError, "Verifier class expected, given #{verifier.class}." unless verifier.class == Verifier
+            @verifier = verifier
+            @output = []
+
+            @verifier.request_list.requesters.each_pair do |key, requester|
+              next unless requester.result
+              @output << { name: key,
+                           parsed_response: requester.result.parsed_response,
+                           valid_version: validate_response_version(key) }
+            end
+
+            @output
+          end
+
+          private
+
+          def validate_response_version(requester_identifier)
+            service_config = get_service_config(requester_identifier)
+            current_version = get_service_current_version(requester_identifier)
+
+            operator, required_version = service_config['version'].split(' ')
+
+            current_version.send(operator.to_sym, required_version)
+          end
+
+          def get_service_config(requester_identifier)
+            services = @verifier.config['services'].select do |service|
+              service['name'] == requester_identifier
+            end
+            services.first
+          end
+
+          def get_service_current_version(requester_identifier)
+            @verifier.request_list[requester_identifier].result.parsed_response[:tag_versao]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/boechat/internal/errors.rb

@@ -3,7 +3,13 @@
 module Boechat
   module Internal
     # Custom error class
+    #
+    # @author Danilo Barion Nogueira
+    # @since 0.0.1
     class BoechatError < StandardError
+      # Constructor
+      #
+      # @param message [Object] Error message
       def initialize(message)
         super(message.to_s)
       end

data/lib/boechat/internal/version.rb

@@ -2,6 +2,6 @@
 
 module Boechat
   module Internal
-    VERSION = '0.0.1'
+    VERSION = '0.1.0-RC1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boechat
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0.pre.RC1
 platform: ruby
 authors:
 - Danilo Barion Nogueira
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2018-05-02 00:00:00.000000000 Z
+date: 2018-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-validation
@@ -94,13 +94,29 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: Verify the version of external APIs that your project depends on!
 email:
 - danilo.barion@gmail.com
-executables: []
+executables:
+- boechat
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
 - CHANGELOG.md
@@ -110,16 +126,20 @@ files:
 - README.md
 - Rakefile
 - TODO.md
+- bin/boechat
 - boechat.gemspec
 - config/boechat.yml
 - lib/boechat/core.rb
+- lib/boechat/core/command_runner.rb
 - lib/boechat/core/config/reader.rb
 - lib/boechat/core/config/schema_validator.rb
 - lib/boechat/core/config/wrapper.rb
-- lib/boechat/core/service/request.rb
 - lib/boechat/core/service/request_list.rb
+- lib/boechat/core/service/requester.rb
+- lib/boechat/core/service/response_handler.rb
 - lib/boechat/core/service/result.rb
 - lib/boechat/core/service/verifier.rb
+- lib/boechat/core/service/verifier_result.rb
 - lib/boechat/internal/constants.rb
 - lib/boechat/internal/errors.rb
 - lib/boechat/internal/string_extensions.rb
@@ -130,6 +150,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
+  yard.run: yri
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -141,9 +162,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.3

data/lib/boechat/core/service/request.rb

@@ -1,76 +0,0 @@
-# frozen_string_literal: true
-
-require 'oj'
-require_relative '../../internal/string_extensions'
-require_relative 'result'
-
-module Boechat
-  module Core
-    # Module to group all classes related to the Request/Response/Validation cycle
-    module Service
-      using StringExtensions
-
-
-      # Class responsible for make the request to one service
-      class Request
-        attr_reader :request, :response, :result, :service_uri, :verb, :parameters, :body, :headers
-        HTTP_UNPROCESSABLE_ENTITY = 422
-        BASIC_HEADER = { 'User-Agent' => 'Boechat - API Version Verifier' }
-
-        def initialize(service_uri, verb: :get, parameters: nil, body: nil, headers: nil)
-          @service_uri = service_uri
-          @verb = verb
-          @parameters = parameters
-          @body = body
-          @headers = headers
-          @request = Typhoeus::Request.new(@service_uri, method: @verb, params: @parameters,
-                                                         body: @body, headers: http_header)
-        end
-
-        def call
-          handle_request
-        end
-
-        private
-
-        def http_header
-          return BASIC_HEADER.merge(@headers) if @headers
-          BASIC_HEADER
-        end
-
-        def handle_request
-          @request.on_complete do |res|
-            @response = res
-            @result = Result.new(valid_response(res))
-          end
-          @request.run
-        end
-
-        def valid_response(response)
-          body = response.body
-
-          return response_error(response) if body.empty?
-          return response_invalid_format unless body.valid_json?
-          Oj.load(body, symbol_keys: true).merge(status: response.code)
-        end
-
-        def response_error(response)
-          code = response.code
-
-          case code
-          when 404
-            Oj.load({ error: 'Not Found', code: code }.to_json, symbol_keys: true)
-          when 500
-            Oj.load({ error: 'Service Internal Error', code: code }.to_json, symbol_keys: true)
-          else
-            Oj.load({ error: 'Service Unexpected Error', code: code }.to_json, symbol_keys: true)
-          end
-        end
-
-        def response_invalid_format
-          Oj.load({ error: 'Invalid JSON format', status: HTTP_UNPROCESSABLE_ENTITY }.to_json)
-        end
-      end
-    end
-  end
-end