google-cloud-storage 1.18.1 → 1.44.0

data/lib/google/cloud/storage/hmac_key/list.rb

@@ -0,0 +1,182 @@
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require "delegate"
+
+module Google
+  module Cloud
+    module Storage
+      class HmacKey
+        ##
+        # HmacKey::List is a special case Array with additional values.
+        class List < DelegateClass(::Array)
+          ##
+          # If not empty, indicates that there are more HMAC keys
+          # that match the request and this value should be passed to
+          # the next {Google::Cloud::Storage::Project#hmac_keys} to continue.
+          attr_accessor :token
+
+          ##
+          # @private Create a new HmacKey::List with an array of values.
+          def initialize arr = []
+            super arr
+          end
+
+          ##
+          # Whether there is a next page of HMAC keys.
+          #
+          # @return [Boolean]
+          #
+          # @example
+          #   require "google/cloud/storage"
+          #
+          #   storage = Google::Cloud::Storage.new
+          #
+          #   hmac_keys = storage.hmac_keys
+          #   if hmac_keys.next?
+          #     next_hmac_keys = hmac_keys.next
+          #   end
+          #
+          def next?
+            !token.nil?
+          end
+
+          ##
+          # Retrieve the next page of HMAC keys.
+          #
+          # @return [HmacKey::List]
+          #
+          # @example
+          #   require "google/cloud/storage"
+          #
+          #   storage = Google::Cloud::Storage.new
+          #
+          #   hmac_keys = storage.hmac_keys
+          #   if hmac_keys.next?
+          #     next_hmac_keys = hmac_keys.next
+          #   end
+          #
+          def next
+            return nil unless next?
+            ensure_service!
+            gapi = @service.list_hmac_keys \
+              service_account_email: @service_account_email,
+              show_deleted_keys: @show_deleted_keys, token: @token, max: @max,
+              user_project: @user_project
+
+            HmacKey::List.from_gapi \
+              gapi, @service,
+              service_account_email: @service_account_email,
+              show_deleted_keys: @show_deleted_keys, max: @max,
+              user_project: @user_project
+          end
+
+          ##
+          # Retrieves remaining results by repeatedly invoking {#next} until
+          # {#next?} returns `false`. Calls the given block once for each
+          # result, which is passed as the argument to the block.
+          #
+          # An Enumerator is returned if no block is given.
+          #
+          # This method will make repeated API calls until all remaining results
+          # are retrieved. (Unlike `#each`, for example, which merely iterates
+          # over the results returned by a single API call.) Use with caution.
+          #
+          # @param [Integer] request_limit The upper limit of API requests to
+          #   make to load all HMAC keys. Default is no limit.
+          # @yield [key] The block for accessing each HMAC key.
+          # @yieldparam [HmacKey] key The HMAC key object.
+          #
+          # @return [Enumerator]
+          #
+          # @example Iterating each HMAC key by passing a block:
+          #   require "google/cloud/storage"
+          #
+          #   storage = Google::Cloud::Storage.new
+          #
+          #   hmac_keys = storage.hmac_keys
+          #   hmac_keys.all do |key|
+          #     puts key.access_id
+          #   end
+          #
+          # @example Using the enumerator by not passing a block:
+          #   require "google/cloud/storage"
+          #
+          #   storage = Google::Cloud::Storage.new
+          #
+          #   hmac_keys = storage.hmac_keys
+          #   all_names = hmac_keys.all.map do |key|
+          #     key.access_id
+          #   end
+          #
+          # @example Limit the number of API calls made:
+          #   require "google/cloud/storage"
+          #
+          #   storage = Google::Cloud::Storage.new
+          #
+          #   hmac_keys = storage.hmac_keys
+          #   hmac_keys.all(request_limit: 10) do |key|
+          #     puts key.access_id
+          #   end
+          #
+          def all request_limit: nil, &block
+            request_limit = request_limit.to_i if request_limit
+            unless block_given?
+              return enum_for :all, request_limit: request_limit
+            end
+            results = self
+            loop do
+              results.each(&block)
+              if request_limit
+                request_limit -= 1
+                break if request_limit.negative?
+              end
+              break unless results.next?
+              results = results.next
+            end
+          end
+
+          ##
+          # @private New HmacKey::List from a Google API Client
+          # Google::Apis::StorageV1::HmacKeysMetadata object.
+          def self.from_gapi gapi_list, service, service_account_email: nil,
+                             show_deleted_keys: nil, max: nil, user_project: nil
+            hmac_keys = new(Array(gapi_list.items).map do |gapi_object|
+              HmacKey.from_gapi_metadata gapi_object, service,
+                                         user_project: user_project
+            end)
+            hmac_keys.instance_variable_set :@token, gapi_list.next_page_token
+            hmac_keys.instance_variable_set :@service, service
+            hmac_keys.instance_variable_set :@service_account_email,
+                                            service_account_email
+            hmac_keys.instance_variable_set :@show_deleted_keys,
+                                            show_deleted_keys
+            hmac_keys.instance_variable_set :@max, max
+            hmac_keys.instance_variable_set :@user_project, user_project
+            hmac_keys
+          end
+
+          protected
+
+          ##
+          # Raise an error unless an active connection is available.
+          def ensure_service!
+            raise "Must have active connection" unless @service
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/storage/hmac_key.rb

