fog-profitbricks 3.0.0 → 4.0.0

data/lib/fog/profitbricks/requests/compute/create_group.rb

@@ -0,0 +1,85 @@
+module Fog
+  module Compute
+    class ProfitBricks
+      class Real
+        # Create a new group and set group privileges.
+        #
+        # ==== Parameters
+        # * options<~Hash>:
+        #   * name<~String>               - Required, The name of the group.
+        #   * createDataCenter<~Boolean>  - The group will be allowed to create virtual data centers.
+        #   * createSnapshot<~Boolean>    - The group will be allowed to create snapshots.
+        #   * reserveIp<~Boolean>         - The group will be allowed to reserve IP addresses.
+        #   * accessActivityLog<~Boolean> - The group will be allowed to access the activity log.
+        #
+        # ==== Returns
+        # * response<~Excon::Response>:
+        #   * body<~Hash>:
+        #     * id<~String>                   - The resource's unique identifier.
+        #     * type<~String>                 - The type of the created resource.
+        #     * href<~String>                 - URL to the object's representation (absolute path).
+        #     * properties<~Hash>             - Hash containing the volume properties.
+        #       * name<~String>               - The name of the group.
+        #       * createDataCenter<~Boolean>  - The group will be allowed to create virtual data centers.
+        #       * createSnapshot<~Boolean>    - The group will be allowed to create snapshots.
+        #       * reserveIp<~Boolean>         - The group will be allowed to reserve IP addresses.
+        #       * accessActivityLog<~Boolean> - The group will be allowed to access the activity log.
+        #     * entities<~Hash>               - A hash containing the group entities.
+        #       * users<~Hash>                - A collection of users that belong to this group.
+        #         * id<~String>               - The resource's unique identifier.
+        #         * type<~String>             - The type of the requested resource.
+        #         * href<~String>             - URL to the object’s representation (absolute path).
+        #         * items<~Array>             - The array containing individual user resources.
+        #       * resources<~Hash>            - A collection of resources that are assigned to this group.
+        #         * id<~String>               - The resource's unique identifier.
+        #         * type<~String>             - The type of the requested resource.
+        #         * href<~String>             - URL to the object’s representation (absolute path).
+        #         * items<~Array>             - An array containing individual resources.
+        #           * id<~String>               - The resource's unique identifier.
+        #           * type<~String>             - The type of the requested resource.
+        #           * href<~String>             - URL to the object’s representation (absolute path).
+        #
+        # {ProfitBricks API Documentation}[https://devops.profitbricks.com/api/cloud/v4/#create-a-group]
+        def create_group(options = {})
+          group = {
+            :properties => options
+          }
+
+          request(
+            :expects => [202],
+            :method   => 'POST',
+            :path     => "/um/groups",
+            :body     => Fog::JSON.encode(group)
+          )
+        end
+      end
+
+      class Mock
+        def create_group(options = {})
+          response = Excon::Response.new
+          response.status = 202
+
+          group_id = Fog::UUID.uuid
+
+          group = {
+            'id' => group_id,
+            'type'      => 'group',
+            'href'      => "https=>//api.profitbricks.com/rest/v4/um/groups/#{group_id}",
+            'properties' => {
+                'name'              => options[:name],
+                'createDataCenter'  => options[:create_data_center],
+                'createSnapshot'    => options[:create_snapshot],
+                'reserveIp'         => options[:reserve_ip],
+                'accessActivityLog' => options[:access_activity_log]
+            }
+          }
+
+          data[:groups]['items'] << group
+
+          response.body = group
+          response
+        end
+      end
+    end
+  end
+end

data/lib/fog/profitbricks/requests/compute/create_lan.rb

@@ -32,6 +32,7 @@ module Fog
         #       * properties<~Hash> - Hash containing the LAN properties
         #         * name<~String>             - The name of the LAN
         #         * public<~Boolean>          - Boolean indicating if the LAN faces the public Internet or not
+        #         * ipFailover<~Array>        - Attributes related to IP failover groups
         #       * entities<~Hash>   - Hash containing the LAN entities
         #         * nics<~Hash> - Hash containing the NIC properties
         #           * id<~String> 		  - The resource's unique identifier

data/lib/fog/profitbricks/requests/compute/create_user.rb

