twurl 0.6.0

data/COPYING

@@ -0,0 +1,18 @@
+# Copyright (c) 2009 Marcel Molina <marcel@twitter.com>, Twitter, Inc.
+#
+# 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/INSTALL

@@ -0,0 +1,18 @@
++-----------------------+
+| Install with RubyGems |
++-----------------------+
+
+  sudo gem i twurl --source http://rubygems.org
+
++---------------------+
+| Install from source |
++---------------------+
+
+  rake dist:gem
+  sudo gem i pkg/twurl*gem
+
++--------------+
+| Dependencies |
++--------------+
+
+  sudo gem i oauth

data/README

@@ -0,0 +1,119 @@
++-------+
+| Twurl |
++-------+
+
+Twurl is like curl, but tailored specifically for the Twitter API.
+It knows how to grant an access token to a client application for
+a specified user and then sign all requests with that access token.
+
+It also provides other development and debugging conveniences such
+as defining aliases for common requests, as well as support for
+multiple access tokens to easily switch between different client
+applications and Twitter accounts.
+
++-----------------+
+| Getting Started |
++-----------------+
+
+The first thing you have to do is register an OAuth application
+to get a consumer key and secret.
+
+  http://dev.twitter.com/apps/new
+
+When you have your consumer key and its secret you authorize
+your Twitter account to make API requests with your consumer key
+and secret.
+
+  % twurl authorize --consumer-key the_key       \
+                    --consumer-secret the_secret
+
+This will return an URL that you should open up in your browser.
+Authenticate to Twitter, and then enter the returned PIN back into
+the terminal.  Assuming all that works well, you will beauthorized
+to make requests with the API. Twurl will tell you as much.
+
+If your consumer application has xAuth enabled, then you can use
+a variant of the above
+
+  % twurl authorize -u username -p password      \
+                    --consumer-key the_key       \
+                    --consumer-secret the_secret
+
+And, again assuming your username, password, key and secret is
+correct, will authorize you in one step.
+
++-----------------+
+| Making Requests |
++-----------------+
+
+The simplest request just requires that you specify the path you
+want to request.
+
+  % twurl /1/statuses/home_timeline.xml
+
+Similar to curl, a GET request is performed by default.
+
+You can implicitly perform a POST request by passing the -d option,
+which specifies POST parameters.
+
+  % twurl -d 'status=Testing twurl' /1/statuses/update.xml
+
+You can explicitly specify what request method to perform with
+the -X (or --request-method) option.
+
+  % twurl -X DELETE /1/statuses/destroy/123456.xml
+
++------------------+
+| Creating aliases |
++------------------+
+
+  % twurl alias h /1/statuses/home_timeline.xml
+
+You can then use "h" in place of the full path.
+
+  % twurl h
+
+Paths that require additional options such as request parameters for example can
+be used with aliases the same as with full explicit paths, just as you might
+expect.
+
+  % twurl alias tweet /1/statuses/update.xml
+  % twurl tweet -d "status=Aliases in twurl are convenient"
+
++-------------------------------+
+| Changing your default profile |
++-------------------------------+
+
+The first time you authorize a client application to make requests on behalf of your account, twurl stores your access token information in its .twurlrc file. Subsequent requests will use this profile as the default profile. You can use the 'accounts' subcommand to see what client applications have been authorized for what user names:
+
+  % twurl accounts
+  noradio
+    HQsAGcBm5MQT4n6j7qVJw
+    hhC7Koy2zRsTZvQh1hVlSA (default)
+  testiverse
+    guT9RsJbNQgVe6AwoY9BA
+
+Notice that one of those consumer keys is marked as the default. To change the default use the 'set' subcommand, passing then either just the username, if it's unambiguous, or the username and consumer key pair if it isn't unambiguous:
+
+  % twurl set default testiverse
+  % twurl accounts
+  noradio
+    HQsAGcBm5MQT4n6j7qVJw
+    hhC7Koy2zRsTZvQh1hVlSA
+  testiverse
+    guT9RsJbNQgVe6AwoY9BA (default)
+
+  % twurl set default noradio HQsAGcBm5MQT4n6j7qVJw
+  % twurl accounts
+  noradio
+    HQsAGcBm5MQT4n6j7qVJw (default)
+    hhC7Koy2zRsTZvQh1hVlSA
+  testiverse
+    guT9RsJbNQgVe6AwoY9BA
+
++--------------+
+| Contributors |
++--------------+
+
+Marcel Molina <marcel@twitter.com> / @noradio
+Raffi Krikorian <raffi@twitter.com> / @raffi

