pagelime_rails 0.1.0 → 0.1.1

data/Heroku.md

@@ -0,0 +1,4 @@
+Pagelime CMS Addon
+=====================
+
+The CMS add-on enables the Pagelime CMS for your app, and allows your team to edit content on your Heroku app without commiting new code, modifying the database, or impacting the release process. 

data/Readme.md

@@ -0,0 +1,81 @@
+Pagelime Rails Plugin
+=====================
+
+Easily add the Pagelime CMS to your rails app.
+
+Pagelime is a simple CMS service that allows you to define editable regions in your content without installing any software on your site or app. Simply add a class="cms-editable" to any HTML element, and log-in to the Pagelime CMS service to edit your content and images with a nice UI. We host all of the code, content, and data until you publish a page. When you publish a page, we push the content to your site/app via secure FTP or web APIs.
+
+One line example:
+`<div id="my_content" class="cms-editable">This content is now editable in Pagelime... no code... no databases... no fuss</div>`
+
+Getting Started
+---------------
+
+Requirements:
+
+* Pagelime account (either a standalone from pagelime.com or as a Heroku add-on)
+* Nokogiri gem
+
+### Step 1. (Skip if using Heroku add-on)
+If NOT on Heroku, set up a site for your Rails app in Pagelime. Make sure that the "Integration Method" for your site on the advanced tab is set to "web services"
+
+### Step 2.
+Require the **pagelime_rails** gem
+
+#### For Rails 2
+edit your `config/environment.rb` file and add:
+
+`config.gem "pagelime_rails"`
+
+then run
+
+`rake gems:install`
+
+#### For Rails 3
+edit your `Gemfile` and add
+
+`gem "pagelime_rails"`
+
+then run
+
+`bundle install`
+
+### Step 3. (Only for Rails 2.3.X)
+Add the plugin routes to your `config/routes.rb` configuration:
+
+`map.cms_routes`
+
+These routes are used by Pagelime to clear any caches after save and publish events on your files.
+
+*Rails 3 does not need this statement, as the plugin will behave as an engine*
+
+### Step 4.
+For any controller that renders views that you want editable, add the acts_as_cms_editable behavior like so:
+
+    class CmsPagesController < ApplicationController
+        # attach the cms behavior to the controller
+        acts_as_cms_editable
+
+        def index
+        end
+    end
+
+You can pass an `:except` parameter just like with a filter like so:
+
+`acts_as_cms_editable :except => :index`
+
+### Step 5.
+Create some editable regions in your views like so:
+
+`<div id="my_content" class="cms-editable">this is now editable</div>`
+
+*The ID and the class are required for the CMS to work*
+
+### Step 6. (OPTIONAL)
+If you don't want to have your entire controller CMS editable for some reason, you can sorround areas in your view with a code block like so:
+
+	<% cms_content do %>
+		<div id="my_content" class="cms-editable">hello world</div>
+	<% end %>
+
+Copyright (c) 2011 Pagelime LLC, released under the MIT license

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/config/routes.rb

@@ -7,15 +7,27 @@ if Rails::VERSION::MAJOR == 2
   end
 
 elsif Rails::VERSION::MAJOR == 3
+  
+  if Rails::VERSION::MINOR == 0
 
-  puts "PAGELIME CMS PLUGIN: setting up rails 3 routes"
+    puts "PAGELIME CMS PLUGIN: setting up rails 3 routes"
+    
+    Rails.application.routes.draw do
+      match 'pagelime/:action' => 'pagelime_receiver'
+    end
+    
+  else
+    
+    puts "PAGELIME CMS PLUGIN: setting up rails 3.1 routes"
+    
+    Pagelime::Engine.routes.draw do
+      match 'pagelime/:action' => 'pagelime_receiver'
+    end
+  
+    Rails.application.routes.draw do
+      mount Pagelime::Engine => "/"
+    end
     
-  Pagelime::Engine.routes.draw do
-    match 'pagelime/:action' => 'pagelime_receiver'
-  end
-
-  Rails.application.routes.draw do
-    mount Pagelime::Engine => "/"
   end
   
 end

data/pagelime_rails.gemspec

@@ -5,21 +5,19 @@
 
 Gem::Specification.new do |s|
   s.name = %q{pagelime_rails}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Emil Anticevic"]
   s.date = %q{2012-01-09}
   s.description = %q{}
   s.email = %q{eanticev@gmail.com}
-  s.extra_rdoc_files = [
-    "README"
-  ]
   s.files = [
     "Gemfile",
+    "Heroku.md",
     "MIT-LICENSE",
-    "README",
     "Rakefile",
+    "Readme.md",
     "VERSION",
     "config/routes.rb",
     "init.rb",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: pagelime_rails
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Emil Anticevic
@@ -84,13 +84,14 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README
+extra_rdoc_files: []
+
 files: 
 - Gemfile
+- Heroku.md
 - MIT-LICENSE
-- README
 - Rakefile
+- Readme.md
 - VERSION
 - config/routes.rb
 - init.rb

data/README

@@ -1,59 +0,0 @@
-Pagelime Rails Plugin
-========
-
-Easily add the Pagelime CMS to your rails app.
-
-Pagelime is a simple CMS service that allows you to define editable regions in your content without installing any software on your site or app. Simply add a class="cms-editable" to any HTML element, and log-in to the Pagelime CMS service to edit your content and images with a nice UI. We host all of the code, content, and data until you publish a page. When you publish a page, we push the content to your site/app via secure FTP or web APIs.
-
-One line example:
-<div id="my_content" class="cms-editable">This content is now editable in Pagelime... no code... no databases... no fuss</div>
-
-
-Getting Started
-=======
-
-Requirements:
-* Pagelime account (either a standalone from www.pagelime.com or as a Heroku add-on)
-* Nokogiri gem
-
-Step 1. 
-If NOT on Heroku, set up a site for your Rails app in Pagelime. Make sure that the "Integration Method" for your site on the advanced tab is set to "web services"
-
-Step 2.
-Install this plugin on your Rails app, or use it as a gem (pagelime-rails)
-
-Step 3.
-Add the plugin routes to your routes.rb configuration:
-
-map.cms_routes
-
-These routes are used by Pagelime to clear any caches after save and publish events on your files.
-
-Step 4.
-For any controller that renders views that you want editable, add the acts_as_cms_editable behavior like so:
-
-class CmsPagesController < ApplicationController
-  acts_as_cms_editable
-  
-  def index
-  end
-end
-
-You can pass an :except parameter just like with a filter like so:
-
-acts_as_cms_editable :except => :index
-
-Step 5.
-Create some editable regions in your views like so:
-<div id="my_content" class="cms-editable">...</div>
-
-The ID is required.
-
-Step 6. (OPTIONAL)
-If you don't want to have your entire controller CMS editable for some reason, you can sorround areas in your view with a code block like so:
-
-<% cms_content do %>
-	<div id="my_content" class="cms-editable">hello world</div>
-<% end %>
-
-Copyright (c) 2011 Pagelime LLC, released under the MIT license