google_storage 0.1.2 → 0.2.0

data/README.textile

@@ -1,61 +1,86 @@
 h1. Google Storage using API v2
 
-I wrote this gem because the only google storage gems I could find already written were either written a while ago and only set up to use the original
-version of Google's API or they were dependent on Gems that don't run properly on... dare I say it... windows.. :)  Apologies, I'm without choice
-at the moment, but anyways, this gem should run fine on all platforms and I've tried to keep dependencies to a minimum. Let me know if you find
-any bugs though ok and feel free to contribute.
+*last updated 30/9/2012*
 
-h2. Response Object
+I wrote this gem to work with the newer v2 of the Google Storage API. It will run fine on all platforms and has been tested to work
+with ruby 1.8.7 and above. Let me know if you find any bugs though and feel free to make contributions.
 
-A lot of the responses from GS on the backend are a little bit inconsistent, sometimes returning response codes, sometimes returning heavily
-nested xml data and sometimes just returning information in the response header. I've tried to parse all responses that are returned from GS into a fairly
-consistent type of response Hash object. Usually this is in the form of something like this:
+h2. Setup Guide
 
-<pre>
-#successful responses will always include a :success => true key/value pair
+This guide assumes you've already set up a Google Storage account through Google, if you haven't already yet, read the
+'Setup your Google Project Client ID's' section further below and create one first before trying to setup this gem.
 
-client.list_buckets
-=> {:success=>true,
-        :buckets=>[ {"Name"=>"bucket_1_example", "CreationDate"=>"2011-06-07T07:11:18.480Z"},
-                    {"Name"=>"bucket_2_example", "CreationDate"=>"2011-05-31T10:58:08.097Z"},
-                    {"Name"=>"bucket_3_example", "CreationDate"=>"2011-06-06T22:47:10.728Z"}],
-        :raw=>{ THIS :raw FIELD WILL RETURN A HASH OF THE UNPARSED RESPONSE IN CASE YOU NEED IT }
-    }
+There's a couple of steps to follow in order to setup this gem. The new Google Storage APIv2 uses OAuth 2.0 to authenticate requests,
+you can read up on the nitty gritty details if you like, here:
+"Google's OAuth2 Guide":http://code.google.com/apis/accounts/docs/OAuth2.html
 
-#Unsuccessful responses will return an "Error" Hash
+I'll try and add client side support also once this gem is up and running properly, but for the moment it's only setup to support
+server side applications.
 
-client.get_bucket("bucket_4_example")
-=> {"Error"=>{
-        "Code"=>"NoSuchBucket",
-        "Message"=>"The specified bucket does not exist."
-    }}
+But it's also possible to run this gem from the command line, or through a plain ruby script if you want.
+
+
+h3. Rails setup
+
+<pre>#Include the google_storage gem in your Gemfile and install config files
+gem 'google_storage'
+bundle install
+
+#Then in your Rails application directory run:
+cd /rails_app
+rails generate google_storage:install
+
+#This will generate some rake tasks and a google_storage.yml file in your config directory.
+/rails_app/config/google_storage.yml
+/rails_app/lib/tasks/google_storage.task
+
+#Before running any of the rake tasks, update the google_storage.yml file with your own Google Storage login details
+#and read the commented out code in the google_storage.yml on how to use the rake tasks to acquire a refresh token
+#from google
 </pre>
 
-h2. Setup Guide
+h3. Ruby setup
 
-There's a couple of steps to follow in order to setup this gem. The new Google Storage APIv2 uses OAuth 2.0 to authenticate requests, you can read up
-more on the nitty gritty if you like here: "Google's OAuth2 Guide":http://code.google.com/apis/accounts/docs/OAuth2.html
+<pre>#Install the google_storage gem first
 
-I'll try and add client side support also once this gem is up and running properly, but for the moment it's only setup to support server side web
-applications.
+gem install google_storage
 
-But it's also possible to run this gem from the command line if you want.
+#From the command line run: 'deploy_gs_yml' to generate a google_storage.yml file
 
+cd /tmp
+deploy_gs_yml
 
-h2. Install the google_storage Gem
+#This will generate a template file: /tmp/google_storage.yml
 
-Include the google_storage gem in your Gemfile and install config files
-<pre>gem 'google_storage'
-bundle install
-</pre>
-Then in your Rails application directory run:
-<pre>rails generate google_storage:install
-</pre>
-This will generate some rake tasks a google_storage.yml file in your config directory.
-<pre>/Application/config/google_storage.yml
-/Application/lib/tasks/google_storage.task
-</pre>
+#Open the generated google_storage.yml file and enter your own google credentials
+#Then run IRB and type the following:
 
