newrelic_data 0.0.3

data/Gemfile

@@ -0,0 +1,11 @@
+source :rubygems
+
+gem 'curb'
+gem 'xml-simple'
+
+group :development do
+  gem 'rspec'
+  gem 'simplecov'
+  gem 'yard'
+  gem 'redcarpet'
+end

data/HISTORY.md

@@ -0,0 +1,15 @@
+NewRelicData History
+====================
+
+### 0.0.2
+
+* Made work.
+* Added support for "app_name" 
+* Added functional tests.
+  * `rspec ./spec/newrelic_data_functional.rb`
+
+### 0.0.1
+
+* Initial Release
+
+

data/README.md

@@ -0,0 +1,56 @@
+NewRelicData
+============
+
+This is a simple interface for accessing data through [NewRelic's RESTful API](https://newrelic.com/docs/docs/getting-started-with-the-new-relic-rest-api).
+
+* [Gem on Rubygems.com](https://rubygems.org/gems/newrelic_data)
+* [Documentation](http://jmervine.github.com/newrelic_data/doc/)
+* [Coverage](http://jmervine.github.com/newrelic_data/coverage/)
+* [History](https://github.com/jmervine/newrelic_data/blob/master/HISTORY.md)
+
+### Installation
+
+        gem install newrelic_data
+
+Via Bundler
+
+     sources :rubygems
+     gem 'newrelic_data'
+
+### Usage
+
+     require 'newrelic_data'
+     @newrelic = NewRelicData.new
+
+     @newrelic.format = "json" # default
+     
+     @newrelic.configure({
+         api_key:      "your_newrelic_api_key",
+         account:      4321,     # NewRelic Account ID
+         application:  654321,   # NewRelic Application ID 
+         # Also supported:
+         # application:  "app name",   # NewRelic Application name.
+         query_params: {
+             metrics:      [ "Apdex", "Apdex/home/index" ],
+             field:        "score",
+             begin:        @newrelic.today,
+             end:          7.days_ago
+         }
+     })
+     
+     pp @newrelic.fetch
+
+### Disclaimer
+
+NewRelic (tm) is a trademark of [New Relic, Inc.](http://www.newrelic.com/). This was written without their consent and is in no way affiliated with them.
+
+#### MIT License
+
+Copyright (C) 2012 Joshua P. Mervine
+
+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/lib/newrelic_data.rb

@@ -0,0 +1,207 @@
+require 'date'
+require 'curb'
+require 'json'
+require 'xmlsimple'
+require 'csv'
+require 'uri'
+
+# A simple utility for getting data from NewRelic based
+# loosly off of NewRelic's API.
+class NewRelicData
+
+  # Version for gem.
+  VERSION = "0.0.3"
+
+  # @return [String] NewRelic API key.
+  attr_accessor :api_key
+ 
+  # @return [Boolean] Use 'http' or 'https', defaults to true.
+  attr_accessor :ssl
+
+  # @return [String] NewRelic API host, defaults to 'rpm.newrelic.com'.
+  attr_accessor :host
+ 
+  # @return [Fixnum] NewRelic API port, defaults to '80'.
+  attr_accessor :port
+ 
+  # @return [Fixnum] NewRelic Account ID.
+  attr_accessor :account
+  
+  # @return [Fixnum] NewRelic Application ID.
+  attr_accessor :application
+ 
+  # @return [String] Format to return NewRelic data; valid options:
+  # * json
+  # * xml
+  # * csv
+  attr_accessor :format
+ 
+  # @return [Hash] Parameters to be passed to NewRelic API.
+  attr_accessor :query_params
+
+  # == Parameters:
+  # See {#configure}.
+  def initialize opts={}
+    self.ssl = true
+    configure(opts)
+  end
+
+  # == Parameters:
+  # api_key::
+  #   See {#api_key}
+  # ssl::
+  #   See {#ssl}
+  # host:: 
+  #   See {#host}
+  # port::
+  #   See {#port}
+  # application::
+  #   See {#application}
+  # account::
+  #   See {#account}
+  # format::
+  #   See {#format}
+  # query_params::
+  #   See {#query_params}
+  #
+  # == Example:
+  #
+  # nr.configure( metrics: [ "Apdex" ], field: "score" )
+  def configure opts
+    opts.each do |key,val| 
+      self.send("#{key}=".to_sym, val)
+    end
+  end
+
+  # @return [Hash] or [Array] parsed data from NewRelic. 
+  def fetch
+    case self.format
+    when "json"
+      return JSON.parse(fetch_raw)
+    when "xml"
+      return XmlSimple.xml_in(fetch_raw)
+    when "csv"
+      return CSV.parse(fetch_raw)
+    else
+      raise "unsupport format '#{self.format}', try #fetch_raw"
+    end
+  end
+
+  # @return [String] raw data from NewRelic.
+  def fetch_raw
+    Curl::Easy.perform(fetch_path) do |curl|
+      curl.headers['x-api-key'] = self.api_key
+    end.body_str
+  end
+
+  # @return [String] URI to be used to fetch content
+  def fetch_path
+    port = ":#{self.port}" unless self.port.nil? or self.port == 80
+    "#{self.ssl ? 'https' : 'http' }://#{self.host}#{port}/api/v1/#{self.account}/metrics/data.#{self.format}?#{self.query_string}"
+  end
+
+  # @return [String] NewRelic API key.
+  def api_key
+    raise "api_key required" unless @api_key
+    @api_key
+  end
+
+  # @return [String] NewRelic API host, defaults to 'api.newrelic.com'.
+  def host
+    @host||"api.newrelic.com"
+  end
+
+  # @return [Fixnum] NewRelic API port, defaults to '80'.
+  def port
+    @port||80
+  end
+ 
+  # @return [Fixnum] NewRelic Application ID.
+  def application
+    raise "application required" unless @application
+    @application
+  end
+
+  def application=(a)
+    @application = a
+    if @application.kind_of? String and @application.to_i == 0
+      self.query_params = self.query_params.merge({ "app_name" => @application })
+      self.query_params.delete("app_id") if self.query_params.has_key?("app_id")
+    else
+      self.query_params = self.query_params.merge({ "app_id" => @application })
+      self.query_params.delete("app_name") if self.query_params.has_key?("app_name")
+    end
+    @application
+  end
+
+  # @return [Fixnum] NewRelic Account ID.
+  def account
+    raise "account required" unless @account
+    "accounts/#{@account}"
+  end
+
+  # @return [String] Format to return NewRelic data; valid options:
+  # * json
+  # * xml
+  # * csv
+  def format
+    @format||"json"
+  end
+
+  # @return [Hash] Parameters to be passed to NewRelic API.
+  #
+  # == Parameters:
+  # * "metrics" -- [Array]  (see NewRelic API)
+  # * "field"   -- [String] (see NewRelic API)
+  # * "begin"   -- [String] (format: YYYY-MM-DDTHH:MM:SSZ)
+  # * "end"     -- [String] (format: YYYY-MM-DDTHH:MM:SSZ)
+  #
+  # == Note:
+  # 'begin' and 'end' can be set using X.days_ago or helpers {#today} or {#yesterday}
+  def query_params
+    @query_params||{ "metrics" => [ "Apdex" ], "field" => "score", "begin" => 1.day_ago, "end" => self.today, "summary" => 1 }
+  end
+
+  def query_params=(q)
+    @query_params = q
+    @query_params["app_id"] = @application if @application and !@query_params.has_key?("app_id")
+  end
+
+  # @return [String] {#query_params} as a URI query string.
+  def query_string
+    q = []
+    self.query_params.each do |key,val|
+      if val.kind_of? Array
+        val.each do |v|
+          q.push "#{key}[]=#{v}"
+        end
+      else
+        q.push "#{key}=#{val}"
+      end
+    end
+    URI.escape(q.join("&"))
+  end
+
+  # @return [String] Today formated for 'begin' or 'end' {#query_params}.
+  def today
+    0.days_ago
+  end
+
+  # @return [String] Yesterday formated for 'begin' or 'end' {#query_params}.
+  def yesterday
+    1.day_ago
+  end
+
+end
+
+# Monkey patch of the [Integer] object for quickly generating
+# {NewRelicData#query_params} options 'begin' and 'end'.
+class Integer
+  # @return [String] formated for {NewRelicData#query_params} 'begin' and 'end'.
+  # * N.days_ago at '00:00:00'
+  def days_ago
+    (DateTime.now-self).strftime("%Y-%m-%dT00:00:00Z")
+  end
+  alias :day_ago :days_ago
+end
+

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: newrelic_data
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Joshua Mervine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-06 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &16055980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16055980
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &16054500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16054500
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &16053580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16053580
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &16052620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16052620
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: &16051560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *16051560
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: &16050340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *16050340
+description: Simple utility for access NewRelic data through their RESTful API.
+email:
+- joshua@mervine.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/newrelic_data.rb
+- README.md
+- HISTORY.md
+- Gemfile
+homepage: http://github.com/jmervine/newrelic_data
+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'
+      segments:
+      - 0
+      hash: -3303414572505684251
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: NewRelic Data access API
+test_files: []
+has_rdoc: