bidu-house 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e81c76e00406e53d4990c5cc225f38e81fa4de1c
-  data.tar.gz: cf6bd8a5b1f369c44cf2b3e4c67464a13c4e4700
+  metadata.gz: 1bce0f17bbdd46d4d769e1b3a6d086abad2ba9b4
+  data.tar.gz: ab14a3c78154d146481f730c198face541890f24
 SHA512:
-  metadata.gz: 6dc1bf73244b34f0a5c84c8ca65238f4f43bcf94b7278d6d028f41e3e9d0351a4711cd08ab95a93499ff7033c7ff9e52e3c0cdb84cc3bba7ac5b67ead002be67
-  data.tar.gz: a6d7313fa19994b600c4a87bb83191d1ca8e289563756e8b23a52a122712d104daed6e6561a4975a4ebb2d1a029a8b44e57c9ac0550f3947de666e0a6f3852af
+  metadata.gz: 173182741ddeb9f5ec7bcf41beb5e084777d8039cd6d13e3dee181c9b6bddab21ebe052248199c8bd8450ea79ce12523a00439140629a35337c374ca6ac7698b
+  data.tar.gz: 5d83943edac6382f139c0f7d61b35c32b1566cd355f28ccf5816c326f093a431b515d7edee0a81ab8fa0d4863f32d05fd96351ca62ac3801d6c0f1a5c129648d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bidu-house (1.0.0)
+    bidu-house (1.1.0)
       activesupport
       bidu-active_ext
       concern_builder
@@ -30,6 +30,8 @@ GEM
     bidu-core_ext (1.2.2)
       activesupport
     builder (3.2.2)
+    codeclimate-test-reporter (0.5.0)
+      simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.0)
     concern_builder (0.0.2)
       activesupport
@@ -75,6 +77,7 @@ DEPENDENCIES
   activerecord
   bidu-house!
   bundler (~> 1.6)
+  codeclimate-test-reporter
   pry-nav
   rake
   rspec (~> 2.14)

data/README.md

@@ -1,6 +1,8 @@
 Bidu House
 ==========
 
+[![Code Climate](https://codeclimate.com/github/Bidu/house/badges/gpa.svg)](https://codeclimate.com/github/Bidu/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
 
@@ -21,8 +23,10 @@ with error and render the report
     include Bidu::House
 
     status_report :failures, clazz: Document
-    status_report :failures, clazz: Schedules, on: :schedules
+    status_report :'failures.schedules', 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
@@ -45,14 +49,23 @@ with error and render the report
 
 3. Set the correct options on your status report to achieve a perfect report
  - clazz: Class of the object that might contain 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)
  - period: default search period (default: 1 day)
  - on: report bucket (default: :default)
- - base_scope: scope to be universal sample
- - uniq: when the output ids should not be repeated
- - limit: limit of ids to be outputed
+ - 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
 

data/house.gemspec

@@ -30,4 +30,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "rspec", "~> 2.14"
   gem.add_development_dependency 'pry-nav'
   gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'codeclimate-test-reporter'
 end

data/lib/bidu/house/report.rb

@@ -3,13 +3,14 @@ module Bidu
     class Report
       include JsonParser
       require 'bidu/house/report/error'
+      require 'bidu/house/report/range'
       ALLOWED_PARAMETERS = []
       DEFAULT_OPTION = {}
 
       attr_reader :json
 
       json_parse :period, type: :period
-      json_parse :clazz, :base_scope, case: :snake
+      json_parse :clazz, :base_scope, :id, case: :snake
 
       def initialize(options)
         @json = DEFAULT_OPTION.merge(options)

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

@@ -13,7 +13,7 @@ module Bidu
         }
 
         json_parse :threshold, type: :float
-        json_parse :scope, :id, :external_key, :uniq, :limit, case: :snake
+        json_parse :scope, :external_key, :uniq, :limit, case: :snake
 
         def initialize(options)
           super(DEFAULT_OPTION.merge(options))

data/lib/bidu/house/report/range.rb

@@ -0,0 +1,54 @@
+module Bidu
+  module House
+    class Report
+      class Range < Report
+        ALLOWED_PARAMETERS=[:period, :maximum, :minimum]
+        DEFAULT_OPTION = {
+          period: 1.day,
+          scope: :all,
+          minimum: nil,
+          maximum: nil
+        }
+
+        json_parse :scope
+        json_parse :minimum, :maximum, type: :integer
+
+        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) unless (maximum.nil? || minimum.nil?)
+          return count >= minimum unless minimum.nil?
+          return count <= maximum unless maximum.nil?
+          true
+        end
+      end
+    end
+  end
+end

data/lib/bidu/house/version.rb

@@ -1,5 +1,5 @@
 module Bidu
   module House
-    VERSION = '1.0.0'
+    VERSION = '1.1.0'
   end
 end

data/spec/lib/bidu/house/report/range_spec.rb

