pagelime-rails 0.2.0 → 0.2.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OWI4NGZiMTQ5ZGY4YWE4NmQxN2I3YzFkNzYzMzJhYTNjMDEyMTA4Yw==
+    MTViNzIyMTI1MzU3ZTc4MzljNmQyMzg5ZjVhYjI1ZTRhYThhYWJhYQ==
   data.tar.gz: !binary |-
-    OGMxNTZlMThjZjM0MjEyNWFlMmRiM2E5YjVhM2I2NzI3MGQzN2FkYg==
+    ZWMwY2YxZGJkMmY3ZjEzYWI3ZTg0NjQ0NmE1MzA3OTUzZjZmZTIzMQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    OTg4MjQwMTEwZGMyNTFjYjNkNjc1NTU1OWNkMThmMTg1NDZhYWU4YjZmMmRh
-    M2M1MzY3MWUyOTUyZWU5YzEwODc2YWUzZDFlNmUwMjU4Mjg5Y2UwNzJiYmVm
-    OTUzMGQ5ZmUyOWMyMGM3MjEyMDU3NTMwMjExYjQwOWE2M2U3YzE=
+    MTRlNGQ0ODdjMjcxNTJmODRkNmUxYjFhN2VmZDhkY2Q3MGYxNjk2YjVhYzMy
+    NWUxYzIzMDNkMGEwNjAzOGVmOTg1YTViYzliZjIzNDg0NThmNWJhYTFlNGI1
+    MTU0MzBkMjZkMmE3YWI5MGJhZWNiZGM3MGMxNDc4YzAyMmQwN2M=
   data.tar.gz: !binary |-
-    NDE0OWZiZDA5ZjNiNzM3NzI3M2JjMjQ4ZDllN2ExMTc4OWFlNDdiYzkxNzhj
-    ZWQ4MTM1MmI0ZmFkOGUyMTNhMTE5MzMxMGJlOTljMGY5ZjI3ZTViYTZiYjc4
-    MDg1ZTRiMzZmNTIxYmZhMjg5YmM2M2YwNzcxYWI3ZGZjNzNkOGU=
+    YTQ1ZGFlZGE2NTBhNzFhYTg4NWQ3YzQ4ODA1YTBlMGQ0NjRhNWJmNzczMjdi
+    OGUyZWNmYmFmOTdhZjM0YjRjZDU3NTQwY2ZhNWRlYzlhMTFkMTZmZGFjNjlm
+    NjEwNGI4NWFkZDkwZDExYTdhMWE0MWI4NGIzZjk5ZGE3MjEwNDY=

data/Readme.md

@@ -1,81 +1,102 @@
 Pagelime Rails Plugin
 =====================
 
-Easily add the Pagelime CMS to your rails app.
+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.
+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>`
+
+    <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
+### Requirements
 
-### 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"
+* Pagelime account (either standalone [pagelime.com](http://pagelime.com) or via the [Pagelime Heroku add-on](https://addons.heroku.com/pagelime))
+* [Pagelime Rack gem](https://github.com/eanticev/pagelime_rack) (`pagelime-rack`)
 
-### Step 2.
-Require the **pagelime_rails** gem
+### Step 1: Install the Pagelime Rails gem
 
 #### For Rails 2
-edit your `config/environment.rb` file and add:
 
-`config.gem "pagelime_rails"`
+Edit your `config/environment.rb` file and add:
+
+    config.gem "pagelime-rails"
 
 then run
 
-`rake gems:install`
+    rake gems:install
 
 #### For Rails 3
-edit your `Gemfile` and add
 
-`gem "pagelime_rails"`
+Edit your `Gemfile` and add
+
+    gem "pagelime-rails"
 
 then run
 
-`bundle install`
+    bundle install
 
-### Step 3. (Only for Rails 2.3.X)
-Add the plugin routes to your `config/routes.rb` configuration:
+### Step 2: Setup your Pagelime credentials
 
-`map.cms_routes`
+*(Skip if using Heroku add-on)*
 
-These routes are used by Pagelime to clear any caches after save and publish events on your files.
+If you are NOT using the [Pagelime Heroku add-on](https://addons.heroku.com/pagelime), set up an account at [pagelime.com](http://pagelime.com). 
+Make sure that the "Integration Method" for your site on the advanced tab is set to "web services".
 
-*Rails 3 does not need this statement, as the plugin will behave as an engine*
+### Step 3: Configure your application
 
-### Step 4.
-For any controller that renders views that you want editable, add the acts_as_cms_editable behavior like so:
+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
+      # 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`
+    acts_as_cms_editable :except => :index
+
+#### 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*
+
+#### Additional configuration options
+
+*Read the [`pagelime-rack`](https://github.com/eanticev/pagelime_rack) documentation for more configuration options.*
+
+### Step 4: Make pages editable
 
-### Step 5.
 Create some editable regions in your views like so:
 
-`<div id="my_content" class="cms-editable">this is now editable</div>`
+    <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:
+Optionally: 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 %>
+    <% cms_content do %>
+      <div id="my_content" class="cms-editable">
+        hello world
+      </div>
+    <% end %>
 
-Copyright (c) 2011 Pagelime LLC, released under the MIT license
+Copyright (c) 2013 Pagelime LLC, released under the MIT license

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/lib/pagelime-rails.rb

@@ -1,3 +1,4 @@
+require 'pagelime-rack'
 require 'pagelime'
 require 'pagelime/rails'
 require 'pagelime/s3_rails_cache'

data/lib/pagelime/s3_rails_cache.rb

@@ -1,5 +1,5 @@
 module Pagelime
-  class S3RailsCache < Pagelime::S3Client
+  class S3RailsCache < S3Client
     module ClassMethods
       def generate_cache_key(page_path, format = default_format)
         "pagelime:cms:#{format}:page:#{Base64.encode64(page_path)}"

data/pagelime-rails.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "pagelime-rails"
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Emil Anticevic", "Joel Van Horn"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pagelime-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Emil Anticevic