htty 1.0.0

data/app/htty/cli/commands/http_options.rb

@@ -0,0 +1,36 @@
+# Defines HTTY::CLI::Commands::HttpOptions.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/../http_method_command")
+require File.expand_path("#{File.dirname __FILE__}/http_get")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _http-options_ command.
+class HTTY::CLI::Commands::HttpOptions < HTTY::CLI::Command
+
+  include HTTY::CLI::HTTPMethodCommand
+
+  # Returns the help text for the _http-options_ command.
+  def self.help
+    'Issues an HTTP OPTIONS using the current request'
+  end
+
+  # Returns the extended help text for the _http-options_ command.
+  def self.help_extended
+    "Issues an HTTP OPTIONS using the current request.\n"                    +
+    "\n"                                                                     +
+    'Any request body you may set is ignored (i.e., it is not sent as part ' +
+    'of the request).'
+  end
+
+  # Returns related command classes for the _http-options_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::HttpGet]
+  end
+
+end

data/app/htty/cli/commands/http_post.rb

@@ -0,0 +1,34 @@
+# Defines HTTY::CLI::Commands::HttpPost.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/../http_method_command")
+require File.expand_path("#{File.dirname __FILE__}/follow")
+require File.expand_path("#{File.dirname __FILE__}/http_delete")
+require File.expand_path("#{File.dirname __FILE__}/http_get")
+require File.expand_path("#{File.dirname __FILE__}/http_put")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _http-post_ command.
+class HTTY::CLI::Commands::HttpPost < HTTY::CLI::Command
+
+  include HTTY::CLI::HTTPMethodCommand
+
+  # Returns the help text for the _http-post_ command.
+  def self.help
+    'Issues an HTTP POST using the current request'
+  end
+
+  # Returns related command classes for the _http-post_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::HttpGet,
+     HTTY::CLI::Commands::Follow,
+     HTTY::CLI::Commands::HttpPut,
+     HTTY::CLI::Commands::HttpDelete]
+  end
+
+end

data/app/htty/cli/commands/http_put.rb

@@ -0,0 +1,29 @@
+# Defines HTTY::CLI::Commands::HttpPut.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/../http_method_command")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _http-put_ command.
+class HTTY::CLI::Commands::HttpPut < HTTY::CLI::Command
+
+  include HTTY::CLI::HTTPMethodCommand
+
+  # Returns the help text for the _http-put_ command.
+  def self.help
+    'Issues an HTTP PUT using the current request'
+  end
+
+  # Returns related command classes for the _http-put_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::HttpGet,
+     HTTY::CLI::Commands::HttpPost,
+     HTTY::CLI::Commands::HttpDelete]
+  end
+
+end

data/app/htty/cli/commands/http_trace.rb

@@ -0,0 +1,36 @@
+# Defines HTTY::CLI::Commands::HttpTrace.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/../http_method_command")
+require File.expand_path("#{File.dirname __FILE__}/http_get")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _http-trace_ command.
+class HTTY::CLI::Commands::HttpTrace < HTTY::CLI::Command
+
+  include HTTY::CLI::HTTPMethodCommand
+
+  # Returns the help text for the _http-trace_ command.
+  def self.help
+    'Issues an HTTP TRACE using the current request'
+  end
+
+  # Returns the extended help text for the _http-trace_ command.
+  def self.help_extended
+    "Issues an HTTP TRACE using the current request.\n"                      +
+    "\n"                                                                     +
+    'Any request body you may set is ignored (i.e., it is not sent as part ' +
+    'of the request).'
+  end
+
+  # Returns related command classes for the _http-trace_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::HttpGet]
+  end
+
+end

data/app/htty/cli/commands/path_set.rb

