giraffi 0.1.3

data/lib/giraffi/client/items.rb

@@ -0,0 +1,102 @@
+module Giraffi
+  class Client
+    # Defines methods related to the items
+
+    module Items
+      # Returns the desired items
+      #
+      # @requires_apikey Yes
+      # @param options [Hash] The request params to retrieve the desired items
+      # @return [HTTParty::Response]
+      def find_items(options={})
+        self.class.get("/items.json?apikey=#{apikey}", :query => options)
+      end
+
+      # Returns the desired item by the numerical ID
+      #
+      # @requires_apikey Yes
+      # @param id [String] The numerical ID of the desired item
+      # @return [HTTParty::Response]
+      def find_item(id)
+        self.class.get("/items/#{id}.json?apikey=#{apikey}")
+      end
+
+      # Returns the desired agent related to the item
+      #
+      # @requires_apikey Yes
+      # @param id [String] The numerical ID of the desired item
+      # @return [HTTParty::Response]
+      def find_agent(id)
+        # TODO
+      end
+
+      # Returns all services related to the item
+      #
+      # @requires_apikey Yes
+      # @param id [String] The numerical ID of the item
+      # @param options [Hash] A set of params to retrieve services related the item
+      # @return [HTTParty::Response]
+      def find_services_by_item(id, options={})
+        self.class.get("/items/#{id}/services.json?apikey=#{apikey}", :query => options)
+      end
+
+      # Creates a new item
+      #
+      # @requires_apikey Yes
+      # @param options [Hash] A set of attributes to create a new item
+      # @return [HTTParty::Response]
+      def create_item(options={})
+        self.class.post("/items.json?apikey=#{apikey}", :query => { :item => options })
+      end
+
+      # Reloads all items
+      #
+      # @requires_apikey Yes
+      # @return [HTTParty::Response]
+      def reload_items
+        self.class.post("/items/reload.json?apikey=#{apikey}")
+      end
+
+      # Adds a service to the item
+      #
+      # @requires_apikey Yes
+      # @param id [String] The numerical ID of the related item
+      # @param options [Hash] A set of attributes for a service to add to the item
+      # @return [HTTParty::Response]
+      def add_service_to_item(id, options={})
+        self.class.post("/items/#{id}/services.json?apikey=#{apikey}", :query => { :service => options })
+      end
+
+      # Updates the desired item
+      #
+      # @requires_apikey Yes
+      # @param id [String] The numerical ID of the desired item
+      # @param options [Hash] A set of attributes to update the item
+      # @return [HTTParty::Response]
+      def update_item(id, options={})
+        self.class.put("/items/#{id}.json?apikey=#{apikey}", :query => {:item => options}, :body => {})
+      end
+
+      # Deletes the item
+      #
+      # @requires_apikey Yes
+      # @param id [String] The numerical ID of the desired item
+      # @return [HTTParty::Response]
+      def destroy_item(id)
+        self.class.delete("/items/#{id}.json?apikey=#{apikey}")
+      end
+
+      # Removes a service from the item
+      #
+      # @requires_apikey Yes
+      # @param args [Array] A set of params to remove a service from the item
+      # @option args [String] The numerical ID of the related item
+      # @option args [String] The numerical ID of the service to remove
+      # @return [HTTParty::Response]
+      def remove_service_from_item(*args)
+        raise ArgumentError.new('The method `remove_service_from_item` requires 2 arguments (item-id and service-id)') if args.size != 2
+        self.class.delete("/items/#{args[0]}/services/#{args[-1]}.json?apikey=#{apikey}")
+      end
+    end
+  end
+end

data/lib/giraffi/client/logs.rb

@@ -0,0 +1,23 @@
+module Giraffi
+  class Client
+    # Defines methods related to the logs generated by the Giraffi
+
+    module Logs
+      # Returns the desired logs related to the axions
+      #
+      # @param options [Hash] The request params to retrieve the desired logs
+      # @return [HTTParty::Response]
+      def find_axion_logs(options={})
+        self.class.get("/logs/axion.json?apikey=#{apikey}", query: options)
+      end
+
+      # Returns the number of logs related to the axions
+      #
+      # @param options [Hash] The request params to retrieve the desired logs to count
+      # @return [HTTParty::Response]
+      def count_axion_logs(options={})
+        self.class.get("/logs/axion/count.json?apikey=#{apikey}", query: options)
+      end
+    end
+  end
+end

data/lib/giraffi/client/media.rb

