htty 1.0.0

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

@@ -0,0 +1,62 @@
+# Defines HTTY::CLI::Commands::CookiesAdd.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/cookies")
+require File.expand_path("#{File.dirname __FILE__}/cookies_remove")
+require File.expand_path("#{File.dirname __FILE__}/cookies_remove_all")
+require File.expand_path("#{File.dirname __FILE__}/cookies_use")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _cookies-add_ command.
+class HTTY::CLI::Commands::CookiesAdd < HTTY::CLI::Command
+
+  # Returns the name of a category under which help for the _cookies-add_
+  # command should appear.
+  def self.category
+    'Building Requests'
+  end
+
+  # Returns the arguments for the command-line usage of the _cookies-add_
+  # command.
+  def self.command_line_arguments
+    'name [value]'
+  end
+
+  # Returns the help text for the _cookies-add_ command.
+  def self.help
+    'Adds a cookie to the request'
+  end
+
+  # Returns the extended help text for the _cookies-add_ command.
+  def self.help_extended
+    'Adds a cookie used for the request. Does not communicate with the '   +
+    "endpoint.\n"                                                          +
+    "\n"                                                                   +
+    'Cookies are not required to have unique names. You can add multiple ' +
+    'cookies with the same name, and they will be removed in '             +
+    "last-in-first-out order.\n"                                           +
+    "\n"                                                                   +
+    'Cookies are not required to have values, either.'
+  end
+
+  # Returns related command classes for the _cookies-add_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::Cookies,
+     HTTY::CLI::Commands::CookiesRemove,
+     HTTY::CLI::Commands::CookiesRemoveAll,
+     HTTY::CLI::Commands::CookiesUse]
+  end
+
+  # Performs the _cookies-add_ command.
+  def perform
+    add_request_if_has_response do |request|
+      request.cookie_add(*arguments)
+    end
+  end
+
+end

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

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

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

@@ -0,0 +1,60 @@
+# Defines HTTY::CLI::Commands::CookiesRemove.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/cookies")
+require File.expand_path("#{File.dirname __FILE__}/cookies_add")
+require File.expand_path("#{File.dirname __FILE__}/cookies_remove_all")
+require File.expand_path("#{File.dirname __FILE__}/cookies_use")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _cookies-remove_ command.
+class HTTY::CLI::Commands::CookiesRemove < HTTY::CLI::Command
+
+  # Returns the name of a category under which help for the _cookies-remove_
+  # command should appear.
+  def self.category
+    'Building Requests'
+  end
+
+  # Returns the arguments for the command-line usage of the _cookies-remove_
+  # command.
+  def self.command_line_arguments
+    'name'
+  end
+
+  # Returns the help text for the _cookies-remove_ command.
+  def self.help
+    'Removes from the request the last cookie having a particular name'
+  end
+
+  # Returns the extended help text for the _cookies-remove_ command.
+  def self.help_extended
+    'Removes a cookie used for the request. Does not communicate with the ' +
+    "endpoint.\n"                                                           +
+    "\n"                                                                    +
+    'Cookies are not required to have unique names. You can add multiple '  +
+    'cookies with the same name, and they will be removed in '              +
+    'last-in-first-out order.'
+  end
+
+  # Returns related command classes for the _cookies-remove_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::Cookies,
+     HTTY::CLI::Commands::CookiesAdd,
+     HTTY::CLI::Commands::CookiesRemoveAll,
+     HTTY::CLI::Commands::CookiesUse]
+  end
+
+  # Performs the _cookies-remove_ command.
+  def perform
+    add_request_if_has_response do |request|
+      request.cookie_remove(*arguments)
+    end
+  end
+
+end

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

