fog-profitbricks 3.0.0 → 4.0.0

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

@@ -0,0 +1,66 @@
+module Fog
+  module Compute
+    class ProfitBricks
+      class Real
+        # Retrieves a list of all resources and optionally their group associations.
+        # Please note that this API call can take a significant amount of time to return when
+        # there are a large number of provisioned resources.
+        #
+        # ==== 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)
+        #       * metadata<~Hash>               - Hash containing the metadata for the specific resource.
+        #         * createdDate<~String>        - A time and date stamp indicating when the resource was created.
+        #         * createdBy<~String>          - The user who created the resource.
+        #         * etag<~String>               - Resource's ETag.
+        #         * lastModifiedDate<~String>   - A time and date stamp indicating when the resource was last modified.
+        #         * lastModifiedBy<~String>     - The user who last modified the resource.
+        #         * state<~String>              - The current state of the resource. [ AVAILABLE, BUSY, INACTIVE ]
+        #       * entities<~Hash>               - A hash containing groups the resource is associated with.
+        #         * groups<~Hash>               - A collection of groups associated with the resource.
+        #           * 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>
+        #             * 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.
+        #
+        # {ProfitBricks API Documentation}[https://devops.profitbricks.com/api/cloud/v4/#list-resources]
+        def get_all_resources
+          request(
+            :expects => [200],
+            :method  => 'GET',
+            :path    => "/um/resources?depth=2"
+          )
+        end
+      end
+
+      class Mock
+        def get_all_resources
+          response        = Excon::Response.new
+          response.status = 200
+          response.body   = data[:resources]
+
+          response
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+module Fog
+  module Compute
+    class ProfitBricks
+      class Real
+        # Retrieve a full list of all the resources that are shared through this group
+        # and lists the permissions granted to the group members for each shared resource.
+        #
+        # ==== Parameters
+        # * group_id<~String> - Required, The ID of a specific group.
+        #
+        # ==== 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.
+        #         * editPrivilege<~Boolean>   - The group has permission to edit privileges on this resource.
+        #         * sharePrivilege<~Boolean>  - The group has permission to share this resource.
+        #
+        # {ProfitBricks API Documentation}[https://devops.profitbricks.com/api/cloud/v4/#list-shares]
+        def get_all_shares(group_id)
+          request(
+            :expects => [200],
+            :method  => 'GET',
+            :path    => "/um/groups/#{group_id}/shares?depth=1"
+          )
+        end
+      end
+
+      class Mock
+        def get_all_shares(group_id)
+          response        = Excon::Response.new
+          response.status = 200
+          response.body   = data[:shares]
+
+          response
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+module Fog
+  module Compute
+    class ProfitBricks
+      class Real
+        # Retrieve a list of all the users that have been created under a contract.
+        #
+        # ==== 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 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.
+        #       * entities<~Hash>           - Hash containing resources the user owns, and groups the user is a member of.
+        #         * owns<~Hash>             - Hash containing resources the user owns.
+        #           * 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).
+        #           * items<~Array>
+        #             * 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).
+        #         * groups<~Hash>           - Hash containing groups the user is a member of.
+        #           * 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).
+        #           * items<~Array>
+        #             * 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).
+        #
+        # {ProfitBricks API Documentation}[https://devops.profitbricks.com/api/cloud/v4/#list-users]
+        def get_all_users
+          request(
+            :expects => [200],
+            :method  => 'GET',
+            :path    => "/um/users?depth=1"
+          )
+        end
+      end
+
+      class Mock
+        def get_all_users
+          response        = Excon::Response.new
+          response.status = 200
+          response.body   = data[:users]
+
+          response
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+module Fog
+  module Compute
+    class ProfitBricks
+      class Real
+        # Retrieves the attributes of a given volume
+        #
+        # ==== Parameters
+        # * group_id<~String>      - Required, UUID of the group
+        #
+        # ==== Returns
+        # * response<~Excon::Response>:
+        #   * body<~Hash>:
+        #     * 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/#retrieve-a-group]
+        def get_group(group_id)
+          request(
+            :expects => [200],
+            :method  => "GET",
+            :path    => "/um/groups/#{group_id}"
+          )
+        end
+      end
+
+      class Mock
+        def get_group(group_id)
+          if group = data[:groups]['items'].find do |grp|
+            grp["id"] == group_id
+          end
+          else
+            raise Excon::Error::HTTPStatus, "The requested resource could not be found"
+          end
+
+          response        = Excon::Response.new
+          response.status = 200
+          response.body   = group
+          response
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+module Fog
+  module Compute
+    class ProfitBricks
+      class Real
+        # Retrieves a full list of all the users that are members of a particular group.
+        #
+        # ==== 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 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.
+        #       * entities<~Hash>           - Hash containing resources the user owns, and groups the user is a member of.
+        #         * owns<~Hash>             - Hash containing resources the user owns.
+        #           * 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).
+        #           * items<~Array>
+        #             * 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).
+        #         * groups<~Hash>           - Hash containing groups the user is a member of.
+        #           * 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).
+        #           * items<~Array>
+        #             * 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).
+        #
+        # {ProfitBricks API Documentation}[https://devops.profitbricks.com/api/cloud/v4/#list-users-in-a-group]
+        def get_group_users(group_id)
+          request(
+            :expects => [200],
+            :method  => 'GET',
+            :path    => "/um/groups/#{group_id}/users?depth=2"
+          )
+        end
+      end
+
+      class Mock
+        def get_group_users(group_id)
+          if users = data[:groups]['items']['users'].find do |usr|
+            usr["groups"]["items"].find do |grp|
+              grp["id"] == group_id
+            end
+          end
+          else
+            raise Fog::Errors::NotFound, "The requested resource could not be found"
+          end
+
+          response        = Excon::Response.new
+          response.status = 200
+          response.body = users
+          response
+        end
+      end
+    end
+  end
+end

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

