twat 0.6.3 → 0.9.2

data/lib/twat/version.rb

@@ -0,0 +1,7 @@
+module Twat
+  VERSION_MAJOR = 0
+  VERSION_MINOR = 9
+  VERSION_PATCH = 2
+
+  VERSION = "#{VERSION_MAJOR}.#{VERSION_MINOR}.#{VERSION_PATCH}"
+end

data/man/twat.1

@@ -1,16 +1,19 @@
-.TH twat 1 "October 2011" "Rich Healey" ""
+.TH twat 1 "February 2012" "Rich Healey" ""
 .SH NAME
 twat \- a cli/ruby interface to twitter.
 .SH SYNOPSIS
-.B twat [-n account] <-a|-d|-l|-u [user]>
+.B twat [-n account] [follow|finger|config|add|delete|set|version]
 .B twat [-n account] tweet goes here
 .SH DESCRIPTION
 .B twat
 gives a simple interface to twitter from the command line.
 .SH USAGE
-generally, twat -an accountname will prompt you to authenticate via a given
-URL, and from that point on twat -n accountname "tweet" will post "tweet" to
-your twitter account.
+Configuration can be initially generated with
+.IP twat config
+and extended after this point with
+.IP twat add ACCOUNTNAME
+tweeting is achieved with
+.IP twat tweet goes here
 .SH OPTIONS
 .IP -n account
 Specify which account to connect with. If not specified, twat searches your

data/spec/argparse_spec.rb

@@ -0,0 +1,48 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Twat do
+
+  ["-n", "--account"].each do |flag|
+    it "Should respect the #{flag} flag" do #{{{
+      with_config(Fixtures::multiuser_config) do
+
+        set_argv [flag, "secondAccount"]
+
+        $args = ::Twat::Args.new
+        conf = ::Twat::Config.new
+
+        conf.account.should == Fixtures::multiuser_config[:accounts][:secondAccount]
+      end
+    end
+  end #}}}
+
+  ["-h", "--help"].each do |flag|
+    it "Should print help and bail on the #{flag} flag" do #{{{
+      set_argv [flag]
+
+      STDOUT.expects(:puts) # Getting the exact usage string TODO
+      lambda { args = ::Twat::Args.new }.should raise_error SystemExit
+    end #}}}
+  end
+
+  ["-v", "--version"].each do |flag|
+    it "Should print the version and exit on #{flag}" do #{{{
+      set_argv [flag]
+
+      STDOUT.expects(:puts).with("twat #{::Twat::VERSION}")
+      lambda { args = ::Twat::Args.new }.should raise_error SystemExit
+
+    end #}}}
+  end
+
+  it "Should print a nice error message when called with a nonexistant account" do #{{{
+    with_config(Fixtures::multiuser_config) do
+
+      set_argv ["-n", "nonexistantaccount", "rawr", "update"]
+
+      STDOUT.expects(:puts).with(Twat::Exceptions::NoSuchAccount.new.msg)
+      Twat::Twat.new.cli_run
+    end
+  end
+
+end

data/spec/helpers/environment.rb

@@ -0,0 +1,47 @@
+def set_argv(ary)
+  while ARGV.length > 0
+    ARGV.pop
+  end
+
+  ary.each { |e| ARGV << e }
+end
+
+def set_env(pairs)
+  orig = {}
+  begin
+    pairs.each do |k, v|
+      # TODO Check what happens when unsetting keys
+      orig[k] = ENV[k]
+      ENV[k] = v
+    end
+    yield
+  ensure
+    orig.each do |k, v|
+      ENV[k] = v
+    end
+  end
+end
+
+def with_config(cfg)
+  FileUtils.mktemp do |dir|
+    set_env('TWAT_CONFIG' => "#{dir}/twatrc") do
+      File.open("#{dir}/twatrc", 'w') do |conf|
+        conf.chmod(0600)
+        conf.puts(cfg.to_yaml)
+      end
+
+      yield
+
+    end
+  end
+end
+
+def with_no_config
+  FileUtils.mktemp do |dir|
+    set_env('TWAT_CONFIG' => "#{dir}/twatrc") do
+
+      yield
+
+    end
+  end
+end

data/spec/helpers/fileutils.rb

@@ -0,0 +1,18 @@
+require 'mktemp'
+module FileUtils extend self
+
+  include MkTemp
+
+  # Shamelessly poached from homebrew
+  def mktemp(opts={})
+    tmp_prefix = ENV['TWAT_TEMP'] || Dir.pwd
+    tmp=Pathname.new MkTemp.mktempdir("#{tmp_prefix}/twat_spec-XXXX")
+    raise "Couldn't create build sandbox" if not tmp.directory?
+    begin
+      yield tmp
+    ensure
+      tmp.rmtree unless opts[:clean] == false
+    end
+  end
+
+end

data/spec/helpers/fixtures/core.rb

