mercy 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68a29e5f4fa044fa73b32f12b346d4cceed9e412
-  data.tar.gz: daf14a5ee6e905a90fef1f07f0bfeed96ef7e88f
+  metadata.gz: ea2e29aaca202d99f4b6d0d8ea3a9515b0ee8c80
+  data.tar.gz: 8b1bfb1ac1ab08640814ded69b186c6b1664c6d0
 SHA512:
-  metadata.gz: 125286d85808a19342179001573365be133f7e88a0a2b847ca3b18a5d5627d41dd78061d1aa82cd82c1c1aa4484fa20f0d2716640fce8672e88a561a45c3f354
-  data.tar.gz: 8d67fde38e51096f1fb47f3fa272159658088a152bfadb7ad77d5b6e5a89d98cf9a85f2be2cd232a07e7d7632cbbcb173533b3a21a8bb51d6e57f2e4534fd923
+  metadata.gz: 60d0ff4fe15a81f17e59f203a7839f68d1fe82fa2ae178f7a1785e626eb0c12c9e030b3cfb6bd97b882090f8b8bca48e99beaf0f4e184938ee07e45d01811e1c
+  data.tar.gz: a3c670ed0b56a98f534ba6c62af5df0c9ae32c302243db676d3b5f8cbaec013b3d01c4ac1eaa0436f160d0d5de05fe2f242f297d8807fc685c9f610512c0d67b

data/.circleci/config.yml

@@ -0,0 +1,13 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.4.1
+    steps:
+      - checkout
+      - run: curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+      - run: chmod +x ./cc-test-reporter
+      - run: ./cc-test-reporter before-build
+      - run: bundle install
+      - run: bundle exec rspec
+      - run: ./cc-test-reporter after-build --exit-code $?

data/.gitignore

@@ -1,2 +1,3 @@
 coverage
 pkg
+Gemfile.lock

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Bidu Corretora
+Copyright (c) 2017 Favini
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,19 +1,21 @@
-Bidu House
+Mercy
 ==========
 
