stashboardmanager 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7740e0ee907b9b81a69152969c7510f5e6599b15
+  data.tar.gz: 6712adcd6660f6033fb4110203c579a2b73f0678
+SHA512:
+  metadata.gz: 5f6f0eaab23573783e631dd2ce77db62ef1858e870bd63c2e63b66c3c327830212469fe10a49a956913a9ba5100e6c964fd6fdf46c4c3155e2e064260868fd5b
+  data.tar.gz: f166444d705157cb91e18ff34f9d59bbd77496faaca10d5447d47d5461a38c1692fe7e97b5bb864719c8ef30fc9368514f3f7849c4e3170848f6c4d2355f5a1f

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 stashboardmanager.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Matt Rayner
+
+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,29 @@
+# Stashboardmanager
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'stashboardmanager'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stashboardmanager
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/stashboardmanager/fork )
+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 @@
+require "bundler/gem_tasks"

data/lib/stashboardmanager/version.rb

@@ -0,0 +1,3 @@
+module Stashboardmanager
+  VERSION = "0.0.2"
+end

data/lib/stashboardmanager.rb

@@ -0,0 +1,100 @@
+require "stashboard"
+require "stashboardmanager/version"
+
+module Stashboardmanager
+
+
+  # Main class for interacting with StashboardManager.
+  class Manager
+
+    @stashboard = nil
+
+    # Create a new StashboardManager instance.
+    def initialize(address, token, secret)
+      @stashboard = Stashboard::Stashboard.new(address, token, secret)
+    end
+
+    # Check to see if a service is already set as 'status'. If not, update it.
+    #
+    # @param [String] service The service you are attempting to set
+    # @param [String] status The status you are attempting to set
+    # @param [String] message The message you wish to attach to this update
+    def service_update(service, status, message)
+      if service_updatable(service, status)
+        self.generate_stashboard_event(service, status, message)
+      end
+    end
+
+    # Get all services attached to this stashboard.
+    #
+    # @return [Hash] services A hash containing an array of service detail hashes, or an error message
+    def services
+      @stashboard.services
+    end
+
+    # Get an array of service ids. This is just for convenience/
+    #
+    # @return [Array] Services Array containing just the service ids
+    def service_ids
+      @stashboard.service_ids
+    end
+
+    # Get the current status of a service.
+    #
+    # @param [String] service The service you are attempting to set
+    # @return [Hash] details A hash containing the details for this service
+    def service_status(service)
+      #Do we have a service for this set up
+      services = self.service_ids
+      exists = services.include? service
+
+      status = false
+
+      #Make sure we have some services and that this one exists
+      if exists
+        #Get the service's details
+        s = @stashboard.service(service)
+
+        #Grab the current event
+        current_event = s["current-event"]
+
+        #Make sure we have a current event
+        if(!current_event.nil?)
+          status = current_event["status"]["id"]
+        end
+      end
+
+      status
+    end
+
+    # Is this service updatable?
+    #
+    # @param [String] service The name of the service you want to check
+    # @param [String] status The status you are trying to update the service to
+    # @return [Boolean] response Response containing a true if this service should be updated, a false if it shouldn't OR a nil if the service doesn't exist
+    def service_updatable(service, status)
+      #What is the current service status?
+      serv_stat = self.service_status(service)
+
+      if serv_stat == false       #If false then don't continue (the service does not exist on remote)
+        return nil
+      elsif serv_stat == status   #If match don't update
+        return false
+      else                        #No match - update
+        return true
+      end
+    end
+
+    # Create an event of a service. Events are the main way we
+    # indicate problems or resolutions of issues.
+    #
+    # @param [String] service The service you want to update
+    # @param [String] id The id of an already existing status (i.e. "up", "down", "warning" or "error")
+    # @param [String] message The message we want our event to have attached
+    # @return [Hash] event The event details
+    def generate_stashboard_event(service, status, message)
+      @stashboard.create_event(service, status, message)
+    end
+  end
+
+end

data/spec/manager_spec.rb

@@ -0,0 +1,37 @@
+require 'stashboardmanager'
+
+describe Stashboardmanager::Manager do
+  #Setup the remote instance ready for the tests
+  puts "Preparing for tests"
+  manager = Stashboardmanager::Manager.new("https://stashmanagertest.appspot.com", "1/3x3oY6MRqACaMmuzr0pr76_3J9zkB3sJX_rIMCFU-cU", "p2K71wl3ekDBNF88UcAnFfUi")
+
+  ids = manager.service_ids
+
+  puts ids
+
+  ids.each do |id|
+    manager.service_update(id, "up", "Resetting #{id} for testing purposes")
+  end
+
+  id = ids[0]
+
+  puts id
+
+  puts manager.service_status(id)
+
+  it "Has reset all" do
+    manager.service_status(id).should eql("up")
+  end
+
+  it "Can update status" do
+    manager.service_update(id, "down", "test that we can set #{id} to 'down'")
+    manager.service_status(id).should eql("down")
+  end
+
+  it "Can mass-asign" do
+    ids.each do |id|
+      manager.service_update(id, "warning", "Warning on #{id} for testing purposes")
+      manager.service_status(id).should eql("warning")
+    end
+  end
+end

data/stashboardmanager.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stashboardmanager/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "stashboardmanager"
+  spec.version       = Stashboardmanager::VERSION
+  spec.authors       = ["Matt Rayner"]
+  spec.email         = ["matt@mattrayner.co.uk"]
+  spec.summary       = %q{A manager designed to work with the stashboard-ruby gem and simplify it's use.}
+  spec.description   = %q{Adds easy management to stashboard events within a ruby environment. This gem adds the ability to update stashboard only when an update is needed. i.e. creating a stashboard event with status "up" is only created when the remote status != "up" allowing you to save on Google App Engine bandwidth.}
+  spec.homepage      = "https://github.com/mattrayner/stashboardmanager"
+  spec.license       = "MIT"
+
+  spec.add_dependency "stashboard-ruby", "~> 0.1.0"
+  spec.add_development_dependency "rspec", "~> 2.6"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.5"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: stashboardmanager
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Matt Rayner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: stashboard-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+description: Adds easy management to stashboard events within a ruby environment.
+  This gem adds the ability to update stashboard only when an update is needed. i.e.
+  creating a stashboard event with status "up" is only created when the remote status
+  != "up" allowing you to save on Google App Engine bandwidth.
+email:
+- matt@mattrayner.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/stashboardmanager.rb
+- lib/stashboardmanager/version.rb
+- spec/manager_spec.rb
+- stashboardmanager.gemspec
+homepage: https://github.com/mattrayner/stashboardmanager
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A manager designed to work with the stashboard-ruby gem and simplify it's
+  use.
+test_files:
+- spec/manager_spec.rb