closync 0.1.0 → 0.1.1

data/Changelog.md

@@ -1,3 +1,7 @@
+## 0.1.1 (2012-10-23)
+
+* enhancement: documented programmatic usage
+
 ## 0.1.0 (2012-10-23)
 
 * new feature: files that do not appear in the origin bucket are now automatically deleted from the destination bucket

data/Gemfile

@@ -27,4 +27,9 @@ group :development, :test do
     end
 
   end
-end
+end
+
+group :development do
+  gem 'yard'
+  gem 'redcarpet'
+end

data/Guardfile

@@ -1,7 +1,7 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard 'rspec', :version => 2 do
+guard 'rspec' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://secure.travis-ci.org/wenzowski/closync.png)](http://travis-ci.org/wenzowski/closync)
+
 # Closync
 
 Synchronizes local and cloud storage.

data/closync.gemspec

@@ -6,9 +6,9 @@ Gem::Specification.new do |gem|
   gem.email         = ["alexander@wenzowski.com"]
   gem.summary       = 'A tool for synchronizing cloud storage buckets.'
   gem.description   = <<-EOF
-    Closync is a cloud storage interaction tool designed to simplify
-    synchronization between multiple filesystems. It uses the fog gem
-    to interact with both local and remote storage.
+    A tool for deploying complete HTML Apps to S3-compatible object
+    storage. Cache-Control max-age headers are set based on file type.
+    Closync uses the fog gem to interact with both local and remote storage.
   EOF
   gem.homepage      = "http://github.com/wenzowski/closync"
 

data/lib/closync/config.rb

@@ -1,6 +1,8 @@
 module Closync
   class Config
 
+    attr_accessor :working_dir
+
     # Fog config
     attr_accessor :credentials
     attr_accessor :storage
@@ -9,14 +11,14 @@ module Closync
     # Git
     attr_accessor :branch
 
-
     def initialize(opts={})
-      self.credentials    = {}
-      self.storage        = {}
-      self.cache_control  = {}
-      self.branch         = []
+      self.credentials    = ( opts[:credentials]    || {} )
+      self.storage        = ( opts[:storage]        || {} )
+      self.cache_control  = ( opts[:cache_control]  || {} )
+      self.branch         = ( opts[:branch]         || [] )
+      self.working_dir    = ( opts[:working_dir]    || Dir.pwd)
 
-      @yml_path = ( opts[:yml_path] || "#{Dir.pwd}/.closync.yml" )
+      @yml_path = ( opts[:yml_path] || "#{self.working_dir}/.closync.yml" )
 
       if self.yml_exists?
         load_yml!

data/lib/closync/storage.rb

@@ -4,15 +4,17 @@ module Closync
   class Storage
     attr_accessor :directory
 
+    ##
     # * config (<~object) Closync::Config
-    # * opts (<~dict) Options to initialize fog connection.
+    # * bucket_config (<~hash) Options to initialize fog connection.
     #   * :provider (<~string): Options are ['Local', 'AWS', 'Google', 'Rackspace']
     #   * :directory (<~string) Bucket or local directory.
-    def initialize(config, opts={})
+    def initialize(config, bucket_config={})
+      opts = bucket_config.clone
       dir = opts.delete(:directory)
       case opts[:provider]
       when 'Local'
-        opts[:local_root] = Dir.pwd
+        opts[:local_root] = config.working_dir
         @storage = Fog::Storage.new(opts)
       when 'AWS'
         opts[:aws_access_key_id] =

data/lib/closync/version.rb

@@ -1,3 +1,3 @@
 module Closync
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/closync.rb

@@ -3,6 +3,43 @@ require 'closync/config'
 require 'closync/storage'
 require 'closync/sync'
 
+##
+# The three supported object storage providers are
+# Amazon S3, Google Coloud Storage, and Rackspace Cloudfiles.
+#
+# In addition to loading configuration via yml file (see README.md), Closync
+# can also be used programmatically:
+#
+#   require 'closync'
+#
+#   config = Closync::Config.new({
+#     credentials: {
+#       # aws_access_key_id:                  ENV['AWS_ACCESS_KEY_ID'],
+#       # aws_secret_access_key:              ENV['AWS_SECRET_ACCESS_KEY'],
+#       # google_storage_access_key_id:       ENV['GOOGLE_STORAGE_ACCESS_KEY_ID'],
+#       # google_storage_secret_access_key:   ENV['GOOGLE_STORAGE_SECRET_ACCESS_KEY'],
+#       rackspace_username:                 ENV['RACKSPACE_USERNAME'],
+#       rackspace_api_key:                  ENV['RACKSPACE_API_KEY']
+#     },
+#     working_dir: '/path/from/root', # defaults to Dir.pwd
+#     storage: {
+#       local: {
+#         provider:   'Local',
+#         directory:  'relative/path' # relative to working_dir
+#       },
+#       remote: {
+#         provider:   'Rackspace',    # || 'AWS' || 'Google'
+#         directory:  'bucket_name'
+#       }
+#     },
+#     cache_control: {
+#       'default'  => (60*60*24*365),
+#       '.html'    => (60*5),
+#       '.htm'     => (60*5)
+#     }
+#   })
+#
+#   Closync::Sync.new(config).push!
 module Closync
   class << self
     def config=(data)

data/spec/lib/closync/version_spec.rb

@@ -2,5 +2,5 @@ require 'spec_helper'
 require 'closync/version'
 
 describe Closync do
-  it { Closync::VERSION.should eq('0.1.0'), "Please don't bump the version." }
+  it { Closync::VERSION.should eq('0.1.1'), "Please don't bump the version." }
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: closync
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-24 00:00:00.000000000 Z
+date: 2012-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
@@ -27,9 +27,9 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! "    Closync is a cloud storage interaction tool designed to simplify\n
-  \   synchronization between multiple filesystems. It uses the fog gem\n    to interact
-  with both local and remote storage.\n"
+description: ! "    A tool for deploying complete HTML Apps to S3-compatible object\n
+  \   storage. Cache-Control max-age headers are set based on file type.\n    Closync
+  uses the fog gem to interact with both local and remote storage.\n"
 email:
 - alexander@wenzowski.com
 executables: []
@@ -72,7 +72,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 12197200572235269
+      hash: 1824680898520444066
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 12197200572235269
+      hash: 1824680898520444066
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -96,3 +96,4 @@ test_files:
 - spec/lib/closync_spec.rb
 - spec/spec_helper.rb
 - spec/support/closync.yml
+has_rdoc: