google-cloud-bigtable 0.6.2 → 1.0.2

data/lib/google/cloud/bigtable/app_profile/job.rb

@@ -17,6 +17,7 @@ module Google
   module Cloud
     module Bigtable
       class AppProfile
+        ##
         # # Job
         #
         # A resource representing the long-running, asynchronous processing of
@@ -34,7 +35,7 @@ module Google
         #   bigtable = Google::Cloud::Bigtable.new
         #
         #   instance = bigtable.instance("my-instance")
-        #   app_profile = bigtable.instance("my-app-profile")
+        #   app_profile = instance.app_profile("my-app-profile")
         #
         #   app_profile.description = "User data instance app profile"
         #   routing_policy = Google::Cloud::Bigtable::AppProfile.single_cluster_routing(
@@ -59,6 +60,7 @@ module Google
         #   end
         #
         class Job < LongrunningJob
+          ##
           # The instance that is the object of the operation.
           #
           # @return [Google::Cloud::Bigtable::AppProfile, nil] The app profile instance, or
@@ -70,7 +72,7 @@ module Google
           #   bigtable = Google::Cloud::Bigtable.new
           #
           #   instance = bigtable.instance("my-instance")
-          #   app_profile = bigtable.instance("my-app-profile")
+          #   app_profile = instance.app_profile("my-app-profile")
           #
           #   app_profile.description = "User data instance app profile"
           #   routing_policy = Google::Cloud::Bigtable::AppProfile.single_cluster_routing(
@@ -81,11 +83,6 @@ module Google
           #
           #   job = app_profile.save
           #
-          #   job.done? #=> false
-          #   job.reload!
-          #   job.done? #=> true
-          #
-          #   # OR
           #   job.wait_until_done!
           #
           #   app_profile = job.app_profile
@@ -93,7 +90,7 @@ module Google
           def app_profile
             return nil unless done?
             return nil unless @grpc.grpc_op.result == :response
-            AppProfile.from_grpc(@grpc.results, service)
+            AppProfile.from_grpc @grpc.results, service
           end
         end
       end

data/lib/google/cloud/bigtable/app_profile/list.rb

@@ -19,6 +19,7 @@ module Google
   module Cloud
     module Bigtable
       class AppProfile
+        ##
         # AppProfile::List is a special-case array with additional
         # values.
         class List < DelegateClass(::Array)
@@ -31,12 +32,13 @@ module Google
           attr_accessor :grpc
 
           # @private
-          # Creates a new AppProfile::List with an array of snapshot instances.
+          # Creates a new AppProfile::List with an array of app profiles.
           def initialize arr = []
-            super(arr)
+            super arr
           end
 
-          # Whether there is a next page of instances.
+          ##
+          # Whether there is a next page of app profiles.
           #
           # @return [Boolean]
           #
@@ -51,13 +53,15 @@ module Google
           #   if app_profiles.next?
           #     next_app_profiles = app_profiles.next
           #   end
+          #
           def next?
             grpc.next_page?
           end
 
-          # Retrieves the next page of app_profiles.
+          ##
+          # Retrieves the next page of app profiles.
           #
-          # @return [AppProfile::List] The list of instances.
+          # @return [AppProfile::List] The list of app profiles.
           #
           # @example
           #   require "google/cloud/bigtable"
@@ -70,14 +74,16 @@ module Google
           #   if app_profiles.next?
           #     next_app_profiles = app_profiles.next
           #   end
+          #
           def next
             ensure_grpc!
 
             return nil unless next?
             grpc.next_page
-            self.class.from_grpc(grpc, service)
+            self.class.from_grpc grpc, service
           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.
@@ -88,12 +94,12 @@ module Google
           # are retrieved (unlike `#each`, for example, which merely iterates
           # over the results returned by a single API call). Use with caution.
           #