@@ -0,0 +1,83 @@
+module Fog
+  module Compute
+    class ProfitBricks
+      class Real
+        # Create a new user under a particular contract.
+        #
+        # ==== Parameters
+        # * options<~Hash>:
+        #   * firstname<~String>      - Required, The name of the group.
+        #   * lastname<~String>       - Required, The group will be allowed to create virtual data centers.
+        #   * email<~String>          - Required, The group will be allowed to create snapshots.
+        #   * password<~String>       - Required, The group will be allowed to reserve IP addresses.
+        #   * administrator<~Boolean> - The group will be allowed to access the activity log.
+        #   * forceSecAuth<~Boolean>  - The group will be allowed to access the activity log.
+        #
+        # ==== Returns
+        # * response<~Excon::Response>:
+        #   * body<~Hash>:
+        #     * id<~String>               - The resource's unique identifier.
+        #     * type<~String>             - The type of the created resource.
+        #     * href<~String>             - URL to the object's representation (absolute path).
+        #     * metadata<~Hash>           - Hash containing metadata for the user.
+        #       * etag<~String>           - ETag of the user.
+        #       * creationDate<~String>   - A time and date stamp indicating when the user was created.
+        #       * lastLogin<~String>      - A time and date stamp indicating when the user last logged in.
+        #     * properties<~Hash>         - Hash containing the user's properties.
+        #       * firstname<~String>      - The first name of the user.
+        #       * lastname<~String>       - The last name of the user.
+        #       * email<~String>          - The e-mail address of the user.
+        #       * administrator<~Boolean> - Indicates if the user has administrative rights.
+        #       * forceSecAuth<~Boolean>  - Indicates if secure (two-factor) authentication was enabled for the user.
+        #       * secAuthActive<~Boolean> - Indicates if secure (two-factor) authentication is enabled for the user.
+        #
+        # {ProfitBricks API Documentation}[https://devops.profitbricks.com/api/cloud/v4/#create-a-user]
+        def create_user(options = {})
+          user = {
+            :properties => options
+          }
+
+          request(
+            :expects => [202],
+            :method   => 'POST',
+            :path     => "/um/users",
+            :body     => Fog::JSON.encode(user)
+          )
+        end
+      end
+
+      class Mock
+        def create_user(options = {})
+          response = Excon::Response.new
+          response.status = 202
+
+          user_id = Fog::UUID.uuid
+
+          user = {
+            'id' => user_id,
+            'type'      => 'user',
+            'href'      => "https=>//api.profitbricks.com/rest/v4/um/users/#{user_id}",
+            'metadata' => {
+                'etag'         => '26a6259cc0c1dae299a5687455dff0ce',
+                'creationDate' => '2017-05-22T08:15:55Z',
+                'lastLogin'    => '',
+            },
+            'properties' => {
+                'firstname'     => options[:firstname],
+                'lastname'      => options[:lastname],
+                'email'         => options[:email],
+                'password'      => options[:password],
+                'administrator' => options[:administrator],
+                'forceSecAuth'  => options[:force_sec_auth]
+            }
+          }
+
+          data[:users]['items'] << user
+
+          response.body = user
+          response
+        end
+      end
+    end
+  end
+end

data/lib/fog/profitbricks/requests/compute/create_volume.rb

@@ -11,6 +11,7 @@ module Fog
         #   * size<~Integer>          - Required, the size of the volume in GB
         #   * bus<~String>            - The bus type of the volume (VIRTIO or IDE). Default: VIRTIO.
         #   * image<~String>          - Required**, the image or snapshot ID
+        #   * imageAlias<~String>     - Required**, an alias to a ProfitBricks public image. Use instead of "image".
         #   * type<~String>           - The volume type, HDD or SSD
         #   * licenceType<~String>    - Required**, the licence type of the volume. Options: LINUX, WINDOWS, UNKNOWN, OTHER
         #   * imagePassword<~String>  - One-time password is set on the Image for the appropriate account.

data/lib/fog/profitbricks/requests/compute/delete_group.rb

@@ -0,0 +1,43 @@
+module Fog
+  module Compute
+    class ProfitBricks
+      class Real
+        # Delete a single group.
+        # Resources that are assigned to the group are NOT deleted, but are no longer accessible
+        # to the group members unless the member is a Contract Owner, Admin, or Resource Owner.
+        #
+        # ==== Parameters
+        # * group_id<~String>          - UUID of the group
+        #
+        # ==== Returns
+        # * response<~Excon::Response> - No response parameters
+        #   (HTTP/1.1 202 Accepted)
+        #
+        # {ProfitBricks API Documentation}[https://devops.profitbricks.com/api/cloud/v4/#delete-a-group]
+        def delete_group(group_id)
+          request(
+            :expects => [202],
+            :method  => 'DELETE',
+            :path    => "/um/groups/#{group_id}"
+          )
+        end
+      end
+
+      class Mock
+        def delete_group(group_id)
+          response = Excon::Response.new
+          response.status = 202
+
+          if group = data[:groups]['items'].find do |grp|
+            grp['id'] == group_id
+          end
+          else
+            raise Fog::Errors::NotFound, "The requested resource could not be found"
+          end
+
+          response
+        end
+      end
+    end
+  end
+end

