trackman 0.0.5

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem "heroku", ">= 2.26.2"

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    trackman (0.0.5)
+      json
+      nokogiri
+      rack
+      rest-client
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.8)
+    diff-lcs (1.1.3)
+    excon (0.14.0)
+    heroku (2.26.6)
+      heroku-api (~> 0.2.4)
+      launchy (>= 0.3.2)
+      netrc (~> 0.7.2)
+      rest-client (~> 1.6.1)
+      rubyzip
+    heroku-api (0.2.4)
+      excon (~> 0.14.0)
+    json (1.7.3)
+    launchy (2.1.0)
+      addressable (~> 2.2.6)
+    mime-types (1.18)
+    netrc (0.7.4)
+    nokogiri (1.5.3)
+    rack (1.4.1)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    rubyzip (0.9.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  heroku (>= 2.26.2)
+  rspec
+  trackman!

data/LICENSE

@@ -0,0 +1,17 @@
+Copyright (c) 2012 Fabre Jeremy and Petre Emanuel
+
+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,96 @@
+# Trackman
+
+Trackman is a Heroku add-on that enables you to handle your maintenance and error pages with the rest of your app and hosts the production version of those files in the cloud when you deploy.
+
+* It works with rails-like conventions.
+* It is rack-based.
+* It will push your pages and all their internal assets upon application initialization. 
+
+## Information
+
+### Platform support
+
+Trackman works out of the box for Ruby(1.8.7 and 1.9.3) on
+
+* Rails 2
+* Rails 3
+
+
+## Getting started
+### Step 1 - Install the heroku add-on
+```console
+heroku addons:add trackman
+```
+### Step 2 - Add the client gem to your Gemfile
+```console
+gem 'trackman'
+```
+
+##### Step 2.1 - Rails 2 only
+```console
+./script/generate trackman
+```
+This will add trackman.rake to lib/tasks/ 
+
+### Step 3 - Setup
+```console
+rake trackman:setup
+```
+Sets up your initial configuration and add custom error page add-on if you don't have it yet.
+
+### Optional
+```console
+rake trackman:sync
+```
+Performs a manual sync of your error/maintenance pages and their related assets. 
+This normally gets executed everytime you deploy to heroku.
+
+### For best results, make sure you have those installed:
+* Heroku >= 2.26.2
+* Bundler >= 1.1.3
+
+### Notes
+By convention, we assume your maintenance page is located at
+
+```console
+public/503.html
+```
+
+If you want two different pages for maintenance and when your app is down, we expect:
+
+For maintenance
+```console
+public/503.html
+```
+Broken app
+```console
+public/503-error.html
+```
+
+After the add-on installation
+
+* On the first publish or manual sync, your html file(s) and every internal assets referenced by your pages(s) will be pushed to our server so that we can store them properly on S3.
+* On the next publications, only modified assets will be published. 
+* Any renamed or missing asset will be handled properly on our side.
+
+### Bug reports
+
+Any bug report can be submitted here.
+https://github.com/jfabre/trackman/issues
+
+
+### Creators / Maintainers
+
+* Jeremy Fabre (https://github.com/jfabre)
+* Emanuel Petre (https://github.com/epetre)
+
+###Copyright
+
+Copyright © 2012 Emanuel Petre, Jeremy Fabre
+
+## License
+
+  Trackman is released under the MIT license:
+
+  [LICENSE](https://github.com/jfabre/trackman/blob/master/LICENSE)
+

data/Rakefile

@@ -0,0 +1,52 @@
+require "bundler/gem_tasks"
+
+
+desc "creates a new app to the server and outputs the credentials"
+task :create_app do
+  require 'trackman'
+  RemoteAsset = Trackman::Assets::RemoteAsset  
+
+  user = ENV['HEROKU_USERNAME']
+  pass = ENV['HEROKU_PASSWORD']
+  server = RemoteAsset.class_variable_get :@@server
+
+  url = "http://#{user}:#{pass}@#{server}/heroku/resources"
+  puts "\nPosting on : #{url}\n\n"
+  response = RestClient.post url, :plan => 'test', :heroku_id => 123 
+  json = JSON.parse response
+
+  puts "export TRACKMAN_USER=#{json['config']['TRACKMAN_USER']}"
+  puts "export TRACKMAN_PASSWORD=#{json['config']['TRACKMAN_PASSWORD']}"
+  puts "export TRACKMAN_APP_ID=#{json['id']}\n\n"
+  
+  puts "Have fun!"
+end
+
+namespace :setup do
+  namespace :rails32 do
+    desc "runs rails new for a given name and removes useless files"
+    task :fixture, :name do |t, args| 
+      name = response = args[:name]
+      puts "rails _3.2.0_ new spec/fixtures/rails32/#{name} -G -O -T"
+      `rails _3.2.0_ new spec/fixtures/rails32/#{name} -G -O -T`
+    end
+  end
+
+  namespace :rails309 do
+    desc "runs rails new for a given name and removes useless files"
+    task :fixture, :name do |t, args| 
+      name = response = args[:name]
+      puts "rails _3.0.9_ new spec/fixtures/rails309/#{name} -G -O -T"
+      `rails _3.0.9_ new spec/fixtures/rails309/#{name} -G -O -T`
+    end
+  end
+
+  namespace :rails2311 do
+    desc "runs rails new for a given name and removes useless files"
+    task :fixture, :name do |t, args| 
+      name = response = args[:name]
+      puts "cp spec/fixtures/rails2311/template spec/fixtures/rails2311/#{name}"
+      `cp -r spec/fixtures/rails2311/template spec/fixtures/rails2311/#{name}`
+    end
+  end
+end

data/lib/tasks.rb

@@ -0,0 +1,7 @@
+if defined?(Rails) && ::Rails::VERSION::STRING =~ /^[3-9]\.[1-9]/
+  class Tasks < Rails::Railtie
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__),'../rails_generators/trackman/templates/*.rake')].each { |f| load f }
+    end
+  end
+end

data/lib/trackman/assets/asset.rb

@@ -0,0 +1,97 @@
+module Trackman
+  module Assets
+    class Asset
+      extend Components::AssetFactory
+      extend Components::Conventions
+      extend Components::Diffable
+      extend Components::Shippable
+      include Components::Hashable
+      include Comparable
+      
+      def initialize attributes = {}
+        @assets = []
+        self.path = attributes[:path]
+      end
+      
+      attr_reader :path, :assets
+
+      def to_remote
+        RemoteAsset.new(:path => @path)
+      end
+
+      def ==(other)
+        return false if other.nil?
+        other_path = other.path.is_a?(Pathname) ? other.path : Pathname.new(other.path)         
+        other_path.to_s == path.to_s || path.realpath == other_path.realpath
+      end
+
+      def <=>(another)
+        result = 0
+
+        if self.path.extname == '.html' && another.path.extname == '.html'
+          result = self.path.to_s <=> another.path.to_s  
+        elsif @path.extname == '.html' || another.path.extname == '.html'  
+          result += 1 if self.path.extname == '.html'
+          result -= 1 if another.path.extname == '.html'
+        elsif is_child_of(another)
+          result += -1
+        elsif another.is_child_of(self)
+          result += 1
+        end  
+
+        result
+      end
+      
+      def is_child_of(parent)
+        parent.is_a?(Components::CompositeAsset) && parent.assets.include?(self)
+      end
+
+      def self.all
+        return [] unless maintenance_path.exist?
+
+        assets = [maintenance_page] + maintenance_page.assets 
+        assets = assets + [error_page] + error_page.assets if error_path.exist?
+
+        assets.uniq{|a| a.path.realpath }.sort 
+      end
+
+      def self.sync
+        local = Asset.all
+        remote = RemoteAsset.all
+        diff_result = diff(local, remote) 
+        ship diff_result
+        
+        true
+      end
+
+      def self.autosync
+        autosync = ENV['TRACKMAN_AUTOSYNC'] || true
+        autosync = autosync !~ /(0|false|FALSE)/ unless autosync.is_a? TrueClass
+        if const_defined?(:Rails) 
+          autosync = autosync && Rails.env.production?
+        end 
+        
+        begin
+          return sync if autosync
+        rescue
+          return false
+        end
+        autosync
+      end
+
+      protected
+        def validate_path?
+          true
+        end
+        def path=(value)
+          value = Pathname.new value unless value.nil? || value.is_a?(Pathname)
+          if validate_path?
+            unless value && value.exist? && value.file?
+              raise Errors::AssetNotFoundError, "The path '#{value}' is invalid or is not a file"
+            end
+          end
+          @path = value
+        end
+    end 
+  end
+end

data/lib/trackman/assets/components/asset_factory.rb

@@ -0,0 +1,41 @@
+module Trackman
+  module Assets
+    module Components
+      module AssetFactory
+        def create attributes = {}
+          path = attributes[:path]
+
+          if File.extname(path) == '.html'
+            parent = HtmlAsset
+          elsif File.extname(path) == '.css'
+            parent = CssAsset 
+          else
+            parent = Asset
+          end 
+
+          instance = parent.new attributes
+
+          if asset_pipeline_enabled?
+            instance.extend Rails32PathResolver  
+          elsif rails_defined? #fallback to rails without asset pipeline
+            instance.extend RailsPathResolver
+          end
+
+          instance
+        end
+
+        def rails_defined?
+          Object.const_defined?(:Rails)
+        end
+
+        def asset_pipeline_enabled?
+           rails_defined? && 
+           Rails.respond_to?(:application) &&
+           Rails.application.respond_to?(:config) &&
+           Rails.application.config.respond_to?(:assets) && 
+           Rails.application.config.assets.enabled
+        end  
+      end
+    end
+  end
+end

data/lib/trackman/assets/components/asset_factory.rb.orig

@@ -0,0 +1,54 @@
+module Trackman
+  module Assets
+    module Components
+      module AssetFactory
+        def create attributes = {}
+          path = attributes[:path]
+
+          if File.extname(path) == '.html'
+            parent = HtmlAsset
+          elsif File.extname(path) == '.css'
+            parent = CssAsset 
+          else
+            parent = Asset
+          end 
+
+          instance = parent.new attributes
+<<<<<<< HEAD
+          instance.extend Rails32PathResolver if asset_pipeline_enabled?
+          instance
+        end
+
+        def rails_defined?
+          const_defined? :Rails
+=======
+        
+          if uses_rails32?
+            instance.extend Rails32PathResolver
+          elsif uses_rails? #fallback to rails without asset pipeline
+            instance.extend RailsPathResolver
+          end
+
+          instance
+        end
+
+        def uses_rails?
+          const_defined?(:Rails)
+        end
+
+        def uses_rails32?
+          uses_rails?  &&  ::Rails::VERSION::STRING =~ /^[3-9]\.[1-9]/
+>>>>>>> c8c05bfdca05b2ee989fd7040676cebe6f2f2b88
+        end
+
+        def asset_pipeline_enabled?
+           rails_defined? && 
+           Rails.respond_to?(:application) &&
+           Rails.application.respond_to?(:config) &&
+           Rails.application.config.respond_to?(:assets) && 
+           Rails.application.config.assets.enabled
+        end  
+      end
+    end
+  end
+end

data/lib/trackman/assets/components/composite_asset.rb

@@ -0,0 +1,39 @@
+module Trackman
+  module Assets
+    module Components
+      module CompositeAsset
+
+        def self.included(mod)
+          mod.send(:include, PathResolver)
+        end
+        def self.extended(mod)
+          mod.send(:extend, PathResolver)
+        end
+
+        def assets
+          result = children_paths.select{|p| p.internal_path? }.inject([]) do |array, p|
+            asset = Asset.create(:path => translate(p, path))  
+            array << asset 
+            array.concat(asset.assets.select{|a| !array.include?(a) })
+            array              
+          end
+          
+          result
+        end
+        
+        def inner_css_paths
+          @@url ||= /url\(['"]?([^'")]+)['"]?\)/
+          @@import ||= /url\(['"]?[^'"]+['"]?\)/
+
+          data.scan(@@import).collect{|x| @@url.match(x)[1] }
+        end
+      end
+    end
+  end
+end
+
+class String
+  def internal_path? 
+    self !~ /^http/
+  end 
+end

data/lib/trackman/assets/components/conventions.rb

@@ -0,0 +1,23 @@
+module Trackman
+  module Assets
+    module Components
+      module Conventions
+        Asset = Trackman::Assets::Asset
+        
+        def maintenance_path
+          Pathname.new 'public/503.html'
+        end
+        def error_path
+          Pathname.new 'public/503-error.html'
+        end  
+        def maintenance_page
+          Asset.create(:path => maintenance_path)
+        end
+        def error_page
+          Asset.create(:path => error_path)
+        end 
+      end
+    end
+  end
+end
+

data/lib/trackman/assets/components/diffable.rb

@@ -0,0 +1,29 @@
+module Trackman
+  module Assets
+    module Components
+      module Diffable
+        def diff local, remote 
+          to_create = local.select{|a| remote.all? { |s| a.path != s.path } }.map{|a| a.to_remote }.to_a
+          { 
+            :create => to_create, 
+            :update => remote.select{|a| local.any?{ |s| a.path == s.path && a.file_hash != s.file_hash }}.to_a,  
+            :delete => define_deleted(local, remote) do |a| 
+              to_create.any?{ |c| c.path.basename == a.path.basename }
+            end
+          }
+        end
+
+        private
+          # will not delete an html for now. 
+          # this behaviour is to avoid the removal of the default templates.
+          def define_deleted local, remote
+            to_delete = remote.select do |a| 
+              local.all? { |s| s.path != a.path } 
+            end
+
+            to_delete.reject{|a| a.path.to_s =~ /.html$/ }.to_a
+          end
+      end
+    end
+  end
+end

data/lib/trackman/assets/components/hashable.rb

@@ -0,0 +1,30 @@
+require 'digest/md5'
+ 
+module Trackman
+  module Assets
+    module Components
+      module Hashable
+      
+        def data
+          @data ||= read_file
+        end
+
+        def file_hash
+          Digest::MD5.hexdigest(data)
+        end
+        
+        protected
+          def read_file
+            begin
+              file = File.open(path)
+              return file.read
+            rescue
+              return nil
+            ensure
+              file.close 
+            end    
+          end
+      end      
+    end
+  end
+end

data/lib/trackman/assets/components/path_resolver.rb

@@ -0,0 +1,34 @@
+module Trackman
+  module Assets
+    module Components  
+      module PathResolver
+      	def translate url, parent_url
+          raise "parent_url: #{parent_url} is required to be relative" if Pathname.new(parent_url).absolute?
+
+      		url = Pathname.new(url) unless url.is_a? Pathname
+      		parent_url = Pathname.new(parent_url) unless parent_url.is_a? Pathname
+      		
+      		if url.relative?
+      			parent = parent_of(parent_url)
+      			child = url
+      		else
+      			parent = working_dir
+            s = url.to_s
+      			child = Pathname.new(s[1...s.length])
+      		end
+
+          (parent + child).relative_path_from(working_dir).to_s
+      	end
+
+      	def working_dir
+      		Pathname.new Dir.pwd
+      	end
+
+      	def parent_of(url)
+      		(working_dir + url).parent
+      	end
+      end
+    end
+  end
+end
+

data/lib/trackman/assets/components/rails32_path_resolver.rb

@@ -0,0 +1,49 @@
+module Trackman
+  module Assets
+    module Components  
+      module Rails32PathResolver
+        extend PathResolver
+        
+        class << self
+          alias old_translate translate
+          alias old_parent_of parent_of
+
+          def parent_of(url)
+            if url.to_s.include?('assets')
+              old_parent_of(url).ascend do |p|
+                return p if p.basename.to_s == 'assets'
+              end
+            else
+              return old_parent_of(url)
+            end
+          end 
+        end
+
+        def translate url, parent_url
+          path = Rails32PathResolver.old_translate(url, parent_url)
+          parts = path.split('/')
+          parts.insert(0, 'app') if parts.first == 'assets'
+
+          if parts.first == 'app' && parts[1] == 'assets'
+            parts.insert(2, subfolder(parts.last))
+          elsif parts.first != 'public'
+            parts.insert(0, 'public') 
+          end
+
+          parts.join('/')
+        end
+
+        def subfolder(file)
+          if file.include?('.js')
+            subfolder = "javascripts"
+          elsif file.include?('.css')
+            subfolder = "stylesheets"
+          else 
+            subfolder = "images"
+          end
+          subfolder
+        end
+      end
+    end
+  end
+end

data/lib/trackman/assets/components/rails_path_resolver.rb

@@ -0,0 +1,34 @@
+module Trackman
+  module Assets
+    module Components  
+      module RailsPathResolver
+        
+        #way 2
+        extend PathResolver
+        class << self
+          alias old_translate translate
+          alias old_parent_of parent_of
+
+          def parent_of(url)
+            if url.to_s.include?('assets')
+              old_parent_of(url).ascend do |p|
+                return p if p.basename.to_s == 'assets'
+              end
+            else
+              return old_parent_of(url)
+            end
+          end 
+        end
+
+        def translate url, parent_url
+          path = RailsPathResolver.old_translate(url, parent_url)
+
+          parts = path.split('/')
+          parts.insert(0, 'public') if parts.first != 'public'
+
+          parts.join('/')
+        end
+      end
+    end
+  end
+end