oz 0.1

data/README

@@ -0,0 +1,209 @@
+#
+# oz.
+#   a command line t
+#                    u
+# by.                  m
+#    chris wanstrath     b
+#                          l
+#       - and -              e
+#                              r
+#    dayne broderson
+#
+
+New to ozimodo 1.2 is oz, the swiss army knife of command line tumbling.  
+Sure, Ajax is great.  And you know what?  Some HTML is okay, too.  But nothing
+beats the warm glow of a terminal.  
+
+First, let us install oz.  It's pretty easy, thanks to Ruby and all the 
+people who make it great:
+
+  $ gem install oz
+
+(If you already have ozimodo 1.2 you can find oz in ozimodo/bin, but the
+gem install is recommended.)
+
+== The Wizard of oz
+
+Not every tumblelog (or blog) supports oz yet, but they will.  In 
+the meantime, let's play some with a tumblelog we know supports oz: 
+ozmm.org.
+
+  $ oz --at ozmm.org commands
+
+This will give us a list of commands ozmm.org's API supports.  I get this
+list:
+
+  - code
+  - commands
+  - image
+  - link
+  - list
+  - post
+  - posts_with_tag
+  - quip
+  - quote
+  - show
+  - tags
+  - types
+  - version
+  - whoami
+
+Okay, fair enough.  Let's start simple.
+
+  $ oz --at ozmm.org version
+  version: "1.2"
+
+Nice.  Up to date.  How about...
+
+  $ oz --at ozmm.org tags
+  - ruby: 158
+  - rails: 62
+  - photos: 53
+  - games: 46
+  - svrc: 43
+  - php: 37
+  - mac: 34
+  - quotes: 33
+  - sanfrancisco: 28
+  - music: 17
+  - javascript: 14
+  - tumblelog: 5
+  - cocoa: 4
+  - rss: 4
+  - subversion: 4
+  - io: 3
+  - mysql: 3
+  - vim: 3
+
+Whoa!  Okay, Mr. Web2.0.  Let's see what you have to say about vim...
+
+  $ oz --at ozmm.org posts_with_tag vim
+  - 585: 
+    user: admin
+    title: ""
+    tags: vim
+    id: 585
+    content: okay we've got ''pastie for vim'':http://pastie.caboo.se/606 ...
+    post_type: quip
+    user_id: 1
+    created_at: 2006-07-10 13:15:00 -07:00
+  [ ...more posts... ]
+
+We can, of course, also run commands like posts or show 13 to get 
+information on specific posts.  What's this code command, though?
+I'll try it.
+
+  $ oz --at ozmm.org code
+  error: You need to login to do that
+
+Ah, so it's something secretive.  If only we were let into the club...    
+
+== Posting To Your Tumblelog With oz
+
+oz is great for querying tumblelogs, but the real magic is its ability to 
+post to your tumblelog.  
+
+=== Loggin' In
+
+The first thing we need to do is login.  Since 
+ozimodo 1.2 uses cookies for authentication, this is cake.  We'll be doing all
+of this on our local build of ozimodo, running at http://localhost:3000.
+
+My username is monet and my password is goodart.  Here is how I login:
+
+  $ oz --site monet:goodartlocalhost:3000
+  => Login successful, you don't have to use --site anymore.
+  => No URL to hit.
+
+Ah, great!  But what did that do?  Well, it created a ~/.ozcache file 
+and stored some information in it.
+
+  $ cat ~/.ozcache
+  cookie: ozimodo=1%26admin%269ce07a6fe388c0ceac0bd5b041757f1b
+  port: 3000
+  host: localhost
+
+This file contains the host and port of the tumblelog we want to work on as
+well as our login cookie, which will keep us from sending our password on 
+every request.
+
+If you don't want the cache file to be ~/.ozcache you can set the OZCACHE
+environment variable and oz will use that instead.
+
+=== Posting
+
+Posting is the easiest part.  Since "you know":configure.html a tumblelog 
+consists of multiple post types, let's see what post types we have available.
+
+  $ oz types
+  - code: content
+  - quip: content
+  - post: content
+  - quote: 
+    - author
+    - quote
+  - link: content
+  - image: 
+    - src
+    - alt
+    - blurb
+
+We're given a simple list (somewhat YAML-like) which lists each of our 
+available post types and the fields they accept.  code consists of 
+simple content while quote consists of author and quote, right?
+
+Let's post a quip, which Webster defines as a "clever, witty remark often 
+prompted by the occasion."
+
+  $ oz quip --content 'This command line stuff is so 1970.'
+  success: Post saved with id of 22
+
+Wow, it really worked.  If we were to open up our tumblelog at 
+http://localhost:3000 we'd see a new quip with our content.
+
+How about posting an image?
+
+  $ oz image --src http://facebook.railsconf.org/portraits/139/snap.png \ 
+    --tags 'rails dhh' --alt 'dhh is hot'
+  success: Post saved with id of 23
+
+Even though --tags isn't listed in the types info, it's of course a valid
+switch.  You can also use the --title switch with any post.
+
+Personally, I post a lot of links.  It would suck to have to format them in 
+textile from the command line each time.  Lots of terminating slashes.
+
+  $ oz link --url http://www.pjhyett.com/ --text 'PJ is a hack.' --tags link
+  success: Post saved with id of 24
+
+The link post type is special; our above input will be roughly translated 
+to: 
+
+  ''PJ is a hack.'':http://www.pjhyett.com" before posting.  
+
+It's a nice shortcut.
+
+== Tips and Tricks
+
+You can use oz --help for a refresher course at any time.  That'll tell you
+some helpful information, like that you can use --debug or --clear-cache
+when you're really getting into it.
+
+If your login has expired you can simply rock the --login switch without having
+to re-enter your host and port, ala:
+
+  $ oz --login monet:goodart
+  => Login successful, you don't have to use --site anymore.
+
+You can mostly ignore the No URL to hit messages as they're just letting you
+know that while you may have asked something of oz, it's not going to request
+anything of the remote server.
+
+If you're interested in how the oz API works, writing your own tumbler, or 
+implementing an API which oz can interact with (%(aside)it's quite versatile%),
+check out our "API":api.html docs. 
+
+== It Broke!
+
+As always, check the "install":install.html page for the best ways to report
+a bug.  We thank ya.

data/bin/oz

@@ -0,0 +1,287 @@
+#!/usr/bin/env ruby
+
+#
+# oz.
+#   a command line t
+#                    u
+# by.                  m
+#    chris wanstrath     b
+#                          l
+#       - and -              e
+#                              r
+#    dayne broderson
+#
+
+require 'net/http'
+require 'open-uri'
+require 'uri'
+require 'yaml'
+
+OZ_VERSION = '0.1'
+USER_AGENT = "oz/#{OZ_VERSION}"
+
+class OzException < Exception; end
+class BadFormatOfSiteSwitch < OzException; end
+class BadFormatOfLoginSwitch < OzException; end
+class ConfigFileDoesntExist < OzException; end
+class ConfigFileNeedsHost < OzException; end
+class CantLoginWithoutHost < OzException; end
+class LoginFailed < OzException; end
+class HostNeeded < OzException; end
+
+class Oz
+  class << self 
+    @@debug = false
+
+    def tumble(args)
+      check_oz_switches(args)
+
+      if args.include?('--at')
+        host, port = parse_at_switch(args) 
+      else
+        host, port, cookie = load_cache_or_login(args)
+      end
+
+      error "No cache file or host info found.  Please run the script with --site user:pass@host:port." unless host
+
+      url = build_url(host, port, args)
+      headers = build_headers(cookie)
+
+      error "No URL to hit." unless url
+
+      debug "Hitting #{url} with headers #{headers.inspect}."
+      
+      begin
+        open(url, headers) do |body|
+          puts body.read
+        end
+      rescue => e
+        error "There was an error connecting to http://#{host}:#{port}:\n   #{e}"
+      end
+    end
+
+    def do_login(host, port, user, pass)
+      uri = URI.parse("http://#{host}")
+      uri.send(:set_port, port)
+      debug "Tried to login to #{uri.host}:#{port}#{uri.path} as #{user}/#{pass}."
+      begin
+        site = Net::HTTP.new(uri.host, uri.port)
+        res  = site.post2("#{uri.path}/api/login", "username=#{user}&password=#{pass}", build_headers)
+      rescue Errno::ECONNREFUSED 
+        error "Couldn't connect to http://#{host}:#{port} to login."
+      end
+      (res.header['set-cookie'] =~ /(.+); path(.+)$/) ? $1 : false
+    end
+
+    def parse_site_switch(site)
+      raise BadFormatOfSiteSwitch unless site =~ /^(http:\/\/)?(.+):(.+)@([^:]+):?(\d*)$/
+      [$4, $2, $3, ($5.empty? ? 80 : $5)]
+    end
+
+    def parse_at_switch(args)
+      if i = args.index('--at')
+        info = args[i+1]
+        args.delete_at(i+1)
+        args.delete_at(i)
+      else
+        return false
+      end
+
+      raise BadFormatOfAtSwitch unless info =~ /^(http:\/\/)?([^:!]+):?(\d*)$/
+      [$2, ($3.empty? ? 80 : $3).to_i]
+    end
+
+    def parse_login_switch(login)
+      raise BadFormatOfLoginSwitch unless login =~ /^(.+):(.+)$/
+      [$1, $2]
+    end
+
+    def write_to_cache(options)
+      cache_file = ENV['OZCACHE'] || (File.expand_path('~') + '/.ozcache')
+      options.stringify_keys!
+      cache = if File.exists? cache_file
+                YAML.load(File.read(cache_file)).merge(options)
+              else
+                options
+              end
+      file = File.new(cache_file, 'w')
+      file.write(YAML.dump(cache))
+      file.close_write
+      debug "Wrote #{cache.inspect} to cache file #{cache_file}."
+    end
+
+    def clear_cache
+      files = [ENV['OZCACHE'], File.expand_path('~') + '/.ozcache'].compact
+
+      return info("No cache exists.") unless files.any? { |f| File.exists?(f) }
+
+      while file = files.shift
+        next unless File.exists? file
+        File.unlink file
+        info "Deleted cache file #{file}"
+      end
+    end
+
+    def load_cache_or_login(args)
+      host, port, cookie = load_cache
+      host, port, cookie = cache_info_from_switch(host, port, args) if args.any? { |a| a =~ /site|login/ }
+      [host, port, cookie]
+    end
+
+    def load_cache
+      if (file = ENV['OZCACHE']) && File.exists?(file)
+      elsif (file = File.expand_path('~') + '/.ozcache') && File.exists?(file)
+      else return false
+      end
+      yaml = YAML.load(File.read(file))
+      debug "Loaded cache file #{file}"
+      yaml['host'] ? [yaml['host'], yaml['port'], yaml['cookie']] : false
+    end
+
+    def cache_info_from_switch(host, port, args)
+      if ((i = args.index('--login')) || (i = args.index('--site')))
+        switch_type, info = args[i], args[i+1]
+        args.delete_at(i+1)
+        args.delete_at(i)
+      else
+        return false
+      end
+
+      case switch_type
+      when '--login'
+        raise CantLoginWithoutHost unless host
+        user, pass = parse_login_switch(info)
+      when '--site'
+        host, user, pass, port = parse_site_switch(info)
+      end
+
+      raise LoginFailed unless cookie = do_login(host, port, user, pass)
+
+      info "Login successful, you don't have to use --site anymore."
+      write_to_cache(:host => host, :port => port.to_i, :cookie => cookie)
+
+      [host, port, cookie]
+    end
+
+    def build_url(host, port, args)
+      return unless args.size.nonzero?
+      port = (port == 80) ? '' : ":#{port}"
+      domain = host =~ /([^\/]+)\/(.+)/ ? "#{$1}#{port}/#{$2}" : "#{host}#{port}"
+      url  = "http://#{domain}/api/"
+      url << args.shift # something like 'list' or 'show' -- the page you want to hit
+      url << "/#{args.shift}" if args.size.nonzero? unless args.first =~ /^--/    # the '33' part of /api/show/33
+
+      # turns --link http://ozmm.org into &post[link]=http://ozmm.org
+      sep = '?'
+      while arg = args.shift
+        next unless arg =~ /^--(\w+)/
+        url << "#{sep}post[#{$1}]=#{args.shift}"
+        sep = '&'
+      end if args.size.nonzero?
+
+      url = URI.escape(url)
+      debug "Built url #{url}"
+      url
+    end
+
+    def build_headers(cookie = nil)
+      headers = { 'User-Agent' => USER_AGENT, 'Accept' => 'text/plain' }
+      cookie ? headers.merge('Cookie' => cookie) : headers
+    end
+
+    def error(msg)
+      puts "=> #{msg}"
+      exit
+    end
+
+    def info(msg)
+      puts "=> #{msg}"
+    end
+
+    def debug(msg)
+      info msg if @@debug
+    end
+
+    def check_oz_switches(args)
+      if args.index('--clear-cache')
+        clear_cache
+        exit
+      end
+
+      if args.index('--help')
+        show_help
+        exit
+      end
+
+      if i = args.index('--debug')
+        args.delete_at(i)
+        @@debug = true
+      end
+    end
+
+    def show_help
+      break_length = 29
+      puts "Usage: oz [command] [arguments] <switch>"
+
+      show_switch = proc { |s| (' ' * 4) + sprintf("%-#{break_length}s", s) }
+      
+      print show_switch.call('--site user:pass@host:port')
+      puts "Login.  Once you do this, your login cookie and server will be cached"
+
+      print show_switch.call('--at host:port')
+      puts "Hit a specific host once.  Use this for hitting APIs you don't want to login to."
+
+      print show_switch.call('--debug')
+      puts "Print debug information"
+
+      print show_switch.call('--clear-cache')
+      puts "Clear your local login/site cache"
+
+      print show_switch.call('--help')
+      puts "This message"
+
+      puts
+      puts "Remote Commands:"
+
+      print show_switch.call('commands')
+      puts "Get a list of valid commands from the server"
+
+      print show_switch.call('types')
+      puts "Get a list of valid type commands and their arguments from the server"
+
+      print show_switch.call('list')
+      puts "See a list of recent posts"
+
+      print show_switch.call('show #')
+      puts "Examine post number #"
+
+      puts
+      puts "Example usage:"
+      puts "    $ ./oz --site mark:love@ozmm.org list"
+      puts "    => Login successful, you don't have to use --site anymore."
+      puts "    <list of recent posts>"
+      puts "    $ ./oz show 12"
+      puts "    <YAML description of post 12>"
+      puts "    $ ./oz image --src http://ozmm.org/images/smiley_face.jpg --alt 'smile!' --tags 'photos faces'"
+      puts "    success: Post saved with id of 13"
+      
+      puts
+      puts "   See http://ozimodo.rubyforge.org/oz.html for a more in-depth tutorial."
+    end
+
+  end
+end
+
+class Hash
+  def stringify_keys!
+    keys.each do |key|
+      unless key.class.to_s == "String"
+        self[key.to_s] = self[key]
+        delete(key)
+      end
+    end
+    self
+  end
+end
+
+Oz.tumble(ARGV.dup) unless $DONT_RUN

data/test/test_oz.rb

@@ -0,0 +1,210 @@
+$:.unshift Dir.pwd
+require 'test/unit'
+require 'fileutils'
+require 'tempfile'
+$DONT_RUN = true
+load 'bin/oz'
+
+# don't let oz exit when it wants to
+Kernel.send(:define_method, :exit, proc {})
+
+class OzTest < Test::Unit::TestCase
+
+  def test_load_cache_from_env
+    ENV['OZCACHE'] = 'ozimondo'   
+    file = File.new('ozimondo', 'w')
+    file.write <<-MONDO
+    --- 
+    host: ozmm.org
+    port: 80
+    cookie: crazy#RJrj3rhQ#ROHr3$TOhy4--
+    MONDO
+    file.close_write
+    assert_equal ['ozmm.org', 80, 'crazy#RJrj3rhQ#ROHr3$TOhy4--'], Oz.load_cache
+    FileUtils.rm 'ozimondo'
+  end
+
+  def test_write_host_to_cache
+    ENV['OZCACHE'] = 'ozicachedo'
+    Oz.write_to_cache(:host => 'ozmm.org')
+    assert_equal 'ozmm.org', YAML.load(File.read('ozicachedo'))['host']
+    FileUtils.rm 'ozicachedo'
+  end
+
+  def test_write_host_and_port_to_cache
+    ENV['OZCACHE'] = 'ozidom'
+    Oz.write_to_cache(:host => '127.0.0.1', :port => 3000)
+    assert_equal '127.0.0.1', YAML.load(File.read('ozidom'))['host']
+    assert_equal 3000, YAML.load(File.read('ozidom'))['port']
+    FileUtils.rm 'ozidom'
+  end
+
+  def test_load_cache_or_login
+    assert false
+  end
+
+  def test_cache_info_from_switch
+    assert false
+  end
+
+  def test_do_login_good
+    assert_equal 'ozimodo=cookiecookie', Oz.do_login('ozmm.org', 80, 'cookie', 'monster')
+  end
+
+  def test_parse_site_switch_good
+    args = %w[--site chris:jimmy@ozmm.org] 
+    assert_equal %w[ozmm.org chris jimmy] + [80], Oz.parse_site_switch(args.last)
+  end
+  
+  def test_parse_site_switch_with_http
+    args = %w[--site http://jimmy:chris@ozmm.org] 
+    assert_equal %w[ozmm.org jimmy chris] + [80], Oz.parse_site_switch(args.last)
+  end
+
+  def test_parse_site_switch_with_port
+    args = %w[--site http://local:host@ozmm.org:3000]
+    assert_equal %w[ozmm.org local host 3000], Oz.parse_site_switch(args.last)
+  end
+
+  def test_parse_site_switch_no_auth
+    args = %w[--site http://ozmm.org] 
+    assert_raises(BadFormatOfSiteSwitch) do
+      Oz.parse_site_switch(args.last)
+    end
+  end
+  
+  def test_parse_site_switch_bad
+    args = %w[--site chris!@ozmm.org] 
+    assert_raises(BadFormatOfSiteSwitch) do 
+      Oz.parse_site_switch(args.last)
+    end
+  end
+
+  def test_parse_login_switch
+    args = %w[--login chris:jimmy]
+    assert_equal %w[chris jimmy], Oz.parse_login_switch(args.last)
+  end
+
+  def test_parse_login_switch_bad
+    args = %w[--login chris!jimmy]
+    assert_raises(BadFormatOfLoginSwitch) do
+      Oz.parse_login_switch(args.last)
+    end
+  end
+
+  def test_parse_at_switch
+    args = %w[--at http://ozmm.org] 
+    assert_equal ['ozmm.org', 80], Oz.parse_at_switch(args)
+  end
+  
+  def test_parse_at_switch_with_port
+    args = %w[--at http://onepointzero.com:4000] 
+    assert_equal ['onepointzero.com', 4000], Oz.parse_at_switch(args)
+  end
+
+  def test_build_url_no_params
+    host = 'ozmm.org'
+    port = 80
+    args = %w[list]
+    assert_equal 'http://ozmm.org/api/list', Oz.build_url(host, port, args)
+  end
+
+  def test_build_url_in_subdirectory
+    host = 'modzer0.cs.uaf.edu/hank-log'
+    port = 3001
+    args = %w[list]
+    assert_equal 'http://modzer0.cs.uaf.edu:3001/hank-log/api/list', Oz.build_url(host, port, args)
+  end
+
+  def test_build_url_one_param
+    host = 'ozimodo.net'
+    port = 3000
+    args = %w[show 55]
+    assert_equal 'http://ozimodo.net:3000/api/show/55', Oz.build_url(host, port, args)
+  end
+
+  def test_build_url_to_post
+    host = 'ozmm.org'
+    port = 80
+    args = %w[image --src http://ozmm.org/puppy.jpg --alt aww --tags photo]
+    assert_equal 'http://ozmm.org/api/image?post[src]=http://ozmm.org/puppy.jpg&post[alt]=aww&post[tags]=photo',
+                 Oz.build_url(host, port, args)
+  end
+
+  def test_build_url_to_post_again
+    host = 'ozmm.org'
+    port = 80
+    args = %w[link --link http://hotchicks.com --quip babybaby!]
+    assert_equal 'http://ozmm.org/api/link?post[link]=http://hotchicks.com&post[quip]=babybaby!',
+                 Oz.build_url(host, port, args)
+  end
+
+  def test_build_url_to_post_is_escape
+    host = 'ozmm.org'
+    port = 80
+    args = %w[link --link http://hotchicks.com --quip] + ['baby baby!']
+    assert_equal 'http://ozmm.org/api/link?post[link]=http://hotchicks.com&post[quip]=baby%20baby!',
+                 Oz.build_url(host, port, args)
+  end
+
+  def test_build_headers
+    expected = { 'User-Agent' => USER_AGENT, 'Accept' => 'text/plain' }
+    assert_equal expected, Oz.build_headers
+  end
+
+  def test_stringify_keys_bang
+    hash = { :make => 'Apple', :model => 'Powerbook' }
+    hash.stringify_keys!
+    assert_equal %w[make model], hash.keys.sort
+  end
+
+  def test_clear_cache
+    $stdout = Tempfile.new('tmp')
+    ENV['OZCACHE'] = 'clearme'
+    FileUtils.touch 'clearme'
+    assert_equal true, File.exists?('clearme')
+    Oz.clear_cache
+    assert_equal false, File.exists?('clearme')
+  end
+
+  def test_check_switches_clear_cache
+    $stdout = StringIO.new
+    ENV['OZCACHE'] = 'clearme'
+    FileUtils.touch 'clearme'
+    assert_equal true, File.exists?('clearme')
+    Oz.check_oz_switches(%w[nothing new --clear-cache something else])
+    assert_equal false, File.exists?('clearme')
+    $stdout = STDOUT
+  end
+
+  def test_check_switches_debug_is_on
+    Oz.check_oz_switches(%w[list --debug leet haxor])
+    assert Oz.send(:class_variable_get, :@@debug)
+  end
+
+  def test_check_switches_help_prints_something
+    $tmpout, $stdout = '', StringIO.new
+    Kernel.send(:alias_method, :real_print, :print)
+    Kernel.send(:define_method, :print, proc { |s| $tmpout << s.to_s })
+    Oz.check_oz_switches(%w[idont commands --help])
+    assert /--site/ =~ $tmpout
+    assert /--debug/ =~ $tmpout
+    Kernel.send(:alias_method, :print, :real_print)
+    $stdout = STDOUT
+  end
+
+end
+
+module Net
+  class FakeResponse
+    attr_reader :header
+    def initialize(params, headers)
+      @header = { 'set-cookie' => 'ozimodo=cookiecookie; path=/' }
+    end
+  end
+  class HTTP
+    def post2(uri, params, headers)
+      FakeResponse.new(params, headers)
+    end
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: oz
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+date: 2006-07-11 00:00:00 -07:00
+summary: oz is a command line tumbler for ozimodo tumblelogs
+require_paths: 
+- lib
+email: chris@ozmm.org
+homepage: 
+- http://ozimodo.rubyforge.org
+- http://rubyforge.org/projects/ozimodo
+rubyforge_project: 
+description: oz is a command line tumbler for ozimodo tumblelogs.  Use it to query tumblelogs or post to your tumblelog from the command line.
+autorequire: 
+default_executable: oz
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Chris Wanstrath and Dayne Broderson
+files: 
+- README
+- bin/oz
+- test/test_oz.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: 
+- oz
+extensions: []
+
+requirements: []
+
+dependencies: []
+