@@ -0,0 +1,50 @@
+# Defines HTTY::CLI::Commands::CookiesRemoveAll.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/cookies")
+require File.expand_path("#{File.dirname __FILE__}/cookies_add")
+require File.expand_path("#{File.dirname __FILE__}/cookies_remove")
+require File.expand_path("#{File.dirname __FILE__}/cookies_use")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _cookies-remove-all_ command.
+class HTTY::CLI::Commands::CookiesRemoveAll < HTTY::CLI::Command
+
+  # Returns the name of a category under which help for the _cookies-remove-all_
+  # command should appear.
+  def self.category
+    'Building Requests'
+  end
+
+  # Returns the help text for the _cookies-remove-all_ command.
+  def self.help
+    'Removes all cookies from the request'
+  end
+
+  # Returns the extended help text for the _cookies-remove-all_ command.
+  def self.help_extended
+    'Removes all cookies used for the request. Does not communicate with the ' +
+    'endpoint.'
+  end
+
+  # Returns related command classes for the _cookies-remove-all_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::Cookies,
+     HTTY::CLI::Commands::CookiesRemove,
+     HTTY::CLI::Commands::CookiesAdd,
+     HTTY::CLI::Commands::CookiesUse]
+  end
+
+  # Performs the _cookies-remove-all_ command.
+  def perform
+    add_request_if_has_response do |request|
+      request.cookies_remove_all(*arguments)
+    end
+  end
+
+end

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

@@ -0,0 +1,57 @@
+# Defines HTTY::CLI::Commands::CookiesUse.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/cookies")
+require File.expand_path("#{File.dirname __FILE__}/cookies_add")
+require File.expand_path("#{File.dirname __FILE__}/cookies_remove")
+require File.expand_path("#{File.dirname __FILE__}/cookies_remove_all")
+require File.expand_path("#{File.dirname __FILE__}/headers_response")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _cookies-use_ command.
+class HTTY::CLI::Commands::CookiesUse < HTTY::CLI::Command
+
+  # Returns the name of a category under which help for the _cookies-use_
+  # command should appear.
+  def self.category
+    'Building Requests'
+  end
+
+  # Returns the help text for the _cookies-use_ command.
+  def self.help
+    'Uses cookies offered in the response'
+  end
+
+  # Returns the extended help text for the _cookies-use_ command.
+  def self.help_extended
+    'Sets the cookies of the request to the cookies offered in the response ' +
+    "(the 'Set-Cookie' header). Does not communicate with the endpoint."
+  end
+
+  # Returns related command classes for the _cookies-use_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::Cookies,
+     HTTY::CLI::Commands::CookiesAdd,
+     HTTY::CLI::Commands::CookiesRemove,
+     HTTY::CLI::Commands::CookiesRemoveAll,
+     HTTY::CLI::Commands::HeadersResponse]
+  end
+
+  # Performs the _cookies-use_ command.
+  def perform
+    unless arguments.empty?
+      raise ArgumentError,
+            "wrong number of arguments (#{arguments.length} for 0)"
+    end
+
+    add_request_if_has_response do |request|
+      request.cookies_use session.last_response
+    end
+  end
+
+end

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

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

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

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

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

@@ -0,0 +1,56 @@
+# Defines HTTY::CLI::Commands::Follow.
+
+require File.expand_path("#{File.dirname __FILE__}/../command")
+require File.expand_path("#{File.dirname __FILE__}/../cookie_clearing_command")
+require File.expand_path("#{File.dirname __FILE__}/address")
+require File.expand_path("#{File.dirname __FILE__}/http_get")
+
+module HTTY; end
+
+class HTTY::CLI; end
+
+module HTTY::CLI::Commands; end
+
+# Encapsulates the _follow_ command.
+class HTTY::CLI::Commands::Follow < HTTY::CLI::Command
+
+  include HTTY::CLI::CookieClearingCommand
+
+  # Returns the name of a category under which help for the _follow_ command
+  # should appear.
+  def self.category
+    'Navigation'
+  end
+
+  # Returns the help text for the _follow_ command.
+  def self.help
+    "Changes the address of the request to the value of the response's " +
+    "'Location' header"
+  end
+
+  # Returns the extended help text for the _follow_ command.
+  def self.help_extended
+    "Changes the address of the request to the value of the response's " +
+    "'Location' header. Does not communicate with the endpoint."
+  end
+
+  # Returns related command classes for the _follow_ command.
+  def self.see_also_commands
+    [HTTY::CLI::Commands::Address, HTTY::CLI::Commands::HttpGet]
+  end
+
+  # Performs the _follow_ command.
+  def perform
+    unless arguments.empty?
+      raise ArgumentError,
+            "wrong number of arguments (#{arguments.length} for 0)"
+    end
+
+    add_request_if_has_response do |request|
+      notify_if_cookies_cleared request do
+        request.follow session.last_response
+      end
+    end
+  end
+
+end

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

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

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

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

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

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

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

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