@@ -0,0 +1,54 @@
+# Defines HTTY::CLI::Commands::PathSet.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/../url_escaping")
+require File.expand_path("#{File.dirname __FILE__}/address")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _path-set_ command.
+class HTTY::CLI::Commands::PathSet < HTTY::CLI::Command
+
+  include HTTY::CLI::UrlEscaping
+
+  # Returns the name of a category under which help for the _path-set_ command
+  # should appear.
+  def self.category
+    'Navigation'
+  end
+
+  # Returns the arguments for the command-line usage of the _path-set_ command.
+  def self.command_line_arguments
+    'path'
+  end
+
+  # Returns the help text for the _path-set_ command.
+  def self.help
+    "Changes the path of the request's address"
+  end
+
+  # Returns the extended help text for the _path-set_ command.
+  def self.help_extended
+    'Changes the path used for the request. Does not communicate with the ' +
+    "endpoint.\n"                                                           +
+    "\n"                                                                    +
+    'The console prompt shows the address for the current request.'
+  end
+
+  # Returns related command classes for the _path-set_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::Address]
+  end
+
+  # Performs the _path-set_ command.
+  def perform
+    add_request_if_has_response do |request|
+      request.path_set(*escape_or_warn_of_escape_sequences(arguments))
+    end
+  end
+
+end

data/app/htty/cli/commands/port_set.rb

@@ -0,0 +1,55 @@
+# Defines HTTY::CLI::Commands::PortSet.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/address")
+require File.expand_path("#{File.dirname __FILE__}/scheme_set")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _port-set_ command.
+class HTTY::CLI::Commands::PortSet < HTTY::CLI::Command
+
+  # Returns the name of a category under which help for the _port-set_ command
+  # should appear.
+  def self.category
+    'Navigation'
+  end
+
+  # Returns the arguments for the command-line usage of the _port-set_ command.
+  def self.command_line_arguments
+    'port'
+  end
+
+  # Returns the help text for the _port-set_ command.
+  def self.help
+    "Changes the TCP port of the request's address"
+  end
+
+  # Returns the extended help text for the _port-set_ command.
+  def self.help_extended
+    'Changes the TCP port used for the request. Does not communicate with '  +
+    "the endpoint.\n"                                                        +
+    "\n"                                                                     +
+    "The port you supply must be an integer between 0 and 65,535. Changing " +
+    "the port has no effect on the scheme, and vice versa.\n"                +
+    "\n"                                                                     +
+    'The console prompt shows the address for the current request.'
+  end
+
+  # Returns related command classes for the _port-set_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::Address, HTTY::CLI::Commands::SchemeSet]
+  end
+
+  # Performs the _port-set_ command.
+  def perform
+    add_request_if_has_response do |request|
+      request.port_set(*arguments)
+    end
+  end
+
+end

data/app/htty/cli/commands/post.rb

@@ -0,0 +1,20 @@
+# Defines HTTY::CLI::Commands::Post.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/http_post")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _post_ command.
+class HTTY::CLI::Commands::Post < HTTY::CLI::Command
+
+  # Returns the command that the _post_ command is an alias for.
+  def self.alias_for
+    HTTY::CLI::Commands::HttpPost
+  end
+
+end

data/app/htty/cli/commands/put.rb

@@ -0,0 +1,20 @@
+# Defines HTTY::CLI::Commands::Put.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/http_put")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _put_ command.
+class HTTY::CLI::Commands::Put < HTTY::CLI::Command
+
+  # Returns the command that the _put_ command is an alias for.
+  def self.alias_for
+    HTTY::CLI::Commands::HttpPut
+  end
+
+end

data/app/htty/cli/commands/query_clear.rb

@@ -0,0 +1,20 @@
+# Defines HTTY::CLI::Commands::QueryClear.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/query_unset_all")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _query-clear_ command.
+class HTTY::CLI::Commands::QueryClear < HTTY::CLI::Command
+
+  # Returns the command that the _query-clear_ command is an alias for.
+  def self.alias_for
+    HTTY::CLI::Commands::QueryUnsetAll
+  end
+
+end

data/app/htty/cli/commands/query_set.rb

