locomotive-heroku 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 NoCoffee, released under the 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.textile

@@ -0,0 +1,41 @@
+h1. Heroku extension for LocomotiveCMS
+
+This extension allows LocomotiveCMS to run on heroku
+
+h2. Requirements
+
+* Heroku gem
+* Heroku app
+* Heroku API key
+* LocomotiveCMS engine
+
+h2. Installation
+
+Inside your LocomotiveCMS application, open your **Gemfile** file and insert the following line after the one referencing LocomotiveCMS
+
+bc. gem 'locomotive_heroku', :require => 'locomotive/heroku'
+
+h2. Configuration
+
+Then, you have to let Heroku know about your API key and your application name
+Modify your Locomotive config file (**config/locomotive.rb**)
+
+bc. config.hosting = { :target => :heroku, :api_key => '<YOUR HEROKU API KEY>', :app_name => '<MY HEROKU APP NAME>' }
+
+h2. Storage: Amazon S3
+
+Because Heroku disables writing on their disk, we have to use Amazon S3 or any storage providers as long as they are supported by Carrierwave. In the following example, we will use Amazon S3 which is by far the most known/used.
+
+Open your terminal and at the root of your application on your machine,
+
+bc.. heroku config:add S3_KEY_ID=<your s3 key id>
+heroku config:add S3_SECRET_KEY=<your s3 secret key>
+heroku config:add S3_BUCKET=<your s3 bucket name>
+
+p. Note: If you plan to use another storage provider, do not forget to modify the **config/carrierwave.rb** file accordingly.
+
+h2. Contact
+
+Feel free to contact me at didier at nocoffee dot fr.
+
+Copyright (c) 2012 NoCoffee, released under the MIT license

data/Rakefile

@@ -0,0 +1,30 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Heroku'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+# === RSpec ===
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+# === Default task ===
+task :default => :spec

data/lib/locomotive/heroku.rb

@@ -0,0 +1,63 @@
+puts "\t...loading heroku extension"
+
+require 'heroku-api'
+require 'locomotive/heroku/patches'
+require 'locomotive/heroku/custom_domain'
+require 'locomotive/heroku/first_installation'
+require 'locomotive/heroku/enabler'
+
+module Locomotive
+  module Heroku
+
+    class << self
+      attr_accessor :connection, :app_name, :domains
+
+      def domains
+        if @domains.nil?
+          response = self.connection.get_domains(self.app_name)
+
+          if response.status == 200
+            @domains = response.body.map { |h| h['domain'] }.reject { |n| n.starts_with?('*') }
+          else
+            @domains = []
+          end
+        else
+          @domains
+        end
+      end
+
+      def connection
+        return @connection if @connection
+
+        raise 'The Heroku API key is mandatory' if ENV['HEROKU_API_KEY'].blank? && Locomotive.config.hosting[:api_key].blank?
+
+        @connection = ::Heroku::API.new(:api_key => ENV['HEROKU_API_KEY'] || Locomotive.config.hosting[:api_key])
+      end
+
+      def app_name
+        return @app_name if @app_name
+
+        raise 'The Heroku application name is mandatory' if ENV['APP_NAME'].blank? && Locomotive.config.hosting[:app_name].blank?
+
+        @app_name = Locomotive.config.hosting[:app_name] || ENV['APP_NAME']
+      end
+    end
+
+    def self.add_domain(name)
+      Locomotive.log "[add heroku domain] #{name}"
+
+      response = self.connection.post_domain(self.app_name, name)
+
+      if response.status >= 200 && response.status < 300
+        self.domains << name
+      end
+    end
+
+    def self.remove_domain(name)
+      Locomotive.log "[remove heroku domain] #{name}"
+      self.connection.delete_domain(self.app_name, name)
+      self.domains.delete(name)
+    end
+
+  end
+end

data/lib/locomotive/heroku/custom_domain.rb

