bidu-house 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25cc0841110cb3f8c649f8a42343f80736c1c910
-  data.tar.gz: e9ef4b32c0651fe1400d053d38ffae6a3a385b27
+  metadata.gz: a983db5f6db921362ce62f4d7f0a0cbe09272968
+  data.tar.gz: bfc7a4ace34f0eb1ba940ad1e562e2ed0351d98c
 SHA512:
-  metadata.gz: 3e52af0063573133cffdb10b444a236a6081559622b4af79f0bd10227011a73ebdcf11ec6ca296504952d560afe53990428788f3cc9606c2cd2529c4f31d15bc
-  data.tar.gz: 6aa8cfde4107f3a1d4a50fc5aa937a06a672dfd8b8ef95531a5e91a4708987350728120aae37ba5733451b06fb8c7d8541eb32345c8c2468fdbd838e36c24f55
+  metadata.gz: b4c2f0f4e0c0c5151a98171e5ae307cf332c965b00e3dacc44dfa05ea369f9aa2fedd5b984c5231ebe3d96c5514b3abc7746471e02d5aaf5cf267c825179e943
+  data.tar.gz: 535155a3de8ecb7e6a101e80a1d3bd287c75d3be780a9d53df3221deb1cb38d1be5286b988e56cf2b9f1b4bc1b98f460c9fe69ca1b1f79366a11351d3a816273

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bidu-house (0.2.0)
+    bidu-house (0.2.1)
       activesupport
       bidu-active_ext
       concern_builder
@@ -27,7 +27,7 @@ GEM
     bidu-active_ext (1.0.0)
       activesupport
       bidu-core_ext
-    bidu-core_ext (1.2.0)
+    bidu-core_ext (1.2.1)
       activesupport
     builder (3.2.2)
     coderay (1.1.0)

data/README.md

@@ -63,3 +63,20 @@ with error and render the report
  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/lib/bidu/house/report/error.rb

@@ -35,13 +35,18 @@ module Bidu
         end
 
         def error?
-          percentage > threshold
+          @error ||= percentage > threshold
+        end
+
+        def status
+          error? ? :error : :ok
         end
 
         def as_json
           {
             ids: scoped.pluck(external_key),
-            percentage: percentage
+            percentage: percentage,
+            status: status
           }
         end
 

data/lib/bidu/house/version.rb

@@ -1,5 +1,5 @@
 module Bidu
   module House
-    VERSION = '0.2.0'
+    VERSION = '0.2.1'
   end
 end

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

@@ -293,16 +293,44 @@ describe Bidu::House::Report::Error do
     end
   end
 
+  describe '#status' do
+    context 'when errors percentage overcames threshold' do
+      it { expect(subject.status).to eq(:error) }
+    end
+
+    context 'when errors percentage does not overcames threshold' do
+      let(:errors) { 0 }
+      it { expect(subject.status).to eq(:ok) }
+    end
+  end
+
   describe '#as_json' do
+    let(:expected) do
+      { ids: ids_expected, percentage: percentage_expected, status: status_expected }
+    end
+
+    context 'when everything is ok' do
+      let(:errors) { 1 }
+      let(:successes) { 9 }
+      let(:ids_expected) { [90] }
+      let(:status_expected) { :ok }
+      let(:percentage_expected) { 0.1 }
+      let(:threshold) { 0.5 }
+
+      it 'returns the external keys, status and error percentage' do
+        expect(subject.as_json).to eq(expected)
+      end
+
+    end
+
     context 'when there are 75% erros' do
+      let(:status_expected) { :error }
+      let(:percentage_expected) { 0.75 }
       let(:errors) { 3 }
       let(:successes) { 1 }
       let(:ids_expected) { [10, 11, 12] }
-      let(:expected) do
-        { ids: ids_expected, percentage: 0.75 }
-      end
 
-      it 'returns the external keys and error percentage' do
+      it 'returns the external keys, status and error percentage' do
         expect(subject.as_json).to eq(expected)
       end
 

data/spec/lib/bidu/house/report_builder_spec.rb

@@ -37,7 +37,7 @@ describe Bidu::House::ReportBuilder do
     end
 
     it 'builds the report using the given configuration' do
-      expect(report.as_json).to eq( ids: ids, percentage: 0.25 )
+      expect(report.as_json).to eq( ids: ids, percentage: 0.25, status: :error )
       expect(report.error?).to be_truthy
     end
 
@@ -50,7 +50,7 @@ describe Bidu::House::ReportBuilder do
     end
 
     context 'when passing a custom period parameter' do
-      let(:parameters) { { threshold: 0.4, period: 10.days } }
+      let(:parameters) { { threshold: 0.4, period: 10.days, status: :error } }
 
       it 'uses custom period parameter' do
         expect(report.error?).to be_truthy
@@ -63,7 +63,7 @@ describe Bidu::House::ReportBuilder do
       end
 
       it 'ignores the non customizable parameters' do
-        expect(report.as_json).to eq( ids: ids, percentage: 0.25 )
+        expect(report.as_json).to eq( ids: ids, percentage: 0.25, status: :error )
         expect(report.error?).to be_truthy
         expect(report.id).to eq(:errors)
       end

data/spec/lib/bidu/house/status_builder_spec.rb

@@ -40,7 +40,8 @@ describe Bidu::House::StatusBuilder do
          status: status_expected,
          failures: {
            ids: ids,
-           percentage: percentage
+           percentage: percentage,
+           status: status_expected
          }
        }
     end

data/spec/lib/bidu/house/status_spec.rb

@@ -98,7 +98,8 @@ describe Bidu::House::Status do
         status: :error,
         errors: {
           ids: ids,
-          percentage: 0.75
+          percentage: 0.75,
+          status: :error
         }
       }
     end
@@ -114,11 +115,13 @@ describe Bidu::House::Status do
           status: :error,
           errors: {
             ids: ids,
-            percentage: 0.75
+            percentage: 0.75,
+            status: :error
           },
           success: {
             ids: success_ids,
-            percentage: 0.25
+            percentage: 0.25,
+            status: :error
           }
         }
       end

metadata

@@ -1,167 +1,167 @@
 --- !ruby/object:Gem::Specification
 name: bidu-house
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Bidu Dev's Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-30 00:00:00.000000000 Z
+date: 2016-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: concern_builder
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bidu-active_ext
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json_parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
   name: activerecord
   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'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   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'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
 - !ruby/object:Gem::Dependency
   name: pry-nav
   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'
 - !ruby/object:Gem::Dependency
   name: simplecov
   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
@@ -171,8 +171,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -212,17 +212,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Gem for easy health check