@@ -0,0 +1,59 @@
+# Defines HTTY::CLI::Commands::QuerySet.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/../url_escaping")
+require File.expand_path("#{File.dirname __FILE__}/address")
+require File.expand_path("#{File.dirname __FILE__}/query_unset")
+require File.expand_path("#{File.dirname __FILE__}/query_unset_all")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _query-set_ command.
+class HTTY::CLI::Commands::QuerySet < HTTY::CLI::Command
+
+  include HTTY::CLI::UrlEscaping
+
+  # Returns the name of a category under which help for the _query-set_ command
+  # should appear.
+  def self.category
+    'Navigation'
+  end
+
+  # Returns the arguments for the command-line usage of the _query-set_
+  # command.
+  def self.command_line_arguments
+    'name value'
+  end
+
+  # Returns the help text for the _query-set_ command.
+  def self.help
+    "Sets a query string parameter in the request's address"
+  end
+
+  # Returns the extended help text for the _query-set_ command.
+  def self.help_extended
+    'Sets a query string parameter used for the request. Does not ' +
+    "communicate with the endpoint.\n"                              +
+    "\n"                                                            +
+    'The console prompt shows the address for the current request.'
+  end
+
+  # Returns related command classes for the _query-set_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::QueryUnset,
+     HTTY::CLI::Commands::QueryUnsetAll,
+     HTTY::CLI::Commands::Address]
+  end
+
+  # Performs the _query-set_ command.
+  def perform
+    add_request_if_has_response do |request|
+      request.query_set(*escape_or_warn_of_escape_sequences(arguments))
+    end
+  end
+
+end

data/app/htty/cli/commands/query_unset.rb

@@ -0,0 +1,56 @@
+# Defines HTTY::CLI::Commands::QueryUnset.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/address")
+require File.expand_path("#{File.dirname __FILE__}/query_set")
+require File.expand_path("#{File.dirname __FILE__}/query_unset_all")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _query-unset_ command.
+class HTTY::CLI::Commands::QueryUnset < HTTY::CLI::Command
+
+  # Returns the name of a category under which help for the _query-unset_
+  # command should appear.
+  def self.category
+    'Navigation'
+  end
+
+  # Returns the arguments for the command-line usage of the _query-unset_
+  # command.
+  def self.command_line_arguments
+    'name'
+  end
+
+  # Returns the help text for the _query-unset_ command.
+  def self.help
+    "Removes a query string parameter from the request's address"
+  end
+
+  # Returns the extended help text for the _query-unset_ command.
+  def self.help_extended
+    'Removes a query string parameter used for the request. Does not ' +
+    "communicate with the endpoint.\n"                                 +
+    "\n"                                                               +
+    'The console prompt shows the address for the current request.'
+  end
+
+  # Returns related command classes for the _query-unset_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::QuerySet,
+     HTTY::CLI::Commands::QueryUnsetAll,
+     HTTY::CLI::Commands::Address]
+  end
+
+  # Performs the _query-unset_ command.
+  def perform
+    add_request_if_has_response do |request|
+      request.query_unset(*arguments)
+    end
+  end
+
+end

data/app/htty/cli/commands/query_unset_all.rb

@@ -0,0 +1,50 @@
+# Defines HTTY::CLI::Commands::QueryUnsetAll.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/address")
+require File.expand_path("#{File.dirname __FILE__}/query_set")
+require File.expand_path("#{File.dirname __FILE__}/query_unset")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _query-unset-all_ command.
+class HTTY::CLI::Commands::QueryUnsetAll < HTTY::CLI::Command
+
+  # Returns the name of a category under which help for the _query-unset-all_
+  # command should appear.
+  def self.category
+    'Navigation'
+  end
+
+  # Returns the help text for the _query-unset-all_ command.
+  def self.help
+    "Clears the query string of the request's address"
+  end
+
+  # Returns the extended help text for the _query-unset-all_ command.
+  def self.help_extended
+    'Clears the query string used for the request. Does not communicate with ' +
+    "the endpoint.\n"                                                          +
+    "\n"                                                                       +
+    'The console prompt shows the address for the current request.'
+  end
+
+  # Returns related command classes for the _query-unset-all_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::QueryUnset,
+     HTTY::CLI::Commands::QuerySet,
+     HTTY::CLI::Commands::Address]
+  end
+
+  # Performs the _query-unset-all_ command.
+  def perform
+    add_request_if_has_response do |request|
+      request.query_unset_all(*arguments)
+    end
+  end
+
+end