bidu-mercy 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ba27966c96140a28442d6b9a52b8c54500ee5dc
+  data.tar.gz: 378791324c844494e19e2b043e017f89aaecbd3c
+SHA512:
+  metadata.gz: 80d9c849a716494ab02908d0ec612334762be08726f4e2dd14dddac677426a76ee9d8e68fa9bcfc76c1da413f638f6536634e097f802db02d15143f635ca0c73
+  data.tar.gz: 8782984c3bf03c608ab7a93189633eed7e486ef16af5c4a44ae5298dfd7730197c1b97e813cbd4c274628917751e954c08914fd39b859aa109fcc73a59cff3b3

data/.gitignore

@@ -0,0 +1,2 @@
+coverage
+pkg

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,88 @@
+PATH
+  remote: .
+  specs:
+    bidu-mercy (1.3.0)
+      activesupport
+      concern_builder
+      darthjee-active_ext
+      json_parser (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.1.1)
+      activesupport (= 5.1.1)
+    activerecord (5.1.1)
+      activemodel (= 5.1.1)
+      activesupport (= 5.1.1)
+      arel (~> 8.0)
+    activesupport (5.1.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    coderay (1.1.1)
+    concern_builder (0.0.2)
+      activesupport
+    concurrent-ruby (1.0.5)
+    darthjee-active_ext (1.2.0)
+      activesupport (~> 5.1.1)
+      darthjee-core_ext (~> 1.2.6)
+    darthjee-core_ext (1.2.6)
+      activesupport (~> 5.1.1)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    i18n (0.8.4)
+    json (2.1.0)
+    json_parser (1.1.0)
+      activesupport
+      concern_builder
+    method_source (0.8.2)
+    minitest (5.10.2)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-nav (0.2.4)
+      pry (>= 0.9.10, < 0.11.0)
+    rake (12.0.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.1)
+    slop (3.6.0)
+    sqlite3 (1.3.13)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  bidu-mercy!
+  bundler
+  pry-nav
+  rake
+  rspec
+  simplecov
+  sqlite3
+
+BUNDLED WITH
+   1.15.1

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Bidu Corretora
+
+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,100 @@
+Bidu House
+==========
+
+[![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)
+
+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`:
+
+    ```ruby
+    gem 'bidu-house'
+    ```
+
+
+2. Include in your health check controller passing the configuration to fetch your Documents
+with error and render the report
+
+  ```ruby
+  class HealthCheckController < ApplicationController
+    include Bidu::House
+
+    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.errors', clazz: Document, scope: :'active.with_error', type: :range, maximum: 1000
+
+    def status
+      render_status
+    end
+
+    def late_status
+      render_status(:schedules)
+    end
+  end
+  ```
+
+3. Add a route to your controller
+
+  ```ruby
+  scope path: 'health-check', controller: :health_check do
+    get '/status' => :status
+    get '/late-status' => :late_status
+  end
+  ```
+
+3. Set the correct options on your status report to achieve a perfect report
+ - clazz: Class of the object that might contain error
+ - period: default search period (default: 1 day)
+ - on: report bucket (default: :default)
+ - type: report type (error, range or other custom report)
+ 
+  Remembering that each report may have its onw parameters
+
+ - ```House::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```
+   - scope: scope of the query to be counted
+   - maximum: max value accepted in the range
+   - minimum: minimum value accepted in the range
+
+4. Run the server and hit the health-check routes
+
+ ```
+ wget http://localhost:3000/health-check/status
+ wget http://localhost:3000/health-check/late-status
+ ```
+
+5. Customize your request for multiple reports
+ ```
+ wget http://localhost:3000/health-check/status?period=3.days&threshold=0.005
+ wget http://localhost:3000/health-check/late-status?period=1.hours&threshold=0.1
+ ```
+
+ 6. Use the status json to understand what is wrong
+ ```json
+ {
+   "status": "error",
+   "failures": {
+     "ids": [10, 14],
+     "percentage": 0.5,
+     "status": "error"
+   },
+   "delays": {
+     "ids": [12],
+     "percentage": 0.001,
+     "status": "ok"
+   }
+ }
+ ```

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task test: :spec

data/circle.yml

@@ -0,0 +1,16 @@
+dependencies:
+  post:
+    - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+    - chmod +x ./cc-test-reporter
+
+
+database:
+  override:
+    - echo "Skipping DB section."
+
+test:
+  pre:
+    - bundle install
+    - ./cc-test-reporter before-build
+  override:
+    - bundle exec rspec; ./cc-test-reporter after-build --exit-code $?

data/lib/bidu.rb

@@ -0,0 +1,3 @@
+module Bidu
+  require 'bidu/mercy'
+end

data/lib/bidu/mercy.rb

@@ -0,0 +1,18 @@
+require 'darthjee/active_ext'
+require 'concern_builder'
+require 'darthjee/core_ext'
+require 'bidu/period_parser'
+require 'json_parser'
+require 'json_parser/type_cast_ext'
+
+module Bidu
+  module Mercy
+    require 'bidu/mercy/concern'
+    require 'bidu/mercy/report_config'
+    require 'bidu/mercy/report'
+    require 'bidu/mercy/status'
+    require 'bidu/mercy/report_builder'
+    require 'bidu/mercy/status_builder'
+    require 'bidu/mercy/class_methods'
+  end
+end

data/lib/bidu/mercy/class_methods.rb

@@ -0,0 +1,19 @@
+module Bidu
+  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 ||= Bidu::Mercy::StatusBuilder.new
+      end
+    end
+  end
+end

data/lib/bidu/mercy/concern.rb

@@ -0,0 +1,10 @@
+module Bidu
+  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
+end

data/lib/bidu/mercy/report.rb

@@ -0,0 +1,44 @@
+module Bidu
+  module Mercy
+    class Report
+      include JsonParser
+      require 'bidu/mercy/report/active_record'
+      require 'bidu/mercy/report/error'
+      require 'bidu/mercy/report/range'
+      require 'bidu/mercy/report/multiple'
+      ALLOWED_PARAMETERS = []
+      DEFAULT_OPTION = {}
+
+      attr_reader :json
+
+      json_parse :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
+end

data/lib/bidu/mercy/report/active_record.rb

@@ -0,0 +1,28 @@
+module Bidu
+  module Mercy
+    class Report::ActiveRecord < Report
+      json_parse :period, type: :period
+      json_parse :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
+end

data/lib/bidu/mercy/report/error.rb

@@ -0,0 +1,62 @@
+module Bidu
+  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
+        }
+
+        json_parse :threshold, type: :float
+        json_parse :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
+end