Module: Twurl::CLI::AvailableOptions

Defined in:

lib/twurl/cli.rb

Instance Method Summary

• #access_token ⇒ Object
• #consumer_key ⇒ Object
• #consumer_secret ⇒ Object
• #data ⇒ Object
• #disable_ssl ⇒ Object
• #headers ⇒ Object
• #help ⇒ Object
• #host ⇒ Object
• #options ⇒ Object
• #password ⇒ Object
• #proxy ⇒ Object
• #quiet ⇒ Object
• #request_method ⇒ Object
• #section(heading, &block) ⇒ Object
• #token_secret ⇒ Object
• #trace ⇒ Object
• #tutorial ⇒ Object
• #username ⇒ Object
• #version ⇒ Object

Instance Method Details

#access_token ⇒ Object

# File 'lib/twurl/cli.rb', line 195

def access_token
  on('-a', '--access-token [token]', 'Your access token') do |token|
    options.access_token = token
  end
end

#consumer_key ⇒ Object

# File 'lib/twurl/cli.rb', line 183

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

#consumer_secret ⇒ Object

# File 'lib/twurl/cli.rb', line 189

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

#data ⇒ Object

# File 'lib/twurl/cli.rb', line 225

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('=', 2)
      options.data[key] = value
    end
  end
end

#disable_ssl ⇒ Object

# File 'lib/twurl/cli.rb', line 258

def disable_ssl
  on('-U', '--no-ssl', 'Disable SSL (default: SSL is enabled)') do |use_ssl|
    options.protocol = 'http'
  end
end

#headers ⇒ Object

# File 'lib/twurl/cli.rb', line 234

def headers
  on('-A', '--header [header]', 'Adds the specified header to the request to the HTTP server.') do |header|
    key, value = header.split(': ')
    options.headers[key] = value
  end
end

#help ⇒ Object

# File 'lib/twurl/cli.rb', line 270

def help
  on_tail("-h", "--help", "Show this message") do
    CLI.puts self
    exit
  end
end

#host ⇒ Object

# File 'lib/twurl/cli.rb', line 241

def host
  on('-H', '--host [host]', 'Specify host to make requests to (default: api.twitter.com)') do |host|
    if host[PROTOCOL_PATTERN]
      protocol, protocolless_host = host.split(PROTOCOL_PATTERN, 2)
      options.host = protocolless_host
    else
      options.host = host
    end
  end
end

#options ⇒ Object

# File 'lib/twurl/cli.rb', line 165

def options
  Twurl.options
end

#password ⇒ Object

# File 'lib/twurl/cli.rb', line 213

def password
  on('-p', '--password [password]', 'Password of account to authorize (required)') do |password|
    options.password = password ? password : CLI.prompt_for('Password')
  end
end

#proxy ⇒ Object

# File 'lib/twurl/cli.rb', line 284

def proxy
  on('-P', '--proxy [proxy]', 'Specify HTTP proxy to forward requests to (default: No proxy)') do |proxy|
    options.proxy = proxy
  end
end

#quiet ⇒ Object

# File 'lib/twurl/cli.rb', line 252

def quiet
  on('-q', '--quiet', 'Suppress all output (default: output is printed to STDOUT)') do |quiet|
    options.output = StringIO.new
  end
end

#request_method ⇒ Object

# File 'lib/twurl/cli.rb', line 264

def request_method
  on('-X', '--request-method [method]', 'Request method (default: GET)') do |request_method|
    options.request_method = request_method.downcase
  end
end

#section(heading, &block) ⇒ Object

# File 'lib/twurl/cli.rb', line 169

def section(heading, &block)
  separator ""
  separator heading

  instance_eval(&block)
end

#token_secret ⇒ Object

# File 'lib/twurl/cli.rb', line 201

def token_secret
  on('-S', '--token-secret', "Your token secret") do |secret|
    options.token_secret = secret
  end
end

#trace ⇒ Object

# File 'lib/twurl/cli.rb', line 219

def trace
  on('-t', '--[no-]trace', 'Trace request/response traffic (default: --no-trace)') do |trace|
    options.trace = trace
  end
end

#tutorial ⇒ Object

# File 'lib/twurl/cli.rb', line 176

def tutorial
  on('-T', '--tutorial', "Narrative overview of how to get started using Twurl") do
    CLI.puts IO.read(README)
    exit
  end
end

#username ⇒ Object

# File 'lib/twurl/cli.rb', line 207

def username
  on('-u', '--username [username]', 'Username of account to authorize (required)') do |username|
    options.username = username
  end
end

#version ⇒ Object

# File 'lib/twurl/cli.rb', line 277

def version
  on_tail("-v", "--version", "Show version") do
    CLI.puts Version
    exit
  end
end