data/lib/fog/profitbricks/requests/compute/delete_share.rb

@@ -0,0 +1,42 @@
+module Fog
+  module Compute
+    class ProfitBricks
+      class Real
+        # Remove a resource share from a specified group.
+        #
+        # ==== Parameters
+        # * group_id<~String>    - Required, The ID of the specific group containing the resource to delete.
+        # * resource_id<~String> - Required, The ID of the specific resource to delete.
+        #
+        # ==== Returns
+        # * response<~Excon::Response> - No response parameters
+        #   (HTTP/1.1 202 Accepted)
+        #
+        # {ProfitBricks API Documentation}[https://devops.profitbricks.com/api/cloud/v4/#delete-a-share]
+        def delete_share(group_id, resource_id)
+          request(
+            :expects => [202],
+            :method  => 'DELETE',
+            :path    => "/um/groups/#{group_id}/shares/#{resource_id}"
+          )
+        end
+      end
+
+      class Mock
+        def delete_share(group_id, resource_id)
+          response = Excon::Response.new
+          response.status = 202
+
+          if share = data[:shares]['items'].find do |shr|
+            shr['id'] == resource_id
+          end
+          else
+            raise Fog::Errors::NotFound, "The requested resource could not be found"
+          end
+
+          response
+        end
+      end
+    end
+  end
+end

data/lib/fog/profitbricks/requests/compute/delete_user.rb

@@ -0,0 +1,43 @@
+module Fog
+  module Compute
+    class ProfitBricks
+      class Real
+        # Blacklists the user, disabling them.
+        # The user is not completely purged, therefore if you anticipate needing to create
+        # a user with the same name in the future, we suggest renaming the user before you delete it.
+        #
+        # ==== Parameters
+        # * user_id<~String>          - UUID of the user
+        #
+        # ==== Returns
+        # * response<~Excon::Response> - No response parameters
+        #   (HTTP/1.1 202 Accepted)
+        #
+        # {ProfitBricks API Documentation}[https://devops.profitbricks.com/api/cloud/v4/#delete-a-user]
+        def delete_user(user_id)
+          request(
+            :expects => [202],
+            :method  => 'DELETE',
+            :path    => "/um/users/#{user_id}"
+          )
+        end
+      end
+
+      class Mock
+        def delete_user(user_id)
+          response = Excon::Response.new
+          response.status = 202
+
+          if user = data[:users]['items'].find do |usr|
+            usr['id'] == user_id
+          end
+          else
+            raise Fog::Errors::NotFound, "The requested resource could not be found"
+          end
+
+          response
+        end
+      end
+    end
+  end
+end

data/lib/fog/profitbricks/requests/compute/get_all_contract_resources.rb

@@ -0,0 +1,55 @@
+module Fog
+  module Compute
+    class ProfitBricks
+      class Real
+        # Get all contract resources
+        #
+        # ==== Parameters
+        # * None
+        #
+        # ==== Returns
+        # * response<~Excon::Response>:
+        #   * body<~Hash>:
+        #     * type<~String>                 - The type of the requested resource
+        #     * properties<~Hash>
+        #       * contractNumber<~Integer>        - The contract number that the returned information is from
+        #       * owner<~String>                  - The username of the Contract Owner
+        #       * status<~String>                 - The status of the contract. [ BILLABLE...]
+        #       * resourceLimits<~Hash>           - An object containing the contract's resource limits
+        #         * coresPerServer<~Integer>        - Maximum number of CPU cores per server
+        #         * coresPerContract<~Integer>      - Maximum number of CPU cores per contract
+        #         * coresProvisioned<~Integer>      - The total number of CPU cores that have been provisioned
+        #         * ramPerServer<~Integer>          - The maximum amount of RAM (in MB) that may be provisioned for a particular server under this contract
+        #         * ramPerContract<~Integer>        - The maximum amount of RAM (in MB) that may be provisioned under this contract
+        #         * ramProvisioned<~Integer>        - The amount of RAM (in MB) that has been provisioned under this contract
+        #         * hddLimitPerVolume<~Integer>     - The maximum size (in MB) of an individual hard disk volume
+        #         * hddLimitPerContract<~Integer>   - The maximum amount of hard disk space (in MB) that may be provisioned under this contract
+        #         * hddVolumeProvisioned<~Integer>  - The amount of hard disk space (in MB) that is currently provisioned
+        #         * ssdLimitPerVolume<~Integer>     - The maximum size (in MB) of an individual solid state disk volume
+        #         * ssdLimitPerContract<~Integer>   - The maximum amount of solid state disk space (in MB) that may be provisioned under this contract
+        #         * ssdVolumeProvisioned<~Integer>  - The amount of solid state disk space (in MB) that is currently provisioned
+        #         * reservableIps<~Integer>         - The maximum number of static public IP addresses that may be reserved by this customer across all contracts
+        #         * reservedIpsOnContract<~Integer> - The maximum number of static public IP addresses that can be reserved under this contract
+        #         * reservedIpsInUse<~Integer>      - The number of static public IP addresses that have been reserved
+        #
+        # {ProfitBricks API Documentation}[https://devops.profitbricks.com/api/cloud/v4/#contract-resources]
+        def get_all_contract_resources
+          request(
+            :expects => [200],
+            :method  => 'GET',
+            :path    => "/contracts"
+          )
+        end
+      end
+
+      class Mock
+        def get_all_contract_resources
+          response        = Excon::Response.new
+          response.status = 200
+          response.body   = data[:contracts]
+          response
+        end
+      end
+    end
+  end
+end

