dears3 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74c3e62a041513e6f02777553a05aca66865bc9e
-  data.tar.gz: 18d8a01ef03ea76d1fa403afc4d69160bac6b911
+  metadata.gz: 4744ddc0b3362fc28d2fea6baec07d58463377ca
+  data.tar.gz: 7425662978d73e2f15c08ef4a8636d7970555ab9
 SHA512:
-  metadata.gz: 8df8690ad22ddfd2368f7702a69e8ff045369ae0c9fb968085c01a74e982ed677dff16b0e17e37401fd64d4da5f731582c1aedf48205c5d57833a8f7ccde8da4
-  data.tar.gz: 9cef82454ec4703e74bd468285ebc69d7a4f17b34241927e1caebfb3bc3ff0debf12911902ddfc4c610eab4c17ae9fcdccdda312fbd6540cbf33b6b45e87c138
+  metadata.gz: 76cd5e1d5b83ca35ea38eae584358bef6ca8a8b4716f557d5c8b968cf6a8f1647d6bfed71c55c3f02c6603d1ed15ae9c43c00e90248ef964873e286837f55276
+  data.tar.gz: 10219a8b43a77c44ccd496e8a496e8540db857b38f73a73e3ac2d2f6f97e238750b9fca5b38b0a92c34a50dfbfde0057299030aaba4448a58e3400b29de4e964

data/.aws.json

@@ -0,0 +1 @@
+{"access_key_id":"AKIAIQEZRNEZX5DG2AEQ","secret_access_key":"BwDssTdj48Fe1o3KDu5VmeoyiuZJmWYlFtHEmq1j"}

data/README.md

@@ -6,7 +6,8 @@ Command line tools to mirror your current directory in an AWS bucket.
 
 **Installation**
 
-Run `gem install dears3` from the command line. Only works on *NIX systems.
+Run `gem install dears3` from the command line. Only works on *NIX systems for
+now.
 
 **AWS Credentials**
 
@@ -40,25 +41,22 @@ bucket. Any file beginning with "." is ignored. It syncs to arbitary levels of
 nesting so be careful with symlinks that could cause an infinite loop.
 
 The bucket will take the name of the current directory, replacing underscores
-with dashes. Note that the bucket's name must conform with DNS requirements if
-you plan on publishing it as a website.
+with dashes. If the bucket name is invalid or unavaiable, you will be prompted
+to specify the bucket's name.
 
 *Caution: If a bucket with that name already exists and contains files with the
-same names as the files in your directory, those files will be overriden without
-warning.*
-
-Run `s3 upload --publish` to publish your uploaded files as a website.
+same names as the files in your directory, those files will be overriden.*
 
 **s3 publish**
 
