newrelic_plugin 1.0.2

data/lib/newrelic_plugin/version.rb

@@ -0,0 +1,5 @@
+module NewRelic
+  module Plugin
+    VERSION = "1.0.2"
+  end
+end

data/newrelic_plugin.gemspec

@@ -0,0 +1,47 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/newrelic_plugin/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  s.name          = 'newrelic_plugin'
+  s.version       = NewRelic::Plugin::VERSION
+  s.rubyforge_project = 'newrelic_plugin'
+
+  ## Edit these as appropriate
+  s.summary     = "New Relic Ruby Plugin SDK"
+  s.description   = %q{The New Relic Plugin Gem is used to send plugin data to New Relic from non-application sources.}
+
+  s.authors       = ["New Relic"]
+  s.email         = ["support@newrelic.com"]
+  s.homepage =    'http://newrelic.com'
+
+  s.require_paths = %w[lib]
+
+  s.rdoc_options = ["--charset=UTF-8",
+                    "--main", "README.md"]
+  s.extra_rdoc_files = %w[README.md LICENSE]
+
+  s.add_dependency 'faraday', '>= 0.8.1'
+  s.add_dependency 'json'
+
+  ## List your development dependencies here. Development dependencies are
+  ## those that are only needed during development
+  #s.add_development_dependency "minitest"
+  #s.add_development_dependency "vcr"
+  s.add_development_dependency 'shoulda-context'
+  s.add_development_dependency 'mocha'
+
+  s.files         = `git ls-files`.split($\)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+
+end

data/test/agent_test.rb

@@ -0,0 +1,153 @@
+require 'test_helper'
+
+class AgentTest < Test::Unit::TestCase
+
+  def setup 
+    @agent_info = {:ident => 1}
+    @agent_class = TestingAgent::Agent.dup
+  end
+
+  context :agent_guid do
+    should 'set guid' do
+      @agent_class.class_eval do
+        agent_guid '12234'
+      end
+      agent = @agent_class.new('test agent', @agent_info)
+      assert_equal '12234', agent.class.guid
+    end
+
+    should 'raise RuntimeError if guid is set to nil' do
+      assert_raise RuntimeError do
+        @agent_class.class_eval do
+          agent_guid nil
+        end
+      end
+    end
+
+    should 'raise RuntimeError if guid is set to empty string' do
+      assert_raise RuntimeError do
+        @agent_class.class_eval do
+          agent_guid ""
+        end
+      end
+    end
+  end
+
+  context :guid do
+    should "return instance @guid" do
+      agent = @agent_class.new('test agent', @agent_info)
+      agent.instance_variable_set(:@guid, 'test')
+      assert_equal 'test', agent.guid
+    end
+
+    should "return class guid" do
+      @agent_class.class_eval do
+        @guid = '123'
+      end
+      agent = @agent_class.new('test agent', @agent_info)
+      assert_equal '123', agent.guid
+    end 
+
+    should "raise error if guid is not set properly" do
+      @agent_class.class_eval do
+        @guid = 'guid'
+      end
+      #agent = TestingAgent::Agent.new('test agent', @agent_info)
+      # refactor the code this is hitting before finishing this test
+      # this does not test well
+      #assert_raise RuntimeError, 'Did not set GUID' do
+      #  agent.guid
+      #end
+    end
+  end
+
+  context :agent_version do
+    should 'set version' do
+      @agent_class.class_eval do
+        agent_version '0.0.1'
+      end
+      agent = @agent_class.new('test agent', @agent_info)
+      assert_equal '0.0.1', agent.class.version
+    end
+  end
+
+  context :version do
+    should 'return class @version' do
+      @agent_class.class_eval do
+        @version = '1.2.3'
+      end
+      agent = @agent_class.new('test agent', @agent_info)
+      assert_equal '1.2.3', agent.version
+    end
+  end
+
+  context :agent_human_labels do
+    setup do
+      @agent_class.class_eval do
+        agent_human_labels('Testing Agent') { 'Testing Agent block' }
+      end
+      @agent = @agent_class.new('test agent', @agent_info)
+    end
+    should 'set class @label' do
+      assert_equal 'Testing Agent', @agent.class.label
+    end
+    should 'set instance label proc' do
+      assert_equal "Testing Agent block", @agent.class.instance_label_proc.call
+    end
+  end
+
+  context :no_config_required do
+    should 'set class @no_config_required' do
+      @agent_class.class_eval do
+        agent_human_labels('Testing Agent') { 'Testing Agent block' }
+      end
+      agent = @agent_class.new('test agent', @agent_info)
+      assert_equal true, agent.class.no_config_required
+    end
+  end
+
+  context :config_required? do
+    should 'return false when class @no_config_required true' do
+      @agent_class.class_eval do
+        @no_config_required = true
+      end
+      agent = @agent_class.new('test agent', @agent_info)
+      assert_equal false, agent.class.config_required?
+    end
+    should 'return true when class @no_config_required false' do
+      @agent_class.class_eval do
+        @no_config_required = false
+      end
+      agent = @agent_class.new('test agent', @agent_info)
+      assert_equal true, agent.class.config_required?
+    end
+    should 'return true when class @no_config_required is not set' do
+      @agent_class.class_eval do
+      end
+      agent = @agent_class.new('test agent', @agent_info)
+      assert_equal true, agent.class.config_required?
+    end
+  end
+
+  context :agent_config_options do
+    should 'set class @config_options_list if empty' do
+      @agent_class.class_eval do
+        agent_config_options(:test, 'foo', 'bar')
+      end
+      @agent = @agent_class.new('test agent', @agent_info)
+      assert_equal [:test, 'foo', 'bar'], @agent.class.config_options_list  
+    end
+
+    should 'add to existing @config_options_list' do
+      @agent_class.class_eval do
+        attr_accessor 'foobar'
+        @config_options_list = ['foobar']
+        agent_config_options(:test, 'foo', 'bar')
+      end
+  
+      @agent = @agent_class.new('test agent', @agent_info)
+      assert_equal ['foobar', :test, 'foo', 'bar'], @agent.class.config_options_list  
+    end
+  end
+
+end