-          # @yield [app_profile] The block for accessing each instance.
-          # @yieldparam [AppProfile] instance The instance object.
+          # @yield [app_profile] The block for accessing each app profile.
+          # @yieldparam [AppProfile] app_profile The app profile object.
           #
           # @return [Enumerator]
           #
-          # @example Iterating each instance by passing a block:
+          # @example Iterating each app profile by passing a block:
           #   require "google/cloud/bigtable"
           #
           #   bigtable = Google::Cloud::Bigtable.new
@@ -117,14 +123,14 @@ module Google
           #   end
           #
           def all
-            return enum_for(:all) unless block_given?
+            return enum_for :all unless block_given?
 
             results = self
             loop do
               results.each { |r| yield r }
               break unless next?
               grpc.next_page
-              results = self.class.from_grpc(grpc, service)
+              results = self.class.from_grpc grpc, service
             end
           end
 
@@ -136,7 +142,7 @@ module Google
           def self.from_grpc grpc, service
             app_profiles = List.new(
               Array(grpc.response.app_profiles).map do |app_profile|
-                AppProfile.from_grpc(app_profile, service)
+                AppProfile.from_grpc app_profile, service
               end
             )
             app_profiles.grpc = grpc

data/lib/google/cloud/bigtable/chunk_processor.rb

@@ -19,7 +19,7 @@ module Google
   module Cloud
     module Bigtable
       # @private
-      # # RowsMutator
+      # # ChunkProcessor
       #
       # Read a chunk of data and merge it based on states and build rows and cells
       #
@@ -46,6 +46,7 @@ module Google
           reset_to_new_row
         end
 
+        ##
         # Process chunk and build full row with cells
         #
         # @param chunk [Google::Bigtable::V2::ReadRowsResponse::CellChunk]
@@ -53,12 +54,8 @@ module Google
         def process chunk
           self.chunk = chunk
 
-          if chunk.commit_row
-            raise_if(
-              chunk.value_size > 0,
-              "Commit rows cannot have a non-zero value_size."
-            )
-          end
+
+          raise_if chunk.value_size.positive?, "Commit rows cannot have a non-zero value_size." if chunk.commit_row
 
           if state == NEW_ROW
             process_new_row
@@ -69,6 +66,7 @@ module Google
           end
         end
 
+        ##
         # Validate row status commit or reset
         #
         # @raise [Google::Cloud::Bigtable::InvalidRowStateError]
@@ -81,11 +79,12 @@ module Google
               chunk.family_name ||
               chunk.qualifier ||
               !chunk.value.empty? ||
-              chunk.timestamp_micros > 0)
+              chunk.timestamp_micros.positive?)
 
           raise_if value, "A reset should have no data"
         end
 
+        ##
         # Validate chunk has new row state
         #
         # @raise [Google::Cloud::Bigtable::InvalidRowStateError]
@@ -94,36 +93,29 @@ module Google
         #   or if family name or column qualifier are empty
         #
         def validate_new_row
-          raise_if(row.key, "A new row cannot have existing state")
-          raise_if(chunk.row_key.empty?, "A row key must be set")
-          raise_if(chunk.reset_row, "A new row cannot be reset")
-          raise_if(
-            last_key == chunk.row_key,
-            "A commit happened but the same key followed"
-          )
-          raise_if(chunk.family_name.nil?, "A family must be set")
-          raise_if(chunk.qualifier.nil?, "A column qualifier must be set")
+          raise_if row.key, "A new row cannot have existing state"
+          raise_if chunk.row_key.empty?, "A row key must be set"
+          raise_if chunk.reset_row, "A new row cannot be reset"
+          raise_if last_key == chunk.row_key, "A commit happened but the same key followed"
+          raise_if chunk.family_name.nil?, "A family must be set"
+          raise_if chunk.qualifier.nil?, "A column qualifier must be set"
         end
 
