htty 1.0.0

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

@@ -0,0 +1,20 @@
+# Defines HTTY::CLI::Commands::FormRemoveAll.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _form-remove-all_ command.
+class HTTY::CLI::Commands::FormRemoveAll < HTTY::CLI::Command
+
+  # Returns the name of a category under which help for the _form-remove-all_
+  # command should appear.
+  def self.category
+    'Building Requests'
+  end
+
+end

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

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

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

@@ -0,0 +1,59 @@
+# Defines HTTY::CLI::Commands::FragmentSet.
+
+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__}/fragment_unset")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _fragment-set_ command.
+class HTTY::CLI::Commands::FragmentSet < HTTY::CLI::Command
+
+  include HTTY::CLI::UrlEscaping
+
+  # Returns the name of a category under which help for the _fragment-set_
+  # command should appear.
+  def self.category
+    'Navigation'
+  end
+
+  # Returns the arguments for the command-line usage of the _fragment-set_ command.
+  def self.command_line_arguments
+    'fragment'
+  end
+
+  # Returns the help text for the _fragment-set_ command.
+  def self.help
+    "Sets the fragment of the request's address"
+  end
+
+  # Returns the extended help text for the _fragment-set_ command.
+  def self.help_extended
+    'Sets the page fragment 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 _fragment-set_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::FragmentUnset,
+     HTTY::CLI::Commands::Address]
+  end
+
+  # Performs the _fragment-set_ command.
+  def perform
+    add_request_if_has_response do |request|
+      clean_arguments = arguments.collect do |a|
+        a.gsub(/^#/, '')
+      end
+      request.fragment_set(*escape_or_warn_of_escape_sequences(clean_arguments))
+    end
+  end
+
+end

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

@@ -0,0 +1,48 @@
+# Defines HTTY::CLI::Commands::FragmentUnset.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/address")
+require File.expand_path("#{File.dirname __FILE__}/fragment_set")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _fragment-unset_ command.
+class HTTY::CLI::Commands::FragmentUnset < HTTY::CLI::Command
+
+  # Returns the name of a category under which help for the _fragment-unset_
+  # command should appear.
+  def self.category
+    'Navigation'
+  end
+
+  # Returns the help text for the _fragment-unset_ command.
+  def self.help
+    "Removes the fragment from the request's address"
+  end
+
+  # Returns the extended help text for the _fragment-unset_ command.
+  def self.help_extended
+    'Removes the page fragment 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 _fragment-unset_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::FragmentSet,
+     HTTY::CLI::Commands::Address]
+  end
+
+  # Performs the _fragment-unset_ command.
+  def perform
+    add_request_if_has_response do |request|
+      request.fragment_unset(*arguments)
+    end
+  end
+
+end

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,70 @@
+# Defines HTTY::CLI::Commands::HeadersRequest.
+
+require File.expand_path("#{File.dirname __FILE__}/../../request")
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/../display")
+require File.expand_path("#{File.dirname __FILE__}/body_request")
+require File.expand_path("#{File.dirname __FILE__}/cookies")
+require File.expand_path("#{File.dirname __FILE__}/headers_response")
+require File.expand_path("#{File.dirname __FILE__}/headers_set")
+require File.expand_path("#{File.dirname __FILE__}/headers_unset")
+require File.expand_path("#{File.dirname __FILE__}/headers_unset_all")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _headers-request_ command.
+class HTTY::CLI::Commands::HeadersRequest < HTTY::CLI::Command
+
+  include HTTY::CLI::Display
+
+  # Returns the name of a category under which help for the _headers-request_
+  # command should appear.
+  def self.category
+    'Building Requests'
+  end
+
+  # Returns the help text for the _headers-request_ command.
+  def self.help
+    'Displays the headers of the request'
+  end
+
+  # Returns the extended help text for the _headers-request_ command.
+  def self.help_extended
+    'Displays the headers used for the request. Does not communicate with '  +
+    "the endpoint.\n"                                                        +
+    "\n"                                                                     +
+    'Headers must have unique names. When you set a header that already '    +
+    'exists, its value will be changed.'
+  end
+
+  # Returns related command classes for the _headers-request_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::HeadersSet,
+     HTTY::CLI::Commands::HeadersUnset,
+     HTTY::CLI::Commands::HeadersUnsetAll,
+     HTTY::CLI::Commands::BodyRequest,
+     HTTY::CLI::Commands::Cookies,
+     HTTY::CLI::Commands::HeadersResponse]
+  end
+
+  # Performs the _headers-request_ command.
+  def perform
+    request = session.requests.last
+    headers = if request.request_method.nil?
+                if request.body.to_s.length.zero?
+                  request.headers false
+                else
+                  request.headers true
+                end
+              else
+                request.headers
+              end
+    show_headers headers, HTTY::Request::COOKIES_HEADER_NAME
+    self
+  end
+
+end

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

@@ -0,0 +1,65 @@
+# Defines HTTY::CLI::Commands::HeadersResponse.
+
+require File.expand_path("#{File.dirname __FILE__}/../../response")
+require File.expand_path("#{File.dirname __FILE__}/../../no_response_error")
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/../display")
+require File.expand_path("#{File.dirname __FILE__}/body_response")
+require File.expand_path("#{File.dirname __FILE__}/cookies")
+require File.expand_path("#{File.dirname __FILE__}/cookies_use")
+require File.expand_path("#{File.dirname __FILE__}/headers_request")
+require File.expand_path("#{File.dirname __FILE__}/status")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _headers-response_ command.
+class HTTY::CLI::Commands::HeadersResponse < HTTY::CLI::Command
+
+  include HTTY::CLI::Display
+
+  # Returns the name of a category under which help for the _headers-response_
+  # command should appear.
+  def self.category
+    'Inspecting Responses'
+  end
+
+  # Returns the string used to invoke the _headers-response_ command from the
+  # command line.
+  def self.command_line
+    'headers[-response]'
+  end
+
+  # Returns the help text for the _headers-response_ command.
+  def self.help
+    'Displays the headers of the response'
+  end
+
+  # Returns the extended help text for the _headers-response_ command.
+  def self.help_extended
+    'Displays the headers received in the response. Does not communicate ' +
+    'with the endpoint.'
+  end
+
+  # Returns related command classes for the _headers-response_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::BodyResponse,
+     HTTY::CLI::Commands::Cookies,
+     HTTY::CLI::Commands::CookiesUse,
+     HTTY::CLI::Commands::Status,
+     HTTY::CLI::Commands::HeadersRequest]
+  end
+
+  # Performs the _headers-response_ command.
+  def perform
+    unless (response = session.last_response)
+      raise HTTY::NoResponseError
+    end
+    show_headers response.headers, HTTY::Response::COOKIES_HEADER_NAME
+    self
+  end
+
+end

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

@@ -0,0 +1,57 @@
+# Defines HTTY::CLI::Commands::HeadersSet.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/headers_request")
+require File.expand_path("#{File.dirname __FILE__}/headers_unset")
+require File.expand_path("#{File.dirname __FILE__}/headers_unset_all")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _headers-set_ command.
+class HTTY::CLI::Commands::HeadersSet < HTTY::CLI::Command
+
+  # Returns the name of a category under which help for the _headers-set_
+  # command should appear.
+  def self.category
+    'Building Requests'
+  end
+
+  # Returns the arguments for the command-line usage of the _headers-set_
+  # command.
+  def self.command_line_arguments
+    'name value'
+  end
+
+  # Returns the help text for the _headers-set_ command.
+  def self.help
+    'Sets a header of the request'
+  end
+
+  # Returns the extended help text for the _headers-set_ command.
+  def self.help_extended
+    'Sets a header used for the request. Does not communicate with the '  +
+    "endpoint.\n"                                                         +
+    "\n"                                                                  +
+    'Headers must have unique names. When you set a header that already ' +
+    'exists, its value will be changed.'
+  end
+
+  # Returns related command classes for the _headers-set_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::HeadersRequest,
+     HTTY::CLI::Commands::HeadersUnset,
+     HTTY::CLI::Commands::HeadersUnsetAll]
+  end
+
+  # Performs the _headers-set_ command.
+  def perform
+    add_request_if_has_response do |request|
+      request.header_set(*arguments)
+    end
+  end
+
+end

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

@@ -0,0 +1,54 @@
+# Defines HTTY::CLI::Commands::HeadersUnset.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/headers_request")
+require File.expand_path("#{File.dirname __FILE__}/headers_set")
+require File.expand_path("#{File.dirname __FILE__}/headers_unset_all")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _headers-unset_ command.
+class HTTY::CLI::Commands::HeadersUnset < HTTY::CLI::Command
+
+  # Returns the name of a category under which help for the _headers-unset_
+  # command should appear.
+  def self.category
+    'Building Requests'
+  end
+
+  # Returns the arguments for the command-line usage of the _headers-unset_
+  # command.
+  def self.command_line_arguments
+    'name'
+  end
+
+  # Returns the help text for the _headers-unset_ command.
+  def self.help
+    'Removes a header of the request'
+  end
+
+  # Returns the extended help text for the _headers-unset_ command.
+  def self.help_extended
+    'Removes a header used for the request. Does not communicate with the ' +
+    'endpoint.'
+  end
+
+  # Returns related command classes for the _headers-unset_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::HeadersRequest,
+     HTTY::CLI::Commands::HeadersSet,
+     HTTY::CLI::Commands::HeadersUnsetAll]
+  end
+
+  # Performs the _headers-unset_ command.
+  def perform
+    add_request_if_has_response do |request|
+      request.header_unset(*arguments)
+    end
+  end
+
+end