stashboardmanager 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7740e0ee907b9b81a69152969c7510f5e6599b15
-  data.tar.gz: 6712adcd6660f6033fb4110203c579a2b73f0678
+  metadata.gz: daf1d45fd36354a13e21fd8716eb61aa645833b0
+  data.tar.gz: 23ded6c557713baf4509123ff8bf00bfe74509f0
 SHA512:
-  metadata.gz: 5f6f0eaab23573783e631dd2ce77db62ef1858e870bd63c2e63b66c3c327830212469fe10a49a956913a9ba5100e6c964fd6fdf46c4c3155e2e064260868fd5b
-  data.tar.gz: f166444d705157cb91e18ff34f9d59bbd77496faaca10d5447d47d5461a38c1692fe7e97b5bb864719c8ef30fc9368514f3f7849c4e3170848f6c4d2355f5a1f
+  metadata.gz: 49f582f1594851976aaf821209a2af98721c08a022cb5b7c53937cf2f0ed549a8564d1d9d16c9eb58993e411abc671890f7c236217418a87514105dd6fcaac6d
+  data.tar.gz: 70b1d8015e16923575ec4edefc73fcb7cfa34a2bfcb3e838ef21ed007e47d9458d21c8c17e4f5e061662a0ad1afb9256ad3adc3cafd56ae8b862c2bb18914b57

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"
+  - "2.0.0"
+  - "2.1.0"
+  - rbx
+# uncomment this line if your project needs to run something other than `rake`:
+script: bundle exec rspec spec

data/README.md

@@ -1,28 +1,157 @@
-# Stashboardmanager
+# Stashboardmanager [![Gem Version](https://badge.fury.io/rb/stashboardmanager.svg)](http://badge.fury.io/rb/stashboardmanager) [![Build Status](https://travis-ci.org/mattrayner/stashboardmanager.svg?branch=master)](https://travis-ci.org/mattrayner/stashboardmanager)
 
-TODO: Write a gem description
+A super-simple manager for stashboard, allowing you to easily update a stashboard instance with events throughout your application.
+
+This gem adds a number of checks to prevent the repeat posting of updated so if you try to update the status to 'up' and the remote status is already 'up' then nothing happens, saving you bandwidth and time.
 
 ## Installation
 
 Add this line to your application's Gemfile:
-
+```ruby
     gem 'stashboardmanager'
+```
 
 And then execute:
-
+```bash
     $ bundle
+```
 
 Or install it yourself as:
