boechat 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 666155b02a02293152a1fe3ab9f25517f47c4795224d33b0e1124d2a31adb219
+  data.tar.gz: 630e27e95ce5160648c4d4a31efa9580146ec89a9d55770b40ab2da85f85d623
+SHA512:
+  metadata.gz: b6637c22a3f0b67c59af54032c45c120ad972179a3298b996584d12c609ddd6a2898e2a1a887e693c3531076423a196a3b61777ad220ead863bae7554814b70f
+  data.tar.gz: 1e79404dfd944972e195215b459ae3c41e4369a8b9b930f1210dcc1740e88f250878b750d2a04a47647c627c1464027c357a693b86f23c90f6c0fe04c2912c6d

data/.rubocop.yml

@@ -0,0 +1,32 @@
+AllCops:
+  TargetRubyVersion: '2.5'
+
+Lint/UselessAssignment:
+  Exclude:
+    - 'lib/boechat/internal/version.rb'
+
+Metrics/LineLength:
+  Max: 120
+  Exclude:
+    - '**/*_spec.rb'
+
+Metrics/ModuleLength:
+  Exclude:
+    - '**/*_spec.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - '**/*_spec.rb'
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: nested
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+
+Lint/HandleExceptions:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0@boechat

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# v0.0.1 (<release date here>)
+
+Initial release

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'dry-validation'
+gem 'typhoeus'
+
+group :test do
+  gem 'codeclimate-test-reporter', require: false
+  gem 'simplecov', require: false
+end
+
+group :tools do
+  gem 'pry'
+  gem 'rubocop'
+end

data/Gemfile.lock

@@ -0,0 +1,110 @@
+PATH
+  remote: .
+  specs:
+    boechat (0.0.1)
+      dry-validation (~> 0.11.1)
+      oj (~> 3.5.0)
+      typhoeus (~> 1.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    codeclimate-test-reporter (1.0.8)
+      simplecov (<= 0.13)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    dry-configurable (0.7.0)
+      concurrent-ruby (~> 1.0)
+    dry-container (0.6.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.4.5)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.2.1)
+    dry-logic (0.4.2)
+      dry-container (~> 0.2, >= 0.2.6)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-types (0.12.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1)
+      dry-container (~> 0.3)
+      dry-core (~> 0.2, >= 0.2.1)
+      dry-equalizer (~> 0.2)
+      dry-logic (~> 0.4, >= 0.4.2)
+      inflecto (~> 0.0.0, >= 0.0.2)
+    dry-validation (0.11.1)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+      dry-core (~> 0.2, >= 0.2.1)
+      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)
+    inflecto (0.0.2)
+    json (2.1.0)
+    method_source (0.9.0)
+    oj (3.5.1)
+    parallel (1.12.1)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.55.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    simplecov (0.13.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+    unicode-display_width (1.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  boechat!
+  bundler (~> 1.16)
+  codeclimate-test-reporter
+  dry-validation
+  dry-validation-matchers (~> 0.4.0)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+  simplecov
+  typhoeus
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nikita Shilnikov
+
+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,7 @@
+## Boechat
+
+Version verifier for BFFs and APIs.
+
+[WIP] Verify the version of external APIs that your project depends on!
+
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/TODO.md

@@ -0,0 +1,6 @@
+## TODO's
+
++ [DONE] Create Result class to store the result after call each request
++ [DONE] Define boechat.yml expected format and adapt config classes
++ [WIP ] Write tests for Core classes
++ [    ] Fix call for multiple services, that have error with Typhoeus Hydra...

data/boechat.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'boechat/internal/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'boechat'
+  spec.version       = Boechat::Internal::VERSION
+  spec.authors       = ['Danilo Barion Nogueira']
+  spec.email         = ['danilo.barion@gmail.com']
+
+  spec.summary       = 'Version verifier for BFFs and APIs'
+  spec.description   = 'Verify the version of external APIs that your project depends on!'
+  spec.homepage      = 'https://github.com/danilobarion1986/boechat'
+  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.
+  # rubocop:disable Style/GuardClause
+  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
+  # 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.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.5.0'
+
+  # Dependencies that your gem needs at runtime
+  spec.add_runtime_dependency 'dry-validation', '~> 0.11.1'
+  spec.add_runtime_dependency 'oj', '~> 3.5'
+  spec.add_runtime_dependency 'typhoeus', '~> 1.3'
+
+  # Dependencies that your gem needs only for development
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/config/boechat.yml

@@ -0,0 +1,10 @@
+# Describe all API healthcheck/status endpoints's that your application depends on!
+services:
+  - name: empresas
+    base_url: http://empresasservice.ad.vagastec.com.br
+    status_endpoint: status
+    http_verb: get
+  - name: processos
+    base_url: http://qa-processosseletivosservice.ad.vagastec.com.br
+    status_endpoint: healthcheck
+    http_verb: get

data/lib/boechat/core.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'boechat/internal/version'
+
+# :nodoc:
+module MyGem
+  # :nodoc:
+  module Core
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require_relative 'wrapper'
+require_relative 'schema_validator'
+
+module Boechat
+  module Core
+    module Config
+      # Class responsible for read the boechat.yml file, that describes all endpoints to call
+      class Reader
+        attr_reader :config_path
+
+        def initialize
+          app_root = Pathname.new(File.expand_path('../../../../', __dir__))
+          @config_path = File.join(app_root, 'config', 'boechat.yml')
+        end
+
+        def call
+          result = validate_config_schema
+          output = result.success? ? result.output : {}
+          Wrapper.new(output, result.errors)
+        end
+
+        private
+
+        def validate_config_schema
+          SchemaValidator.call(File.read(@config_path))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'dry-validation'
+
+module Boechat
+  module Core
+    module Config
+      # Class responsible for validate the schema of the boechat.yml configuration file
+      class SchemaValidator
+        CONFIG_SCHEMA = Dry::Validation.Schema do
+          required('services').each do
+            schema do
+              required('name').filled(:str?)
+              required('base_url').filled(:str?)
+              optional('status_endpoint').filled(:str?)
+              optional('http_verb').filled(included_in?: %w[get post])
+            end
+          end
+        end
+
+        def self.call(config)
+          CONFIG_SCHEMA.call(YAML.safe_load(config))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Boechat
+  module Core
+    module Config
+      # Class responsible for save all configurations readed from boechat.yml file
+      class Wrapper
+        attr_reader :config, :errors
+
+        def initialize(config, errors)
+          @config = config
+          @errors = errors
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+# 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

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+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 RequestList
+        attr_reader :requests
+
+        def initialize(requests = {})
+          @requests = requests
+        end
+
+        def call(request_identifier = nil)
+          if request_identifier.nil?
+            hydra = Typhoeus::Hydra.hydra
+            requests.each_pair { |_key, request| hydra.queue(request.call) }
+            hydra.run
+          elsif requests.key?(request_identifier)
+            requests[request_identifier].call
+          end
+
+          self
+        end
+
+        def []=(key, requester)
+          requests[key] = requester
+        end
+
+        def [](key)
+          requests[key]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'oj'
+
+module Boechat
+  module Core
+    module Service
+      # Class responsible for store the response of the Request class
+      class Result
+        attr_reader :parsed_response
+
+        def initialize(parsed_response)
+          @parsed_response = parsed_response
+        end
+
+        def success?
+          @parsed_response && @parsed_response[:status] < 400
+        end
+
+        def failure?
+          @parsed_response && @parsed_response[:status] >= 400
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative './request'
+require_relative './request_list'
+require_relative '../config/reader'
+require 'typhoeus'
+require 'json'
+
+module Boechat
+  module Core
+    module Service
+      # Class responsible for call the endpoints and return all the results
+      class Verifier
+        attr_reader :config, :request_list
+
+        def initialize
+          @config = ConfigReader.new.call.config
+          build_request_list
+        end
+
+        def call(service = nil)
+          @request_list.call(service)
+        end
+
+        private
+
+        def build_request_list
+          @request_list = RequestList.new
+
+          @config['services'].each do |service|
+            key, value = service.first
+            @request_list.requests[key] = Request.new(value['url'])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/boechat/internal/constants.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Boechat
+  module Internal
+    # A list of constants you can use to avoid memory allocations or identity checks.
+    #
+    # @example Just include this module to your class or module
+    #   class Foo
+    #     include Boechat::Internal::Constants
+    #
+    #     def call(value = EMPTY_ARRAY)
+    #        value.map(&:to_s)
+    #     end
+    #   end
+    module Constants
+      # Source: https://github.com/semver/semver/issues/232
+      # rubocop:disable Metrics/LineLength
+      REGEX_SEMVER_FORMAT = /^(v\d*|0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(-(0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(\.(0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*)?(\+[0-9a-zA-Z-]+(\.[0-9a-zA-Z-]+)*)?$/
+      # rubocop:enable Metrics/LineLength
+    end
+  end
+end

data/lib/boechat/internal/errors.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Boechat
+  module Internal
+    # Custom error class
+    class BoechatError < StandardError
+      def initialize(message)
+        super(message.to_s)
+      end
+    end
+  end
+end

data/lib/boechat/internal/string_extensions.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Module for safely include methods in String built-in class
+module StringExtensions
+  refine String do
+    # Verifies if the string is a valid JSON format
+    # If valid, returns true; otherwise false
+    def valid_json?
+      JSON.parse(self)
+      true
+    rescue JSON::ParserError
+      false
+    end
+  end
+end

data/lib/boechat/internal/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Boechat
+  module Internal
+    VERSION = '0.0.1'
+  end
+end

data/lib/boechat_core.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'boechat/core'

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: boechat
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Danilo Barion Nogueira
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: Verify the version of external APIs that your project depends on!
+email:
+- danilo.barion@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO.md
+- boechat.gemspec
+- config/boechat.yml
+- lib/boechat/core.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/result.rb
+- lib/boechat/core/service/verifier.rb
+- lib/boechat/internal/constants.rb
+- lib/boechat/internal/errors.rb
+- lib/boechat/internal/string_extensions.rb
+- lib/boechat/internal/version.rb
+- lib/boechat_core.rb
+homepage: https://github.com/danilobarion1986/boechat
+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: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Version verifier for BFFs and APIs
+test_files: []