mercy 1.3.0

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

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe Bidu::Mercy::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::Mercy::Report::Error)
+    end
+
+    it 'builds the report using the given configuration' do
+      expect(report.as_json).to eq( ids: ids, percentage: 0.25, status: :error )
+      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, status: :error } }
+
+      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::Mercy::Report::Error, external_key: :id, id: :failures }
+      end
+
+      it 'ignores the non customizable parameters' do
+        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
+    end
+  end
+end

data/spec/lib/bidu/mercy/report_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Bidu::Mercy::Report do
+  class Bidu::Mercy::Report::Dummy1 < Bidu::Mercy::Report
+    DEFAULT_OPTION = {
+      option_value: 1,
+      other_option: 10
+    }
+    json_parse :option_value, :other_option, case: :snake
+  end
+  class Bidu::Mercy::Report::Dummy2 < Bidu::Mercy::Report::Dummy1; end
+  class Bidu::Mercy::Report::Dummy3 < Bidu::Mercy::Report::Dummy1
+    DEFAULT_OPTION = { option_value: 5 }
+  end
+
+  describe 'default_options' do
+    let(:report_class) { described_class::Dummy1 }
+    let(:subject) { report_class.new }
+    
+    it 'setup the attributes using class default options' do
+      expect(subject.option_value).to eq(1)
+      expect(subject.other_option).to eq(10)
+    end
+
+    context 'when class inherit options' do
+      let(:report_class) { described_class::Dummy2 }
+
+      it 'setup the attributes using superclass default options' do
+        expect(subject.option_value).to eq(1)
+        expect(subject.other_option).to eq(10)
+      end
+    end
+
+    context 'when class inherit options but overrides some' do
+      let(:report_class) { described_class::Dummy3 }
+
+      it 'setup the attributes using superclass default options' do
+        expect(subject.option_value).to eq(5)
+        expect(subject.other_option).to eq(10)
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe Bidu::Mercy::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,
+           status: status_expected
+         }
+       }
+    end
+
+    it do
+      expect(status).to be_a(Bidu::Mercy::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/mercy/status_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+
+describe Bidu::Mercy::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::Mercy::Report::Error.new(report_options) }
+  let(:success_report) do
+    Bidu::Mercy::Report::Error.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::Mercy::Report::Error.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,
+          status: :error
+        }
+      }
+    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,
+            status: :error
+          },
+          success: {
+            ids: success_ids,
+            percentage: 0.25,
+            status: :error
+          }
+        }
+      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,32 @@
+require 'simplecov'
+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'
+require 'bidu/mercy'
+
+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,6 @@
+class Document < ActiveRecord::Base
+  scope :with_error, proc { where(status: :error) }
+  scope :with_success, proc { where(status: :success) }
+  scope :type_a, proc { where(doc_type: :a) }
+  scope :type_b, proc { where(doc_type: :b) }
+end

data/spec/support/report/dummy.rb

@@ -0,0 +1,17 @@
+module Bidu
+  module Mercy
+    class Report
+      class Dummy < Report
+        ALLOWED_PARAMETERS=[:period, :threshold]
+        def initialize(options)
+        end
+      end
+    end
+  end
+end
+
+class Dummy
+  ALLOWED_PARAMETERS=[:period, :threshold]
+  def initialize(options)
+  end
+end