middleware_healthcheck 0.2.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3385631d49a7b374953f938aa58f350c5a2acf1c4a37ecc0a2bf8ab410315b09
-  data.tar.gz: a50a238151aa178562a3041f857009699354ab262fa93b5a4ec9c2787e7ed5b3
+  metadata.gz: a4e32074ef167d6ba91fcec3f586e7487e8aa9525ca4154e1e7854b93c0a62da
+  data.tar.gz: 32c3b688afeb072d3e4947511da57ac026acb8d5d1509cc1ed6897f87a9db558
 SHA512:
-  metadata.gz: d2b8ca12641253a4b7cdb3e8121c7a9d55d5879bfd424bb5bc74ae3d7c03beddd978a17e5d191f099dd54b72704b8d9c7d727193272b2cca66e1890c496bb6d7
-  data.tar.gz: 7010aab4e04ee708bde55d91b9f78f6074739fc760ac7c6e4898850776a0be73c7e3e9184e2295277ddd2dc72f7a4aa2d0036030c57615252d75d98e08228c19
+  metadata.gz: f8ec32c894e203ca994edfcca94dc5e7e5a32c4404b49f0af63ef16072395be17f2cc4b6d833a4553919a12ed112153f432d025f0a8804c59b02a36f4358a567
+  data.tar.gz: 0f9712ec4a409c7f48b2f048d5cb0da0a23f2795b2755c555443314bad473072082ad7b82e9e253a0071f2299717e44c3d84fab1dc42b93112943ffc0cb7f614

data/CHANGELOG.md

@@ -0,0 +1,39 @@
+# Changelog
+
+## [Unreleased]
+
+## [1.0.0] - 2019-04-03
+
+### Added
+- Add Rubocop and address various offences
+- Add CHANGELOG.md and CODE_OF_CONDUCT.md
+- Add contributors in README.md
+
+### Fixed
+- Fix gemspec's gem dependencies
+
+## [0.2.2] - 2019-04-02
+### Changed
+- Update docs
+
+### Fixed
+- Fix gemspec
+
+## [0.2.1] - 2019-03-21
+### Added
+- Dockerize project
+- Add more docs
+
+## [0.2.0] - 2017-03-08
+### Added
+- Add basic specs
+- Add gem configuration feature
+- User can add custom checkers
+
+### Changed
+- Update gems
+- DB connection checked by default
+
+## [0.1.0] - 2017-02-16
+### Added
+- Initial files for the gem

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/CONTRIBUTING.md

@@ -0,0 +1,48 @@
+# Introduction
+
+Thank you for considering contributing to this project!
+
+Any kind of contributions will be appreciated, from improving the documentation,
+submitting bug reports and feature requests or writing useful checks.
+
+# Ground Rules
+
+* Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get feedback.
+* Keep pull requests as small as possible, preferably one new feature per pull request.
+
+# Your First Contribution
+
+Unsure where to begin contributing? Here you have some ideas:
+
+* documentation is always welcome
+* check the pending issues
+* write useful checks
+
+# Getting started
+
+1. Clone the repository if you have commit rights or create your own fork otherwise
+1. Create your Feature Branch (git checkout -b feature/AmazingFeature)
+1. Commit your Changes (git commit -m 'Add some AmazingFeature)
+1. Push to the Branch (git push origin feature/AmazingFeature)
+1. Open a Pull Request
+
+Be sure you have followed the code style for the project.
+
+# How to report a bug
+
+If you find a security vulnerability, do NOT open an issue. Email security@firefield.com instead.
+
+When filing an issue, make sure to answer these questions:
+
+1. What did you do?
+1. What did you expect to see?
+1. What did you see instead?
+
+# How to suggest a feature or enhancement
+
+Open an issue on our issues list which describes the feature you would like to
+see, why you need it, and how it should work.
+
+# Code review process
+
+The core team looks at Pull Requests on a regular basis. After feedback has been given we expect responses within two weeks. After two weeks we may close the pull request if it isn't showing any activity.

data/Dockerfile

@@ -0,0 +1,14 @@
+FROM ruby:2.6.1-alpine3.9
+
+LABEL maintainer="devops@firefield.com"
+
+RUN apk add --no-cache --update build-base linux-headers
+RUN apk add --no-cache --update git file
+RUN apk add --no-cache --update sqlite sqlite-dev
+
+ENV APP_PATH /usr/src/app
+WORKDIR $APP_PATH
+
+COPY . .
+
+RUN bundle install --jobs `expr $(cat /proc/cpuinfo | grep -c "cpu cores") - 1` --retry 3

data/Gemfile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in middleware_healthcheck.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]
+
+group :development, :test do
+  gem 'rubocop'
+  gem 'tzinfo-data'
+end

