gcloud 0.1.1 → 0.2.0

data/lib/gcloud/storage/project.rb

@@ -33,14 +33,15 @@ module Gcloud
     # Google Storage. Gcloud::Storage::Bucket objects are created,
     # read, updated, and deleted by Gcloud::Storage::Project.
     #
-    #   require "gcloud/datastore"
+    #   require "gcloud"
     #
-    #   storage = Gcloud.storage
+    #   gcloud = Gcloud.new
+    #   storage = gcloud.storage
     #
-    #   bucket = storage.find_bucket "my-bucket"
-    #   file = bucket.find_file "path/to/my-file.ext"
+    #   bucket = storage.bucket "my-bucket"
+    #   file = bucket.file "path/to/my-file.ext"
     #
-    # See Gcloud.storage
+    # See Gcloud#storage
     class Project
       ##
       # The Connection object.
@@ -49,7 +50,7 @@ module Gcloud
       ##
       # Creates a new Project instance.
       #
-      # See Gcloud.storage
+      # See Gcloud#storage
       def initialize project, credentials #:nodoc:
         @connection = Connection.new project, credentials
       end
@@ -59,10 +60,11 @@ module Gcloud
       #
       # === Example
       #
-      #   require "gcloud/datastore"
+      #   require "gcloud"
       #
-      #   storage = Gcloud.storage "my-todo-project",
-      #                            "/path/to/keyfile.json"
+      #   gcloud = Gcloud.new "my-todo-project",
+      #                       "/path/to/keyfile.json"
+      #   storage = gcloud.storage
       #
       #   storage.project #=> "my-todo-project"
       #
@@ -82,25 +84,26 @@ module Gcloud
       # === Parameters
       #
       # +options+::
-      #   An optional Hash for controlling additional behavor. (+Hash+)
-      # +options [:prefix]+::
+      #   An optional Hash for controlling additional behavior. (+Hash+)
+      # <code>options[:prefix]</code>::
       #   Filter results to buckets whose names begin with this prefix.
       #   (+String+)
-      # +options [:token]+::
+      # <code>options[:token]</code>::
       #   A previously-returned page token representing part of the larger set
       #   of results to view. (+String+)
-      # +options [:max]+::
+      # <code>options[:max]</code>::
       #   Maximum number of buckets to return. (+Integer+)
       #
       # === Returns
       #
-      # Array of Gcloud::Datastore::Bucket (Gcloud::Datastore::Bucket::List)
+      # Array of Gcloud::Storage::Bucket (Gcloud::Storage::Bucket::List)
       #
       # === Examples
       #
-      #   require "gcloud/datastore"
+      #   require "gcloud"
       #
-      #   storage = Gcloud.storage
+      #   gcloud = Gcloud.new
+      #   storage = gcloud.storage
       #
       #   buckets = storage.buckets
       #   buckets.each do |bucket|
@@ -110,18 +113,20 @@ module Gcloud
       # You can also retrieve all buckets whose names begin with a prefix using
       # the +:prefix+ option:
       #
-      #   require "gcloud/storage"
+      #   require "gcloud"
       #
-      #   storage = Gcloud.storage
+      #   gcloud = Gcloud.new
+      #   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"
+      #   require "gcloud"
       #
-      #   storage = Gcloud.storage
+      #   gcloud = Gcloud.new
+      #   storage = gcloud.storage
       #
       #   all_buckets = []
       #   tmp_buckets = storage.buckets
@@ -143,6 +148,7 @@ module Gcloud
           fail ApiError.from_response(resp)
         end
       end
+      alias_method :find_buckets, :buckets
 
       ##
       # Retrieves bucket by name.
@@ -154,18 +160,19 @@ module Gcloud
       #
       # === Returns
       #
-      # Gcloud::Datastore::Bucket or nil if bucket does not exist
+      # Gcloud::Storage::Bucket or nil if bucket does not exist
       #
       # === Example
       #
-      #   require "gcloud/storage"
+      #   require "gcloud"
       #
-      #   storage = Gcloud.storage
+      #   gcloud = Gcloud.new
+      #   storage = gcloud.storage
       #
-      #   bucket = storage.find_bucket "my-bucket"
+      #   bucket = storage.bucket "my-bucket"
       #   puts bucket.name
       #
-      def find_bucket bucket_name
+      def bucket bucket_name
         resp = connection.get_bucket bucket_name
         if resp.success?
           Bucket.from_gapi resp.data, connection
@@ -174,6 +181,7 @@ module Gcloud
           fail ApiError.from_response(resp)
         end
       end
+      alias_method :find_bucket, :bucket
 
       ##
       # Creates a new bucket.
@@ -183,20 +191,21 @@ module Gcloud
       # +bucket_name+::
       #   Name of a bucket. (+String+)
       # +options+::
-      #   An optional Hash for controlling additional behavor. (+Hash+)
-      # +options [:retries]+::
+      #   An optional Hash for controlling additional behavior. (+Hash+)
+      # <code>options[:retries]</code>::
       #   The number of times the API call should be retried.
       #   Default is Gcloud::Backoff.retries. (+Integer+)
       #
       # === Returns
       #
-      # Gcloud::Datastore::Bucket
+      # Gcloud::Storage::Bucket
       #
       # === Examples
       #
-      #   require "gcloud/storage"
+      #   require "gcloud"
       #
-      #   storage = Gcloud.storage
+      #   gcloud = Gcloud.new
+      #   storage = gcloud.storage
       #
       #   bucket = storage.create_bucket "my-bucket"
       #
@@ -204,9 +213,10 @@ module Gcloud
       # conditions. See Gcloud::Backoff to control this behavior, or
       # specify the wanted behavior in the call with the +:retries:+ option:
       #
-      #   require "gcloud/storage"
+      #   require "gcloud"
       #
-      #   storage = Gcloud.storage
+      #   gcloud = Gcloud.new
+      #   storage = gcloud.storage
       #
       #   bucket = storage.create_bucket "my-bucket", retries: 5
       #

data/lib/gcloud/version.rb

@@ -16,5 +16,5 @@
 #--
 # Google Cloud Version
 module Gcloud
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gcloud
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Silvano Luciani
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-17 00:00:00.000000000 Z
+date: 2015-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: beefcake
@@ -158,17 +158,13 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
+- OVERVIEW.md
 - AUTHENTICATION.md
 - CHANGELOG.md
-- CONTRIBUTING.md
-- LICENSE
-- README.md
 files:
 - AUTHENTICATION.md
 - CHANGELOG.md
-- CONTRIBUTING.md
-- LICENSE
-- README.md
+- OVERVIEW.md
 - lib/gcloud.rb
 - lib/gcloud/backoff.rb
 - lib/gcloud/credentials.rb
@@ -186,6 +182,17 @@ files:
 - lib/gcloud/datastore/query.rb
 - lib/gcloud/datastore/transaction.rb
 - lib/gcloud/proto/datastore_v1.pb.rb
+- lib/gcloud/pubsub.rb
+- lib/gcloud/pubsub/connection.rb
+- lib/gcloud/pubsub/credentials.rb
+- lib/gcloud/pubsub/errors.rb
+- lib/gcloud/pubsub/message.rb
+- lib/gcloud/pubsub/project.rb
+- lib/gcloud/pubsub/received_message.rb
+- lib/gcloud/pubsub/subscription.rb
+- lib/gcloud/pubsub/subscription/list.rb
+- lib/gcloud/pubsub/topic.rb
+- lib/gcloud/pubsub/topic/list.rb
 - lib/gcloud/storage.rb
 - lib/gcloud/storage/bucket.rb
 - lib/gcloud/storage/bucket/acl.rb