@@ -0,0 +1,38 @@
+module Locomotive
+  module Heroku
+    module CustomDomain
+
+      extend ActiveSupport::Concern
+
+      included do
+        after_save    :sync_heroku_domains
+        after_destroy :remove_heroku_domains
+      end
+
+      protected
+
+      def sync_heroku_domains
+        # all the Heroku domains should also referenced in the site, if not then remove them from Heroku.
+        Locomotive::Heroku.domains.each do |domain|
+          unless self.domains_without_subdomain.include?(domain)
+            Locomotive::Heroku.remove_domain(domain)
+          end
+        end
+
+        # add the site domains should referenced in the Heroku domains, if not then add them to Heroku
+        self.domains_without_subdomain.each do |domain|
+          unless Locomotive::Heroku.domains.include?(domain)
+            Locomotive::Heroku.add_domain(domain)
+          end
+        end
+      end
+
+      def remove_heroku_domains
+        self.domains_without_subdomain.each do |domain|
+          Locomotive::Heroku.remove_domain(domain)
+        end
+      end
+
+    end
+  end
+end

data/lib/locomotive/heroku/enabler.rb

@@ -0,0 +1,24 @@
+module Locomotive
+
+  def self.enable_heroku
+    Locomotive.config.domain = 'herokuapp.com' unless Locomotive.config.multi_sites?
+
+    # we can manage domains within Heroku no matter what the value of the multi_sites option is
+    Locomotive.config.manage_domains    = true
+    Locomotive.config.manage_subdomain  = false unless Locomotive.config.multi_sites?
+
+    # rack_cache: disabled because of Varnish
+    Locomotive.config.rack_cache = false
+
+    # hooks
+    Locomotive::Site.send :include, Locomotive::Heroku::CustomDomain
+    Locomotive::Site.send :include, Locomotive::Heroku::FirstInstallation
+
+    # initialize the API connection
+    Locomotive::Heroku.connection
+
+    # load all the domains
+    Locomotive::Heroku.domains
+  end
+
+end

data/lib/locomotive/heroku/first_installation.rb

@@ -0,0 +1,27 @@
+module Locomotive
+  module Heroku
+    module FirstInstallation
+
+      extend ActiveSupport::Concern
+
+      included do
+
+        class << self
+          alias_method_chain :create_first_one, :heroku
+        end
+
+      end
+
+      module ClassMethods
+
+        def create_first_one_with_heroku(attributes)
+          attributes[:subdomain] = Locomotive::Heroku.app_name
+
+          self.create_first_one_without_heroku(attributes)
+        end
+
+      end
+
+    end
+  end
+end

data/lib/locomotive/heroku/patches.rb

@@ -0,0 +1,6 @@
+# http://blog.ethanvizitei.com/2010/11/json-pure-ruins-my-morning.html
+Fixnum.class_eval do
+  def to_json(options = nil)
+    to_s
+  end
+end

data/lib/locomotive/heroku/version.rb

@@ -0,0 +1,5 @@
+module Locomotive
+  module Heroku
+    VERSION = '0.0.1'
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: locomotive-heroku
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Didier Lafforgue
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &2154722040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *2154722040
+- !ruby/object:Gem::Dependency
+  name: heroku-api
+  requirement: &2154721380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2154721380
+description: Enhance the LocomotiveCMS engine in order to make it run on Heroku
+email:
+- didier@nocoffee.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/locomotive/heroku/custom_domain.rb
+- lib/locomotive/heroku/enabler.rb
+- lib/locomotive/heroku/first_installation.rb
+- lib/locomotive/heroku/patches.rb
+- lib/locomotive/heroku/version.rb
+- lib/locomotive/heroku.rb
+- MIT-LICENSE
+- Rakefile
+- README.textile
+homepage: http://www.locomotivecms.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 255214951121743543
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 255214951121743543
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Heroku for LocomotiveCMS
+test_files: []