abril_heartbeat 1.0.0

data/spec/heartbeater_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe AbrilHeartbeat::Heartbeater do
+  let(:file_path) { "#{File.dirname(__FILE__)}/support/heartbeat_example.yml" }
+
+  before do
+    allow(AbrilHeartbeat::RestChecker).to receive(:run!) { {"REST" => "MOCK"} }
+    allow(AbrilHeartbeat::MongoChecker).to receive(:run!) { {"MONGO" => "MOCK"} }
+  end
+
+  describe "#run!" do
+    describe "Default checkers" do
+      subject { described_class.new({file_path: file_path}).run! }
+
+      context "when the app has more than one dependency" do
+        before do
+          allow(AbrilHeartbeat::RestChecker).to receive(:is_running?) { true }
+          allow(AbrilHeartbeat::MongoChecker).to receive(:is_running?) { true }
+        end
+
+        it { is_expected.to eql([{"REST" => "MOCK"}, {"MONGO" => "MOCK"}]) }
+      end
+
+      context "when the app just have on kind of dependency" do
+        before do
+          allow(AbrilHeartbeat::RestChecker).to receive(:is_running?) { false }
+          allow(AbrilHeartbeat::MongoChecker).to receive(:is_running?) { true }
+        end
+
+        it { is_expected.to eql([{"MONGO" => "MOCK"}]) }
+      end
+    end
+
+    describe "Custom checkers" do
+      let(:custom_checker) { double("CustomChecker", is_running?: true) }
+
+      subject { described_class.new({file_path: file_path, custom_checkers: [custom_checker]}) }
+
+      before do
+        allow(AbrilHeartbeat::RestChecker).to receive(:is_running?) { false }
+        allow(AbrilHeartbeat::MongoChecker).to receive(:is_running?) { false }
+        allow(AbrilHeartbeat::MysqlChecker).to receive(:is_running?) { false }
+      end
+
+      it "returns the status codes" do
+        expect(custom_checker).to receive(:is_running?)
+        expect(custom_checker).to receive(:run!)
+
+        subject.run!
+      end
+    end
+  end
+end

data/spec/middleware/abril_heartbeat_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'rack/test'
+require 'abril_heartbeat'
+require 'json'
+
+describe AbrilHeartbeat::Middleware, :vcr do
+  include Rack::Test::Methods
+
+  let(:app)        { ->(env) { [200, env, "app"] } }
+  let(:middleware) { described_class.new(app, {file_path: file_path}) }
+  let(:file_path)  { "#{File.dirname(__FILE__)}/../support/heartbeat_example.yml" }
+  let(:response)   { [[{"REST" => [api_success_response, api_not_found_response, api_wrong_url_response]}].to_json] }
+  let(:api_success_response)   { build(:api_success) }
+  let(:api_not_found_response) { build(:api_not_found) }
+  let(:api_wrong_url_response) { build(:api_wrong_url) }
+
+  describe "when middleware handles the request" do
+    it "responds success" do
+      status, env, body = middleware.call env_for('http://www.example.com/heartbeat')
+
+      expect(status).to eql(200)
+      expect(body).to eql(response)
+    end
+  end
+
+  describe "when middleware does not handle the request" do
+    it "responds success" do
+      status, env, body = middleware.call env_for('http://www.example.com/')
+
+      expect(status).to eql(200)
+      expect(body).to eql("app")
+    end
+  end
+
+  def env_for(url, opts={})
+    Rack::MockRequest.env_for(url, opts)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+require "#{File.dirname(__FILE__)}/../lib/abril_heartbeat"
+
+# Load Factories
+require 'factory_girl'
+FactoryGirl.find_definitions
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # Configure FactoryGirl Helper Methods
+  config.include FactoryGirl::Syntax::Methods
+
+  # Load Support Files
+  Dir["./spec/support/**/*.rb"].sort.each { |f| require f}
+end

data/spec/support/heartbeat_example.yml

@@ -0,0 +1,11 @@
+api_success:
+  url: http://www.scudelletti.com
+  type: rest
+
+api_not_found:
+  url: http://www.scudelletti.com/not_found
+  type: rest
+
+api_wrong_url:
+  url: I am a wrong url
+  type: rest

