gstore 0.1.0 → 0.2.0

data/README.textile

@@ -12,7 +12,7 @@ Visit "The Google Storage Key Manager":https://sandbox.google.com/storage/m/mana
 
 In your code just: <code>require 'gstore'</code>
 
-h2. Example
+h2. Basic Examples
 
 Create an instance of the client with your credentials:
 
@@ -50,4 +50,33 @@ client.get_object('my_unique_bucket', 'my_first_object', :outfile => 'retrieved_
 
 # Delete an object from the bucket
 client.delete_object('my_unique_bucket', 'my_first_object')
-</code></pre>
+</code></pre>
+
+h2. Advanced Examples
+
+h3. Query parameters
+
+For certain requests like <code>get_bucket('my_unique_bucket')</code> you can specify query parameters like <code>max-keys</code>, <code>prefix</code>, <code>delimiter</code> and <code>marker</code> (see "The Google Developer Guide":http://code.google.com/apis/storage/docs/developer-guide.html) for more information.
+
+Here's an example with gstore:
+
+<pre><code>client.get_bucket('my_unique_bucket', :params => {:max_keys => 2, :prefix => 'backup'})
+</code></pre>
+
+* <code>max_keys</code> is converted to <code>max-keys</code> so you can use the ruby symbol without quotes. <code>:"max-keys"</code> and <code>"max-keys"</code> also work
+
+h3. Access Control
+
+Here is how you retrieve the ACL for a bucket or object:
+
+<pre><code>client.get_bucket('my_unique_bucket', :params => {:acl => ''})
+client.get_bucket('my_unique_bucket', 'my_first_object', :params => {:acl => ''})
+</pre></code>
+
+To create a bucket or object with one of the pre-defined ACL's:
+
+<pre><code>client.create_bucket('my_public_bucket', :headers => {:x_goog_acl => 'public-read'})
+client.create_object('my_public_bucket', 'my_public_object', :headers => {:x_goog_acl => 'public-read-write'})
+</code></pre>
+
+* <code>x_goog_acl</code> is converted to <code>x-goog-acl</code> so you can use the ruby symbol without quotes. <code>:"x-goog-acl"</code> and <code>"x-goog-acl"</code> also work

data/lib/gstore.rb

@@ -1,5 +1,5 @@
 require 'gstore/client'
 
 module GStore
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/gstore/client.rb

@@ -14,26 +14,30 @@ module GStore
 
     private
       
-      def get(bucket, path, params={}, options={})
-        _http_request(Net::HTTP::Get, bucket, path, params, options)
+      def get(bucket, path, options={})
+        _http_request(Net::HTTP::Get, bucket, path, options)
       end
       
-      def put(bucket, path, params={}, options={})
-        _http_request(Net::HTTP::Put, bucket, path, params, options)
+      def put(bucket, path, options={})
+        _http_request(Net::HTTP::Put, bucket, path, options)
       end
       
-      def delete(bucket, path, params={}, options={})
-        _http_request(Net::HTTP::Delete, bucket, path, params, options)
+      def delete(bucket, path, options={})
+        _http_request(Net::HTTP::Delete, bucket, path, options)
       end
       
-      def head(bucket, path, params={}, options={})
-        _http_request(Net::HTTP::Head, bucket, path, params, options)
+      def head(bucket, path, options={})
+        _http_request(Net::HTTP::Head, bucket, path, options)
       end
       
-      def _http_request(method, bucket, path, params, options={})
+      def _http_request(method, bucket, path, options={})
         host = @host
         host = "#{bucket}.#{@host}" if bucket
-        signed_request(method, host, path, params, options)
+        params = options.delete(:params) || {}
+        headers = options.delete(:headers) || {}
+        params[:"max-keys"] = params.delete(:max_keys) if params and params[:max_keys]
+        headers[:"x-goog-acl"] = headers.delete(:x_goog_acl) if headers and headers[:x_goog_acl]
+        signed_request(method, host, path, params, headers, options)
       end
       
   end

data/lib/gstore/object.rb

@@ -1,7 +1,7 @@
 module GStore
   class Client
-    def put_object(bucket, filename, data, options={})
-      put(bucket, "/#{filename}", options, data)
+    def put_object(bucket, filename, options={})
+      put(bucket, "/#{filename}", options)
     end
     
     def get_object(bucket, filename, options={})

data/lib/gstore/request.rb

@@ -9,7 +9,7 @@ require 'cgi'
 module GStore
   class Client
     
-    def signed_request(method, host, path, params={}, options={})
+    def signed_request(method, host, path, params={}, headers={}, options={})
       
       if @debug
         puts
@@ -17,21 +17,24 @@ module GStore
         puts "***** HOST: #{host}"
         puts "***** PATH: #{path}"
         puts "***** PARAMS: #{params.inspect}"
+        puts "***** HEADERS: #{headers.inspect}"
         puts "***** OPTIONS: #{options.inspect}"
         puts
       end
       
-      headers = {
+      headers.merge!({
         :Host => host,
-        :Date => Time.now.utc.strftime('%a, %d %b %Y %H:%M:%S -0000'),
-        :"Content-Type" => 'text/plain',
+        :Date => Time.now.utc.strftime('%a, %d %b %Y %H:%M:%S -0000')
         #:"Content-MD5" => ''
-      }
+      })
+      
       if options[:data]
         headers = headers.merge(:"Content-Length" => options[:data].size)
       else
         headers = headers.merge(:"Content-Length" => 0) 
       end
+      headers[:"Content-Type"] ||= 'text/plain'
+      
       
       bucket = nil
       if host =~ /(\S+).#{@host}/
@@ -42,10 +45,16 @@ module GStore
         '' + "\n" + # Content-MD5
         headers[:"Content-Type"] + "\n" + # Content-Type
         headers[:Date] + "\n" # Date
+      headers.each do |key,value|
+        if key.to_s =~ /^x-goog/
+          canonical_headers += "#{key}:#{value}\n"
+        end
+      end
       
       canonical_resource = ""
       canonical_resource += "/#{bucket}" if bucket
       canonical_resource += path
+      canonical_resource += '?acl' if params[:acl]
       
       authorization = 'GOOG1 ' + @access_key + ':' + sign((canonical_headers + canonical_resource).toutf8)
       
@@ -71,15 +80,17 @@ module GStore
       def _http_do(method, host, path, params, headers, data=nil)
         http = Net::HTTP.new(host, 443)
         http.use_ssl = true
+        http.set_debug_output $stderr if @debug
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE 
         
         http.start do
-          req = method.new(path)
+          req = method.new(path + params)
           req.content_type = 'application/x-www-form-urlencoded'
           req['User-Agent'] = "moomerman-gstore-gem"
           headers.each do |key, value|
             req[key.to_s] = value
           end
-          
+                    
           response = http.request(req, data)
 
           return response.body
@@ -87,12 +98,13 @@ module GStore
       end
       
       def params_to_request_string(params)
+        return "" if params.empty?
         sorted_params = params.sort {|x,y| x[0].to_s <=> y[0].to_s}
         escaped_params = sorted_params.collect do |p|
           encoded = (CGI::escape(p[0].to_s) + "=" + CGI::escape(p[1].to_s))
           encoded.gsub('+', '%20')
         end
-        escaped_params.join('&')
+        "?#{escaped_params.join('&')}"
       end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gstore
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Richard Taylor
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-15 00:00:00 +01:00
+date: 2010-06-16 00:00:00 +01:00
 default_executable: 
 dependencies: []