@@ -0,0 +1,67 @@
+module Giraffi
+  class Client
+    # Defines methods related to the media
+
+    module Media
+      # Returns the desired media
+      #
+      # @param options [Hash] The request params to retrieve the desired media
+      # @return [HTTParty::Response]
+      def find_media(options={})
+        self.class.get("/media.json?apikey=#{apikey}", :query => options)
+      end
+
+      # Returns the desired medium
+      #
+      # @param id [String] The numerical ID of the desired medium
+      # @return [HTTParty::Response]
+      def find_medium(id)
+        self.class.get("/media/#{id}.json?apikey=#{apikey}")
+      end
+
+      # Returns the desired oauth
+      #
+      # @param id [String] The numerical ID of the desired medium
+      # @return [HTTParty::Response]
+      def find_oauth_by_medium(id)
+        self.class.get("/media/#{id}/oauth.json?apikey=#{apikey}")
+      end
+
+      # Returns the oauth-callbacks related to the medium
+      #
+      # @param args [Array] A set of params to retrieve the desired oauth-callback
+      # @option args [String] The numerical ID of the desired medium
+      # @option args [String] The oauth verifier related to the callback
+      # @return [HTTParty::Response]
+      def find_oauth_callback_by_medium(*args)
+        raise ArgumentError.new('The method `find_oauth_callback_by_medium` requires 2 arguments(medium-id and oauth-token)') if args.size != 2
+        self.class.get("/media/#{args[0]}/oauth_callback.json?apikey=#{apikey}", :query => {:oauth_verifier => args[-1]})
+      end
+
+      # Creates a new medium
+      #
+      # @param options [Hash] A set of attributes to create a new medium
+      # @return [HTTParty::Response]
+      def create_medium(options={})
+        self.class.post("/media.json?apikey=#{apikey}", :query => { :medium => options })
+      end
+
+      # Updates the desired medium
+      #
+      # @param id [String] The numerical ID of the desired medium
+      # @param options [Hash] A set of attributes to update the medium
+      # @return [HTTParty::Response]
+      def update_medium(id, options={})
+        self.class.put("/media/#{id}.json?apikey=#{apikey}", :query => {:medium => options}, :body => {})
+      end
+
+      # Deletes the medium
+      #
+      # @param id [String] The numerical ID of the desired medium
+      # @return [HTTParty::Response]
+      def destroy_medium(id)
+        self.class.delete("/media/#{id}?apikey=#{apikey}")
+      end
+    end
+  end
+end

data/lib/giraffi/client/monitoringdata.rb

@@ -0,0 +1,25 @@
+module Giraffi
+  class Client
+    # Defines methods related to the monitoring data
+
+    module Monitoringdata
+      # Returns the desired monitoring data
+      #
+      # @requires_apikey Yes
+      # @param options [Hash] The request params to retrieve the desired monitoring data
+      # @return [HTTParty::Response]
+      def find_monitoringdata(options={})
+        self.class.get("/monitoringdata.json?apikey=#{apikey}", query: options)
+      end
+
+      # Posts the monitoring data to the Giraffi
+      #
+      # @requires_apikey Yes
+      # @param options [Hash] The monitoring data to post to the Giraffi
+      # @return [HTTParty::Response]
+      def add_monitoringdata(options={})
+        self.class.post("#{monitoringdata_endpoint}/internal/nodelayed?apikey=#{apikey}", :body => MultiJson.encode({:internal => options}))
+      end
+    end
+  end
+end

data/lib/giraffi/client/my_current_status.rb

@@ -0,0 +1,19 @@
+module Giraffi
+  class Client
+  # Defines methods related to the status of endpoints
+
+    module MyCurrentStatus
+      # Returns the current status of the desired endpoint
+      #
+      # @requires_apikey No
+      # @param options [String] The alias string of the desired endpoint
+      # @return [HTTParty::Response]
+      def my_current_status(options="")
+        uri = to_uri options.to_sym
+        raise StandardError.new("The given key `#{options}` is not valid.") if uri.nil?
+        self.class.get("#{uri}/my_current_status.json")
+      end
+
+    end
+  end
+end

data/lib/giraffi/client/regions.rb

@@ -0,0 +1,15 @@
+module Giraffi
+  class Client
+    # Defines methods related to the regions
+
+    module Regions
+      # Returns all available regions
+      #
+      # @requires_apikey Yes
+      # @return [HTTParty::Response]
+      def find_regions
+        self.class.get("/regions.json?apikey=#{apikey}")
+      end
+    end
+  end
+end

data/lib/giraffi/client/services.rb

@@ -0,0 +1,97 @@
+module Giraffi
+  class Client
+    # Defines methods related to the services
+
+    module Services
+      # Returns the desired services
+      #
+      # @requires_apikey Yes
+      # @param options [Hash] The request params to retrieve the desired services
+      # @return [HTTParty::Response]
+      def find_services(options={})
+        self.class.get("/services.json?apikey=#{apikey}", :query => options)
+      end
+
+      # Returns the desired service
+      #
+      # @requires_apikey Yes
+      # @param id [String] The numerical ID of the desired service
+      # @return [HTTParty::Response]
+      def find_service(id)
+        self.class.get("/services/#{id}.json?apikey=#{apikey}")
+      end
+
+      # Returns the region related to the desired service
+      #
+      # @requires_apikey Yes
+      # @param id [String] The numerical ID of the desired service
+      # @return [HTTParty::Response]
+      def find_region_by_service(id)
+        self.class.get("/services/#{id}/regions.json?apikey=#{apikey}") 
+      end
+
+      # Returns all triggers related to the desired service
+      #
+      # @requires_apikey Yes
+      # @param id [String] The numerical ID of the desired service
+      # @return [HTTParty::Response]
+      def find_triggers_by_service(id)
+        self.class.get("/services/#{id}/triggers.json?apikey=#{apikey}")
+      end
+
+      # Adds a trigger to the service
+      #
+      # @requires_apikey Yes
+      # @param id [String] The numerical ID of the related service
+      # @param options [Hash] A set of attributes for a trigger to add to the service
+      # @return [HTTParty::Response]
+      def add_trigger_to_service(id, options={})
+        self.class.post("/services/#{id}/triggers.json?apikey=#{apikey}", :query => {:trigger => options})
+      end
+
+      # Updates the desired service
+      #
+      # @requires_apikey Yes
+      # @param id [String] The numerical ID of the desired service
+      # @param options [Hash] A set of attributes to update the service
+      # @return [HTTParty::Response]
+      def update_service(id, options={})
+        self.class.put("/services/#{id}.json?apikey=#{apikey}", :query => {:service => options}, :body => {})
+      end
+
+      # Updates the region related to the service
+      #
+      # @requires_apikey Yes
+      # @param args [Array] A set of params to update the region
+      # @option args [String] The numerical ID of the related service
+      # @option args [String] The region code(e.g JP) to update
+      # @return [HTTParty::Response]
+      def update_region_of_service(*args)
+        raise ArgumentError.new('The method `update_region_of_service` requires 2 arguments (service-id and region-code).') if args.size != 2
+        self.class.put("/services/#{args[0]}/regions/#{args[-1]}.json?apikey=#{apikey}", :body => {})
+      end
+
+      # Deletes the service
+      #
+      # @requires_apikey Yes
+      # @param id [String] The numerical ID of the desired service
+      # @return [HTTParty::Response]
+      def destroy_service(id)
+        self.class.delete("/services/#{id}.json?apikey=#{apikey}")
+      end
+
+      # Removes a trigger from the service
+      #
+      # @requires_apikey Yes
+      # @param args [Array] A set of params to remove a trigger from the service
+      # @option args [String] The numerical ID of the related service
+      # @option args [String] The numerical ID of the trigger to remove
+      # @return [HTTParty::Response]
+      def remove_trigger_from_service(*args)
+        raise ArgumentError.new('The method `remove_trigger_from_service` requires 2 arguments (service-id and trigger-id).') if args.size != 2
+        self.class.delete("/services/#{args[0]}/triggers/#{args[-1]}.json?apikey=#{apikey}")
+      end
+    end
+  end
+end
+

data/lib/giraffi/client/trends.rb

@@ -0,0 +1,25 @@
+module Giraffi
+  class Client
+    # Defines methods related to the trend data
+
+    module Trends
+      # Returns the desired trend data(average)
+      #
+      # @requires_apikey Yes
+      # @param options [Hash] The request params to retrieve the desired trend data(average)
+      # @return [HTTParty::Response]
+      def find_average_trends(options={})
+        self.class.get("/trends/average.json?apikey=#{apikey}", query: options)
+      end
+
+      # Returns the desired trend data(failure)
+      #
+      # @requires_apikey Yes
+      # @param options [Hash] The request params to retrieve the desired trend data(failure)
+      # @return [HTTParty::Response]
+      def find_failure_trends(options={})
+        self.class.get("/trends/failure.json?apikey=#{apikey}", query: options)
+      end
+    end
+  end
+end

data/lib/giraffi/client/triggers.rb

