qoobaa-stree 0.1.0 → 0.2.0

data/README.rdoc

@@ -16,28 +16,28 @@ environment variables and uses them by default, so if you don't want
 to pass them each time, export them (e.g. in .bashrc file).
 
 * list buckets
-  stree bucket
+    stree bucket
 
 * create bucket
-  stree bucket add name-of-bucket
+    stree bucket add name-of-bucket
 
 * list objects in bucket
-  stree bucket show name-of-bucket
+    stree bucket show name-of-bucket
 
 * destroy bucket
-  stree bucket remove name-of-bucket
+    stree bucket remove name-of-bucket
 
 * list objects (in all buckets)
-  stree object
+    stree object
 
 * show the object information
-  stree object show bucket_name/path/to/object.extension
+    stree object show bucket_name/path/to/object.extension
 
 * download the content of the object
-  stree object show bucket_name/path/to/object.extension filename_to_store_the_content.extension
+    stree object show bucket_name/path/to/object.extension filename_to_store_the_content.extension
 
 * show the content of the object to STDOUT
-  stree object show bucket_name/path/to/object.extension -
+    stree object show bucket_name/path/to/object.extension -
 
 You can also pass --help to the commmands like:
   stree bucket add --help

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/extra/stree_backend.rb

@@ -103,7 +103,7 @@ module Technoweenie
         # :nodoc:
         def current_data
           # Object.value full_filename, bucket_name
-          object = self.class.bucket.find(full_filename)
+          object = self.class.bucket.objects.find(full_filename)
           object.content
         end
 

data/lib/stree/bucket.rb

@@ -1,25 +1,26 @@
 module Stree
   class Bucket
+    include Parser
     extend Roxy::Moxie
     extend Forwardable
 
     attr_reader :name, :service
 
     def_instance_delegators :service, :service_request
+    private_class_method :new
 
     # Retrieves the bucket information from the server. Raises an
     # Stree::Error exception if the bucket doesn't exist or you don't
     # have access to it, etc.
     def retrieve
-      bucket_request(:get, :params => { :max_keys => 0 })
+      list_bucket(:max_keys => 0)
       self
     end
 
     # Returns location of the bucket, e.g. "EU"
     def location(reload = false)
       if reload or @location.nil?
-        response = bucket_request(:get, :params => { :location => nil })
-        @location = parse_location(response.body)
+        @location = location_constraint
       else
         @location
       end
@@ -45,7 +46,7 @@ module Stree
     # bucket is not empty. You can destroy non-empty bucket passing
     # true (to force destroy)
     def destroy(force = false)
-      bucket_request(:delete)
+      delete_bucket
       true
     rescue Error::BucketNotEmpty
       if force
@@ -59,13 +60,7 @@ module Stree
     # Saves the newly built bucket. Optionally you can pass location
     # of the bucket (:eu or :us)
     def save(location = nil)
-      location = location.to_s.upcase if location
-      options = { :headers => {} }
-      if location and location != "US"
-        options[:body] = "<CreateBucketConfiguration><LocationConstraint>#{location}</LocationConstraint></CreateBucketConfiguration>"
-        options[:headers][:content_type] = "application/xml"
-      end
-      bucket_request(:put, options)
+      create_bucket_configuration(location)
       true
     end
 
@@ -92,7 +87,7 @@ module Stree
     # reload).
     def objects(reload = false)
       if reload or @objects.nil?
-        @objects = fetch_objects
+        @objects = list_bucket
       else
         @objects
       end
@@ -102,7 +97,7 @@ module Stree
 
       # Builds the object in the bucket with given key
       def build(key)
-        Object.new(proxy_owner, key)
+        Object.send(:new, proxy_owner, :key => key)
       end
 
       # Finds first object with given name or raises the exception if
@@ -120,7 +115,7 @@ module Stree
       # +max_keys+:: The maximum number of keys you'd like to see
       # +delimiter+:: Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element
       def find_all(options = {})
-        proxy_owner.send(:fetch_objects, options)
+        proxy_owner.send(:list_bucket, options)
       end
 
       # Reloads the object list (clears the cache)
@@ -140,15 +135,40 @@ module Stree
       "#<#{self.class}:#{name}>"
     end
 
+    private
+
+    attr_writer :service
+
+    def location_constraint
+      response = bucket_request(:get, :params => { :location => nil })
+      parse_location_constraint(response.body)
+    end
+
+    def list_bucket(options = {})
+      response = bucket_request(:get, :params => options)
+      objects_attributes = parse_list_bucket_result(response.body)
+      objects_attributes.map { |object_attributes| Object.send(:new, self, object_attributes) }
+    end
+
+    def create_bucket_configuration(location = nil)
+      location = location.to_s.upcase if location
+      options = { :headers => {} }
+      if location and location != "US"
+        options[:body] = "<CreateBucketConfiguration><LocationConstraint>#{location}</LocationConstraint></CreateBucketConfiguration>"
+        options[:headers][:content_type] = "application/xml"
+      end
+      bucket_request(:put, options)
+    end
+
+    def delete_bucket
+      bucket_request(:delete)
+    end
+
     def initialize(service, name) #:nodoc:
       self.service = service
       self.name = name
     end
 
-    private
-
-    attr_writer :service
-
     def name=(name)
       raise ArgumentError.new("Invalid bucket name: #{name}") unless name_valid?(name)
       @name = name
@@ -159,32 +179,6 @@ module Stree
       service_request(method, options.merge(:host => host, :path => path))
     end
 
-    def fetch_objects(options = {})
-      response = bucket_request(:get, options)
-      parse_objects(response.body)
-    end
-
-    def parse_objects(xml_body)
-      xml = XmlSimple.xml_in(xml_body)
-      objects_attributes = xml["Contents"]
-      if objects_attributes
-        objects_attributes.map do |object_attributes|
-          Object.new(self,
-                     object_attributes["Key"].first,
-                     :etag => object_attributes["ETag"].first,
-                     :last_modified => object_attributes["LastModified"].first,
-                     :size => object_attributes["Size"].first)
-        end
-      else
-        []
-      end
-    end
-
-    def parse_location(xml_body)
-      xml = XmlSimple.xml_in(xml_body)
-      xml["content"]
-    end
-
     def name_valid?(name)
       name =~ /\A[a-z0-9][a-z0-9\._-]{2,254}\Z/ and name !~ /\A#{URI::REGEXP::PATTERN::IPV4ADDR}\Z/
     end

data/lib/stree/connection.rb

@@ -2,6 +2,8 @@ module Stree
 
   # Class responsible for handling connections to amazon hosts
   class Connection
+    include Parser
+
     attr_accessor :access_key_id, :secret_access_key, :use_ssl, :timeout, :debug
     alias :use_ssl? :use_ssl
 
@@ -185,9 +187,7 @@ module Stree
         if response.body.nil? || response.body.empty?
           raise Error::ResponseError.new(nil, response)
         else
-          xml = XmlSimple.xml_in(response.body)
-          message = xml["Message"].first
-          code = xml["Code"].first
+          code, message = parse_error(response.body)
           raise Error::ResponseError.exception(code).new(message, response)
         end
       else

data/lib/stree/object.rb

@@ -2,6 +2,7 @@ module Stree
 
   # Class responsible for handling objects stored in S3 buckets
   class Object
+    include Parser
     extend Forwardable
 
     attr_accessor :content_type, :content_disposition, :content_encoding
@@ -10,6 +11,7 @@ module Stree
 
     def_instance_delegators :bucket, :name, :service, :bucket_request, :vhost?, :host, :path_prefix
     def_instance_delegators :service, :protocol, :port
+    private_class_method :new
 
     # Compares the object with other object. Returns true if the key
     # of the objects are the same, and both have the same buckets (see
@@ -43,8 +45,7 @@ module Stree
     # NOT download the content of the object (use the content method
     # to do it).
     def retrieve
-      response = object_request(:get, :headers => { :range => 0..0 })
-      parse_headers(response)
+      get_object(:headers => { :range => 0..0 })
       self
     end
 
@@ -62,18 +63,14 @@ module Stree
     # to clear the cache and download the object again.
     def content(reload = false)
       if reload or @content.nil?
-        response = object_request(:get)
-        parse_headers(response)
-        self.content = response.body
+        get_object
       end
       @content
     end
 
     # Saves the object, returns true if successfull.
     def save
