twurl 0.6.0

data/test/cli_options_test.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class Twurl::Options::Test < Test::Unit::TestCase
+  attr_reader :options
+  def setup
+    @options = Twurl::Options.new
+  end
+
+  def test_base_url_is_built_from_protocol_and_host
+    options.protocol = 'http'
+    options.host     = 'api.twitter.com'
+
+    assert_equal 'http://api.twitter.com', options.base_url
+  end
+
+  def test_ssl_is_enabled_if_the_protocol_is_https
+    options.protocol = 'http'
+    assert !options.ssl?
+
+    options.protocol = 'https'
+    assert options.ssl?
+  end
+end

data/test/cli_test.rb

@@ -0,0 +1,129 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class Twurl::CLI::OptionParsingTest < Test::Unit::TestCase
+  module CommandParsingTests
+    def test_no_command_specified_falls_to_default_command
+      options = Twurl::CLI.parse_options(['/1/url/does/not/matter.xml'])
+      assert_equal Twurl::CLI::DEFAULT_COMMAND, options.command
+    end
+
+    def test_supported_command_specified_extracts_the_command
+      expected_command = Twurl::CLI::SUPPORTED_COMMANDS.first
+      options = Twurl::CLI.parse_options([expected_command])
+      assert_equal expected_command, options.command
+    end
+
+    def test_unsupported_command_specified_sets_default_command
+      unsupported_command = 'unsupported'
+      options = Twurl::CLI.parse_options([unsupported_command])
+      assert_equal Twurl::CLI::DEFAULT_COMMAND, options.command
+    end
+  end
+  include CommandParsingTests
+
+  module RequestMethodParsingTests
+    def test_request_method_is_default_if_unspecified
+      options = Twurl::CLI.parse_options(['/1/url/does/not/matter.xml'])
+      assert_equal Twurl::Options::DEFAULT_REQUEST_METHOD, options.request_method
+    end
+
+    def test_specifying_a_request_method_extracts_and_normalizes_request_method
+      variations = [%w[-X put], %w[-X PUT], %w[--request-method PUT], %w[--request-method put]]
+      variations.each do |option_variation|
+        path = '/1/url/does/not/matter.xml'
+        order_variant_1 = [option_variation, path].flatten
+        order_variant_2 = [path, option_variation].flatten
+        [order_variant_1, order_variant_2].each do |args|
+          options = Twurl::CLI.parse_options(args)
+          assert_equal 'put', options.request_method
+        end
+      end
+    end
+
+    def test_specifying_unsupported_request_method_returns_an_error
+      Twurl::CLI.parse_options(['-X', 'UNSUPPORTED'])
+    end
+  end
+  include RequestMethodParsingTests
+
+  module OAuthClientOptionParsingTests
+    def test_extracting_the_consumer_key
+      mock(Twurl::CLI).prompt_for('Consumer key').never
+
+      options = Twurl::CLI.parse_options(['-c', 'the-key'])
+      assert_equal 'the-key', options.consumer_key
+    end
+
+    def test_consumer_key_option_with_no_value_prompts_user_for_value
+      mock(Twurl::CLI).prompt_for('Consumer key').times(1) { 'inputted-key'}
+      options = Twurl::CLI.parse_options(['-c'])
+      assert_equal 'inputted-key', options.consumer_key
+    end
+  end
+  include OAuthClientOptionParsingTests
+
+  module DataParsingTests
+    def test_extracting_a_single_key_value_pair
+      options = Twurl::CLI.parse_options(['-d', 'key=value'])
+      assert_equal({'key' => 'value'}, options.data)
+
+      options = Twurl::CLI.parse_options(['--data', 'key=value'])
+      assert_equal({'key' => 'value'}, options.data)
+    end
+
+    def test_passing_data_and_no_explicit_request_method_defaults_request_method_to_post
+      options = Twurl::CLI.parse_options(['-d', 'key=value'])
+      assert_equal 'post', options.request_method
+    end
+
+    def test_passing_data_and_an_explicit_request_method_uses_the_specified_method
+      options = Twurl::CLI.parse_options(['-d', 'key=value', '-X', 'DELETE'])
+      assert_equal({'key' => 'value'}, options.data)
+      assert_equal 'delete', options.request_method
+    end
+
+    def test_multiple_pairs_when_option_is_specified_multiple_times_on_command_line_collects_all
+      options = Twurl::CLI.parse_options(['-d', 'key=value', '-d', 'another=pair'])
+      assert_equal({'key' => 'value', 'another' => 'pair'}, options.data)
+    end
+
+    def test_multiple_pairs_separated_by_ampersand_are_all_captured
+      options = Twurl::CLI.parse_options(['-d', 'key=value&another=pair'])
+      assert_equal({'key' => 'value', 'another' => 'pair'}, options.data)
+    end
+  end
+  include DataParsingTests
+
+  module SSLDisablingTests
+    def test_ssl_is_on_by_default
+      options = Twurl::CLI.parse_options([])
+      assert options.ssl?
+    end
+
+    def test_passing_no_ssl_option_disables_ssl
+      ['-U', '--no-ssl'].each do |switch|
+        options = Twurl::CLI.parse_options([switch])
+        assert !options.ssl?
+      end
+    end
+  end
+  include SSLDisablingTests
+
+  module HostOptionTests
+    def test_not_specifying_host_sets_it_to_the_default
+      options = Twurl::CLI.parse_options([])
+      assert_equal Twurl::Options::DEFAULT_HOST, options.host
+    end
+
+    def test_setting_host_updates_to_requested_value
+      custom_host = 'localhost:3000'
+      assert_not_equal Twurl::Options::DEFAULT_HOST, custom_host
+
+      [['-H', custom_host], ['--host', custom_host]].each do |option_combination|
+        options = Twurl::CLI.parse_options(option_combination)
+        assert_equal custom_host, options.host
+      end
+    end
+  end
+  include HostOptionTests
+end