+        ##
         # Validate chunk merge is in progress to build new row
         #
         # @raise [Google::Cloud::Bigtable::InvalidRowStateError]
         #   If row and chunk row key are not same or chunk row key is empty.
         #
         def validate_row_in_progress
-          raise_if(
-            !chunk.row_key.empty? && chunk.row_key != row.key,
-            "A commit is required between row keys"
-          )
+          raise_if !chunk.row_key.empty? && chunk.row_key != row.key, "A commit is required between row keys"
 
-          raise_if(
-            chunk.family_name && chunk.qualifier.nil?,
-            "A qualifier must be specified"
-          )
+          raise_if chunk.family_name && chunk.qualifier.nil?, "A qualifier must be specified"
 
           validate_reset_row
         end
 
+        ##
         # Process new row by setting values from current chunk.
         #
         # @return [Google::Cloud::Bigtable::Row]
@@ -142,6 +134,7 @@ module Google
           next_state!
         end
 
+        ##
         # Process chunk if row state is in progress
         #
         # @return [Google::Cloud::Bigtable::Row]
@@ -158,6 +151,7 @@ module Google
           next_state!
         end
 
+        ##
         # Process chunk if row cell state is in progress
         #
         # @return [Google::Cloud::Bigtable::Row]
@@ -170,6 +164,7 @@ module Google
           next_state!
         end
 
+        ##
         # Set next state of row.
         #
         # @return [Google::Cloud::Bigtable::Row]
@@ -198,13 +193,7 @@ module Google
 
         # Build cell and append to row.
         def persist_cell
-          cell = Row::Cell.new(
-            cur_family,
-            cur_qaul,
-            cur_ts,
-            cur_val,
-            cur_labels
-          )
+          cell = Row::Cell.new cur_family, cur_qaul, cur_ts, cur_val, cur_labels
           row.cells[cur_family] << cell
 
           # Clear cached cell values
@@ -224,6 +213,7 @@ module Google
           self.cur_labels = nil
         end
 
+        ##
         # Validate last row is completed
         #
         # @raise [Google::Cloud::Bigtable::InvalidRowStateError]
@@ -232,14 +222,12 @@ module Google
         def validate_last_row_complete
           return if row.key.nil?
 
-          raise_if(
-            !chunk.commit_row,
-            "Response ended with pending row without commit"
-          )
+          raise_if !chunk.commit_row, "Response ended with pending row without commit"
         end
 
         private
 
+        ##
         # Raise error on condition failure
         #
         # @raise [Google::Cloud::Bigtable::InvalidRowStateError]

data/lib/google/cloud/bigtable/cluster.rb

@@ -21,6 +21,7 @@ require "google/cloud/bigtable/cluster/job"
 module Google
   module Cloud
     module Bigtable
+      ##
       # # Cluster
       #
       # A configuration object describing how Cloud Bigtable should treat traffic
@@ -54,59 +55,74 @@ module Google
           @service = service
         end
 
-        # The unique identifier for the project.
+        ##
+        # The unique identifier for the project to which the cluster belongs.
         #
         # @return [String]
+        #
         def project_id
           @grpc.name.split("/")[1]
         end
 
-        # The unique identifier for the instance.
+        ##
+        # The unique identifier for the instance to which the cluster belongs.
         #
         # @return [String]
+        #
         def instance_id
           @grpc.name.split("/")[3]
         end
 
+        ##
         # The unique identifier for the cluster.
         #
         # @return [String]
+        #
         def cluster_id
           @grpc.name.split("/")[5]
         end
 
+        ##
         # The unique name of the cluster. Value in the form
         # `projects/<project_id>/instances/<instance_id>/clusters/<cluster_id>`.
         #
         # @return [String]
+        #
         def path
           @grpc.name
         end
 
-        # The current instance state.
+        ##
+        # The current state of the cluster.
         # Possible values are
         # `:CREATING`, `:READY`, `:STATE_NOT_KNOWN`, `:RESIZING`, `:DISABLED`.
         #
         # @return [Symbol]
