is_it_working_info 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7a60e52e362dc055b4fe8fedf062a97133391e51
+  data.tar.gz: 06720201a043ab27a1804b884bdcb0fc8b7d216a
+SHA512:
+  metadata.gz: de1f61f51d45333a122ad272296f19725b54fabddfc06215a3acdf8355f475f749c2bf54b3c36edacb2811075b0cb4aba27b47d2a92fc0e8e676ed7fdc07d53a
+  data.tar.gz: a50c1fc03474502db339dffd090c5630bfa425cfb5b36e9839950f45aa7483b93abfd8423da902208488403d3328d725f63dc893f1610bb30510b1506567ad2b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in is_it_working_info.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Rob Jonson
+
+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,84 @@
+# IsItWorking
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/is_it_working`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'is_it_working_info'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install is_it_working_info
+
+## Create a Checkin at Is It Working
+
+Log in to Is It Working and create a 'Checkin'.
+Click on the 'Use' button to get your CHECKIN_IDENTIFIER
+
+## Usage
+
+Send a simple checkin with
+
+```ruby
+IsItWorkingInfo::Checkin.ping(key:"CHECKIN_IDENTIFIER")
+```
+
+Send more info with optional methods:
+
+```ruby
+IsItWorkingInfo::Checkin.ping(key:"CHECKIN_IDENTIFIER",message:"Your Info",status:0,time:123, boundary:1000)
+```
+
+Time your code with:
+
+```ruby
+IsItWorkingInfo::Checkin.time(key:"CHECKIN_IDENTIFIER",message:"Is It Slow?", boundary:1000) do
+
+	#Your Code Here
+
+end
+```
+If your code takes longer than 1000 milliseconds to run, then that will trigger an error and IsItWorking will let you know.
+
+See the full api details at https://isitworking.info/docs/checkin_api
+
+## Configuration
+
+you can disable http calls with
+
+```ruby
+IsItWorkingInfo.configure do |config|
+	config.testing = true
+end
+```
+
+in Rails, you can disable for testing and development by adding an initialiser 
+
+`/config/initializers/is_it_working_info.rb`
+
+```ruby
+
+IsItWorkingInfo.configure do |config|
+	config.testing = Rails.env.test? || Rails.env.development?
+end
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/is_it_working.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "is_it_working_info"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/is_it_working_info.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'is_it_working_info/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "is_it_working_info"
+  spec.version       = IsItWorkingInfo::VERSION
+  spec.authors       = ["Rob Jonson"]
+  spec.email         = ["rob@hobbyistsoftware.com"]
+
+  spec.summary       = %q{Simple wrapper to monitor background task running and duration with IsItWorking.info}
+  spec.description   = %q{IsItWorking.info provides a service to monitor scripts. This wrapper provides simple methods to time scritps, or to report succesful running}
+  spec.homepage      = "https://github.com/ConfusedVorlon/IsItWorking-Ruby"
+  spec.license       = "MIT"
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '~> 2.0'
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/is_it_working_info/version.rb

@@ -0,0 +1,3 @@
+module IsItWorkingInfo
+  VERSION = "0.3.0"
+end

data/lib/is_it_working_info.rb

@@ -0,0 +1,74 @@
+require "is_it_working_info/version"
+require 'benchmark'
+
+module IsItWorkingInfo
+
+	##
+	# This class provides a wrapper for checking in with https://IsItWorking.info
+	class Checkin
+		attr_accessor :uri
+		attr_accessor :params
+		attr_accessor :response
+
+
+		#checkin with IsItWorking
+		def self.ping(key:nil,message:nil,status:nil,time:nil, boundary:nil)
+			if key.nil?
+				raise 'You must specify a key' 
+			end
+
+			checkin=Checkin.new
+			checkin.uri = URI("https://api.isitworking.info/c/#{key}")
+
+			if checkin.nil?
+				raise 'Unable to generate uri - please check your key' 
+			end
+
+			checkin.params = {
+			t: time,
+			b: boundary,
+			m: message,
+			s: status
+			}
+
+			if IsItWorkingInfo.configuration.testing
+				puts "IsItWorking testing. Would call: #{checkin.uri.to_s}"
+			else
+				checkin.result = Net::HTTP.post_form(checkin.uri,checkin.params)
+			end
+
+			checkin
+		end
+
+		#times the block, in milliseconds and sends the result to IsItWorking
+		def self.time(key:nil,message:nil,status:nil,boundary:nil, &block)
+			time = Benchmark.realtime do
+				block.call
+			end
+			milliseconds = time * 1000
+
+			self.ping(key: key, message: message, status: status, time: milliseconds, boundary: boundary)
+		end
+
+	end
+
+	#config described by
+	#https://robots.thoughtbot.com/mygem-configure-block
+	class << self
+		attr_accessor :configuration
+	end
+
+	def self.configure
+		self.configuration ||= Configuration.new
+		yield(configuration)
+	end
+
+	class Configuration
+		attr_accessor :testing
+
+		def initialize
+			@testing = false
+		end
+	end
+
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: is_it_working_info
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Rob Jonson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: IsItWorking.info provides a service to monitor scripts. This wrapper
+  provides simple methods to time scritps, or to report succesful running
+email:
+- rob@hobbyistsoftware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- is_it_working_info.gemspec
+- lib/is_it_working_info.rb
+- lib/is_it_working_info/version.rb
+homepage: https://github.com/ConfusedVorlon/IsItWorking-Ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.3
+signing_key: 
+specification_version: 4
+summary: Simple wrapper to monitor background task running and duration with IsItWorking.info
+test_files: []