apphunk 0.1.1 → 0.3.0

data/doc/panel/search_index.js

@@ -0,0 +1 @@
+var search_data = {"index":{"searchIndex":["apphunk","config","logger","proxy","remote","result","config()","error()","log()","log_with_options()","new()","post()","prepare_payload()","process_response()","send_message_to_apphunkd()","license","readme.rdoc","apphunk.rb","config.rb","logger.rb","proxy.rb","remote.rb","result.rb"],"longSearchIndex":["lib/apphunk.rb","apphunk","apphunk","apphunk","apphunk","apphunk::remote","apphunk","apphunk::logger","apphunk","apphunk","apphunk::remote::result","apphunk::remote","apphunk::proxy","apphunk::proxy","apphunk::proxy","files/license.html","files/readme_rdoc.html","files/lib/apphunk_rb.html","files/lib/apphunk/config_rb.html","files/lib/apphunk/logger_rb.html","files/lib/apphunk/proxy_rb.html","files/lib/apphunk/remote_rb.html","files/lib/apphunk/remote/result_rb.html"],"info":[["Apphunk","lib/apphunk.rb","classes/Apphunk.html"," < ","",1],["Config","Apphunk","classes/Apphunk/Config.html"," < ","Used to configure the behaviour of Apphunk and its outgoing messages. Each option can be overriden by",1],["Logger","Apphunk","classes/Apphunk/Logger.html"," < ","",1],["Proxy","Apphunk","classes/Apphunk/Proxy.html"," < ","",1],["Remote","Apphunk","classes/Apphunk/Remote.html"," < ","",1],["Result","Apphunk::Remote","classes/Apphunk/Remote/Result.html"," < Object","",1],["config","Apphunk","classes/Apphunk.html#M000008","(&block)","Set runtime configuration options Yields Apphunk::Config which can be used to set configuration options",2],["error","Apphunk::Logger","classes/Apphunk/Logger.html#M000000","(message)","",2],["log","Apphunk","classes/Apphunk.html#M000006","(message, options = {})","Sends a +message+ to your remote inbox at apphunk.com * <tt>message</tt> - The body of the message *",2],["log_with_options","Apphunk","classes/Apphunk.html#M000007","(options = {}, &block)","Send messages with predefined options in a block Yields the Apphunk module which can be used to send",2],["new","Apphunk::Remote::Result","classes/Apphunk/Remote/Result.html#M000004","(opts = {})","",2],["post","Apphunk::Remote","classes/Apphunk/Remote.html#M000005","(url, payload = {}, post_timeout = 30)","",2],["prepare_payload","Apphunk::Proxy","classes/Apphunk/Proxy.html#M000002","(message, options)","",2],["process_response","Apphunk::Proxy","classes/Apphunk/Proxy.html#M000003","(result)","",2],["send_message_to_apphunkd","Apphunk::Proxy","classes/Apphunk/Proxy.html#M000001","(message, options)","",2],["LICENSE","files/LICENSE.html","files/LICENSE.html","","Copyright (c) 2009 Andreas Wolff  Permission is hereby granted, free of charge, to any person obtaining",3],["README.rdoc","files/README_rdoc.html","files/README_rdoc.html","","= apphunk  A library that send's messages to the remote logging service apphunk.com.   == Note on Patches/Pull",3],["apphunk.rb","files/lib/apphunk_rb.html","files/lib/apphunk_rb.html","","",3],["config.rb","files/lib/apphunk/config_rb.html","files/lib/apphunk/config_rb.html","","",3],["logger.rb","files/lib/apphunk/logger_rb.html","files/lib/apphunk/logger_rb.html","","",3],["proxy.rb","files/lib/apphunk/proxy_rb.html","files/lib/apphunk/proxy_rb.html","","",3],["remote.rb","files/lib/apphunk/remote_rb.html","files/lib/apphunk/remote_rb.html","","",3],["result.rb","files/lib/apphunk/remote/result_rb.html","files/lib/apphunk/remote/result_rb.html","","",3]]}}

data/doc/panel/tree.js

@@ -0,0 +1 @@
+var tree = [["","","files",[["LICENSE","files/LICENSE.html","",[]],["README.rdoc","files/README_rdoc.html","",[]],["","","lib",[["","","apphunk",[["config.rb","files/lib/apphunk/config_rb.html","",[]],["logger.rb","files/lib/apphunk/logger_rb.html","",[]],["proxy.rb","files/lib/apphunk/proxy_rb.html","",[]],["","","remote",[["result.rb","files/lib/apphunk/remote/result_rb.html","",[]]]],["remote.rb","files/lib/apphunk/remote_rb.html","",[]]]],["apphunk.rb","files/lib/apphunk_rb.html","",[]]]]]],["Apphunk","classes/Apphunk.html","",[["Config","classes/Apphunk/Config.html","",[]],["Logger","classes/Apphunk/Logger.html","",[]],["Proxy","classes/Apphunk/Proxy.html","",[]],["Remote","classes/Apphunk/Remote.html","",[["Result","classes/Apphunk/Remote/Result.html"," < Object",[]]]]]]]