@@ -206,7 +213,7 @@ metadata: {}
 post_install_message: 
 rdoc_options:
 - --main
-- README.md
+- OVERVIEW.md
 - --exclude
 - lib/gcloud/proto/
 require_paths:

data/CONTRIBUTING.md

@@ -1,93 +0,0 @@
-# Contributing to Gcloud
-
-1. **Sign one of the contributor license agreements below.**
-2. Fork the repo, develop and test your code changes.
-3. Send a pull request.
-
-## Contributor License Agreements
-
-Before we can accept your pull requests you'll need to sign a Contributor License Agreement (CLA):
-
-- **If you are an individual writing original source code** and **you own the intellectual property**, then you'll need to sign an [individual CLA](https://developers.google.com/open-source/cla/individual).
-- **If you work for a company that wants to allow you to contribute your work**, then you'll need to sign a [corporate CLA](https://developers.google.com/open-source/cla/corporate).
-
-You can sign these electronically (just scroll to the bottom). After that, we'll be able to accept your pull requests.
-
-## Tests
-
-Tests are very important part of gcloud-ruby. All contributions should include tests that ensure the contributed code behaves as expected.
-
-### Unit Tests
-
-To run the unit tests, simply run:
-
-``` sh
-$ rake test
-```
-
-### Regression Tests
-
-To run the regression tests, first create and configure a project in the Google Developers Console. Be sure to download the JSON KEY file. Make note of the PROJECT_ID and the KEYFILE location on your system.
-
-Then Install the [gcloud command-line tool](https://developers.google.com/cloud/sdk/gcloud/) and use it to create the indexes used in the datastore regression tests.
-
-From the project's root directory:
-
-``` sh
-# Install the app component
-$ gcloud components update app
-
-# Set the default project in your env
-$ gcloud config set project PROJECT_ID
-
-# Authenticate the gcloud tool with your account
-$ gcloud auth login
-
-# Create the indexes
-$ gcloud preview datastore create-indexes regression/data/
-```
-
-As soon as the indexes are prepared you can run the regression tests:
-
-``` sh
-$ rake test:regression[PROJECT_ID,KEYFILE_PATH]
-```
-
-Or, if you prefer you can store the values in the `GCLOUD_TEST_PROJECT` and `GCLOUD_TEST_KEYFILE` environment variables:
-
-``` sh
-$ export GCLOUD_TEST_PROJECT=my-project-id
-$ export GCLOUD_TEST_KEYFILE=/path/to/keyfile.json
-$ rake test:regression
-```
-
-If you want to use different values for Datastore vs. Storage regression tests, you can use the `DATASTORE_TEST_` and `STORAGE_TEST_` environment variables:
-
-``` sh
-$ export DATASTORE_TEST_PROJECT=my-project-id
-$ export DATASTORE_TEST_KEYFILE=/path/to/keyfile.json
-$ export STORAGE_TEST_PROJECT=my-other-project-id
-$ export STORAGE_TEST_KEYFILE=/path/to/other/keyfile.json
-$ rake test:regression
-```
-
-### Local Datastore Devserver
-
-You can run the Datstore regression tests against a devserver running locally. To switch to the devserver set the `DATASTORE_HOST` environment variable with the location of the local devserver.
-
-``` sh
-$ DATASTORE_HOST=http://127.0.0.1:8080 rake test:regression:datastore
-```
-
-## Coding Style
-
-Please follow the established coding style in the library. The style is is largely based on [The Ruby Style Guide](https://github.com/bbatsov/ruby-style-guide) with a few exceptions based on seattle-style:
-
-* Avoid parenthesis when possible, including in method definitions.
-* Always use double quotes strings. ([Option B](https://github.com/bbatsov/ruby-style-guide#strings))
-
-You can check your code against these rules by running Rubocop like so:
-
-```sh
-$ rake rubocop
-```

data/LICENSE

@@ -1,201 +0,0 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   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.