data/test/configuration_controller_test.rb

@@ -0,0 +1,44 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class Twurl::ConfigurationController::DispatchTest < Test::Unit::TestCase
+  def test_error_message_is_displayed_if_setting_is_unrecognized
+    options = Twurl::Options.test_exemplar
+    client  = Twurl::OAuthClient.test_exemplar
+
+    options.subcommands = ['unrecognized', 'value']
+
+    mock(Twurl::CLI).puts(Twurl::ConfigurationController::UNRECOGNIZED_SETTING_MESSAGE % 'unrecognized').times(1)
+    mock(Twurl::OAuthClient.rcfile).save.times(0)
+
+    controller = Twurl::ConfigurationController.new(client, options)
+    controller.dispatch
+  end
+end
+
+class Twurl::ConfigurationController::DispatchDefaultSettingTest < Test::Unit::TestCase
+  def test_setting_default_profile_just_by_username
+    options = Twurl::Options.test_exemplar
+    client  = Twurl::OAuthClient.test_exemplar
+
+    options.subcommands = ['default', client.username]
+    mock(Twurl::OAuthClient).load_client_for_username(client.username).times(1) { client }
+    mock(Twurl::OAuthClient.rcfile).default_profile = client
+    mock(Twurl::OAuthClient.rcfile).save.times(1)
+
+    controller = Twurl::ConfigurationController.new(client, options)
+    controller.dispatch
+  end
+
+  def test_setting_default_profile_by_username_and_consumer_key
+    options = Twurl::Options.test_exemplar
+    client  = Twurl::OAuthClient.test_exemplar
+
+    options.subcommands = ['default', client.username, client.consumer_key]
+    mock(Twurl::OAuthClient).load_client_for_username_and_consumer_key(client.username, client.consumer_key).times(1) { client }
+    mock(Twurl::OAuthClient.rcfile).default_profile = client
+    mock(Twurl::OAuthClient.rcfile).save.times(1)
+
+    controller = Twurl::ConfigurationController.new(client, options)
+    controller.dispatch
+  end
+end

data/test/oauth_client_test.rb