-      body = content.is_a?(IO) ? content.read : content
-      response = object_request(:put, :body => body, :headers => dump_headers)
-      parse_headers(response)
+      put_object
       true
     end
 
@@ -84,28 +81,12 @@ module Stree
     # +acl+:: acl of the copied object (default: "public-read")
     # +content_type+:: content type of the copied object (default: "application/octet-stream")
     def copy(options = {})
-      key = options[:key] || self.key
-      bucket = options[:bucket] || self.bucket
-
-      headers = {}
-      headers[:x_amz_acl] = options[:acl] || acl || "public-read"
-      headers[:content_type] = options[:content_type] || content_type || "application/octet-stream"
-      headers[:content_encoding] = options[:content_encoding] if options[:content_encoding]
-      headers[:content_disposition] = options[:content_disposition] if options[:content_disposition]
-      headers[:x_amz_copy_source] = full_key
-      headers[:x_amz_metadata_directive] = "REPLACE"
-      headers[:x_amz_copy_source_if_match] = options[:if_match] if options[:if_match]
-      headers[:x_amz_copy_source_if_none_match] = options[:if_none_match] if options[:if_none_match]
-      headers[:x_amz_copy_source_if_unmodified_since] = options[:if_modified_since] if options[:if_modified_since]
-      headers[:x_amz_copy_source_if_modified_since] = options[:if_unmodified_since] if options[:if_unmodified_since]
-
-      response = bucket.send(:bucket_request, :put, :path => key, :headers => headers)
-      self.class.parse_copied(:object => self, :bucket => bucket, :key => key, :body => response.body, :headers => headers)
+      copy_object(options)
     end
 
     # Destroys the file on the server
     def destroy
-      object_request(:delete)
+      delete_object
       true
     end
 
@@ -127,18 +108,62 @@ module Stree
       "#<#{self.class}:/#{name}/#{key}>"
     end
 
-    def initialize(bucket, key, options = {}) #:nodoc:
+    private
+
+    attr_writer :last_modified, :etag, :size, :original_key, :bucket
+
+    def copy_object(options = {})
+      key = options[:key] or raise ArgumentError, "No key given"
+      raise ArgumentError.new("Invalid key name: #{key}") unless key_valid?(key)
+      bucket = options[:bucket] || self.bucket
+
+      headers = {}
+
+      headers[:x_amz_acl] = options[:acl] || acl || "public-read"
+      headers[:content_type] = options[:content_type] || content_type || "application/octet-stream"
+      headers[:content_encoding] = options[:content_encoding] if options[:content_encoding]
+      headers[:content_disposition] = options[:content_disposition] if options[:content_disposition]
+      headers[:x_amz_copy_source] = full_key
+      headers[:x_amz_metadata_directive] = "REPLACE"
+      headers[:x_amz_copy_source_if_match] = options[:if_match] if options[:if_match]
+      headers[:x_amz_copy_source_if_none_match] = options[:if_none_match] if options[:if_none_match]
+      headers[:x_amz_copy_source_if_unmodified_since] = options[:if_modified_since] if options[:if_modified_since]
+      headers[:x_amz_copy_source_if_modified_since] = options[:if_unmodified_since] if options[:if_unmodified_since]
+
+      response = bucket.send(:bucket_request, :put, :path => key, :headers => headers)
+      object_attributes = parse_copy_object_result(response.body)
+
+      object = Object.send(:new, bucket, object_attributes.merge(:key => key, :size => size))
+      object.acl = response[:x_amz_acl]
+      object.content_type = response[:content_type]
+      object.content_encoding = response[:content_encoding]
+      object.content_disposition = response[:content_disposition]
+      object
+    end
+
+    def get_object(options = {})
+      response = object_request(:get, options)
+      parse_headers(response)
+    end
+
+    def put_object
+      body = content.is_a?(IO) ? content.read : content
+      response = object_request(:put, :body => body, :headers => dump_headers)
+      parse_headers(response)
+    end
+
+    def delete_object(options = {})
+      object_request(:delete)
+    end
+
+    def initialize(bucket, options = {})
       self.bucket = bucket