@@ -0,0 +1,302 @@
+require 'spec_helper'
+
+describe Bidu::House::Report::Range do
+  let(:errors) { 1 }
+  let(:successes) { 1 }
+  let(:old_errors) { 2 }
+  let(:old_sucesses) { 2 }
+  let(:period) { 1.day }
+  let(:scope) { :with_error }
+  let(:maximum) { nil }
+  let(:minimum) { nil }
+  let(:options) do
+    {
+      period: period,
+      scope: scope,
+      clazz: Document,
+      minimum: minimum,
+      maximum: maximum
+    }
+  end
+  let(:subject) { described_class.new(options) }
+  let(:types) { [:a] }
+  before do
+    Document.all.each(&:destroy)
+    types.each do |type|
+      successes.times { Document.create status: :success, doc_type: type }
+      errors.times do |i|
+        Document.create status: :error, external_id: 10 * successes + i, outter_external_id: i, doc_type: type
+      end
+      old_errors.times do
+        Document.create status: :error, created_at: 2.days.ago, updated_at: 2.days.ago, doc_type: type
+      end
+      old_sucesses.times do
+        Document.create status: :success, created_at: 2.days.ago, updated_at: 2.days.ago, doc_type: type
+      end
+    end
+  end
+
+  describe '#status' do
+    context 'when looking for maximum counts' do
+      context 'when there are more errors than the allowed by the maximum' do
+        let(:errors) { 2 }
+        let(:maximum) { 1 }
+        it { expect(subject.status).to eq(:error) }
+      end
+
+      context 'when the maximum is 0 and there are no errors' do
+        let(:errors) { 0 }
+        let(:maximum) { 0 }
+        it { expect(subject.status).to eq(:ok) }
+      end
+
+      context 'when the maximum is nil and there are no errors' do
+        let(:errors) { 0 }
+        let(:maximum) { nil }
+        it { expect(subject.status).to eq(:ok) }
+      end
+
+      context 'when the count is the same as the maximum' do
+        let(:errors) { 1 }
+        let(:maximum) { 1 }
+        it { expect(subject.status).to eq(:ok) }
+      end
+
+      context 'when the count is less than the maximum' do
+        let(:errors) { 1 }
+        let(:maximum) { 2 }
+        it { expect(subject.status).to eq(:ok) }
+      end
+
+      context 'when there are older errors out of the period' do
+        let(:maximum) { 1 }
+
+        it 'ignores the older errros' do
+          expect(subject.status).to eq(:ok)
+        end
+
+        context 'when passing a bigger period' do
+          let(:period) { 3.days }
+  
+          it 'consider the older errros' do
+            expect(subject.status).to eq(:error)
+          end
+        end
+      end
+    end
+
+    context 'when looking for minimum' do
+      let(:scope) { :with_success }
+      context 'when there are less successes than the allowed by the minimum' do
+        let(:successes) { 1 }
+        let(:minimum) { 2 }
+        it { expect(subject.status).to eq(:error) }
+      end
+
+      context 'when the minimum is 0 and there are no sucesses' do
+        let(:successes) { 0 }
+        let(:minimum) { 0 }
+        it { expect(subject.status).to eq(:ok) }
+      end
+
+      context 'when the minimum is nil and there are no sucesses' do
+        let(:successes) { 0 }
+        let(:minimum) { nil }
+        it { expect(subject.status).to eq(:ok) }
+      end
+
+      context 'when the count is the same as the minimum' do
+        let(:successes) { 1 }
+        let(:minimum) { 1 }
+        it { expect(subject.status).to eq(:ok) }
+      end
+
+      context 'when the count is greater than the minimum' do
+        let(:successes) { 2 }
+        let(:minimum) { 1 }
+        it { expect(subject.status).to eq(:ok) }
+      end
+
+      context 'when there are older sucesses out of the period' do
+        let(:successes) { 0 }
+        let(:minimum) { 1 }
+
+        it 'ignores the older sucesses' do
+          expect(subject.status).to eq(:error)
+        end
+
+        context 'when passing a bigger period' do
+          let(:period) { 3.days }
+  
+          it 'consider the older sucesses' do
+            expect(subject.status).to eq(:ok)
+          end
+        end
+      end
+    end
+
+    context 'when looking for a range' do
+      let(:scope) { :all }
+      let(:minimum) { 2 }
+      let(:maximum) { 4 }
+
+      context 'when there are less documents than the allowed by the minimum' do
+        let(:successes) { 1 }
+        let(:errors) { 0 }
+        it { expect(subject.status).to eq(:error) }
+      end
+
+      context 'when the count is the same as the minimum' do
+        let(:successes) { 1 }
+        let(:errors) { 2 }
+        it { expect(subject.status).to eq(:ok) }
+      end
+
+      context 'when the count is inside the range' do
+        let(:successes) { 1 }
+        let(:errors) { 2 }
+        it { expect(subject.status).to eq(:ok) }
+      end
+
+      context 'when the count is the same as the maximum' do
+        let(:successes) { 2 }
+        let(:errors) { 2 }
+        it { expect(subject.status).to eq(:ok) }
+      end
+
+      context 'when the count is greater than the maximum' do
+        let(:successes) { 3 }
+        let(:errors) { 2 }
+        it { expect(subject.status).to eq(:error) }
+      end
+
+      context 'when the minimum is 0 and the count is 0' do
+        let(:successes) { 0 }
+        let(:errors) { 0 }
+        let(:minimum) { 0 }
+        it { expect(subject.status).to eq(:ok) }
+      end
+
+      context 'when there are older sucesses out of the period' do
+        let(:old_errors) { 1 }
+        let(:old_sucesses) { 2 }
+
+        context 'and the regular documents are not enough' do
+          let(:successes) { 1 }
+          let(:errors) { 0 }
+ 
+          it 'ignores the older sucesses' do
+            expect(subject.status).to eq(:error)
+          end
+
+          context 'when passing a bigger period' do
+            let(:period) { 3.days }
+  
+            it 'consider the older sucesses' do
+              expect(subject.status).to eq(:ok)
+            end
+          end
+        end
+
+        context 'and the regular documents are almost in the limit' do
+          let(:successes) { 2 }
+          let(:errors) { 1 }
+ 
+          it 'ignores the older sucesses' do
+            expect(subject.status).to eq(:ok)
+          end
+
+          context 'when passing a bigger period' do
+            let(:period) { 3.days }
+  
+            it 'consider the older documents' do
+              expect(subject.status).to eq(:error)
+            end
+          end
+        end
+      end
+    end
+  end
+
+  describe '#count' do 
+    let(:types) { [:a, :b] }
+    let(:errors) { 1 }
+    let(:scope) { :with_error }
+
+    it 'returns all the documents found' do
+      expect(subject.count).to eq(2)
+    end
+    
+    context 'when configuring with a complex scope' do
+      let(:old_errors) { 0 }
+      let(:scope) { :'with_error.type_b' }
+      let(:errors) { 1 }
+
+      context 'as symbol' do
+        let(:scope) { :'with_error.type_b' }
+
+        it 'fetches from each scope in order' do
+          expect(subject.count).to eq(1)
+        end
+      end
+
+      context 'as string where scope' do
+        let(:scope) { "status = 'error' and doc_type = 'b'" }
+
+        it 'fetches from each scope in order' do
+          expect(subject.count).to eq(1)
+        end
+      end
+
+      context 'as hash where scope' do
+        let(:scope) { { status: :error, doc_type: :b } }
+
+        it 'fetches from each scope in order' do
+          expect(subject.count).to eq(1)
+        end
+      end
+    end
+  end
+
+  describe '#error?' do
+    let(:errors) { 2 }
+    let(:maximum) { 1 }
+
+    context 'when errors count overcome maximum' do
+      it { expect(subject.error?).to be_truthy }
+    end
+
+    context 'when errors count do not overcome maximum' do
+      let(:errors) { 0 }
+      it { expect(subject.error?).to be_falsey }
+    end
+  end
+
+  describe '#as_json' do
+    let(:expected) do
+      { count: count_expected, status: status_expected }
+    end
+
+    context 'when everything is ok' do
+      let(:errors) { 1 }
+      let(:status_expected) { :ok }
+      let(:count_expected) { errors }
+      let(:maximum) { 2 }
+
+      it 'returns the count and status' do
+        expect(subject.as_json).to eq(expected)
+      end
+    end
+
+    context 'when there is an error' do
+      let(:errors) { 2 }
+      let(:status_expected) { :error }
+      let(:count_expected) { errors }
+      let(:maximum) { 1 }
+
+      it 'returns the count and status' do
+        expect(subject.as_json).to eq(expected)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -3,6 +3,11 @@ SimpleCov.profiles.define 'gem' do
   add_filter '/spec/'
 end
 
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
+end
+
 SimpleCov.start 'gem'
 
 require 'pry-nav'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bidu-house
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Bidu Dev's Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-24 00:00:00.000000000 Z
+date: 2016-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -164,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Gem for easy health check
 email:
 - dev@bidu.com.br
@@ -185,6 +199,7 @@ files:
 - lib/bidu/house/concern.rb
 - lib/bidu/house/report.rb
 - lib/bidu/house/report/error.rb
+- lib/bidu/house/report/range.rb
 - lib/bidu/house/report_builder.rb
 - lib/bidu/house/report_config.rb
 - lib/bidu/house/status.rb
@@ -193,6 +208,7 @@ files:
 - lib/bidu/period_parser.rb
 - lib/json_parser/type_cast_ext.rb
 - spec/lib/bidu/house/report/error_spec.rb
+- spec/lib/bidu/house/report/range_spec.rb
 - spec/lib/bidu/house/report/report_config_spec.rb
 - spec/lib/bidu/house/report_builder_spec.rb
 - spec/lib/bidu/house/status_builder_spec.rb