bidu-house 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bf8431dbc896d4009687b3896a2d11f268d48a18
+  data.tar.gz: 295a7b922f4af26fb58e8a5b4d59ce6cba59c512
+SHA512:
+  metadata.gz: 94962c145b428b9a261b5df1871586a556d15553ebdd97ef1c36fa2f1ba3e171e3e21672f60df3a624329c05dc72375dac38dd4f042c6840dc95710def42ec16
+  data.tar.gz: f596699a632c86fd136b50312db1490528b6d9bdfadde67405a9a19add49122fb9130d0009c3cf2d9c347bb4af044577baba07fe96075e15d1d199c3e7cdc6b8

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,69 @@
+PATH
+  remote: .
+  specs:
+    bidu-house (0.1.0)
+      activesupport
+      bidu-core_ext
+      concern_builder
+      json_parser (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.3)
+      activesupport (= 4.2.3)
+      builder (~> 3.1)
+    activerecord (4.2.3)
+      activemodel (= 4.2.3)
+      activesupport (= 4.2.3)
+      arel (~> 6.0)
+    activesupport (4.2.3)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.0)
+    bidu-core_ext (1.0.0)
+      activesupport
+    builder (3.2.2)
+    concern_builder (0.0.1)
+      activesupport
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    json_parser (1.1.0)
+      activesupport
+      concern_builder
+    minitest (5.7.0)
+    rake (10.4.2)
+    rspec (2.99.0)
+      rspec-core (~> 2.99.0)
+      rspec-expectations (~> 2.99.0)
+      rspec-mocks (~> 2.99.0)
+    rspec-core (2.99.2)
+    rspec-expectations (2.99.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.99.4)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    sqlite3 (1.3.10)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  bidu-house!
+  bundler (~> 1.6)
+  rake
+  rspec (~> 2.14)
+  simplecov
+  sqlite3

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,2 @@
+# house
+Health Check Gem

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/house.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bidu/house/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'bidu-house'
+  gem.version       = Bidu::House::VERSION
+  gem.authors       = ["Bidu Dev's Team"]
+  gem.email         = ["dev@bidu.com.br"]
+  gem.homepage      = 'https://github.com/Bidu/house'
+  gem.description   = 'Gem for easy health check'
+  gem.summary       = gem.description
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f)  }
+  gem.test_files    = gem.files.grep(%r{^(test|gem|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'activesupport'
+  gem.add_runtime_dependency 'concern_builder'
+  gem.add_runtime_dependency 'bidu-core_ext'
+  gem.add_runtime_dependency 'json_parser', '~> 1.1'
+
+  gem.add_development_dependency "activerecord"
+  gem.add_development_dependency "sqlite3"
+
+  gem.add_development_dependency "bundler", "~> 1.6"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec", "~> 2.14"
+  gem.add_development_dependency 'simplecov'
+end

data/lib/active_record/relation_ext.rb

@@ -0,0 +1,19 @@
+require 'active_record'
+
+module ActiveRecord
+  class Relation
+    def percentage(*filters)
+      return 0 if count == 0
+
+      if filters.first.is_a?(Symbol)
+        filtered = filters.inject(self) do |relation, scope|
+          relation.public_send(scope)
+        end
+      else
+        filtered = where(*filters)
+      end
+
+      filtered.count * 1.0 / count
+    end
+  end
+end

data/lib/bidu/house/class_methods.rb

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

data/lib/bidu/house/concern.rb

@@ -0,0 +1,10 @@
+module Bidu
+  module House
+    extend ActiveSupport::Concern
+
+    def render_status(key)
+      status = self.class.status_builder.build(key, params)
+      render json: status.as_json, status: status.status
+    end
+  end
+end

data/lib/bidu/house/error_report.rb

@@ -0,0 +1,51 @@
+module Bidu
+  module House
+    class ErrorReport
+      include JsonParser
+
+      attr_reader :json
+
+      json_parse :threshold, type: :float
+      json_parse :period, type: :period
+      json_parse :scope, :id, :clazz, :external_key, case: :snake
+
+      def initialize(options)
+        @json = {
+          external_key: :id,
+          threshold: 0.02,
+          period: 1.day,
+          scope: :with_error
+        }.merge(options)
+      end
+
+      def status
+        @status ||= error? ? :error : :ok
+      end
+
+      def percentage
+        @percentage ||= last_entires.percentage(scope)
+      end
+
+      def scoped
+        @scoped ||= last_entires.public_send(scope)
+      end
+
+      def error?
+        percentage > threshold
+      end
+
+      def as_json
+        {
+          ids: scoped.map(&external_key),
+          percentage: percentage
+        }
+      end
+
+      private
+
+      def last_entires
+        @last_entires ||= clazz.where('updated_at >= ?', period.seconds.ago)
+      end
+    end
+  end
+end

data/lib/bidu/house/report_builder.rb

@@ -0,0 +1,21 @@
+module Bidu
+  module House
+    class ReportBuilder
+      def build(key, parameters = {})
+        params = parameters.slice(:period, :threshold)
+        config = configs[key].merge(params)
+        Bidu::House::ErrorReport.new(config)
+      end
+
+      def add_config(key, config)
+        configs[key] = config
+      end
+
+      private
+
+      def configs
+        @configs ||= {}
+      end
+    end
+  end
+end

data/lib/bidu/house/status.rb

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

data/lib/bidu/house/status_builder.rb

@@ -0,0 +1,35 @@
+module Bidu
+  module House
+    class StatusBuilder
+      def build(key, parameters = {})
+        Bidu::House::Status.new(reports_for(key, parameters))
+      end
+
+      def add_report_config(key, config)
+        status_key = config.delete(:on) || :default
+        report_builder.add_config(key, config)
+        config_for(status_key) << key
+      end
+
+      private
+
+      def report_builder
+        @report_builder ||= Bidu::House::ReportBuilder.new
+      end
+
+      def reports_for(key, parameters)
+        config_for(key).map do |report_key|
+          report_builder.build(report_key, parameters)
+        end
+      end
+
+      def configs
+        @configs ||= {}
+      end
+
+      def config_for(key)
+        configs[key] ||= []
+      end
+    end
+  end
+end

data/lib/bidu/house/version.rb

@@ -0,0 +1,5 @@
+module Bidu
+  module House
+    VERSION = '0.1.0'
+  end
+end

data/lib/bidu/house.rb

@@ -0,0 +1,17 @@
+require 'active_record/relation_ext'
+require 'concern_builder'
+require 'bidu/core_ext'
+require 'bidu/period_parser'
+require 'json_parser'
+require 'json_parser/type_cast_ext'
+
+module Bidu
+  module House
+    require 'bidu/house/concern'
+    require 'bidu/house/error_report'
+    require 'bidu/house/status'
+    require 'bidu/house/report_builder'
+    require 'bidu/house/status_builder'
+    require 'bidu/house/class_methods'
+  end
+end

data/lib/bidu/period_parser.rb

@@ -0,0 +1,32 @@
+module Bidu
+  class PeriodParser
+    class << self
+      def parse(period)
+        return unless period
+        return period if period.is_a?(Integer)
+        new(period).to_seconds
+      end
+    end
+
+    def initialize(period)
+      @period = period
+    end
+
+    def to_seconds
+      return unless period.match(/^\d+(years|months|days|hours|minutes|seconds)?/)
+      type.blank? ? value.seconds : value.public_send(type)
+    end
+
+    private
+
+    attr_reader :period
+
+    def value
+      @period_value ||= period.gsub(/\D+/, '').to_i
+    end
+
+    def type
+      @period_type ||= period.gsub(/\d+/, '')
+    end
+  end
+end

data/lib/bidu.rb

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

data/lib/json_parser/type_cast_ext.rb

@@ -0,0 +1,7 @@
+module JsonParser
+  module TypeCast
+    def to_period(value)
+      Bidu::PeriodParser.parse(value)
+    end
+  end
+end

data/spec/lib/active_record/relation_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe ActiveRecord::Relation do
+  describe '#percentage' do
+    let(:error_number) { 1 }
+    let(:success_number) { 1 }
+
+    before do
+      Document.all.each(&:destroy)
+      error_number.times { Document.create(status: :error) }
+      success_number.times { Document.create(status: :success) }
+    end
+
+    context 'when there are 50% documents with error' do
+      it do
+        expect(Document.all.percentage(status: :error)).to eq(0.5)
+      end
+    end
+
+    context 'when there are 25% documents with error' do
+      let(:success_number) { 3 }
+
+      it do
+        expect(Document.all.percentage(status: :error)).to eq(0.25)
+      end
+    end
+
+    context 'when passing a sub scope' do
+      before do
+        Document.create(status: :on_going)
+      end
+
+      it 'does the math inside the scope' do
+        expect(Document.where(status: [:error, :success]).percentage(status: :error)).to eq(0.5)
+      end
+    end
+
+    context 'when passing a scope name instead of query' do
+      it 'does the math inside the scope' do
+        expect(Document.all.percentage(:with_error)).to eq(0.5)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,194 @@
+require 'spec_helper'
+
+describe Bidu::House::ErrorReport do
+  let(:errors) { 1 }
+  let(:successes) { 1 }
+  let(:old_errors) { 2 }
+  let(:threshold) { 0.02 }
+  let(:period) { 1.day }
+  let(:external_key) { :external_id }
+  let(:options) do
+    {
+      period: period,
+      threshold: threshold,
+      scope: :with_error,
+      clazz: Document,
+      external_key: external_key
+    }
+  end
+  let(:subject) { described_class.new(options) }
+  before do
+    Document.all.each(&:destroy)
+    successes.times { Document.create status: :success }
+    errors.times do |i|
+      Document.create status: :error, external_id: 10 * successes + i, outter_external_id: i
+    end
+    old_errors.times { Document.create status: :error, created_at: 2.days.ago, updated_at: 2.days.ago }
+  end
+
+  describe '#status' do
+    context 'when are more errors than the allowed by the threshold' do
+      let(:errors) { 1 }
+      let(:successes) { 3 }
+      it { expect(subject.status).to eq(:error) }
+    end
+
+    context 'when the threshold is 0 and there are no errors' do
+      let(:errors) { 0 }
+      let(:threshold) { 0 }
+      it { expect(subject.status).to eq(:ok) }
+    end
+
+    context 'when the threshold is 100% and there is 100% error' do
+      let(:successes) { 0 }
+      let(:threshold) { 1 }
+      it { expect(subject.status).to eq(:ok) }
+    end
+
+    context 'when there are no documents' do
+      let(:successes) { 0 }
+      let(:errors) { 0 }
+      it { expect(subject.status).to eq(:ok) }
+    end
+
+    context 'when there are older errors out of the period' do
+      let(:threshold) { 0.6 }
+
+      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
+
+  describe 'percentage' do
+    context 'when there are 25% erros' do
+      let(:errors) { 1 }
+      let(:successes) { 3 }
+      it { expect(subject.percentage).to eq(0.25) }
+    end
+
+    context 'when there are no errors' do
+      let(:errors) { 0 }
+      let(:threshold) { 0 }
+      it { expect(subject.percentage).to eq(0) }
+    end
+
+    context 'when there is 100% error' do
+      let(:successes) { 0 }
+      let(:threshold) { 1 }
+      it { expect(subject.percentage).to eq(1) }
+    end
+
+    context 'when there are no documents' do
+      let(:successes) { 0 }
+      let(:errors) { 0 }
+      it { expect(subject.percentage).to eq(0) }
+    end
+
+    context 'when there are older errors out of the period' do
+      let(:old_errors) { 2 }
+
+      it 'ignores the older errros' do
+        expect(subject.percentage).to eq(0.5)
+      end
+
+      context 'when passing a bigger period' do
+        let(:period) { 3.days }
+
+        it 'consider the older errros' do
+          expect(subject.percentage).to eq(0.75)
+        end
+      end
+    end
+  end
+
+  describe '#scoped' do
+    context 'when there are 25% erros' do
+      let(:errors) { 1 }
+      let(:successes) { 3 }
+      it 'returns only the scoped documents' do
+        expect(subject.scoped.count).to eq(1)
+      end
+    end
+
+    context 'when there are no errors' do
+      let(:errors) { 0 }
+      let(:threshold) { 0 }
+      it { expect(subject.scoped).to be_empty }
+    end
+
+    context 'when there are no documents' do
+      let(:successes) { 0 }
+      let(:errors) { 0 }
+      it { expect(subject.scoped).to be_empty }
+    end
+
+    context 'when there are older errors out of the period' do
+      let(:old_errors) { 2 }
+
+      it 'ignores the older errros' do
+        expect(subject.scoped.count).to eq(1)
+      end
+
+      context 'when passing a bigger period' do
+        let(:period) { 3.days }
+
+        it 'consider the older errros' do
+          expect(subject.scoped.count).to eq(3)
+        end
+      end
+    end
+  end
+
+  describe '#error?' do
+    context 'when errors percentage overcames threshold' do
+      it { expect(subject.error?).to be_truthy }
+    end
+
+    context 'when errors percentage does not overcames threshold' do
+      let(:errors) { 0 }
+      it { expect(subject.error?).to be_falsey }
+    end
+  end
+
+  describe '#as_json' do
+    context 'when there are 75% erros' do
+      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
+        expect(subject.as_json).to eq(expected)
+      end
+
+      context 'when configurated with different external key' do
+        let(:external_key) { :outter_external_id }
+        let(:ids_expected) { [0, 1, 2] }
+
+        it 'returns the correct external keys' do
+          expect(subject.as_json).to eq(expected)
+        end
+      end
+
+      context 'when configurated without external key' do
+        before { options.delete(:external_key) }
+        let(:ids_expected) { Document.with_error.where('created_at > ?', 30.hours.ago).map(&:id) }
+
+        it 'returns the ids as default id' do
+          expect(subject.as_json).to eq(expected)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe Bidu::House::ReportBuilder do
+  let(:errors) { 1 }
+  let(:successes) { 3 }
+  let(:old_errors) { 2 }
+  let(:key) { :errors }
+  let(:threshold) { 0.02 }
+  let(:period) { 1.day }
+  let(:external_key) { :external_id }
+  let(:config) do
+    {
+      period: period,
+      threshold: threshold,
+      external_key: :external_id,
+      scope: :with_error,
+      id: key,
+      clazz: Document
+    }
+  end
+  let(:parameters) { {} }
+  let(:report) { subject.build(key, parameters) }
+  before do
+    subject.add_config(key, config)
+    Document.all.each(&:destroy)
+    successes.times { |i| Document.create status: :success, external_id: 30+i }
+    errors.times { |i| Document.create status: :error, external_id: 10+i }
+    old_errors.times do |i|
+      Document.create status: :error, external_id: 20+i, created_at: 2.days.ago, updated_at: 2.days.ago
+    end
+  end
+
+  describe '#build' do
+    let(:ids) { [ 10 ] }
+    it do
+      expect(report).to be_a(Bidu::House::ErrorReport)
+    end
+
+    it 'builds the report using the given configuration' do
+      expect(report.as_json).to eq( ids: ids, percentage: 0.25 )
+      expect(report.error?).to be_truthy
+    end
+
+    context 'when passing a custom threshold parameter' do
+      let(:parameters) { { threshold: 1 } }
+
+      it 'uses custom threshold parameter' do
+        expect(report.error?).to be_falsey
+      end
+    end
+
+    context 'when passing a custom period parameter' do
+      let(:parameters) { { threshold: 0.4, period: 10.days } }
+
+      it 'uses custom period parameter' do
+        expect(report.error?).to be_truthy
+      end
+    end
+
+    context 'when passing a custom other parameters' do
+      let(:parameters) do
+        { scope: :with_success, clazz: Bidu::House::ErrorReport, external_key: :id, id: :failures }
+      end
+
+      it 'ignores the non customizable parameters' do
+        expect(report.as_json).to eq( ids: ids, percentage: 0.25 )
+        expect(report.error?).to be_truthy
+        expect(report.id).to eq(:errors)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe Bidu::House::StatusBuilder do
+  let(:errors) { 1 }
+  let(:successes) { 3 }
+  let(:old_errors) { 2 }
+  let(:key) { :errors }
+  let(:threshold) { 0.02 }
+  let(:period) { 1.day }
+  let(:external_key) { :external_id }
+  let(:config) do
+    {
+      period: period,
+      threshold: threshold,
+      scope: :with_error,
+      clazz: Document,
+      id: :failures,
+      external_key: :external_id,
+      on: key
+    }
+  end
+  let(:parameters) { {} }
+  let(:status) { subject.build(key, parameters) }
+  before do
+    subject.add_report_config(key, config)
+    Document.all.each(&:destroy)
+    successes.times { |i| Document.create status: :success, external_id: 30+i }
+    errors.times { |i| Document.create status: :error, external_id: 10+i }
+    old_errors.times do |i|
+      Document.create status: :error, external_id: 20+i, created_at: 2.days.ago, updated_at: 2.days.ago
+    end
+  end
+
+  describe '#build' do
+    let(:ids) { [ 10 ] }
+    let(:status_expected) { :error }
+    let(:percentage) { 0.25 }
+    let(:json_expected) do
+       {
+         status: status_expected,
+         failures: {
+           ids: ids,
+           percentage: percentage
+         }
+       }
+    end
+
+    it do
+      expect(status).to be_a(Bidu::House::Status)
+    end
+
+    context 'when not specifying where to report' do
+      let(:key) {}
+
+      it 'register report under default' do
+        expect(subject.build(:default).as_json).to eq(json_expected)
+      end
+    end
+
+    it 'builds the report using the given configuration' do
+      expect(status.as_json).to eq(json_expected)
+    end
+
+    context 'when passing a custom threshold parameter' do
+      let(:parameters) { { threshold: 1 } }
+      let(:status_expected) { :ok }
+
+      it 'uses custom threshold parameter' do
+        expect(status.as_json).to eq(json_expected)
+      end
+    end
+
+    context 'when passing a custom period parameter' do
+      let(:ids) { [ 10, 20, 21 ] }
+      let(:percentage) { 0.5 }
+      let(:parameters) { { threshold: 0.4, period: 10.days } }
+
+      it 'uses custom period parameter' do
+        expect(status.as_json).to eq(json_expected)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,132 @@
+require 'spec_helper'
+
+describe Bidu::House::Status do
+  let(:threshold) { 0.02 }
+  let(:period) { 1.day }
+  let(:report_options) do
+    {
+      period: period,
+      threshold: threshold,
+      scope: :with_error,
+      clazz: Document,
+      id: :errors
+    }
+  end
+  let(:success_options) do
+    report_options.merge(
+      scope: :with_success,
+      id: :success
+    )
+  end
+  let(:errors) { 0 }
+  let(:successes) { 1 }
+  let(:error_report) { Bidu::House::ErrorReport.new(report_options) }
+  let(:success_report) do
+    Bidu::House::ErrorReport.new(success_options)
+  end
+  let(:reports) { [ error_report ] }
+  let(:subject) { described_class.new(reports) }
+  before do
+    Document.all.each(&:destroy)
+    errors.times { Document.create status: :error }
+    successes.times { Document.create status: :success }
+  end
+
+  describe '#as_json' do
+    let(:status_json) { subject.as_json }
+    let(:status) { status_json[:status] }
+
+    context 'when report is ok' do
+      it 'returns a json with ok' do
+        expect(status).to eq(:ok)
+      end
+
+      it 'returns the report json' do
+
+      end
+    end
+
+    context 'when report is not ok' do
+      let(:errors) { 1 }
+
+      it 'returns a json with error' do
+        expect(status).to eq(:error)
+      end
+    end
+
+    context 'when there are both success and error reports' do
+      let(:success_report) do
+        Bidu::House::ErrorReport.new(report_options.merge(scope: :with_success))
+      end
+      let(:reports) { [ success_report, error_report ] }
+
+      it 'returns a json with error' do
+        expect(status).to eq(:error)
+      end
+    end
+  end
+
+  describe '#status' do
+    context 'when report is ok' do
+      it do
+        expect(subject.status).to eq(:ok)
+      end
+    end
+
+    context 'when report is not ok' do
+      let(:errors) { 1 }
+
+      it do
+        expect(subject.status).to eq(:error)
+      end
+    end
+
+    context 'when there are both success and error reports' do
+      let(:reports) { [ success_report, error_report ] }
+
+      it do
+        expect(subject.status).to eq(:error)
+      end
+    end
+  end
+
+  describe '#as_json' do
+    let(:errors) { 3 }
+    let(:ids) { Document.with_error.map(&:id) }
+    let(:expected) do
+      {
+        status: :error,
+        errors: {
+          ids: ids,
+          percentage: 0.75
+        }
+      }
+    end
+
+    it 'creates a summary of the reports' do
+      expect(subject.as_json).to eq(expected)
+    end
+
+    context 'when there are both success and error reports' do
+      let(:success_ids) { Document.with_success.map(&:id) }
+      let(:expected) do
+        {
+          status: :error,
+          errors: {
+            ids: ids,
+            percentage: 0.75
+          },
+          success: {
+            ids: success_ids,
+            percentage: 0.25
+          }
+        }
+      end
+      let(:reports) { [ success_report, error_report ] }
+
+      it 'creates a summary of all the reports' do
+        expect(subject.as_json).to eq(expected)
+      end
+    end
+  end
+end

data/spec/lib/bidu/period_parser_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Bidu::PeriodParser do
+  shared_examples 'a class who knows how to parse time' do |tests|
+    tests.each do |string, expected|
+      it "parses #{string} into #{expected} seconds" do
+        expect(described_class.parse(string)).to eq(expected)
+      end
+    end
+  end
+
+  it_behaves_like 'a class who knows how to parse time', {
+    '3' => 3.seconds,
+    '3seconds' => 3.seconds,
+    '3minutes' => 3.minutes,
+    '3hours' => 3.hours,
+    '3days' => 3.days,
+    '3months' => 3.months,
+    '3years' => 3.years
+  }
+
+  context 'when value is already a period' do
+    it 'returns the value itself' do
+      expect(described_class.parse(3.minutes)).to eq(3.minutes)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'bidu/house'
+
+require 'active_record'
+ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
+
+support_files = File.expand_path("spec/support/**/*.rb")
+Dir[support_files].each { |file| require file  }
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.filter_run_excluding :integration unless ENV['ALL']
+
+  config.order = 'random'
+
+  config.before do
+  end
+end

data/spec/support/fixture_helpers.rb

@@ -0,0 +1,19 @@
+require 'active_support'
+
+module FixtureHelpers
+  def load_fixture_file(filename)
+      File.read (['./spec/', 'fixtures', filename].join('/'))
+  end
+
+  def load_json_fixture_file(filename)
+    cached_json_fixture_file(filename)
+  end
+
+  private
+
+  def cached_json_fixture_file(filename)
+      ActiveSupport::JSON.decode(load_fixture_file(filename))
+  end
+end
+
+RSpec.configuration.include FixtureHelpers

data/spec/support/models/document.rb

@@ -0,0 +1,4 @@
+class Document < ActiveRecord::Base
+  scope :with_error, proc { where(status: :error) }
+  scope :with_success, proc { where(status: :success) }
+end

data/spec/support/schema.rb

@@ -0,0 +1,10 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :documents, :force => true do |t|
+    t.string :status
+    t.integer :external_id
+    t.integer :outter_external_id
+    t.timestamps null: true
+  end
+end

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification
+name: bidu-house
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bidu Dev's Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-06 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-core_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: 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
+email:
+- dev@bidu.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- house.gemspec
+- lib/active_record/relation_ext.rb
+- lib/bidu.rb
+- lib/bidu/house.rb
+- lib/bidu/house/class_methods.rb
+- lib/bidu/house/concern.rb
+- lib/bidu/house/error_report.rb
+- lib/bidu/house/report_builder.rb
+- lib/bidu/house/status.rb
+- lib/bidu/house/status_builder.rb
+- lib/bidu/house/version.rb
+- lib/bidu/period_parser.rb
+- lib/json_parser/type_cast_ext.rb
+- spec/lib/active_record/relation_spec.rb
+- spec/lib/bidu/house/error_report_spec.rb
+- spec/lib/bidu/house/report_builder_spec.rb
+- spec/lib/bidu/house/status_builder_spec.rb
+- spec/lib/bidu/house/status_spec.rb
+- spec/lib/bidu/period_parser_spec.rb
+- spec/spec_helper.rb
+- spec/support/fixture_helpers.rb
+- spec/support/models/document.rb
+- spec/support/schema.rb
+homepage: https://github.com/Bidu/house
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: Gem for easy health check
+test_files: []