gcloud 0.11.0 → 0.12.0

data/lib/gcloud/storage/bucket/acl.rb

@@ -53,7 +53,7 @@ module Gcloud
         # Must provide a valid Bucket object.
         def initialize bucket
           @bucket = bucket.name
-          @connection = bucket.connection
+          @service = bucket.service
           @owners  = nil
           @writers = nil
           @readers = nil
@@ -73,8 +73,8 @@ module Gcloud
         #   bucket.acl.reload!
         #
         def reload!
-          resp = @connection.list_bucket_acls @bucket
-          acls = resp.data["items"]
+          gapi = @service.list_bucket_acls @bucket
+          acls = Array(gapi.items)
           @owners  = entities_from_acls acls, "OWNER"
           @writers = entities_from_acls acls, "WRITER"
           @readers = entities_from_acls acls, "READER"
@@ -179,13 +179,10 @@ module Gcloud
         #   bucket.acl.add_owner "group-#{email}"
         #
         def add_owner entity
-          resp = @connection.insert_bucket_acl @bucket, entity, "OWNER"
-          if resp.success?
-            entity = resp.data["entity"]
-            @owners.push entity unless @owners.nil?
-            return entity
-          end
-          nil
+          gapi = @service.insert_bucket_acl @bucket, entity, "OWNER"
+          entity = gapi.entity
+          @owners.push entity unless @owners.nil?
+          entity
         end
 
         ##
@@ -226,13 +223,10 @@ module Gcloud
         #   bucket.acl.add_writer "group-#{email}"
         #
         def add_writer entity
-          resp = @connection.insert_bucket_acl @bucket, entity, "WRITER"
-          if resp.success?
-            entity = resp.data["entity"]
-            @writers.push entity unless @writers.nil?
-            return entity
-          end
-          nil
+          gapi = @service.insert_bucket_acl @bucket, entity, "WRITER"
+          entity = gapi.entity
+          @writers.push entity unless @writers.nil?
+          entity
         end
 
         ##
@@ -273,13 +267,10 @@ module Gcloud
         #   bucket.acl.add_reader "group-#{email}"
         #
         def add_reader entity
-          resp = @connection.insert_bucket_acl @bucket, entity, "READER"
-          if resp.success?
-            entity = resp.data["entity"]
-            @readers.push entity unless @readers.nil?
-            return entity
-          end
-          nil
+          gapi = @service.insert_bucket_acl @bucket, entity, "READER"
+          entity = gapi.entity
+          @readers.push entity unless @readers.nil?
+          entity
         end
 
         ##
@@ -309,14 +300,11 @@ module Gcloud
         #   bucket.acl.delete "user-#{email}"
         #
         def delete entity
-          resp = @connection.delete_bucket_acl @bucket, entity
-          if resp.success?
-            @owners.delete entity  unless @owners.nil?
-            @writers.delete entity unless @writers.nil?
-            @readers.delete entity unless @readers.nil?
-            return true
-          end
-          false
+          @service.delete_bucket_acl @bucket, entity
+          @owners.delete entity  unless @owners.nil?
+          @writers.delete entity unless @writers.nil?
+          @readers.delete entity unless @readers.nil?
+          true
         end
 
         # @private
@@ -433,17 +421,13 @@ module Gcloud
         end
 
         def update_predefined_acl! acl_role
-          resp = @connection.patch_bucket @bucket,
-                                          predefined_acl: acl_role,
-                                          acl: []
-
-          return clear! if resp.success?
-          fail Gcloud::Storage::ApiError.from_response(resp)
+          @service.patch_bucket @bucket, predefined_acl: acl_role
+          clear!
         end
 
         def entities_from_acls acls, role
-          selected = acls.select { |acl| acl["role"] == role }
-          entities = selected.map { |acl| acl["entity"] }
+          selected = acls.select { |acl| acl.role == role }
+          entities = selected.map(&:entity)
           entities
         end
       end
@@ -486,9 +470,8 @@ module Gcloud
         # Must provide a valid Bucket object.
         def initialize bucket
           @bucket = bucket.name
-          @connection = bucket.connection
+          @service = bucket.service
           @owners  = nil
