1and1 1.1

data/sphinx/shared_storages.rst

@@ -0,0 +1,160 @@
+Shared Storages
+*****************
+
+.. rb:class:: OneAndOne::SharedStorage()
+   
+   The :rb:class:`SharedStorage` 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, size: nil)
+
+     Create a shared storage.
+
+     :param name: shared storage name.
+     :type name:  ``str``
+
+     :param description: shared storage description.
+     :type description: ``str``
+
+     :param size: shared storage size.
+     :type size: ``int``
+
+     :rtype: JSON
+
+
+   .. rb:method:: get(shared_storage_id: @id)
+
+     Returns a shared storage's current specs.
+
+     :param shared_storage_id: the unique identifier for the shared storage.
+     :type shared_storage_id: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: modify(shared_storage_id: @id, name: nil, description: nil, size: nil)
+
+     Modify a shared storage.
+
+     :param shared_storage_id: the unique identifier for the shared storage.
+     :type shared_storage_id: ``str``
+
+     :param name: shared storage name.
+     :type name: ``str``
+
+     :param description: shared storage description.
+     :type description: ``str``
+
+     :param size: shared storage size.  Must be a multiple of ``50``.
+     :type size: ``int``
+
+     :rtype: JSON
+
+
+   .. rb:method:: delete(shared_storage_id: @id)
+
+     Delete a shared storage.
+
+     :param shared_storage_id: the unique identifier for the shared storage.
+     :type shared_storage_id: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: add_servers(shared_storage_id: @id, servers: nil)
+
+     Add servers to a shared storage.
+
+     :param shared_storage_id: the unique identifier for the shared storage.
+     :type shared_storage_id: ``str``
+
+     :param servers: an array of server hashes.
+     :type servers: ``array``
+
+     :rtype: JSON
+
+
+   .. rb:method:: servers(shared_storage_id: @id)
+
+     List a shared storage's servers.
+
+     :param shared_storage_id: the unique identifier for the shared storage.
+     :type shared_storage_id: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: server(shared_storage_id: @id, server_id: nil)
+
+     Returns information about a shared storage's server.
+
+     :param shared_storage_id: the unique identifier for the shared storage.
+     :type shared_storage_id: ``str``
+
+     :param server_id: the unique identifier for the server.
+     :type server_id: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: remove_server(shared_storage_id: @id, server_id: nil)
+
+     Remove a server from a shared storage.
+
+     :param shared_storage_id: the unique identifier for the shared storage.
+     :type shared_storage_id: ``str``
+
+     :param server_id: the unique identifier for the server.
+     :type server_id: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: access()
+
+     Retrieve the credentials for accessing shared storages.
+
+     :rtype: JSON
+
+
+   .. rb:method:: change_password(password: nil)
+
+     Change the password for accessing shared storages.
+
+     :param password: new shared storage password.
+     :type password: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: wait_for()
+
+     Polls the shared storage until an "ACTIVE" state is returned.  Use this when chaining actions.
+
+     :rtype: ``nil``

data/sphinx/usages.rst

@@ -0,0 +1,45 @@
+Usages
+*****************
+
+.. rb:class:: OneAndOne::Usage()
+   
+   The :rb:class:`Usage` 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 usages 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

data/sphinx/users.rst

@@ -0,0 +1,172 @@
+Users
+*****************
+
+.. rb:class:: OneAndOne::User()
+   
+   The :rb:class:`User` 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 users 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:: create(name: nil, description: nil, password: nil, email: nil)
+
+     Create a new user account.
+
+     :param name: user name.
+     :type name: ``str``
+
+     :param description: user description.
+     :type description: ``str``
+
+     :param password: user password.
+     :type password: ``str``
+
+     :param email: user email.
+     :type email: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: get(user_id: @id)
+
+     Returns a user account's current specs.
+
+     :param user_id: the unique identifier for the user.
+     :type user_id: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: modify(user_id: @id, description: nil, password: nil, email: nil, state: nil)
+
+     Modify a user account.
+
+     :param user_id: the unique identifier for the user.
+     :type user_id: ``str``
+
+     :param password: user password.
+     :type password: ``str``
+
+     :param email: user email.
+     :type email: ``str``
+
+     :param description: user description.
+     :type description: ``str``
+
+     :param state: allows you to enable and disable users.  Possible values are ``"ACTIVE"`` or ``"DISABLE"``.
+     :type state: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: delete(user_id: @id)
+
+     Delete a user account.
+
+     :param user_id: the unique identifier for the user.
+     :type user_id: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: api(user_id: @id)
+
+     Return a user's API access credentials.
+
+     :param user_id: the unique identifier for the user.
+     :type user_id: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: enable_api(user_id: @id, active: nil)
+
+     Enable or disable a user's API access.
+
+     :param user_id: the unique identifier for the user.
+     :type user_id: ``str``
+
+     :param active: API access.
+     :type active: ``bool``
+
+     :rtype: JSON
+
+
+   .. rb:method:: api_key(user_id: @id)
+
+     Return a user's API key.
+
+     :param user_id: the unique identifier for the user.
+     :type user_id: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: change_key(user_id: @id)
+
+     Change a user's API key.
+
+     :param user_id: the unique identifier for the user.
+     :type user_id: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: ips(user_id: @id)
+
+     List the IP's from which a user can access the API.
+
+     :param user_id: the unique identifier for the user.
+     :type user_id: ``str``
+
+     :rtype: JSON
+
+
+   .. rb:method:: add_ips(user_id: @id, ips: nil)
+
+     Add IP's from which a user can access the API.
+
+     :param user_id: the unique identifier for the user.
+     :type user_id: ``str``
+
+     :param ips: an array containing at least one IP string.
+     :type ips: ``array``
+
+     :rtype: JSON
+
+
+   .. rb:method:: remove_ip(user_id: @id, ip: nil)
+
+     Remove API access for an IP.
+
+     :param user_id: the unique identifier for the user.
+     :type user_id: ``str``
+
+     :param ip: IP to be removed.
+     :type ip: ``str``
+
+     :rtype: JSON