@@ -0,0 +1,94 @@
+module Giraffi
+  class Client
+    # Defines methods related to the triggers
+
+    module Triggers
+      # Returns the desired trigger
+      #
+      # @requires_apikey Yes
+      # @param options [Hash] The request params to retrieve the desired triggers
+      # @return [HTTParty::Response]
+      def find_triggers(options={})
+        self.class.get("/triggers.json?apikey=#{apikey}", :query => options)
+      end
+
+      # Returns the desired trigger
+      #
+      # @requires_apikey Yes
+      # @param id [String] The numerical ID of the desired trigger
+      # @return [HTTParty::Response]
+      def find_trigger(id)
+        self.class.get("/triggers/#{id}.json?apikey=#{apikey}")
+      end
+
+      # Returns all axions related to the desired trigger
+      #
+      # @requires_apikey Yes
+      # @param args [Array] A set of params to retrieve axions related to the trigger
+      # @option args [String] The numerical ID of the related trigger
+      # @option args [String] The kind of axion [problem, recovery] to retrieve
+      # @return [HTTParty::Response]
+      def find_axions_by_trigger(*args)
+        raise ArgumentError.new('The method `find_axions_by_trigger` requires at least a trigger id.') if args.size.zero?
+        if args.size == 1
+          self.class.get("/triggers/#{args[0]}/axions.json?apikey=#{apikey}")
+        else
+          self.class.get("/triggers/#{args[0]}/axions.json?apikey=#{apikey}", :query => {:axionkind => args[-1]})
+        end
+      end
+
+      # Executes all axions related to the desired trigger
+      #
+      # @requires_apikey Yes
+      # @param id [String] The numerical ID of the desired trigger
+      # @return [HTTParty::Response]
+      def execute_axions_by_trigger(id)
+        self.class.post("/triggers/#{id}/axions/execute.json?apikey=#{apikey}")
+      end
+
+      # Updates the desired trigger
+      #
+      # @requires_apikey Yes
+      # @param id [String] The numerical ID of the desired trigger
+      # @param options [Hash] A set of attributes to update the trigger
+      # @return [HTTParty::Response]
+      def update_trigger(id, options={})
+        self.class.put("/triggers/#{id}.json?apikey=#{apikey}", :query => {:trigger => options}, :body => {})
+      end
+
+      # Updates the axion related to the desired trigger
+      #
+      # @requires_apikey Yes
+      # @param args [Array] A set of parmas to update the axion related to the trigger
+      # @option args [String] The numerical ID of the related trigger
+      # @option args [String] The numerical ID of the desired axion
+      # @option args [String] The kind of axion [problem, recovery] to update
+      # @return [HTTParty::Response]
+      def update_axion_of_trigger(*args)
+        raise ArgumentError.new('The method `update_axion_by_trigger` requires 3 argments (trigger-id, axion-id and axion-kind)') if args.size != 3
+        self.class.put("/triggers/#{args[0]}/axions/#{args[1]}.json?apikey=#{apikey}", :query => { :axionkind => args[-1] }, :body => {})
+      end
+
+      # Deletes the trigger
+      #
+      # @requires_apikey Yes
+      # @param id [String] The numerical ID of the desired trigger
+      # @return [HTTParty::Response]
+      def destroy_trigger(id)
+        self.class.delete("/triggers/#{id}.json?apikey=#{apikey}")
+      end
+
+      # Removes an axion from the trigger
+      #
+      # @requires_apikey Yes
+      # @param args [Array] A set of parmas to remove an axion from the trigger
+      # @option args [String] The numerical ID of the related trigger
+      # @option args [String] The numerical ID of the axion to remove
+      # @return [HTTParty::Response]
+      def remove_axion_from_trigger(*args)
+        raise ArgumentError.new('The method `remove_axion_from_trigger` requires 2 arguments (trigger-id and axion-id)') if args.size != 2
+        self.class.delete("/triggers/#{args[0]}/axions/#{args[-1]}.json?apikey=#{apikey}")
+      end
+    end
+  end
+end

data/lib/giraffi/client.rb

