s3file 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 glen
+
+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/README.rdoc

@@ -0,0 +1,40 @@
+= S3File
+
+Interact with your Amazon S3 bucket.
+* Move objects between S3 and your system. 
+* Create buckets.
+* Delete buckets.
+* Fix buckets.
+
+== Installation
+The gem requires you to have s3cmd a Python library for transfer of files, installed. http://s3tools.org/s3cmd.
+
+== Usage
+The gem was designed to be similar to File class in Ruby. Thus you can use ls, cp_r, cp_rf, rm etc.
+You will need to start out with setting at the minimum a 
+  :access_key and a 
+  :secret_access_key
+so..
+  require 'rubygems'
+  require 's3file'
+  S3File.new(:access_key => 'blahblah', :secret_access_key => 'blahblah')
+
+then use the code as you would normally would
+  S3File.ls("s3://bucket")
+  S3File.cp("s3://bucket/file.rb", ".")
+  S3File.cp_r("s3://bucket/files/", ".")
+  S3File.rm("s3://bucket/file.rb")
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 glen. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "s3file"
+    gem.summary = %Q{Use s3cmd to interact with Amazon's S3}
+    gem.description = %Q{Use methods similar to the File class of Ruby to interact with the S3 objects of your Amazon bucket}
+    gem.email = "glen.noronha@gmail.com"
+    gem.homepage = "http://github.com/glen/s3file"
+    gem.authors = ["glen"]
+    gem.add_development_dependency "open4", ">= 1.0.1"
+    gem.files.include %w(lib/s3file/*)
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "s3file #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/s3file/bucket.rb

@@ -0,0 +1,31 @@
+class S3File
+  class << self
+    # Makes a bucket in S3.
+    # Raises a S3PathError in case bucket specified does not start with s3://
+    def make_bucket(bucket)
+      raise(S3PathError, "Invalid S3 path") unless s3?(bucket)
+      run_command("s3cmd mb #{bucket} -c #{@@config_file}")
+    end
+
+    # Removes a bucket from S3.
+    # Raises a S3PathError in case bucket specified does not start with s3://
+    def remove_bucket(bucket)
+      raise(S3PathError, "Invalid S3 path") unless s3?(bucket)
+      run_command("s3cmd rb #{bucket} -c #{@@config_file}")
+    end
+
+    # Gets the disk usage of the bucket.
+    # Raises a S3PathError in case bucket specified does not start with s3://
+    def disk_usage(bucket)
+      raise(S3PathError, "Invalid S3 path") unless s3?(bucket)
+      run_command("s3cmd du #{bucket} -c #{@@config_file}")
+    end
+
+    # Fixes any invalid file names in the bucket.
+    # Raises S3PathError in case bucket specified does not start with s3://
+    def fix_bucket(bucket)
+      raise(S3PathError, "Invalid S3 path") unless s3?(bucket)
+      run_command("s3cmd fixbucket #{bucket} -c #{@@config_file}")
+    end
+  end
+end

data/lib/s3file/cp.rb

@@ -0,0 +1,43 @@
+class S3File
+  class << self
+    # Copy either from local to S3 or the other way around. Used for copying files and not folders.
+    # Raises a S3CommandError in case attempt to copy a folder.
+    def cp(source, destination)
+      if s3?(source)
+        raise(S3CommandError, "Attempting to copy folder using cp. Use cp_r instead.") if source.match(/\/\z/)
+        run_command("s3cmd get #{source} #{destination} -c #{@@config_file}")
+      elsif local?(source)
+        run_command("s3cmd put #{source} #{destination} -c #{@@config_file}")
+      end
+    end
+
+    # Force copy from local to S3 or the other way around. This will over write local files.
+    # Raises a S3CommandError in case attempt to copy a folder.
+    def cp_f(source, destination)
+      if s3?(source)
+        raise(S3CommandError, "Attempting to copy folder using cp. Use cp_rf instead.") if source.match(/\/\z/)
+        run_command("s3cmd get #{source} #{destination} -c #{@@config_file} --force")
+      elsif local?(source)
+        run_command("s3cmd put #{source} #{destination} -c #{@@config_file} --force")
+      end
+    end
+
+    # Recursively copy from local to S3 or the other way around. This is used for copying of folders.
+    def cp_r(source, destination)
+      if s3?(source)
+        run_command("s3cmd get #{source} #{destination} -c #{@@config_file} --recursive")
+      elsif local?(source)
+        run_command("s3cmd put #{source} #{destination} -c #{@@config_file} --recursive")
+      end
+    end
+
+    # Recursively and forcefully copy a folder between S3 and local or the other way around.
+    def cp_rf(source, destination)
+      if s3?(source)
+        run_command("s3cmd get #{source} #{destination} -c #{@@config_file} --recursive --force")
+      elsif local?(source)
+        run_command("s3cmd put #{source} #{destination} -c #{@@config_file} --recursive --force")
+      end
+    end
+  end
+end

data/lib/s3file/errors.rb

@@ -0,0 +1,25 @@
+class S3File
+
+  # Raised when no access_key and secret_access_key is provided.
+  class InitializationError < StandardError; end
+
+  # Raised in case the keys are incorrect.
+  class AuthorizationError < StandardError; end
+
+  # Raised in case there is an error in the local file path
+  class PathError < StandardError; end
+
+  # Raised in case there is an error in the S3 path.
+  class S3PathError < StandardError; end
+
+  # Raised when there is an error in the S3 command. This could happen you are trying to copy
+  # a folder instead of a file using cp rather than ch_r
+  class S3CommandError < StandardError; end
+
+  # Raised when there is no connection to S3
+  class ConnectionError < StandardError; end
+
+  # Raised for any unknowns
+  class UnknownError < StandardError; end
+  
+end

data/lib/s3file/ls.rb

@@ -0,0 +1,59 @@
+class S3File
+  class << self
+    # Gets a list of all the entries in a given directory
+    def ls(location=nil)
+      list(location, 'all')
+    end
+
+    # Gets a list of all the directories in the given location in the bucket 
+    def ls_directories(location=nil)
+      list(location, 'dir')
+    end
+
+    # Gets a list of all the files in the given location in the bucket
+    def ls_files(location=nil)
+      list(location, 'file')
+    end
+  end
+  private
+  class << self
+    # Gets a list of all the files in the given location in the bucket
+    def list(location = nil, display = nil)
+      return [] if location.nil?
+      raise(PathError, "Not S3 Path") unless s3?(location)
+      # display can take 3 possible values "all", "dir" or "file"
+      # if display is nil or any other value other than dir or file then
+      # display = "all"
+      # if display is 'dir' or 'file' then
+      # display takes that value
+      if display.nil? || !display.match(/dir|file/)
+        display = "all"
+      end
+
+      directories = []
+      files = []
+      location += "/" if location == s3_bucket(location)
+      entries = run_command("s3cmd ls #{location} -c #{@@config_file}")
+
+      directory = s3_directory(location)
+      entries.split("\n").each do |entry|
+        if display.match(/all|dir/) && entry.strip.match(/DIR/)
+          dir = entry.strip.sub(/DIR/, '').strip.sub("#{directory}", "")
+          if dir == "/"
+            directories << (location + "/")
+          else
+            directories << dir
+          end
+        elsif display.match(/all|file/) && !entry.strip.match(/DIR/)
+          file = entry.strip.sub(/\d{4}-\d{2}-\d{2}\s*\d{2}:\d{2}\s*/, '').split(" ")[1].sub("#{directory}","")
+          if file == ""
+            files << location
+          else
+            files << file
+          end
+        end
+      end
+      directories + files
+    end
+  end
+end

data/lib/s3file/mv.rb

@@ -0,0 +1,10 @@
+class S3File
+  class << self
+    # Moves a file from a bucket to another.
+    # Requires that both source and destination be s3 location - raises S3PathError otherwise.
+    def mv(source, destination)
+      raise(S3PathError, "Either source or destination (or both) not S3") unless (s3?(source) && s3?(destination))
+      run_command("s3cmd mv #{source} #{destination} -c #{@@config_file}")
+    end
+  end
+end

data/lib/s3file/rm.rb

@@ -0,0 +1,35 @@
+class S3File
+  class << self
+    # Deletes the file from S3.
+    # Raises an S3CommandError in case of directory deletion. Use s3_r instead.
+    # Raises a S3PathError in case the location provided is not S3
+    def rm(location)
+      if s3?(location)
+        raise(S3CommandError, "Attempting to delete folder using rm. Use rm_r instead.") if source.match(/\/\z/)
+        run_command("s3cmd del #{location} -c #{@@config_file}")
+      else
+        raise(S3PathError, "Incorrect S3 path")
+      end
+    end
+
+    # Recursively deletes a folder from S3
+    # Raises a S3PathError in case the location provided is not S3
+    def rm_r(location)
+      if s3?(location)
+        run_command("s3cmd del #{location} -c #{@@config_file} --recursive")
+      else
+        raise(S3PathError, "Incorrect S3 path")
+      end
+    end
+
+    # Recursively and forcefully deletes a folder from S3
+    # Raises S3PathError in case the location provided is not an S3 location 
+    def rm_rf(location)
+      if s3?(location)
+        run_command("s3cmd del #{location} -c #{@@config_file} --recursive --force")
+      else
+        raise(S3PathError, "Incorrect S3 path")
+      end
+    end
+  end
+end

data/lib/s3file.rb

@@ -0,0 +1,149 @@
+class S3File
+  require 'open4'
+  require 'ruby-debug'
+  # Require all the files in the lib/s3file
+  $:.unshift File.join(File.dirname(__FILE__),'..','lib')  
+  require 's3file/cp'
+  require 's3file/errors'
+  require 's3file/ls'
+  require 's3file/rm'
+  require 's3file/bucket'
+  require 's3file/mv'
+
+  @@config_file = File.join(File.expand_path("~/"), ".s3file.cfg")
+
+  # Intialize the object to the bucket given the access_key and secret_access_key
+  # You need to have the following set
+  # *:access_key and
+  # *:secret_access_key
+  # s3cmd requires a config file to be created.
+  # Based upon the values provided - a .s3file.cfg is created in the users home directory.
+  # If the keys are not provided - it will raise an InitializationError
+  def initialize(keys = {})
+    if keys.nil? || keys[:access_key].nil? || keys[:secret_access_key].nil?
+      raise(InitializationError, "Keys not set when initializing S3 connection")
+    end
+    S3File.create_config_file(keys)
+  end
+
+  class << self
+    # Deletes the config file that was created.
+    def delete_config_file!
+      FileUtils.rm_f(@@config_file) if S3File.config_file_exists?
+    end
+
+    # Gets the md5 hash of the s3 file. This will be used to confirm if the copy occurred
+    # successfully or not.    
+    def md5_hash(location)
+      raise(S3PathError, "Not an S3 location") unless s3?(location)
+      run_command("s3cmd --list-md5 ls #{location} -c #{@@config_file}").split(" ")[3]
+    end
+
+  end
+  
+  private
+  class << self
+    # Returns true or false if s3cmd config file exists
+    def config_file_exists?
+      File.exists?(@@config_file)
+    end
+
+    # Creates the config_file
+    def create_config_file(keys={})
+      # Data to be put into the config file
+      config_data = %Q{[default]
+    access_key = #{keys[:access_key].to_s}
+    acl_public = False
+    bucket_location = US
+    cloudfront_host = cloudfront.amazonaws.com
+    cloudfront_resource = /2008-06-30/distribution
+    default_mime_type = binary/octet-stream
+    delete_removed = False
+    dry_run = False
+    encoding = UTF-8
+    encrypt = False
+    force = False
+    get_continue = False
+    gpg_command = /usr/bin/gpg
+    gpg_decrypt = %(gpg_command)s -d --verbose --no-use-agent --batch --yes --passphrase-fd %(passphrase_fd)s -o %(output_file)s %(input_file)s
+    gpg_encrypt = %(gpg_command)s -c --verbose --no-use-agent --batch --yes --passphrase-fd %(passphrase_fd)s -o %(output_file)s %(input_file)s
+    gpg_passphrase = 
+    guess_mime_type = True
+    host_base = s3.amazonaws.com
+    host_bucket = %(bucket)s.s3.amazonaws.com
+    human_readable_sizes = False
+    list_md5 = False
+    preserve_attrs = True
+    progress_meter = True
+    proxy_host = 
+    proxy_port = 0
+    recursive = False
+    recv_chunk = 4096
+    secret_key = #{keys[:secret_access_key]}
+    send_chunk = 4096
+    simpledb_host = sdb.amazonaws.com
+    skip_existing = False
+    urlencoding_mode = normal
+    use_https = False
+    verbosity = WARNING}
+
+      File.delete(@@config_file) if File.exists?(@@config_file)
+      file = File.new(@@config_file, "w")
+      file.puts config_data
+      file.close
+    end
+
+    # Checks if the location is on s3 or not
+    # Checking if the location starts with s3://
+    def s3?(location)
+      return true if location.match(/s3:\/\//)
+      return false
+    end
+
+
+    # Checks if the location is on local or not
+    # Checking that the location does not start with s3://
+    # Short cut - use the opposite of s3? to get the solution
+    def local?(location)
+      if s3?(location)
+        return false
+      else
+        return File.exists?(File.expand_path(location))
+      end
+    end
+
+    # Gets the directory of the file given the location
+    def s3_directory(location)
+      location.sub(%r{#{location.match(/[^\/]*\z/)}\z}, "")
+    end
+
+    # Gets the s3 bucket given a location
+    def s3_bucket(location)
+      location.match("s3://[^\/]*").to_s
+    end
+
+    #
+    def run_command(command)
+      output = status = err = nil
+      status =
+              Open4::popen4(command) do |pid, stdin, stdout, stderr|
+                output = stdout.read
+                err = stderr.read
+              end
+
+      if err.empty?
+        raise(PathError, "File not found") if output.empty?
+        return output
+      else
+        puts "Error #{err}"
+        raise(AuthorizationError, "Authorization keys failed") if err.match("S3 error: 403")
+        raise(S3PathError, "S3 file does not exist") if err.match("S3 error: 404")
+        raise(S3PathError, "S3 bucket does not exist") if err.match("does not exist")
+        raise(S3PathError, "S3 bucket does not exist") if err.match("was denied")
+        raise(PathError, "Local file already exists") if err.match("already exists")
+        raise(ConnectionError, "Check your connection and try again") if err.match("Errno -2")
+        raise(UnknownError, "Unknown Error caught - #{err}")
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 's3file'
+require 's3file/errors'
+
+class Test::Unit::TestCase
+end

data/test/test_s3file.rb

@@ -0,0 +1,27 @@
+require 'helper'
+
+class TestS3file < Test::Unit::TestCase
+  def test_should_raise_InitializationError_if_no_arguments_provided
+    assert_raises S3File::InitializationError do
+      S3File.new()
+    end
+  end
+
+  def test_should_raise_InitializationError_if_access_key_not_provided
+    assert_raises S3File::InitializationError do
+      S3File.new(:secret_access_key => "blah")
+    end
+  end
+
+  def test_should_raise_InitializationError_if_secret_access_key_not_provided
+    assert_raises S3File::InitializationError do
+      S3File.new(:access_key => "blah")
+    end
+  end
+
+  def test_should_create_config_file_given_access_key_and_secret_access_key
+    S3File.delete_config_file!
+    S3File.new(:access_key => "blah", :secret_access_key => "blah")
+    assert_equal true, S3File.config_file_exists?
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: s3file
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- glen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-20 00:00:00 +05:30
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: open4
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 1
+        - 0
+        - 1
+        version: 1.0.1
+  type: :development
+  version_requirements: *id001
+description: Use methods similar to the File class of Ruby to interact with the S3 objects of your Amazon bucket
+email: glen.noronha@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/s3file.rb
+- lib/s3file/bucket.rb
+- lib/s3file/cp.rb
+- lib/s3file/errors.rb
+- lib/s3file/ls.rb
+- lib/s3file/mv.rb
+- lib/s3file/rm.rb
+- test/helper.rb
+- test/test_s3file.rb
+has_rdoc: true
+homepage: http://github.com/glen/s3file
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  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 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Use s3cmd to interact with Amazon's S3
+test_files: 
+- test/helper.rb
+- test/test_s3file.rb