gcloud 0.1.0 → 0.1.1

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

@@ -1,3 +1,4 @@
+#--
 # Copyright 2015 Google Inc. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/gcloud/storage/file/verifier.rb

@@ -1,3 +1,4 @@
+#--
 # Copyright 2014 Google Inc. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/gcloud/storage/project.rb

@@ -1,3 +1,4 @@
+#--
 # Copyright 2014 Google Inc. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,14 +22,21 @@ require "gcloud/storage/file"
 module Gcloud
   module Storage
     ##
-    # Represents the Project that the Buckets and Files belong to.
+    # = Project
+    #
+    # Represents the project that storage buckets and files belong to.
+    # All data in Google Cloud Storage belongs inside a project.
+    # A project consists of a set of users, a set of APIs, billing,
+    # authentication, and monitoring settings for those APIs.
     #
     # Gcloud::Storage::Project is the main object for interacting with
     # Google Storage. Gcloud::Storage::Bucket objects are created,
     # read, updated, and deleted by Gcloud::Storage::Project.
     #
-    #   storage = Gcloud.storage "my-todo-project",
-    #                            "/path/to/keyfile.json"
+    #   require "gcloud/datastore"
+    #
+    #   storage = Gcloud.storage
+    #
     #   bucket = storage.find_bucket "my-bucket"
     #   file = bucket.find_file "path/to/my-file.ext"
     #
@@ -47,21 +55,86 @@ module Gcloud
       end
 
       ##
-      # The project identifier.
+      # The Storage project connected to.
+      #
+      # === Example
+      #
+      #   require "gcloud/datastore"
+      #
+      #   storage = Gcloud.storage "my-todo-project",
+      #                            "/path/to/keyfile.json"
+      #
+      #   storage.project #=> "my-todo-project"
+      #
       def project
         connection.project
       end
 
+      ##
+      # Default project.
+      def self.default_project #:nodoc:
+        ENV["STORAGE_PROJECT"] || ENV["GOOGLE_CLOUD_PROJECT"]
+      end
+
       ##
       # Retrieves a list of buckets for the given project.
       #
+      # === Parameters
+      #
+      # +options+::
+      #   An optional Hash for controlling additional behavor. (+Hash+)
+      # +options [:prefix]+::
+      #   Filter results to buckets whose names begin with this prefix.
+      #   (+String+)
+      # +options [:token]+::
+      #   A previously-returned page token representing part of the larger set
+      #   of results to view. (+String+)
+      # +options [:max]+::
+      #   Maximum number of buckets to return. (+Integer+)
+      #
+      # === Returns
+      #
+      # Array of Gcloud::Datastore::Bucket (Gcloud::Datastore::Bucket::List)
+      #
+      # === Examples
+      #
+      #   require "gcloud/datastore"
+      #
       #   storage = Gcloud.storage
+      #
       #   buckets = storage.buckets
       #   buckets.each do |bucket|
       #     puts bucket.name
       #   end
       #
-      # See Gcloud::Storage::Bucket
+      # You can also retrieve all buckets whose names begin with a prefix using
+      # the +:prefix+ option:
+      #
+      #   require "gcloud/storage"
+      #
+      #   storage = Gcloud.storage
+      #
+      #   user_buckets = storage.buckets prefix: "user-"
+      #
+      # If you have a significant number of buckets, you may need to paginate
+      # through them: (See Bucket::List#token)
+      #
+      #   require "gcloud/storage"
+      #
+      #   storage = Gcloud.storage
+      #
+      #   all_buckets = []
+      #   tmp_buckets = storage.buckets
+      #   while tmp_buckets.any? do
+      #     tmp_buckets.each do |bucket|
+      #       all_buckets << bucket
+      #     end
+      #     # break loop if no more buckets available
+      #     break if tmp_buckets.token.nil?
+      #     # get the next group of buckets
+      #     tmp_buckets = storage.buckets token: tmp_buckets.token
+      #   end
+      #
       def buckets options = {}
         resp = connection.list_buckets options
         if resp.success?
@@ -74,11 +147,24 @@ module Gcloud
       ##
       # Retrieves bucket by name.
       #
+      # === Parameters
+      #
+      # +bucket_name+::
+      #   Name of a bucket. (+String+)
+      #
+      # === Returns
+      #
+      # Gcloud::Datastore::Bucket or nil if bucket does not exist
+      #
+      # === Example
+      #
+      #   require "gcloud/storage"
+      #
       #   storage = Gcloud.storage
+      #
       #   bucket = storage.find_bucket "my-bucket"
       #   puts bucket.name
       #
-      # See Gcloud::Storage::Bucket
       def find_bucket bucket_name
         resp = connection.get_bucket bucket_name
         if resp.success?