data/Rakefile

@@ -0,0 +1,72 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/gempackagetask'
+
+require File.dirname(__FILE__) + '/lib/twurl'
+
+library_root = File.dirname(__FILE__)
+
+task :default => :test
+
+Rake::TestTask.new do |test|
+  test.pattern = 'test/*_test.rb'
+  test.verbose = true
+end
+
+namespace :test do
+  desc "Analyze test coverage"
+  task :coverage do
+    system("rcov -x Library -x support --sort coverage #{File.join(library_root, 'test/*_test.rb')}")
+    system("open #{File.join(library_root, 'coverage/index.html')}") if PLATFORM['darwin']
+  end
+
+  namespace :coverage do
+    desc "Remove artifacts generated from coverage analysis"
+    task :clobber do
+      rm_r 'coverage' rescue nil
+    end
+  end
+end
+
+namespace :dist do
+  spec = Gem::Specification.new do |s|
+    s.name              = 'twurl'
+    s.version           = Gem::Version.new(Twurl::Version)
+    s.summary           = "Curl for the Twitter API"
+    s.description       = s.summary
+    s.email             = ['marcel@twitter.com', 'raffi@twitter.com']
+    s.authors           = ['Marcel Molina', 'Raffi Krikorian']
+    s.has_rdoc          = true
+    s.extra_rdoc_files  = %w(README COPYING INSTALL)
+    s.homepage          = 'http://github.com/marcel/twurl'
+    s.rubyforge_project = 'twurl'
+    s.files             = FileList['Rakefile', 'lib/**/*.rb', 'bin/*']
+    s.executables       << 'twurl'
+    s.test_files        = Dir['test/**/*']
+
+    s.add_dependency 'oauth'
+    s.rdoc_options  = ['--title', "twurl -- OAuth-enabled curl for the Twitter API",
+                       '--main',  'README',
+                       '--line-numbers', '--inline-source']
+  end
+
+  Rake::GemPackageTask.new(spec) do |pkg|
+    pkg.need_tar_gz = true
+    pkg.package_files.include('{lib,bin,test}/**/*')
+    pkg.package_files.include('README')
+    pkg.package_files.include('COPYING')
+    pkg.package_files.include('INSTALL')
+    pkg.package_files.include('Rakefile')
+  end
+
+  task :spec do
+    puts spec.to_ruby
+  end
+
+  desc "Unpack current version of library into the twitter.com vendor directory"
+  task :unpack_to_vendor => :repackage do
+    cd 'pkg'
+    system("gem unpack '#{spec.name}-#{spec.version}.gem' --target=$TWITTER/vendor/gems")
+  end
+end

data/bin/twurl

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../lib/twurl'
+
+Twurl::CLI.run(ARGV)

data/lib/twurl.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'oauth'
+require 'optparse'
+require 'ostruct'
+require 'stringio'
+require 'yaml'
+
+library_files = Dir[File.join(File.dirname(__FILE__), "/twurl/**/*.rb")]
+library_files.each do |file|
+  require file
+end
+
+module Twurl
+  @options ||= Options.new
+  class << self
+    attr_accessor :options
+  end
+
+  class Exception < ::Exception
+  end
+end

data/lib/twurl/abstract_command_controller.rb

@@ -0,0 +1,16 @@
+module Twurl
+  # Subclasses need to implement a `dispatch' instance method.
+  class AbstractCommandController
+    attr_reader :client, :options
+    class << self
+      def dispatch(*args, &block)
+        new(*args, &block).dispatch
+      end
+    end
+
+    def initialize(client, options)
+      @client  = client
+      @options = options
+    end
+  end
+end

data/lib/twurl/account_information_controller.rb

@@ -0,0 +1,22 @@
+module Twurl
+  class AccountInformationController < AbstractCommandController
+    NO_AUTHORIZED_ACCOUNTS_MESSAGE = "No authorized accounts"
+
+    def dispatch
+      rcfile = OAuthClient.rcfile
+      if rcfile.empty?
+        CLI.puts NO_AUTHORIZED_ACCOUNTS_MESSAGE
+      else
+        profiles = rcfile.profiles
+        profiles.keys.sort.each do |account_name|
+          CLI.puts account_name
+          profiles[account_name].each do |consumer_key, _|
+            account_summary = "  #{consumer_key}"
+            account_summary << " (default)" if rcfile.default_profile == [account_name, consumer_key]
+            CLI.puts account_summary
+          end
+        end
+      end
+    end
+  end
+end

