postbin 0.1.0 → 0.1.6

data/HISTORY.md

@@ -1,3 +1,9 @@
+## 0.1.6 (2012-01-04)
+
+* Added support for Ruby 1.8.7
+* Let rubygems deal with $LOAD_PATH
+* Change JSON lib to `multi_json` gem.
+
 ## 0.1.0 (2011-11-22)
 
 * Initial gem release, v0.1.0

data/README.md

@@ -8,8 +8,11 @@ Quick Start
 
     $ gem install postbin
     $ postbin
-    == PostBin online http://127.0.0.1:6969/
-    == CTRL+C to stop
+    == Starting PostBin on http://127.0.0.1:6969
+    == Sinatra/1.3.1 has taken the stage on 6969 for development with backup from Thin
+    >> Thin web server (v1.2.11 codename Bat-Shit Crazy)
+    >> Maximum connections set to 1024
+    >> Listening on 127.0.0.1:6969, CTRL+C to stop
 
 When running postbin from the command line, requests are stored in a temporary
 file database, they will be lost once the server terminates.
@@ -21,13 +24,24 @@ You can run a more permeant install by running PostBin as a Rack application:
 
     # example config.ru
     require 'postbin'
+
     # path of pstore file to use for storage.
     pstore = File.expand_path(File.join(File.dirname(__FILE__), 'postbin.pstore'))
+
     # start the server.
+    PostBin::Server.set :pstore_file, pstore
     run PostBin::Server.new(pstore)
 
 Command Line Options
 --------------------
 
-    -a, --address HOST       listen on HOST address (default: 127.0.0.1)
-    -p, --port PORT          use PORT number (default: 6969)
+    Usage: postbin [options]
+
+    PostBin options:
+      -v, --version            show version number
+      -h, --help               show this message
+
+    Rack options:
+      -s, --server SERVER      server (webrick, mongrel, thin, etc.)
+      -a, --address HOST       listen on HOST address (default: 127.0.0.1)
+      -p, --port PORT          use PORT number (default: 6969)

data/Rakefile

@@ -7,6 +7,7 @@ task :default => 'test:unit'
 namespace :test do
   # unit tests.
   Rake::TestTask.new(:unit) do |task|
+    task.libs << 'test'
     task.test_files = FileList['test/**/*_test.rb']
     task.verbose = true
   end

data/bin/postbin

@@ -1,35 +1,13 @@
 #!/usr/bin/env ruby
 
-# --- use local code if possible, otherwise use gem --------------------------
-begin
-  require 'postbin'
-rescue LoadError => err
-  require 'rubygems'
-  path = ::File.dirname(::File.expand_path(__FILE__))
-  $LOAD_PATH.unshift path + '/../lib' if File.directory?(path) && !$LOAD_PATH.include?(path)
-  require 'postbin'
-end
+# DEVELOPMENT NOTE
+# To run this executiable using the local code add ./lib/ to your ruby load path:
+# 
+#     ruby -Ilib bin/postbin
+#
 
-# --- cli option parsing -----------------------------------------------------
-require 'optparse'
+require 'rubygems' unless defined?(Gem)
+require 'postbin'
 
-# default options.
-options = { :bind => '127.0.0.1', :port => 6969, :server => 'thin', :enviroment => :production }
-
-# available options.
-opts = OptionParser.new('', 24, '  ') do |opts|
-  opts.banner = 'Usage: postbin [options]'
-  opts.separator ''
-  opts.separator 'PostBin options:'
-  opts.on('-v', '--version', 'show version number') { puts 'PostBin ' + PostBin::Version; exit }
-  opts.on('-h', '--help', 'show this message') { puts opts; exit; }
-  opts.separator ''
-  opts.separator 'Rack options:'
-  opts.on('-s', '--server SERVER', 'server (webrick, mongrel, thin, etc.)') { |s| options[:server] = s }
-  opts.on('-a', '--address HOST', 'listen on HOST address (default: 127.0.0.1)') { |host| options[:bind] = host }
-  opts.on('-p', '--port PORT', 'use PORT number (default: 6969)') { |port| options[:port] = port }
-end.parse!
-
-# --- start sinatra server ---------------------------------------------------
-puts "== Starting PostBin on http://#{options[:bind]}:#{options[:port]}"
-PostBin::Server.run!(options)
+# run command line instance of application
+PostBin::Server.run_command_line!(ARGV)

data/lib/postbin.rb

@@ -1,8 +1,9 @@
+require 'optparse'
 require 'pstore'
-require 'json'
+require 'multi_json'
 require 'sinatra/base'
 
-require_relative 'postbin/post'
-require_relative 'postbin/server'
-require_relative 'postbin/storage'
-require_relative 'postbin/version'
+require 'postbin/post'
+require 'postbin/server'
+require 'postbin/storage'
+require 'postbin/version'

data/lib/postbin/post.rb

@@ -18,8 +18,8 @@ module PostBin
       body == other.body
     end
 
-    def to_json(*a)
-      { received_at: received_at, headers: headers, body: body }.to_json(*a)
+    def to_json(*options)
+      MultiJson.encode({ :received_at => received_at, :headers => headers, :body => body })
     end
 
   end

