postbin 0.1.0

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/HISTORY.md

@@ -0,0 +1,3 @@
+## 0.1.0 (2011-11-22)
+
+* Initial gem release, v0.1.0

data/README.md

@@ -0,0 +1,33 @@
+PostBin
+=======
+
+PostBin, a simple web service for testing WebHooks (HTTP POST requests).
+
+Quick Start
+-----------
+
+    $ gem install postbin
+    $ postbin
+    == PostBin online http://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.
+
+Rack Application
+----------------
+
+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.
+    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)

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems' unless defined?(Gem)
+require 'rake/testtask'
+
+# by default run unit tests.
+task :default => 'test:unit'
+
+namespace :test do
+  # unit tests.
+  Rake::TestTask.new(:unit) do |task|
+    task.test_files = FileList['test/**/*_test.rb']
+    task.verbose = true
+  end
+end

data/bin/postbin

@@ -0,0 +1,35 @@
+#!/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
+
+# --- cli option parsing -----------------------------------------------------
+require 'optparse'
+
+# 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)

data/lib/postbin.rb

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

data/lib/postbin/post.rb

@@ -0,0 +1,26 @@
+module PostBin
+
+  # Represents header/body information of a HTTP POST request.
+  class Post
+    attr_reader :received_at, :headers, :body
+
+    def initialize(headers, body, received_at = nil)
+      @received_at = received_at || Time.now
+      @headers = headers
+      @body = body
+    end
+
+    # Returns true only if the two posts contain equal data.
+    def ==(other)
+      return false unless Post === other
+      return false unless received_at == other.received_at
+      return false unless headers == other.headers
+      body == other.body
+    end
+
+    def to_json(*a)
+      { received_at: received_at, headers: headers, body: body }.to_json(*a)
+    end
+
+  end
+end

data/lib/postbin/server.rb

@@ -0,0 +1,71 @@
+module PostBin
+  class Server < Sinatra::Base
+
+    dir = File.dirname(File.expand_path(__FILE__))
+
+    set :views,  "#{dir}/server/views"
+    set :public_folder, "#{dir}/server/public"
+    set :static, true
+
+    # by default we store in a temp file.
+    set :pstore_file, Tempfile.new(['postbin', 'pstore'])
+
+    # Redirect lost users.
+    get '/?' do;         redirect '/postbin/overview'; end
+    get '/postbin/?' do;  redirect '/postbin/overview'; end
+
+    # Display main overview.
+    get '/postbin/overview' do
+      storage = PostBin::Storage.new(settings.pstore_file)
+      # pull out all urls and there posts.
+      @url_hits = storage.hits
+
+      @url_posts = @url_hits.inject({}) do |result, data|
+        url, hits = *data
+        result[url] = storage.posts(url)
+        result
+      end
+
+      erb :overview
+    end
+
+    # Display urls and there hit count as JSON.
+    get '/postbin/hits' do
+      storage = PostBin::Storage.new(settings.pstore_file)
+
+      content_type :json
+      storage.hits.to_json
+    end
+
+    # Display posts for the given URL as JSON.
+    get %r{/postbin/posts(.*)} do
+      url = params[:captures].first
+      storage = PostBin::Storage.new(settings.pstore_file)
+
+      content_type :json
+      storage.posts(url).to_json
+    end
+
+    # Catch all for post requests.
+    post '*' do
+      storage = PostBin::Storage.new(settings.pstore_file)
+      post = PostBin::Post.new(client_request_headers, request.body.read)
+      storage.store(request.path, post)
+      status 201
+    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] ] }
+        .collect { |pair| pair.join(': ') }
+
+      headers
+    end
+
+  end
+end

data/lib/postbin/server/views/layout.erb

@@ -0,0 +1,24 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>PostBin</title>
+</head>
+<body>
+  <div id="header">
+    <h1>PostBin</h1>
+  </div>
+
+  <div id="main">
+    <%= yield %>
+  </div>
+  <!--
+  <div id="footer">
+    <div class="block wat-cf">
+      <span class="links">http://github.com/lantins/postbin</span>
+      <span id="dev-info">v<%= PostBin::Version %></span>
+    </div>
+  </div>
+  -->
+</body>
+</html>

data/lib/postbin/server/views/overview.erb