data/test/fixtures/valid_payload.json

@@ -0,0 +1,17 @@
+{
+  "agent": {
+    "host" : "localhost",
+    "name" : "Test",
+    "version" : "1.0.0" },
+  "components": [
+    { "name": "Xtra DB",
+      "guid": "com.newrelic.test.Plugin",
+      "duration" : 120,
+      "metrics" : {
+        "one": 100, 
+        "two": [10,2,2,8,68]
+       }
+    } 
+  ] 
+}
+

data/test/manual_test.rb

@@ -0,0 +1,20 @@
+require 'test_helper'
+
+
+new_relic_message = NewRelic::Plugin::NewRelicMessage.new('fake connection', 'manual curl test', 'manual-test-guid', 'version', 60)
+new_relic_message.add_stat_fullname('test metric', 2, 2, :min => 1, :max => 3, :sum_of_squares => 10) 
+new_relic_message.add_stat_fullname('other metric', 2, 2, :min => 2, :max => 2, :sum_of_squares => 8) 
+
+puts <<-EOF
+########################################################
+Manual testing -- output curl command with payload
+########################################################
+
+ curl -vi http://collector.newrelic.com/platform/v1/metrics \
+    -H "X-License-Key: ADD_LICENSE_KEY" \
+    -H "Content-Type: application/json" \
+    -H "Accept: application/json" \
+    -X POST -d \'#{new_relic_message.send(:build_request_payload)}\'
+
+########################################################
+EOF

data/test/new_relic_message_test.rb