@@ -0,0 +1,73 @@
+require 'httparty'
+require 'multi_json'
+require 'giraffi/config'
+
+module Giraffi
+  # Warpper for the Giraffi RESTful API
+
+  class Client
+    include MultiJson
+    include HTTParty
+    base_uri Config::DEFAULT_ENDPOINT
+    headers Config::DEFAULT_REQUEST_HEADERS
+    format :plain #:json
+    #debug_output
+
+    # Requires client method modules
+    require 'giraffi/client/items'
+    require 'giraffi/client/services'
+    require 'giraffi/client/media'
+    require 'giraffi/client/axions'
+    require 'giraffi/client/applogs'
+    require 'giraffi/client/logs'
+    require 'giraffi/client/monitoringdata'
+    require 'giraffi/client/my_current_status'
+    require 'giraffi/client/regions'
+    require 'giraffi/client/trends'
+    require 'giraffi/client/triggers'
+
+    include Giraffi::Client::Items
+    include Giraffi::Client::Services
+    include Giraffi::Client::Media
+    include Giraffi::Client::Axions
+    include Giraffi::Client::Applogs
+    include Giraffi::Client::Logs
+    include Giraffi::Client::Monitoringdata
+    include Giraffi::Client::MyCurrentStatus
+    include Giraffi::Client::Regions
+    include Giraffi::Client::Trends
+    include Giraffi::Client::Triggers
+
+    # @return [Array] the attributes +Config::VALID_OPTIONS_KEYS+ as a Array
+    attr_accessor *Config::VALID_OPTIONS_KEYS
+
+    # Examines a bad response and raise an appropriate error
+    #
+    # @param response [HTTParty::Response]
+    def bad_response(response)
+      if response.class == HTTParty::Response
+        raise ResponseError, response
+      end
+      raise StandardError, "Unknown error"
+    end
+
+    # Initializes a new API object
+    #
+    # @param attrs [Hash] The options allows you to access the Giraffi RESTful API
+    # @return [Giraffi::Client]
+    def initialize(attrs={})
+      attrs = Giraffi.options.merge(attrs)
+      Config::VALID_OPTIONS_KEYS.each do |key|
+        instance_variable_set("@#{key}".to_sym, attrs[key])
+      end
+    end
+
+    # Returns the URL related to the given key
+    #
+    # @param options [Symbol] The keyword related to the real URI
+    # @return [String] URI or nil when no matching value
+    def to_uri(key)
+      {papi: endpoint,okapi: monitoringdata_endpoint,lapi: applogs_endpoint}[key] || nil
+    end
+  end
+end

data/lib/giraffi/config.rb

@@ -0,0 +1,60 @@
+require 'giraffi/version'
+
+module Giraffi
+  # Defines constants and methods related to configuration
+  module Config
+
+    # The HTTP request header if none is set
+    DEFAULT_REQUEST_HEADERS = {
+      "User-Agent"    => "Giraffi Ruby Gem #{Giraffi::Version}",
+      "Accept"        => "application/json",
+      "Content-Type"  => "application/json"
+    }
+
+    # The basic endpoint if none is set
+    DEFAULT_ENDPOINT                = 'https://papi.giraffi.jp'
+
+    # The endpoint for posting the monitoringdata if none is set
+    DEFAULT_MONITORINGDATA_ENDPOINT = 'https://okapi.giraffi.jp:3007'
+
+    # The endpoint for posting the application logs if none is set
+    DEFAULT_APPLOGS_ENDPOINT        = 'https://lapi.giraffi.jp:3443'
+
+    # The APIKEY to allow you to use the Giraffi API if none is set
+    DEFAULT_APIKEY                  = nil
+
+    # An array of valid keys in the options hash when configuring a {Giraffi::Client}
+    VALID_OPTIONS_KEYS = [
+      :request_headers,
+      :endpoint,
+      :monitoringdata_endpoint,
+      :applogs_endpoint,
+      :apikey
+    ]
+
+    # @return [Array] the attribute +VALID_OPTIONS_KEYS+ as an Array
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # Set all configuration options to thier values when this module is extended
+    def self.extended(base)
+      base.reset
+    end
+
+    # Create a hash of options and thier values
+    def options
+      options = {}
+      VALID_OPTIONS_KEYS.each{|k| options[k] = send(k)}
+      options
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.request_headers          = DEFAULT_REQUEST_HEADERS
+      self.endpoint                 = DEFAULT_ENDPOINT
+      self.monitoringdata_endpoint  = DEFAULT_MONITORINGDATA_ENDPOINT
+      self.applogs_endpoint         = DEFAULT_APPLOGS_ENDPOINT
+      self.apikey                   = DEFAULT_APIKEY
+    end
+
+  end
+end

data/lib/giraffi/version.rb

@@ -0,0 +1,3 @@
+module Giraffi
+  Version = '0.1.3'
+end

data/lib/giraffi.rb

@@ -0,0 +1,26 @@
+$:.unshift File.dirname(__FILE__)
+require 'giraffi/client'
+require 'giraffi/config'
+
+module Giraffi
+  extend Config
+  class << self
+    # Alias for Giraffi::Client.new
+    #
+    # @param options [Hash] The APIKEY allows you to access the Giraffi RESTful API
+    # @return [Giraffi::Client]
+    def new(options={})
+      Giraffi::Client.new(options)
+    end
+
+    # Delegate to Giraffi::Client
+    def method_missing(method, *args, &blocks)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private=false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+  end
+end