gcloud 0.6.3 → 0.7.0

data/lib/gcloud/bigquery/dataset/access.rb

@@ -1,4 +1,3 @@
-#--
 # Copyright 2015 Google Inc. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,15 +12,19 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 module Gcloud
   module Bigquery
     class Dataset
       ##
-      # = Dataset Access Control
+      # # Dataset Access Control
+      #
+      # Represents the Access rules for a {Dataset}.
       #
-      # Represents the Access rules for a Dataset. See {BigQuery Access
-      # Control}[https://cloud.google.com/bigquery/access-control].
+      # @see https://cloud.google.com/bigquery/access-control BigQuery Access
+      #   Control
       #
+      # @example
       #   require "gcloud"
       #
       #   gcloud = Gcloud.new
@@ -37,10 +40,12 @@ module Gcloud
       #   end
       #
       class Access
+        # @private
         ROLES = { "reader" => "READER",
                   "writer" => "WRITER",
-                  "owner"  => "OWNER" } #:nodoc:
+                  "owner"  => "OWNER" }
 
+        # @private
         SCOPES = { "user"           => "userByEmail",
                    "user_by_email"  => "userByEmail",
                    "userByEmail"    => "userByEmail",
@@ -51,8 +56,9 @@ module Gcloud
                    "special"        => "specialGroup",
                    "special_group"  => "specialGroup",
                    "specialGroup"   => "specialGroup",
-                   "view"           => "view" } #:nodoc:
+                   "view"           => "view" }
 
+        # @private
         GROUPS = { "owners"                  => "projectOwners",
                    "project_owners"          => "projectOwners",
                    "projectOwners"           => "projectOwners",
@@ -66,18 +72,21 @@ module Gcloud
                    "all_authenticated_users" => "allAuthenticatedUsers",
                    "allAuthenticatedUsers"   => "allAuthenticatedUsers" }
 
-        attr_reader :access #:nodoc:
+        # @private
+        attr_reader :access
 
         ##
+        # @private
         # Initialized a new Access object.
         # Must provide a valid Dataset object.
-        def initialize access, context #:nodoc:
+        def initialize access, context
           @original   = access.dup
           @access     = access.dup
           @context    = context
         end
 
-        def changed? #:nodoc:
+        # @private
+        def changed?
           @original != @access
         end
 
@@ -101,7 +110,7 @@ module Gcloud
 
         ##
         # Add reader access to a special group.
-        # Accepted values are +owners+, +writers+, +readers+, and +all+.
+        # Accepted values are `owners`, `writers`, `readers`, and `all`.
         def add_reader_special group
           add_access_role_scope_value :reader, :special, group
         end
@@ -110,8 +119,8 @@ module Gcloud
         # Add reader access to a view.
         # The view can be a Gcloud::Bigquery::View object,
         # or a string identifier as specified by the
-        # {Query
-        # Reference}[https://cloud.google.com/bigquery/query-reference#from]:
+        # [Query
+        # Reference](https://cloud.google.com/bigquery/query-reference#from):
         # +project_name:datasetId.tableId+.
         def add_reader_view view
           add_access_role_scope_value :reader, :view, view
@@ -137,7 +146,7 @@ module Gcloud
 
         ##
         # Add writer access to a special group.
-        # Accepted values are +owners+, +writers+, +readers+, and +all+.
+        # Accepted values are `owners`, `writers`, `readers`, and `all`.
         def add_writer_special group
           add_access_role_scope_value :writer, :special, group
         end
@@ -146,8 +155,8 @@ module Gcloud
         # Add writer access to a view.
         # The view can be a Gcloud::Bigquery::View object,
         # or a string identifier as specified by the
-        # {Query
-        # Reference}[https://cloud.google.com/bigquery/query-reference#from]:
+        # [Query
+        # Reference](https://cloud.google.com/bigquery/query-reference#from):
         # +project_name:datasetId.tableId+.
         def add_writer_view view
           add_access_role_scope_value :writer, :view, view
@@ -173,7 +182,7 @@ module Gcloud
 
         ##
         # Add owner access to a special group.
-        # Accepted values are +owners+, +writers+, +readers+, and +all+.
+        # Accepted values are `owners`, `writers`, `readers`, and `all`.
         def add_owner_special group
           add_access_role_scope_value :owner, :special, group
         end
@@ -182,8 +191,8 @@ module Gcloud
         # Add owner access to a view.
         # The view can be a Gcloud::Bigquery::View object,
         # or a string identifier as specified by the
-        # {Query
-        # Reference}[https://cloud.google.com/bigquery/query-reference#from]:
+        # [Query
+        # Reference](https://cloud.google.com/bigquery/query-reference#from):
         # +project_name:datasetId.tableId+.
         def add_owner_view view
           add_access_role_scope_value :owner, :view, view
@@ -209,7 +218,7 @@ module Gcloud
 
         ##
         # Remove reader access from a special group.
-        # Accepted values are +owners+, +writers+, +readers+, and +all+.
+        # Accepted values are `owners`, `writers`, `readers`, and `all`.
         def remove_reader_special group
           remove_access_role_scope_value :reader, :special, group
         end
@@ -218,8 +227,8 @@ module Gcloud
         # Remove reader access from a view.
         # The view can be a Gcloud::Bigquery::View object,
         # or a string identifier as specified by the
-        # {Query
-        # Reference}[https://cloud.google.com/bigquery/query-reference#from]:
+        # [Query
+        # Reference](https://cloud.google.com/bigquery/query-reference#from):
         # +project_name:datasetId.tableId+.
         def remove_reader_view view
           remove_access_role_scope_value :reader, :view, view
@@ -245,7 +254,7 @@ module Gcloud
 
         ##
         # Remove writer access from a special group.
-        # Accepted values are +owners+, +writers+, +readers+, and +all+.
+        # Accepted values are `owners`, `writers`, `readers`, and `all`.
         def remove_writer_special group
           remove_access_role_scope_value :writer, :special, group
         end
@@ -254,8 +263,8 @@ module Gcloud
         # Remove writer access from a view.
         # The view can be a Gcloud::Bigquery::View object,
         # or a string identifier as specified by the
-        # {Query
-        # Reference}[https://cloud.google.com/bigquery/query-reference#from]:
+        # [Query
+        # Reference](https://cloud.google.com/bigquery/query-reference#from):
         # +project_name:datasetId.tableId+.
         def remove_writer_view view
           remove_access_role_scope_value :writer, :view, view
@@ -281,7 +290,7 @@ module Gcloud
 
         ##
         # Remove owner access from a special group.
-        # Accepted values are +owners+, +writers+, +readers+, and +all+.
+        # Accepted values are `owners`, `writers`, `readers`, and `all`.
         def remove_owner_special group
           remove_access_role_scope_value :owner, :special, group
         end
@@ -290,8 +299,8 @@ module Gcloud
         # Remove owner access from a view.
         # The view can be a Gcloud::Bigquery::View object,
         # or a string identifier as specified by the
-        # {Query
-        # Reference}[https://cloud.google.com/bigquery/query-reference#from]:
+        # [Query
+        # Reference](https://cloud.google.com/bigquery/query-reference#from):
         # +project_name:datasetId.tableId+.
         def remove_owner_view view
           remove_access_role_scope_value :owner, :view, view
@@ -317,7 +326,7 @@ module Gcloud
 
         ##
         # Checks reader access for a special group.
-        # Accepted values are +owners+, +writers+, +readers+, and +all+.
+        # Accepted values are `owners`, `writers`, `readers`, and `all`.
         def reader_special? group
           lookup_access_role_scope_value :reader, :special, group
         end
@@ -326,8 +335,8 @@ module Gcloud
         # Checks reader access for a view.
         # The view can be a Gcloud::Bigquery::View object,
         # or a string identifier as specified by the
-        # {Query
-        # Reference}[https://cloud.google.com/bigquery/query-reference#from]:
+        # [Query
+        # Reference](https://cloud.google.com/bigquery/query-reference#from):
         # +project_name:datasetId.tableId+.
         def reader_view? view
           lookup_access_role_scope_value :reader, :view, view
@@ -353,7 +362,7 @@ module Gcloud
 
         ##
         # Checks writer access for a special group.
-        # Accepted values are +owners+, +writers+, +readers+, and +all+.
+        # Accepted values are `owners`, `writers`, `readers`, and `all`.
         def writer_special? group
           lookup_access_role_scope_value :writer, :special, group
         end
@@ -362,8 +371,8 @@ module Gcloud
         # Checks writer access for a view.
         # The view can be a Gcloud::Bigquery::View object,
         # or a string identifier as specified by the