@@ -0,0 +1,76 @@
+require 'test_helper'
+
+class NewRelicMessageTest < Test::Unit::TestCase
+  def setup 
+    @new_relic_message = NewRelic::Plugin::NewRelicMessage.new('foo', 'test component name', 'fake guid', 'version', 60)
+  end
+
+  context 'initialization' do
+    should 'start with an empty metrics array' do
+      assert_equal [], @new_relic_message.instance_variable_get(:@metrics)
+    end
+  end
+
+  context :add_stat_fullname do
+    setup do
+      @new_relic_message.add_stat_fullname('test metric', 2, 2, :min => 1, :max => 3, :sum_of_squares => 10) 
+    end
+    should '@metric array should have 1 metric' do
+      assert_equal 1, @new_relic_message.metrics.size
+    end
+
+    should '@metric array should include expected data' do
+      stored_metric = {
+        :metric_name => 'test metric',
+        :count => 2,
+        :total => 2,
+        :min => 1,
+        :max => 3,
+        :sum_of_squares => 10
+      }
+      assert_equal stored_metric, @new_relic_message.metrics.first
+    end
+  end
+
+  context :build_metrics_hash do
+    setup do
+      @new_relic_message.add_stat_fullname('test metric', 2, 2, :min => 1, :max => 3, :sum_of_squares => 10) 
+      @new_relic_message.add_stat_fullname('other metric', 2, 2, :min => 2, :max => 2, :sum_of_squares => 8) 
+    end
+
+    should 'build expected metric hash' do
+      metric_hash = {
+        'test metric' => [2,2,3,1,10],
+        'other metric' => [2,2,2,2,8]
+      }
+      assert_equal metric_hash, @new_relic_message.send(:build_metrics_hash)
+    end
+  end
+
+  context :build_request_payload do
+    setup do 
+      @new_relic_message.add_stat_fullname('test metric', 2, 2, :min => 1, :max => 3, :sum_of_squares => 10) 
+    end
+
+    should 'build expected request payload' do
+      payload = {
+        'agent' => {
+          'name' => 'test component name',
+          'version' => 'version',
+          'host' => ''
+        },
+        'components' => [
+          {
+            'name' => 'test component name',
+            'guid' => 'fake guid',
+            'duration' => 60,
+            'metrics' => @new_relic_message.send(:build_metrics_hash)
+          }
+        ]
+      }
+
+      assert_equal payload.to_json, @new_relic_message.send(:build_request_payload)
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+require 'newrelic_plugin'
+require 'test/unit'
+require 'shoulda-context'
+require 'mocha'
+
+
+module TestingAgent
+  class Agent < NewRelic::Plugin::Agent::Base
+
+  end
+end
+

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: newrelic_plugin
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+  prerelease: 
+platform: ruby
+authors:
+- New Relic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The New Relic Plugin Gem is used to send plugin data to New Relic from
+  non-application sources.
+email:
+- support@newrelic.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/newrelic_plugin.rb
+- lib/newrelic_plugin/agent.rb
+- lib/newrelic_plugin/config.rb
+- lib/newrelic_plugin/data_collector.rb
+- lib/newrelic_plugin/error.rb
+- lib/newrelic_plugin/new_relic_connection.rb
+- lib/newrelic_plugin/new_relic_message.rb
+- lib/newrelic_plugin/processor.rb
+- lib/newrelic_plugin/processors/epoch_counter_processor.rb
+- lib/newrelic_plugin/processors/rate_processor.rb
+- lib/newrelic_plugin/run.rb
+- lib/newrelic_plugin/setup.rb
+- lib/newrelic_plugin/simple_syntax.rb
+- lib/newrelic_plugin/version.rb
+- newrelic_plugin.gemspec
+- test/agent_test.rb
+- test/fixtures/valid_payload.json
+- test/manual_test.rb
+- test/new_relic_message_test.rb
+- test/test_helper.rb
+homepage: http://newrelic.com
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+- --main
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: newrelic_plugin
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 2
+summary: New Relic Ruby Plugin SDK
+test_files:
+- test/test_helper.rb