data/spec/support/shared_examples/checker_share.rb

@@ -0,0 +1,21 @@
+RSpec.shared_examples "a checker" do
+  let(:response) {{ "MODEL" => {"status"=>"OK", "status_message"=>"Everything is OK"} }}
+
+  subject{ described_class }
+
+  it { is_expected.to respond_to(:is_running?) }
+  it { is_expected.to respond_to(:module_name) }
+  it { is_expected.to respond_to(:run!) }
+  it { is_expected.to respond_to(:check!) }
+
+  describe "#run!" do
+    before do
+      allow(described_class).to receive(:module_name) { "MODEL" }
+      allow(described_class).to receive(:check!) { ["OK", "Everything is OK"] }
+    end
+
+    subject { described_class.run! }
+
+    it { is_expected.to eql(response) }
+  end
+end

data/spec/support/vcr.rb

@@ -0,0 +1,7 @@
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.configure_rspec_metadata!
+  c.hook_into :webmock
+end

metadata

@@ -0,0 +1,234 @@
+--- !ruby/object:Gem::Specification
+name: abril_heartbeat
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Diogo Scudelletti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.4.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.18.0
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+description: This GEM is a middleware which adds a heartbeat route to your Apps, a
+  route which checks your external dependencies such as MySQL, Mongo, Redis and REST
+  APIs.
+email:
+- diogo@scudelletti.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- abril_heartbeat.gemspec
+- lib/abril_heartbeat.rb
+- lib/abril_heartbeat/checkers/abstract_checker.rb
+- lib/abril_heartbeat/checkers/mongo_checker.rb
+- lib/abril_heartbeat/checkers/mysql_checker.rb
+- lib/abril_heartbeat/checkers/redis_checker.rb
+- lib/abril_heartbeat/checkers/rest_checker.rb
+- lib/abril_heartbeat/config_loader.rb
+- lib/abril_heartbeat/heartbeater.rb
+- lib/abril_heartbeat/version.rb
+- lib/abril_heartbeat/wrappers/mongo_wrapper.rb
+- lib/abril_heartbeat/wrappers/mysql_wrapper.rb
+- lib/abril_heartbeat/wrappers/redis_wrapper.rb
+- spec/cassettes/AbrilHeartbeat_Middleware/when_middleware_handles_the_request/responds_success.yml
+- spec/cassettes/HeartbeatAbril_Middleware/when_middleware_handles_the_request/responds_success.yml
+- spec/checkers/abstract_checker_spec.rb
+- spec/checkers/mongo_checker_spec.rb
+- spec/checkers/mysql_checker_spec.rb
+- spec/checkers/redis_checker_spec.rb
+- spec/checkers/rest_checker_spec.rb
+- spec/factories/rest_status.rb
+- spec/heartbeater_spec.rb
+- spec/middleware/abril_heartbeat_spec.rb
+- spec/spec_helper.rb
+- spec/support/heartbeat_example.yml
+- spec/support/shared_examples/checker_share.rb
+- spec/support/vcr.rb
+homepage: https://github.com/abril/abril_heartbeat
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Builds a heartbeat route for Apps
+test_files:
+- spec/cassettes/AbrilHeartbeat_Middleware/when_middleware_handles_the_request/responds_success.yml
+- spec/cassettes/HeartbeatAbril_Middleware/when_middleware_handles_the_request/responds_success.yml
+- spec/checkers/abstract_checker_spec.rb
+- spec/checkers/mongo_checker_spec.rb
+- spec/checkers/mysql_checker_spec.rb
+- spec/checkers/redis_checker_spec.rb
+- spec/checkers/rest_checker_spec.rb
+- spec/factories/rest_status.rb
+- spec/heartbeater_spec.rb
+- spec/middleware/abril_heartbeat_spec.rb
+- spec/spec_helper.rb
+- spec/support/heartbeat_example.yml
+- spec/support/shared_examples/checker_share.rb
+- spec/support/vcr.rb