data/test/mock-api/add-firewall.json

@@ -0,0 +1,66 @@
+{
+  "id": "92AA60BEC8333A21EDB9EAAA61852860",
+  "cloudpanel_id": "5061DE9",
+  "name": "My server",
+  "description": null,
+  "creation_date": "2015-05-06T11:09:55+00:00",
+  "first_password": null,
+  "status": {
+    "state": "POWERED_ON",
+    "percent": null
+  },
+  "hardware": {
+    "fixed_instance_size_id": 0,
+    "vcore": 1,
+    "cores_per_processor": 1,
+    "ram": 1,
+    "hdds": [
+    {
+      "id": "77F5BC74C9B3532A37D31FEED070BE01",
+      "size": 40,
+      "is_main": true
+    }
+    ]
+  },
+  "image": {
+    "id": "07C170D67C8EC776933FCFF1C299C1C5",
+    "name": "w2012r2datacenter64min"
+  },
+  "dvd": {
+    "id": "05F2EF8C89A12782B7DBE445256BD7A5",
+    "name": "centos7-64iso"
+  },
+  "snapshot": null,
+  "ips": [
+  {
+    "id": "696469547988D3945B3FE59DFCB93C90",
+    "ip": "10.4.141.161",
+    "type": "IPV4",
+    "reverse_dns": null,
+    "firewall_policy": {
+      "id": "5DE607955050915229D602931F942F32",
+      "name": "Linux"
+    },
+    "load_balancers": []
+  }
+  ],
+  "alerts": {
+    "critical": [
+    {
+      "type": "agent",
+      "description": "MONITORING_AGENT_NOT_INSTALLED",
+      "date": "2015-05-07 10:11:02"
+    },
+    {
+      "type": "internal_ping",
+      "description": "CRITICAL - 10.4.141.161: rta nan, lost 100%",
+      "date": "2015-05-07 09:59:21"
+    }
+    ]
+  },
+  "monitoring_policy": {
+    "id": "5DF232A92E9635249B8A4EB31C5B14F4",
+    "name": "My Monitoring Policy 1"
+  },
+  "private_networks": null
+}

data/test/mock-api/add-hdd.json

@@ -0,0 +1,49 @@
+{
+  "id": "4B86A3ACC4CEB7A89E012E49FC17F312",
+  "cloudpanel_id": "FE7ED7D",
+  "name": "My Server remame",
+  "description": "My server rename description",
+  "creation_date": "2015-05-07T08:25:37+00:00",
+  "first_password": "Nm4gP97xSw",
+  "status": {
+    "state": "CONFIGURING",
+    "percent": 10
+  },
+  "hardware": {
+    "fixed_instance_size_id": 0,
+    "vcore": 2,
+    "cores_per_processor": 1,
+    "ram": 2,
+    "hdds": [
+    {
+      "id": "0DDE06DFA47743DF928E76AE7DC195C1",
+      "size": 40,
+      "is_main": true
+    },
+    {
+      "id": "B6DAEB7FA4D0CABFD8FE878EC467CA7E",
+      "size": 20,
+      "is_main": false
+    }
+    ]
+  },
+  "image": {
+    "id": "07C170D67C8EC776933FCFF1C299C1C5",
+    "name": "w2012r2datacenter64min"
+  },
+  "dvd": null,
+  "snapshot": null,
+  "ips": [
+  {
+    "id": "D609028BC090EE05665072C721EA4A7A",
+    "ip": "10.4.141.43",
+    "type": "IPV4",
+    "reverse_dns": null,
+    "firewall_policy": null,
+    "load_balancers": []
+  }
+  ],
+  "alerts": [],
+  "monitoring_policy": null,
+  "private_networks": null
+}