@@ -0,0 +1,30 @@
+module Fixtures
+  extend self
+
+  def multiuser_config
+    { accounts: {
+      :rich0H =>
+      { oauth_token: "rich0h's token",
+        oauth_token_secret: "rich0H's secret",
+        endpoint: :twitter
+      },
+        :secondAccount =>
+      { oauth_token: "secondAccount's token",
+        oauth_token_secret: "secondAccount's secret",
+        endpoint: :twitter
+      }
+    },
+      :default => :rich0H
+    }
+  end
+
+  def valid_config
+    { accounts: {
+      :rich0H =>
+      { oauth_token: "I'mtotallyatokenbrah",
+        oauth_token_secret: "I'mtotallyasecretbrah",
+        endpoint: :twitter
+      } } }
+  end
+
+end

data/spec/helpers/fixtures/migrations.rb

@@ -0,0 +1,13 @@
+module Fixtures
+  module Migrations
+    extend self
+
+    def pre_v1
+      { :rich0H =>
+        { oauth_token: "I'mtotallyatokenbrah",
+          oauth_token_secret: "I'mtotallyasecretbrah",
+          endpoint: :twitter
+        } }
+    end
+  end
+end

data/spec/helpers/oauth.rb

@@ -0,0 +1,15 @@
+STUB_URL = "url"
+STUB_PIN = "1234"
+def mock_request_token
+  t = mock()
+  t.expects(:authorize_url).returns(STUB_URL)
+  t.expects(:get_access_token).with(oauth_verifier: STUB_PIN).returns(mock_access_token)
+  return t
+end
+
+def mock_access_token
+  t = mock()
+  t.expects(:token).returns("I'mtotallyatokenbrah")
+  t.expects(:secret).returns("I'mtotallyasecretbrah")
+  return t
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'twat'
+require 'mocha'
+
+require 'fileutils'
+
+Dir["#{File.expand_path(File.dirname(__FILE__))}/helpers/**/*.rb"].each do |f|
+  puts "Requiring #{f}"
+  require f
+end
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+end

data/spec/subcommands/add_spec.rb

@@ -0,0 +1,61 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Twat do
+
+  it "Should bail if add is called without an argument" do #{{{
+    set_argv ["add"]
+    STDOUT.expects(:puts).with(Twat::Subcommands::Add.usage)
+
+    lambda { Twat::Twat.new.cli_run }.should raise_error SystemExit
+  end #}}}
+
+  it "Should create a config file if one does not already exist" do #{{{
+    FileUtils.mktemp do |dir|
+      set_env('TWAT_CONFIG' => "#{dir}/twatrc") do
+        # stub out the io
+
+        STDOUT.expects(:puts).with("Please authenticate the application at #{STUB_URL}, then enter pin")
+        STDIN.expects(:gets).returns(STUB_PIN)
+
+        # Stub out any oauth calls that talk externally
+
+        OAuth::Consumer.any_instance.expects(:get_request_token).returns(mock_request_token)
+
+        set_argv ["add", "rich0H"]
+
+        Twat::Twat.new.cli_run
+
+        YAML.load_file(ENV['TWAT_CONFIG']).should == Fixtures::valid_config
+      end
+    end
+  end #}}}
+
+  it "Should call the twitter endpoint if specified" do #{{{
+    Twat::Endpoints::Twitter.any_instance.expects(:authorize_account)
+
+    set_argv ["--endpoint", "twitter", "add", "rich0H"]
+    Twat::Twat.new.cli_run
+  end #}}}
+
+  it "Should call the identi.ca endpoint if specified" do #{{{
+    Twat::Endpoints::Identica.any_instance.expects(:authorize_account)
+
+    set_argv ["--endpoint", "identi.ca", "add", "rich0H"]
+    Twat::Twat.new.cli_run
+  end #}}}
+
+  it "Should call the twitter endpoint by default" do #{{{
+    Twat::Endpoints::Twitter.any_instance.expects(:authorize_account)
+
+    set_argv ["add", "rich0H"]
+    Twat::Twat.new.cli_run
+  end #}}}
+
+  it "Should fail if asked for an invalid endpoint" do #{{{
+    STDOUT.expects(:puts).with(Twat::Exceptions::NoSuchEndpoint.new.msg)
+
+    set_argv ["--endpoint", "rawk", "add", "rich0H"]
+    Twat::Twat.new.cli_run
+  end #}}}
+
+end

data/spec/subcommands/config_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Twat do
+
+  it "Should bail if config already exists" do #{{{
+    with_config(Fixtures::multiuser_config) do
+      STDOUT.expects(:puts).with(Twat::Exceptions::AlreadyConfigured.new.msg)
+      set_argv ["config"]
+      Twat::Twat.new.cli_run
+    end
+  end #}}}
+
+end

data/spec/subcommands/delete_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Twat do
+
+  it "Should bail if delete is called without an argument" do #{{{
+    set_argv ["delete"]
+    STDOUT.expects(:puts).with(Twat::Subcommands::Delete.usage)
+
+    lambda { Twat::Twat.new.cli_run }.should raise_error SystemExit
+  end #}}}
+
+end

data/spec/subcommands/finger_spec.rb

