s3cmd-dsl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b8c1643ca59f650067f770ac0a6a7f2a22168dac
+  data.tar.gz: a7cf4bda02c43fc035ebdef76344dd0112cd99ea
+SHA512:
+  metadata.gz: 18c467c374dabc608af61732dc0768a6ffe2d9f4f18a5f823c09611e3384ed39aec3ba9d2ae862df64caae5f1d9787b07d666c5ca1e49b604d3eb9eac1396749
+  data.tar.gz: 38ad08f1ba8b344e84c04c20f1c7f73cfb437abfb8dc881e96c1677da1b8267e83a4744929ad723ac19e80c63307e319aca693e8f16c25fbb02e02172bfb80fc

data/lib/dsl/commands/base_commands.rb

@@ -0,0 +1,190 @@
+require_relative 'dsl_commands'
+require_relative 'string'
+
+module BaseCommands
+  include DSLCommands
+
+  class BaseDSLCommands
+    def path(path)
+      @commands[:path] = path
+      self
+    end
+    alias :path_to_s3cmd :path
+
+    def send_block_command
+      @send_block_command = if @commands.include? :path
+        @commands[:path]
+        @commands.delete(:path)
+      else
+        @path.empty? ? 's3cmd' : @path
+      end
+
+      @commands.each do |key, value|
+         @send_block_command += " #{key} '#{value}'"
+      end
+
+      @send_block_command.gsub!(/\'/, '').strip!
+      `#{@send_block_command}` if @execute
+
+      if @save
+        File.open(@save, 'w') do |file|
+          file.write(
+          <<-EOF.unindent_heredoc
+          #!/usr/bin/env bash
+          ##{@name}
+          ##{Time.now}
+          #{@send_block_command}
+          EOF
+          )
+        end
+      end
+
+      @send_block_command
+    end
+
+    def save_script(filename)
+      @save = filename
+      self
+    end
+
+    def execute
+      @execute = true
+      self
+    end
+  end
+
+  # Make bucket
+  def mb(bucket = nil) # s3://BUCKET
+    @commands[:mb] = bucket || @bucket
+    self
+  end
+  alias :create_new_bucket :mb
+  alias :make_bucket :mb
+  alias :mkdir :mb
+  alias :create_bucket :mb
+
+  # Remove bucket
+  def rb(bucket = nil) # s3://BUCKET
+    @commands[:rb] = bucket || @bucket
+    self
+  end
+  alias :remove_bucket :rb
+  alias :rmdir :rb
+  alias :delete_bucket :rb
+
+  # List objects or buckets
+  def ls(bucket = nil) # s3://BUCKET[/PREFIX]]
+    @commands[:ls] = bucket || @bucket
+    self
+  end
+  alias :list_bucket :ls
+  alias :list :ls
+
+  # List all object in all buckets
+  def la
+    @commands[:la] = ''
+    self
+  end
+  alias :list_all :la
+  alias :list_all_objects :la
+
+  # Put file into bucket (i.e. upload to S3)
+  def put(files = nil, bucket = nil) # FILE [FILE...] s3://BUCKET[/PREFIX]
+    put_files = @files || files
+    put_bucket = @bucket || bucket
+
+    @commands[:put] = "#{put_files} #{put_bucket}"
+    self
+  end
+  alias :upload :put
+
+  # Get file from bucket (i.e. download from S3)
+  def get(object = nil, files = nil) # s3://BUCKET/OBJECT LOCAL_FILE
+    get_files = @files || files
+    get_object = @bucket || object
+
+    @commands[:get] = "#{get_object} #{get_files}"
+    self
+  end
+  alias :download :get
+
+  # Delete file from bucket
+  def del(object = nil) # s3://BUCKET/OBJECT
+    @commands[:del] = @bucket || object
+    self
+  end
+  alias :delete :del
+  alias :rm :del
+  alias :delete_object :del
+  alias :delete_file :del
+  alias :remove :del
+
+  # Backup a directory tree to S3
+  # Restore a tree from S3 to local directory
+  def sync(src_object, dest_object) # LOCAL_DIR s3://BUCKET[/PREFIX] or s3://BUCKET[/PREFIX] LOCAL_DIR
+    @commands[:sync] = "#{src_object} #{dest_object}"
+    self
+  end
+  alias :sync_directory :sync
+  alias :sync_dir :sync
+  alias :synchronize :sync
+
+  # Make a copy of a file (cp) or move a file (mv).  Destination can be in the same bucket with  a  dif‐
+  # ferent name or in another bucket with the same or different name.  Adding --acl-public will make the
+  # destination object publicly accessible (see below).
+  def cp(src_bucket, dest_bucket) # s3://BUCKET1/OBJECT1 s3://BUCKET2[/OBJECT2]
+    @commands[:cp] = "#{src_bucket} #{dest_bucket}"
+    self
+  end
+  alias :copy :cp
+
+  # Make a copy of a file (cp) or move a file (mv).  Destination can be in the same bucket with  a  dif‐
+  # ferent name or in another bucket with the same or different name.  Adding --acl-public will make the
+  # destination object publicly accessible (see below).
+  def mv(src_bucket, dest_bucket) # s3://BUCKET1/OBJECT1 s3://BUCKET2[/OBJECT2]
+    @commands[:mv] = "#{src_bucket} #{dest_bucket}"
+    self
+  end
+  alias :move :mv
+
+  # Modify Access control list for Bucket or Files. Use with --acl-public or --acl-private
+  def setacl(bucket = nil) # s3://BUCKET[/OBJECT]
+    @commands[:setacl] = @bucket || bucket
+    self
+  end
+  alias :set_access_control_list :setacl
+
+  # Get various information about a Bucket or Object
+  def info(bucket = nil) # s3://BUCKET[/OBJECT]
+    @commands[:info] = @bucket || bucket
+    self
+  end
+
+  # Disk usage - amount of data stored in S3
+  def du(bucket = nil) # [s3://BUCKET[/PREFIX]]
+    @commands[:du] = @bucket || bucket
+    self
+  end
+  alias :disk_usage :du
+
+  # Enable/disable bucket access logging
+  def accesslog(bucket = nil)
+    @commands[:accesslog] = @bucket || bucket
+    self
+  end
+  alias :logging :accesslog
+
+  # Sign arbitrary string using the secret key
+  def sign(string)
+    @commands[:sign] = string
+    self
+  end
+  alias :secretkey :sign
+
+  # Fix invalid file names in a bucket
+  def fixbucket(bucket = nil)
+    @commands[:fixbucket] = @bucket || bucket
+    self
+  end
+  alias :fix :fixbucket
+end

data/lib/dsl/commands/cloudfront_commands.rb

@@ -0,0 +1,42 @@
+module CloudFrontCommands
+  # Commands for CloudFront management
+  # List CloudFront distribution points
+  def cflist
+    @commands[:cflist] = ''
+    self
+  end
+  alias :cloudfront_list :cflist
+  alias :cloudfront_ls :cflist
+  alias :cfls :cflist
+
+  # Display CloudFront distribution point parameters
+  def cfinfo(dist_id) # [cf://DIST_ID]
+    @commands[:cfinfo] = dist_id
+    self
+  end
+  alias :cloudfront_info :cfinfo
+
+  # Create CloudFront distribution point
+  def cfcreate(bucket) # s3://BUCKET
+    @commands[:cfcreate] = bucket
+    self
+  end
+  alias :cloudfront_create :cfcreate
+  alias :cloudfront_make :cfcreate
+  alias :cfmake :cfcreate
+  alias :cfmk :cfcreate
+
+  # Delete CloudFront distribution point
+  def cfdelete(dist_id) # cf://DIST_ID
+    @commands[:cfdelete] = dist_id
+    self
+  end
+  alias :cloudfront_delete :cfdelete
+
+  # Change CloudFront distribution point parameters
+  def cfmodify(dist_id) # cf://DIST_ID
+    @commands[:cfmodify] = dist_id
+    self
+  end
+  alias :cloudfront_modify :cfmodify
+end

data/lib/dsl/commands/dsl_commands.rb

@@ -0,0 +1,16 @@
+module DSLCommands
+  def bucket(bucket)
+    @bucket = bucket
+    self
+  end
+  alias :remote_bucket :bucket
+  alias :object :bucket
+  alias :remote_file :bucket
+
+  def files(*files)
+    @files = files.join(' ')
+    self
+  end
+  alias :local_files :files
+  alias :file :files
+end

data/lib/dsl/commands/string.rb

@@ -0,0 +1,5 @@
+class String
+  def unindent_heredoc
+    gsub(/^#{scan(/^\s*/).min_by{|l|l.length}}/, "")
+  end
+end

data/lib/dsl/dsl.rb

@@ -0,0 +1,13 @@
+require_relative 's3cmd'
+
+module S3Cmd
+  def s3cmd(name = nil, command = nil, execute = nil, &block)
+    s3cmd = S3CmdDSL.new(name)
+    s3cmd.send(command) if command
+    s3cmd.execute if execute == 'execute'
+    if block_given? && command.nil?
+      s3cmd.instance_eval(&block)
+    end
+    s3cmd.send_block_command
+  end
+end

data/lib/dsl/s3cmd.rb

@@ -0,0 +1,20 @@
+require_relative 'commands/base_commands'
+require_relative 'commands/cloudfront_commands'
+require_relative 'dsl'
+
+class S3CmdDSL < BaseCommands::BaseDSLCommands
+  include BaseCommands
+  include CloudFrontCommands
+
+  def initialize(name)
+    @name = name
+    @path = `which s3cmd`.strip
+    @commands = {}
+  end
+
+  def method_missing(method, *args)
+    meth = method.to_s.gsub("_", "-").gsub(/^/, "--")
+    @commands[meth] = args.join(', ')
+    self
+  end
+end

data/lib/s3cmd-dsl.rb

@@ -0,0 +1,11 @@
+  # = s3cmd-dsl - A gem providing a ruby DSL interface to s3cmd Amazon S3 client.
+  #
+  # Homepage::  http://github.com/jjuliano/s3cmd-dsl
+  # Author::    Joel Bryan Juliano
+  # Copyright:: (cc) 2013 Joel Bryan Juliano
+  # License::   MIT
+  #
+  require_relative 'version'
+
+  Dir[File.join(File.dirname(__FILE__), 'dsl/**/*.rb')].sort.reverse.each { |lib| require lib }
+

data/lib/version.rb

@@ -0,0 +1,10 @@
+module S3Cmd #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end
+

data/test/test_dsl.rb

@@ -0,0 +1,210 @@
+require_relative 'test_helper'
+class TestS3CmdDSLGeneral < Test::Unit::TestCase
+  def test_with_params
+    test_class('test_with_params') {
+      s3cmd('Test With Parameters') do
+        path 'test-s3cmd'
+        mb 's3://BUCKET'
+      end
+    }
+
+    klass = TestClass.new
+    assert_equal('test-s3cmd mb s3://BUCKET',  klass.test_with_params)
+  end
+
+  def test_without_params
+    test_class('test_without_params') {
+      s3cmd('Test Without Parameters') do
+        path 'test-s3cmd'
+        bucket 's3://BUCKET'
+        mb
+      end
+    }
+
+    klass = TestClass.new
+    assert_equal('test-s3cmd mb s3://BUCKET',  klass.test_without_params)
+  end
+
+  def test_with_keywords
+    test_class('test_with_keywords') {
+      s3cmd('Test With Keywords') do
+        path 'test-s3cmd'
+        ls 's3://BUCKET'
+        rinclude '[0-9].*.jpg'
+        exclude '*.jpg'
+      end
+    }
+
+    klass = TestClass.new
+    assert_equal('test-s3cmd ls s3://BUCKET --rinclude [0-9].*.jpg --exclude *.jpg',  klass.test_with_keywords)
+  end
+
+  def test_one_liner
+    test_class('test_one_liner') { s3cmd('Test One Liner', 'configure') }
+
+    klass = TestClass.new
+    s3cmd_path = `which s3cmd`.strip!
+    path = s3cmd_path.nil? ? 's3cmd' : s3cmd_path
+    assert_equal("#{path} --configure",  klass.test_one_liner)
+  end
+
+  def test_chaining
+    test_class('test_chaining') {
+      s3cmd('Test Chaining') { path('test-s3cmd').ls('s3://BUCKET').rinclude('[0-9].*.jpg').exclude('*.jpg') }
+    }
+
+    klass = TestClass.new
+    assert_equal('test-s3cmd ls s3://BUCKET --rinclude [0-9].*.jpg --exclude *.jpg',  klass.test_chaining)
+  end
+
+  def test_path
+    test_class('test_path') {
+      s3cmd('Test Path') { ls }
+    }
+
+    klass = TestClass.new
+    s3cmd_path = `which s3cmd`.strip!
+    path = s3cmd_path.nil? ? 's3cmd' : s3cmd_path
+    assert_equal("#{path} ls",  klass.test_path)
+  end
+
+  def test_cloudfront_methods
+    test_class('test_cloudfront_methods') {
+      s3cmd('Test CloudFront Methods') { cflist }
+    }
+
+    klass = TestClass.new
+    s3cmd_path = `which s3cmd`.strip!
+    path = s3cmd_path.nil? ? 's3cmd' : s3cmd_path
+    assert_equal("#{path} cflist",  klass.test_cloudfront_methods)
+  end
+
+  def test_files_parameter
+    test_class('test_files_parameter') {
+      filelist = ['file1', 'file2']
+      s3cmd('Test Files Parameter') do
+        path 'test-s3cmd'
+        files filelist
+        bucket 's3://BUCKET'
+        put
+      end
+    }
+
+    klass = TestClass.new
+    assert_equal("test-s3cmd put file1 file2 s3://BUCKET", klass.test_files_parameter)
+  end
+
+  COMMANDS = [:mb, :rb, :ls, :del, :setacl, :info, :du, :accesslog, :fixbucket]
+
+  # Test with Parameters
+  COMMANDS.each do |command|
+    meth = %Q{
+      def test_#{command.to_s}_with_params
+        test_class("test_#{command.to_s}_with_params") {
+          s3cmd("Test #{command.to_s} With Parameters") do
+            path 'test-s3cmd'
+            #{command.to_s} 's3://BUCKET'
+          end
+        }
+
+        klass = TestClass.new
+        assert_equal("test-s3cmd #{command.to_s} s3://BUCKET",  klass.test_#{command.to_s}_with_params)
+      end
+    }
+    eval(meth)
+  end
+
+  # Test without parameters
+  COMMANDS.each do |command|
+    meth = %Q{
+      def test_#{command.to_s}_without_params
+        test_class("test_#{command.to_s}_without_params") {
+          s3cmd("Test #{command.to_s} Without Parameters") do
+            path 'test-s3cmd'
+            bucket 's3://BUCKET'
+            #{command.to_s}
+          end
+        }
+
+        klass = TestClass.new
+        assert_equal("test-s3cmd #{command.to_s} s3://BUCKET",  klass.test_#{command.to_s}_without_params)
+      end
+    }
+    eval(meth)
+  end
+
+  # Test with parameters and passing arguments
+  COMMANDS.each do |command|
+    meth = %Q{
+      def test_#{command.to_s}_with_params_and_arguments
+        test_class("test_#{command.to_s}_with_params_and_arguments") {
+          s3cmd("Test #{command.to_s} With Parameters") do
+            path 'test-s3cmd'
+            #{command.to_s} 's3://BUCKET'
+            recursive
+            encoding 'utf-8'
+          end
+        }
+
+        klass = TestClass.new
+        assert_equal("test-s3cmd #{command.to_s} s3://BUCKET --recursive  --encoding utf-8",  klass.test_#{command.to_s}_with_params_and_arguments)
+      end
+    }
+    eval(meth)
+  end
+
+  # Test without parameters and passing arguments
+  COMMANDS.each do |command|
+    meth = %Q{
+      def test_#{command.to_s}_without_params_and_arguments
+        test_class("test_#{command.to_s}_without_params_and_arguments") {
+          s3cmd("Test #{command.to_s} Without Parameters") do
+            path 'test-s3cmd'
+            bucket 's3://BUCKET'
+            #{command.to_s}
+            recursive
+            encoding 'utf-8'
+          end
+        }
+
+        klass = TestClass.new
+        assert_equal("test-s3cmd #{command.to_s} s3://BUCKET --recursive  --encoding utf-8",  klass.test_#{command.to_s}_without_params_and_arguments)
+      end
+    }
+    eval(meth)
+  end
+
+  # Test chaining with parameters and passing arguments
+  COMMANDS.each do |command|
+    meth = %Q{
+      def test_chaining_#{command.to_s}_with_params_and_arguments
+        test_class("test_chaining_#{command.to_s}_with_params_and_arguments") {
+          s3cmd("Test #{command.to_s} With Parameters") do
+            path('test-s3cmd').#{command.to_s}('s3://BUCKET').recursive.encoding('utf-8')
+          end
+        }
+
+        klass = TestClass.new
+        assert_equal("test-s3cmd #{command.to_s} s3://BUCKET --recursive  --encoding utf-8",  klass.test_chaining_#{command.to_s}_with_params_and_arguments)
+      end
+    }
+    eval(meth)
+  end
+
+  # Test chaining without parameters and passing arguments
+  COMMANDS.each do |command|
+    meth = %Q{
+      def test_chaining_#{command.to_s}_without_params_and_arguments
+        test_class("test_chaining_#{command.to_s}_without_params_and_arguments") {
+          s3cmd("Test #{command.to_s} Without Parameters") do
+            path('test-s3cmd').bucket('s3://BUCKET').#{command.to_s}.recursive.encoding('utf-8')
+          end
+        }
+
+        klass = TestClass.new
+        assert_equal("test-s3cmd #{command.to_s} s3://BUCKET --recursive  --encoding utf-8",  klass.test_chaining_#{command.to_s}_without_params_and_arguments)
+      end
+    }
+    eval(meth)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require 'test/unit'
+Dir[File.join(File.dirname(__FILE__), '/../lib/*.rb')].sort.reverse.each { |lib| require lib }
+
+class TestClass; end
+def test_class(method_name, &block)
+  TestClass.class_eval do
+    include S3Cmd
+    define_method(method_name) do
+      self.instance_eval(&block)
+    end
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: s3cmd-dsl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joel Bryan Juliano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-10 00:00:00.000000000 Z
+dependencies: []
+description: A gem providing a ruby DSL interface to s3cmd Amazon S3 client.
+email: joelbryan.juliano@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/dsl/commands/base_commands.rb
+- lib/dsl/commands/cloudfront_commands.rb
+- lib/dsl/commands/dsl_commands.rb
+- lib/dsl/commands/string.rb
+- lib/dsl/dsl.rb
+- lib/dsl/s3cmd.rb
+- lib/s3cmd-dsl.rb
+- lib/version.rb
+- test/test_dsl.rb
+- test/test_helper.rb
+homepage: http://github.com/jjuliano/s3cmd-dsl
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: A gem providing a ruby DSL interface to s3cmd Amazon S3 client.
+test_files:
+- test/test_dsl.rb
+- test/test_helper.rb