+require 'google_storage'
+client = GoogleStorage::Client.new(:config_yml => '/tmp/google_storage.yml')
+
+#The authorization_url takes 1 of 3 arguments depending on how much access you want to grant yourself:
+#(:read_only, :read_write or :full_control)
+
+puts client.authorization_url(:full_control)
+
+#This will output a really long URL, copy and paste this URL into a browser and you'll be prompted by Google
+#to allow access to your google storage account.
+#Accept this request and your browser will redirect to a "PAGE NOT FOUND" error most likely. This is fine.
+#In your browsers URL now though, you should see something like this:
+
+http://localhost:3000/example?code=4/oSdp5JUOiTVcq9p6SW6rjAfrdkuG.wngsnANBsI4RgrKXntQAax1m82kodAI
+
+#This is an authentication token. Copy the token from this URL and issue one more command in IRB:
+
+puts client.acquire_refresh_token('4/oSdp5JUOiTVcq9p6SW6rjAfrdkuG.wngsnANBsI4RgrKXntQAax1m82kodAI')
+
+#Copy the output result from this command into the bottom of your google_storage.yml file
+
+refresh_token: 1/Lyti64r-CmpYTpmXC6n4zKK84oh__6yArTPfgANTP9f
+
+#You should now be setup and able to perform the commands in the 'Examples' section below.
+
+</pre>
 
 
 h2. Setup your Google Project Client ID's
@@ -63,15 +88,16 @@ h2. Setup your Google Project Client ID's
 Visit "Google Storage":http://code.google.com/apis/storage/ and select activate Google Storage.
 If you haven't already got a project set up, it'll prompt you to create one.
 
-When you have access to your Google APIs Console, you need to enable Google Storage. When you select enable, you'll be shown terms and conditions
-and you'll then need to setup billing. They have full pricing details there for you to check out as well but I think it's pretty reasonable..
+When you have access to your Google APIs Console, you need to enable Google Storage. When you select enable, you'll be shown terms
+and conditions and you'll then need to setup billing. They have full pricing details there for you to check out as well but I think
+it's pretty reasonable..
 
 Create a client ID for your project
 On the left menu select "API Access" and then "Create an OAuth 2.0 client ID"
 Enter your project's name and brand information.
 
-Select Application type = Web Application and enter your site's information. If you're using localhost and running
-locally make sure you include the port number you're using as well.
+Select Application type = Web Application and enter your site's information. If you're using localhost and running locally make sure
+you include the port number you're using as well.
 
 
 h2. Enter your Client ID details into your google_storage.yml
@@ -133,6 +159,34 @@ web_applications:
 Once you've acquired your refresh_token you can now make calls to the API.
 
 
+h2. Response Object
+
+A lot of the responses from GS on the backend are a little bit inconsistent, sometimes returning response codes, sometimes returning
+heavily nested xml data and sometimes just returning information in the response header. I've tried to parse all responses that are
+returned from GS into a fairly consistent type of response Hash object.
+Usually this is in the form of something like this:
+
+<pre>
+#successful responses will always include a :success => true key/value pair
+
+client.list_buckets
+=> {:success=>true,
+        :buckets=>[ {"Name"=>"bucket_1_example", "CreationDate"=>"2011-06-07T07:11:18.480Z"},
+                    {"Name"=>"bucket_2_example", "CreationDate"=>"2011-05-31T10:58:08.097Z"},
+                    {"Name"=>"bucket_3_example", "CreationDate"=>"2011-06-06T22:47:10.728Z"}],
+        :raw=>{ THIS :raw FIELD WILL RETURN A HASH OF THE UNPARSED RESPONSE IN CASE YOU NEED IT }
+    }
+
+#Unsuccessful responses will return an "Error" Hash
+
+client.get_bucket("bucket_4_example")
+=> {"Error"=>{
+        "Code"=>"NoSuchBucket",
+        "Message"=>"The specified bucket does not exist."
+    }}
+</pre>
+
+
 h2. Examples
 
 h3. Configuration
@@ -143,7 +197,7 @@ h3. Configuration
      <pre>client = GoogleStorage::Client.new</pre>
 
    Otherwise you can pass in the path to the google_storage.yml
-     <pre>client = GoogleStorage::Client.new(:config_yml => 'C:/github/highvoltage/config/google_storage.yml')
+     <pre>client = GoogleStorage::Client.new(:config_yml => 'C:/rails_app/config/google_storage.yml')
      </pre>
 
 h3. Service Requests
@@ -173,15 +227,15 @@ h3. Object Requests
 
    GET Object
      <pre>client.get_object('bucket_name', 'filename.jpg')