@@ -0,0 +1,45 @@
+<!-- FIXME: replace with some async javascript magic and make pretty -->
+
+<h3>URLs &amp; Hits</h3>
+
+<table border="1">
+  <tr>
+    <th >Total Hits</th>
+    <th>URL</th>
+  </tr>
+  <% if @url_hits.empty? %>
+    <tr>
+      <td colspan="2"><em>No urls &amp; hits to display.</em></td>
+    </tr>
+  <% else %>
+    <% @url_hits.each do |url, hits| %>
+    <tr>
+      <td><%= hits %></td>
+      <td><%= url %></td>
+    </tr>
+    <% end %>
+  <% end %>
+</table>
+
+<hr>
+
+<h3>Recent Post Requests</h3>
+
+<% if @url_posts.empty? %>
+  <em>No post requests to display.</em>
+<% else %>
+  <% @url_posts.each_pair do |url, posts| %>
+    <strong>URL:</strong> <%= url %><br /><br />
+    <div style="padding-left: 40px;">
+      <% posts.each do |post| %>
+        <strong>TIMESTAMP</strong>
+        <pre><%= post.received_at %></pre>
+        <strong>HEADERS</strong>
+        <pre><%= post.headers.join("\n") %></pre>
+        <strong>BODY</strong>
+        <pre><%= post.body %></pre>
+        <hr>
+      <% end %>
+    </div>
+  <% end %>
+<% end %>

data/lib/postbin/storage.rb

@@ -0,0 +1,47 @@
+module PostBin
+
+  # Storage backend for PostBin, uses PStore under the hood.
+  class Storage
+
+    def initialize(pstore_file)
+      # setup file database for storage.
+      @db = PStore.new(pstore_file)
+    end
+
+    # Store a post in the database.
+    def store(url, post)
+      @db.transaction do
+        # init if no data exists.
+        @db['urls'] ||= {}
+        @db['urls'][url] ||= 0
+        @db[url] ||= []
+        # incr hit count.
+        @db['urls'][url] += 1
+        # store post.
+        @db[url] << post
+      end
+    end
+
+    # Returns hash, key being url and value being number of posts received.
+    def hits
+      @db.transaction(true) do
+        @db['urls'] || {}
+      end
+    end
+
+    # Returns array of urls that have been posted to.
+    def urls
+      @db.transaction(true) do
+        (@db['urls'] || {}).keys
+      end
+    end
+
+    # Returns array of posts for the given url.
+    def posts(url)
+      @db.transaction(true) do
+        @db[url] || []
+      end
+    end
+
+  end
+end

data/lib/postbin/version.rb

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

data/postbin.gemspec

@@ -0,0 +1,31 @@
+require './lib/postbin/version'
+
+spec = Gem::Specification.new do |s|
+  s.name                = 'postbin'
+  s.version             = PostBin::Version
+  s.date                = Time.now.strftime('%Y-%m-%d')
+  s.summary             = 'PostBin, a simple web service for testing WebHooks (HTTP POST requests).'
+  s.homepage            = 'https://github.com/lantins/postbin'
+  s.authors             = ['Luke Antins']
+  s.email               = ['luke@lividpenguin.com']
+  s.has_rdoc            = false
+
+  s.files               = %w(Rakefile README.md HISTORY.md Gemfile postbin.gemspec)
+  s.files              += Dir.glob('{test/**/*,lib/**/*}')
+  s.require_paths       = ['lib']
+  s.executables         = ['postbin']
+  s.default_executable  = 'postbin'
+
+  s.add_dependency('sinatra')
+  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')
+
+  s.description       = <<-EOL
+  A ruby command line/rack application for testing systems that send WebHooks
+  using a HTTP POST request. Requests can be viewed via a simple web interface.
+  EOL
+end

data/test/post_test.rb

@@ -0,0 +1,29 @@
+require_relative 'test_helper'
+
+class TestPost < MiniTest::Unit::TestCase
+
+  def test_has_a_header_and_body
+    post = PostBin::Post.new('header data', 'body data')
+    assert_equal 'header data', post.headers, 'post headers not as we expect'
+    assert_equal 'body data', post.body, 'post body not as we expect'
+  end
+
+  def test_has_received_at_timestamp
+    post = PostBin::Post.new('headers', 'body')
+    assert_kind_of Time, post.received_at
+  end
+
+  def test_we_can_set_received_at
+    now = Time.now
+    post = PostBin::Post.new('headers', 'body', now)
+    assert_equal now, post.received_at
+  end
+
+  def test_double_equals_comparison_method
+    now = Time.now
+    post1 = PostBin::Post.new('headers', 'body', now)
+    post2 = PostBin::Post.new('headers', 'body', now)
+    assert_equal post1, post2, 'should be the same'
+  end
+
+end

data/test/server_test.rb

