radosgw-s3 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6c32f6f0402f284ca0d2db932700ef45d05c8488
+  data.tar.gz: 06235b61e1ce7933c13e47d3e8f2c9628fb1b2ef
+SHA512:
+  metadata.gz: e68ff57af1d4f71b530bcc784eb143c7666a34d4fee7ec875a3b4ad5df0749461dbdc4b0aab6c2a50be5b395caad095a99175a7a4104595713997237b32cba9c
+  data.tar.gz: bba508b3da38e2b39f20e03368c042793d7154ad62194dc0ad39b7f383d0d81f3ebb9e8cef3123fd00b53b7f746487820a9864f5c1fe1c4f9fd332e092a22d83

data/.gitignore

@@ -0,0 +1,7 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+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.
+

data/README.rdoc

@@ -0,0 +1,126 @@
+= radosgw-S3
+
+This gem is used to access ceph storage and to create radosgw-admin user. 
+
+
+== Installation
+
+    gem install radosgw-s3
+
+= Ceph-radosgw user
+
+
+radosgw-admin guide to {create radosgw user}[http://docs.ceph.com/docs/master/radosgw/admin/].
+
+
+== Usage
+
+=== Initialize the service
+
+    require "radosgw-s3"
+    service = CEPH::Radosgw.new(:ipaddress => "RADOSGW_HOST_IP",
+                              :username => "RADOSGW_HOST_USERNAME",
+                              :user_password => "RADOSGW_HOST_USER_PASSWORD",
+    )
+
+
+=== create user
+
+    service.user_create("UID_NAME")
+
+It will give you the access_key and secret_key in hash format
+Eg : {"access_key"=>"8OC3R0QYPOW9TWE6M4L7", "secret_key"=>"+dDV9U+0hx7VufeFGWvF+34AC9g1IcrsIrOzLtZL"}
+
+== See also
+
+* radosgw-admin[http://docs.ceph.com/docs/master/radosgw/admin/]
+
+
+= radosgw-S3
+
+radosgw-S3 library provides access to {Ceph's radosgw storage}[http://docs.ceph.com/docs/master/radosgw/].
+
+=== Initialize the service
+
+    require "radosgw-s3"
+    service = S3::Service.new(:access_key_id => "...",
+                              :secret_access_key => "...",
+			      :host => "127.0.0.1")
+
+=== List buckets
+
+    service.buckets
+    #=> [#<S3::Bucket:first-bucket>,
+    #    #<S3::Bucket:second-bucket>]
+
+=== Find bucket
+
+    first_bucket = service.buckets.find("first-bucket")
+    #=> #<S3::Bucket:first-bucket>
+
+=== Create bucket
+
+    new_bucket = service.buckets.build("newbucketname")
+    new_bucket.save(:location => :eu)
+
+
+=== List objects in a bucket
+
+    first_bucket.objects
+    #=> [#<S3::Object:/first-bucket/lenna.png>,
+    #    #<S3::Object:/first-bucket/lenna_mini.png>]
+
+=== Find object in a bucket
+
+    object = first_bucket.objects.find("lenna.png")
+    #=> #<S3::Object:/first-bucket/lenna.png>
+
+=== Access object metadata (cached from find)
+
+    object.content_type
+    #=> "image/png"
+
+=== Access object content (downloads the object)
+
+    object.content
+    #=> "\x89PNG\r\n\x1A\n\x00\x00\x00\rIHDR\x00..."
+
+=== Delete an object
+
+    object.destroy
+    #=> true
+
+=== Create an object
+
+    new_object = bucket.objects.build("bender.png")
+    #=> #<S3::Object:/synergy-staging/bender.png>
+
+    new_object.content = open("bender.png")
+
+    new_object.save
+    #=> true
+
+Please note that new objects are created with "private" ACL by
+default.
+
+=== Fetch ACL
+
+   object = bucket.objects.find('lenna.png')
+   object.request_acl # or bucket.request_acl
+
+This will return hash with all users/groups and theirs permissions
+
+=== Modify ACL
+
+   object = bucket.objects.find("lenna.png")
+   object.copy(:key => "lenna.png", :bucket => bucket, :acl => :public_read)
+
+== See also
+
+* rubygems[http://rubygems.org/gems/radosgw-s3]
+* repository[http://github.com/megamsys/radosgw-s3]
+* {issue tracker}[http://github.com/megamsys/radosgw-s3/issues]
+
+== Copyright
+
+See LICENSE[http://github.com/megamsys/s3/raw/master/LICENSE] for details.

data/Rakefile

@@ -0,0 +1,21 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+Bundler.setup
+
+require "rake/testtask"
+require "rdoc/task"
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << "lib" << "test"
+  test.pattern = "test/**/*_test.rb"
+  test.verbose = true
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "radosgw-s3 #{S3::VERSION}"
+  rdoc.rdoc_files.include("README.rdoc")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+task :default => :test

data/lib/ceph/radosgw.rb

@@ -0,0 +1,35 @@
+require 'net/ssh'
+require 'json'
+
+module CEPH
+  class Radosgw
+
+    attr_reader :username, :ipaddress, :user_password, :uid
+
+
+    def initialize(options)
+      raise ArgumentError, "Missing :username." if !options[:username]
+      raise ArgumentError, "Missing :ipaddress." if !options[:ipaddress]
+      raise ArgumentError, "Missing :user_password." if !options[:user_password]
+
+      @username = options.fetch(:username)
+      @ipaddress = options.fetch(:ipaddress)
+      @user_password = options.fetch(:user_password)
+    end
+
+
+
+    def user_create(uid)
+	ceph_user_json = ""
+	Net::SSH.start( @ipaddress, @username, :password => @user_password ) do|ssh| 
+		ceph_user_json = ssh.exec!("sudo radosgw-admin user create --uid='#{uid}'  --display-name='radosgw demo user from s3 gem'")
+	end
+
+
+    ceph_user_hash = JSON.parse(ceph_user_json)
+    secret_hash = {"access_key" => "#{ceph_user_hash['keys'][0]['access_key']}", "secret_key" => "#{ceph_user_hash['keys'][0]['secret_key']}" }
+    secret_hash
+    end
+
+  end
+end

data/lib/radosgw-s3.rb

@@ -0,0 +1,29 @@
+require "base64"
+require "cgi"
+require "digest/md5"
+require "forwardable"
+require "net/http"
+require "net/https"
+require "openssl"
+require "rexml/document"
+require "time"
+
+require "proxies"
+require "s3/objects_extension"
+require "s3/buckets_extension"
+require "s3/parser"
+require "s3/bucket"
+require "s3/connection"
+require "s3/exceptions"
+require "s3/object"
+require "s3/request"
+require "s3/service"
+require "s3/signature"
+require "s3/version"
+
+require "ceph/radosgw"
+
+module S3
+  # Default (and only) host serving S3 stuff
+  HOST = "s3.amazonaws.com"
+end

data/lib/s3/bucket.rb

@@ -0,0 +1,217 @@
+module S3
+  class Bucket
+    include Parser
+    include Proxies
+    extend Forwardable
+
+    attr_reader :name, :service, :acl
+
+    def_instance_delegators :service, :service_request
+    private_class_method :new
+
+    # Retrieves the bucket information from the server. Raises an
+    # S3::Error exception if the bucket doesn't exist or you don't
+    # have access to it.
+    def retrieve
+      bucket_headers
+      self
+    end
+
+    # Returns location of the bucket, e.g. "EU"
+    def location(reload = false)
+      return @location if defined?(@location) and not reload
+      @location = location_constraint
+    end
+
+    # Compares the bucket with other bucket. Returns true if the names
+    # of the buckets are the same, and both have the same services
+    # (see Service equality)
+    def ==(other)
+      self.name == other.name and self.service == other.service
+    end
+
+    # Retrieves acl for bucket from the server.
+    #
+    # Return:
+    # hash: user|group => permission
+    def request_acl
+      body = bucket_request(:get, :params => "acl").body
+      parse_acl(body)
+    end
+
+    # Assigns a new ACL to the bucket. Please note that ACL is not
+    # retrieved from the server and set to "private" by default.
+    #
+    # Valid Values: :private | :public_read | :public_read_write | authenticated_read
+    #
+    # ==== Example
+    #   bucket.acl = :public_read
+    def acl=(acl)
+      @acl = acl.to_s.gsub("_","-") if acl
+    end
+
+    # Similar to retrieve, but catches S3::Error::NoSuchBucket
+    # exceptions and returns false instead. Also catch S3::Error::ForbiddenBucket
+    # and return true
+    def exists?
+      retrieve
+      true
+    rescue Error::ForbiddenBucket
+      true
+    rescue Error::NoSuchBucket
+      false
+    end
+
+    # Destroys given bucket. Raises an S3::Error::BucketNotEmpty
+    # exception if the bucket is not empty. You can destroy non-empty
+    # bucket passing true (to force destroy)
+    def destroy(force = false)
+      delete_bucket
+      true
+    rescue Error::BucketNotEmpty
+      if force
+        objects.destroy_all
+        retry
+      else
+        raise
+      end
+    end
+
+    # Saves the newly built bucket.
+    #
+    # ==== Options
+    # * <tt>:location</tt> - location of the bucket
+    #   (<tt>:eu</tt> or <tt>us</tt>)
+    # * Any other options are passed through to
+    #   Connection#request
+    def save(options = {})
+      options = {:location => options} unless options.is_a?(Hash)
+      create_bucket_configuration(options)
+      true
+    end
+
+    # Returns true if the name of the bucket can be used like +VHOST+
+    # name. If the bucket contains characters like underscore it can't
+    # be used as +VHOST+ (e.g. <tt>bucket_name.s3.amazonaws.com</tt>)
+    def vhost?
+      !service.use_ssl && service.use_vhost && "#@name.#{HOST}" =~ /\A#{URI::REGEXP::PATTERN::HOSTNAME}\Z/
+    end
+
+    # Returns host name of the bucket according (see #vhost? method)
+    def host
+      vhost? ? "#@name.#{HOST}" : "#{HOST}"
+    end
+
+    # Returns path prefix for non +VHOST+ bucket. Path prefix is used
+    # instead of +VHOST+ name, e.g. "bucket_name/"
+    def path_prefix
+      vhost? ? "" : "#@name/"
+    end
+
+    # Returns the objects in the bucket and caches the result
+    #
+    # ==== Parameters
+    # * <tt>params</tt> - additional params for <tt>list_bucket</tt>
+    #   request.
+    def objects(params = {})
+      Proxy.new(lambda { list_bucket(params) }, :owner => self, :extend => ObjectsExtension)
+    end
+
+    # Returns the object with the given key. Does not check whether the
+    # object exists. But also does not issue any HTTP requests, so it's
+    # much faster than objects.find
+    def object(key)
+      Object.send(:new, self, :key => key)
+    end
+
+    def inspect #:nodoc:
+      "#<#{self.class}:#{name}>"
+    end
+
+    def save_acl(options = {})
+      headers = {}
+      headers[:content_length] = 0
+      headers[:x_amz_acl] = options[:acl] || acl || "private"
+
+      bucket_request(:put, :headers => headers, :path => 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(params = {})
+      response = bucket_request(:get, :params => params)
+      max_keys = params[:max_keys]
+      objects_attributes = parse_list_bucket_result(response.body)
+
+      # If there are more than 1000 objects S3 truncates listing and
+      # we need to request another listing for the remaining objects.
+      while parse_is_truncated(response.body)
+        next_request_options = {:marker => URI.escape(objects_attributes.last[:key])}
+
+        if max_keys
+          break if objects_attributes.length >= max_keys
+          next_request_options[:max_keys] = max_keys - objects_attributes.length
+        end
+
+        response = bucket_request(:get, :params => params.merge(next_request_options))
+        objects_attributes += parse_list_bucket_result(response.body)
+      end
+
+      objects_attributes.map { |object_attributes| Object.send(:new, self, object_attributes) }
+    end
+
+    def bucket_headers(options = {})
+      bucket_request(:head, :params => options)
+    rescue Error::ResponseError => e
+      case e.response.code.to_i
+        when 404
+          raise Error::ResponseError.exception("NoSuchBucket").new("The specified bucket does not exist.", nil)
+        when 403
+          raise Error::ResponseError.exception("ForbiddenBucket").new("The specified bucket exist but you do not have access to it.", nil)
+        else
+          raise e
+      end
+    end
+
+    def create_bucket_configuration(options = {})
+      location = options[:location].to_s.upcase if options[: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
+
+    def name=(name)
+      raise ArgumentError.new("Invalid bucket name: #{name}") unless name_valid?(name)
+      @name = name
+    end
+
+    def bucket_request(method, options = {})
+      path = "#{path_prefix}#{options[:path]}"
+      service_request(method, options.merge(:host => host, :path => path))
+    end
+
+    def name_valid?(name)
+      name =~ /\A[a-z0-9][a-z0-9\._-]{2,254}\Z/i and name !~ /\A#{URI::REGEXP::PATTERN::IPV4ADDR}\Z/
+    end
+
+  end
+end