cloud_crooner 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0264cd064043ffa30c3b8e1f243c568614c33071
+  data.tar.gz: 5c5c511702a426b686d529d7e3d28b8eb219591c
+SHA512:
+  metadata.gz: b56c82ae03ac812ba2b39c778ad0f619b62a4115e346d297b7c3b1c63cbfbe01f36d2fb444a14504fed8adc3c980e15e1f717e3a7ec251e087dbb02f2acb8e9c
+  data.tar.gz: 990555fd530e9372fe0efaacdb5a5c3609e990c1148eef286f734c93b59072b6cb13f1df9ac6e00b200af5d13f005705f161e4a7eda3191b4bf7b94f2661fd83

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
+*.swp
+tags
+spec/rspec_output.txt

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--fail-fast
+--format d

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 2.0.0" > .rvmrc
+environment_id="ruby-2.0.0-p247@cloud_crooner"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.21.11 (stable)" # 1.10.1 seems like a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  for __hook in "${rvm_path:-$HOME/.rvm}/hooks/after_use"*
+  do
+    if [[ -f "${__hook}" && -x "${__hook}" && -s "${__hook}" ]]
+    then \. "${__hook}" || true
+    fi
+  done
+  unset __hook
+  if (( ${rvm_use_flag:=1} >= 2 )) # display only when forced
+  then
+    if [[ $- == *i* ]] # check for interactive shells
+    then printf "%b" "Using: \E[32m$GEM_HOME\E[0m
+" # show the user the ruby and gemset they are using in green
+    else printf "%b" "Using: $GEM_HOME
+" # don't use colors in non-interactive shells
+    fi
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 bambery
+
+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,142 @@
+# CloudCrooner
+
+Manage your Sinatra app's assets with [Sprockets](https://github.com/sstephenson/sprockets) and sync them with [Amazon S3](http://aws.amazon.com/s3/).
+
+Cloud Crooner will run a Sprockets instance and configure helpers for your views. Create a rake task to call the sync method to compile your assets and upload them to the cloud. The helpers will make sure you're pointing to the S3 assets in prod. Your assets will have appended to their names an MD5 hash of their contents which updates when your assets change, ensuring that your users will always be served the freshest assets without needing to worry about expiring caches. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cloud_crooner'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install cloud_crooner
+
+## Configuration
+
+Cloud Crooner has many configuration options which can be set in a configure block: 
+
+    CloudCrooner.configure do |config|
+      config.prefix = '/assets'
+    end
+
+`remote_enabled`  - true by default. When disabled, your assets will be served from your public folder instead of from S3. Only works in production. _Be aware that attempting to test this on your machine using rackup or thin will not work_. Rack does not serve files from `/public`. If you want to see static assets in action without messing with Rack internals, you must run [shotgun](https://github.com/rtomayko/shotgun) or something like it.
+
+`public_folder` - the public folder of your application. By default set to `/public`. If you are using a different public folder, you must set it here as well as in your application.
+
+`prefix` - the path from root where you keep your assets. By default it is `/assets`. Your compiled assets will be placed in `public_folder/prefix.` It will also be the pseudo-folder on S3 where your assets will be stored, so the paths will look something like `http://bucket-name.s3.amazonaws.com/prefix/filename`.
+
+`sprockets` - by default, this will be your Sprockets environment and it will load paths the config option `asset_paths`. 
+
+`asset_paths` - the [load paths](https://github.com/sstephenson/sprockets#the-load-path) for your Sprockets instance. By default it will add the `prefix` directory. 
+
+`manifest` - the Sprockets manifest. By default, it will be created in `public_folder/prefix`. The manifest's location is also the folder where assets will be compiled to.
+
+`assets_to_compile` - an array of the assets you would like compiled, given by their [logical Sprockets paths](https://github.com/sstephenson/sprockets#logical-paths). If Sprockets knows how to gzip your assets (it can do css and js by default), it will also gzip them. 
+
+`backups_to_keep` - the number of compiled asset backups to keep. Default is 2. When running the sync task, if an asset's content has changed, it will be recompiled. If there are already more than the set number of backups present, the oldest asset will be deleted locally, removed from the manifest, and deleted remotely.
+
+`bucket_name` - the name of your AWS S3 bucket. [See below for details.](#hooking_up )
+
+`region` - the region of your AWS S3 bucket.  [See below for details.](#hooking_up )
+ 
+`aws_access_id_key` - aws credentials. [See below for details.](#hooking_up )
+
+`aws_secret_access_key` - aws credentials. [See below for details.](#hooking_up )
+
+### No Configuration
+
+If you're keen to run everything on defaults, you will still need to run one command in order to get the helpers working: 
+
+    CloudCrooner.configure_sprockets_helpers
+
+Normally this is called at the end of the configure method.
+
+### <a id="hooking_up"></a>Hooking up with your Amazon S3 Account
+
+After you have created an S3 account, [you will will be provided with an "access key id" and a "secret access key"](https://console.aws.amazon.com/iam/home?#security_credential). You will also need your bucket name and the bucket's region. One of the ways to find the region is by going to the [S3 console](https://console.aws.amazon.com/s3/) and checking the end of the URL: it will look something like us-west-1. Cloud Crooner will look for your AWS credentials in your ENV by default. _Do not put your credentials anywhere they can be checked into source control._ I would suggest loading them into the env with your bash login scripts. The env keys that will be checked by default are:
+
+    ENV["AWS_SECRET_ACCESS_KEY"]  # the secret access key given by Amazon
+    ENV["AWS_ACCESS_KEY_ID"]      # access key id given by Amazon 
+    ENV["AWS_BUCKET_NAME"]        # the name of your bucket 
+    ENV["AWS_REGION"]             # the region of your bucket
+
+You may also set these in the Cloud Crooner config block, but please do not directly set the two Amazon credentials here.
+
+    CloudCrooner.configure do |config|
+      config.aws_secret_access_key = ENV["MY_AWS_SECRET"] 
+      config.aws_access_key_id = ENV["MY_ACCESS_KEY"]
+      config.bucket_name = "super-cool-bucket"
+      config.aws_region = "eu-west-1"
+    end
+
+## Setting Up Your App:
+
+I have thrown together a very simple application as an example. 
+
+In a file of your choosing (in this case `/config/cloud_crooner_config.rb`) run the configuration block with your desired settings. 
+
+    require 'cloud_crooner'
+
+    CloudCrooner.configure do |config|
+      config.backups_to_keep = 1
+      config.asset_paths = %w( assets/stylesheets ) # assuming this is where I put my sass files
+      config.assets_to_compile %w( main.css )  # assuming this is the file I want to compile
+    end
+
+In config.ru, require this file, and set up the following:
+
+    require './config/cloud_crooner_config.rb' # your Cloud Crooner config file
+    require './app.rb' # your app file
+
+    map '/' + CloudCrooner.prefix do
+      run CloudCrooner.sprockets
+    end
+
+    map '/' do
+      run App # your application class name
+    end
+
+To compile and upload the assets, in your rakefile:
+
+    require './config/cloud_crooner_config.rb'
+    
+    namespace :assets do
+      desc 'compile and sync assets' do
+      task :sync do
+        CloudCrooner.sync
+      end
+    end
+
+Now on the command line, run `rake assets:sync` and the following will happen:
+
+1. new or changed assets will be compiled into `public/assets` 
+2. assets will be uploaded to the S3 bucket, which is set in ENV elsewhere. If an asset has a gzipped file associated with it and the gzip is smaller than the original file, the gzip will be uploaded in its place
+3. manifest will be updated
+4. old backups locally and remotely will be deleted
+
+Running your app in development mode will serve uncompiled assets locally (from `/assets`), and running your app in production mode will serve your compiled assets from S3. If you have `remote_assets` set to `false` and are in production mode, your compiled assets will be served from `public/assets`.
+
+If you want to precompile and upload your assets every time you spin up your app, you can put the configure block directly into config.ru and after config run CloudCrooner.sync.
+
+## Notes About Sass and Sprockets
+
+If you are using sass files, you should use the [ sprockets-sass ](https://github.com/petebrowne/sprockets-sass) and [ sass ](https://github.com/nex3/sass)  gems to help Sprockets cope (sprockets-sass still necessary as of 06/30/13 for functional Sinatra @imports, email me if this changes).
+
+Specifically for Sass files, do not use the Sprockets directives - use @include. See here for more details:
+
+[Structure Your Sass Files with @import](http://pivotallabs.com/structure-your-sass-files-with-import/)
+
+You can also set any sass (or other supported processor) specific options in your config.ru:
+      Sprockets::Sass.options[:style] = :compressed
+See Sprockets for details.
+
+## Contributing
+
+If there's a feature you'd like to see, when you create an issue, please supply a valid use case. If you'd like to fix a bug or add a feature yourself, please update relevant tests before submitting a pull request. 

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/cloud_crooner.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cloud_crooner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cloud_crooner"
+  spec.version       = CloudCrooner::VERSION
+  spec.authors       = ["bambery"]
+  spec.email         = ["lwszolek@gmail.com"]
+  spec.description   = %q{Manage assets on Sinatra apps with Sprockets and S3}
+  spec.summary       = %q{Manage assets with Sprockets, precompile them into static assets, then upload them to S3}
+  spec.homepage      = "https://github.com/bambery/cloud_crooner"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sinatra"
+  spec.add_development_dependency "test-construct"
+
+  spec.add_dependency             "sprockets", "~>2.10"
+  spec.add_dependency             "fog", "~> 1.12" 
+  spec.add_dependency             "sprockets-helpers"
+end

data/lib/cloud_crooner.rb

@@ -0,0 +1,3 @@
+require "cloud_crooner/version"
+require 'cloud_crooner/storage'
+require 'cloud_crooner/cloud_crooner'

data/lib/cloud_crooner/cloud_crooner.rb

@@ -0,0 +1,212 @@
+require 'sprockets'
+require 'sprockets-helpers'
+
+module CloudCrooner
+
+  class FogSettingError < StandardError; end
+
+    VALID_AWS_REGIONS = %w(
+      us-west-2
+      us-west-1
+      eu-west-1
+      ap-southeast-1
+      ap-southeast-2
+      ap-northeast-1
+      sa-east-1
+    )
+
+  class << self
+
+    def configure(&proc)
+      yield self
+      configure_sprockets_helpers
+    end
+
+    def configure_sprockets_helpers
+      # if you're running fully on defaults, you must call this explicitly in config.ru if you want to use the helpers
+      Sprockets::Helpers.configure do |config|
+        if ENV['RACK_ENV'] == "production"
+          config.manifest = manifest
+          config.digest = true
+          config.debug = false
+          if remote_enabled?
+            config.asset_host = asset_host
+          else  
+            config.public_path = public_folder 
+          end
+        end
+        config.environment = sprockets
+        config.prefix = "/" + prefix
+      end
+    end
+
+    def storage
+      @storage ||= Storage.new
+    end
+
+    def remote_enabled?
+    # Disable this in prod if you want to serve compiled assets locally. 
+      @remote_enabled.nil? ? (@remote_enabled = true) : @remote_enabled
+    end
+
+    def remote_enabled= (val)
+      @remote_enabled = val if [ true, false ].include?(val)
+    end
+
+    def sprockets
+      if @sprockets.nil?
+        @sprockets = Sprockets::Environment.new { |env| env.logger = Logger.new($stdout) }
+        asset_paths.each {|path| @sprockets.append_path(path)}
+      end
+      return @sprockets
+    end
+    attr_writer :sprockets
+
+    def manifest
+      @manifest ||= Sprockets::Manifest.new(sprockets, File.join(public_folder, prefix))
+    end
+    attr_writer :manifest
+
+    def prefix
+      @prefix ||= 'assets'
+    end
+
+    def prefix=(val)
+      #remove any slashes at beginning or end 
+      @prefix = val.chomp('/').gsub(/^\//, "")
+    end
+
+    def public_folder
+      @public_folder ||= 'public'
+    end
+
+    def public_folder=(val)
+      #remove any slashes at beginning or end 
+      @public_folder = val.chomp('/').gsub(/^\//, "")
+    end
+
+    def assets_to_compile  
+      # list of assets to compile, given by their Sprocket's load path
+      # defaults to every file under the prefix directory
+      return @assets_to_compile if @assets_to_compile 
+      files = Dir.glob(prefix + "**/*").select {|f| File.file?(f)}
+      files.collect! { |f| f.gsub(/^#{prefix}\//, "") }
+    end
+    attr_writer :assets_to_compile
+    
+    # AWS bucket name, can be stored in ENV but can be overwritten in config block
+    # Defaults to ENV['AWS_BUCKET_NAME']
+    def bucket_name 
+      if @bucket_name
+        return @bucket_name
+      elsif !ENV.has_key?('AWS_BUCKET_NAME')
+        raise FogSettingError, "Bucket name must be set in ENV or configure block"
+      end
+      @bucket_name = ENV['AWS_BUCKET_NAME'] 
+    end
+    attr_writer :bucket_name
+
+    # Region of your AWS bucket
+    # Defaults to looking in ENV but can be overwritten in config block
+    def region
+      if @region
+        return @region
+      elsif !ENV.has_key?('AWS_REGION')
+        raise FogSettingError, "AWS Region must be set in ENV or in configure block"
+      elsif !VALID_AWS_REGIONS.include?(ENV['AWS_REGION'])
+        raise FogSettingError, "Invalid region"
+      end
+      @region = ENV['AWS_REGION']
+    end
+
+    def region=(val)
+      VALID_AWS_REGIONS.include?(val) ? @region = val : (raise FogSettingError, "Invalid region") 
+    end
+
+    # AWS access id key given by Amazon, should be stored in 
+    # env but can be set to be elsewhere.
+    # Defaults to ENV["AWS_ACCESS_ID_KEY"]
+    def aws_access_key_id
+      if @aws_access_key_id
+        return @aws_access_key_id
+      elsif !ENV.has_key?('AWS_ACCESS_KEY_ID')
+        raise FogSettingError, "access key id must be set in ENV or configure block"
+      end
+      @aws_access_key_id ||= ENV['AWS_ACCESS_KEY_ID']
+    end
+    attr_writer :aws_access_key_id
+    
+    # AWS secret access key given by Amazon, should be stored in env but can be set to be elsewhere
+    # Defaults to ENV["AWS_SECRET_ACCESS_KEY"]
+    def aws_secret_access_key 
+      if @aws_secret_access_key
+        return @aws_secret_access_key
+      elsif !ENV.has_key?('AWS_SECRET_ACCESS_KEY')
+        raise FogSettingError, "secret access key must be set in ENV or configure block"
+      end
+      @aws_secret_access_key ||= ENV['AWS_SECRET_ACCESS_KEY']
+    end
+    attr_writer :aws_secret_access_key
+
+    def asset_paths
+    # logical paths to assets for use with Sprockets
+    # default: everything under the prefix dir 
+    # note that if remote is enabled in prod, asset paths will be added, but the link helpers bypass sprockets and grab the manifest links, and will only fall back to the paths if the asset is not found in the manifest. 
+      @asset_paths ||= [prefix] 
+    end
+    attr_writer :asset_paths
+
+    def backups_to_keep
+      @backups_to_keep ||= 2
+    end
+    attr_writer :backups_to_keep
+
+    def fog_options
+      options = { :provider => provider, :aws_access_key_id => aws_access_key_id, :aws_secret_access_key => aws_secret_access_key, :region => region }
+    end
+
+    def compile_sprockets_assets
+      # compile the assets in the sprockets load path. Outputs to directory of manifest. Updates the manifest
+      manifest.compile(*self.assets_to_compile)
+    end
+
+    def clean_sprockets_assets
+      # if there are more backups than the requested number, delete the oldest from the file system and update the manifest 
+      manifest.clean(backups_to_keep)
+    end
+
+    def clobber_sprockets_assets
+      # delete the manifest directory and everything in it
+      manifest.clobber
+    end
+
+    def sync
+      compile_sprockets_assets
+      clean_sprockets_assets
+
+      storage.upload_files
+      storage.clean_remote
+
+    end
+
+    def log(msg)
+      $stdout.puts msg
+    end
+
+    private
+
+    def provider
+      'AWS'
+    end
+
+    def digest
+      true
+    end
+
+    def asset_host
+      @asset_host ||= "#{bucket_name}.s3.amazonaws.com" 
+    end
+
+  end
+end
+