dashy4r 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA512: 
+  data.tar.gz: c8a60d2428fb63c99a911c646530a6184b621e185f1a46e7c45bdd2a755ab221e540af693b5c3bdddea576ac30ec48955cc2b6c2f74ffd8828daf8e54a856989
+  metadata.gz: 236d89dd633c33fe215e5a8ac661976e85a2a397f143d1edb68168fb5f4cd208a9084a187b17bdc879410f27b0aa4ff026040a8b95a1b03d53cd0e4fcb9bfe85
+SHA1: 
+  data.tar.gz: 37201da6203a0367793c142503d9d67c2c033b4f
+  metadata.gz: 97eb5c41d2bd93bf6126fe83513979839806c318

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+group :development do
+  gem 'system_timer', '~> 1.2.4'
+  gem 'mime-types', '~> 1.16'
+  gem 'rest-client', '~> 1.6.7'
+  gem 'nokogiri', '~> 1.5.10'
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+end

data/Gemfile.lock

@@ -0,0 +1,57 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    builder (3.2.2)
+    faraday (0.8.9)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.1.1)
+    highline (1.6.21)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (1.0.0)
+    mime-types (1.25.1)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.11)
+    oauth2 (0.9.4)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.3.2)
+    rdoc (4.1.1)
+      json (~> 1.4)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    system_timer (1.2.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  jeweler (~> 2.0.1)
+  mime-types (~> 1.16)
+  nokogiri (~> 1.5.10)
+  rest-client (~> 1.6.7)
+  system_timer (~> 1.2.4)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Alabê Duarte
+
+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,47 @@
+dashy4r
+=======
+
+dashy4r is a gem that helps you use ruby to integrate with [Dashy](https://github.com/thoughtworks/dashy)
+
+## Documentation
+
+### Configuration file
+Create a file dashy_config.yml
+```yaml
+app_id: <YOUR_APP_ID>
+url: <YOUR_DASHY_URL>
+timeout: <YOUR_TIMEOUT_IN_SECONDS>
+```
+
+### Enable configuration
+```ruby
+  Dashy::Base.enable_with_config '<path for your dashy_config.yml>'
+```
+
+### Usage
+
+Simplest way of reporting status. It will fail if any exception is raised
+```ruby
+  Dashy::Runner.run_and_report_status_for do
+    # your code goes here
+    run_something_that_you_want_to_report_status
+  end
+```
+
+A more complete Runner setup where you can set options and also validate the response the response is the return of your block to run
+```ruby
+  Dashy::Runner.config_and_run do |runner|
+    runner.with_options  :environment => 'My Environment', :endpoint => 'My Web Service'
+    runner.block_to_run do
+      # your code goes here
+      run_something_that_you_want_to_report_status_and_returns_something
+    end
+    runner.valid_response? do |response|
+      # your code goes here
+      validates_response_and_returns_a_boolean(response)
+    end
+  end
+```
+
+### Very Important
+#### Works only with ruby 1.8.7

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "dashy4r"
+  gem.homepage = "http://github.com/fabiopereira/dashy4r"
+  gem.license = "MIT"
+  gem.summary = "dashy4r is a gem that helps you use ruby to integrate with [Dashy](https://github.com/thoughtworks/dashy)"
+  gem.description = "Intercept endpoint calls to notify a Dash server about endpoint status"
+  gem.email = "aduarte@thoughtworks.com"
+  gem.authors = ["ThoughtWorks"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "dashy4r #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/dashy/base.rb

@@ -0,0 +1,17 @@
+module Dashy
+  class Base
+
+    def self.enable_with_config config_file_path
+      @config = Dashy::ConfigYml.new config_file_path
+      @enabled = true
+    end
+
+    def self.enabled?
+      @enabled
+    end
+
+    def self.config
+      @config
+    end
+  end
+end

data/lib/dashy/config_yml.rb

@@ -0,0 +1,23 @@
+require 'yaml'
+
+module Dashy
+  class ConfigYml
+    DEFAULT_TIMEOUT = 5
+
+    def initialize file_path
+      @yaml ||= YAML.load_file(file_path)
+    end
+
+    def app_id
+      @yaml['app_id']
+    end
+
+    def url
+      @yaml['url']
+    end
+
+    def timeout
+      @yaml['timeout'] || DEFAULT_TIMEOUT
+    end
+  end
+end

data/lib/dashy/rest_interface.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'system_timer'
+require 'rest_client'
+
+module Dashy
+  class RestInterface
+
+    def self.report_status options = {}
+      return unless Dashy::Base.enabled?
+      begin
+        config = Dashy::Base.config
+        # TODO: change SystemTimer to use Timeout::timeout instead for ruby ~>1.9
+        SystemTimer.timeout_after(config.timeout) do
+          RestClient.post "#{config.url}/requests/#{config.app_id}", :request => options
+        end
+      rescue => e
+        puts e
+      end
+    end
+  end
+end

data/lib/dashy/runner.rb

@@ -0,0 +1,52 @@
+module Dashy
+  class Runner
+
+    def self.run_and_report_status_for &block
+      Dashy::Runner.config_and_run do |runner|
+        runner.block_to_run &block
+      end
+    end
+
+    def self.config_and_run
+      runner = Dashy::Runner.new
+      yield runner
+      runner.run
+    end
+
+    def block_to_run &block
+      @block_to_run = block
+    end
+
+    def with_options options = {}
+      @options = options
+    end
+
+    def valid_response? &block
+      @valid_response_block = block
+    end
+
+    def run
+      raise 'Please before running Dashy you need to set the block_to_run' unless @block_to_run
+      begin
+        response = @block_to_run.call
+        Dashy::RestInterface.report_status(({:success => valid_response_after_calling_block?(response)}).merge(extra_options))
+        return response
+      rescue StandardError => e
+        Dashy::RestInterface.report_status(({:success => false}).merge(extra_options))
+        raise
+      end
+    end
+
+
+    protected
+    def valid_response_after_calling_block? response
+      return true unless @valid_response_block
+      @valid_response_block.call response
+    end
+
+    def extra_options
+      @options || {}
+    end
+
+  end
+end

data/lib/dashy4r.rb

@@ -0,0 +1,10 @@
+# require 'dashy/base'
+# require 'dashy/config_yml'
+# require 'dashy/rest_interface'
+# require 'dashy/runner'
+
+require "#{File.dirname(__FILE__)}/dashy/base"
+require "#{File.dirname(__FILE__)}/dashy/config_yml"
+require "#{File.dirname(__FILE__)}/dashy/rest_interface"
+require "#{File.dirname(__FILE__)}/dashy/runner"
+

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: dashy4r
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- ThoughtWorks
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2014-06-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.2.4
+  version_requirements: *id001
+  prerelease: false
+  type: :development
+  name: system_timer
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.16"
+  version_requirements: *id002
+  prerelease: false
+  type: :development
+  name: mime-types
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.6.7
+  version_requirements: *id003
+  prerelease: false
+  type: :development
+  name: rest-client
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.10
+  version_requirements: *id004
+  prerelease: false
+  type: :development
+  name: nokogiri
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+  version_requirements: *id005
+  prerelease: false
+  type: :development
+  name: bundler
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.0.1
+  version_requirements: *id006
+  prerelease: false
+  type: :development
+  name: jeweler
+description: Intercept endpoint calls to notify a Dash server about endpoint status
+email: aduarte@thoughtworks.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/dashy/base.rb
+- lib/dashy/config_yml.rb
+- lib/dashy/rest_interface.rb
+- lib/dashy/runner.rb
+- lib/dashy4r.rb
+homepage: http://github.com/fabiopereira/dashy4r
+licenses: 
+- MIT
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - &id007 
+    - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id007
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: dashy4r is a gem that helps you use ruby to integrate with [Dashy](https://github.com/thoughtworks/dashy)
+test_files: []
+