data/Gemfile.lock

@@ -0,0 +1,167 @@
+PATH
+  remote: .
+  specs:
+    middleware_healthcheck (1.0.0)
+      rails (>= 4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.0.2)
+      actionpack (= 5.0.2)
+      nio4r (>= 1.2, < 3.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.0.2)
+      actionpack (= 5.0.2)
+      actionview (= 5.0.2)
+      activejob (= 5.0.2)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.0.2)
+      actionview (= 5.0.2)
+      activesupport (= 5.0.2)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.2)
+      activesupport (= 5.0.2)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.0.2)
+      activesupport (= 5.0.2)
+      globalid (>= 0.3.6)
+    activemodel (5.0.2)
+      activesupport (= 5.0.2)
+    activerecord (5.0.2)
+      activemodel (= 5.0.2)
+      activesupport (= 5.0.2)
+      arel (~> 7.0)
+    activesupport (5.0.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (7.1.4)
+    ast (2.4.0)
+    builder (3.2.3)
+    byebug (9.0.6)
+    coderay (1.1.1)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    erubis (2.7.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (0.8.1)
+    jaro_winkler (1.5.2)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    method_source (0.8.2)
+    mini_mime (1.0.1)
+    mini_portile2 (2.1.0)
+    minitest (5.10.1)
+    nio4r (2.3.1)
+    nokogiri (1.7.0.1)
+      mini_portile2 (~> 2.1.0)
+    parallel (1.17.0)
+    parser (2.6.2.0)
+      ast (~> 2.4.0)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.4.2)
+      byebug (~> 9.0)
+      pry (~> 0.10)
+    psych (3.1.0)
+    rack (2.0.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.0.2)
+      actioncable (= 5.0.2)
+      actionmailer (= 5.0.2)
+      actionpack (= 5.0.2)
+      actionview (= 5.0.2)
+      activejob (= 5.0.2)
+      activemodel (= 5.0.2)
+      activerecord (= 5.0.2)
+      activesupport (= 5.0.2)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 5.0.2)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.2)
+      activesupport (>= 4.2.0, < 6.0)
+      nokogiri (~> 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.0.2)
+      actionpack (= 5.0.2)
+      activesupport (= 5.0.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rainbow (3.0.0)
+    rake (12.0.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-rails (3.5.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.66.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.10.0)
+    slop (3.6.0)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.3.13)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    tzinfo-data (1.2018.9)
+      tzinfo (>= 1.0.0)
+    unicode-display_width (1.5.0)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  middleware_healthcheck!
+  pry-byebug (~> 3.4)
+  rspec-rails (~> 3.5)
+  rubocop
+  sqlite3 (~> 1.3)
+  tzinfo-data
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -94,7 +94,7 @@ Your Custom Checker class should look like this:
 ```ruby
 class MyCustomChecker
   attr_accessor :error
- 
+
   def initialize(_app, _env)
   end
 
@@ -120,6 +120,11 @@ in initializer.
 
 # Contributing
 
+Contributors:
+- Adam Wieczorkowski adam.wieczorkowski@naturaily.com
+- Claudio Perez Gamayo claudio@firefield.com
+- Jan Wieczorkowski jan.wieczorkowski@naturaily.com
+
 Use the provided dockerized development environment. For more information check the [CONTRIBUTING](CONTRIBUTING.md) file.
 
 ## Development

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -14,10 +16,4 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-
-
-
-
-
 require 'bundler/gem_tasks'
-

data/lib/middleware_healthcheck.rb

@@ -1,12 +1,14 @@
-require "middleware_healthcheck/rails" if defined? Rails::Railtie
-require "middleware_healthcheck/default_checkers"
-require "middleware_healthcheck/configuration"
-require "middleware_healthcheck/main_checker"
-require "middleware_healthcheck/middleware"
+# frozen_string_literal: true
+
+require 'middleware_healthcheck/rails' if defined? Rails::Railtie
+require 'middleware_healthcheck/default_checkers'
+require 'middleware_healthcheck/configuration'
+require 'middleware_healthcheck/main_checker'
+require 'middleware_healthcheck/middleware'
 
 module MiddlewareHealthcheck
   class << self
-    attr_accessor :configuration
+    cattr_writer :configuration
 
     def configuration
       @configuration ||= Configuration.new