-      self.key = key
+      self.key = options[:key]
       self.last_modified = options[:last_modified]
       self.etag = options[:etag]
       self.size = options[:size]
     end
 
-    private
-
-    attr_writer :last_modified, :etag, :size, :original_key, :bucket
-
     def object_request(method, options = {})
       bucket_request(method, options.merge(:path => key))
     end
@@ -151,6 +176,14 @@ module Stree
       @etag = etag[1..-2] if etag
     end
 
+    def key_valid?(key)
+      if (key.nil? or key.empty? or key =~ %r#//#)
+        false
+      else
+        true
+      end
+    end
+
     def dump_headers
       headers = {}
       headers[:x_amz_acl] = @acl || "public-read"
@@ -160,37 +193,18 @@ module Stree
       headers
     end
 
-    def key_valid?(key)
-      if (key.nil? or key.empty? or key =~ %r#//#)
-        false
-      else
-        true
-      end
-    end
-
     def parse_headers(response)
       self.etag = response["etag"]
       self.content_type = response["content-type"]
       self.content_disposition = response["content-disposition"]
       self.content_encoding = response["content-encoding"]
       self.last_modified = response["last-modified"]
-      self.size = response["content-length"]
       if response["content-range"]
         self.size = response["content-range"].sub(/[^\/]+\//, "").to_i
+      else
+        self.size = response["content-length"]
+        self.content = response.body
       end
     end
-
-    def self.parse_copied(options)
-      xml = XmlSimple.xml_in(options[:body])
-      etag = xml["ETag"].first
-      last_modified = xml["LastModified"].first
-      size = options[:object].size
-      object = Object.new(options[:bucket], options[:key], :etag => etag, :last_modified => last_modified, :size => size)
-      object.acl = options[:headers][:x_amz_acl]
-      object.content_type = options[:headers][:content_type]
-      object.content_encoding = options[:headers][:content_encoding]
-      object.content_disposition = options[:headers][:content_disposition]
-      object
-    end
   end
 end

data/lib/stree/parser.rb

@@ -0,0 +1,48 @@
+module Stree
+  module Parser
+    include REXML
+
+    def rexml_document(xml)
+      xml.force_encoding(Encoding::UTF_8) if xml.respond_to? :force_encoding
+      Document.new(xml)
+    end
+
+    def parse_list_all_my_buckets_result(xml)
+      names = []
+      rexml_document(xml).elements.each("ListAllMyBucketsResult/Buckets/Bucket/Name") { |e| names << e.text }
+      names
+    end
+
+    def parse_location_constraint(xml)
+      rexml_document(xml).elements["LocationConstraint"].text
+    end
+
+    def parse_list_bucket_result(xml)
+      objects_attributes = []
+      rexml_document(xml).elements.each("ListBucketResult/Contents") do |e|
+        object_attributes = {}
+        object_attributes[:key] = e.elements["Key"].text
+        object_attributes[:etag] = e.elements["ETag"].text
+        object_attributes[:last_modified] = e.elements["LastModified"].text
+        object_attributes[:size] = e.elements["Size"].text
+        objects_attributes << object_attributes
+      end
+      objects_attributes
+    end
+
+    def parse_copy_object_result(xml)
+      object_attributes = {}
+      document = rexml_document(xml)
+      object_attributes[:etag] = document.elements["CopyObjectResult/ETag"].text
+      object_attributes[:last_modified] = document.elements["CopyObjectResult/LastModified"].text
+      object_attributes
+    end
+
+    def parse_error(xml)
+      document = rexml_document(xml)
+      code = document.elements["Error/Code"].text
+      message = document.elements["Error/Message"].text
+      [code, message]
+    end
+  end
+end

data/lib/stree/service.rb

@@ -1,5 +1,6 @@
 module Stree
   class Service
+    include Parser
     extend Roxy::Moxie
 
     attr_reader :access_key_id, :secret_access_key, :use_ssl
@@ -19,8 +20,8 @@ module Stree
     # +timeout+:: parameter for Net::HTTP module
     # +debug+:: prints the raw requests to STDOUT
     def initialize(options)
-      @access_key_id = options[:access_key_id] or raise ArgumentError.new("No access key id given")
-      @secret_access_key = options[:secret_access_key] or raise ArgumentError.new("No secret access key given")
+      @access_key_id = options[:access_key_id] or raise ArgumentError, "No access key id given"
+      @secret_access_key = options[:secret_access_key] or raise ArgumentError, "No secret access key given"
       @use_ssl = options[:use_ssl]
       @timeout = options[:timeout]
       @debug = options[:debug]
@@ -29,8 +30,7 @@ module Stree
     # Returns all buckets in the service and caches the result (see reload)
     def buckets(reload = false)
       if reload or @buckets.nil?
-        response = service_request(:get)
-        @buckets = parse_buckets(response.body)
+        @buckets = list_all_my_buckets
       else
         @buckets
       end
@@ -49,7 +49,7 @@ module Stree
     proxy :buckets do
       # Builds new bucket with given name
       def build(name)
-        Bucket.new(proxy_owner, name)
+        Bucket.send(:new, proxy_owner, name)
       end
 
       # Finds the bucket with given name
@@ -85,6 +85,12 @@ module Stree
 
     private
 
+    def list_all_my_buckets
+      response = service_request(:get)
+      names = parse_list_all_my_buckets_result(response.body)
+      names.map { |name| Bucket.send(:new, self, name) }
+    end
+
     def service_request(method, options = {})
       connection.request(method, options.merge(:path => "/#{options[:path]}"))
     end
@@ -100,18 +106,5 @@ module Stree
       end
       @connection
     end
-
-    def parse_buckets(xml_body)
-      xml = XmlSimple.xml_in(xml_body)
-      buckets = xml["Buckets"].first["Bucket"]
-      if buckets
-        buckets_names = buckets.map { |bucket| bucket["Name"].first }
-        buckets_names.map do |bucket_name|
-          Bucket.new(self, bucket_name)
-        end
-      else
-        []
-      end
-    end
   end
 end

data/lib/stree.rb

@@ -1,16 +1,16 @@
-require "time"
-require "openssl"
-require "net/http"
-require "net/https"
 require "base64"
-require "forwardable"
 require "digest/md5"
+require "forwardable"
+require "net/http"
+require "net/https"
+require "openssl"
+require "rexml/document"
+require "time"
 
-require "xmlsimple"
-
-require "stree/roxy/proxy"
 require "stree/roxy/moxie"
+require "stree/roxy/proxy"
 
+require "stree/parser"
 require "stree/bucket"
 require "stree/connection"
 require "stree/exceptions"

data/stree.gemspec

@@ -1,12 +1,15 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{stree}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jakub Kuźma", "Mirosław Boruta"]
-  s.date = %q{2009-07-13}
+  s.date = %q{2009-08-19}
   s.default_executable = %q{stree}
   s.email = %q{qoobaa@gmail.com}
   s.executables = ["stree"]
@@ -28,6 +31,7 @@ Gem::Specification.new do |s|
      "lib/stree/connection.rb",
      "lib/stree/exceptions.rb",
      "lib/stree/object.rb",
+     "lib/stree/parser.rb",
      "lib/stree/roxy/moxie.rb",
      "lib/stree/roxy/proxy.rb",
      "lib/stree/service.rb",
@@ -43,7 +47,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/qoobaa/stree}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.4}
+  s.rubygems_version = %q{1.3.5}
   s.summary = %q{Library for accessing S3 objects and buckets, with command line tool}
   s.test_files = [
     "test/bucket_test.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: qoobaa-stree
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - "Jakub Ku\xC5\xBAma"
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-13 00:00:00 -07:00
+date: 2009-08-19 00:00:00 -07:00
 default_executable: stree
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,6 +46,7 @@ files:
 - lib/stree/connection.rb
 - lib/stree/exceptions.rb
 - lib/stree/object.rb
+- lib/stree/parser.rb
 - lib/stree/roxy/moxie.rb
 - lib/stree/roxy/proxy.rb
 - lib/stree/service.rb
@@ -59,6 +60,7 @@ files:
 - test/test_helper.rb
 has_rdoc: false
 homepage: http://github.com/qoobaa/stree
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -79,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Library for accessing S3 objects and buckets, with command line tool