@@ -0,0 +1,41 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Twat do
+
+  it "Should bail if finger is called without an argument" do #{{{
+    with_config(Fixtures::multiuser_config) do
+      set_argv ["finger"]
+      STDOUT.expects(:puts).with(Twat::Subcommands::Finger.usage)
+
+      lambda { Twat::Twat.new.cli_run }.should raise_error SystemExit
+    end
+  end #}}}
+
+  it "Should retrieve a tweet for user if called with only a user" do #{{{
+    with_config(Fixtures::multiuser_config) do
+      tweet = mock()
+      tweet.expects(:each).yields(tweet)
+      Twitter.expects(:user_timeline).with("hanke", :count => 1).returns(tweet)
+      Twat::Subcommands::Finger.any_instance.expects(:format).with(tweet)
+
+      set_argv ["finger", "hanke"]
+
+      STDOUT.expects(:puts)
+      Twat::Twat.new.cli_run
+    end
+  end #}}}
+
+  it "Should retrieve n tweets for user if invoked with count" do #{{{
+    with_config(Fixtures::multiuser_config) do
+      tweet = mock()
+      Twitter.expects(:user_timeline).with("hanke", :count => 3).returns([tweet, tweet, tweet])
+      Twat::Subcommands::Finger.any_instance.expects(:format).with(tweet).times(3)
+
+      set_argv ["finger", "hanke", "3"]
+
+      STDOUT.expects(:puts).times(3)
+      Twat::Twat.new.cli_run
+    end
+  end #}}}
+
+end

data/spec/subcommands/follow_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Twat do
+
+  it "Should bail if follow is called without an argument" do #{{{
+    set_argv ["follow"]
+    STDOUT.expects(:puts).with(Twat::Subcommands::Follow.usage)
+
+    lambda { Twat::Twat.new.cli_run }.should raise_error SystemExit
+  end #}}}
+
+end

data/spec/subcommands/follow_tag_spec.rb

@@ -0,0 +1,52 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Twat do
+
+  it "Should search home_timeline when called sans args" do #{{{
+    with_config(Fixtures::multiuser_config) do
+      Twitter.expects(:home_timeline)
+      Twat::Subcommands::FollowTag.any_instance.expects(:untested).returns(false).at_least_once
+      set_argv []
+
+      # lambda { Twat::Twat.new.cli_run }.should raise_error SystemExit
+      Twat::Twat.new.cli_run
+    end
+  end #}}}
+
+  it "Should search home_timeline when called as follow_tag" do #{{{
+    with_config(Fixtures::multiuser_config) do
+      Twitter.expects(:home_timeline)
+      Twat::Subcommands::FollowTag.any_instance.expects(:untested).returns(false).at_least_once
+      set_argv ["follow_tag"]
+
+      # lambda { Twat::Twat.new.cli_run }.should raise_error SystemExit
+      Twat::Twat.new.cli_run
+    end
+  end #}}}
+
+  it "Should call search with the argument if called with one" do #{{{
+    with_config(Fixtures::multiuser_config) do
+      mock_opts = mock()
+      Twitter.expects(:search).with("#hackmelb", count: 5)
+      Twat::Subcommands::FollowTag.any_instance.expects(:untested).returns(false).at_least_once
+      set_argv ["follow_tag", "#hackmelb"]
+
+      # lambda { Twat::Twat.new.cli_run }.should raise_error SystemExit
+      Twat::Twat.new.cli_run
+    end
+  end #}}}
+
+  it "Should cat together all commandline args" do #{{{
+    with_config(Fixtures::multiuser_config) do
+      mock_opts = mock()
+      Twitter.expects(:search).with("#hackmelb richo", count: 5)
+      Twat::Subcommands::FollowTag.any_instance.expects(:untested).returns(false).at_least_once
+      set_argv ["follow_tag", "#hackmelb", "richo"]
+
+      # lambda { Twat::Twat.new.cli_run }.should raise_error SystemExit
+      Twat::Twat.new.cli_run
+    end
+  end #}}}
+
+
+end

data/spec/subcommands/list_spec.rb

@@ -0,0 +1,8 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Twat do
+
+  it "Should bail if add is called without an argument" do #{{{
+  end #}}}
+
+end

data/spec/subcommands/mentions_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Twat do
+
+  it "Should search recent mentions" do #{{{
+    with_config(Fixtures::multiuser_config) do
+      Twitter.expects(:mentions)
+      Twat::Subcommands::Mentions.any_instance.expects(:untested).returns(false).at_least_once
+      set_argv ["mentions"]
+
+      Twat::Twat.new.cli_run
+    end
+  end #}}}
+
+  it "Should bail if called with arguments" do #{{{
+    with_config(Fixtures::multiuser_config) do
+      STDOUT.expects(:puts).with(Twat::Subcommands::Mentions.usage)
+      set_argv ["mentions", "rawr"]
+
+      lambda { Twat::Twat.new.cli_run }.should raise_error SystemExit
+    end
+  end #}}}
+
+end