thunk 0.0.0

data/.autotest

@@ -0,0 +1,5 @@
+require "autotest/restart"
+
+Autotest.add_hook :initialize do |at|
+  at.testlib = "minitest/autorun"
+end

data/CHANGELOG.rdoc

@@ -0,0 +1,4 @@
+=== 0.0.0 / 2010-01-25
+
+* First prerelease. Pretty darn rough.
+

data/Manifest.txt

@@ -0,0 +1,8 @@
+.autotest
+CHANGELOG.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+bin/thunk
+lib/thunk.rb
+test/test_thunk.rb

data/README.rdoc

@@ -0,0 +1,72 @@
+= Thunk!
+
+* http://github.com/eleven/thunk
+* http://thunk.us
+
+== Description
+
+An API for talking to thunk.us, a (soon to be) generally awesome
+notification service. Thunk lets you share and change simple state.
+
+We know these docs are rough, but we wanted to get a version of the
+API out quickly. We'll have it all polished by 1.0, we promise. :)
+
+Since Thunk gets used in basic infrastructure tools, it works extra
+hard to never throw exceptions or cause hangs/timeouts. If it does,
+please file a bug! Even a nonexistent or read-only thunk will
+successfully respond to pokes, returning stub information. If you need
+to make extra sure you're hooked up to a valid thunk, check out
+<tt>Thunk#exists?</tt> and <tt>Thunk#pokeable?</tt>.
+
+== Examples
+
+(Eventually) check out the RDoc for more detailed information.
+
+=== Poking & Reading a Thunk
+
+    thunk = Thunk.for "0681851956dccf88"
+    thunk.good! "Everything went better than expected!"
+
+    thunk.good?   # => true
+    thunk.payload # => "Everything went..."
+
+=== Creating a Thunk
+
+    thunk = Thunk.create "My New Thunk"
+
+    thunk.name  # => "My New Thunk"
+    thunk.state # => :new
+    thunk.uuid  # => "..."
+
+    thunk.good! "I just made this thunk! Aaugh!"
+
+=== At the Command Line
+
+    $ thunk -h
+
+== Installation
+
+    $ gem install thunk
+
+== License
+
+Copyright 2010 Eleven Eleven (hello@thunk.us)
+
+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/Rakefile

@@ -0,0 +1,17 @@
+require "hoe"
+
+Hoe.plugin :doofus, :git
+Hoe.plugins.delete :rubyforge
+
+Hoe.spec "thunk" do
+  developer "Eleven Eleven", "hello@3lev3n.com"
+
+  self.extra_rdoc_files = Dir["*.rdoc"]
+  self.history_file     = "CHANGELOG.rdoc"
+  self.readme_file      = "README.rdoc"
+  self.testlib          = :minitest
+
+  extra_deps     << %w(json_pure 1.2.0)
+  extra_dev_deps << %w(fakeweb   1.2.8)
+  extra_dev_deps << %w(minitest  1.5.0)
+end

data/bin/thunk

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "thunk"
+
+OptionParser.new do |opts|
+  @payload = nil
+  @poke    = nil
+  @raw     = false
+
+  opts.banner = 
+    "Usage: thunk [options] --create [message]\n" +
+    "       thunk [options] <uuid>\n" +
+    "       thunk [options] {--good, --bad, --iffy, --unknown} <uuid>\n\n"
+
+  opts.on "--create [PAYLOAD]", "-c", "Create a thunk, optional payload." do |p|
+    thunk = Thunk.create p
+    puts thunk.uuid if thunk.uuid
+    exit thunk.exists? ? 0 : 1
+  end
+
+  opts.on "--help", "-h", "-?", "Show this help." do
+    puts opts
+    exit 0
+  end
+
+  opts.on "--payload PAYLOAD", "-p", "-m",
+    "An optional poke payload/message." do |p|
+
+    @payload = p
+  end
+
+  opts.on "--raw", "Show the thunk data as raw JSON." do
+    @raw = true
+  end
+
+  opts.on "--url URL", "Use a different base URL." do |url|
+    Thunk.url = url
+  end
+
+  opts.on "--version", "-V", "Prints #{Thunk::VERSION}." do
+    puts Thunk::VERSION
+    exit 0
+  end
+
+  %w(good iffy bad unknown).each do |state|
+    opts.on "--#{state}", "-#{state[0,1]}", "Send a '#{state}' poke." do
+      @poke = state
+    end
+  end
+
+  if ARGV.empty?
+    puts opts
+    exit 1
+  end
+
+  begin
+    opts.parse! ARGV
+  rescue OptionParser::ParseError => e
+    abort "#$0: #{e.message}"
+  end
+
+  abort "#$0: Specify a thunk UUID!" unless uuid = ARGV.shift
+  thunk = Thunk.for uuid
+
+  if @poke
+    p @payload
+    thunk.send "#{@poke}!", @payload
+  else
+    if @raw
+      puts thunk.json
+    else
+      str  = [thunk.name, thunk.state].compact.join ", "
+      str << ", updated at #{thunk.updated}" if thunk.updated
+      str << ": #{thunk.payload}" if thunk.payload
+
+      puts str
+    end
+
+    exit({ :new => 0, :good => 0, :iffy => 2,
+           :bad => 4, :iffy => 8, :unknown => 16 }[thunk.state])
+  end
+end

data/lib/thunk.rb

@@ -0,0 +1,160 @@
+require "cgi"
+require "json/pure"
+require "net/http"
+require "uri"
+
+class Thunk
+  VERSION = "0.0.0"
+  URL     = "http://thunk.us".freeze
+
+  class << self
+    attr_accessor :url
+    private :new
+
+    def create name = nil
+      json = request :post, url, :name => name
+      new "#{url}/#{json["uuid"]}", json
+    end
+
+    def for url
+      url  = "#{self.url}/#{url}" unless /^http/ =~ url
+      json = request :get, url
+      new url, json
+    end
+
+    def request method, url, options = {}
+      url = URI.parse url
+
+      unless options.empty?
+        url.query = options.collect { |k ,v|
+          "#{CGI.escape k.to_s}=#{CGI.escape v.to_s}"
+        }.join "&"
+      end
+
+      # FIX http timeout settings
+      # FIX exception handing, etc
+
+      http    = Net::HTTP.new url.host, url.port
+      rclass  = { :get => Net::HTTP::Get, :post => Net::HTTP::Post }[method]
+      req     = rclass.new url.request_uri
+      res     = http.request req
+      success = %w(200 201).include? res.code
+
+      unless success
+        warn "[Thunk] #{res.code}, #{method}, #{url}: #{res.message}"
+        warn res.body if res.body
+      end
+
+      return success if res.body.empty?
+
+      data = JSON.parse(res.body) rescue {}
+
+      unless Hash === data
+        warn "[Thunk] Malformed JSON response: #{data.inspect}"
+        data = {}
+      end
+
+      warn warning if warning = data.delete("warn")
+      abort critical if critical = data.delete("abort")
+
+      data
+    end
+  end
+
+  self.url = URL
+
+  attr_reader :name
+  attr_reader :payload
+  attr_reader :puuid
+  attr_reader :state
+  attr_reader :updated
+  attr_reader :url
+  attr_reader :uuid
+
+  def bad?
+    :bad == state
+  end
+
+  def bad! payload = nil
+    poke :bad, payload
+  end
+
+  def exists?
+    self.class.request :get, url
+  end
+
+  def good?
+    :good == state
+  end
+
+  def good! payload = nil
+    poke :good, payload
+  end
+
+  def iffy?
+    :iffy == state
+  end
+
+  def iffy! payload = nil
+    poke :iffy, payload
+  end
+
+  def json
+    json = {
+      :name    => name,
+      :payload => payload,
+      :puuid   => puuid,
+      :state   => state,
+      :updated => updated,
+      :url     => url,
+      :uuid    => uuid
+    }
+
+    json.reject! { |k, v| v.nil? }
+    JSON.generate json
+  end
+
+  def poke state, payload = nil
+    if self.class.request :post, "#{url}/#{state}", :payload => payload
+      @payload = payload
+      @state   = state.to_sym
+      @updated = Time.now.utc
+    end
+
+    @state
+  end
+
+  def pokeable?
+    puuid
+  end
+
+  def public?
+    !puuid
+  end
+
+  def unknown?
+    :unknown == state
+  end
+
+  def unknown! payload = nil
+    poke :unknown, payload
+  end
+
+  private
+
+  def initialize url, json
+    @url = url
+    apply json
+  end
+
+  def apply json
+    @name    = json["name"]
+    @payload = json["payload"]
+    @state   = (json["state"] || "unknown").to_sym
+    @updated = json["updated"]
+    @uuid    = json["uuid"]
+    @puuid   = json["puuid"]
+
+    self
+  end
+end

data/test/test_thunk.rb