+        #
         def state
           @grpc.state
         end
 
+        ##
         # The cluster has been successfully created and is ready to serve requests.
         #
         # @return [Boolean]
+        #
         def ready?
           state == :READY
         end
 
-        # The instance is currently being created, and may be destroyed if the
+        ##
+        # The cluster is currently being created, and may be destroyed if the
         # creation process encounters an error.
         #
         # @return [Boolean]
+        #
         def creating?
           state == :CREATING
         end
 
+        ##
         # The cluster is currently being resized, and may revert to its previous
         # node count if the process encounters an error.
         # A cluster is still capable of serving requests while being resized,
@@ -114,62 +130,76 @@ module Google
         # between the starting and requested states.
         #
         # @return [Boolean]
+        #
         def resizing?
           state == :RESIZING
         end
 
+        ##
         # The cluster has no backing nodes. The data (tables) still
         # exist, but no operations can be performed on the cluster.
         #
         # @return [Boolean]
+        #
         def disabled?
           state == :DISABLED
         end
 
+        ##
         # The number of nodes allocated to this cluster.
         #
         # @return [Integer]
+        #
         def nodes
           @grpc.serve_nodes
         end
 
+        ##
         # The number of nodes allocated to this cluster. More nodes enable higher
         # throughput and more consistent performance.
         #
         # @param serve_nodes [Integer] Number of nodes
+        #
         def nodes= serve_nodes
           @grpc.serve_nodes = serve_nodes
         end
 
+        ##
         # The type of storage used by this cluster to serve its
         # parent instance's tables, unless explicitly overridden.
         # Valid values are `:SSD`(Flash (SSD) storage should be used),
         # `:HDD`(Magnetic drive (HDD) storage should be used)
         #
         # @return [Symbol]
+        #
         def storage_type
           @grpc.default_storage_type
         end
 
+        ##
         # Cluster location.
         # For example, "us-east1-b"
         #
         # @return [String]
+        #
         def location
           @grpc.location.split("/")[3]
         end
 
+        ##
         # Cluster location path in form of
         # `projects/<project_id>/locations/<zone>`
         #
         # @return [String]
+        #
         def location_path
           @grpc.location
         end
 
-        # Update cluster.
+        ##
+        # Updates the cluster.
         #
-        # `serve_nodes` is the only updatable field
+        # `serve_nodes` is the only updatable field.
         #
         # @return [Google::Cloud::Bigtable::Cluster::Job]
         #   The job representing the long-running, asynchronous processing of
@@ -199,25 +229,22 @@ module Google
         #
         def save
           ensure_service!
-          grpc = service.update_cluster(
-            instance_id,
-            cluster_id,
-            location_path,
-            nodes
-          )
-          Cluster::Job.from_grpc(grpc, service)
+          grpc = service.update_cluster instance_id, cluster_id, location_path, nodes
+          Cluster::Job.from_grpc grpc, service
         end
         alias update save
 
-        # Reloads cluster information.
+        ##
+        # Reloads cluster data.
         #
         # @return [Google::Cloud::Bigtable::Cluster]
-
+        #
         def reload!
-          @grpc = service.get_cluster(instance_id, cluster_id)
+          @grpc = service.get_cluster instance_id, cluster_id
           self
         end
 
+        ##
         # Permanently deletes the cluster.
         #
         # @return [Boolean] Returns `true` if the cluster was deleted.
@@ -233,7 +260,7 @@ module Google
         #
         def delete
           ensure_service!
-          service.delete_cluster(instance_id, cluster_id)
+          service.delete_cluster instance_id, cluster_id
           true
         end
 
@@ -246,7 +273,7 @@ module Google
         # @param service [Google::Cloud::Bigtable::Service]
         # @return [Google::Cloud::Bigtable::Cluster]
         def self.from_grpc grpc, service
-          new(grpc, service)
+          new grpc, service
         end
 
         protected