github_status 0.0.1

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 github-status.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Murray Summers
+
+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,58 @@
+# GitHub Status API
+
+GitHub continuously monitors the status of github.com and all its related services. If there are any interruptions, the system status can be check on https://status.github.com/
+or querying the GitHub Status API.
+
+This library allows you to easily integrate and query the GitHub Status API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'github_status'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install github_status
+
+## Usage
+Firstly, the library can be used to wrap the whole of the Github Status API into objects.
+
+```
+require 'github_status'
+
+Github::Status.last_message
+=> #<GithubStatus::Status @created_on="2013-01-08T23:13:55Z", @message="Error Message ...",@status="minor">
+
+GithubStatus::Status.messages
+=> [#<Github::Status @created_on="2013-01-08T23:33:47Z", @message="Error Message ...", @status="minor">,
+    #<Github::Status @created_on="2013-01-08T23:33:47Z", @message="Error Message ...", @status="major">,
+    #<Github::Status @created_on="2013-01-08T23:33:47Z", @message="Error Message ...", @status="minor">]
+ 
+```
+
+Alternatively, the GitHub Status API can be queried directly:
+
+```
+GithubStatus::API.last_message
+=> { :status=>"minor", :body=>"Error message ...", :created_on=>"2013-01-08T23:33:47Z" }
+
+GithubStatus::API.messages
+=> [
+     { :status=>"minor", :body=>"Error message ...", :created_on=>"2013-01-08T23:33:47Z" },
+     { :status=>"minor", :body=>"Error message ...", :created_on=>"2013-01-08T23:33:47Z" }
+   ]
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')

data/github_status.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'github_status/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "github_status"
+  gem.version       = GithubStatus::VERSION
+  gem.authors       = GithubStatus::AUTHORS
+  gem.email         = GithubStatus::EMAIL
+  gem.summary       = GithubStatus::SUMMARY
+  gem.description   = GithubStatus::DESCRIPTION
+  gem.homepage      = GithubStatus::HOMEPAGE
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency("json")
+  
+  gem.add_development_dependency('rspec')
+  gem.add_development_dependency 'webmock'
+end

data/lib/github_status/api.rb

@@ -0,0 +1,48 @@
+module GithubStatus
+  class API
+    API_URL = "https://status.github.com/api.json"
+
+    STATUS_URL = "https://status.github.com/api/status.json" 
+
+    LAST_MESSAGE_URL = "https://status.github.com/api/last-message.json" 
+
+    MESSAGES_URL = "https://status.github.com/api/messages.json" 
+
+    def self.api
+      get(API_URL)
+    end
+
+    def self.current_status
+      get(STATUS_URL)
+    end
+
+    def self.last_message
+      get(LAST_MESSAGE_URL)
+    end
+
+    def self.messages
+      get(MESSAGES_URL)
+    end
+
+    private
+
+    def self.get(uri)
+      uri = prepare_uri(uri)
+      
+      response = Net::HTTP.start(uri.host, use_ssl: true) do |http|
+        request = Net::HTTP::Get.new(uri.request_uri)
+        http.request(request)
+      end
+
+      prepare_response(response)
+    end
+
+    def self.prepare_uri(uri)
+      URI.parse(uri)
+    end
+
+    def self.prepare_response(response)
+      JSON.parse(response.body, symbolize_names: true)
+    end
+  end
+end

data/lib/github_status/status.rb

@@ -0,0 +1,36 @@
+module GithubStatus
+  class Status
+
+    GOOD = "good"
+    MAJOR = "major"
+    MINOR = "minor"
+
+    attr_reader :status, :message, :created_on
+
+    def initialize(options)
+      @status = options[:status]
+      @message = options[:body]
+      @created_on = options[:created_on]
+    end
+
+    def self.last_message 
+      new(GithubStatus::API.last_message)
+    end
+
+    def self.messages
+      GithubStatus::API.messages.collect { |response| new(response) }
+    end
+    
+    def good?
+      status == GOOD
+    end
+
+    def major?
+      status == MAJOR
+    end
+    
+    def minor?
+      status == MINOR
+    end
+  end
+end

data/lib/github_status/version.rb

@@ -0,0 +1,17 @@
+module GithubStatus
+  VERSION = "0.0.1"
+  
+  AUTHORS = [
+    "Murray Summers"
+  ]
+
+  EMAIL = [
+    "murray.sum@gmail.com"
+  ]
+
+  SUMMARY = "Github Status API"
+
+  HOMEPAGE = "https://github.com/murraysum/github_status"
+
+  DESCRIPTION = "Provides a Ruby Library that allows the Github Status API to be queried."
+end

data/lib/github_status.rb

@@ -0,0 +1,9 @@
+require 'net/https'
+require 'uri'
+require 'json'
+
+module GithubStatus
+  require "github_status/version"
+  require 'github_status/status'
+  require 'github_status/api'
+end

data/spec/api_spec.rb

@@ -0,0 +1,119 @@
+require 'spec_helper'
+
+describe GithubStatus::API do
+  describe "#api" do
+    before do
+      @expected_response = {
+        status_url: "https://status.github.com/api/status.json",
+        messages_url: "https://status.github.com/api/messages.json",
+        last_message_url: "https://status.github.com/api/last-message.json"
+      }
+
+      @stub_request = stub_request(:get, "https://status.github.com/api.json")
+      @stub_request.to_return(body: JSON.generate(@expected_response))
+
+      @actual_response = GithubStatus::API.api
+    end
+
+    describe "request" do  
+      it "should have been requested" do
+        @stub_request.should have_been_requested
+      end
+
+      it "should have requested api.json" do
+        @stub_request.should have_requested(:get, "https://status.github.com/api.json")
+      end
+    end
+
+    describe "response" do
+      it "should have responded with a status url" do
+        @actual_response[:status_url].should == @expected_response[:status_url] 
+      end
+
+      it "should have responded with a messages url" do
+        @actual_response[:messages_url].should == @expected_response[:messages_url] 
+      end
+
+      it "should have responded with a last message url" do
+        @actual_response[:last_message_url].should == @expected_response[:last_message_url] 
+      end
+    end
+  end
+
+  describe "#last_message" do
+    before do
+      @expected_response = {
+        status: "good",
+        body: "good status message",
+        created_on: Time.now.to_s
+      }
+
+      @stub_request = stub_request(:get, "https://status.github.com/api/last-message.json")
+      @stub_request.to_return(body: JSON.generate(@expected_response))
+
+      @actual_response = GithubStatus::API.last_message
+    end
+
+    describe "request" do  
+      it "should have been requested" do
+        @stub_request.should have_been_requested
+      end
+
+      it "should have requested last-message.json" do
+        @stub_request.should have_requested(:get, "https://status.github.com/api/last-message.json")
+      end
+    end
+
+    describe "response" do
+      it "should have responded with a status" do
+        @actual_response[:status].should == @expected_response[:status] 
+      end
+
+      it "should have responded with a body" do
+        @actual_response[:body].should == @expected_response[:body] 
+      end
+
+      it "should have responded with a created_on" do
+        @actual_response[:created_on].should == @expected_response[:created_on] 
+      end
+    end
+  end
+
+  describe "#messages" do
+    before do
+      @status_options_1 = {
+        status: "major",
+        body: "some major status message",
+        created_on: Time.now.to_s
+      }
+      @status_options_2 = {
+        status: "minor",
+        body: "some minor status message",
+        created_on: Time.now.to_s
+      }
+      @expected_response = [@status_options_1, @status_options_2]
+
+      @stub_request = stub_request(:get, "https://status.github.com/api/messages.json")
+      @stub_request.to_return(body: JSON.generate(@expected_response))
+
+      @actual_response = GithubStatus::API.messages
+    end
+
+    describe "request" do
+      it "should have been requested" do
+        @stub_request.should have_been_requested
+      end
+
+      it "should have requested messages.json" do
+        @stub_request.should have_requested(:get, "https://status.github.com/api/messages.json")
+      end
+    end
+
+    describe "response" do
+      it "should respond with a list of messages" do
+        @actual_response.should == @expected_response
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rspec'
+require 'webmock/rspec'
+
+require 'github_status'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter = 'documentation'
+end

data/spec/status_spec.rb

@@ -0,0 +1,183 @@
+require 'spec_helper'
+
+describe GithubStatus::Status do
+  describe 'status constants' do
+    it 'should have good status' do
+      GithubStatus::Status::GOOD.should == "good" 
+    end
+
+    it 'should have major status' do
+      GithubStatus::Status::MAJOR.should == "major" 
+    end
+
+    it 'should have minor status' do
+      GithubStatus::Status::MINOR.should == "minor" 
+    end
+  end
+
+  describe "initialize" do
+    before do
+      @options = {
+        status: "good",
+        body: "some status message",
+        created_on: Time.now
+      }
+      @status_item = GithubStatus::Status.new(@options)
+    end
+
+    it 'should initialise the status' do
+      @status_item.status.should == @options[:status]
+    end
+
+    it 'should initialise the message' do
+      @status_item.message.should == @options[:body]
+    end
+
+    it 'should initialise the created on' do
+      @status_item.created_on.should == @options[:created_on]
+    end
+  end
+
+  describe ".good?" do
+    before do
+      @options = {
+        status: "good",
+        body: "some status message",
+        created_on: Time.now
+      }
+      @status_item = GithubStatus::Status.new(@options)
+    end
+
+    it 'should identify as good' do
+      @status_item.good?.should be_true
+    end
+
+    it 'should not identify as major' do
+      @status_item.major?.should be_false
+    end
+
+    it 'should not identify as minor' do
+      @status_item.minor?.should be_false
+    end
+  end
+
+  describe ".major?" do
+    before do
+      @options = {
+        status: "major",
+        body: "some status message",
+        created_on: Time.now
+      }
+      @status_item = GithubStatus::Status.new(@options)
+    end
+
+    it 'should not identify as good' do
+      @status_item.good?.should be_false
+    end
+
+    it 'should identify as major' do
+      @status_item.major?.should be_true
+    end
+
+    it 'should not identify as minor' do
+      @status_item.minor?.should be_false
+    end
+  end
+
+  describe ".minor?" do
+    before do
+      @options = {
+        status: "minor",
+        body: "some status message",
+        created_on: Time.now
+      }
+      @status_item = GithubStatus::Status.new(@options)
+    end
+
+    it 'should not identify as good' do
+      @status_item.good?.should be_false
+    end
+
+    it 'should not identify as major' do
+      @status_item.major?.should be_false 
+    end
+
+    it 'should identify as minor' do
+      @status_item.minor?.should be_true
+    end
+  end
+
+  describe "#last_message" do
+    before do
+      @options = {
+        status: "major",
+        body: "some status message",
+        created_on: Time.now
+      }
+      GithubStatus::API.stub(:last_message) { @options }
+      @status_item = GithubStatus::Status.last_message
+    end
+    
+    it 'should initialise the status' do
+      @status_item.status.should == @options[:status]
+    end
+
+    it 'should initialise the message' do
+      @status_item.message.should == @options[:body]
+    end
+
+    it 'should initialise the created on' do
+      @status_item.created_on.should == @options[:created_on]
+    end
+  end
+
+  describe "#messages" do
+    before do
+      @status_options_1 = {
+        status: "major",
+        body: "some major status message",
+        created_on: Time.now
+      }
+      @status_options_2 = {
+        status: "minor",
+        body: "some minor status message",
+        created_on: Time.now
+      }
+      @options = [@status_options_1, @status_options_2] 
+      GithubStatus::API.stub(:messages) { @options }
+      @status_items = GithubStatus::Status.messages
+    end
+
+    it "should contain both status messages" do
+      @status_items.should have(2).items
+    end
+
+    describe "initialize the first status" do
+      it 'should initialise the status' do
+        @status_items[0].status.should == @status_options_1[:status]
+      end
+
+      it 'should initialise the message' do
+        @status_items[0].message.should == @status_options_1[:body]
+      end
+
+      it 'should initialise the created on' do
+        @status_items[0].created_on.should == @status_options_1[:created_on]
+      end
+    end 
+
+    describe "initialize the second status" do
+      it 'should initialise the status' do
+        @status_items[1].status.should == @status_options_2[:status]
+      end
+
+      it 'should initialise the message' do
+        @status_items[1].message.should == @status_options_2[:body]
+      end
+
+      it 'should initialise the created on' do
+        @status_items[1].created_on.should == @status_options_2[:created_on]
+      end
+    end 
+  end
+end

data/spec/version_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe "#{GithubStatus::Status} version information" do
+  it "should be version 0.0.1" do
+    GithubStatus::VERSION.should == "0.0.1"
+  end
+
+  it "should have authors" do
+    GithubStatus::AUTHORS.should_not be_empty
+  end
+
+  it "should have email addresses" do
+    GithubStatus::EMAIL.should_not be_empty
+  end
+
+  it "should have a summary" do
+    GithubStatus::SUMMARY.should == "Github Status API"
+  end
+
+  it "should have a homepage" do
+    GithubStatus::HOMEPAGE.should == "https://github.com/murraysum/github_status"
+  end
+
+  it "should have a description" do
+    GithubStatus::DESCRIPTION.should_not be_empty
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: github_status
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Murray Summers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides a Ruby Library that allows the Github Status API to be queried.
+email:
+- murray.sum@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- github_status.gemspec
+- lib/github_status.rb
+- lib/github_status/api.rb
+- lib/github_status/status.rb
+- lib/github_status/version.rb
+- spec/api_spec.rb
+- spec/spec_helper.rb
+- spec/status_spec.rb
+- spec/version_spec.rb
+homepage: https://github.com/murraysum/github_status
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Github Status API
+test_files:
+- spec/api_spec.rb
+- spec/spec_helper.rb
+- spec/status_spec.rb
+- spec/version_spec.rb