@@ -0,0 +1,162 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class Twurl::OAuthClient::AbstractOAuthClientTest < Test::Unit::TestCase
+  attr_reader :client, :options
+  def setup
+    Twurl::OAuthClient.instance_variable_set(:@rcfile, nil)
+
+    @options                = Twurl::Options.test_exemplar
+    @client                 = Twurl::OAuthClient.test_exemplar
+    options.base_url        = 'api.twitter.com'
+    options.request_method  = 'get'
+    options.path            = '/path/does/not/matter.xml'
+    options.data            = {}
+
+    Twurl.options           = options
+  end
+
+  def teardown
+    super
+    Twurl.options = Twurl::Options.new
+    # Make sure we don't do any disk IO in these tests
+    assert !File.exists?(Twurl::RCFile.file_path)
+  end
+
+  def test_nothing
+    # Appeasing test/unit
+  end
+end
+
+class Twurl::OAuthClient::BasicRCFileLoadingTest < Twurl::OAuthClient::AbstractOAuthClientTest
+  def test_rcfile_is_memoized
+    mock.proxy(Twurl::RCFile).new.times(1)
+
+    Twurl::OAuthClient.rcfile
+    Twurl::OAuthClient.rcfile
+  end
+
+  def test_forced_reloading
+    mock.proxy(Twurl::RCFile).new.times(2)
+
+    Twurl::OAuthClient.rcfile
+    Twurl::OAuthClient.rcfile(:reload)
+    Twurl::OAuthClient.rcfile
+  end
+end
+
+class Twurl::OAuthClient::ClientLoadingFromOptionsTest < Twurl::OAuthClient::AbstractOAuthClientTest
+  def test_if_username_is_supplied_and_no_profile_exists_for_username_then_new_client_is_created
+    mock(Twurl::OAuthClient).load_client_for_username(options.username).never
+    mock(Twurl::OAuthClient).load_new_client_from_options(options).times(1)
+    mock(Twurl::OAuthClient).load_default_client.never
+
+    Twurl::OAuthClient.load_from_options(options)
+  end
+
+  def test_if_username_is_supplied_and_profile_exists_for_username_then_client_is_loaded
+    mock(Twurl::OAuthClient.rcfile).save.times(1)
+    Twurl::OAuthClient.rcfile << client
+
+    mock(Twurl::OAuthClient).load_client_for_username_and_consumer_key(options.username, options.consumer_key).times(1)
+    mock(Twurl::OAuthClient).load_new_client_from_options(options).never
+    mock(Twurl::OAuthClient).load_default_client.never
+
+    Twurl::OAuthClient.load_from_options(options)
+  end
+
+  def test_if_username_is_not_provided_then_the_default_client_is_loaded
+    options.username = nil
+
+    mock(Twurl::OAuthClient).load_client_for_username(options.username).never
+    mock(Twurl::OAuthClient).load_new_client_from_options(options).never
+    mock(Twurl::OAuthClient).load_default_client.times(1)
+
+    Twurl::OAuthClient.load_from_options(options)
+  end
+end
+
+class Twurl::OAuthClient::ClientLoadingForUsernameTest < Twurl::OAuthClient::AbstractOAuthClientTest
+  def test_attempting_to_load_a_username_that_is_not_in_the_file_fails
+    assert_nil Twurl::OAuthClient.rcfile[client.username]
+
+    assert_raises Twurl::Exception do
+      Twurl::OAuthClient.load_client_for_username_and_consumer_key(client.username, client.consumer_key)
+    end
+  end
+
+  def test_loading_a_username_that_exists
+    mock(Twurl::OAuthClient.rcfile).save.times(1)
+
+    Twurl::OAuthClient.rcfile << client
+
+    client_from_file = Twurl::OAuthClient.load_client_for_username_and_consumer_key(client.username, client.consumer_key)
+    assert_equal client.to_hash, client_from_file.to_hash
+  end
+end
+
+class Twurl::OAuthClient::DefaultClientLoadingTest < Twurl::OAuthClient::AbstractOAuthClientTest
+  def test_loading_default_client_when_there_is_none_fails
+    assert_nil Twurl::OAuthClient.rcfile.default_profile
+
+    assert_raises Twurl::Exception do
+      Twurl::OAuthClient.load_default_client
+    end
+  end
+
+  def test_loading_default_client_from_file
+    mock(Twurl::OAuthClient.rcfile).save.times(1)
+
+    Twurl::OAuthClient.rcfile << client
+    assert_equal [client.username, client.consumer_key], Twurl::OAuthClient.rcfile.default_profile
+
+    client_from_file = Twurl::OAuthClient.load_default_client
+
+    assert_equal client.to_hash, client_from_file.to_hash
+  end
+end
+
+class Twurl::OAuthClient::NewClientLoadingFromOptionsTest < Twurl::OAuthClient::AbstractOAuthClientTest
+  attr_reader :new_client
+  def setup
+    super
+    @new_client = Twurl::OAuthClient.load_new_client_from_options(options)
+  end
+
+  def test_password_is_included
+    assert_equal options.password, new_client.password
+  end
+
+  def test_oauth_options_are_passed_through
+    assert_equal client.to_hash, new_client.to_hash
+  end
+end
+
+class Twurl::OAuthClient::PerformingRequestsFromOptionsTest < Twurl::OAuthClient::AbstractOAuthClientTest
+  def test_request_is_made_using_request_method_and_path_and_data_in_options
+    client = Twurl::OAuthClient.test_exemplar
+    mock(client).get(options.path, options.data)
+
+    client.perform_request_from_options(options)
+  end
+end
+
+class Twurl::OAuthClient::CredentialsForAccessTokenExchangeTest < Twurl::OAuthClient::AbstractOAuthClientTest
+  def test_successful_exchange_parses_token_and_secret_from_response_body
+    parsed_response = {:oauth_token        => "123456789",
+                       :oauth_token_secret => "abcdefghi",
+                       :user_id            => "3191321",
+                       :screen_name        => "noradio",
+                       :x_auth_expires     => "0"}
+
+    mock(client.consumer).
+      token_request(:post,
+                    client.consumer.access_token_path,
+                    nil,
+                    {},
+                    client.client_auth_parameters) { parsed_response }
+
+   assert client.needs_to_authorize?
+   client.exchange_credentials_for_access_token
+   assert !client.needs_to_authorize?
+  end
+end

data/test/rcfile_test.rb

@@ -0,0 +1,141 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class Twurl::RCFile::PathConstructionTest < Test::Unit::TestCase
+  def test_file_path_appends_file_to_directory
+    assert_equal File.join(Twurl::RCFile.directory, Twurl::RCFile::FILE), Twurl::RCFile.file_path
+  end
+end
+
+class Twurl::RCFile::LoadingTest < Test::Unit::TestCase
+  def test_load_parses_and_loads_file_if_it_exists
+    mock(YAML).load_file(Twurl::RCFile.file_path).times(1)
+    mock(Twurl::RCFile).default_rcfile_structure.never
+
+    Twurl::RCFile.load
+  end
+
+  def test_load_returns_default_file_structure_if_file_does_not_exist
+    mock(YAML).load_file(Twurl::RCFile.file_path) { raise Errno::ENOENT }.times(1)
+    mock(Twurl::RCFile).default_rcfile_structure.times(1)
+
+    Twurl::RCFile.load
+  end
+end
+
+class Twurl::RCFile::InitializationTest < Test::Unit::TestCase
+  def test_initializing_when_the_file_does_not_exist_loads_default_rcfile_structure
+    mock(YAML).load_file(Twurl::RCFile.file_path) { raise Errno::ENOENT }.times(1)
+
+    rcfile = Twurl::RCFile.new
+    assert_equal Twurl::RCFile.default_rcfile_structure, rcfile.data
+  end
+
+  def test_initializing_when_the_file_does_exists_loads_content_of_file
+    mock_content_of_rcfile = {'this data' => 'does not matter'}
+    mock(YAML).load_file(Twurl::RCFile.file_path) { mock_content_of_rcfile }.times(1)
+    mock(Twurl::RCFile).default_rcfile_structure.never
+
+    rcfile = Twurl::RCFile.new
+    assert_equal mock_content_of_rcfile, rcfile.data
+  end
+end
+
+class Twurl::RCFile::DefaultProfileFromDefaultRCFileTest < Test::Unit::TestCase
+  attr_reader :rcfile
+  def setup
+    mock(YAML).load_file(Twurl::RCFile.file_path) { raise Errno::ENOENT }.times(1)
+    mock.proxy(Twurl::RCFile).default_rcfile_structure.times(any_times)
+
+    @rcfile = Twurl::RCFile.new
+  end
+
+  def test_default_rcfile_structure_has_no_default_profile
+    assert_nil rcfile.default_profile
+  end
+
+  def test_rcfile_is_considered_empty_at_first
+    assert rcfile.empty?
+  end
+
+  def test_setting_default_profile
+    options  = Twurl::Options.test_exemplar
+
+    client = Twurl::OAuthClient.load_new_client_from_options(options)
+    rcfile.default_profile = client
+    assert_equal [options.username, options.consumer_key], rcfile.default_profile
+  end
+end
+
+class Twurl::RCFile::UpdatingTest < Test::Unit::TestCase
+  attr_reader :rcfile
+  def setup
+    mock(YAML).load_file(Twurl::RCFile.file_path) { raise Errno::ENOENT }.times(1)
+
+    @rcfile = Twurl::RCFile.new
+    assert rcfile.profiles.empty?
+    assert_nil rcfile.default_profile
+    mock(rcfile).save.times(any_times)
+  end
+
+  def test_adding_the_first_client_sets_it_as_default_profile
+    client = Twurl::OAuthClient.test_exemplar
+
+    rcfile << client
+    assert_equal [client.username, client.consumer_key], rcfile.default_profile
+    assert rcfile.has_oauth_profile_for_username_with_consumer_key?(client.username, client.consumer_key)
+    assert_equal({client.username => {client.consumer_key => client.to_hash}}, rcfile.profiles)
+  end
+
+  def test_adding_additional_clients_does_not_change_default_profile
+    first_client = Twurl::OAuthClient.test_exemplar
+
+    rcfile << first_client
+    assert_equal [first_client.username, first_client.consumer_key], rcfile.default_profile
+    assert rcfile.has_oauth_profile_for_username_with_consumer_key?(first_client.username, first_client.consumer_key)
+
+    additional_client = Twurl::OAuthClient.test_exemplar(:username => 'additional_exemplar_username')
+
+    rcfile << additional_client
+    assert_equal [first_client.username, first_client.consumer_key], rcfile.default_profile
+    assert rcfile.has_oauth_profile_for_username_with_consumer_key?(additional_client.username, additional_client.consumer_key)
+
+    expected_profiles = {
+      first_client.username      => {first_client.consumer_key      => first_client.to_hash},
+      additional_client.username => {additional_client.consumer_key => additional_client.to_hash}
+    }
+
+    assert_equal expected_profiles, rcfile.profiles
+  end
+end
+
+class Twurl::RCFile::SavingTest < Test::Unit::TestCase
+  attr_reader :rcfile
+  def setup
+    delete_rcfile
+    assert !rcfile_exists?
+    @rcfile = Twurl::RCFile.new
+    assert !rcfile_exists?
+  end
+
+  def teardown
+    super
+    delete_rcfile
+  end
+
+  def test_save_writes_profiles_to_disk
+    client = Twurl::OAuthClient.test_exemplar
+    rcfile << client
+    assert rcfile_exists?
+  end
+
+  private
+    def rcfile_exists?
+      File.exists?(Twurl::RCFile.file_path)
+    end
+
+    def delete_rcfile
+      File.unlink(Twurl::RCFile.file_path)
+    rescue Errno::ENOENT
+      # Do nothing
+    end
+end