@@ -28,6 +28,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/get_resource_by_type.rb

@@ -0,0 +1,73 @@
+module Fog
+  module Compute
+    class ProfitBricks
+      class Real
+        # ==== Parameters
+        # * resource_type<~String>  - Required, Type of resource. [datacenter, image, snapshot, ipblock]
+        # * resource_id<~String>    - Required, The ID of the specific resource to retrieve information about.
+        #
+        # ==== Returns
+        # * response<~Excon::Response>:
+        #   * body<~Hash>:
+        #     * id<~String>                 - The resource's unique identifier.
+        #     * type<~String>               - The type of the requested resource.
+        #     * href<~String>               - A URI for accessing the resource object.
+        #     * metadata<~Hash>             - Hash containing metadata for the specific resource.
+        #       * createdDate<~String>      - A time and date stamp indicating when the resource was created.
+        #       * createdBy<~String>        - The user who created the resource.
+        #       * etag<~String>             - Resource's ETag.
+        #       * lastModifiedDate<~String> - A time and date stamp indicating when the resource was last modified.
+        #       * lastModifiedBy<~String>   - The user who last modified the resource.
+        #       * state<~String>            - The current state of the resource. [ AVAILABLE, BUSY, INACTIVE ]
+        #     * entities<~Hash>             - Hash containing groups the resource is associated with.
+        #       * groups<~Hash>             - Hash containing groups associated with the resource.
+        #         * 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).
+        #         * items<~Array>
+        #           * 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/#list-a-specific-resource-type]
+        def get_resource_by_type(resource_type, resource_id)
+          request(
+            :expects => [200],
+            :method  => 'GET',
+            :path    => "/um/resources/#{resource_type}/#{resource_id}?depth=2"
+          )
+        end
+      end
+
+      class Mock
+        def get_resource_by_type(resource_type, resource_id)
+          response        = Excon::Response.new
+          response.status = 200
+          response.body   = data[:resources]
+
+          response
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+module Fog
+  module Compute
+    class ProfitBricks
+      class Real
+        # List all shareable resources of a specific type.
+        # Optionally include their association with groups, permissions that a group has
+        # for the resource, and users that are members of the group.
+        #
+        # ==== Parameters
+        # * resource_type<~String> - Required, Type of resource. [datacenter, image, snapshot, ipblock]
+        #
+        # ==== Returns
+        # * response<~Excon::Response>:
+        #   * body<~Hash>:
+        #     * id<~String>                   - "resources"
+        #     * type<~String>                 - The type of response, in this case it will be "collection".
+        #     * href<~String>                 - A URI for accessing the object. "baseurl/um/resources"
+        #     * items<~Array>                 - A collection containing the available resources.
+        #       * id<~String>                   - The resource's unique identifier
+        #       * type<~String>                 - The type of object.
+        #       * href<~String>                 - A URI for accessing the object.
+        #
+        # {ProfitBricks API Documentation}[https://devops.profitbricks.com/api/cloud/v4/#list-all-resources-of-a-type]
+        def get_resources_by_type(resource_type)
+          request(
+            :expects => [200],
+            :method  => 'GET',
+            :path    => "/um/resources/#{resource_type}?depth=2"
+          )
+        end
+      end
+
+      class Mock
+        def get_resources_by_type(resource_type)
+          response        = Excon::Response.new
+          response.status = 200
+          response.body   = data[:resources]
+
+          response
+        end
+      end
+    end
+  end
+end