data/lib/fog/profitbricks/requests/compute/get_all_groups.rb

@@ -0,0 +1,62 @@
+module Fog
+  module Compute
+    class ProfitBricks
+      class Real
+        # Retrieve a full list of all groups.
+        #
+        # ==== Parameters
+        # * None
+        #
+        # ==== Returns
+        # * response<~Excon::Response>:
+        #   * body<~Hash>:
+        #     * id<~String>                   - Id of the requested resource
+        #     * type<~String>                 - type of the requested resource
+        #     * href<~String>                 - url to the requested resource
+        #     * items<~Array>
+        #       * id<~String>                   - The resource's unique identifier
+        #       * type<~String>                 - The type of the requested resource
+        #       * href<~String>                 - URL to the object’s representation (absolute path)
+        #       * properties<~Hash>             - Hash containing the volume properties.
+        #         * name<~String>               - The name of the group.
+        #         * createDataCenter<~Boolean>  - The group will be allowed to create virtual data centers.
+        #         * createSnapshot<~Boolean>    - The group will be allowed to create snapshots.
+        #         * reserveIp<~Boolean>         - The group will be allowed to reserve IP addresses.
+        #         * accessActivityLog<~Boolean> - The group will be allowed to access the activity log.
+        #       * entities<~Hash>               - A hash containing the group entities.
+        #         * users<~Hash>                - A collection of users that belong to this group.
+        #           * id<~String>               - The resource's unique identifier.
+        #           * type<~String>             - The type of the requested resource.
+        #           * href<~String>             - URL to the object’s representation (absolute path).
+        #           * items<~Array>             - The array containing individual user resources.
+        #         * resources<~Hash>            - A collection of resources that are assigned to this group.
+        #           * id<~String>               - The resource's unique identifier.
+        #           * type<~String>             - The type of the requested resource.
+        #           * href<~String>             - URL to the object’s representation (absolute path).
+        #           * items<~Array>             - An array containing individual resources.
+        #             * id<~String>               - The resource's unique identifier.
+        #             * type<~String>             - The type of the requested resource.
+        #             * href<~String>             - URL to the object’s representation (absolute path).
+        #
+        # {ProfitBricks API Documentation}[https://devops.profitbricks.com/api/cloud/v4/#list-groups]
+        def get_all_groups
+          request(
+            :expects => [200],
+            :method  => 'GET',
+            :path    => "/um/groups?depth=1"
+          )
+        end
+      end
+
+      class Mock
+        def get_all_groups
+          response        = Excon::Response.new
+          response.status = 200
+          response.body   = data[:groups]
+
+          response
+        end
+      end
+    end
+  end
+end

data/lib/fog/profitbricks/requests/compute/get_all_lans.rb

@@ -27,6 +27,7 @@ module Fog
         #       * properties<~Hash> - Hash containing the LAN properties
         #         * name<~String>             - The name of the LAN
         #         * public<~Boolean>          - Boolean indicating if the LAN faces the public Internet or not
+        #         * ipFailover<~Array>        - Attributes related to IP failover groups
         #       * entities<~Hash>   - Hash containing the LAN entities
         #         * nics<~Hash> - Hash containing the NIC properties
         #           * id<~String> 		  - The resource's unique identifier