data/lib/apphunk/config.rb

@@ -0,0 +1,54 @@
+module Apphunk
+  
+  # Used to configure the behaviour of Apphunk and its outgoing messages. Each option can be overriden by Apphunk.log's +option+ parameter.
+  # If Apphunk is used as part of a Rails application, the configuration should go to +config/initializers/apphunk.rb+.
+  #
+  # *Note*: The configuration must be set using Apphunk.config as shown in the example below.
+  #
+  # ==== Example
+  #  Apphunk.config do |config|
+  #    config.token = "secret_project_token"
+  #  end
+  #
+  module Config
+    class << self
+      
+      # The current environment. Automatically retrieved if Apphunk is running as part of a Rails app.
+      #
+      # ==== Example
+      #  config.environment = 'production'
+      #
+      attr_accessor :environment
+      
+      # A list of allowed environments. Apphunk will only send messages if Apphunk::Config.environment is part of these allowed environments.
+      # *Note*: This step is skipped if Apphunk::Config.environment is +empty+.
+      #
+      # ==== Example
+      #  config.environments = %w(production staging)
+      #
+      attr_accessor :environments
+
+      # A list of tags to be send with each message.
+      #
+      # ==== Example
+      #  config.tags = 'each, message, will, get, these, tags'
+      #      
+      attr_accessor :tags
+
+      # The token as provided by apphunk.com. Used to authenticate a message request.
+      #
+      # ==== Example
+      #  config.token = 'secrect_project_token'
+      #      
+      attr_accessor :token
+
+      # A list of trails to be send with each message.
+      #
+      # ==== Example
+      #  config.trails = { :product => 'Car', :country => 'Germany' }
+      #      
+      attr_accessor :trails
+
+    end
+  end
+end

data/lib/apphunk/logger.rb

@@ -1,11 +1,19 @@
 module Apphunk
   module Logger
     class << self
-      
+
       def error(message)
-        puts "[Apphunk] Error: #{message}"
+        message = "[Apphunk] Error: #{message}"
+        case
+          when Rails && Rails.logger
+            Rails.logger.error(message)
+          when RAILS_DEFAULT_LOGGER
+            RAILS_DEFAULT_LOGGER.error(message)
+          else
+            puts(message)
+        end
       end
-      
+
     end
   end
-end
+end

data/lib/apphunk/proxy.rb

@@ -8,6 +8,10 @@ module Apphunk
       PROXY_API_URL = "http://127.0.0.1:8212/api/messages"
       
       def send_message_to_apphunkd(message, options)
+        if options[:environments] && options[:environment] && !options[:environments].include?(options[:environment])
+          return false
+        end
+        
         payload = prepare_payload(message, options)
         result = Apphunk::Remote.post(PROXY_API_URL, payload, 3)
         return process_response(result)
@@ -28,11 +32,11 @@ module Apphunk
           if result.response.code == '201'
             return true
           else
-            Apphunk::Logger.error "The Apphunkd Proxy couldn't store the message: #{result.response.code} / #{result.response.body}"
+            Apphunk::Logger.error "The Apphunkd-Proxy couldn't store the message: #{result.response.code} / #{result.response.body}"
             return false
           end
         else
-          Apphunk::Logger.error "Connection Error: Could not get a response from Apphunkd in time"
+          Apphunk::Logger.error "Connection Error: Could not get a response from local Apphunkd-Proxy in time"
           return false
         end
       end

data/lib/apphunk.rb

@@ -2,19 +2,50 @@ require 'rubygems'
 
 module Apphunk
   
+  autoload :Config, 'apphunk/config'
   autoload :Logger, 'apphunk/logger'
   autoload :Proxy,  'apphunk/proxy'
   autoload :Remote, 'apphunk/remote'
   
   class << self
 
+    # Default options to be used for Apphunk.log. Initialized by Apphunk::Config.
     attr_accessor :default_options
     
+    # Sends a +message+ to your remote inbox at apphunk.com
+    # 
+    # * <tt>message</tt> - The body of the message
+    # * <tt>options</tt> - A hash of options. Merges with Apphunk.default_options
+    #
+    # For a list of available options see Apphunk::Config.
+    #
+    # ==== Examples  
+    #   
+    #  Apphunk.log("Yet another hello world")
+    #  Apphunk.log("Tag me baby", :tags => 'apphunk, doc, examples', :trails => { :user_id => 5 })
+    #  Apphunk.log("I'm on my way to a different project", :token => 'secret_project_access_token')
+    #
     def log(message, options = {})
       options = (self.default_options || {}).merge(options)
       Apphunk::Proxy.send_message_to_apphunkd(message, options)
     end
     