-        # {Query
-        # Reference}[https://cloud.google.com/bigquery/query-reference#from]:
+        # [Query
+        # Reference](https://cloud.google.com/bigquery/query-reference#from):
         # +project_name:datasetId.tableId+.
         def writer_view? view
           lookup_access_role_scope_value :writer, :view, view
@@ -389,7 +398,7 @@ module Gcloud
 
         ##
         # Checks owner access for a special group.
-        # Accepted values are +owners+, +writers+, +readers+, and +all+.
+        # Accepted values are `owners`, `writers`, `readers`, and `all`.
         def owner_special? group
           lookup_access_role_scope_value :owner, :special, group
         end
@@ -398,8 +407,8 @@ module Gcloud
         # Checks owner access for a view.
         # The view can be a Gcloud::Bigquery::View object,
         # or a string identifier as specified by the
-        # {Query
-        # Reference}[https://cloud.google.com/bigquery/query-reference#from]:
+        # [Query
+        # Reference](https://cloud.google.com/bigquery/query-reference#from):
         # +project_name:datasetId.tableId+.
         def owner_view? view
           lookup_access_role_scope_value :owner, :view, view
@@ -407,7 +416,8 @@ module Gcloud
 
         protected
 
-        def validate_role role #:nodoc:
+        # @private
+        def validate_role role
           good_role = ROLES[role.to_s]
           if good_role.nil?
             fail ArgumentError "Unable to determine role for #{role}"
@@ -415,7 +425,8 @@ module Gcloud
           good_role
         end
 
-        def validate_scope scope #:nodoc:
+        # @private
+        def validate_scope scope
           good_scope = SCOPES[scope.to_s]
           if good_scope.nil?
             fail ArgumentError "Unable to determine scope for #{scope}"
@@ -423,13 +434,15 @@ module Gcloud
           good_scope
         end
 
-        def validate_special_group value #:nodoc:
+        # @private
+        def validate_special_group value
           good_value = GROUPS[value.to_s]
           return good_value unless good_value.nil?
           value
         end
 
-        def validate_view view #:nodoc:
+        # @private
+        def validate_view view
           if view.respond_to? :table_ref
             view.table_ref
           else
@@ -437,7 +450,8 @@ module Gcloud
           end
         end
 
-        def add_access_role_scope_value role, scope, value #:nodoc:
+        # @private
+        def add_access_role_scope_value role, scope, value
           role = validate_role role
           scope = validate_scope scope
           # If scope is special group, make sure value is in the list
@@ -450,7 +464,8 @@ module Gcloud
           access << { "role" => role, scope => value }
         end
 
-        def remove_access_role_scope_value role, scope, value #:nodoc:
+        # @private
+        def remove_access_role_scope_value role, scope, value
           role = validate_role role
           scope = validate_scope scope
           # If scope is special group, make sure value is in the list
@@ -461,7 +476,8 @@ module Gcloud
           access.reject! { |h| h["role"] == role && h[scope] == value }
         end
 
-        def lookup_access_role_scope_value role, scope, value #:nodoc:
+        # @private
+        def lookup_access_role_scope_value role, scope, value
           role = validate_role role
           scope = validate_scope scope
           # If scope is special group, make sure value is in the list

data/lib/gcloud/bigquery/dataset/list.rb

@@ -1,4 +1,3 @@
-#--
 # Copyright 2015 Google Inc. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 require "delegate"
 
 module Gcloud
@@ -36,8 +36,8 @@ module Gcloud
         end
 
         ##
-        # New Dataset::List from a response object.
-        def self.from_response resp, conn #:nodoc:
+        # @private New Dataset::List from a response object.
+        def self.from_response resp, conn
           datasets = List.new(Array(resp.data["datasets"]).map do |gapi_object|
             Dataset.from_gapi gapi_object, conn
           end)

data/lib/gcloud/bigquery/errors.rb

@@ -1,4 +1,3 @@
-#--
 # Copyright 2015 Google Inc. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 require "gcloud/errors"
 
 module Gcloud
@@ -33,13 +33,15 @@ module Gcloud
       # The errors encountered.
       attr_reader :errors
 
-      def initialize message, code, errors = [] #:nodoc:
+      # @private
+      def initialize message, code, errors = []
         super message
         @code   = code
         @errors = errors
       end
 
