ping-my-site 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 33f3e581efc5cf1ac95fde19e698ca1e5548dfa7
+  data.tar.gz: f40a0044ef2567824d7ddf4be94d2ba0aa9e1d8d
+SHA512:
+  metadata.gz: 0bf1d58c5da7a04259a570a1bdedd1e0e1d6c46d99b96e8e1147bd79df779db044ce607e9c9cbf547b56175fa8aede13a0cd30acdfa991f0ec4cab2bebf2bec0
+  data.tar.gz: 15e3d017ae2c2c3577fdf335e8e61b133f6697d6706b836ecf442e866b5d8316bea8331e536581ebabcefeae7c6b8e898ef09e38ff380bc7c87bd448b2865700

data/.env_schema

@@ -0,0 +1 @@
+SLACK_WEBHOOK_URL:

data/.gitignore

@@ -0,0 +1 @@
+.env

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm use 2.2.0@ping-my-site --create
+rvm_trust_rvmrcs_flag=1

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'dotenv-schema', '~> 0.0.1'
+gem 'thor', '~> 0.19.1'
+gem 'curb', '~> 0.9.0'
+gem 'slack-notifier', '~> 1.5', '>= 1.5.1'
+
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,33 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    curb (0.9.0)
+    diff-lcs (1.2.5)
+    dotenv (2.0.2)
+    dotenv-schema (0.0.1)
+      dotenv
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    slack-notifier (1.5.1)
+    thor (0.19.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  curb (~> 0.9.0)
+  dotenv-schema (~> 0.0.1)
+  rspec
+  slack-notifier (~> 1.5, >= 1.5.1)
+  thor (~> 0.19.1)

data/README.md

@@ -0,0 +1,59 @@
+# Ping My Site
+
+A simple CLI Pingdom-like written in ruby.
+
+## How to use
+
+### Git clone
+
+> git clone https://github.com/cedricbousmanne/PingMySite.git
+
+### Install required Gem
+
+> bundle
+
+### dotenv (.env)
+
+Copy the ```.env_schema```file to ```.env```and fill it.
+> cp .env_schema .env
+
+### Run
+
+> bin/ping-my-site ping http://google.com --expected-status-code 200  --follow-location false
+
+### Options
+
+* ```--expected-status-code XXX``` : define the expected HTTP status code (default: ```200```)
+* ```--follow-location true```: allow CURL to follow HTTP redirection (default: false)
+
+## Usecase
+
+### Test HTTP status
+
+> bin/ping-my-site ping http://google.com --expected-status-code 200
+
+### Test HTTP redirection
+
+> bin/ping-my-site ping http://mysite.be --expected-status-code 301 --follow-location false --expected-redirect-url http://www.mysite.be
+
+## Troubleshooting
+
+### Dotenv::Schema::ValidationError
+
+Something is missing in your ```.env```file. Compare it to ```.env_schema```and be sure every constant is defined.
+
+## Use with crontab
+
+> * * * * * /bin/bash -l -c 'cd /path/to/ping-my-site/ && bundle exec bin/ping-my-site ping http://www.6x7asbl.be --expected-status-code 200 --follow-location false'
+
+## Technologies
+
+* [Dotenv Schema](https://github.com/mirakui/dotenv-schema)
+* [Thor](http://whatisthor.com/)
+* [Curb](https://github.com/taf2/curb)
+* [Slack-Notifier](https://github.com/stevenosloan/slack-notifier)
+
+## Foot Note
+
+Coded with ♥, [Ruby](https://www.ruby-lang.org/) and [Vim](http://www.vim.org/). Made in Belgium.
+

data/bin/ping-my-site

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'rubygems' unless defined? Gem
+require 'ping-my-site'
+
+Dotenv.load 
+
+PingMySite::Cli.start(ARGV)

data/lib/notifier.rb

@@ -0,0 +1,26 @@
+class Notifier
+  
+  def initialize(message)
+    @message = message
+  end
+
+  def notifier
+    @notifier ||= Slack::Notifier.new ENV['SLACK_WEBHOOK_URL']
+    @notifier.username = "Ping My Site"
+    @notifier
+  end
+  
+  def perform
+    unless $TESTING
+      notification = notifier.ping(@message)
+      
+      if notification.response.code.to_i == 200
+        puts "Successfully notified to Slack"
+      else
+        puts "Something went wrong when trying to notify Slack"
+      end
+    else
+      return "Successfully notified to Slack"
+    end
+  end
+end

data/lib/ping-my-site.rb

@@ -0,0 +1,28 @@
+#require "ping-my-site/version"
+require "dotenv-schema"
+require "thor"
+require "curb"
+require "slack-notifier"
+require "notifier"
+require "pinger"
+
+$TESTING = false
+
+module PingMySite
+  class Cli < Thor
+    option :follow_location, type: :boolean, default: false, desc: "Allow CURL to follow HTTP redirection"
+    option :expected_status_code, type: :numeric, default: 200, desc: "A valid HTTP status code"
+    option :expected_redirect_url, type: :string, desc: "A valid redirection url"
+
+    desc "ping URL", "ping to URL"
+    def ping(url)
+      pinger = Pinger.new
+      pinger.url = url
+      pinger.expected_status_code  = options[:expected_status_code]
+      pinger.expected_redirect_url = options[:expected_redirect_url]
+      pinger.follow_location       = options[:follow_location]
+      pinger.perform
+    end
+
+  end
+end

data/lib/pinger.rb

@@ -0,0 +1,45 @@
+class Pinger
+
+  attr_accessor :url, 
+    :expected_status_code, 
+    :expected_redirect_url,
+    :follow_location
+
+  def perform
+    if response_code.to_i == @expected_status_code
+      # Everything's fine
+      puts "Sucessfully ping #{url} with expected status code #{@expected_status_code}"
+      if @expected_status_code == 301 and @expected_redirect_url
+        if redirect_url == @expected_redirect_url
+          # Everything's fine
+          puts "Sucessfully redirect #{url} to #{@expected_redirect_url} with status #{response_code}"
+        else
+          message = "Unable to redirect #{url} to #{@expected_redirect_url} with expected status code #{@expected_status_code} - Received location #{redirect_url} with #{response_code} instead"   
+          puts "Something went wrong, we must notify someone"
+          Notifier.new(message).perform
+        end
+      end
+    else
+      message = "Unable to ping #{url} with expected status code #{@expected_status_code} - Received #{response_code} instead"
+      puts "Something went wrong, we must notify someone"
+      Notifier.new(message).perform
+    end
+  end
+
+
+  def response_code
+    request.response_code
+  end
+
+  def redirect_url
+    request.redirect_url
+  end
+
+  def request
+    @request ||= Curl::Easy.new(@url) do |curl|
+      curl.follow_location = @follow_location
+    end
+    @request.perform
+    @request
+  end
+end

data/spec/ping-my-site.rb

@@ -0,0 +1,21 @@
+require './lib/ping-my-site'
+$TESTING = true # Override $TESTING - this line must stay below the ```require '.lib/ping-my-site'``
+
+describe PingMySite do
+
+  let(:shell){ Thor::Base.shell.new }
+
+  describe "output" do
+    # Dummy test
+    specify { expect { print('foo') }.to output('foo').to_stdout }
+
+    # HTTP 200 successful test
+    specify { expect { PingMySite.start(%w[ping http://www.greenlab-coworking.com], shell: shell) }.to output("Sucessfully ping http://www.greenlab-coworking.com with expected status code 200\n").to_stdout }
+    
+    # HTTP 404 unsuccessful test
+    specify { expect { PingMySite.start(%w[ping http://www.greenlab-coworking.com --expected-status-code 404], shell: shell) }.to output("Something went wrong, we must notify someone\n").to_stdout }
+
+    # HTTP 301 successful test
+    specify { expect { PingMySite.start(%w[ping http://13pixels.be --expected-status-code 301 --follow-location false --expected-redirect-url http://www.13pixels.be], shell: shell) }.to output("Sucessfully ping http://13pixels.be with expected status code 301\nSucessfully redirect http://13pixels.be to http://www.13pixels.be with status 301\n").to_stdout }
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: ping-my-site
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Cédric Bousmanne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-02 00:00:00.000000000 Z
+dependencies: []
+description: ''
+email:
+- i@cedricbousmanne.com
+executables:
+- ping-my-site
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env_schema"
+- ".gitignore"
+- ".rvmrc"
+- Gemfile
+- Gemfile.lock
+- README.md
+- bin/ping-my-site
+- lib/notifier.rb
+- lib/ping-my-site.rb
+- lib/pinger.rb
+- spec/ping-my-site.rb
+homepage: http://cedric.io
+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.5
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- spec/ping-my-site.rb