appsignal 0.5.0 → 0.5.1

data/README.md

@@ -40,9 +40,7 @@ Appsignal.postprocessing_middleware.add MiddlewareTemplate
 ```ruby
 class RemoveBoringPayload
   def call(event)
-    unless event.name == 'interesting'
-      event.payload = {}
-    end
+    event.payload.clear unless event.name == 'interesting'
     yield
   end
 end

data/config/appsignal.yml

@@ -1,8 +1,10 @@
 development: &development
   endpoint: "http://localhost:3000/1"
   api_key: "abc"
-  active: true
+  active: <%= 'true' %>
 production:
   <<: *development
+  api_key: "def"
 test:
   <<: *development
+  api_key: "ghi"

data/lib/appsignal/config.rb

@@ -11,28 +11,51 @@ module Appsignal
       :slow_request_threshold => 200
     }.freeze
 
-    attr_accessor :root_path, :rails_env
+    attr_reader :configurations, :project_path, :env
 
-    def initialize(root_path, rails_env, logger=Appsignal.logger)
-      @root_path = root_path
-      @rails_env = rails_env
+    def initialize(project_path, env, logger=Appsignal.logger)
+      @project_path = project_path
+      @env = env.to_sym
       @logger = logger
+      @configurations = {}
     end
 
     def load
-      file = File.join(@root_path, 'config/appsignal.yml')
+      return unless load_configurations_from_disk
+      return unless used_unique_api_keys
+      return unless current_environment_present
+
+      DEFAULT_CONFIG.merge(configurations[env])
+    end
+
+    protected
+
+    def load_configurations_from_disk
+      file = File.join(project_path, 'config', 'appsignal.yml')
       unless File.exists?(file)
-        carefully_log_error "config not found at: #{file}"
-        return
+        carefully_log_error "config not found at: '#{file}'"
+        return false
       end
+      @configurations = YAML.load(ERB.new(IO.read(file)).result)
+      configurations.each { |k,v| v.symbolize_keys! }
+      configurations.symbolize_keys!
+      true
+    end
 
-      config = YAML.load_file(file)[@rails_env]
-      unless config
-        carefully_log_error "config for '#{@rails_env}' not found"
-        return
+    def used_unique_api_keys
+      keys = configurations.each_value.map { |config| config[:api_key] }.compact
+      if keys.uniq.count < keys.count
+        carefully_log_error('Duplicate API keys found in appsignal.yml')
+        false
+      else
+        true
       end
+    end
 
-      DEFAULT_CONFIG.merge(config.symbolize_keys)
+    def current_environment_present
+      return true if configurations[env].present?
+      carefully_log_error "config for '#{env}' not found"
+      false
     end
 
   end

data/lib/appsignal/railtie.rb

@@ -1,10 +1,14 @@
 module Appsignal
   class Railtie < Rails::Railtie
     initializer "appsignal.configure_rails_initialization" do |app|
-      Appsignal.logger = Logger.new(Rails.root.join('log/appsignal.log')).tap do |l|
-        l.level = Logger::INFO
+      # Some apps when run from the console do not have Rails.root set, there's
+      # currently no way to spec this.
+      if Rails.root
+        Appsignal.logger = Logger.new(Rails.root.join('log/appsignal.log')).tap do |l|
+          l.level = Logger::INFO
+        end
+        Appsignal.flush_in_memory_log
       end
-      Appsignal.flush_in_memory_log
 
       if Appsignal.active?
         app.middleware.

data/lib/appsignal/version.rb

@@ -1,3 +1,3 @@
 module Appsignal
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
 end

data/spec/appsignal/auth_check_spec.rb

@@ -5,7 +5,7 @@ describe Appsignal::AuthCheck do
   before do
     @transmitter = mock
     Appsignal::Transmitter.should_receive(:new).
-      with('http://localhost:3000/1', 'auth', 'abc').
+      with('http://localhost:3000/1', 'auth', 'def').
       and_return(@transmitter)
   end
 

data/spec/appsignal/cli_spec.rb

@@ -89,13 +89,15 @@ describe Appsignal::CLI do
     end
   end
 
-  describe "notify_of_deploy" do
+  describe "#notify_of_deploy" do
     it "should validate that all options have been supplied" do
       options = {}
       cli.should_receive(:validate_required_options).with(
         [:revision, :repository, :user, :environment],
         options
       )
+      Appsignal::Marker.should_receive(:new).
+        and_return(mock(:transmit => true))
       cli.notify_of_deploy(options)
     end
 
@@ -104,7 +106,7 @@ describe Appsignal::CLI do
       Appsignal::Transmitter.should_receive(:new).with(
         'http://localhost:3000/1',
         'markers',
-        'abc'
+        'def'
       ).and_return(transmitter)
       transmitter.should_receive(:transmit).with(
         :revision => 'aaaaa',

data/spec/appsignal/config_spec.rb

@@ -2,63 +2,114 @@ require 'spec_helper'
 
 describe Appsignal::Config do
   let(:logger_parameter) { [] }
-  subject { Appsignal::Config.new(Dir.pwd, 'test', *logger_parameter).load }
-
-  it {
-    should == {
-      :ignore_exceptions => [],
-      :endpoint => 'http://localhost:3000/1',
-      :slow_request_threshold => 200,
-      :api_key => 'abc',
-      :active => true
+  let(:path) { Dir.pwd }
+  let(:config) { Appsignal::Config.new(path, 'test', *logger_parameter) }
+
+  describe "#load" do
+    subject { config.load }
+
+    it "should never have logged an error" do
+      Appsignal.logger.should_not_receive(:error)
+      subject
+    end
+
+    it {
+      should == {
+        :ignore_exceptions => [],
+        :endpoint => 'http://localhost:3000/1',
+        :slow_request_threshold => 200,
+        :api_key => 'ghi',
+        :active => true
+      }
     }
-  }
 
-  context 'when there is no config file' do
-    before { Dir.stub(:pwd => '/not/existing') }
+    context 'when there is no config file' do
+      before { Dir.stub(:pwd => '/not/existing') }
 
-    it "should log error" do
-      Appsignal.logger.should_receive(:error).with(
-        "config not found at:"\
-        " /not/existing/config/appsignal.yml"
-      )
+      it { should be_nil }
     end
 
-    context "when the logger has no #error method" do
-      let(:logger) { mock(:logger) }
-      let(:logger_parameter) { [logger] }
+    context "the env is not in the config" do
+      before { config.stub(:current_environment_present => false) }
 
-      it "should log the error using #important" do
-        logger.should_receive(:important).with(
-          "config not found at:"\
-          " /not/existing/config/appsignal.yml"
-        )
-      end
+      it { should be_nil }
     end
 
-    after { subject }
+    context "when an api key is used for more then one environment" do
+      before { config.stub(:used_unique_api_keys => false) }
+
+      it { should be_nil }
+    end
   end
 
-  context "the env is not in the config" do
-    subject { Appsignal::Config.new(Dir.pwd, 'staging', *logger_parameter).load }
+  # protected
 
-    it "should generate error" do
-      Appsignal.logger.should_receive(:error).with(
-        "config for 'staging' not found"
-      )
+  describe "#load_configurations_from_disk" do
+    subject do
+      config.send(:load_configurations_from_disk)
+      config.configurations
     end
 
-    context "when the logger has no #error method" do
-      let(:logger) { mock(:logger) }
-      let(:logger_parameter) { [logger] }
+    context "when the file is present" do
+      before { config.should_not_receive(:carefully_log_error) }
 
-      it "should log the error using #important" do
-        logger.should_receive(:important).with(
-          "config for 'staging' not found"
-        )
+      it { should_not be_empty }
+    end
+
+    context "when the file is not present" do
+      before do
+        config.should_receive(:carefully_log_error)
+        config.stub(:project_path => '/non/existing')
       end
+
+      it { should be_empty }
     end
+  end
+
+  describe "#used_unique_api_keys" do
+    let(:env) { {:api_key => :foo} }
+    subject { config.send(:used_unique_api_keys) }
 
-    after { subject }
+    context "when using all unique keys" do
+      before do
+        config.should_not_receive(:carefully_log_error)
+        config.stub(:configurations => {1 => env})
+      end
+
+      it { should be_true }
+    end
+
+    context "when using non-unique keys" do
+      before do
+        config.should_receive(:carefully_log_error).
+          with("Duplicate API keys found in appsignal.yml")
+        config.stub(:configurations => {:production => env, :staging => env})
+      end
+
+      it { should be_false }
+    end
+  end
+
+  describe "#current_environment_present" do
+    subject { config.send(:current_environment_present) }
+
+    context "when the current environment is present" do
+      before do
+        config.should_not_receive(:carefully_log_error)
+        config.stub(:configurations => {:test => :foo})
+      end
+
+      it { should be_true }
+    end
+
+    context "when the current environment is absent" do
+      before do
+        config.should_receive(:carefully_log_error).
+          with("config for 'test' not found")
+        config.stub(:configurations => {})
+      end
+
+      it { should be_false }
+    end
   end
 end

data/spec/support/helpers/notification_helpers.rb

@@ -1,11 +1,10 @@
 module NotificationHelpers
 
   def notification_event(args={})
-    time = Time.parse('01-01-2001 10:01:00')
     args = {
       :name => 'process_action.action_controller',
-      :start => time,
-      :ending => time + 0.100,
+      :start => fixed_time,
+      :ending => fixed_time + 0.1,
       :tid => '1',
       :payload => create_payload
     }.merge(args)

data/spec/support/helpers/transaction_helpers.rb

@@ -1,5 +1,9 @@
 module TransactionHelpers
 
+  def fixed_time
+    @fixed_time ||= Time.at(978364860.0)
+  end
+
   def transaction_with_exception
     appsignal_transaction.tap do |o|
       begin
@@ -18,24 +22,22 @@ module TransactionHelpers
   end
 
   def slow_transaction(args={})
-    time = Time.parse('01-01-2001 10:01:00')
     appsignal_transaction(
       {
         :process_action_event => notification_event(
-          :start => time,
-          :ending => time + Appsignal.config[:slow_request_threshold] / 1000.0
+          :start => fixed_time,
+          :ending => fixed_time + Appsignal.config[:slow_request_threshold] / 1000.0
         )
       }.merge(args)
     )
   end
 
   def slower_transaction(args={})
-    time = Time.parse('01-01-2001 10:01:00')
     appsignal_transaction(
       {
         :process_action_event => notification_event(
-          :start => time,
-          :ending => time + Appsignal.config[:slow_request_threshold] / 500.0
+          :start => fixed_time,
+          :ending => fixed_time + Appsignal.config[:slow_request_threshold] / 500.0
         )
       }.merge(args)
     )

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 0.5.0
   prerelease: 
+  version: 0.5.1
 platform: ruby
 authors:
 - Robert Beekman
@@ -13,120 +13,120 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-12 00:00:00.000000000 Z
+date: 2013-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
     none: false
+  prerelease: false
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
+    none: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
   type: :runtime
-  prerelease: false
+- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
+    none: false
+  prerelease: false
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
   type: :runtime
-  prerelease: false
+- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
+    none: false
+  prerelease: false
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
   type: :development
-  prerelease: false
+- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
+    none: false
+  prerelease: false
   name: capistrano
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
   type: :development
-  prerelease: false
+- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
+    none: false
+  prerelease: false
   name: generator_spec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
   type: :development
-  prerelease: false
+- !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
+    none: false
+  prerelease: false
   name: pry
   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'
+  type: :development
 description: The official appsignal.com gem
 email:
 - contact@appsignal.com
@@ -212,20 +212,26 @@ rdoc_options: []
 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
+      segments:
+      - 0
+      hash: -3609057050199006546
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3609057050199006546
+  none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Logs performance and exception data from your app toappsignal.com