1and1 1.1

data/sphinx/load_balancers.rst

@@ -0,0 +1,231 @@
+Load Balancers
+*****************
+
+.. rb:class:: OneAndOne::LoadBalancer()
+   
+   The :rb:class:`LoadBalancer` class allows a user to perform actions against the 1and1 API.
+
+
+   .. rb:method:: list(page: nil, per_page: nil, sort: nil, q: nil, fields: nil)
+
+     Return a list of all load balancers.
+
+     :param page: Allows the use of pagination. Indicate which page to start on.
+     :type page: ``int``
+
+     :param per_page: Number of items per page.
+     :type per_page: ``int``
+
+     :param sort: ``sort: 'name'`` retrieves a list of elements sorted 
+       alphabetically. ``sort: 'creation_date'`` retrieves a list of elements 
+       sorted by their creation date in descending order.
+     :type sort: ``str``
+
+     :param q: ``q`` is for query. Use this parameter to return only the items 
+       that match your search query.
+     :type q: ``str``
+
+     :param fields: Returns only the parameters requested. 
+       (i.e. fields: 'id, name, description, hardware.ram')
+     :type fields: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: create(name: nil, description: nil, health_check_test: nil, health_check_interval: nil, persistence: nil, persistence_time: nil, method: nil, rules: nil, health_check_path: nil, health_check_parse: nil)
+
+     Create a load balancer.
+
+     :param name: load balancer name.
+     :type name: ``str``
+
+     :param description: load balancer description.
+     :type description: ``str``
+
+     :param health_check_test: possible values are ``"NONE"`` or ``"TCP"``.
+     :type health_check_test: ``str``
+
+     :param health_check_interval: Health check period in seconds.  Can range between ``5`` and ``300`` seconds.
+     :type health_check_interval: ``int``
+
+     :param persistence: enable or disable persistence.
+     :type persistence: ``bool``
+
+     :param persistence_time: Persistence time in seconds. Required if persistence is enabled.  Can range from ``30`` to ``1200`` seconds
+     :type persistence_time: ``int``
+
+     :param method: balancing procedure.  Possible values are ``"ROUND_ROBIN"`` or ``"LEAST_CONNECTIONS"``.
+     :type method: ``str`` 
+
+     :param rules: takes an array of "rule" objects to be added to the load balancer.
+     :type rules: ``array``
+
+     :param health_check_path: Url to call for checking. Required for HTTP health check.
+     :type health_check_path: ``str``
+
+     :param health_check_parse: Regular expression to check. Required for HTTP health check.
+     :type health_check_parse: ``str``
+
+
+   .. rb:method:: get(load_balancer_id: @id)
+
+     Returns the current specs of a load balancer.
+
+     :param load_balancer_id: the unique identifier for the load balancer.
+     :type load_balancer_id: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: modify(load_balancer_id: @id, name: nil, description: nil, health_check_test: nil, health_check_interval: nil, persistence: nil, persistence_time: nil, method: nil, health_check_path: nil, health_check_parse: nil)
+
+      Modify a load balancer.
+
+      :param load_balancer_id: the unique identifier for the load balancer.
+      :type load_balancer_id: ``str``
+
+      :param name: load balancer name.
+      :type name: ``str``
+
+      :param description: load balancer description.
+      :type description: ``str``
+
+      :param health_check_test: possible values are ``"NONE"``,``"TCP"``, or ``"HTTP"``.
+      :type health_check_test: ``str``
+
+      :param health_check_interval: Health check period in seconds.
+      :type health_check_interval: ``int``
+
+      :param persistence: enable or disable persistnece.
+      :type persistence: ``bool``
+
+      :param persistence_time: Persistence time in seconds. Required if persistence is enabled.
+      :type persistence_time: ``int``
+
+      :param method: balancing procedure.  possible values are ``"ROUND_ROBIN"`` or ``"LEAST_CONNECTIONS"``.
+      :type method: ``str``
+
+      :param health_check_path: Url to call for checking. Required for HTTP health check.
+      :type health_check_path: ``str``
+
+      :param health_check_parse: Regular expression to check. Required for HTTP health check.
+      :type health_check_parse: ``str``
+
+      :rtype: JSON
+
+
+   .. rb:method:: delete(load_balancer_id: @id)
+
+     Delete a load balancer.
+
+     :param load_balancer_id: the unique identifier for the load balancer.
+     :type load_balancer_id: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: ips(load_balancer_id: @id)
+
+     Returns a list of the IP's assigned to a load balancer.
+
+     Delete a load balancer.
+
+     :param load_balancer_id: the unique identifier for the load balancer.
+     :type load_balancer_id: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: ip(load_balancer_id: @id, ip_id: nil)
+
+     Returns information about an IP assigned to a load balancer.
+
+     :param load_balancer_id: the unique identifier for the load balancer.
+     :type load_balancer_id: ``str``
+
+     :param ip_id: the unique identifier for the IP.
+     :type ip_id: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: remove_ip(load_balancer_id: @id, ip_id: nil)
+
+     Remove an IP from a load balancer.
+
+     :param load_balancer_id: the unique identifier for the load balancer.
+     :type load_balancer_id: ``str``
+
+     :param ip_id: the unique identifier for the IP.
+     :type ip_id: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: add_ips(load_balancer_id: @id, ips: nil)
+
+     Assign IP's to a load balancer.
+
+     :param load_balancer_id: the unique identifier for the load balancer.
+     :type load_balancer_id: ``str``
+
+     :param ips: takes an array of IP strings to be added to the load balancer.
+     :type ips: ``array``
+
+     :rtype: JSON
+
+
+   .. rb:method:: rules(load_balancer_id: @id)
+
+     Returns a list of the load balancer's rules.
+
+     :param load_balancer_id: the unique identifier for the load balancer.
+     :type load_balancer_id: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: rule(load_balancer_id: @id, rule_id: nil)
+
+     Returns information about a load balancer's rule.
+
+     :param load_balancer_id: the unique identifier for the load balancer.
+     :type load_balancer_id: ``str``
+
+     :param rule_id: the unique identifier for the rule.
+     :type rule_id: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: add_rules(load_balancer_id: @id, rules: nil)
+
+     Add rules to a load balancer.
+
+     :param load_balancer_id: the unique identifier for the load balancer.
+     :type load_balancer_id: ``str``
+
+     :param rules: takes an array of "rule" objects to be added to the load balancer.
+     :type rules: ``array``
+
+     :rtype: JSON
+
+
+   .. rb:method:: remove_rule(load_balancer_id: @id, rule_id: nil)
+
+     Remove a load balancer's rule.
+
+     :param load_balancer_id: the unique identifier for the load balancer.
+     :type load_balancer_id: ``str``
+
+     :param rule_id: the unique identifier for the rule.
+     :type rule_id: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: wait_for()
+
+     Polls the load balancer until an "ACTIVE" state is returned.  Use this when chaining actions.
+
+     :rtype: ``nil``