+    # Send messages with predefined options in a block
+    #
+    # Yields the Apphunk module which can be used to send messages via Apphunk.log,
+    # but temporarily merges the provided +options+ with Apphunk.default_options.
+    # Can be used to send a bunch of messages with the same options.
+    #
+    # * <tt>options</tt> - A hash of options. Merges with Apphunk.default_options
+    #
+    # For a list of available options see Apphunk::Config.
+    #
+    # ==== Examples  
+    #  Apphunk.log_with_options(:tags => 'hello world') do |apphunk|
+    #    apphunk.log("A messages with tags")
+    #    apphunk.log("Another messages with the same tags")
+    #  end
+    #
     def log_with_options(options = {}, &block)
       preserved_defaults = self.default_options
       self.default_options = (self.default_options || {}).merge(options)
@@ -22,5 +53,31 @@ module Apphunk
       self.default_options = preserved_defaults
     end
     
+    # Set runtime configuration options
+    #
+    # Yields Apphunk::Config which can be used to set configuration options in one place.
+    # See Apphunk::Config for a list of available options. These options will be available in Apphunk.default_options.
+    #
+    # ==== Examples
+    #
+    #  Apphunk.config do |config|
+    #    config.token = "secret_project_token"
+    #    config.environments = %w(staging production)
+    #  end
+    #
+    def config(&block)
+      yield Apphunk::Config
+      self.default_options[:tags] = Apphunk::Config.tags
+      self.default_options[:token] = Apphunk::Config.token
+      self.default_options[:trails] = Apphunk::Config.trails
+      self.default_options[:environments] = Apphunk::Config.environments
+      
+      if Apphunk::Config.environment.blank?
+        Apphunk::Config.environment = self.default_options[:environment]
+      else
+        self.default_options[:environment] = Apphunk::Config.environment 
+      end
+    end
+    
   end
 end

data/rails/init.rb

@@ -0,0 +1,3 @@
+# Init Apphunk Rails Support
+# Set the default environment to current Rails.env
+Apphunk.default_options = { :environment => RAILS_ENV || Rails.env }

data/spec/apphunk/proxy_spec.rb

@@ -13,6 +13,12 @@ describe Apphunk::Proxy do
       Apphunk::Proxy.send_message_to_apphunkd("My Message", @opts)
     end
     
+    it "should return false if options include allowed environments and the current environment isn't included in that list" do
+      @opts[:environments] = ['production', 'staging']
+      @opts[:environment] = 'development'
+      Apphunk::Proxy.send_message_to_apphunkd("My Message", @opts).should be_false
+    end
+    
     context 'posting' do
       before(:each) do
         @payload = { "prepared" => "payload" }
@@ -66,15 +72,15 @@ describe Apphunk::Proxy do
     
     it 'should create an OpenStruct, containing the message and extracted options' do
       payload = Apphunk::Proxy.prepare_payload("My Message", @opts)
-      payload.message.should == "My Message"
-      payload.token.should == "secret"
-      payload.environment.should == "development"
-      payload.tags.should == "test"
+      payload[:message].should == "My Message"
+      payload[:token].should == "secret"
+      payload[:environment].should == "development"
+      payload[:tags].should == "test"
     end
     
     it 'should render the trails to json' do
       payload = Apphunk::Proxy.prepare_payload("My Message", @opts)
-      payload.trails.should == "{\"user\":\"5\"}"
+      payload[:trails].should == "{\"user\":\"5\"}"
     end
   end  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: apphunk
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors: 
 - Andreas Wolff
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-20 00:00:00 +01:00
+date: 2009-11-27 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -61,7 +61,39 @@ files:
 - TODO.rdoc
 - VERSION
 - apphunk.gemspec
+- doc/apple-touch-icon.png
+- doc/classes/Apphunk.html
+- doc/classes/Apphunk/Config.html
+- doc/classes/Apphunk/Logger.html
+- doc/classes/Apphunk/Proxy.html
+- doc/classes/Apphunk/Remote.html
+- doc/classes/Apphunk/Remote/Result.html
+- doc/created.rid
+- doc/css/main.css
+- doc/css/panel.css
+- doc/css/reset.css
+- doc/favicon.ico
+- doc/files/LICENSE.html
+- doc/files/README_rdoc.html
+- doc/files/lib/apphunk/config_rb.html
+- doc/files/lib/apphunk/logger_rb.html
+- doc/files/lib/apphunk/proxy_rb.html
+- doc/files/lib/apphunk/remote/result_rb.html
+- doc/files/lib/apphunk/remote_rb.html
+- doc/files/lib/apphunk_rb.html
+- doc/i/arrows.png
+- doc/i/results_bg.png
+- doc/i/tree_bg.png
+- doc/index.html
+- doc/js/jquery-1.3.2.min.js
+- doc/js/jquery-effect.js
+- doc/js/main.js
+- doc/js/searchdoc.js
+- doc/panel/index.html
+- doc/panel/search_index.js
+- doc/panel/tree.js
 - lib/apphunk.rb
+- lib/apphunk/config.rb
 - lib/apphunk/logger.rb
 - lib/apphunk/proxy.rb
 - lib/apphunk/remote.rb
@@ -98,7 +130,7 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: A library to send messages to Apphunk.com
+summary: A library that send's messages to Apphunk.com
 test_files: 
 - spec/apphunk/proxy_spec.rb
 - spec/apphunk_spec.rb