-
+```bash
     $ gem install stashboardmanager
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+Create a new manager, using your app details and the oauth token and secret:
+```ruby
+manager = Stashboardmanager::Manager.new("https://YOURAPP.appspot.com", <oauth_token>, <oauth_secret>)
+```
+To get a list of all your services:
+```ruby
+manager.services
+=begin
+  [
+    {
+      "description"=>"Mail Service", 
+      "url"=>"https://YOURAPP.appspot.com/api/v1/services/mail-service", 
+      "list"=>{
+        "url"=>"https://YOURAPP.appspot.com/api/v1/service-lists/application-services", 
+        "description"=>"The main services that run the application", 
+        "name"=>"Application Services", 
+        "id"=>"application-services"
+      }, 
+      "current-event"=>nil, 
+      "id"=>"mail-service", 
+      "name"=>"Mail Service"
+    }, 
+    {
+      "description"=>"PDF Cleaner", 
+      "url"=>"https://YOURAPP.appspot.com/api/v1/services/pdf-cleaner", 
+      "list"=>{
+        "url"=>"https://YOURAPP.appspot.com/api/v1/service-lists/helper-services", 
+        "description"=>"The little bits that help without being part of the app itself", 
+        "name"=>"Helper Services", "id"=>"helper-services"
+      }, 
+      "current-event"=>nil, 
+      "id"=>"pdf-cleaner", 
+      "name"=>"PDF Cleaner"
+    }, 
+    {
+      "description"=>"Website service",
+      "url"=>"https://YOURAPP.appspot.com/api/v1/services/website", 
+      "current-event"=>{
+        "status"=>{
+          "description"=>"The service is up", 
+          "level"=>"NORMAL", 
+          "default"=>true, 
+          "image"=>"https://YOURAPP.appspot.com/images/icons/iconic/check_alt.png", 
+          "url"=>"https://YOURAPP.appspot.com/api/v1/statuses/up", 
+          "id"=>"up", 
+          "name"=>"Up"
+        }, 
+        "url"=>"https://YOURAPP.appspot.com/api/v1/services/website/events/ag5zfnBsYW5ocS1zdGF0c3ISCxIFRXZlbnQYgICAgN6QwQsM", 
+        "timestamp"=>"Mon, 28 Apr 2014 14:48:16 GMT", 
+        "sid"=>"ag5zfnBsYW5ocS1zdGF0c3ISCxIFRXZlbnQYgICAgN6QwQsM", 
+        "message"=>"Web server running A-OK", 
+        "informational"=>false
+      },
+      "id"=>"website", 
+      "name"=>"Website"
+    }
+  ]
+=end
+```
+
+To receive an array of service ids:
+```ruby
+manager.service_ids
+# =>  ["mail-service", "pdf-cleaner", "website"]
+```
+
+To receive the status of a particular service:
+```ruby
+manager.service("website")
+=begin
+  {
+    "description"=>"Website service",
+    "url"=>"https://YOURAPP.appspot.com/api/v1/services/website", 
+    "current-event"=>{
+      "status"=>{
+        "description"=>"The service is up", 
+        "level"=>"NORMAL", 
+        "default"=>true, 
+        "image"=>"https://YOURAPP.appspot.com/images/icons/iconic/check_alt.png", 
+        "url"=>"https://YOURAPP.appspot.com/api/v1/statuses/up", 
+        "id"=>"up", 
+        "name"=>"Up"
+      }, 
+      "url"=>"https://YOURAPP.appspot.com/api/v1/services/website/events/ag5zfnBsYW5ocS1zdGF0c3ISCxIFRXZlbnQYgICAgN6QwQsM", 
+      "timestamp"=>"Mon, 28 Apr 2014 14:48:16 GMT", 
+      "sid"=>"ag5zfnBsYW5ocS1zdGF0c3ISCxIFRXZlbnQYgICAgN6QwQsM", 
+      "message"=>"Web server running A-OK", 
+      "informational"=>false
+    },
+    "id"=>"website", 
+    "name"=>"Website"
+  }
+=end
+```
+
+To find out how wether a service should be updated:
+```ruby
+manager.service_updatable("website", "up")
+# => false
+```
+The above command first gets the details for this service, and checks it's current status. If the current status is not the same as the status you passed then it will return true.
+
+To update a service:
+```ruby
+manager.service_update("website", "up", "The website it working!")
+```
+This command will first check if the service is updatable to the status you've chosen, if it is (it is not already the same status) then a new event is fired.
+
+### Example usage
+```ruby
+#Create a manager for our stashboar instance
+manager = Stashboardmanager::Manager.new("https://YOURAPP.appspot.com", <oauth_token>, <oauth_secret>)
+
+#Get a list of all of their IDs
+ids = manager.service_ids
+
+#Iterate over each of them, seting the status to "up" in every case
+ids.each do |id|
+  manager.service_update(id, "up", "Resetting #{id} to up for testing purposes")
+end
+```
+
+## Additional help
+
+For additional help, take a look at the [stashboard-ruby](https://github.com/mattrayner/stashboard-ruby) gem, stashboardmanager is build on top of it.
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/stashboardmanager/fork )
+1. Fork it ( http://github.com/mattrayner/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`)

data/lib/stashboardmanager.rb

@@ -2,11 +2,8 @@ require "stashboard"
 require "stashboardmanager/version"
 
 module Stashboardmanager
-
-
   # Main class for interacting with StashboardManager.
   class Manager
-
     @stashboard = nil
 
     # Create a new StashboardManager instance.
@@ -21,7 +18,7 @@ module Stashboardmanager
     # @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)
+        @stashboard.create_event(service, status, message)
       end
     end
 
@@ -76,25 +73,12 @@ module Stashboardmanager
       #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
+      if 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/lib/stashboardmanager/version.rb

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

data/spec/manager_spec.rb

@@ -2,23 +2,16 @@ 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stashboardmanager
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Matt Rayner
@@ -77,6 +77,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md