data/lib/postbin/server.rb

@@ -8,7 +8,7 @@ module PostBin
     set :static, true
 
     # by default we store in a temp file.
-    set :pstore_file, Tempfile.new(['postbin', 'pstore'])
+    set :pstore_file, Tempfile.new(['postbin', 'pstore']).path
 
     # Redirect lost users.
     get '/?' do;         redirect '/postbin/overview'; end
@@ -34,7 +34,7 @@ module PostBin
       storage = PostBin::Storage.new(settings.pstore_file)
 
       content_type :json
-      storage.hits.to_json
+      MultiJson.encode(storage.hits)
     end
 
     # Display posts for the given URL as JSON.
@@ -43,7 +43,7 @@ module PostBin
       storage = PostBin::Storage.new(settings.pstore_file)
 
       content_type :json
-      storage.posts(url).to_json
+      MultiJson.encode(storage.posts(url))
     end
 
     # Catch all for post requests.
@@ -54,14 +54,43 @@ module PostBin
       status 201
     end
 
+    # Runs a server on local machine, called by command line executable.
+    def self.run_command_line!(argv)
+      options = parse_args(argv)
+      $stderr.puts "== Starting PostBin on http://#{options[:bind]}:#{options[:port]}"
+      run!(options)
+    end
+
+    # Parse command line args.
+    def self.parse_args(argv)
+      # default options.
+      options = { :bind => '127.0.0.1', :port => 6969, :server => 'thin', :enviroment => :production }
+
+      # available options.
+      opts = OptionParser.new('', 24, '  ') do |opts|
+        opts.banner = 'Usage: postbin [options]'
+        opts.separator ''
+        opts.separator 'PostBin options:'
+        opts.on('-v', '--version', 'show version number') { $stderr.puts 'PostBin ' + PostBin::Version; exit }
+        opts.on('-h', '--help', 'show this message') { $stderr.puts opts; exit; }
+        opts.separator ''
+        opts.separator 'Rack options:'
+        opts.on('-s', '--server SERVER', 'server (webrick, mongrel, thin, etc.)') { |s| options[:server] = s }
+        opts.on('-a', '--address HOST', 'listen on HOST address (default: 127.0.0.1)') { |host| options[:bind] = host }
+        opts.on('-p', '--port PORT', 'use PORT number (default: 6969)') { |port| options[:port] = port }
+      end.parse!(argv)
+
+      options
+    end
+
     private
     # Returns an array of all client side HTTP request headers.
     def client_request_headers
       # POST /some/url HTTP/1.1
       # Accept: application/json
       # Content-Type: application/json
-      headers = request.env.select { |k,v| k.start_with? 'HTTP_' }
-        .collect { |pair| [ pair[0].sub(/^HTTP_/, ''), pair[1] ] }
+      headers = request.env.select { |k,v| k.start_with? 'HTTP_' } \
+        .collect { |pair| [ pair[0].sub(/^HTTP_/, ''), pair[1] ] } \
         .collect { |pair| pair.join(': ') }
 
       headers

data/lib/postbin/storage.rb

@@ -6,6 +6,7 @@ module PostBin
     def initialize(pstore_file)
       # setup file database for storage.
       @db = PStore.new(pstore_file)
+      @db.ultra_safe = true if @db.respond_to?(:ultra_safe)
     end
 
     # Store a post in the database.
@@ -20,6 +21,7 @@ module PostBin
         # store post.
         @db[url] << post
       end
+      true
     end
 
     # Returns hash, key being url and value being number of posts received.

data/lib/postbin/version.rb

@@ -1,3 +1,3 @@
 module PostBin
-  Version = '0.1.0'
+  Version = '0.1.6'
 end

data/postbin.gemspec

@@ -17,10 +17,11 @@ spec = Gem::Specification.new do |s|
   s.default_executable  = 'postbin'
 
   s.add_dependency('sinatra')
+  s.add_dependency('multi_json')
+  s.add_dependency('json')
   s.add_development_dependency('rake')
   s.add_development_dependency('yard')
   s.add_development_dependency('minitest')
-  s.add_development_dependency('simplecov')
   s.add_development_dependency('rack-test')
   s.add_development_dependency('bundler')
 

data/test/post_test.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require 'test_helper'
 
 class TestPost < MiniTest::Unit::TestCase
 

data/test/server_test.rb

@@ -1,10 +1,10 @@
-require_relative 'test_helper'
+require 'test_helper'
 
 class TestServer < MiniTest::Unit::TestCase
   def app
     PostBin::Server.new
     # use a new pstore file for each request.
-    PostBin::Server.set :pstore_file, Tempfile.new(['postbin', 'pstore'])
+    PostBin::Server.set :pstore_file, Tempfile.new(['postbin', 'pstore']).path
   end
 
   def test_roots_should_redirect_to_overview
@@ -54,7 +54,7 @@ class TestServer < MiniTest::Unit::TestCase
 
     # read it back.
     get '/postbin/posts/cats'
