1and1 1.1

data/lib/oneandone.rb

@@ -0,0 +1,27 @@
+require 'excon'
+require 'json'
+
+# Top-Level Module
+module OneAndOne
+  require_relative '1and1/oneandone'
+  require_relative '1and1/server'
+  require_relative '1and1/image'
+  require_relative '1and1/shared_storage'
+  require_relative '1and1/firewall'
+  require_relative '1and1/load_balancer'
+  require_relative '1and1/public_ip'
+  require_relative '1and1/private_network'
+  require_relative '1and1/monitoring_center'
+  require_relative '1and1/monitoring_policy'
+  require_relative '1and1/log'
+  require_relative '1and1/user'
+  require_relative '1and1/usage'
+  require_relative '1and1/server_appliance'
+  require_relative '1and1/dvd'
+  require_relative '1and1/datacenter'
+  require_relative '1and1/pricing'
+  require_relative '1and1/ping'
+  require_relative '1and1/ping_auth'
+  require_relative '1and1/vpn'
+  require_relative '1and1/role'
+end

data/sphinx/Makefile

@@ -0,0 +1,192 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
+
+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 "  applehelp  to make an Apple Help Book"
+	@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 "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of 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)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@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.qhc"
+
+applehelp:
+	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+	@echo
+	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+	@echo "N.B. You won't be able to view it unless you put it in" \
+	      "~/Library/Documentation/Help or install it in your application" \
+	      "bundle."
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/1and1RubySDK"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/1and1RubySDK"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+coverage:
+	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+	@echo "Testing of coverage in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/coverage/python.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

data/sphinx/_build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 373af2a432adf9024c467adb4d8ad625
+tags: 645f666f9bcd5a90fca523b33c5a78b7

data/sphinx/_build/html/_sources/dvds.txt

@@ -0,0 +1,42 @@
+DVD's
+*****************
+
+.. rb:class:: OneAndOne::Dvd()
+   
+   The :rb:class:`Dvd` 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)
+
+     List all DVD's on your account.
+
+     :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:: get(dvd_id: nil)
+
+     Returns information about a DVD.
+
+     :param dvd_id: the unique identifier for the DVD.
+     :type dvd_id: ``str``
+
+     :rtype: JSON

data/sphinx/_build/html/_sources/firewalls.txt

@@ -0,0 +1,189 @@
+Firewall Policies
+*****************
+
+.. rb:class:: OneAndOne::Firewall()
+   
+   The :rb:class:`Firewall` 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 shared storages.
+
+     :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, rules: nil)
+
+     Create a firewall policy.
+
+     :param name: firewall policy's name.
+     :type name: ``str``
+
+     :param description: firewall policy's name.
+     :type description: ``str``
+
+     :param rules: an array of rules for the new firewall policy.
+     :type rules: ``array``
+
+     :rtype: JSON
+
+
+   .. rb:method:: get(firewall_id: @id)
+
+     Returns a firewall policy's current specs.
+
+     :param firewall_id: the unique identifier for the firewall.
+     :type firewall_id: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: modify(firewall_id: @id, name: nil, description: nil)
+
+     Modify a firewall policy.
+
+     :param firewall_id: the unique identifier for the firewall policy.
+     :type firewall_id: ``str``
+
+     :param name: firewall policy name.
+     :type name: ``str``
+
+     :param description: firewall policy description.
+     :type description: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: delete(firewall_id: @id)
+
+     Delete a firewall policy.
+
+     :param firewall_id: the unique identifier for the firewall.
+     :type firewall_id: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: ips(firewall_id: @id)
+
+     Returns a list of the IPs assigned to a firewall policy.
+
+     :param firewall_id: the unique identifier for the firewall.
+     :type firewall_id: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: ip(firewall_id: @id, ip_id: nil)
+
+     Returns information about an IP assigned to a firewall policy.
+
+     :param firewall_id: the unique identifier for the firewall policy.
+     :type firewall_id: ``str``
+
+     :param ip_id: the unique identifier for the IP.
+     :type ip_id: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: add_ips(firewall_id: @id, ips: nil)
+
+     Add IPs to a firewall policy.
+
+     :param firewall_id: the unique identifier for the firewall policy.
+     :type firewall_id: ``str``
+
+     :param ips: an array of IP ID's for the new firewall policy..
+     :type ips: ``array``
+
+     :rtype: JSON
+
+
+   .. rb:method:: remove_ip(firewall_id: @id, ip_id: nil)
+
+     Remove an IP from a firewall policy.
+
+     :param firewall_id: the unique identifier for the firewall policy.
+     :type firewall_id: ``str``
+
+     :param ip_id: the unique identifier for the IP.
+     :type ip_id: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: rules(firewall_id: @id)
+
+     Returns a list the firewall policy's rules.
+
+     :param firewall_id: the unique identifier for the firewall.
+     :type firewall_id: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: rule(firewall_id: @id, rule_id: nil)
+
+     Returns information about a firewall policy's rule.
+
+     :param firewall_id: the unique identifier for the firewall policy.
+     :type firewall_id: ``str``
+
+     :param rule_id: the unique identifier for the firewall rule.
+     :type rule_id: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: add_rules(firewall_id: @id, rules: nil)
+
+     Add rules to a firewall policy.
+
+     :param firewall_id: the unique identifier for the firewall policy.
+     :type firewall_id: ``str``
+
+     :param rules: an array of rule objects.
+     :type rules: ``array``
+
+     :rtype: JSON
+
+
+   .. rb:method:: remove_rule(firewall_id: @id, rule_id: nil)
+
+     Remove a firewall policy's rule.
+
+     :param firewall_id: the unique identifier for the firewall policy.
+     :type firewall_id: ``str``
+
+     :param rule_id: the unique identifier for the firewall rule.
+     :type rule_id: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: wait_for()
+
+     Polls the firewall policy until an "ACTIVE" state is returned.  Use this when chaining actions.
+
+     :rtype: ``nil``