ponyhost 0.2.1 → 0.3.0

data/README.md

@@ -1,9 +1,55 @@
-ponyHost is a super simple way to use the Amazon AWS S3 Website feature.
+# ponyHost #
+## Description ##
 
-      $ cd your-website      
-      $ gem install ponyhost
-      $ ponyhost create foobar
-      $ ponyhost push foobar
-      $ open http://foobar.ponyho.st
+ponyHost lets you to easily create Amazon S3 website buckets,
+push files to them and make them available under a *.ponyho.st or custom domain.
+A small HTTP server is also included.
 
-Find more infos on http://ponyho.st
+## Installation ##
+
+To use ponyHost all you need to have is an Amazon S3 
+account and the [access key id and secret](https://aws-portal.amazon.com/gp/aws/developer/account/index.html?ie=UTF8&action=access-key).
+
+The installation is as simple as:
+
+      gem install ponyhost
+
+## Commands ##
+### Create ###
+
+      ponyhost create your-site
+
+  Will create the S3 bucket with a website configuration.
+  Per default index.html will be the index document and 404.html the error document.
+  
+  If the passed name doesn't include a '.' the default domain 'ponyho.st' will be used and your bucket will be named
+  'your-site.ponyho.st'.
+  
+  If you prefer to use a custom domain just pass the name accordingly.
+  
+      ponyhost create foo.yoursite.com
+      
+  You'll have to setup a DNS CNAME record for foo.yoursite.com to s3-website-us-east-1.amazonaws.com.
+  It's also possible to use a naked domain like yoursite.com. 
+  For that you have to point the @ record for yoursite.com to
+  one of the IP's that s3-website-us-east-1.amazonaws.com points to (72.21.207.127) (not so good, but works :)
+
+### Push ###
+
+  Will compare the md5 sum for each file in the current directory with the remote file and push the file if necessary.
+  Currently it won't delete files in the bucket.
+
+### Server ###
+  
+  Runs a very basic HTTP server for the current directory on http://localhost:9090
+  
+### Destroy ###
+
+  Will delete the bucket and all files on S3.
+
+## ToDo ##
+
+* Implement a autopush command
+* Implement a robust HTTP server
+* Support other availability zones
+* Delete files in bucket

data/bin/ponyhost

@@ -21,8 +21,7 @@ elsif command == "list" || (["create", "push",  "destroy", "show", "version"].in
   elsif(command == "push")
     PonyHost.push(bucketname, ".")
   elsif(command == "autopush")
-    # TODO 
-    # monitor cwd and push automatically?
+    puts "Not Yet Implemented"
   elsif(command == "destroy")
     print "Do you really wanna destroy '#{bucketname}' (type 'YES'):"
     PonyHost.destroy(bucketname) if STDIN.gets.chop == "YES"
@@ -31,30 +30,28 @@ elsif command == "list" || (["create", "push",  "destroy", "show", "version"].in
     PonyHost.list.each do |name|
       puts "http://#{name}"
     end
-  elsif(command == "show")
-    # deprecated?
-    PonyHost.show(bucketname)
   elsif(command == "version")
     puts "ponyhost version #{PonyHost::VERSION}"
     puts "created by Johannes Wagener http://johannes.wagener.cc"
   end
 else
-  puts "usage: ponyhost <command> [<sitename>]"
-  puts " "
-  puts "available commands:"
-  puts "  list                  Lists all sites/buckets from your S3 account"
-  puts "  create  [sitename]    Creates a new bucket for your site"
-  puts "  push    [sitename]    Pushes the current directory to the specified bucket/site"
-  puts "  destroy [sitename]    Removes all files and destroys the bucket"
-  puts "  server                Runs a local HTTP server for the current directory"
-#  puts "  version                Print version information"
-  puts " "
-  puts "Notes: if the sitename contains no '.' it will be suffixed with the default domain #{PonyHost::DEFAULT_DOMAIN}"
-  puts "To use your own domainname you have to set up the DNS correctly:"
-  puts "For a site under a subdomain like www.foobar.com you have to create a CNAME record for www.foobar.com to s3-website-us-east-1.amazonaws.com"
-  puts "For a site under a domain like foobar.com you have to create an A record pointing to 72.21.214.197"
-  puts "Once thats done you just have to create the site with the correct name:"
-  puts "$ ponyhost create www.foobar.com"
-  puts " "
-
+  puts <<-EOF
+  usage: ponyhost <command> [<sitename>]
+  
+  available commands:
+    list                  Lists all sites/buckets from your S3 account
+    create  [name]        Creates a new bucket for your site
+    push    [name]        Pushes the current directory to the specified bucket/site
+    destroy [name]        Removes all files and destroys the bucket
+    server                Runs a local HTTP server for the current directory
+   
+  Notes: if the name contains no '.' it will be suffixed with the default domain #{PonyHost::DEFAULT_DOMAIN}
+  To use a custom domain you have to set up the DNS correctly:
+  For a site under a subdomain like www.foobar.com you have to create a CNAME record for www.foobar.com to s3-website-us-east-1.amazonaws.com
+  For a site under a domain like foobar.com you have to create an A record pointing to 72.21.214.197
+  Once thats done you just have to create the site with the correct name:
+  $ ponyhost create www.foobar.com
+  
+  For details have a look at the README.
+  EOF
 end

data/lib/ponyhost.rb

@@ -13,8 +13,9 @@ end
 
 class PonyHost
   S3_CREDENTIAL_FILES = ["~/.ponyhost.yml"]
+  S3_CREDENTIAL_LINK = "https://aws-portal.amazon.com/gp/aws/developer/account/index.html?ie=UTF8&action=access-key"
   DEFAULT_DOMAIN = "ponyho.st"
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
   class << self 
     
 
@@ -25,8 +26,8 @@ class PonyHost
       else
         puts "AWS Credentials file '#{credential_file}' missing. We'll create one."
         puts "You'll find your Amazon AWS credentials here:"
-        puts "https://aws-portal.amazon.com/gp/aws/developer/account/index.html?ie=UTF8&action=access-key"
-        #http://aws.amazon.com/account/
+        puts S3_CREDENTIAL_LINK
+
         credentials = {}
         print "Your AWS Access Key ID: "
         credentials[:access_key_id] = STDIN.gets.chop

metadata

@@ -2,7 +2,7 @@
 name: ponyhost
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors: 
 - Johannes Wagener
@@ -24,7 +24,7 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id001
-description: ponyHost allows you to easily create S3 website buckets with a nice hostname and push files to it
+description: "    ponyHost lets you to easily create Amazon S3 website buckets,\n    push files to them and make them available under a *.ponyho.st or custom domain.\n    A small HTTP server is also included.\n"
 email: 
 - johannes@wagener.cc
 executables: 
@@ -39,8 +39,8 @@ files:
 - bin/ponyhost
 has_rdoc: true
 homepage: http://ponyho.st
-licenses: []
-
+licenses: 
+- MIT
 post_install_message: 
 rdoc_options: []
 
@@ -64,6 +64,6 @@ rubyforge_project: ponyhost
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: Create super simple S3 powered websites
+summary: Create and deploy Amazon S3 powered websites
 test_files: []