-    post = JSON.parse(last_response.body)[0]
+    post = MultiJson.decode(last_response.body)[0]
     assert_equal 'they miaow', post['body']
   end
 

data/test/storage_test.rb

@@ -1,24 +1,29 @@
-require_relative 'test_helper'
+require 'test_helper'
 
 class TestStorage < MiniTest::Unit::TestCase
 
+  def setup
+    test_storage_tempfile = Tempfile.new(['postbin', 'pstore'])
+    @storage_path = test_storage_tempfile.path
+  end
+
   def test_new_instance
-    assert PostBin::Storage.new(Tempfile.new(['postbin', 'pstore']))
+    assert PostBin::Storage.new(@storage_path)
   end
 
   def test_all_urls_returns_empty_hash_by_default
-    storage = PostBin::Storage.new(Tempfile.new(['postbin', 'pstore']))
+    storage = PostBin::Storage.new(@storage_path)
     assert_empty storage.urls, 'should return empty array by default'
   end
 
   def test_can_store_post
-    storage = PostBin::Storage.new(Tempfile.new(['postbin', 'pstore']))
+    storage = PostBin::Storage.new(@storage_path)
     post = PostBin::Post.new('1', '2')
     assert storage.store('/test/url', post)
   end
 
   def test_can_get_all_urls
-    storage = PostBin::Storage.new(Tempfile.new(['postbin', 'pstore']))
+    storage = PostBin::Storage.new(@storage_path)
     post = PostBin::Post.new('1', '2')
     storage.store('/foobar', post)
 
@@ -27,7 +32,7 @@ class TestStorage < MiniTest::Unit::TestCase
   end
 
   def test_keeps_count_of_posts_to_same_url
-    storage = PostBin::Storage.new(Tempfile.new(['postbin', 'pstore']))
+    storage = PostBin::Storage.new(@storage_path)
     post = PostBin::Post.new('1', '2')
     storage.store('/foobar', post)
     storage.store('/foobar', post)
@@ -39,7 +44,7 @@ class TestStorage < MiniTest::Unit::TestCase
   end
 
   def test_can_retrieve_saved_post_data
-    storage = PostBin::Storage.new(Tempfile.new(['postbin', 'pstore']))
+    storage = PostBin::Storage.new(@storage_path)
     post = PostBin::Post.new('4', '2')
     storage.store('/retrieve', post)
 

data/test/test_helper.rb

@@ -1,24 +1,33 @@
 #
 # Test helper init script.
 #
-require 'simplecov'
 
-# code coverage groups.
-SimpleCov.start do
-  add_filter 'test/'
+# --- load rubygems if needed ------------------------------------------------
+require 'rubygems' unless defined?(Gem)
+
+# --- load simplecov if the gem is installed ---------------------------------
+begin
+  require 'simplecov'
+
+  # code coverage groups.
+  SimpleCov.start do
+    add_filter 'test/'
+  end
+rescue LoadError
+  # dont run code coverage if gem isn't installed.
 end
 
-# load our dependencies using bundler.
+# --- load our dependencies using bundler ------------------------------------
 require 'bundler/setup'
 Bundler.setup
 require 'minitest/autorun'
 require 'minitest/pride'
 require 'rack/test'
 
-# load postbin lib.
-require_relative './../lib/postbin'
+# --- load postbin lib -------------------------------------------------------
+require 'postbin'
 
-# extend main TestCase
+# --- extend main TestCase ---------------------------------------------------
 class MiniTest::Unit::TestCase
   include Rack::Test::Methods
 end

data/test/version_test.rb

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require 'test_helper'
 
 class TestVersion < MiniTest::Unit::TestCase
   def test_should_have_a_version

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postbin
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-22 00:00:00.000000000Z
+date: 2012-01-04 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &2165957000 !ruby/object:Gem::Requirement
+  requirement: &2166202940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,21 +21,32 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2165957000
+  version_requirements: *2166202940
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &2165956540 !ruby/object:Gem::Requirement
+  name: multi_json
+  requirement: &2166202180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
-  version_requirements: *2165956540
+  version_requirements: *2166202180
 - !ruby/object:Gem::Dependency
-  name: yard
-  requirement: &2165956060 !ruby/object:Gem::Requirement
+  name: json
+  requirement: &2166201760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2166201760
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2166201340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2165956060
+  version_requirements: *2166201340
 - !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: &2165955600 !ruby/object:Gem::Requirement
+  name: yard
+  requirement: &2166200900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2165955600
+  version_requirements: *2166200900
 - !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: &2165955180 !ruby/object:Gem::Requirement
+  name: minitest
+  requirement: &2166200440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2165955180
+  version_requirements: *2166200440
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &2165954740 !ruby/object:Gem::Requirement
+  requirement: &2166200000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2165954740
+  version_requirements: *2166200000
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2165954320 !ruby/object:Gem::Requirement
+  requirement: &2166199580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +98,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2165954320
+  version_requirements: *2166199580
 description: ! "  A ruby command line/rack application for testing systems that send
   WebHooks\n  using a HTTP POST request. Requests can be viewed via a simple web interface.\n"
 email: