thunk 0.0.0 → 0.1.0

data/CHANGELOG.rdoc

@@ -1,3 +1,9 @@
+=== 0.1.0 / 2010-01-29
+
+* Improve command-line option help.
+* Refactor for better testability (thanks, Evan!)
+* Remove debug output.
+
 === 0.0.0 / 2010-01-25
 
 * First prerelease. Pretty darn rough.

data/Manifest.txt

@@ -5,4 +5,6 @@ README.rdoc
 Rakefile
 bin/thunk
 lib/thunk.rb
+lib/thunk/server.rb
 test/test_thunk.rb
+test/test_thunk_server.rb

data/README.rdoc

@@ -8,6 +8,8 @@
 An API for talking to thunk.us, a (soon to be) generally awesome
 notification service. Thunk lets you share and change simple state.
 
+== Notes in Progress
+
 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. :)
 

data/Rakefile

@@ -4,7 +4,8 @@ Hoe.plugin :doofus, :git
 Hoe.plugins.delete :rubyforge
 
 Hoe.spec "thunk" do
-  developer "Eleven Eleven", "hello@3lev3n.com"
+  developer "Eleven Eleven", "hello@thunk.us"
+  developer "John Barnette", "john@thunk.us"
 
   self.extra_rdoc_files = Dir["*.rdoc"]
   self.history_file     = "CHANGELOG.rdoc"
@@ -14,4 +15,5 @@ Hoe.spec "thunk" do
   extra_deps     << %w(json_pure 1.2.0)
   extra_dev_deps << %w(fakeweb   1.2.8)
   extra_dev_deps << %w(minitest  1.5.0)
+  extra_dev_deps << %w(mocha     0.9.8)
 end

data/bin/thunk

@@ -7,14 +7,15 @@ OptionParser.new do |opts|
   @payload = nil
   @poke    = nil
   @raw     = false
+  @server  = Thunk::Server.new
 
-  opts.banner = 
-    "Usage: thunk [options] --create [message]\n" +
+  opts.banner =
+    "Usage: thunk [options] --create [name]\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
+  opts.on "--create [NAME]", "-c", "Create a thunk, optional name." do |n|
+    thunk = @server.create n
     puts thunk.uuid if thunk.uuid
     exit thunk.exists? ? 0 : 1
   end
@@ -25,7 +26,7 @@ OptionParser.new do |opts|
   end
 
   opts.on "--payload PAYLOAD", "-p", "-m",
-    "An optional poke payload/message." do |p|
+    "Add a payload/message to a poke." do |p|
 
     @payload = p
   end
@@ -35,7 +36,7 @@ OptionParser.new do |opts|
   end
 
   opts.on "--url URL", "Use a different base URL." do |url|
-    Thunk.url = url
+    @server = Thunk::Server.new url
   end
 
   opts.on "--version", "-V", "Prints #{Thunk::VERSION}." do
@@ -61,10 +62,9 @@ OptionParser.new do |opts|
   end
 
   abort "#$0: Specify a thunk UUID!" unless uuid = ARGV.shift
-  thunk = Thunk.for uuid
+  thunk = @server.get uuid
 
   if @poke
-    p @payload
     thunk.send "#{@poke}!", @payload
   else
     if @raw

data/lib/thunk.rb

@@ -1,76 +1,32 @@
-require "cgi"
-require "json/pure"
-require "net/http"
-require "uri"
+require "thunk/server"
 
 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
+  VERSION = "0.1.0"
 
   attr_reader :name
   attr_reader :payload
   attr_reader :puuid
   attr_reader :state
   attr_reader :updated
-  attr_reader :url
   attr_reader :uuid
 
+  def self.create *args
+    server.create *args
+  end
+
+  def self.get *args
+    server.get *args
+  end
+
+  def self.server
+    @server ||= Thunk::Server.new
+  end
+
+  def initialize server, json
+    @server = server
+    apply json
+  end
+
   def bad?
     :bad == state
   end
@@ -80,7 +36,7 @@ class Thunk
   end
 
   def exists?
-    self.class.request :get, url
+    @server.request :get, url
   end
 
   def good?
@@ -99,7 +55,9 @@ class Thunk
     poke :iffy, payload
   end
 
-  def json
+  # Used for the --raw option in the command-line client.
+
+  def json # :nodoc:
     json = {
       :name    => name,
       :payload => payload,
@@ -115,7 +73,7 @@ class Thunk
   end
 
   def poke state, payload = nil
-    if self.class.request :post, "#{url}/#{state}", :payload => payload
+    if @server.request :post, "#{url}/#{state}", :payload => payload
       @payload = payload
       @state   = state.to_sym
       @updated = Time.now.utc
@@ -140,13 +98,12 @@ class Thunk
     poke :unknown, payload
   end
 
-  private
-
-  def initialize url, json
-    @url = url
-    apply json
+  def url
+    "#{@server.url}/#{uuid}"
   end
 
+  private
+
   def apply json
     @name    = json["name"]
     @payload = json["payload"]

data/lib/thunk/server.rb

@@ -0,0 +1,71 @@
+require "cgi"
+require "json/pure"
+require "net/http"
+require "uri"
+
+require "thunk"
+
+class Thunk
+
+  class << self
+    public :new # FIX
+  end
+
+  class Server
+    attr_reader :url
+
+    def initialize url = "http://thunk.us"
+      @url = url
+    end
+
+    def create name = nil
+      json = request :post, url, :name => name
+      url  = "#{self.url}/#{json['uuid']}"
+
+      Thunk.new self, json
+    end
+
+    def get uuid
+      url = "#{self.url}/#{uuid}"
+      Thunk.new self, request(:get, url)
+    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
+end

data/test/test_thunk.rb

@@ -1,29 +1,19 @@
 require "fakeweb"
 require "minitest/autorun"
+require "mocha"
 
 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
+    @server = Thunk::Server.new
   end
 
   def test_bangs_and_predicates
-    t = Thunk.new "http://thunk.us/uuid", {}
+    t = Thunk.new @server, { "uuid" => "uuid" }
 
     [:good, :iffy, :bad, :unknown].each do |state|
       FakeWeb.register_uri :post, "http://thunk.us/uuid/#{state}?payload=hi",
@@ -38,8 +28,8 @@ class TestThunk < MiniTest::Unit::TestCase
   end
 
   def test_exists?
-    good = Thunk.new "http://thunk.us/exists", {}
-    bad  = Thunk.new "http://thunk.us/nonexistent", {}
+    good = Thunk.new @server, { "uuid" => "exists" }
+    bad  = Thunk.new @server, { "uuid" => "nonexistent" }
 
     FakeWeb.register_uri :get, "http://thunk.us/exists", :status => 200
     FakeWeb.register_uri :get, "http://thunk.us/nonexistent", :status => 404
@@ -55,66 +45,22 @@ class TestThunk < MiniTest::Unit::TestCase
     FakeWeb.register_uri :get, "http://thunk.us/public",
       :body => JSON.generate({ :uuid => "public" })
 
-    t = Thunk.for "pokeable"
+    t = @server.get "pokeable"
     assert t.pokeable?, "pokeable"
     refute t.public?, "public"
 
-    t = Thunk.for "public"
+    t = @server.get "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
+    Thunk.server.expects(:create).with "foo"
+    Thunk.create "foo"
   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
+  def test_self_get
+    Thunk.server.expects(:get).with "foo"
+    Thunk.get "foo"
   end
 end

data/test/test_thunk_server.rb

@@ -0,0 +1,73 @@
+require "fakeweb"
+require "minitest/autorun"
+
+require "thunk"
+
+FakeWeb.allow_net_connect = false
+
+class Thunk::Server
+  def abort *; end
+  def warn *; end
+end
+
+class TestThunkServer < MiniTest::Unit::TestCase
+  def setup
+    FakeWeb.clean_registry
+    @server = Thunk::Server.new
+  end
+
+  def test_create
+    response = {
+      :name  => "Hello",
+      :puuid => "public",
+      :state => :new,
+      :uuid  => "uuid"
+    }
+
+    FakeWeb.register_uri :post, "http://thunk.us?name=Hello",
+      :body => JSON.generate(response)
+
+    t = @server.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_create_bad
+    FakeWeb.register_uri :post, "http://thunk.us?name=Hello",
+      :status => 500, :body => "[]"
+
+    t = @server.create "Hello"
+    assert_equal :unknown, t.state
+  end
+
+  def test_get
+    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 = @server.get "uuid"
+
+    response.each do |key, value|
+      assert_equal value, t.send(key)
+    end
+  end
+
+  def test_initialize
+    s = Thunk::Server.new
+    assert_equal "http://thunk.us", s.url
+
+    s = Thunk::Server.new "http://thunk.local"
+    assert_equal "http://thunk.local", s.url
+  end
+end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification 
 name: thunk
 version: !ruby/object:Gem::Version 
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Eleven Eleven
+- John Barnette
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-01-25 00:00:00 -08:00
+date: 2010-01-29 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,6 +53,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.5.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.9.8
+    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   type: :development
@@ -65,18 +76,9 @@ dependencies:
 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
+- hello@thunk.us
+- john@thunk.us
 executables: 
 - thunk
 extensions: []
@@ -93,7 +95,9 @@ files:
 - Rakefile
 - bin/thunk
 - lib/thunk.rb
+- lib/thunk/server.rb
 - test/test_thunk.rb
+- test/test_thunk_server.rb
 has_rdoc: true
 homepage: http://github.com/eleven/thunk
 licenses: []
@@ -125,3 +129,4 @@ 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
+- test/test_thunk_server.rb