data/sphinx/logs.rst

@@ -0,0 +1,55 @@
+Logs
+*****************
+
+.. rb:class:: OneAndOne::Log()
+   
+   The :rb:class:`Log` class allows a user to perform actions against the 1and1 API.
+
+
+   .. rb:method:: list(page: nil, per_page: nil, sort: nil, q: nil, fields: nil, period: 'LAST_24H', start_date: nil, end_date: nil)
+
+     List all logs by time period.
+
+     :param page: Allows the use of pagination. Indicate which page to start on.
+     :type page: ``int``
+
+     :param per_page: Number of items per page.
+     :type per_page: ``int``
+
+     :param sort: ``sort: 'name'`` retrieves a list of elements sorted 
+       alphabetically. ``sort: 'creation_date'`` retrieves a list of elements 
+       sorted by their creation date in descending order.
+     :type sort: ``str``
+
+     :param q: ``q`` is for query. Use this parameter to return only the items 
+       that match your search query.
+     :type q: ``str``
+
+     :param fields: Returns only the parameters requested. 
+       (i.e. fields: 'id, name, description, hardware.ram')
+     :type fields: ``str``
+
+     :param period: the time range of logs to be shown.  Possible values are 
+        ``'LAST_HOUR'``, ``'LAST_24H'``, ``'LAST_7D'``, ``'LAST_30D'``, 
+        ``'LAST_365D'``, or ``'CUSTOM'``
+     :type period: ``str``
+
+     :param start_date: start point.  Only required if using ``'CUSTOM'`` for the 
+        ``period`` parameter.  *Format:* ``2015-19-05T00:05:00Z``
+     :type start_date: ``str``
+
+     :param end_date: end point.  Only required if using ``'CUSTOM'`` for the 
+        ``period`` parameter.  *Format:* ``2015-19-05T00:10:00Z``
+     :type end_date: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: get(log_id: nil)
+
+     Returns information about a log
+
+     :param log_id: the unique identifier for the log.
+     :type log_id: ``str``
+
+     :rtype: JSON