@@ -0,0 +1,316 @@
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+require "google/cloud/storage/hmac_key/list"
+
+module Google
+  module Cloud
+    module Storage
+      ##
+      # # HmacKey
+      #
+      # Represents the metadata for an HMAC key, and also includes the key's
+      # secret if returned by the {Project#create_hmac_key} creation method.
+      #
+      # @see https://cloud.google.com/storage/docs/migrating#migration-simple
+      #   Migrating from Amazon S3 to Cloud Storage - Simple migration
+      #
+      # @attr_reader [String, nil] secret HMAC secret key material, or `nil` if
+      #   the key was not returned by the {Project#create_hmac_key} creation
+      #   method.
+      #
+      # @example
+      #   require "google/cloud/storage"
+      #
+      #   storage = Google::Cloud::Storage.new
+      #
+      #   service_account_email = "my_account@developer.gserviceaccount.com"
+      #   hmac_key = storage.create_hmac_key service_account_email
+      #   hmac_key.secret # ...
+      #
+      #   hmac_key = storage.hmac_key hmac_key.access_id
+      #   hmac_key.secret # nil
+      #
+      #   hmac_key.inactive!
+      #   hmac_key.delete
+      #
+      class HmacKey
+        ##
+        # @private The Connection object.
+        attr_accessor :service
+
+        ##
+        # @private The Google API Client object.
+        attr_accessor :gapi
+
+        ##
+        # @private A boolean value or a project ID string to indicate the
+        # project to be billed for operations.
+        attr_accessor :user_project
+
+        attr_reader :secret
+
+        ##
+        # @private Creates an HmacKey object.
+        def initialize
+          @bucket = nil
+          @service = nil
+          @gapi = nil
+          @user_project = nil
+        end
+
+        ##
+        # The ID of the HMAC Key.
+        #
+        # @return [String]
+        #
+        def access_id
+          @gapi.access_id
+        end
+
+        ##
+        # A URL that can be used to access the HMAC key using the REST API.
+        #
+        # @return [String]
+        #
+        def api_url
+          @gapi.self_link
+        end
+
+        ##
+        # Creation time of the HMAC key.
+        #
+        # @return [String]
+        #
+        def created_at
+          @gapi.time_created
+        end
+
+        ##
+        # HTTP 1.1 Entity tag for the HMAC key.
+        #
+        # @return [String]
+        #
+        def etag
+          @gapi.etag
+        end
+
+        ##
+        # The ID of the HMAC key, including the Project ID and the Access ID.
+        #
+        # @return [String]
+        #
+        def id
+          @gapi.id
+        end
+
+        ##
+        # Project ID owning the service account to which the key authenticates.
+        #
+        # @return [String]
+        #
+        def project_id
+          @gapi.project_id
+        end
+
+        ##
+        # The email address of the key's associated service account.
+        #
+        # @return [String]
+        #
+        def service_account_email
+          @gapi.service_account_email
+        end
+
+        ##
+        # The state of the key. Can be one of `ACTIVE`, `INACTIVE`, or
+        # `DELETED`.
+        #
+        # @return [String]
+        #
+        def state
+          @gapi.state
+        end
+
+        ##
+        # Last modification time of the HMAC key metadata.
+        #
+        # @return [String]
+        #
+        def updated_at
+          @gapi.updated
+        end
+
+        ##
+        # Whether the state of the HMAC key is `ACTIVE`.
+        #
+        # @return [Boolean]
+        #
+        def active?
+          state == "ACTIVE"
+        end
+
+        ##
+        # Updates the state of the HMAC key to `ACTIVE`.
+        #
+        # @return [Google::Cloud::Storage::HmacKey] Returns the HMAC key for
+        #   method chaining.
+        #
+        # @example
+        #   require "google/cloud/storage"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   hmac_key = storage.hmac_keys.first
+        #
+        #   hmac_key.active!
+        #   hmac_key.state # "ACTIVE"
+        #
+        def active!
+          put_gapi! "ACTIVE"
+          self
+        end
+
+        ##
+        # Whether the state of the HMAC key is `INACTIVE`.
+        #
+        # @return [Boolean]
+        #
+        def inactive?
+          state == "INACTIVE"
+        end
+
+        ##
+        # Updates the state of the HMAC key to `INACTIVE`.
+        #
+        # @return [Google::Cloud::Storage::HmacKey] Returns the HMAC key for
+        #   method chaining.
+        #
+        # @example
+        #   require "google/cloud/storage"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   hmac_key = storage.hmac_keys.first
+        #
+        #   hmac_key.inactive!
+        #   hmac_key.state # "INACTIVE"
+        #
+        def inactive!
+          put_gapi! "INACTIVE"
+          self
+        end
+
+        ##
+        # Whether the state of the HMAC key is `DELETED`.
+        #
+        # @return [Boolean]
+        #
+        def deleted?
+          state == "DELETED"
+        end
+
+        ##
+        # Deletes the HMAC key, and loads the new state of the HMAC key,
+        # which will be `DELETED`.
+        #
+        # The API call to delete the HMAC key may be retried under certain
+        # conditions. See {Google::Cloud#storage} to control this behavior.
+        #
+        # @return [Google::Cloud::Storage::HmacKey] Returns the HMAC key for
+        #   method chaining.
+        #
+        # @example
+        #   require "google/cloud/storage"
+        #
+        #   storage = Google::Cloud::Storage.new
+        #
+        #   hmac_key = storage.hmac_keys.first
+        #
+        #   hmac_key.inactive!.delete!
+        #
+        def delete!
+          ensure_service!
+          @service.delete_hmac_key access_id,
+                                   project_id: project_id,
+                                   user_project: @user_project
+          @gapi = @service.get_hmac_key access_id, project_id: project_id,
+                                                   user_project: @user_project
+          self
+        end
+        alias delete delete!
+
+        ##
+        # Reloads the HMAC key with current data from the Storage service.
+        #
+        def reload!
+          ensure_service!
+          @gapi = service.get_hmac_key access_id, project_id: project_id,
+                                                  user_project: user_project
+          self
+        end
+        alias refresh! reload!
+
+        ##
+        # @private New HmacKey from a Google::Apis::StorageV1::HmacKey object.
+        #
+        # @param [Google::Apis::StorageV1::HmacKey] gapi
+        #
+        #
+        def self.from_gapi gapi, service, user_project: nil
+          hmac_key = from_gapi_metadata gapi.metadata,
+                                        service,
+                                        user_project: user_project
+          hmac_key.tap do |f|
+            f.instance_variable_set :@secret, gapi.secret
+          end
+        end
+
+        ##
+        # @private New HmacKey from a Google::Apis::StorageV1::HmacKeyMetadata
+        # object.
+        #
+        # @param [Google::Apis::StorageV1::HmacKeyMetadata] gapi
+        #
+        #
+        def self.from_gapi_metadata gapi, service, user_project: nil
+          new.tap do |f|
+            f.gapi = gapi
+            f.service = service
+            f.user_project = user_project
+          end
+        end
+
+        protected
+
+        ##
+        # Raise an error unless an active service is available.
+        def ensure_service!
+          raise "Must have active connection" unless service
+        end
+
+        def put_gapi! new_state
+          ensure_service!
+          put_gapi = @gapi.dup
+          put_gapi.state = new_state
+          @gapi = service.update_hmac_key access_id, put_gapi,
+                                          project_id: project_id,
+                                          user_project: @user_project
+          self
+        end
+      end
+    end
+  end
+end