data/lib/twurl/aliases_controller.rb

@@ -0,0 +1,25 @@
+module Twurl
+  class AliasesController < AbstractCommandController
+    NO_ALIASES_MESSAGE       = "No aliases exist. Set one this way: twurl alias h /1/statuses/home_timeline.xml"
+    NO_PATH_PROVIDED_MESSAGE = "No path was provided to alias. Paths must start with a forward slash (ex. /1/statuses/update.xml)."
+    def dispatch
+      case options.subcommands.size
+      when 0
+        aliases = OAuthClient.rcfile.aliases
+        if aliases && !aliases.empty?
+          aliases.keys.sort.each do |name|
+            CLI.puts "#{name}: #{aliases[name]}"
+          end
+        else
+          CLI.puts NO_ALIASES_MESSAGE
+        end
+      when 1
+        if options.path
+          OAuthClient.rcfile.alias(options.subcommands.first, options.path)
+        else
+          CLI.puts NO_PATH_PROVIDED_MESSAGE
+        end
+      end
+    end
+  end
+end

data/lib/twurl/authorization_controller.rb

@@ -0,0 +1,13 @@
+module Twurl
+  class AuthorizationController < AbstractCommandController
+    AUTHORIZATION_FAILED_MESSAGE    = "Authorization failed. Check that your consumer key and secret are correct, as well as username and password."
+    AUTHORIZATION_SUCCEEDED_MESSAGE = "Authorization successful"
+    def dispatch
+      client.exchange_credentials_for_access_token
+      client.save
+      CLI.puts AUTHORIZATION_SUCCEEDED_MESSAGE
+    rescue OAuth::Unauthorized
+      raise Exception, AUTHORIZATION_FAILED_MESSAGE
+    end
+  end
+end

data/lib/twurl/cli.rb