@@ -92,15 +178,38 @@ module Gcloud
       ##
       # Creates a new bucket.
       #
-      #   bucket = project.create_bucket "my-bucket"
+      # === Parameters
+      #
+      # +bucket_name+::
+      #   Name of a bucket. (+String+)
+      # +options+::
+      #   An optional Hash for controlling additional behavor. (+Hash+)
+      # +options [:retries]+::
+      #   The number of times the API call should be retried.
+      #   Default is Gcloud::Backoff.retries. (+Integer+)
+      #
+      # === Returns
+      #
+      # Gcloud::Datastore::Bucket
+      #
+      # === Examples
+      #
+      #   require "gcloud/storage"
+      #
+      #   storage = Gcloud.storage
+      #
+      #   bucket = storage.create_bucket "my-bucket"
       #
       # The API call to create the bucket may be retried under certain
       # conditions. See Gcloud::Backoff to control this behavior, or
-      # specify the wanted behavior in the call:
+      # specify the wanted behavior in the call with the +:retries:+ option:
+      #
+      #   require "gcloud/storage"
+      #
+      #   storage = Gcloud.storage
       #
-      #   bucket = project.create_bucket "my-bucket", retries: 5
+      #   bucket = storage.create_bucket "my-bucket", retries: 5
       #
-      # See Gcloud::Storage::Bucket
       def create_bucket bucket_name, options = {}
         options[:acl] = Bucket::Acl.predefined_rule_for options[:acl]
         default_acl = options[:default_acl]

data/lib/gcloud/version.rb

@@ -1,5 +1,20 @@
-##
-# Google Cloud
+#--
+# Copyright 2015 Google Inc. All rights reserved.
+#
+# 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
+#
+#     http://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.
+
+#--
+# Google Cloud Version
 module Gcloud
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gcloud
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Silvano Luciani
@@ -9,162 +9,148 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-31 00:00:00.000000000 Z
+date: 2015-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: beefcake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: google-api-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.3
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.4'
 - !ruby/object:Gem::Dependency
   name: digest-crc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.4'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '5.5'
+        version: '5.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '5.5'
+        version: '5.7'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.27'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.27'
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.5'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.7'
-- !ruby/object:Gem::Dependency
-  name: hoe
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.13'
 description: Gcloud is the official library for interacting with Google Cloud.
 email:
 - silvano@google.com
@@ -172,20 +158,17 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
+- AUTHENTICATION.md
 - CHANGELOG.md
 - CONTRIBUTING.md
-- Manifest.txt
+- LICENSE
 - README.md
 files:
-- ".gemtest"
-- ".rubocop.yml"
+- AUTHENTICATION.md
 - CHANGELOG.md
 - CONTRIBUTING.md
 - LICENSE
-- Manifest.txt
 - README.md
-- Rakefile
-- gcloud.gemspec
 - lib/gcloud.rb
 - lib/gcloud/backoff.rb
 - lib/gcloud/credentials.rb
@@ -216,61 +199,31 @@ files:
 - lib/gcloud/storage/file/verifier.rb
 - lib/gcloud/storage/project.rb
 - lib/gcloud/version.rb
-- rakelib/console.rake
-- rakelib/manifest.rake
-- rakelib/proto.rake
-- rakelib/rubocop.rake
-- rakelib/test.rake
-- test/gcloud/datastore/proto/test_cursor.rb
-- test/gcloud/datastore/proto/test_direction.rb
-- test/gcloud/datastore/proto/test_operator.rb
-- test/gcloud/datastore/proto/test_value.rb
-- test/gcloud/datastore/test_connection.rb
-- test/gcloud/datastore/test_credentials.rb
-- test/gcloud/datastore/test_dataset.rb
-- test/gcloud/datastore/test_entity.rb
-- test/gcloud/datastore/test_entity_exclude.rb
-- test/gcloud/datastore/test_key.rb
-- test/gcloud/datastore/test_query.rb
-- test/gcloud/datastore/test_transaction.rb
-- test/gcloud/storage/test_backoff.rb
-- test/gcloud/storage/test_bucket.rb
-- test/gcloud/storage/test_bucket_acl.rb
-- test/gcloud/storage/test_default_acl.rb
-- test/gcloud/storage/test_file.rb
-- test/gcloud/storage/test_file_acl.rb
-- test/gcloud/storage/test_project.rb
-- test/gcloud/storage/test_storage.rb
-- test/gcloud/storage/test_verifier.rb
-- test/gcloud/test_version.rb
-- test/helper.rb
 homepage: http://googlecloudplatform.github.io/gcloud-ruby/
 licenses:
 - Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options:
-- "--main"
+- --main
 - README.md
-- "--exclude"
+- --exclude
 - lib/gcloud/proto/
-- "--exclude"
-- Manifest.txt
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud