cryptkeeper 0.2.5 → 0.2.6

data/README.rdoc

@@ -47,6 +47,17 @@ Add a new object to a bucket
     data = File.open("/Users/user/Desktop/text_file.txt", 'r')
     new_bucket.add_object("myTextFile.txt", data) # if you don't specify a content type, binary/octet-stream is used
 
+Copy an object from one bucket to another
+    # Fetch an object
+    my_object = keeper.bucket_meta_objects('adam_new_bucket3', {:prefix => 'Picture%205.png'}).first
+
+    # Copy an object to another bucket
+    my_object.copy_to 'adam_first_bucket' # copy to a different bucket and keep the path intact
+    my_object.copy_to 'adam_new_bucket', 'path_1/path_2/path_3/Picture5.png' # copy to a different bucket and path
+
+Delete an object
+    my_object.delete
+
 Delete an object
     keeper.bucket_meta_objects('adam_new_bucket3', {:prefix => 'Picture%205.png'}).first.delete
 

data/cryptkeeper.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cryptkeeper}
-  s.version = "0.2.5"
+  s.version = "0.2.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Adam Medeiros"]
-  s.date = %q{2011-02-19}
+  s.date = %q{2011-02-20}
   s.description = %q{Use cryptkeeper to talk to Google Storage}
   s.email = %q{adammede@gmail.com}
   s.extra_rdoc_files = [

data/lib/buckets.rb

@@ -2,7 +2,6 @@ require 'hpricot'
 require 'digest/md5'
 module Buckets
 
-  # Bucket stuff
   # GET Service
   # lists all of the buckets that you own
   # return an array of Bucket objects
@@ -10,16 +9,21 @@ module Buckets
     find_buckets
   end
 
+  # returns the connection object that was initialized
   def connection
     CryptKeeper::Connection.http_instance
   end
 
+  # create a bucket. Takes a Hash as it's argument
+  # {:name => 'my_new_bucket_name'}
   def create_bucket(*args)
     options = args.last
     connection.put("/", options[:name])
     find_buckets(options)
   end
 
+  # search for buckets by name
+  # {:name => 'my_bucket_name'}
   def find_buckets(*args)
     options = args.last
     name = options[:name] if options.is_a? Hash
@@ -37,7 +41,13 @@ module Buckets
   # GET Bucket
   # lists the contents of a bucket or retrieves the ACLs that are
   # applied to a bucket.
-  # return an array of BucketObjects
+  # returns an array of BucketMetaObjects
+  # takes a bucket name and hash for options.
+  # Possible keys for the hash are
+  # * :delimeter
+  # * :marker
+  # * :max_keys
+  # * :prefix
   def bucket_meta_objects(bucket_name, *args)
     options = {
         :delimeter => nil,
@@ -70,12 +80,16 @@ module Buckets
     obj_hashes.map { |obj| BucketMetaObject.new(obj) }
   end
 
+  # Utils class
   class Utils
+
+    # returns a connection instance
     def connection
       CryptKeeper::Connection.http_instance
     end
   end
 
+  # Bucket
   class Bucket < Utils
     attr_accessor :name, :created_at
 
@@ -86,14 +100,19 @@ module Buckets
       @created_at = options[:created_at]
     end
 
+    # Delete this bucket if it's empty
     def delete(options={})
       connection.delete("/", @name)
     end
 
-    def update(*args)
+    #
+    #def update(*args)
 
-    end
+    #end
 
+    # add an object to this bucket
+    # pass in a name, a File or IO object, it's content type and a hash
+    # containing additional headers (keys and values)
     def add_object(name, data, content_type='binary/octet-stream', *args)
       data.rewind
       additional_headers = {
@@ -105,6 +124,8 @@ module Buckets
     end
   end
 
+  # BucketMetaObject
+  # Contains information about an object
   class BucketMetaObject < Utils
     attr_accessor :properties,
                   :key, :last_modified, :e_tag, :size, :storage_class,
@@ -123,16 +144,26 @@ module Buckets
       @owner_display_name = @properties[:owner_display_name]
     end
 
+    # When called, returns the previously set data of the object. If the object data
+    # hasn't been set, it will go fetch it from Google Storage and set it as an instance
+    # variable to be returned next time.
     def object
       @object ||= object!
     end
 
+    # Forces retrieval of the object data from Google Storage.
     def object!
       connection.get("/#{URI.escape(@key)}", @bucket_name)
     end
 
+    # Deletes the object from the bucket.
     def delete
       connection.delete("/#{URI.escape(@key)}", @bucket_name)
     end
+
+    def copy_to(bucket_name, path=nil)
+      path = path.nil? ? "/#{URI.escape(@key)}" : "/#{URI.escape(path)}"
+      connection.put(path, bucket_name, nil, {'x-goog-copy-source' => "#{@bucket_name}/#{URI.escape(@key)}"})
+    end
   end
 end

data/lib/crypt_keeper.rb

@@ -4,7 +4,17 @@ require ck_path + '/crypt_keeper_http.rb'
 require 'uri'
 
 module CryptKeeper
-  VERSION = "0.2.5"
+  VERSION = "0.2.6"
+
+  # :title: Connection
+  # Author:: Adam R. Medeiros (AKA: ScaryThings)
+  # License:: MIT Style
+
+  # Builds the connection to Google Storage with the credentials
+  # passed in.
+
+  # For example:
+  # keeper = CryptKeeper::Connection.new({:access_key => 'your_access_key', :secret_key => 'your_secret_key'})
   class Connection
     @@http_instance = nil
     def self.http_instance

data/lib/crypt_keeper_http.rb

@@ -48,10 +48,12 @@ class CryptKeeperHttp
 
       content_md5 = ''
       content_type = ''
+      x_headers = ''
 
       if !additional_headers.empty?
         additional_headers.each do |k, v|
           req.add_field(k, v)
+          x_headers << "#{k}:#{v}\n" if k[0..5] == "x-goog"
           if type==PUT
             case k
               when 'Content-MD5'
@@ -80,7 +82,7 @@ class CryptKeeperHttp
       req.add_field('Host', "#{bucket_name}#{@address}")
       req.add_field('Date', time)
       req.add_field('Content-length', content_length)
-      sig = "#{type}\n#{content_md5}\n#{content_type}\n#{time}\n#{sig_path}"
+      sig = "#{type}\n#{content_md5}\n#{content_type}\n#{time}\n#{x_headers}#{sig_path}"
       req.add_field('Authorization', "#{@signature_id} #{@access_key}:#{signature(sig)}")
 
       res = http.request(req)

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 5
-  version: 0.2.5
+  - 6
+  version: 0.2.6
 platform: ruby
 authors: 
 - Adam Medeiros
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-19 00:00:00 -08:00
+date: 2011-02-20 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency