papermill-agent 0.0.2 → 0.1.0

data/Gemfile

@@ -1,6 +1,6 @@
 source 'http://rubygems.org'
 
-gem 'rest-client', '~>1.6.1'
+gemspec
 
 group :test do
   gem 'fakeweb',  '>=1.3.0'

data/README.md

@@ -3,16 +3,40 @@ WARNING: This is pre-alpha software. Use at your own risk until 1.0.
 
 The papermill agent parses responses from your web application.
 
-## Usage Instructions
+# Installation #
 
-Papermill works via a middleware called the Collector. 
+## Step 1: Create config/papermill.yml ##
 
-#### In Rails
+Papermill's configuration information is stored in a yml file located at 
+`[PROJECT_ROOT]/config/papermill.yml`. The only required configuration
+option is your api token:
+
+    # config/papermill.yml
+    token: you-api-token
+    
+## Step 2: include the middleware layer for request capturing and logging ##
+
+Papermill works by capturing every request submitted to your application and 
+periodically sending them off to the PapermillApp servers. To enable this,
+you must add the Papermill middleware class to your application's middleware
+stack.
+
+In rails, this is done in either `config/environment.rb` or `config/application.rb`,
+depending on whether you're using rails 2 or rails 3. In a sinatra or rack app,
+you simply add the middleware via rack's `use` method.
+
+See the examples below.
+
+### rails 2.x ###
     # in config/environment.rb
     config.middleware.use 'Papermill::Collector'
 
-#### In Sinatra/rack
-    # in config.ru
+### rails 3 ###
+    # in config/application.rb
+    config.middleware.use 'Papermill::Collector'
+
+### sinatra or a rack application ###
+    # in config.ru or in a Rack::Builder stack
     use Papermill::Collector
 
 

data/lib/papermill-agent.rb

@@ -3,7 +3,7 @@ $:.unshift File.dirname(File.expand_path(__FILE__))
 
 module Papermill
   # papermill endpoint which will receive client requests
-  API_ENDPOINT = 'http://api.papermillapp.com'
+  API_ENDPOINT = 'http://papermillapp.com/api'
 
   autoload :Agent,          'papermill-agent/agent'
   autoload :Collector,      'papermill-agent/rack/collector'

data/lib/papermill-agent/agent.rb

@@ -12,6 +12,7 @@ module Papermill
     UPDATE_INTERVAL = 10
 
     attr_reader :last_sent, :mutex, :config, :logger
+    attr_accessor :disabled
 
     # request timeout threshold for sending data to papermill
     @@request_timeout = 5
@@ -19,22 +20,28 @@ module Papermill
       @@request_timeout
     end
 
+    def disabled?
+      !!disabled
+    end
+
     def start
       @last_sent = Time.now
       @mutex     = Mutex.new
-      @config    = Configurator.new
       @logger    = Logger.new
+      @config    = Configurator.new
       logger.info "\n\n=============== Starting papermill-agent at #{Time.now} in process #{Process.pid}"
       Thread.abort_on_exception = true
 
-      @worker_thread = Thread.new do
-        loop do
-          if time_since_last_sent > UPDATE_INTERVAL
-            send_data_to_papermill
-            @last_sent = Time.now
+      unless disabled?
+        @worker_thread = Thread.new do
+          loop do
+            if time_since_last_sent > UPDATE_INTERVAL
+              send_data_to_papermill
+              @last_sent = Time.now
+            end
+            sleep_time = seconds_until_next_run
+            sleep sleep_time if sleep_time > 0
           end
-          sleep_time = seconds_until_next_run
-          sleep sleep_time if sleep_time > 0
         end
       end
     end

data/lib/papermill-agent/configurator.rb

@@ -7,19 +7,33 @@ module Papermill
 
     def initialize(config_source = 'config/papermill.yml')
       load_config(config_source)
+      after_init
     end
 
+    # Loads the papermill configuration.
+    #
+    # By default, the papermill configuration is read from a yaml file located
+    # at ./config/papermill.yml. Still, the configuration source can either be
+    # a yaml file of any name or a ruby hash.
+    #
+    # If the configuration file cannot be found, the agent will be disabled.
     def load_config(config_source)
       @config = case
       when config_source.class == String
-        YAML.load_file(config_source)
+        begin
+          YAML.load_file(config_source)
+        rescue Errno::ENOENT => e
+          disable_agent
+          Agent.instance.logger.info "The papermill configuration file does not exist. The papermill agent is disabled."
+          return nil
+        end
       when config_source.class == Hash
         config_source
       end
     end
 
     def token
-      config['token']
+      (config && config.has_key?('token')) ? config['token'] : nil
     end
 
     def endpoint
@@ -50,6 +64,16 @@ module Papermill
     end
 
     private
