giraffi 0.1.3

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+- 
+LICENSE.md
+HISTORY.md
+README.md

data/.yardopts

@@ -0,0 +1,7 @@
+--no-private
+--protected
+--tag requires_apikey:"Requires APIKEY?"
+--markup markdown
+-
+HISTORY.md
+LICENSE.md

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+#
+
+gemspec

data/HISTORY.md

@@ -0,0 +1,6 @@
+HISTORY
+=======
+
+0.1.0 - December 9, 2011
+-------------------------
+* [Initial release](http://github.com/giraffi/giraffi/commit/)

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2011 azukiwasher
+
+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,114 @@
+# The Giraffi Ruby Gem
+
+A Ruby wrapper for the Giraffi API
+
+## Installation
+
+    gem install giraffi
+
+## Requirements
+* Ruby 1.9.2 or later
+* An apikey for the Giraffi API
+
+## Usage
+
+### How to start monitoring your web site status via HTTP
+
+1. Create a new Giraffi::Client object
+2. Create a medium
+3. Create an axion
+4. Add the medium you created to the axion
+5. Create an item
+6. Add a service to the item
+7. Add a trigger to the service
+8. Update the axion of the trigger
+9. Update the region of the service
+10. Reload the settings
+
+``` ruby
+require 'json'
+require 'pp'
+
+# An `APIKEY` that allows you to access the Giraffi API
+APIKEY = 'hanamoguella'
+
+# Sample attributes to create a `medium`
+medium_attrs = {
+  name: "Alert Email",
+  mediumtype: "email",
+  options: { address: "user@example.com" }
+}
+
+# Sample attributes to create an `axion`
+axion_attrs = {
+  name: "aborted alert",
+  axiontype: "messaging",
+  options: {}
+}
+
+# Sample attributes to create an `item`
+item_attrs = {
+  name: "web01",
+  host: "localhost",
+  ip: "127.0.0.1",
+  normalinterval: 120,
+  warninginterval: 60,
+  warningretry: 2,
+  status: 1
+}
+
+# Sample attributes to create a `service`
+service_attrs = {
+  servicetype: "web_response_time",
+  normalinterval: 120,
+  warninginterval: 60,
+  warningretry: 2,
+  status: 1,
+  options: {}
+}
+
+# Sample attributes to create a `trigger`
+trigger_attrs = {
+  triggertype: "timeout",
+  axioninterval: 180,
+  options:{
+    time: "3"
+  }
+}
+
+# Create a Giraffi client object
+g = Giraffi.new({apikey: APIKEY})
+
+# Create a medium
+response = g.create_medium(medium_attrs)
+medium_id = JSON.parse(response.body)['medium']['id']
+
+# Create an axion
+response = g.create_axion(axion_attrs)
+axion_id = JSON.parse(response.body)['axion']['id']
+
+# Add the medium you created to the axion
+pp g.add_medium_to_axion(axion_id, medium_id)
+
+# Create an item
+response = g.create_item(item_attrs)
+item_id = JSON.parse(response.body)['item']['id']
+
+# Add a service to the item
+response = g.add_service_to_item(item_id, service_attrs)
+service_id = JSON.parse(response.body)['service']['id']
+
+# Add a trigger to the service
+response = g.add_trigger_to_service(service_id, trigger_attrs)
+trigger_id = JSON.parse(response.body)['trigger']['id']
+
+# Update the axion of the trigger
+pp g.update_axion_of_trigger(trigger_id, axion_id, "problem")
+
+# Update the region of the service
+pp g.update_region_of_service(service_id, "JP")
+
+# Reload the settings
+pp g.reload_items
+
+```

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "giraffi"
+  gem.homepage = "http://github.com/giraffi/giraffi"
+  gem.license = "MIT"
+  gem.summary = %Q{A Ruby wrapper for the Giraffi API}
+  gem.description = %Q{A Ruby wrapper for the Giraffi API}
+  gem.email = "azukiwasher@higanworks.com"
+  gem.authors = ["azukiwasher"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "giraffi #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.3

data/examples/setup_http_monitoring.rb

@@ -0,0 +1,88 @@
+dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require File.join(dir, 'giraffi')
+require 'json'
+require 'pp'
+
+# An `APIKEY` that allows you to access the Giraffi API
+APIKEY = 'wtLTFEqCTX55Lvhtzlqw6doj5xuphemxJa707QXtDPc'
+
+# Sample attributes to create a `medium`
+medium_attrs = {
+  name: "Alert Email",
+  mediumtype: "email",
+  options: { address: "user@example.com" }
+}
+
+# Sample attributes to create an `axion`
+axion_attrs = {
+  name: "aborted alert",
+  axiontype: "messaging",
+  options: {}
+}
+
+# Sample attributes to create an `item`
+item_attrs = {
+  name: "web01",
+  host: "localhost",
+  ip: "210.152.132.21",
+  normalinterval: 120,
+  warninginterval: 60,
+  warningretry: 2,
+  status: 1
+}
+
+# Sample attributes to create a `service`
+service_attrs = {
+  servicetype: "web_response_time",
+  normalinterval: 120,
+  warninginterval: 60,
+  warningretry: 2,
+  status: 1,
+  options: {}
+}
+
+# Sample attributes to create a `trigger`
+trigger_attrs = {
+  triggertype: "timeout",
+  axioninterval: 180,
+  options:{
+    time: "3"
+  }
+}
+
+# Create a Giraffi client object
+g = Giraffi.new({apikey: APIKEY})
+
+# Create a medium
+response = g.create_medium(medium_attrs)
+medium_id = JSON.parse(response.body)['medium']['id']
+
+# Create an axion
+response = g.create_axion(axion_attrs)
+axion_id = JSON.parse(response.body)['axion']['id']
+
+# Add the medium you created to the axion
+pp g.add_medium_to_axion(axion_id, medium_id)
+
+# Create an item
+response = g.create_item(item_attrs)
+item_id = JSON.parse(response.body)['item']['id']
+
+# Add a service to the item
+response = g.add_service_to_item(item_id, service_attrs)
+service_id = JSON.parse(response.body)['service']['id']
+
+# Add a trigger to the service
+response = g.add_trigger_to_service(service_id, trigger_attrs)
+trigger_id = JSON.parse(response.body)['trigger']['id']
+
+# Update the axion of the trigger
+pp g.update_axion_of_trigger(trigger_id, axion_id, "problem")
+
+# Update the region of the service
+pp g.update_region_of_service(service_id, "JP")
+
+# Reload the settings
+pp g.reload_items
+

data/giraffi.gemspec

@@ -0,0 +1,155 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "giraffi"
+  s.version = "0.1.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["azukiwasher"]
+  s.date = "2011-12-09"
+  s.description = "A Ruby wrapper for the Giraffi API"
+  s.email = "azukiwasher@yahoo.co.jp"
+  s.extra_rdoc_files = [
+    "LICENSE.md",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".yardopts",
+    "Gemfile",
+    "HISTORY.md",
+    "LICENSE.md",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "examples/setup_http_monitoring.rb",
+    "giraffi.gemspec",
+    "lib/giraffi.rb",
+    "lib/giraffi/client.rb",
+    "lib/giraffi/client/applogs.rb",
+    "lib/giraffi/client/axions.rb",
+    "lib/giraffi/client/items.rb",
+    "lib/giraffi/client/logs.rb",
+    "lib/giraffi/client/media.rb",
+    "lib/giraffi/client/monitoringdata.rb",
+    "lib/giraffi/client/my_current_status.rb",
+    "lib/giraffi/client/regions.rb",
+    "lib/giraffi/client/services.rb",
+    "lib/giraffi/client/trends.rb",
+    "lib/giraffi/client/triggers.rb",
+    "lib/giraffi/config.rb",
+    "lib/giraffi/version.rb",
+    "test/applogs_test.rb",
+    "test/axions_test.rb",
+    "test/client_test.rb",
+    "test/fixtures/add_applogs_success_response.json",
+    "test/fixtures/add_monitroingdata.json",
+    "test/fixtures/add_service_to_item.json",
+    "test/fixtures/add_trigger_to_service.json",
+    "test/fixtures/create_axion.json",
+    "test/fixtures/create_item.json",
+    "test/fixtures/create_medium.json",
+    "test/fixtures/find_applogs_with_no_param.json",
+    "test/fixtures/find_applogs_with_params.json",
+    "test/fixtures/find_average_trends.json",
+    "test/fixtures/find_axion_by_id.json",
+    "test/fixtures/find_axion_by_trigger.json",
+    "test/fixtures/find_axion_logs_with_no_param.json",
+    "test/fixtures/find_axion_logs_with_params.json",
+    "test/fixtures/find_axions_by_trigger_with_axionkind.json",
+    "test/fixtures/find_axions_by_trigger_without_axionkind.json",
+    "test/fixtures/find_axions_with_no_param.json",
+    "test/fixtures/find_axions_with_params.json",
+    "test/fixtures/find_failure_trends.json",
+    "test/fixtures/find_item_by_id.json",
+    "test/fixtures/find_items_with_no_param.json",
+    "test/fixtures/find_items_with_params.json",
+    "test/fixtures/find_media_by_axion.json",
+    "test/fixtures/find_media_with_no_param.json",
+    "test/fixtures/find_media_with_params.json",
+    "test/fixtures/find_medium_by_id.json",
+    "test/fixtures/find_monitoringdata_with_no_param.json",
+    "test/fixtures/find_monitoringdata_with_params.json",
+    "test/fixtures/find_region_by_service.json",
+    "test/fixtures/find_regions.json",
+    "test/fixtures/find_service_by_id.json",
+    "test/fixtures/find_service_by_item_with_params.json",
+    "test/fixtures/find_services_by_item_with_no_param.json",
+    "test/fixtures/find_services_with_no_param.json",
+    "test/fixtures/find_services_with_params.json",
+    "test/fixtures/find_trigger_by_id.json",
+    "test/fixtures/find_triggers_by_service.json",
+    "test/fixtures/find_triggers_with_no_param.json",
+    "test/fixtures/find_triggers_with_params.json",
+    "test/fixtures/my_current_status_about_fake_uri.json",
+    "test/fixtures/my_current_status_about_real_uri.json",
+    "test/giraffi_test.rb",
+    "test/items_test.rb",
+    "test/logs_test.rb",
+    "test/media_test.rb",
+    "test/monitoringdata_test.rb",
+    "test/my_current_status_test.rb",
+    "test/regions_test.rb",
+    "test/services_test.rb",
+    "test/test_helper.rb",
+    "test/trends_test.rb",
+    "test/triggers_test.rb"
+  ]
+  s.homepage = "http://github.com/giraffi/giraffi"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "A Ruby wrapper for the Giraffi API"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<multi_json>, [">= 1.0"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0.8"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<webmock>, [">= 0"])
+      s.add_development_dependency(%q<vcr>, [">= 0"])
+      s.add_development_dependency(%q<turn>, [">= 0"])
+      s.add_development_dependency(%q<watchr>, [">= 0"])
+      s.add_development_dependency(%q<rb-fsevent>, [">= 0"])
+      s.add_development_dependency(%q<redcarpet>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<multi_json>, [">= 1.0"])
+      s.add_dependency(%q<httparty>, [">= 0.8"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<webmock>, [">= 0"])
+      s.add_dependency(%q<vcr>, [">= 0"])
+      s.add_dependency(%q<turn>, [">= 0"])
+      s.add_dependency(%q<watchr>, [">= 0"])
+      s.add_dependency(%q<rb-fsevent>, [">= 0"])
+      s.add_dependency(%q<redcarpet>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<multi_json>, [">= 1.0"])
+    s.add_dependency(%q<httparty>, [">= 0.8"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<webmock>, [">= 0"])
+    s.add_dependency(%q<vcr>, [">= 0"])
+    s.add_dependency(%q<turn>, [">= 0"])
+    s.add_dependency(%q<watchr>, [">= 0"])
+    s.add_dependency(%q<rb-fsevent>, [">= 0"])
+    s.add_dependency(%q<redcarpet>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/lib/giraffi/client/applogs.rb

@@ -0,0 +1,25 @@
+module Giraffi
+  class Client
+    # Defines methods related to the applogs
+
+    module Applogs
+      # Returns the desired applogs related
+      #
+      # @requires_apikey Yes
+      # @param options [Hash] The request params to retrieve the desired applogs
+      # @return [HTTParty::Response]
+      def find_applogs(options={})
+        self.class.get("/applogs.json?apikey=#{apikey}", :query => options)
+      end
+
+      # Posts the applogs to the Giraffi
+      #
+      # @requires_apikey Yes
+      # @param options [Hash] The applogs to post to the Giraffi
+      # @return [HTTParty::Response]
+      def add_applogs(options={})
+        self.class.post("#{applogs_endpoint}/applogs.json?apikey=#{apikey}", :body => MultiJson.encode({applog: options}))
+      end
+    end
+  end
+end

data/lib/giraffi/client/axions.rb

@@ -0,0 +1,96 @@
+module Giraffi
+  class Client
+    # Defines methods related to the axions
+
+    module Axions
+      # Returns the desired axions
+      #
+      # @requires_apikey Yes
+      # @param options [Hash] The request params to retrieve the desired axions
+      # @return [HTTParty::Response]
+      def find_axions(options={})
+        self.class.get("/axions.json?apikey=#{apikey}", :query => options)
+      end
+
+      # Returns the desired axion
+      #
+      # @requires_apikey Yes
+      # @param id [String] The numerical ID of the desired axion
+      # @return [HTTParty::Response]
+      def find_axion(id)
+        self.class.get("/axions/#{id}.json?apikey=#{apikey}")
+      end
+
+      # Returns all media related to the desired axion
+      #
+      # @requires_apikey Yes
+      # @param id [String] The numerical ID of the desired axion
+      # @param options [Hash] A set of params to retrieve media related the axion
+      # @return [HTTParty::Response]
+      def find_media_by_axion(id, options={})
+        self.class.get("/axions/#{id}/media.json?apikey=#{apikey}", :query => options)
+      end
+
+      # Creates a new axion
+      #
+      # @requires_apikey Yes
+      # @param options [Hash] A set of attributes to create a new axion
+      # @return [HTTParty::Response]
+      def create_axion(options={})
+        self.class.post("/axions.json?apikey=#{apikey}", :query => { :axion => options })
+      end
+
+      # Executes the desired axion
+      #
+      # @requires_apikey Yes
+      # @param id [String] The numerical ID of the desired axion
+      # @return [HTTParty::Response]
+      def execute_axion(id)
+        self.class.post("/axions/#{id}/execute.json?apikey=#{apikey}")
+      end
+
+      # Updates the desired axion
+      #
+      # @requires_apikey Yes
+      # @param id [String] The numerical ID of the desired axion
+      # @param options [Hash] A set of attributes to update the axion
+      # @return [HTTParty::Response]
+      def update_axion(id, options={})
+        self.class.put("/axions/#{id}.json?apikey=#{apikey}", :query => { :axion => options }, :body => {})
+      end
+
+      # Adds a medium to the axion
+      #
+      # @requires_apikey Yes
+      # @param args [Array] A set of params to add a medium to the axion
+      # @option args [String] The numerical ID of the related axion
+      # @option args [String] The numerical ID of the medium to add
+      # @return [HTTParty::Response]
+      def add_medium_to_axion(*args)
+        raise ArgumentError.new('The method `add_medium_to_axion` requires 2 argments (axion-id and medium-id)') if args.size != 2
+        self.class.put("/axions/#{args[0]}/media/#{args[-1]}.json?apikey=#{apikey}", :body => {})
+      end
+
+      # Deletes the axion
+      #
+      # @requires_apikey Yes
+      # @param id [String] The numerical ID of the desired axion
+      # @return [HTTParty::Response]
+      def destroy_axion(id)
+        self.class.delete("/axions/#{id}?apikey=#{apikey}")
+      end
+
+      # Removes a medium from the axion
+      #
+      # @requires_apikey Yes
+      # @param args [Array] A set of params to remove a medium from the axion
+      # @option args [String] The numerical ID of the related axion
+      # @option args [String] The numerical ID of the axion to remove
+      # @return [HTTParty::Response]
+      def remove_medium_from_axion(*args)
+        raise ArgumentError.new('The method `remove_medium_from_axion` requires 2 argments (axion-id and medium-id)') if args.size != 2
+        self.class.delete("/axions/#{args[0]}/media/#{args[-1]}.json?apikey=#{apikey}")
+      end
+    end
+  end
+end