apphunk 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Andreas Wolff
+
+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/README.rdoc

@@ -0,0 +1,17 @@
+= apphunk
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 rubyphunk. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,71 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "apphunk"
+    gem.summary = %Q{A library to send messages to Apphunk.com}
+    gem.description = %Q{Apphunk is a library that allows your applications (currently only Ruby AND Rails) to send messages to Apphunk.com}
+    gem.email = "andreas@apphunk.com"
+    gem.homepage = "http://apphunk.com"
+    gem.authors = ["Andreas Wolff"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    gem.add_dependency "json"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'reek/adapters/rake_task'
+  Reek::RakeTask.new do |t|
+    t.fail_on_error = true
+    t.verbose = false
+    t.source_files = 'lib/**/*.rb'
+  end
+rescue LoadError
+  task :reek do
+    abort "Reek is not available. In order to run reek, you must: sudo gem install reek"
+  end
+end
+
+begin
+  require 'roodi'
+  require 'roodi_task'
+  RoodiTask.new do |t|
+    t.verbose = false
+  end
+rescue LoadError
+  task :roodi do
+    abort "Roodi is not available. In order to run roodi, you must: sudo gem install roodi"
+  end
+end
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/apphunk.gemspec

@@ -0,0 +1,70 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{apphunk}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andreas Wolff"]
+  s.date = %q{2009-11-20}
+  s.description = %q{Apphunk is a library that allows your applications (currently only Ruby AND Rails) to send messages to Apphunk.com}
+  s.email = %q{andreas@apphunk.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "History.rdoc",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "TODO.rdoc",
+     "VERSION",
+     "apphunk.gemspec",
+     "lib/apphunk.rb",
+     "lib/apphunk/logger.rb",
+     "lib/apphunk/proxy.rb",
+     "lib/apphunk/remote.rb",
+     "lib/apphunk/remote/result.rb",
+     "rails/init.rb",
+     "spec/apphunk/proxy_spec.rb",
+     "spec/apphunk_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://apphunk.com}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A library to send messages to Apphunk.com}
+  s.test_files = [
+    "spec/apphunk/proxy_spec.rb",
+     "spec/apphunk_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+  end
+end
+

data/lib/apphunk.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+
+module Apphunk
+  
+  autoload :Logger, 'apphunk/logger'
+  autoload :Proxy,  'apphunk/proxy'
+  autoload :Remote, 'apphunk/remote'
+  
+  class << self
+
+    attr_accessor :default_options
+    
+    def log(message, options = {})
+      options = (self.default_options || {}).merge(options)
+      Apphunk::Proxy.send_message_to_apphunkd(message, options)
+    end
+    
+    def log_with_options(options = {}, &block)
+      preserved_defaults = self.default_options
+      self.default_options = (self.default_options || {}).merge(options)
+      yield self
+      self.default_options = preserved_defaults
+    end
+    
+  end
+end

data/lib/apphunk/logger.rb

@@ -0,0 +1,11 @@
+module Apphunk
+  module Logger
+    class << self
+      
+      def error(message)
+        puts "[Apphunk] Error: #{message}"
+      end
+      
+    end
+  end
+end

data/lib/apphunk/proxy.rb

@@ -0,0 +1,42 @@
+require 'json'
+require 'ostruct'
+
+module Apphunk
+  module Proxy
+    class << self
+      
+      PROXY_API_URL = "http://127.0.0.1:8212/api/messages"
+      
+      def send_message_to_apphunkd(message, options)
+        payload = prepare_payload(message, options)
+        result = Apphunk::Remote.post(PROXY_API_URL, payload, 3)
+        return process_response(result)
+      end
+
+      def prepare_payload(message, options)
+        {
+          :message      => message,
+          :token        => options[:token],
+          :environment  => options[:environment],
+          :tags         => options[:tags],
+          :trails       => (options[:trails].to_json if options[:trails])
+        }
+      end
+      
+      def process_response(result)
+        if result.status == :ok
+          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}"
+            return false
+          end
+        else
+          Apphunk::Logger.error "Connection Error: Could not get a response from Apphunkd in time"
+          return false
+        end
+      end
+      
+    end
+  end
+end

data/lib/apphunk/remote.rb

@@ -0,0 +1,29 @@
+require 'net/http'
+require 'timeout'
+require 'uri'
+
+module Apphunk
+  module Remote
+    
+    autoload :Result, 'apphunk/remote/result'
+    
+    class << self
+      
+      def post(url, payload = {}, post_timeout = 30)
+        begin
+          Timeout.timeout(post_timeout) do
+            uri = URI.parse(url)
+            result = Remote::Result.new(:response => Net::HTTP.post_form(uri, payload))
+            result.status = :ok
+            return result
+          end
+        rescue SocketError, Errno::ECONNREFUSED
+          Remote::Result.new(:status => :connection_error)
+        rescue Timeout::Error
+          Remote::Result.new(:status => :timeout)
+        end
+      end
+      
+    end
+  end
+end

data/lib/apphunk/remote/result.rb

@@ -0,0 +1,15 @@
+module Apphunk
+  module Remote
+    class Result
+      
+      attr_accessor :status
+      attr_accessor :response
+      
+      def initialize(opts = {})
+        self.status = opts.delete(:status)
+        self.response = opts.delete(:response)
+      end
+      
+    end
+  end
+end

data/spec/apphunk/proxy_spec.rb

@@ -0,0 +1,80 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Apphunk::Proxy do
+  describe 'send_message_to_apphunkd_proxy' do
+    before(:each) do
+      @opts = { :tags => 'test', :token => 'secret' }
+      Apphunk::Remote.stub!(:post)
+      Apphunk::Proxy.stub!(:process_response).and_return(true)
+    end
+    
+    it 'should prepare the payload' do
+      Apphunk::Proxy.should_receive(:prepare_payload).with("My Message", @opts)
+      Apphunk::Proxy.send_message_to_apphunkd("My Message", @opts)
+    end
+    
+    context 'posting' do
+      before(:each) do
+        @payload = { "prepared" => "payload" }
+        Apphunk::Proxy.stub!(:prepare_payload).and_return(@payload)
+      end
+      
+      it 'should post the payload to the local Apphunkd api' do
+        Apphunk::Remote.should_receive(:post).with('http://127.0.0.1:8212/api/messages', @payload, anything)
+        Apphunk::Proxy.send_message_to_apphunkd("My Message", @opts)
+      end
+    
+      it 'should allow the post to only take 3 seconds to finish' do
+        Apphunk::Remote.should_receive(:post).with(anything, anything, 3)
+        Apphunk::Proxy.send_message_to_apphunkd("My Message", @opts)
+      end
+    end
+  end
+    
+  describe 'process_response' do
+    before(:each) do
+      @result = Apphunk::Remote::Result.new
+      @result.response = mock('Response')
+      Apphunk::Remote.stub!(:post).and_return(@result)
+    end
+    
+    it 'should return true if the Proxy return 201, created' do
+      @result.status = :ok
+      @result.response.stub!(:code).and_return("201")
+      Apphunk::Proxy.process_response(@result)
+    end
+    
+    it 'should output the failure and return false if the Proxy doesn not return 201' do
+      @result.status = :ok
+      @result.response.stub!(:code).and_return("404")
+      @result.response.stub!(:body).and_return("Not found.")
+      Apphunk::Logger.should_receive(:error).with(/Not found/)
+      Apphunk::Proxy.process_response(@result)
+    end
+    
+    it 'should output the failure and return false if the connection to the proxy failed' do
+      @result.status = :connection_error
+      Apphunk::Logger.should_receive(:error).with(/Connection Error/)
+      Apphunk::Proxy.process_response(@result)
+    end
+  end
+  
+  describe 'prepare_payload' do
+    before(:each) do
+      @opts = { :token => 'secret', :environment => 'development', :tags => 'test', :trails => { :user => '5' } }
+    end
+    
+    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"
+    end
+    
+    it 'should render the trails to json' do
+      payload = Apphunk::Proxy.prepare_payload("My Message", @opts)
+      payload.trails.should == "{\"user\":\"5\"}"
+    end
+  end  
+end

data/spec/apphunk_spec.rb

@@ -0,0 +1,64 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Apphunk" do
+  describe 'log' do
+    it 'should send the message to the apphunkd-proxy' do
+      Apphunk::Proxy.should_receive(:send_message_to_apphunkd).with("My Message", anything)
+      Apphunk.log("My Message")
+    end
+    
+    it 'should bypass all options' do
+      opts = { :tags => "Hello, World", :trails => { :user => '5', :account => '12' } }
+      Apphunk::Proxy.should_receive(:send_message_to_apphunkd).with("My Message", opts)
+      Apphunk.log("My Message", opts)
+    end
+    
+    it 'should merge provided options with Apphunk.default_options' do
+      Apphunk::Proxy.should_receive(:send_message_to_apphunkd).with("My Message", { :tags => 'Hello', :trails => { :user => '5' }})
+      Apphunk.default_options = { :trails => { :user => '5' }}
+      Apphunk.log("My Message", :tags => "Hello")
+    end
+    
+    it 'should override Apphunk.default_options with provided options' do
+      Apphunk::Proxy.should_receive(:send_message_to_apphunkd).with("My Message", { :tags => 'Bye' })
+      Apphunk.default_options = { :tags => 'Hello'}
+      Apphunk.log("My Message", :tags => "Bye")
+    end
+  end
+  
+  describe 'log_with_options' do
+    it 'should yield the Apphunk module back to the block' do
+      Apphunk.log_with_options do |apphunk|
+        apphunk.should == Apphunk
+      end
+    end
+    
+    it 'should set Apphunk.default_options before yielding' do
+      Apphunk.log_with_options(:tags => 'hello') do |apphunk|
+        apphunk.default_options.should == { :tags => 'hello'}
+      end
+    end
+    
+    it 'should merge existing Apphunk.default_options and provided options' do
+      Apphunk.default_options = { :token => 'secret' }
+      Apphunk.log_with_options(:tags => 'hello', :trails => { :user => '5' }) do |apphunk|
+        apphunk.default_options.should == { :tags => 'hello', :trails => { :user => '5'}, :token => 'secret'}
+      end      
+    end
+    
+    it 'should init the default_options hash on demand' do
+      Apphunk.default_options = nil
+      Apphunk.log_with_options(:tags => "hallo") do |apphunk|
+        apphunk.should == Apphunk
+      end      
+    end
+    
+    it 'should restore old default_options after yielding' do
+      Apphunk.default_options = { :token => 'secret' }
+      Apphunk.log_with_options(:tags => "hallo") do |apphunk|
+        apphunk.should == Apphunk
+      end
+      Apphunk.default_options.should == { :token => 'secret' }
+    end    
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'apphunk'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: apphunk
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Andreas Wolff
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-20 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Apphunk is a library that allows your applications (currently only Ruby AND Rails) to send messages to Apphunk.com
+email: andreas@apphunk.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- History.rdoc
+- LICENSE
+- README.rdoc
+- Rakefile
+- TODO.rdoc
+- VERSION
+- apphunk.gemspec
+- lib/apphunk.rb
+- lib/apphunk/logger.rb
+- lib/apphunk/proxy.rb
+- lib/apphunk/remote.rb
+- lib/apphunk/remote/result.rb
+- rails/init.rb
+- spec/apphunk/proxy_spec.rb
+- spec/apphunk_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://apphunk.com
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A library to send messages to Apphunk.com
+test_files: 
+- spec/apphunk/proxy_spec.rb
+- spec/apphunk_spec.rb
+- spec/spec_helper.rb