@@ -0,0 +1,120 @@
+require "fakeweb"
+require "minitest/autorun"
+
+require "thunk"
+
+FakeWeb.allow_net_connect = false
+
+class Thunk
+  class << self
+    def abort *; end
+    def warn  *; end
+
+    public :new
+  end
+
+  public :initialize
+end
+
+class TestThunk < MiniTest::Unit::TestCase
+  def setup
+    FakeWeb.clean_registry
+    Thunk.url = Thunk::URL
+  end
+
+  def test_bangs_and_predicates
+    t = Thunk.new "http://thunk.us/uuid", {}
+
+    [:good, :iffy, :bad, :unknown].each do |state|
+      FakeWeb.register_uri :post, "http://thunk.us/uuid/#{state}?payload=hi",
+        :status => 201
+
+      t.send "#{state}!", "hi"
+      assert t.send("#{state}?"), "thunk is #{state}"
+
+      refute_nil t.updated
+      assert_equal "hi", t.payload
+    end
+  end
+
+  def test_exists?
+    good = Thunk.new "http://thunk.us/exists", {}
+    bad  = Thunk.new "http://thunk.us/nonexistent", {}
+
+    FakeWeb.register_uri :get, "http://thunk.us/exists", :status => 200
+    FakeWeb.register_uri :get, "http://thunk.us/nonexistent", :status => 404
+
+    assert good.exists?, "good exists"
+    refute bad.exists?, "nonexistent"
+  end
+
+  def test_pokeable_and_public
+    FakeWeb.register_uri :get, "http://thunk.us/pokeable",
+      :body => JSON.generate({ :uuid => "pokeable", :puuid => "public" })
+
+    FakeWeb.register_uri :get, "http://thunk.us/public",
+      :body => JSON.generate({ :uuid => "public" })
+
+    t = Thunk.for "pokeable"
+    assert t.pokeable?, "pokeable"
+    refute t.public?, "public"
+
+    t = Thunk.for "public"
+    refute t.pokeable?, "pokeable"
+    assert t.public?, "public"
+  end
+
+  def test_self_create
+    response = {
+      :name  => "Hello",
+      :puuid => "public",
+      :state => :new,
+      :uuid  => "uuid"
+    }
+
+    FakeWeb.register_uri :post, "http://thunk.us?name=Hello",
+      :body => JSON.generate(response)
+
+    t = Thunk.create "Hello"
+
+    response.each do |key, value|
+      assert_equal value, t.send(key)
+    end
+
+    assert_equal "http://thunk.us/uuid", t.url
+  end
+
+  def test_self_create_bad
+    FakeWeb.register_uri :post, "http://thunk.us?name=Hello",
+      :status => 500, :body => "[]"
+
+    t = Thunk.create "Hello"
+    assert_equal :unknown, t.state
+  end
+
+  def test_self_for
+    response = {
+      :name    => "Hello",
+      :payload => "All is well!",
+      :puuid   => "public",
+      :state   => :good,
+      :uuid    => "uuid"
+    }
+
+    FakeWeb.register_uri :get, "http://thunk.us/uuid",
+      :body => JSON.generate(response)
+
+    t = Thunk.for "uuid"
+
+    response.each do |key, value|
+      assert_equal value, t.send(key)
+    end
+  end
+
+  def test_self_url
+    assert_equal "http://thunk.us", Thunk.url
+
+    Thunk.url = "bleh"
+    assert_equal "bleh", Thunk.url
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification 
+name: thunk
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Eleven Eleven
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-25 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json_pure
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.2.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: gemcutter
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.2.8
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.5.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.5.0
+    version: 
+description: |-
+  An API for talking to thunk.us, a (soon to be) generally awesome
+  notification service. Thunk lets you share and change simple state.
+  
+  We know these docs are rough, but we wanted to get a version of the
+  API out quickly. We'll have it all polished by 1.0, we promise. :)
+  
+  Since Thunk gets used in basic infrastructure tools, it works extra
+  hard to never throw exceptions or cause hangs/timeouts. If it does,
+  please file a bug! Even a nonexistent or read-only thunk will
+  successfully respond to pokes, returning stub information. If you need
+  to make extra sure you're hooked up to a valid thunk, check out
+  <tt>Thunk#exists?</tt> and <tt>Thunk#pokeable?</tt>.
+email: 
+- hello@3lev3n.com
+executables: 
+- thunk
+extensions: []
+
+extra_rdoc_files: 
+- Manifest.txt
+- CHANGELOG.rdoc
+- README.rdoc
+files: 
+- .autotest
+- CHANGELOG.rdoc
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- bin/thunk
+- lib/thunk.rb
+- test/test_thunk.rb
+has_rdoc: true
+homepage: http://github.com/eleven/thunk
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+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: thunk
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: An API for talking to thunk.us, a (soon to be) generally awesome notification service
+test_files: 
+- test/test_thunk.rb