-Publishes the current directory as a website. Directory must already be uploaded
-to s3. Run `s3 publish --off` to roll back.
-
+Publishes the current directory as a website. Requires at least one file in the
+directory to be uploaded.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/dears3/fork )
+1. Fork it ( https://github.com/7imon7ays/dears3/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+

data/dears3.gemspec

@@ -23,5 +23,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "byebug"
 end
 

data/lib/dears3.rb

@@ -11,7 +11,7 @@ module DearS3
   end
 end
 
-require "dears3/auth"
+require "dears3/authentication"
 require "dears3/client"
 require "dears3/cli/s3"
 

data/lib/dears3/authentication.rb

@@ -0,0 +1,32 @@
+require 'aws-sdk'
+require 'oj'
+require 'thor'
+require 'singleton'
+
+class DearS3::Authentication
+  include Singleton
+
+  # TODO: Give option to upload once without storing credentials.
+  def connect
+    # TODO: Raise error if no credentials file available
+    ::AWS::S3.new aws_credentials
+  end
+
+  def create_credentials_file! credentials
+    File.open credentials_path, "w" do |f|
+      f.write credentials.to_json
+      f.write "\n"
+    end
+  end
+
+  private
+
+  def aws_credentials
+    ::Oj.load File.read credentials_path
+  end
+
+  def credentials_path
+    File.expand_path '~/.aws.json'
+  end
+end
+

data/lib/dears3/cli/authentication_helper.rb

@@ -0,0 +1,53 @@
+module DearS3
+  class Cli
+    class AuthenticationHelper
+      include ::Thor::Shell
+
+      def initialize authentication
+        @authentication = authentication
+      end
+
+      def connect
+        begin
+          authentication.connect
+        rescue Errno::ENOENT
+          say "Credentials file not found. Please run 's3:auth' to authenticate.", :red
+          abort
+        end
+      end
+
+      def save_credentials! credentials
+        authentication.create_credentials_file! credentials
+      end
+
+      def maybe_get_credentials
+        if File.exists?(credentials_path) && !override_credentials?
+          nil
+        else
+          request_credentials
+        end
+      end
+
+      private
+
+      attr_reader :authentication
+
+      def request_credentials
+        access_key_id = ask "Please enter your AWS access key id:"
+        secret_access_key = ask "Please enter your AWS secret access key:", echo: false
+        say
+
+        { access_key_id: access_key_id, secret_access_key: secret_access_key }
+      end
+
+      def override_credentials?
+        choice = ask("Override existing '.aws.json' file? (y/n):")
+        %w( y yes Y ok OK ).include? choice
+      end
+
+      def credentials_path
+        File.expand_path '~/.aws.json'
+      end
+    end
+  end
+end

data/lib/dears3/cli/client_helper.rb

@@ -0,0 +1,116 @@
+module DearS3
+  class Cli
+    class ClientHelper
+      include ::Thor::Shell
+
+      def initialize s3_client
+        @s3_client = s3_client
+
+        name = get_bucket_name
+
+        s3_client.set_bucket name
+      end
+
+      def upload
+        bucket_name = s3_client.bucket_name
+
+        say "Uploading files to bucket '#{ bucket_name }'."
+
+        begin
+          s3_client.walk_and_upload ".", status_proc
+        rescue ::AWS::S3::Errors::Forbidden
+          alert_access_denied
+          exit
+        end
+        say "Done syncing bucket."
+      end
+
+      def current_dir_to_bucket_name
+        File.basename(Dir.getwd).gsub('_', '-')
+      end
+
+      def publish
+        bucket_files = s3_client.files_in_bucket
+
+        if bucket_files.empty?
+          abort "Bucket is empty. Please upload at least one file before publishing"
+        end
+
+        say "Files currently in your bucket:"
+        say bucket_files.join(" | "), :green
+        index_doc = request_doc "Pick your bucket's index document:"
+        error_doc = request_doc "Pick your bucket's error document:"
+
+        say "Publishing your bucket. This may take a while..."
+        bucket_url = s3_client.configure_website index_doc, error_doc
+        say "Bucket published at #{ bucket_url }."
+      end
+
+      def unpublish
+        bucket_url = s3_client.remove_website
+        say "Removed #{ bucket_url } from the web."
+      end
+
+      private
+
+      attr_reader :s3_client
+
+      def get_bucket_name
+        bucket_name = default_bucket_name
+
+        if s3_client.validate_bucket_name(bucket_name)
+          bucket_name = ask "Please select your bucket's name:"
+        end
+
+        while error = s3_client.validate_bucket_name(bucket_name)
+          bucket_name = ask "#{ error } bucket name. Please select another:"
+        end
+
+        if s3_client.new_bucket? bucket_name
+          choice = ask "Creating new bucket '#{ bucket_name }'. Continue? (y/n/abort)" end
+
+        return get_bucket_name if %w( n no N No NO ).include? choice
+        exit if choice == "abort"
+
+        bucket_name
+      end
+
+      def default_bucket_name
+        File.basename(Dir.getwd).gsub('_', '-').downcase
+      end
+
+      def request_doc request_message
+        doc = ask request_message
+        files_in_bucket = s3_client.files_in_bucket
+
+        until files_in_bucket.include? doc
+          say "No such file in your bucket. Please choose one from this list:"
+          doc = ask files_in_bucket.join(" | ") + "\n", :green
+        end
+
+        doc
+      end
+
+      def alert_access_denied
+        say "Access denied!", :red
+        say "Make sure your credentials are correct and your bucket name isn't already taken by someone else."
+        say "Note: AWS bucket names are shared across all users."
+        say
+      end
+
+      def status_proc
+        # TODO: Confirm overriding files
+        Proc.new do |entry, status|
+          case status
+          when :unchanged
+            say "\tUnchanged: #{ entry }", :blue
+          when :update
+            say "\tUpdating: '#{ entry }'", :yellow
+          when :upload
+          say "\tUploading: '#{ entry }'", :green
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dears3/cli/s3.rb

@@ -1,39 +1,56 @@
+require 'dears3/cli/authentication_helper'
+require 'dears3/cli/client_helper'
 require 'thor'
 
 module DearS3
   class Cli
-      class S3 < Thor
-        desc "upload", "Deploy current and nested directories to S3"
-        option :publish, type: :boolean, default: false # Optionally publish to the web
-        def upload
-          s3_upload = open_connection
-
-          s3_upload.sync "."
-          s3_upload.configure_website if options[:publish]
-        end
+    class S3 < Thor
+      desc "upload", "Deploy current and nested directories to S3"
+      def upload
+        client_helper.upload
+      end
 
-        desc "publish", "Publish bucket as a website"
-        option :off, type: :boolean, default: false
-        def publish
-          s3_upload = open_connection
-          options[:off] ?
-            s3_upload.remove_website : s3_upload.configure_website
-        end
+      desc "publish", "Publish bucket as a website"
+      def publish
+        client_helper.publish
+      end
 
-        desc "auth", "Save auth credentials in home directory"
-        def auth
-          s3_auth = DearS3::Auth.new
-          s3_auth.authenticate
-        end
+      desc "unpublish", "Take bucket off the www"
+      def unpublish
+        client_helper.unpublish
+      end
 
-        private
-        
-        def open_connection
-          s3_auth = DearS3::Auth.new
-          s3_connection = s3_auth.connect
-          DearS3::Client.new s3_connection
+      desc "auth", "Save AWS credentials in home directory"
+      def auth
+        # If credentials file already exists and user doesn't
+        # choose to override, do nothing.
+        if credentials = authentication_helper.maybe_get_credentials
+          authentication_helper.save_credentials! credentials
         end
       end
+
+      private
+
+      def client_helper
+        @client_helper ||= ClientHelper.new s3_client
+      end
+      
+      def s3_client
+        @s3_client ||= DearS3::Client.instance.with s3_connection
+      end
+
+      def s3_connection
+        authentication.connect
+      end
+
+      def authentication_helper
+        @auhentication_helper ||= DearS3::Cli::AuthenticationHelper.new authentication
+      end
+      
+      def authentication
+        @authentication ||= DearS3::Authentication.instance
+      end
+    end
   end
 end
 

data/lib/dears3/client.rb

@@ -2,40 +2,81 @@ require 'aws-sdk'
 require 'thor'
 require 'digest/md5'
 require 'mime/types'
+require 'singleton'
 
 class DearS3::Client
-  include ::Thor::Shell
+  include Singleton
 
-  def initialize s3_connection
-    @s3 = s3_connection
-    @bucket = nil
+  def set_bucket name
+    self.bucket = s3.buckets[name]
+
+    if new_bucket? name
+      s3.buckets.create(bucket.name, acl: :bucket_owner_full_control)
+    end
+
+    bucket.name
+  end
+
+  def validate_bucket_name name
+    return :Invalid if invalid_bucket_name? name
+    return :Unavailable if unavailable_bucket_name? name
+
+    nil
+  end
+
+  def new_bucket? name
+    !s3.buckets[name].exists?
+  end
 
-    set_bucket
+  def bucket_name
+    bucket.name
   end
 
-  def sync path
-    say "Uploading files to bucket '#{ bucket.name }'."
-    walk_and_upload path
-    say "Done syncing bucket."
+  def with s3_connection
+    @bucket = nil
+    @s3 = s3_connection
+    self
+  end
+
+  def walk_and_upload path, status_proc = nil
+    entries = Dir.entries path
+    entries.each do |entry|
+      next if entry == File.basename(__FILE__) || entry[0] == '.' 
+      nested_entry = (path == "." ? entry : "#{ path }/#{ entry }")
+      if File.directory? nested_entry
+        walk_and_upload nested_entry, status_proc
+        next
+      else
+        upload nested_entry, status_proc
+      end
+    end
   end
 
-  def configure_website
-    files = bucket.objects.map { |obj| obj.key }
-    say "Files currently in your bucket:"
-    say files.join(" | "), :green
-    index_doc = ask "Pick your bucket's index document:"
-    error_doc = ask "Pick your bucket's error document:"
-    say "Publishing your bucket. This may take a while..."
+  def configure_website index_doc, error_doc
     bucket.configure_website do |cfg|
       cfg.index_document_suffix = index_doc
-      cfg.error_document_key = error_doc # TODO: Make this optional
+      cfg.error_document_key = error_doc
     end
-    say "Bucket published at #{ bucket.url }."
+
+    bucket.policy = generate_policy
+    # TODO: find more general pattern
+    "http://#{ bucket_name }.s3-website-us-east-1.amazonaws.com/"
+  end
+
+  def generate_policy
+    policy = AWS::S3::Policy.new
+    resources = "arn:aws:s3:::#{ bucket_name }/*"
+    policy.allow(actions: [:get_object], resources: resources, principals: :any)
+    policy
+  end
+
+  def files_in_bucket
+    @files_in_bucket ||= bucket.objects.map &:key
   end
 
   def remove_website
     bucket.remove_website_configuration
-    say "Removed #{ bucket.name } from the web."
+    bucket.url
   end
 
   private
@@ -43,59 +84,53 @@ class DearS3::Client
   attr_accessor :bucket
   attr_reader :s3
 
-  def set_bucket
-    # TODO: Optionally configure bucket name and enforce DNS requirements
-    # see https://forums.aws.amazon.com/thread.jspa?messageID=570880
-    bucket_name = File.basename(Dir.getwd).gsub '_', '-'
-    self.bucket = s3.buckets[bucket_name]
+  def upload entry, status_proc = nil
+    object = bucket.objects[entry]
 
-    unless bucket.exists?
-      say "Creating bucket '#{ bucket.name }'"
-      s3.buckets.create(bucket.name, acl: :bucket_owner_full_control)
+    if object.exists? && entry_is_unchanged?(entry, object)
+      status_proc.call entry, :unchanged
+    elsif object.exists?
+      status_proc.call entry, :update
+    else
+      status_proc.call entry, :upload
     end
+
+    content_type = ::MIME::Types.type_for(entry).to_s
+    object.write File.open entry, content_type: content_type
   end
 
-  def walk_and_upload path
-    entries = Dir.entries path
-    entries.each do |entry|
-      next if entry == File.basename(__FILE__) || entry[0] == '.' 
-      nested_entry = (path == "." ? entry : "#{ path }/#{ entry }")
-      if File.directory? nested_entry
-        walk_and_upload nested_entry
-        next
-      else
-        upload nested_entry
-      end
-    end
+  def entry_is_unchanged? entry, object
+    # Is object etag equal to the MD5 digest of the entry?
+    # Strip opening and closing "\" chars from AWS-formatted etag
+    object.etag[1..-2] == ::Digest::MD5.hexdigest(File.read entry)
   end
 
-  def upload entry
-    new_object = bucket.objects[entry]
+  def invalid_bucket_name? name
+    name.length < 3     or
+    name.length > 62    or
+    name[-1] == '-'     or
+    name.include?(".")  or
+    name.include?(";")  or
+    name.include?("-.") or
+    name.include?(".-")
+  end
+
+  def unavailable_bucket_name? name
+    # Try deleting a non-existent object
+    # If the action is forbidden, the bucket exists and is taken
+    forbidden_exceptions = [AWS::S3::Errors::AccessDenied,
+                              AWS::S3::Errors::Forbidden]
 
+    rand_key = (0...20).map { ('a'..'z').to_a[rand(26)] }.join
     begin
-      if new_object.exists?
-        # Strip opening and closing "\" chars from AWS-formatted etag
-        etag_is_same = new_object.etag[1..-2] == ::Digest::MD5.hexdigest(File.read entry)
-
-        if etag_is_same
-          say "\tUnchanged: #{ entry }", :blue
-          return
-        else
-          # TODO: Confirm overriding files
-          say "\tUpdating: '#{ entry }'", :yellow
-        end
-      else
-        say "\tUploading: '#{ entry }'", :green
-      end
-      content_type = ::MIME::Types.type_for(entry).to_s
-      new_object.write File.open entry, content_type: content_type
-    rescue ::AWS::S3::Errors::Forbidden
-      say "Access denied!", :red
-      say "Make sure your credentials are correct and your bucket name isn't already taken by someone else."
-      say "Note: AWS bucket names are shared across all users."
-      say
-      abort
+      s3.buckets[name].objects[rand_key].delete
+    rescue *forbidden_exceptions
+      return true
+    rescue AWS::S3::Errors::NoSuchBucket
+      return false
     end
+
+    false
   end
 end
 

data/lib/dears3/version.rb

@@ -1,3 +1,3 @@
 module DearS3
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/authentication_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe DearS3::Cli::S3 do
+  context "auth" do
+    let(:auth_output) do
+      capture(:stdout) { subject.auth }
+    end
+
+    it 'Confirms with the user before overriding an existing credentials file' do
+      File.any_instance.stub(exists?: true)
+      Thor::Shell::Basic.any_instance.stub(ask: 'y')
+      auth_output.should include "Override existing '.aws.json'?"
+      auth_output.should include "Please enter your AWS access key id:"
+      auth_output.should include "Please enter your AWS secret access key:"
+    end
+  end
+end
+

data/spec/client_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe DearS3::Cli::S3 do
+  context "publishing" do
+    let(:output_after_publish) { capture(:stdout) { subject.publish } }
+
+    it 'prompts user for index and error document before publishing' do
+      Thor::Shell::Basic.any_instance.stub(ask: 'foobar')
+      output_after_publish.should include "Files currently in your bucket"
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'rspec'
+require 'bundler/setup'
+require 'thor'
+
+Bundler.setup
+
+require 'dears3'
+
+#AWS.stub!
+RSpec.configure do |config|
+  def capture(stream)
+    begin
+      stream = stream.to_s
+      eval "$#{stream} = StringIO.new"
+      yield
+      result = eval("$#{stream}").string
+    ensure
+      eval("$#{stream} = #{stream.upcase}")
+    end
+
+    result
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dears3
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - 7imon7ays
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-08 00:00:00.000000000 Z
+date: 2014-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -94,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: 
 executables:
@@ -101,6 +129,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".aws.json"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -108,10 +137,15 @@ files:
 - bin/s3
 - dears3.gemspec
 - lib/dears3.rb
-- lib/dears3/auth.rb
+- lib/dears3/authentication.rb
+- lib/dears3/cli/authentication_helper.rb
+- lib/dears3/cli/client_helper.rb
 - lib/dears3/cli/s3.rb
 - lib/dears3/client.rb
 - lib/dears3/version.rb
+- spec/authentication_spec.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/7imon7ays/DearS3
 licenses:
 - MIT
@@ -136,4 +170,7 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Sync an S3 bucket with your current directory.
-test_files: []
+test_files:
+- spec/authentication_spec.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb

data/lib/dears3/auth.rb

@@ -1,64 +0,0 @@
-require 'aws-sdk'
-require 'oj'
-require 'thor'
-
-class DearS3::Auth
-  include ::Thor::Shell
-
-  def initialize
-    @credentials = {}
-  end
-
-  # TODO: Give option to upload once without storing credentials.
-  def connect
-    begin
-      return ::AWS::S3.new aws_credentials
-    rescue Errno::ENOENT
-      say "Credentials file not found. Please run 's3:auth' to authenticate.", :red
-      abort
-    end
-  end
-
-  def authenticate
-    if confirm_create_credentials_file?
-      request_credentials
-      create_credentials_file!
-    end
-  end
-
-  private
-
-  def aws_credentials
-    ::Oj.load File.read credentials_path
-  end
-
-  def create_credentials_file!
-    File.open credentials_path, "w" do |f|
-      f.write @credentials.to_json
-      f.write "\n"
-    end
-  end
-
-  def request_credentials
-    @credentials[:access_key_id] = ask "Please enter your AWS access key id:"
-    @credentials[:secret_access_key] = ask(
-      "Please enter your AWS secret access key:",
-      echo: false
-    )
-    say
-  end
-
-  def credentials_path
-    File.expand_path "~/.aws.json"
-  end
-
-  def confirm_create_credentials_file?
-    if File.exists? credentials_path
-      override = ask "Override existing '.aws.json' file? (y/n):"
-      override == "y"
-    else
-      true
-    end
-  end
-end
-