spacejam 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ac5243c6ac07615eb776378fef3d70026bbe9a14
+  data.tar.gz: 253dbbd2e2fcc0f4eba1d5c227775c1ceee1c04a
+SHA512:
+  metadata.gz: 7582612ad797bf514f6989e3eafeb285037ca2a585c0034ef2bb8e720101bf6ea09e069bae48dc82189ecf8615bf711131eb7949e2c52d9eb2057af66b5bb93f
+  data.tar.gz: f71b9814cee14dd0b2747d33042b3bdf737a6dec361c9ea8d64f1559eb5b3e992f4354dc6ad121aac83970facdedad4bbb765f6005e0fdb2676d1513feaec968

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Colin Mitchell
+
+MIT License
+
+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,90 @@
+# Spacejam -- A simple tool to check on the status of a website
+
+Spacejam is a ruby library for checking on the status of a website.
+You can use it to check if a page or site is online. I wrote it to
+keep an eye on the website for
+[Space Jam](http://www2.warnerbros.com/spacejam/movie/jam.htm). I
+wrote a [Twitter bot](https://twitter.com/SpaceJamCheck) that checks
+the status of the website multiple times a day.
+
+The library is basically a very simple wrapper around Curl. Here's how
+it works:
+
+
+    Spacejam.online?('http://muffinlabs.com')
+    => true
+
+
+    x = Spacejam::HTTPCheck.new('http://muffinlabs.com')
+    x.online?
+    => true
+
+Instead of just passing a URL, you can pass a hash with the URL and an expected
+response code:
+
+    x = Spacejam::HTTPCheck.new(url:'http://muffinlabs.com/missing_file.html', response_code:200)
+    x.online?
+    => false
+
+
+You can also check non-200 response codes. Admittedly, looking for a
+404 seems a little odd, but it still has it's uses.
+
+    x = Spacejam::HTTPCheck.new(url:'http://muffinlabs.com/missing_file.html', response_code:404)
+    x.online?
+    => true
+
+Also, you can check the body content of the page:
+
+    x = Spacejam::HTTPCheck.new(url:'http://muffinlabs.com/', body:"A string to check for")
+    x.online?
+    => true
+
+Both body and response_code attributes can be a regex:
+
+    x = Spacejam::HTTPCheck.new(
+        url:'http://muffinlabs.com/',
+        response_code:/20?/,
+        body:/muffinlabs/)
+    x.online?
+    => true
+
+If the request isn't successful, Spacejam can give you some
+information about what went wrong via the **reason** attribute:
+
+    x.reason
+    => :response_code
+
+The possible values are:
+ * **:response_code** - an unexpected response code
+ * **:body** - the body check failed
+ * **:error** - a network/DNS error, etc. You would get this if the
+     remote server was inaccessible or unresponsive.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'spacejam'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install spacejam
+
+
+## Contributing
+
+Please do! Pull requests are welcomed.
+
+## Copyright/License
+
+Copyright (c) 2014 Colin Mitchell. MIT License. Keep Circulating The Tapes.
+
+http://muffinlabs.com
+
+

data/Rakefile

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

data/lib/spacejam.rb

@@ -0,0 +1,15 @@
+require "spacejam/version"
+require 'curl'
+
+module Spacejam
+  require 'spacejam/http_check'
+  class << self
+    def check(*args)
+      Spacejam::HTTPCheck.new(*args)
+    end
+
+    def online?(*args)
+      Spacejam::HTTPCheck.new(*args).online?
+    end
+  end
+end

data/lib/spacejam/http_check.rb

@@ -0,0 +1,50 @@
+module Spacejam
+  class HTTPCheck
+    attr_accessor :url, :response_code, :body, :result, :reason
+    def initialize(opts={})
+      if opts.is_a?(String)
+        opts = {
+          url: opts
+        }
+      end
+
+      opts = {
+        response_code: 200,
+        body: nil
+      }.merge(opts)
+
+      @url = opts[:url]
+      @response_code = to_regexp(opts[:response_code])
+      @body = to_regexp(opts[:body])
+    end
+    
+    def online?
+      @reason = nil
+      @result = Curl::Easy.perform(@url)
+
+      if @response_code && @response_code.match(@result.response_code.to_s) == nil
+        @reason = :response_code
+        return false
+      end
+
+      if @body && @result.body_str.match(@body) == nil
+        @reason = :body
+        return false
+      end
+
+      true
+    rescue
+      @reason = :error
+      false
+    end
+
+    protected
+    def to_regexp(s)
+      return if !s
+      if ! s.is_a?(Regexp)
+        s = Regexp.compile(s.to_s)
+      end
+      s
+    end
+  end
+end

data/lib/spacejam/version.rb

@@ -0,0 +1,3 @@
+module Spacejam
+  VERSION = "0.0.1"
+end

data/spacejam.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spacejam/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spacejam"
+  spec.version       = Spacejam::VERSION
+  spec.authors       = ["Colin Mitchell"]
+  spec.email         = ["colin@muffinlabs.com"]
+  spec.description   = %q{Check on the status of a website}
+  spec.summary       = %q{Check on the status of a website}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 5.2.1"
+  spec.add_dependency "curb"
+end

data/test/http_check_test.rb

@@ -0,0 +1,59 @@
+require 'test_helper'
+
+class HTTPCheckTest < MiniTest::Test
+  def test_works_with_string
+    @checker = Spacejam::HTTPCheck.new('http://www.google.com/')
+    assert @checker.online?   
+  end
+
+  def test_works_with_hash
+    @checker = Spacejam::HTTPCheck.new(url:'http://www.google.com/')
+    assert @checker.online?
+  end
+
+  def test_works_with_hash_and_response_code
+    @checker = Spacejam::HTTPCheck.new(url:'http://www.google.com/', response_code:200)
+    assert @checker.online?
+  end
+
+  def test_works_with_hash_and_bad_response_code
+    @checker = Spacejam::HTTPCheck.new(url:'http://www.google.com/', response_code:555)
+    assert !@checker.online?
+    assert @checker.reason == :response_code
+  end
+
+  def test_works_with_bad_host
+    @checker = Spacejam::HTTPCheck.new('http://foobar.loc/')
+    assert !@checker.online?
+    assert @checker.reason == :error
+  end
+
+  def test_works_with_bad_path
+    @checker = Spacejam::HTTPCheck.new('http://www.google.com/weird.html')
+    assert !@checker.online?
+    assert @checker.reason == :response_code
+  end
+
+  def test_works_with_response_code_as_regex
+    @checker = Spacejam::HTTPCheck.new(url:'http://www.google.com/', response_code:Regexp.new('200'))
+    assert @checker.online?
+  end
+
+  def test_works_with_body
+    @checker = Spacejam::HTTPCheck.new(url:'http://www.google.com/', body:"Google has many special features to help you find exactly what you're looking for")
+    assert @checker.online?
+  end
+
+  def test_works_with_body_as_regex
+    @checker = Spacejam::HTTPCheck.new(url:'http://www.google.com/', body:Regexp.new("Google has many special features to help you find exactly what you're looking for"))
+    assert @checker.online?
+  end
+
+  def test_works_with_body_as_regex
+    @checker = Spacejam::HTTPCheck.new(url:'http://www.google.com/', body:Regexp.new("Yahoo"))
+    assert !@checker.online?
+    assert @checker.reason == :body
+  end
+  
+end
+

data/test/spacejam_test.rb

@@ -0,0 +1,63 @@
+require 'test_helper'
+
+class SpacejamTest < MiniTest::Test
+  def test_online_works
+    assert Spacejam.online?('http://www.google.com/')
+  end
+
+  def test_works_with_string
+    @checker = Spacejam.check('http://www.google.com/')
+    assert @checker.online?   
+  end
+
+  def test_works_with_hash
+    @checker = Spacejam.check(url:'http://www.google.com/')
+    assert @checker.online?
+  end
+
+  def test_works_with_hash_and_response_code
+    @checker = Spacejam.check(url:'http://www.google.com/', response_code:200)
+    assert @checker.online?
+  end
+
+  def test_works_with_hash_and_bad_response_code
+    @checker = Spacejam.check(url:'http://www.google.com/', response_code:555)
+    assert !@checker.online?
+    assert @checker.reason == :response_code
+  end
+
+  def test_works_with_bad_host
+    @checker = Spacejam.check('http://foobar.loc/')
+    assert !@checker.online?
+    assert @checker.reason == :error
+  end
+
+  def test_works_with_bad_path
+    @checker = Spacejam.check('http://www.google.com/weird.html')
+    assert !@checker.online?
+    assert @checker.reason == :response_code
+  end
+
+  def test_works_with_response_code_as_regex
+    @checker = Spacejam.check(url:'http://www.google.com/', response_code:Regexp.new('200'))
+    assert @checker.online?
+  end
+
+  def test_works_with_body
+    @checker = Spacejam.check(url:'http://www.google.com/', body:"Google has many special features to help you find exactly what you're looking for")
+    assert @checker.online?
+  end
+
+  def test_works_with_body_as_regex
+    @checker = Spacejam.check(url:'http://www.google.com/', body:Regexp.new("Google has many special features to help you find exactly what you're looking for"))
+    assert @checker.online?
+  end
+
+  def test_works_with_body_as_regex
+    @checker = Spacejam.check(url:'http://www.google.com/', body:Regexp.new("Yahoo"))
+    assert !@checker.online?
+    assert @checker.reason == :body
+  end
+  
+end
+

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'spacejam'
+require 'minitest/autorun'
+require 'minitest/pride'
+

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: spacejam
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Colin Mitchell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Check on the status of a website
+email:
+- colin@muffinlabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/spacejam.rb
+- lib/spacejam/http_check.rb
+- lib/spacejam/version.rb
+- spacejam.gemspec
+- test/http_check_test.rb
+- test/spacejam_test.rb
+- test/test_helper.rb
+homepage: ''
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Check on the status of a website
+test_files:
+- test/http_check_test.rb
+- test/spacejam_test.rb
+- test/test_helper.rb