data/sphinx/make.bat

@@ -0,0 +1,263 @@
+@ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=_build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+set I18NSPHINXOPTS=%SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+	set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+	:help
+	echo.Please use `make ^<target^>` where ^<target^> is one of
+	echo.  html       to make standalone HTML files
+	echo.  dirhtml    to make HTML files named index.html in directories
+	echo.  singlehtml to make a single large HTML file
+	echo.  pickle     to make pickle files
+	echo.  json       to make JSON files
+	echo.  htmlhelp   to make HTML files and a HTML help project
+	echo.  qthelp     to make HTML files and a qthelp project
+	echo.  devhelp    to make HTML files and a Devhelp project
+	echo.  epub       to make an epub
+	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
+	echo.  text       to make text files
+	echo.  man        to make manual pages
+	echo.  texinfo    to make Texinfo files
+	echo.  gettext    to make PO message catalogs
+	echo.  changes    to make an overview over all changed/added/deprecated items
+	echo.  xml        to make Docutils-native XML files
+	echo.  pseudoxml  to make pseudoxml-XML files for display purposes
+	echo.  linkcheck  to check all external links for integrity
+	echo.  doctest    to run all doctests embedded in the documentation if enabled
+	echo.  coverage   to run coverage check of the documentation if enabled
+	goto end
+)
+
+if "%1" == "clean" (
+	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+	del /q /s %BUILDDIR%\*
+	goto end
+)
+
+
+REM Check if sphinx-build is available and fallback to Python version if any
+%SPHINXBUILD% 1>NUL 2>NUL
+if errorlevel 9009 goto sphinx_python
+goto sphinx_ok
+
+:sphinx_python
+
+set SPHINXBUILD=python -m sphinx.__init__
+%SPHINXBUILD% 2> nul
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+:sphinx_ok
+
+
+if "%1" == "html" (
+	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+	goto end
+)
+
+if "%1" == "dirhtml" (
+	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+	goto end
+)
+
+if "%1" == "singlehtml" (
+	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
+	goto end
+)
+
+if "%1" == "pickle" (
+	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can process the pickle files.
+	goto end
+)
+
+if "%1" == "json" (
+	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can process the JSON files.
+	goto end
+)
+
+if "%1" == "htmlhelp" (
+	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in %BUILDDIR%/htmlhelp.
+	goto end
+)
+
+if "%1" == "qthelp" (
+	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\1and1RubySDK.qhcp
+	echo.To view the help file:
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\1and1RubySDK.ghc
+	goto end
+)
+
+if "%1" == "devhelp" (
+	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished.
+	goto end
+)
+
+if "%1" == "epub" (
+	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The epub file is in %BUILDDIR%/epub.
+	goto end
+)
+
+if "%1" == "latex" (
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+	goto end
+)
+
+if "%1" == "latexpdf" (
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+	cd %BUILDDIR%/latex
+	make all-pdf
+	cd %~dp0
+	echo.
+	echo.Build finished; the PDF files are in %BUILDDIR%/latex.
+	goto end
+)
+
+if "%1" == "latexpdfja" (
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+	cd %BUILDDIR%/latex
+	make all-pdf-ja
+	cd %~dp0
+	echo.
+	echo.Build finished; the PDF files are in %BUILDDIR%/latex.
+	goto end
+)
+
+if "%1" == "text" (
+	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The text files are in %BUILDDIR%/text.
+	goto end
+)
+
+if "%1" == "man" (
+	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The manual pages are in %BUILDDIR%/man.
+	goto end
+)
+
+if "%1" == "texinfo" (
+	%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
+	goto end
+)
+
+if "%1" == "gettext" (
+	%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
+	goto end
+)
+
+if "%1" == "changes" (
+	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.The overview file is in %BUILDDIR%/changes.
+	goto end
+)
+
+if "%1" == "linkcheck" (
+	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Link check complete; look for any errors in the above output ^
+or in %BUILDDIR%/linkcheck/output.txt.
+	goto end
+)
+
+if "%1" == "doctest" (
+	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+	goto end
+)
+
+if "%1" == "coverage" (
+	%SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Testing of coverage in the sources finished, look at the ^
+results in %BUILDDIR%/coverage/python.txt.
+	goto end
+)
+
+if "%1" == "xml" (
+	%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The XML files are in %BUILDDIR%/xml.
+	goto end
+)
+
+if "%1" == "pseudoxml" (
+	%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
+	goto end
+)
+
+:end