-     client.get_object('bucket_name', 'filename.jpg', :write_to_file => 'c:/temp/new_file_name.jpg')</pre>
+     client.get_object('bucket_name', 'filename.jpg', :write_to_file => 'c:/example/new_file_name.jpg')</pre>
 
    POST Object
     <pre>Sorry, not including a 'post' object method as it still requires use of the old legacy access,
     Please use the 'put' object method below instead to upload files to a bucket.</pre>
 
    PUT Object
-     <pre>client.put_object('bucket_name', 'filename.jpg', :data => File.read('c:/temp/file.jpg'), :x_goog_acl => 'public-read')
-     client.upload_object('bucket_name', 'filename.jpg', :path_to_file => 'c:/temp/file.jpg')</pre>
+     <pre>client.put_object('bucket_name', 'filename.jpg', :data => File.read('c:/example/file.jpg'), :x_goog_acl => 'public-read')
+     client.upload_object('bucket_name', 'filename.jpg', :path_to_file => 'c:/example/file.jpg')</pre>
 
    HEAD Object
      <pre>client.object_head('bucket_name', 'filename.jpg')</pre>
@@ -191,4 +245,38 @@ h3. Object Requests
 
 
 
+h2. Contributions made by (and thanks to) the following people:
+
+Brian Armstrong
+Peter Graham
+ilyakatz
+karlentwistle
+
+
+h2. License
+
+MIT License
+
+Copyright (C) 2011 by Lucas Hills
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+
+
 

data/bin/deploy_gs_yml

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+##
+#   Title: google_storage
+#   Contact: https://github.com/2potatocakes/google_storage
+##
+
+require 'fileutils'
+
+##
+# The following script will generate a google_storage.yml template file in the directory
+# where the script is executed from
+#
+# Usage: deploy_gs_yml
+#
+##
+
+class GSYml
+
+  def self.deploy
+    gs_yml = File.expand_path(File.join(Dir.pwd, "google_storage.yml"))
+    if File.exists?(gs_yml)
+      puts "google_storage.yml already exists in this directory"
+    else
+      FileUtils.cp File.expand_path("../lib/generators/templates/google_storage.yml", File.dirname(__FILE__)),
+                   gs_yml
+
+      puts "Successfully generated: #{gs_yml}"
+    end
+
+  end
+
+end
+
+GSYml.deploy

data/google_storage.gemspec

@@ -12,7 +12,8 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/2potatocakes/google_storage'
   s.summary     = 'Google Storage for Developers is a RESTful service for storing and accessing your data on Google\'s infrastructure'
   s.description = 'A Ruby client library for using the new Google Storage API v2 using OAuth2.0'
-  s.files       = `git ls-files`.split("\n")
+  s.files       = %w(Rakefile README.textile google_storage.gemspec) + Dir.glob("{bin,lib}/**/*")
+  s.executables = %w(deploy_gs_yml)
   s.require_paths = ['lib']
 
   s.add_dependency('crack')

data/lib/google_storage/bucket.rb

@@ -17,7 +17,7 @@ module GoogleStorage
       resp_obj = Crack::XML.parse(resp.body)
       if resp_obj["ListAllMyBucketsResult"]
         resp_obj[:success] = true
-        resp_obj[:buckets] = resp_obj["ListAllMyBucketsResult"]["Buckets"]["Bucket"]
+        resp_obj[:buckets] = resp_obj["ListAllMyBucketsResult"]["Buckets"].nil? ? [] : resp_obj["ListAllMyBucketsResult"]["Buckets"]["Bucket"]
         resp_obj[:raw] = Crack::XML.parse(resp.body)
         resp_obj.each_key {|key| resp_obj.delete(key) unless key == :success || key == :buckets || key == :raw }
       end

data/lib/google_storage/client.rb

@@ -100,6 +100,8 @@ Example: GoogleStorage::Client.new(:config_yml => 'path to your google storage y
       @debug          = options[:debug]
       @timeout        = options[:timeout]
       @host           = options[:host] ? options[:host] : 'commondatastorage.googleapis.com'
+
+      @access_token = self.refresh_access_token(@refresh_token)["access_token"]
     end
 
 
@@ -160,5 +162,4 @@ Example: GoogleStorage::Client.new(:config_yml => 'path to your google storage y
       end
       
   end
-end
-   
+end

data/lib/google_storage/request.rb

@@ -22,7 +22,7 @@ module GoogleStorage
       headers["Content-Length"]     = (options[:data] ? options[:data].size : 0).to_s
       headers["x-goog-api-version"] = @api_version
       headers["x-goog-project-id"]  = @project_id if options[:send_goog_project_id]
-      headers["Authorization"]      = 'OAuth ' + self.refresh_access_token(@refresh_token)["access_token"]
+      headers["Authorization"]      = 'Bearer ' + @access_token
       param_string                  = params.empty? ? '' : '?' + params_to_data_string(params)
       headers["Range"]              = options[:range] if options[:range]
       headers["If-Match"]           = options[:filename] if options[:filename]
@@ -31,8 +31,16 @@ module GoogleStorage
       headers["If-Unmodified-Since"]= options[:if_modified_since] if options[:if_modified_since]
       headers["Content-MD5"]        = options[:md5] if options[:md5]
       headers["x-goog-acl"]         = options[:x_goog_acl] if options[:x_goog_acl]
+      headers["Transfer-Encoding"]  = options[:transfer_encoding] if options[:transfer_encoding]
 
-      _http_request(host, path, method, headers, param_string, options[:data])
+      request = _http_request(host, path, method, headers, param_string, options[:data])
+      if request.class == Net::HTTPUnauthorized
+        warn "Token expired, will attempt to get a new one" if @debug
+        @access_token = self.refresh_access_token(@refresh_token)["access_token"]
+        headers["Authorization"]      = 'Bearer ' + @access_token
+        request = _http_request(host, path, method, headers, param_string, options[:data])
+      end
+      request
     end
 
     private
@@ -81,4 +89,4 @@ module GoogleStorage
       "#{esc_params.join('&')}"
     end
   end
-end
+end

data/lib/google_storage/token.rb

@@ -11,8 +11,17 @@ module GoogleStorage
           'https://www.googleapis.com/auth/devstorage.full_control'
         else
           'https://www.google.com/m8/feeds/'
-      end
-      "https://accounts.google.com/o/oauth2/auth?client_id=#{@client_id}&redirect_uri=#{@redirect_uri}&scope=#{scope_url}&response_type=code"
+        end
+
+      auth_url = "https://accounts.google.com/o/oauth2/auth?"
+      auth_url += "client_id=#{@client_id}&"
+      auth_url += "redirect_uri=#{@redirect_uri}&"
+      auth_url += "scope=#{scope_url}&"
+      auth_url += "response_type=code&"
+      auth_url += "access_type=offline&"
+      auth_url += "approval_prompt=force"
+
+      return auth_url
     end
 
     def acquire_refresh_token(token, options={})

data/lib/google_storage/version.rb

@@ -1,3 +1,3 @@
 module GoogleStorage
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,92 +1,92 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: google_storage
-version: !ruby/object:Gem::Version
-  version: 0.1.2
+version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
-authors:
+authors: 
 - Lucas Hills
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-29 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-10-01 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: crack
-  requirement: &10174068 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
-  prerelease: false
-  version_requirements: *10174068
+  version_requirements: *id001
 description: A Ruby client library for using the new Google Storage API v2 using OAuth2.0
-email:
+email: 
 - lucas@lucashills.com
-executables: []
+executables: 
+- deploy_gs_yml
 extensions: []
-extra_rdoc_files:
-- README.textile
-files:
-- .gitignore
-- .yardopts
-- Gemfile
+
+extra_rdoc_files: 
 - README.textile
+files: 
 - Rakefile
-- doc/GoogleStorage.html
-- doc/GoogleStorage/Client.html
-- doc/GoogleStorage/InstallGenerator.html
-- doc/_index.html
-- doc/class_list.html
-- doc/css/common.css
-- doc/css/full_list.css
-- doc/css/style.css
-- doc/file.README.html
-- doc/file_list.html
-- doc/frames.html
-- doc/index.html
-- doc/js/app.js
-- doc/js/full_list.js
-- doc/js/jquery.js
-- doc/method_list.html
-- doc/top-level-namespace.html
-- examples/examples.rb
+- README.textile
 - google_storage.gemspec
+- bin/deploy_gs_yml
 - lib/generators/google_storage/install/install_generator.rb
 - lib/generators/templates/google_storage.rake
 - lib/generators/templates/google_storage.yml
-- lib/google_storage.rb
 - lib/google_storage/bucket.rb
 - lib/google_storage/client.rb
 - lib/google_storage/object.rb
 - lib/google_storage/request.rb
 - lib/google_storage/token.rb
 - lib/google_storage/version.rb
+- lib/google_storage.rb
 homepage: https://github.com/2potatocakes/google_storage
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
-summary: Google Storage for Developers is a RESTful service for storing and accessing
-  your data on Google's infrastructure
+summary: Google Storage for Developers is a RESTful service for storing and accessing your data on Google's infrastructure
 test_files: []
+