@@ -0,0 +1,258 @@
+module Twurl
+  class CLI
+    SUPPORTED_COMMANDS     = %w(authorize accounts alias set)
+    DEFAULT_COMMAND        = 'request'
+    PATH_PATTERN           = /^\/\w+/
+    README                 = File.dirname(__FILE__) + '/../../README'
+    @output              ||= STDOUT
+
+    class << self
+      attr_accessor :output
+
+      def run(args)
+        options = parse_options(args)
+        dispatch(options)
+      end
+
+      def dispatch(options)
+        client     = OAuthClient.load_from_options(options)
+        controller = case options.command
+                     when 'authorize'
+                       AuthorizationController
+                     when 'accounts'
+                       AccountInformationController
+                     when 'alias'
+                       AliasesController
+                     when 'set'
+                       ConfigurationController
+                     when 'request'
+                       RequestController
+                     end
+        controller.dispatch(client, options)
+      rescue Twurl::Exception => exception
+        abort(exception.message)
+      end
+
+      def parse_options(args)
+        arguments = args.dup
+
+        Twurl.options         = Options.new
+        Twurl.options.trace   = false
+        Twurl.options.data    = {}
+
+        option_parser = OptionParser.new do |o|
+          o.extend AvailableOptions
+
+          o.banner = "Usage: twurl authorize -u username -p password --consumer-key HQsAGcVm5MQT3n6j7qVJw --consumer-secret asdfasd223sd2\n" +
+                     "       twurl [options] /statuses/home_timeline.xml\n"                                                                  +
+                     "\n"                                                                                                                    +
+                     "Supported Commands:\n#{SUPPORTED_COMMANDS.sort.join(', ')}"
+
+          o.section "Getting started:" do
+            tutorial
+          end
+
+          o.section "Authorization options:" do
+            username
+            password
+            consumer_key
+            consumer_secret
+            access_token
+            token_secret
+          end
+
+          o.section "Common options:" do
+            trace
+            data
+            host
+            quiet
+            disable_ssl
+            request_method
+            help
+          end
+        end
+
+        arguments                 = option_parser.parse!(args)
+        Twurl.options.command     = extract_command!(arguments)
+        Twurl.options.path        = extract_path!(arguments)
+        Twurl.options.subcommands = arguments
+        Twurl.options
+      end
+
+      def puts(*args, &block)
+        output.puts(*args, &block)
+      end
+
+      def prompt_for(label)
+        system "stty -echo"
+        print "#{label}: "
+        result = STDIN.gets.chomp
+        CLI.puts
+        result
+      rescue Interrupt
+        exit
+      ensure
+        system "stty echo"
+      end
+
+      private
+        def extract_command!(arguments)
+          if SUPPORTED_COMMANDS.include?(arguments.first)
+            arguments.shift
+          else
+            DEFAULT_COMMAND
+          end
+        end
+
+        def extract_path!(arguments)
+          path = nil
+          arguments.each_with_index do |argument, index|
+            if argument[PATH_PATTERN]
+              path = arguments.slice!(index)
+              break
+            end
+          end
+          path
+        end
+    end
+
+    module AvailableOptions
+      def options
+        Twurl.options
+      end
+
+      def section(heading, &block)
+        separator ""
+        separator heading
+
+        instance_eval(&block)
+      end
+
+      def tutorial
+        on('-T', '--tutorial', "Narrative overview of how to get started using Twurl") do
+          CLI.puts IO.read(README)
+          exit
+        end
+      end
+
+      def consumer_key
+        on('-c', '--consumer-key [key]', "Your consumer key (required)") do |key|
+          options.consumer_key = key ? key : CLI.prompt_for('Consumer key')
+        end
+      end
+
+      def consumer_secret
+        on('-s', '--consumer-secret [secret]', "Your consumer secret (required)") do |secret|
+          options.consumer_secret = secret ? secret : CLI.prompt_for('Consumer secret')
+        end
+      end
+
+      def access_token
+        on('-a', '--access-token [token]', 'Your access token') do |token|
+          options.access_token = token
+        end
+      end
+
+      def token_secret
+        on('-S', '--token-secret', "Your token secret") do |secret|
+          options.token_secret = secret
+        end
+      end
+
+      def username
+        on('-u', '--username [username]', 'Username of account to authorize (required)') do |username|
+          options.username = username
+        end
+      end
+
+      def password
+        on('-p', '--password [password]', 'Password of account to authorize (required)') do |password|
+          options.password = password ? password : CLI.prompt_for('Password')
+        end
+      end
+
+      def trace
+        on('-t', '--[no-]trace', 'Trace request/response traffic (default: --no-trace)') do |trace|
+          options.trace = trace
+        end
+      end
+
+      def data
+        on('-d', '--data [data]', 'Sends the specified data in a POST request to the HTTP server.') do |data|
+          data.split('&').each do |pair|
+            key, value = pair.split('=')
+            options.data[key] = value
+          end
+        end
+      end
+
+      def host
+        on('-H', '--host [host]', 'Specify host to make requests to (default: api.twitter.com)') do |host|
+          options.host = host
+        end
+      end
+
+      def quiet
+        on('-q', '--quiet', 'Suppress all output (default: output is printed to STDOUT)') do |quiet|
+          options.output = StringIO.new
+        end
+      end
+
+      def disable_ssl
+        on('-U', '--no-ssl', 'Disable SSL (default: SSL is enabled)') do |use_ssl|
+          options.protocol = 'http'
+        end
+      end
+
+      def request_method
+        on('-X', '--request-method [method]', 'Request method (default: GET)') do |request_method|
+          options.request_method = request_method.downcase
+        end
+      end
+
+      def help
+        on_tail("-h", "--help", "Show this message") do
+          CLI.puts self
+          exit
+        end
+      end
+    end
+  end
+
+  class Options < OpenStruct
+    DEFAULT_REQUEST_METHOD = 'get'
+    DEFAULT_HOST           = 'api.twitter.com'
+    DEFAULT_PROTOCOL       = 'https'
+
+    def oauth_client_options
+      OAuthClient::OAUTH_CLIENT_OPTIONS.inject({}) do |options, option|
+        options[option] = send(option)
+        options
+      end
+    end
+
+    def base_url
+      "#{protocol}://#{host}"
+    end
+
+    def ssl?
+      protocol == 'https'
+    end
+
+    def debug_output_io
+      super || STDERR
+    end
+
+    def request_method
+      super || (data.empty? ? DEFAULT_REQUEST_METHOD : 'post')
+    end
+
+    def protocol
+      super || DEFAULT_PROTOCOL
+    end
+
+    def host
+      super || DEFAULT_HOST
+    end
+  end
+end