-      def self.from_response resp #:nodoc:
+      # @private
+      def self.from_response resp
         if resp.data? && resp.data["error"]
           from_response_data resp.data["error"]
         else
@@ -47,11 +49,13 @@ module Gcloud
         end
       end
 
-      def self.from_response_data error #:nodoc:
+      # @private
+      def self.from_response_data error
         new error["message"], error["code"], error["errors"]
       end
 
-      def self.from_response_status resp #:nodoc:
+      # @private
+      def self.from_response_status resp
         if resp.status == 404
           new "#{resp.error_message}: #{resp.request.uri.request_uri}",
               resp.status

data/lib/gcloud/bigquery/extract_job.rb

@@ -1,4 +1,3 @@
-#--
 # Copyright 2015 Google Inc. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,19 +12,20 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
 module Gcloud
   module Bigquery
     ##
-    # = ExtractJob
+    # # ExtractJob
     #
-    # A Job subclass representing an export operation that may be performed
-    # on a Table. A ExtractJob instance is created when you call Table#extract.
+    # A {Job} subclass representing an export operation that may be performed
+    # on a {Table}. A ExtractJob instance is created when you call
+    # {Table#extract}.
     #
-    # See {Exporting Data From
-    # BigQuery}[https://cloud.google.com/bigquery/exporting-data-from-bigquery]
-    # and the {Jobs API
-    # reference}[https://cloud.google.com/bigquery/docs/reference/v2/jobs]
-    # for details.
+    # @see https://cloud.google.com/bigquery/exporting-data-from-bigquery
+    #   Exporting Data From BigQuery
+    # @see https://cloud.google.com/bigquery/docs/reference/v2/jobs Jobs API
+    #   reference
     #
     class ExtractJob < Job
       ##
@@ -37,7 +37,7 @@ module Gcloud
 
       ##
       # The table from which the data is exported. This is the table upon
-      # which Table#extract was called. Returns a Table instance.
+      # which {Table#extract} was called. Returns a {Table} instance.
       def source
         table = config["extract"]["sourceTable"]
         return nil unless table
@@ -48,15 +48,15 @@ module Gcloud
 
       ##
       # Checks if the export operation compresses the data using gzip. The
-      # default is +false+.
+      # default is `false`.
       def compression?
         val = config["extract"]["compression"]
         val == "GZIP"
       end
 
       ##
-      # Checks if the destination format for the data is {newline-delimited
-      # JSON}[http://jsonlines.org/]. The default is +false+.
+      # Checks if the destination format for the data is [newline-delimited
+      # JSON](http://jsonlines.org/). The default is `false`.
       def json?
         val = config["extract"]["destinationFormat"]
         val == "NEWLINE_DELIMITED_JSON"
@@ -64,7 +64,7 @@ module Gcloud
 
       ##
       # Checks if the destination format for the data is CSV. Tables with nested
-      # or repeated fields cannot be exported as CSV. The default is +true+.
+      # or repeated fields cannot be exported as CSV. The default is `true`.
       def csv?
         val = config["extract"]["destinationFormat"]
         return true if val.nil?
@@ -73,7 +73,7 @@ module Gcloud
 
       ##
       # Checks if the destination format for the data is
-      # {Avro}[http://avro.apache.org/]. The default is +false+.
+      # [Avro](http://avro.apache.org/). The default is `false`.
       def avro?
         val = config["extract"]["destinationFormat"]
         val == "AVRO"
@@ -90,7 +90,7 @@ module Gcloud
 
       ##
       # Checks if the exported data contains a header row. The default is
-      # +true+.
+      # `true`.
       def print_header?
         val = config["extract"]["printHeader"]
         val = true if val.nil?
@@ -99,7 +99,7 @@ module Gcloud
 
       ##
       # The count of files per destination URI or URI pattern specified in
-      # #destinations. Returns an Array of values in the same order as the URI
+      # {#destinations}. Returns an Array of values in the same order as the URI
       # patterns.
       def destinations_file_counts
         Array stats["extract"]["destinationUriFileCounts"]
@@ -107,7 +107,7 @@ module Gcloud
 
       ##
       # The count of files per destination URI or URI pattern specified in
-      # #destinations. Returns a Hash with the URI patterns as keys and the
+      # {#destinations}. Returns a Hash with the URI patterns as keys and the
       # counts as values.
       def destinations_counts
         Hash[destinations.zip destinations_file_counts]