multi_sync 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 15f64f882b07eb32c2ab67b3a86aebfce1c41c06
+  data.tar.gz: f35664cd52f5bf38d99156140f0c56aa1aa09e91
+SHA512:
+  metadata.gz: 40c4bfece43530dbc54002bb4b59787bfa59f28acca1085772de7f0a22c83be9577a2b30fe47943d5f25f269b865a1c6fdc3ce55ed327143d80b7414c48cea4e
+  data.tar.gz: 845d7cc8cd79ab528445f057c0957a4802d7dcf4296be83fe99b1697a2867018052cfc8c64f5b5d4d597f29aeb1ecb37bd71c905fa39d8b27c8018b10861884d

data/.document

@@ -0,0 +1,3 @@
+LICENSE.md
+README.md
+lib/**/*.rb

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+bin
+/examples/rails-4-0/public/assets/
+/examples/rails-3-2/public/assets/

data/.rubocop.yml

@@ -0,0 +1,26 @@
+AllCops:
+  Includes:
+    - Rakefile
+    - Gemfile
+  Excludes:
+    - script/**
+    - vendor/**
+    - bin/**
+    - examples/**
+    - gemfiles/**
+LineLength:
+  Enabled: false
+MethodLength:
+  Enabled: false
+ClassLength:
+  Enabled: false
+Documentation:
+  Enabled: false
+Encoding:
+  Enabled: false
+Blocks:
+  Enabled: false
+AlignParameters:
+  Enabled: false
+HashSyntax:
+  EnforcedStyle: ruby19

data/.travis.yml

@@ -0,0 +1,24 @@
+language: ruby
+cache: bundler
+bundler_args: --without development
+rvm:
+  - ruby-head
+  - jruby-head
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - rbx-19mode
+  - jruby-19mode
+# gemfile:
+#   - gemfiles/Gemfile.middleman-3.1.x
+#   - gemfiles/Gemfile.rails-3.2.x
+#   - Gemfile
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: rbx-19mode
+    - rvm: jruby-19mode
+notifications:
+  email: false

data/.yardopts

@@ -0,0 +1,6 @@
+--markup markdown
+-
+CHANGELOG.md
+CONTRIBUTING.md
+LICENSE.md
+README.md

data/CONTRIBUTING.md

@@ -0,0 +1,44 @@
+## Contributing
+In the spirit of [free software][free-sw], **everyone** is encouraged to help
+improve this project.
+
+[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code (**no patch is too small**: fix typos, add comments, clean up
+  inconsistent whitespace)
+* by refactoring code
+* by closing [issues][]
+* by reviewing patches
+
+[issues]: https://github.com/karlfreeman/multi_sync/issues
+
+## Submitting an Issue
+We use the [GitHub issue tracker][issues] to track bugs and features. Before
+submitting a bug report or feature request, check to make sure it hasn't
+already been submitted. When submitting a bug report, please include a [Gist][]
+that includes a stack trace and any details that may be necessary to reproduce
+the bug, including your gem version, Ruby version, and operating system.
+Ideally, a bug report should include a pull request with failing specs.
+
+[gist]: https://gist.github.com/
+
+## Submitting a Pull Request
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Add specs for your unimplemented feature or bug fix.
+4. Run `bundle exec rake spec`. If your specs pass, return to step 3.
+5. Implement your feature or bug fix.
+6. Run `bundle exec rake spec`. If your specs fail, return to step 5.
+7. Add, commit, and push your changes.
+8. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: http://learn.github.com/p/branching.html
+[pr]: http://help.github.com/send-pull-requests/

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'sprockets'
+gem 'celluloid', github: 'celluloid/celluloid'
+
+group :developement do
+  gem 'rubocop', github: 'bbatsov/rubocop'
+end
+
+group :test do
+  gem 'rake', '~> 10.0'
+  gem 'fakefs', '~> 0.4.3'
+  gem 'rspec'
+  gem 'timecop'
+end

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2013-2014 Karl Freeman
+
+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,134 @@
+# MultiSync
+
+:heavy_exclamation_mark: **a WIP that is functioning but just a warning, not finished yet.** :heavy_exclamation_mark:
+
+A flexible synchronisation library for your assets.
+
+At MultiSync's core is [Celluloid](http://celluloid.io) allowing for the synchronisation of assets to be truly parallel. Each target you define creates a pool of resources which allows for parallel execution of uploads and deletes. Meaning that when your synchronising thousands of files, you get alot more :boom: for your :dollar:.
+
+MultiSync tries to expose its asset synchronisation in a flexible way, allowing for it to be used in `Rails`, `Sinatra (WIP)`, `Rake (WIP)` and `Plain old ruby` as well as extensions for `Middleman (WIP)`, `Nanoc (WIP)` and others. Listed below are examples of how to get setup.
+
+## Installation
+
+```ruby
+gem 'multi_sync', '~> 0.0.1'
+```
+
+```ruby
+require 'multi_sync'
+
+MultiSync.configuration do |config|
+  # config.verbose = false  # turn on verbose logging (defaults to false)
+  # config.force = false  # force syncing of outdated_files (defaults to false)
+  # config.run_on_build = true # when within a framework which `builds` assets, whether to sync afterwards (defaults to true)
+  # config.sync_outdated_files = true # when an outdated file is found whether to replace it (defaults to true)
+  # config.delete_abandoned_files = true # when an abondoned file is found whether to remove it (defaults to true)
+  # config.upload_missing_files = true # when a missing file is found whether to upload it (defaults to true)
+  # config.target_pool_size = 8 # how many threads you would like to open for each target (defaults to the amount of CPU core's your machine has)
+  # config.max_sync_attempts = 1 # how many times a file should be retried if there was an error during sync (defaults to 3)
+end
+```
+
+### Fog credentials support
+
+`MultiSync` supports utilising [Fog Credentials](http://fog.io/about/getting_started.html#credentials). Simply specify either a `FOG_RC` or `.fog` and we'll use it as the base for any credentials used in a target.
+
+## Features / Usage Examples
+
+### AssetSync compatibility
+
+Many people use [AssetSync](https://github.com/rumblelabs/asset_sync) and for `MultiSync`'s first release compatibility with it has been built in. When within a `Rails` environment `MultiSync` will check for `asset_sync.yml` and read in its settings. You should be able to simply require `multi_sync` and try things out.
+
+#### Unsupported features
+
+- `AssetSync`'s environment variables
+- `AssetSync`'s gzip_compression hack
+
+### Rails
+
+`MultiSync` prefers ruby backed configuration instead of `YAML` so you'll need to create an initializer `/config/initializers/multi_sync` for `MultiSync`.
+
+```ruby
+MultiSync.prepare do
+
+  source :public, {
+    type: :manifest, # load files from a Sprockets based manifest
+    source_dir: '/path_to_your_build_folder',
+    targets: [:assets] # an array of target names that this source should sync against
+  }
+
+  target :assets, {
+    type: :aws, # :aws is the target's type, current options are :aws
+    target_dir: 'your_aws_bucket',
+    destination_dir: 'an_optional_directory_inside_your_aws_bucket',
+    credentials: {
+      region: 'us-east-1',
+      aws_access_key_id: 'super_secret',
+      aws_secret_access_key: 'super_secret'
+    }
+  }
+
+end
+```
+
+`MultiSync.prepare` simply bootstraps `MultiSync` which is then ran during `rake assets:precompile`. By having `multi_sync` included in your `Gemfile`, the rake task `rake assets:sync` will be available.
+
+### Plain Old Ruby
+
+```ruby
+MultiSync.run do
+
+  source :build, {
+    type: :local, # :local is the source's type, current options are :local, :manifest
+    source_dir: '/path_to_your_build_folder',
+    targets: [:assets] # an array of target names that this source should sync against
+  }
+
+  target :assets, {
+    type: :aws, # :aws is the target's type, current options are :aws
+    target_dir: 'your_aws_bucket',
+    destination_dir: 'an_optional_directory_inside_your_aws_bucket',
+    credentials: {
+      region: 'us-east-1',
+      aws_access_key_id: 'super_secret',
+      aws_secret_access_key: 'super_secret'
+    }
+  }
+
+end
+```
+
+## Badges
+
+[![Gem Version](http://img.shields.io/gem/v/multi_sync.svg)][gem]
+[![Build Status](http://img.shields.io/travis/karlfreeman/multi_sync.svg)][travis]
+[![Code Quality](http://img.shields.io/codeclimate/github/karlfreeman/multi_sync.svg)][codeclimate]
+[![Gittip](http://img.shields.io/gittip/karlfreeman.svg)][gittip]
+
+## Supported Storage Services
+
+Behind the scenes we're using [Fog::Storage](http://fog.io/storage) which allows us to support the most popular storage providers
+
+- [Amazon S3](http://aws.amazon.com/s3)
+- [Rackspace CloudFiles](http://www.rackspace.com/cloud/files)
+- [Google Cloud Storage](https://developers.google.com/storage)
+
+## Supported Ruby Versions
+
+This library aims to support and is [tested against][travis] the following Ruby
+implementations:
+
+- Ruby 2.1.0
+- Ruby 2.0.0
+- Ruby 1.9.3
+- [JRuby][jruby]
+- [Rubinius][rubinius]
+
+# Credits
+
+[gem]: https://rubygems.org/gems/multi_sync
+[travis]: http://travis-ci.org/karlfreeman/multi_sync
+[codeclimate]: https://codeclimate.com/github/karlfreeman/multi_sync
+[gittip]: https://www.gittip.com/karlfreeman
+[jruby]: http://www.jruby.org
+[rubinius]: http://rubini.us

data/Rakefile

@@ -0,0 +1,45 @@
+require 'bundler'
+Bundler.setup
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+desc 'Run all examples'
+RSpec::Core::RakeTask.new(:spec)
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+end
+
+begin
+  require 'rubocop/rake_task'
+  desc 'Run rubocop'
+  Rubocop::RakeTask.new(:rubocop)
+rescue LoadError
+end
+
+namespace :spec do
+
+  desc 'Run specs with middleman'
+  task :middleman do
+    ENV['BUNDLE_GEMFILE'] = 'gemfiles/middleman-3.1.x.gemfile'
+    Rake::Task['spec'].execute
+  end
+
+  desc 'Run specs with rails 3.2'
+  task :rails_3_2 do
+    ENV['BUNDLE_GEMFILE'] = 'gemfiles/rails-3.2.x.gemfile'
+    Rake::Task['spec'].execute
+  end
+
+  desc 'Run specs with rails 4.0'
+  task :rails_4_0 do
+    ENV['BUNDLE_GEMFILE'] = 'gemfiles/rails-4.0.x.gemfile'
+    Rake::Task['spec'].execute
+  end
+
+end
+
+task default: :spec
+task test: :spec

data/examples/custom.rb

@@ -0,0 +1,34 @@
+require "multi_sync"
+
+MultiSync.configuration do |config|
+  # config.verbose = false  # turn on verbose logging (defaults to false)
+  # config.force = false  # force syncing of outdated_files (defaults to false)
+  # config.run_on_build = true # when within a framework which `builds` assets, whether to sync afterwards (defaults to true)
+  # config.sync_outdated_files = true # when an outdated file is found whether to replace it (defaults to true)
+  # config.delete_abandoned_files = true # when an abondoned file is found whether to remove it (defaults to true)
+  # config.upload_missing_files = true # when a missing file is found whether to upload it (defaults to true)
+  # config.target_pool_size = 8 # how many threads you would like to open for each target (defaults to the amount of CPU core's your machine has)
+  # config.max_sync_attempts = 1 # how many times a file should be retried if there was an error during sync (defaults to 3)
+end
+
+MultiSync.run do
+
+  source :build {
+    :type => :local, # :local is the source's type, current options are :local, :manifest
+    :source_dir => "/path_to_your_build_folder",
+    :targets => [ :www ] # an array of target names that this source should sync against
+    # targets optional? default to all
+  }
+
+  target :www {
+    :type => :aws, # :aws is the target's type, current options are :aws
+    :target_dir => "your_aws_bucket",
+    :destination_dir => "an_optional_directory_inside_your_aws_bucket",
+    :credentials => {
+      :region => "us-east-1",
+      :aws_access_key_id => "super_secret",
+      :aws_secret_access_key => "super_secret"
+    }
+  }
+
+end

data/examples/rails-3-2/.gitignore

@@ -0,0 +1,15 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/examples/rails-3-2/Gemfile

@@ -0,0 +1,43 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 3.2'
+
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+gem 'sqlite3'
+
+
+# Gems used only for assets and not required
+# in production environments by default.
+group :assets do
+  gem 'sass-rails',   '~> 3.2.3'
+  gem 'coffee-rails', '~> 3.2.1'
+
+  # See https://github.com/sstephenson/execjs#readme for more supported runtimes
+  # gem 'therubyracer', :platforms => :ruby
+
+  gem 'uglifier', '>= 1.0.3'
+end
+
+gem 'jquery-rails'
+
+# To use ActiveModel has_secure_password
+# gem 'bcrypt-ruby', '~> 3.0.0'
+
+# To use Jbuilder templates for JSON
+# gem 'jbuilder'
+
+# Use unicorn as the app server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger
+# gem 'debugger'
+
+gem 'awesome_print', :require => 'awesome_print'
+gem 'celluloid', :github => 'celluloid/celluloid'
+gem 'multi_mime', :github => 'karlfreeman/multi_mime'
+gem 'multi_sync', :path => '../../'