+    # If there is no token, disable the agent.
+    def after_init
+      if token.nil?
+        disable_agent
+      end
+    end
+
+    def disable_agent
+      Agent.instance.disabled = true
+    end
 
     # holds the internal config hash
     def config

data/lib/papermill-agent/logger.rb

@@ -3,7 +3,7 @@ require 'logger'
 module Papermill
   class Logger < ::Logger
     def initialize(io_object = 'log/papermill.log')
-      FileUtils.mkdir('log') unless Dir.exists?('log')
+      FileUtils.mkdir('log') unless File.exists?('log')
       super(io_object)
     end
 

data/lib/papermill-agent/rack/collector.rb

@@ -4,6 +4,7 @@ module Papermill
   # The Collector class is the middleware component of papermill.
   # To use it with a rails app, you must add the following to
   # your environment.rb file:
+  #
   # config.middleware.use Papermill::Collector
   class Collector
     def initialize(app)

data/lib/papermill-agent/railtie.rb

@@ -0,0 +1,14 @@
+require 'papermill-agent'
+require 'rails'
+
+module Papermill
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      require 'papermill-agent/tasks'
+    end
+
+    # initializer "..." do |app|
+    #   app.config.middleware.use "Papermill::Collector"
+    # end
+  end
+end

data/lib/papermill-agent/response_adapters/base.rb

@@ -30,11 +30,15 @@ module Papermill
       end
 
       def extract_env_info
-        result_hash = env.select { |key, value| ENV_CAPTURE_FIELDS.include?(key) }
+        result_hash = {}
+
+        # Hash#select returns an array in 1.8, so we have to do some manual
+        # iteration to extract the key/value pairs from the environment hash.
+        ENV_CAPTURE_FIELDS.each { |key| result_hash[key] = env[key] }
 
         # rename rack.* keys b/c mongo does not allow key names containing a .
-        rack_keys = ENV_CAPTURE_FIELDS.select { |key| key =~ /^rack\./ }
-        rack_keys.each do |key|
+        naughty_rack_keys = ENV_CAPTURE_FIELDS.select { |key| key =~ /^rack\./ }
+        naughty_rack_keys.each do |key|
           new_key = key.gsub(/^rack\./, '').upcase
           result_hash[new_key] = result_hash.delete(key)
         end

data/lib/papermill-agent/tasks.rb

@@ -0,0 +1,21 @@
+require 'papermill-agent'
+
+namespace :papermill do
+  desc "Generate a papermill configuration file"
+  task :create_config do
+    require 'yaml'
+
+    # don't overwrite existing configuration files
+    if File.exists?('./config/papermil.yml')
+      fail("A papermill configuration file already exists. Please remove it and try again.")
+    end
+
+    token = ENV['TOKEN'] || 'replace-with-your-token'
+
+    File.open('./config/papermill.yml', 'w') do |file|
+      config = {'token' => token}
+      YAML.dump(config, file)
+    end
+    STDOUT.puts "Your papermill configuration file has been created at config/papermill.yml."
+  end
+end

data/spec/agent_spec.rb

@@ -147,7 +147,7 @@ module Papermill
 
   describe 'the api endpoint' do
     subject { Papermill::API_ENDPOINT }
-    it { should == 'http://api.papermillapp.com' }
+    it { should == 'http://papermillapp.com/api' }
   end
 
   describe 'request timeout interval' do
@@ -188,7 +188,7 @@ module Papermill
 
     describe 'serializing the payload' do
       it 'jsonifies the payload data' do
-        agent.jsonify_payload.should == '[{"headers":{"Content-Type":"text/html"},"status":200}]'
+        agent.jsonify_payload.should == Storage.store.flatten.to_json
       end
     end
 
@@ -201,7 +201,7 @@ module Papermill
       end
 
       it 'sends a request to the papermill api endpoint' do
-        RestClient.should_receive(:post).with(Papermill::API_ENDPOINT, :token => 'api-key', :payload => '[{"headers":{"Content-Type":"text/html"},"status":200}]')
+        RestClient.should_receive(:post).with(Papermill::API_ENDPOINT, :token => 'api-key', :payload => Storage.store.flatten.to_json)
         agent.send_data_to_papermill
       end
 
@@ -234,5 +234,30 @@ module Papermill
     end
   end
 
+  describe 'disabling the papermill agent' do
+    context 'when disabled is set to true' do
+      before { agent.disabled = true  }
+      after  { agent.disabled = false }
+
+      it 'is disabled' do
+        agent.should be_disabled
+      end
+    end
+
+    context 'wen disabled is set to false' do
+      before { agent.disabled = false }
+
+      it 'is disabled' do
+        agent.should_not be_disabled
+      end
+    end
+
+    context 'by default' do
+      it 'is not disabled' do
+        agent.should_not be_disabled
+      end
+    end
+  end
+
 end
 

data/spec/configurator_spec.rb

@@ -8,6 +8,35 @@ module Papermill
         YAML.should_receive(:load_file).with('filename')
         Configurator.new('filename')
       end
+
+      context 'the config file does not exist' do
+        after { agent.disabled = false }
+
+        it 'disables the agent' do
+          lambda {
+            Configurator.new('does not exist')
+          }.should change(agent, :disabled?).to(true)
+        end
+
+        it 'does not raise a file load error' do
+          lambda {
+            Configurator.new('does not exist')
+          }.should_not raise_error(Errno::ENOENT)
+        end
+
+        it 'sets config to nil' do
+          config = Configurator.new('does not exist')
+          config.send(:config).should be_nil
+        end
+      end
+
+      context 'when no token key is found' do
+        it 'disables the agent' do
+          lambda {
+            Configurator.new({})
+          }.should change(agent, :disabled?).to(true)
+        end
+      end
     end
 
     context 'when a hash is passed in' do
@@ -22,14 +51,19 @@ module Papermill
   end
 
   describe 'given a configurator instance' do
-    let(:configurator) do
-      YAML.stub!(:load_file).and_return({'token' => 'token'})
-      Configurator.new 
-    end
-
     describe 'the token' do
-      it 'should return the token from the config' do
-        configurator.token.should == 'token'
+      subject { config.token }
+
+      context 'when the token exists' do
+        let(:config) { Configurator.new({'token' => 'token'}) }
+
+        it { should == 'token' }
+      end
+
+      context 'when the token does not exist' do
+        let(:config) { Configurator.new({}) }
+
+        it { should be_nil }
       end
     end
 
@@ -159,8 +193,9 @@ module Papermill
   end
 
   describe 'retrieving a setting for the current environment' do
+    let(:config) { Configurator.new({'production' => {'my key' => 'my val'}}) }
+
     context 'for a given environment' do
-      let(:config) { Configurator.new({'production' => {'my key' => 'my val'}}) }
       before { config.environment = 'production' }
 
       context 'for a setting that has a value' do
@@ -172,9 +207,31 @@ module Papermill
       context 'for a setting that does not have a value' do
         it 'returns nil' do
           config.setting('does not exist').should == nil
+          config.setting('does not exist').should === nil
+          config.setting('does not exist').should be_instance_of NilClass
+        end
+
+        it 'does not return false' do
+          config.setting('does not exist').should_not === false
+          config.setting('does not exist').should_not == false
+          config.setting('does not exist').should_not === FalseClass
+          config.setting('does not exist').should_not be_instance_of FalseClass
         end
       end
     end
 
+    context 'when trying to access a property with no environment' do
+      before { config.environment = 'not defined' }
+      subject { config.setting('does not exist') } 
+
+      it 'should not return false' do
+        subject.should_not == false
+      end
+
+      it 'should return nil' do
+        subject.should == nil
+      end
+    end
+
   end
 end

data/spec/response_parser_spec.rb

@@ -14,14 +14,12 @@ module Papermill
     end
 
     context 'in a rails app' do
-      before do
-        # self.class.module_eval { remove_const(:Sinatra) if defined?(Sinatra) }
+      class Rails
       end
 
       it 'uses the rails adapter' do
-      class Rails
-      end
-        ResponseParser.parse_klass.should == ResponseAdapters::Rails
+        ResponseAdapters::Rails.should_receive(:new).and_return(mock('object', :parse => nil))
+        ResponseParser.parse(200, {}, [], {})
       end
     end
   end

data/spec/spec_helper.rb

@@ -28,4 +28,8 @@ RSpec.configure do |config|
     # clear the storage before each example
     Papermill::Storage.clear
   end
+
+  config.after(:each) do
+    agent.disabled = false
+  end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 2
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - Alex Sharp
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-02 00:00:00 -06:00
+date: 2011-01-07 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,6 +32,19 @@ dependencies:
         version: 1.6.1
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json_pure
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
 description: The client agent for papermillapp.com
 email: 
 - ajsharp@gmail.com
@@ -47,11 +60,13 @@ files:
 - lib/papermill-agent/configurator.rb
 - lib/papermill-agent/logger.rb
 - lib/papermill-agent/rack/collector.rb
+- lib/papermill-agent/railtie.rb
 - lib/papermill-agent/response_adapters/base.rb
 - lib/papermill-agent/response_adapters/rails.rb
 - lib/papermill-agent/response_adapters/sinatra.rb
 - lib/papermill-agent/response_parser.rb
 - lib/papermill-agent/storage.rb
+- lib/papermill-agent/tasks.rb
 - lib/papermill-agent.rb
 - LICENSE
 - README.md