-          @writers = nil
           @readers = nil
         end
 
@@ -506,10 +489,13 @@ module Gcloud
         #   bucket.default_acl.reload!
         #
         def reload!
-          resp = @connection.list_default_acls @bucket
-          acls = resp.data["items"]
+          gapi = @service.list_default_acls @bucket
+          acls = Array(gapi.items).map do |acl|
+            return acl if acl.is_a? Google::Apis::StorageV1::ObjectAccessControl
+            fail "Unknown ACL format: #{acl.class}" unless acl.is_a? Hash
+            Google::Apis::StorageV1::ObjectAccessControl.from_json acl.to_json
+          end
           @owners  = entities_from_acls acls, "OWNER"
-          @writers = entities_from_acls acls, "WRITER"
           @readers = entities_from_acls acls, "READER"
         end
         alias_method :refresh!, :reload!
@@ -534,26 +520,6 @@ module Gcloud
           @owners
         end
 
-        ##
-        # Lists the default writers for files in the bucket.
-        #
-        # @return [Array<String>]
-        #
-        # @example
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   storage = gcloud.storage
-        #
-        #   bucket = storage.bucket "my-bucket"
-        #
-        #   bucket.default_acl.writers.each { |writer| puts writer }
-        #
-        def writers
-          reload! if @writers.nil?
-          @writers
-        end
-
         ##
         # Lists the default readers for files in the bucket.
         #
@@ -612,60 +578,10 @@ module Gcloud
         #   bucket.default_acl.add_owner "group-#{email}"
         #
         def add_owner entity
-          resp = @connection.insert_default_acl @bucket, entity, "OWNER"
-          if resp.success?
-            entity = resp.data["entity"]
-            @owners.push entity unless @owners.nil?
-            return entity
-          end
-          nil
-        end
-
-        ##
-        # Grants default writer permission to files in the bucket.
-        #
-        # @param [String] entity The entity holding the permission, in one of
-        #   the following forms:
-        #
-        #   * user-userId
-        #   * user-email
-        #   * group-groupId
-        #   * group-email
-        #   * domain-domain
-        #   * project-team-projectId
-        #   * allUsers
-        #   * allAuthenticatedUsers
-        #
-        # @example Grant access to a user by pre-pending `"user-"` to an email:
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   storage = gcloud.storage
-        #
-        #   bucket = storage.bucket "my-bucket"
-        #
-        #   email = "heidi@example.net"
-        #   bucket.default_acl.add_writer "user-#{email}"
-        #
-        # @example Grant access to a group by pre-pending `"group-"` to an email
-        #   require "gcloud"
-        #
-        #   gcloud = Gcloud.new
-        #   storage = gcloud.storage
-        #
-        #   bucket = storage.bucket "my-bucket"
-        #
-        #   email = "authors@example.net"
-        #   bucket.default_acl.add_writer "group-#{email}"
-        #
-        def add_writer entity
-          resp = @connection.insert_default_acl @bucket, entity, "WRITER"
-          if resp.success?
-            entity = resp.data["entity"]
-            @writers.push entity unless @writers.nil?
-            return entity
-          end
-          nil
+          gapi = @service.insert_default_acl @bucket, entity, "OWNER"
+          entity = gapi.entity
+          @owners.push entity unless @owners.nil?
+          entity
         end
 
         ##
@@ -706,13 +622,10 @@ module Gcloud
         #   bucket.default_acl.add_reader "group-#{email}"
         #
         def add_reader entity
-          resp = @connection.insert_default_acl @bucket, entity, "READER"
-          if resp.success?
-            entity = resp.data["entity"]
-            @readers.push entity unless @readers.nil?
-            return entity
-          end
-          nil
+          gapi = @service.insert_default_acl @bucket, entity, "READER"
+          entity = gapi.entity
+          @readers.push entity unless @readers.nil?
+          entity
         end
 
         ##
@@ -743,14 +656,10 @@ module Gcloud
         #   bucket.default_acl.delete "user-#{email}"
         #
         def delete entity
-          resp = @connection.delete_default_acl @bucket, entity
-          if resp.success?
-            @owners.delete entity  unless @owners.nil?
-            @writers.delete entity unless @writers.nil?
-            @readers.delete entity unless @readers.nil?
-            return true
-          end
-          false
+          @service.delete_default_acl @bucket, entity
+          @owners.delete entity  unless @owners.nil?
+          @readers.delete entity unless @readers.nil?
+          true
         end
 
         # @private
@@ -881,23 +790,18 @@ module Gcloud
 
         def clear!
           @owners  = nil
-          @writers = nil
           @readers = nil
           self
         end
 
         def update_predefined_default_acl! acl_role
-          resp = @connection.patch_bucket @bucket,
-                                          predefined_default_acl: acl_role,
-                                          default_acl: []
-
-          return clear! if resp.success?
-          fail Gcloud::Storage::ApiError.from_response(resp)
+          @service.patch_bucket @bucket, predefined_default_acl: acl_role
+          clear!
         end
 
         def entities_from_acls acls, role
-          selected = acls.select { |acl| acl["role"] == role }
-          entities = selected.map { |acl| acl["entity"] }
+          selected = acls.select { |acl| acl.role == role }
+          entities = selected.map(&:entity)
           entities
         end
       end

data/lib/gcloud/storage/bucket/cors.rb

@@ -22,8 +22,7 @@ module Gcloud
       # # Bucket Cors
       #
       # A special-case Array for managing the website CORS rules for a bucket.
-      # Accessed via a block argument to {Project#create_bucket}, {Bucket#cors},
-      # or {Bucket#update}.
+      # Accessed via {Bucket#cors}.
       #
       # @see https://cloud.google.com/storage/docs/cross-origin Cross-Origin
       #   Resource Sharing (CORS)
@@ -35,11 +34,12 @@ module Gcloud
       #   storage = gcloud.storage
       #   bucket = storage.bucket "my-todo-app"
       #
+      #   bucket = storage.bucket "my-bucket"
       #   bucket.cors do |c|
       #     # Remove the last CORS rule from the array
       #     c.pop
       #     # Remove all existing rules with the https protocol
-      #     c.delete_if { |r| r["origin"].include? "http://example.com" }
+      #     c.delete_if { |r| r.origin.include? "http://example.com" }
       #     c.add_rule ["http://example.org", "https://example.org"],
       #                ["GET", "POST", "DELETE"],
       #                response_headers: ["X-My-Custom-Header"],
@@ -50,14 +50,14 @@ module Gcloud
         ##
         # @private
         # Initialize a new CORS rules builder with existing CORS rules, if any.
-        def initialize cors = []
-          super cors.dup
-          @original = cors.dup
+        def initialize rules = []
+          super rules
+          @original = to_gapi.map(&:to_json)
         end
 
         # @private
         def changed?
-          @original != self
+          @original != to_gapi.map(&:to_json)
         end
 
         ##
@@ -98,10 +98,54 @@ module Gcloud
         #   end
         #
         def add_rule origin, methods, headers: nil, max_age: nil
-          rule = { "origin" => Array(origin), "method" => Array(methods) }
-          rule["responseHeader"] = Array(headers) || []
-          rule["maxAgeSeconds"]  = max_age || 1800
-          push rule
+          push Rule.new(origin, methods, headers: headers, max_age: max_age)
+        end
+
+        # @private
+        def to_gapi
+          map(&:to_gapi)
+        end
+
+        # @private
+        def self.from_gapi gapi_list
+          rules = Array(gapi_list).map { |gapi| Rule.from_gapi gapi }
+          new rules
+        end
+
+        # @private
+        def freeze
+          each(&:freeze)
+          super
+        end
+
+        class Rule
+          attr_accessor :origin, :methods, :headers, :max_age
+
+          def initialize origin, methods, headers: nil, max_age: nil
+            @origin = Array(origin)
+            @methods = Array(methods)
+            @headers = Array(headers)
+            @max_age = (max_age||1800)
+          end
+
+          def to_gapi
+            Google::Apis::StorageV1::Bucket::CorsConfiguration.new(
+              origin: Array(origin).dup, http_method: Array(methods).dup,
+              response_header: Array(headers).dup, max_age_seconds: max_age
+            )
+          end
+
+          def self.from_gapi gapi
+            new gapi.origin.dup, gapi.http_method.dup, \
+                headers: gapi.response_header.dup, max_age: gapi.max_age_seconds
+          end
+
+          def freeze
+            @origin.freeze
+            @methods.freeze
+            @headers.freeze
+            super
+          end
         end
       end
     end