-[![Code Climate](https://codeclimate.com/github/darthjee/house/badges/gpa.svg)](https://codeclimate.com/github/darthjee/house)
-[![Test Coverage](https://codeclimate.com/github/darthjee/house/badges/coverage.svg)](https://codeclimate.com/github/darthjee/house/coverage)
-[![Issue Count](https://codeclimate.com/github/darthjee/house/badges/issue_count.svg)](https://codeclimate.com/github/darthjee/house)
+![mercy](https://raw.githubusercontent.com/darthjee/mercy/master/mercy.jpg)
+
+[![Code Climate](https://codeclimate.com/github/darthjee/mercy/badges/gpa.svg)](https://codeclimate.com/github/darthjee/mercy)
+[![Test Coverage](https://codeclimate.com/github/darthjee/mercy/badges/coverage.svg)](https://codeclimate.com/github/darthjee/mercy/coverage)
+[![Issue Count](https://codeclimate.com/github/darthjee/mercy/badges/issue_count.svg)](https://codeclimate.com/github/darthjee/mercy)
 
 This gem tries to make server monitoring easier and more reliable by adding an easly configurable
 report and making it avaliable in a controller
 
 Getting started
 ---------------
-1. Add House to your `Gemfile` and `bundle install`:
+1. Add Mercy to your `Gemfile` and `bundle install`:
 
     ```ruby
-    gem 'bidu-house'
+    gem 'mercy'
     ```
 
 
@@ -22,12 +24,12 @@ with error and render the report
 
   ```ruby
   class HealthCheckController < ApplicationController
-    include Bidu::House
+    include Mercy
 
     status_report :failures, clazz: Document
     status_report :failures, clazz: Schedules, on: :schedules
     status_report :delays, clazz: Schedules, scope: :late, on: :schedules
-    status_report :'documents.count', clazz: Document, scope: :active, type: House::Range, minimum: 100
+    status_report :'documents.count', clazz: Document, scope: :active, type: Mercy::Range, minimum: 100
     status_report :'documents.errors', clazz: Document, scope: :'active.with_error', type: :range, maximum: 1000
 
     def status
@@ -57,14 +59,14 @@ with error and render the report
  
   Remembering that each report may have its onw parameters
 
- - ```House::Error```
+ - ```Mercy::Error```
    - scope: scope to be fetched when trying to find objects with error (default: :with_error)
    - external_key: column to be exposed as id for the objects with error
    - threshold: default report threshold (default: 0.02)
    - base_scope: scope to be universal sample
    - uniq: when the output ids should not be repeated
    - limit: limit of ids to be outputed
- - ```House::Range```
+ - ```Mercy::Range```
    - scope: scope of the query to be counted
    - maximum: max value accepted in the range
    - minimum: minimum value accepted in the range

data/docker-compose.yml

@@ -0,0 +1,18 @@
+version: '2'
+services:
+  base: &base
+    image: ruby:2.4.0
+    working_dir: /home/app/mercy
+    volumes:
+      - .:/home/app/mercy
+      - mercy_gems_2_4_0:/usr/local/bundle
+
+  #################### CONTAINERS ####################
+
+  mercy:
+    <<: *base
+    container_name: mercy
+    command: /bin/bash -c 'bundle install && bundle exec rspec'
+
+volumes:
+  mercy_gems_2_4_0:

data/lib/arstotzka/type_cast_ext.rb

@@ -0,0 +1,15 @@
+module Arstotzka
+  module TypeCast
+    def to_period(value)
+      Mercy::PeriodParser.parse(value)
+    end
+
+    def to_infinity_float(value)
+      return value if value.is_a?(Numeric)
+      return -Float::INFINITY if value.match(/-inf/)
+      return Float::INFINITY if value.match(/inf/)
+
+      value.to_f
+    end
+  end
+end

data/lib/mercy.rb

@@ -0,0 +1,15 @@
+require 'darthjee/active_ext'
+require 'darthjee/core_ext'
+require 'mercy/period_parser'
+require 'arstotzka'
+require 'arstotzka/type_cast_ext'
+
+module Mercy
+  require 'mercy/concern'
+  require 'mercy/report_config'
+  require 'mercy/report'
+  require 'mercy/status'
+  require 'mercy/report_builder'
+  require 'mercy/status_builder'
+  require 'mercy/class_methods'
+end

data/lib/mercy/class_methods.rb

@@ -0,0 +1,17 @@
+module Mercy
+  module ClassMethods
+
+    def status_report(*attr_names)
+      id = attr_names.first
+      options = {
+        id: id
+      }.merge(attr_names.extract_options!)
+
+      self.status_builder.add_report_config(id, options)
+    end
+
+    def status_builder
+      @status_builder ||= Mercy::StatusBuilder.new
+    end
+  end
+end

data/lib/mercy/concern.rb

@@ -0,0 +1,8 @@
+module Mercy
+  extend ActiveSupport::Concern
+
+  def render_status(key = :default)
+    status = self.class.status_builder.build(key, params)
+    render json: status.as_json.stringify_keys.to_deep_hash, status: status.status
+  end
+end

data/lib/{bidu → mercy}/period_parser.rb

@@ -1,4 +1,4 @@
-module Bidu
+module Mercy
   class PeriodParser
     class << self
       def parse(period)

data/lib/mercy/report.rb

@@ -0,0 +1,42 @@
+module Mercy
+  class Report
+    include Arstotzka
+    require 'mercy/report/active_record'
+    require 'mercy/report/error'
+    require 'mercy/report/range'
+    require 'mercy/report/multiple'
+    ALLOWED_PARAMETERS = []
+    DEFAULT_OPTION = {}
+
+    attr_reader :json
+
+    expose :id, case: :snake
+
+    def initialize(options = {})
+      @json = default_option.merge(options)
+    end
+
+    def status
+      @status ||= error? ? :error : :ok
+    end
+
+    def error?
+      raise 'Not implemented yet'
+    end
+
+    def as_json
+      { status: status }
+    end
+
+    private
+
+    def default_option
+      self.class.default_options
+    end
+
+    def self.default_options
+      return {} if self == Report
+      self.superclass.default_options.merge(self::DEFAULT_OPTION)
+    end
+  end
+end

data/lib/mercy/report/active_record.rb

@@ -0,0 +1,26 @@
+module Mercy
+  class Report::ActiveRecord < Report
+    expose :period, type: :period
+    expose :clazz, :base_scope, case: :snake
+
+    private
+
+    def fetch_scoped(base, scope)
+      if (scope.is_a?(Symbol))
+        scope.to_s.split('.').inject(base) do |entries, method|
+          entries.public_send(method)
+        end
+      else
+        base.where(scope)
+      end
+    end
+
+    def last_entries
+      @last_entries ||= base.where('updated_at >= ?', period.seconds.ago)
+    end
+
+    def base
+      fetch_scoped(clazz, base_scope)
+    end
+  end
+end

data/lib/mercy/report/error.rb

@@ -0,0 +1,60 @@
+module Mercy
+  class Report
+    class Error < Report::ActiveRecord
+      ALLOWED_PARAMETERS=[:period, :threshold]
+      DEFAULT_OPTION = {
+        external_key: :id,
+        threshold: 0.02,
+        period: 1.day,
+        scope: :with_error,
+        base_scope: :all,
+        uniq: false
+      }
+
+      expose :threshold, type: :float
+      expose :scope, :external_key, :uniq, :limit, case: :snake
+
+      def initialize(options)
+        super(self.class::DEFAULT_OPTION.merge(options))
+      end
+
+      def percentage
+        @percentage ||= fetch_percentage
+      end
+
+      def scoped
+        @scoped ||= fetch_scoped(last_entries, scope)
+      end
+
+      def error?
+        @error ||= percentage > threshold
+      end
+
+      def as_json
+        {
+          ids: ids,
+          percentage: percentage,
+          status: status
+        }
+      end
+
+      private
+
+      def ids
+        relation = scoped
+        relation = relation.distinct if uniq
+        relation = relation.limit(limit) if limit
+
+        relation.pluck(external_key)
+      end
+
+      def fetch_percentage
+        if (scope.is_a?(Symbol))
+          last_entries.percentage(*(scope.to_s.split('.').map(&:to_sym)))
+        else
+          last_entries.percentage(scope)
+        end
+      end
+    end
+  end
+end

data/lib/{bidu/mercy → mercy}/report/multiple.rb

@@ -1,4 +1,4 @@
-module Bidu::Mercy::Report::Multiple
+module Mercy::Report::Multiple
   def as_json
     {
       status: status

data/lib/mercy/report/range.rb

@@ -0,0 +1,48 @@
+module Mercy
+  class Report
+    class Range < Report::ActiveRecord
+      ALLOWED_PARAMETERS=[:period, :maximum, :minimum]
+      DEFAULT_OPTION = {
+        period: 1.day,
+        scope: :all,
+      }
+
+      expose :scope
+      expose :maximum, type: :infinity_float, default: 'inf'
+      expose :minimum, type: :infinity_float, default: '-inf'
+
+      def initialize(options)
+        super(DEFAULT_OPTION.merge(options))
+      end
+
+      def scoped
+        @scoped ||= fetch_scoped(last_entries, scope)
+      end
+
+      def error?
+        @error ||= !count_in_range?
+      end
+
+      def as_json
+        {
+          status: status,
+          count: count
+        }
+      end
+
+      def count
+        scoped.count
+      end
+
+      private
+
+      def range
+        (minimum..maximum)
+      end
+
+      def count_in_range?
+        return range.include?(count)
+      end
+    end
+  end
+end

data/lib/mercy/report_builder.rb

@@ -0,0 +1,22 @@
+module Mercy
+  class ReportBuilder
+    def build(key, parameters = {})
+      config = config_for(key)
+      config.build(parameters)
+    end
+
+    def add_config(key, config)
+      configs[key] = Mercy::ReportConfig.new(config)
+    end
+
+    private
+
+    def config_for(key)
+      configs[key]
+    end
+
+    def configs
+      @configs ||= {}
+    end
+  end
+end

data/lib/mercy/report_config.rb

@@ -0,0 +1,35 @@
+module Mercy
+  class ReportConfig
+    attr_accessor :config
+
+    delegate :[], :[]=, :merge, to: :config
+
+    def initialize(config)
+      @config = config
+    end
+
+    def build(parameters)
+      params = slice_parameters(parameters)
+      report_class.new(config.merge(params))
+    end
+
+    private
+
+    def type
+      self[:type] ||= :error
+    end
+
+    def report_class
+      return type if type.is_a?(Class)
+      @report_class ||= Mercy::Report.const_get(type.to_s.camelize)
+    end
+
+    def slice_parameters(parameters)
+      parameters.slice(*allowed_parameters)
+    end
+
+    def allowed_parameters
+      report_class::ALLOWED_PARAMETERS
+    end
+  end
+end

data/lib/mercy/status.rb

@@ -0,0 +1,25 @@
+module Mercy
+  class Status
+    attr_reader :reports
+
+    def initialize(reports)
+      @reports = reports
+    end
+
+    def status
+      reports.any? { |r| r.error? } ? :error : :ok
+    end
+
+    def as_json
+      {
+        status: status
+      }.merge(reports_jsons)
+    end
+
+    private
+
+    def reports_jsons
+      reports.map(&:as_json).as_hash(reports.map(&:id))
+    end
+  end
+end