dears3 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 74c3e62a041513e6f02777553a05aca66865bc9e
+  data.tar.gz: 18d8a01ef03ea76d1fa403afc4d69160bac6b911
+SHA512:
+  metadata.gz: 8df8690ad22ddfd2368f7702a69e8ff045369ae0c9fb968085c01a74e982ed677dff16b0e17e37401fd64d4da5f731582c1aedf48205c5d57833a8f7ccde8da4
+  data.tar.gz: 9cef82454ec4703e74bd468285ebc69d7a4f17b34241927e1caebfb3bc3ff0debf12911902ddfc4c610eab4c17ae9fcdccdda312fbd6540cbf33b6b45e87c138

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dears3.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Simon Chaffetz
+
+MIT License
+
+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.md

@@ -0,0 +1,64 @@
+# DearS3
+
+Command line tools to mirror your current directory in an AWS bucket.
+
+## Set up
+
+**Installation**
+
+Run `gem install dears3` from the command line. Only works on *NIX systems.
+
+**AWS Credentials**
+
+This CLI will look in your home directory for a file called ".aws.json"
+that contains the JSON string of your AWS credentials.
+
+```json
+{
+  "access_key_id": "YOUR_ACCESS_KEY_ID",
+  "secret_access_key": "YOUR_SECRET_ACCESS_KEY"
+}
+```
+
+To get these credentials, log into your [AWS S3 console][s3 console], click on your name in
+the navigation menu and open "Security Credentials". See [here][credentials docs] for more details.
+
+[s3 console]: https://console.aws.amazon.com/s3
+[credentials docs]: http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html
+
+## Tasks
+
+**s3 auth**
+
+Prompts you for your AWS credentials and stores them in your home
+directory in a file called ".aws.json".
+
+**s3 upload**
+
+Uploads every file in the current directory and its subdirectories to an AWS
+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.
+
+*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.
+
+**s3 publish**
+
+Publishes the current directory as a website. Directory must already be uploaded
+to s3. Run `s3 publish --off` to roll back.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/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/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/s3

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'dears3'
+rescue LoadError
+  require 'rubygems'
+  require 'dears3'
+end
+
+DearS3::Cli::S3.start ARGV
+

data/dears3.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dears3/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dears3"
+  spec.version       = DearS3::VERSION
+  spec.authors       = ["7imon7ays"]
+  spec.homepage      = "https://github.com/7imon7ays/DearS3"
+  spec.summary       = %q{Sync an S3 bucket with your current directory.}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "aws-sdk", "~> 1.59.x"
+  spec.add_dependency "oj", "~> 2.x"
+  spec.add_dependency "thor", "~> 0.19.x"
+  spec.add_dependency "mime-types", "2.4.3"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end
+

data/lib/dears3/auth.rb

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

data/lib/dears3/cli/s3.rb

@@ -0,0 +1,39 @@
+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
+
+        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 "auth", "Save auth credentials in home directory"
+        def auth
+          s3_auth = DearS3::Auth.new
+          s3_auth.authenticate
+        end
+
+        private
+        
+        def open_connection
+          s3_auth = DearS3::Auth.new
+          s3_connection = s3_auth.connect
+          DearS3::Client.new s3_connection
+        end
+      end
+  end
+end
+

data/lib/dears3/client.rb

@@ -0,0 +1,101 @@
+require 'aws-sdk'
+require 'thor'
+require 'digest/md5'
+require 'mime/types'
+
+class DearS3::Client
+  include ::Thor::Shell
+
+  def initialize s3_connection
+    @s3 = s3_connection
+    @bucket = nil
+
+    set_bucket
+  end
+
+  def sync path
+    say "Uploading files to bucket '#{ bucket.name }'."
+    walk_and_upload path
+    say "Done syncing bucket."
+  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..."
+    bucket.configure_website do |cfg|
+      cfg.index_document_suffix = index_doc
+      cfg.error_document_key = error_doc # TODO: Make this optional
+    end
+    say "Bucket published at #{ bucket.url }."
+  end
+
+  def remove_website
+    bucket.remove_website_configuration
+    say "Removed #{ bucket.name } from the web."
+  end
+
+  private
+
+  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]
+
+    unless bucket.exists?
+      say "Creating bucket '#{ bucket.name }'"
+      s3.buckets.create(bucket.name, acl: :bucket_owner_full_control)
+    end
+  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
+  end
+
+  def upload entry
+    new_object = bucket.objects[entry]
+
+    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
+    end
+  end
+end
+

data/lib/dears3/version.rb

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

data/lib/dears3.rb

@@ -0,0 +1,17 @@
+require "dears3/version"
+
+module DearS3
+  class Auth
+  end
+
+  class Cli
+  end
+
+  class Client
+  end
+end
+
+require "dears3/auth"
+require "dears3/client"
+require "dears3/cli/s3"
+

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: dears3
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- 7imon7ays
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.59.x
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.59.x
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.x
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.x
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.x
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.x
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.4.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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:
+- s3
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/s3
+- dears3.gemspec
+- lib/dears3.rb
+- lib/dears3/auth.rb
+- lib/dears3/cli/s3.rb
+- lib/dears3/client.rb
+- lib/dears3/version.rb
+homepage: https://github.com/7imon7ays/DearS3
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Sync an S3 bucket with your current directory.
+test_files: []