data/lib/gcloud/storage/bucket/list.rb

@@ -71,11 +71,10 @@ module Gcloud
         #
         def next
           return nil unless next?
-          ensure_connection!
+          ensure_service!
           options = { prefix: @prefix, token: @token, max: @max }
-          resp = @connection.list_buckets options
-          fail ApiError.from_response(resp) unless resp.success?
-          Bucket::List.from_response resp, @connection, @prefix, @max
+          gapi = @service.list_buckets options
+          Bucket::List.from_gapi gapi, @service, @prefix, @max
         end
 
         ##
@@ -147,15 +146,16 @@ module Gcloud
         end
 
         ##
-        # @private New Bucket::List from a response object.
-        def self.from_response resp, conn, prefix = nil, max = nil
-          buckets = new(Array(resp.data["items"]).map do |gapi_object|
-            Bucket.from_gapi gapi_object, conn
+        # @private New Bucket::List from a Google API Client
+        # Google::Apis::StorageV1::Buckets object.
+        def self.from_gapi gapi_list, service, prefix = nil, max = nil
+          buckets = new(Array(gapi_list.items).map do |gapi_object|
+            Bucket.from_gapi gapi_object, service
           end)
-          buckets.instance_variable_set "@token", resp.data["nextPageToken"]
-          buckets.instance_variable_set "@connection", conn
-          buckets.instance_variable_set "@prefix", prefix
-          buckets.instance_variable_set "@max", max
+          buckets.instance_variable_set :@token, gapi_list.next_page_token
+          buckets.instance_variable_set :@service, service
+          buckets.instance_variable_set :@prefix, prefix
+          buckets.instance_variable_set :@max, max
           buckets
         end
 
@@ -163,8 +163,8 @@ module Gcloud
 
         ##
         # Raise an error unless an active connection is available.
-        def ensure_connection!
-          fail "Must have active connection" unless @connection
+        def ensure_service!
+          fail "Must have active connection" unless @service
         end
       end
     end

data/lib/gcloud/storage/errors.rb

@@ -17,58 +17,18 @@ require "gcloud/errors"
 
 module Gcloud
   module Storage
-    ##
-    # # Storage Error
-    #
-    # Base Storage exception class.
-    class Error < Gcloud::Error
-    end
-
-    ##
-    # # ApiError
-    #
-    # Raised when an API call is not successful.
-    class ApiError < Error
-      ##
-      # The code of the error.
-      attr_reader :code
-
-      ##
-      # The errors encountered.
-      attr_reader :errors
-
-      def initialize message, code, errors
-        super message
-        @code   = code
-        @errors = errors
-      end
-
-      # @private
-      def self.from_response resp
-        if resp.data && resp.data["error"]
-          new resp.data["error"]["message"],
-              resp.data["error"]["code"],
-              resp.data["error"]["errors"]
-        else
-          new resp.error_message,
-              resp.status,
-              nil
-        end
-      end
-    end
-
     ##
     # # FileVerificationError
     #
     # Raised when a File download fails the verification.
-    class FileVerificationError < Error
+    class FileVerificationError < Gcloud::Error
       ##
       # The type of digest that failed verification,
       # :md5 or :crc32c.
       attr_accessor :type
 
       ##
-      # The value of the digest on the Gcloud file.
+      # The value of the digest on the gcloud-ruby file.
       attr_accessor :gcloud_digest
 
       ##
@@ -99,7 +59,7 @@ module Gcloud
     #
     # This is raised when File#signed_url is unable to generate a URL due to
     # missing credentials needed to create the URL.
-    class SignedUrlUnavailable < Error
+    class SignedUrlUnavailable < Gcloud::Error
     end
   end
 end