@@ -0,0 +1,62 @@
+require_relative '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'])
+  end
+
+  def test_roots_should_redirect_to_overview
+    get '/'
+    follow_redirect!
+    assert_equal '/postbin/overview', last_request.path
+    assert last_response.ok?
+
+    get '/postbin'
+    follow_redirect!
+    assert_equal '/postbin/overview', last_request.path
+    assert last_response.ok?
+  end
+
+  def test_overview_returns_200
+    get '/postbin/overview'
+    assert_equal 200, last_response.status, 'status code should be 200 OK'
+  end
+
+  def test_accepts_post_requests
+    post '/hello', 'foobar'
+    assert_equal 201, last_response.status, 'status code should be 201 Created'
+  end
+
+  def test_accepts_posts_to_long_urls
+    post '/foo/bar/is/very/long.php', 'hello world'
+    assert_equal 201, last_response.status, 'status code should be 201 Created'
+  end
+
+  def test_json_url_hits
+    get '/postbin/hits'
+    assert_equal 200, last_response.status, 'status code should be 200 OK'
+    assert_includes last_response.headers['Content-Type'], 'application/json', 'Content-Type header should be json'
+  end
+
+  def test_json_url_posts
+    get '/postbin/posts'
+    assert_equal 200, last_response.status, 'status code should be 200 OK'
+    assert_includes last_response.headers['Content-Type'], 'application/json', 'Content-Type header should be json'
+  end
+
+  def test_post_and_read_back
+    # post some data.
+    post '/cats', 'they miaow'
+    get '/postbin/hits'
+    assert_equal '{"/cats":1}', last_response.body
+
+    # read it back.
+    get '/postbin/posts/cats'
+    post = JSON.parse(last_response.body)[0]
+    assert_equal 'they miaow', post['body']
+  end
+
+
+end

data/test/storage_test.rb

@@ -0,0 +1,50 @@
+require_relative 'test_helper'
+
+class TestStorage < MiniTest::Unit::TestCase
+
+  def test_new_instance
+    assert PostBin::Storage.new(Tempfile.new(['postbin', 'pstore']))
+  end
+
+  def test_all_urls_returns_empty_hash_by_default
+    storage = PostBin::Storage.new(Tempfile.new(['postbin', 'pstore']))
+    assert_empty storage.urls, 'should return empty array by default'
+  end
+
+  def test_can_store_post
+    storage = PostBin::Storage.new(Tempfile.new(['postbin', 'pstore']))
+    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']))
+    post = PostBin::Post.new('1', '2')
+    storage.store('/foobar', post)
+
+    expected = ['/foobar']
+    assert_equal expected, storage.urls, 'all urls should be a populated array'
+  end
+
+  def test_keeps_count_of_posts_to_same_url
+    storage = PostBin::Storage.new(Tempfile.new(['postbin', 'pstore']))
+    post = PostBin::Post.new('1', '2')
+    storage.store('/foobar', post)
+    storage.store('/foobar', post)
+    storage.store('/hello', post)
+
+    hits = storage.hits
+    assert_equal 2, hits['/foobar'], 'count should be 2'
+    assert_equal 1, hits['/hello'], 'count should be 1'
+  end
+
+  def test_can_retrieve_saved_post_data
+    storage = PostBin::Storage.new(Tempfile.new(['postbin', 'pstore']))
+    post = PostBin::Post.new('4', '2')
+    storage.store('/retrieve', post)
+
+    posts = storage.posts('/retrieve')
+    assert_equal post, posts[0], 'should match the post we stored'
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,24 @@
+#
+# Test helper init script.
+#
+require 'simplecov'
+
+# code coverage groups.
+SimpleCov.start do
+  add_filter 'test/'
+end
+
+# 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'
+
+# extend main TestCase
+class MiniTest::Unit::TestCase
+  include Rack::Test::Methods
+end

data/test/version_test.rb

@@ -0,0 +1,7 @@
+require_relative 'test_helper'
+
+class TestVersion < MiniTest::Unit::TestCase
+  def test_should_have_a_version
+    assert PostBin::Version, 'unable to access the version number'
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: postbin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Luke Antins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-22 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &2165957000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2165957000
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2165956540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165956540
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2165956060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165956060
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &2165955600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165955600
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &2165955180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165955180
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &2165954740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165954740
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2165954320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2165954320
+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:
+- luke@lividpenguin.com
+executables:
+- postbin
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- README.md
+- HISTORY.md
+- Gemfile
+- postbin.gemspec
+- test/post_test.rb
+- test/server_test.rb
+- test/storage_test.rb
+- test/test_helper.rb
+- test/version_test.rb
+- lib/postbin/post.rb
+- lib/postbin/server/views/layout.erb
+- lib/postbin/server/views/overview.erb
+- lib/postbin/server.rb
+- lib/postbin/storage.rb
+- lib/postbin/version.rb
+- lib/postbin.rb
+- bin/postbin
+homepage: https://github.com/lantins/postbin
+licenses: []
+post_install_message: 
+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
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: PostBin, a simple web service for testing WebHooks (HTTP POST requests).
+test_files: []
+has_rdoc: false