buttercms 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a899685662a22b2ad2a4ec87e0f9e0683fbcdaa
-  data.tar.gz: a7d27b415b8e3d6e16ce7368f1cfd527e60e4301
+  metadata.gz: e8cfd9c6d155d1d6af4e7ce36410d02caec5f155
+  data.tar.gz: 3e7eea1416ff87e322a4af8c55f63741a4e8c46c
 SHA512:
-  metadata.gz: e1aae93ced97c476b91c31efdfa3ce2d4f6b82e30a9527d3963c9661ae3c07eb3aee0215d8d706f0f787a247f14e0c95d605e0731352b459a204fa40a7905e1d
-  data.tar.gz: 2559999bf1ea8819f7d95334162e3e14e839af3aa1f120215167e08f2ae4419f7c42585cfa261f80729e4bb2a2efb627b3ed1434d669fd895439cd132217e778
+  metadata.gz: 67b0cc540d0b9c3ea17fbaac22cc2712b1d173fdeb7c6c94900412d239635f92da05200747c3acb94923090179e288012cae745b88bb9ce9299702e028a63dba
+  data.tar.gz: c92fce92b78b7989aef456e793433957e1087dade9fa5bd39b5c051772e47543ec2a4e1042d0ed6ffb9832c9f36acb32682eededaea28a144f552089a3759e71

data/README.rst

@@ -1,5 +1,6 @@
+====================
 Butter CMS for Rails
-=========================
+====================
 
 https://www.buttercms.com
 
@@ -12,8 +13,10 @@ Butter provides a user friendly blogging UI, hosted on buttercms.com, and expose
 This package provides a Rails Engine that interacts with the Butter API to get you up and running in seconds.
 
 
+============
 Installation
-------------
+============
+
 Add buttercms gem to your Gemfile and install it.
 
 .. code-block:: ruby
@@ -34,11 +37,29 @@ Mount the Buttercms engine in your config/routes.rb and define your blog path.
 
 Grab your API token from https://buttercms.com/api_token
 
-.. code:: ruby
+**Rails 4.x**
+
+For rails 4, add `BUTTER_CMS_TOKEN` to `secrets.yml`
+
+.. code-block:: ruby
 
     # In config/secrets.yml
     # Add your BUTTER_CMS_TOKEN to both development: and production:
-    BUTTER_CMS_TOKEN: <your_api_token>
+    development:
+     BUTTER_CMS_TOKEN: <your_api_token>
+    production:
+     BUTTER_CMS_TOKEN: <your_api_token>
+
+
+**Rails 3.x**
+
+For rails 3, set up a classic initializer to expose the api token to the Butter gem.
+
+.. code-block:: ruby
+
+    # In config/initializers/butter.rb
+    Buttercms::BUTTER_CMS_TOKEN = <your_api_token>
+
 
 Nice job. You've now got a blog running natively in your Rails project. Nothing but Ruby goodness. (No PHP scripts here ;))
 
@@ -46,6 +67,73 @@ Check it out: localhost:3000/blog
 
 Log into https://buttercms.com/ to start blogging!
 
+==========================
+Overview of key blog views
+==========================
+The Butter gem implements several actions for your blog and provides a default view+layout for each of them. The gem also talks to an API that resides on https://buttercms.com to retrieve your blog content and makes that content easily available in each view. 
+
+Here's an overview each action+view and the available content:
+
+home: /blog
+-----------
+.. code:: ruby
+
+    @next_page # Integer used for blog post pagination (i.e. 2)
+    @previous_page # Integer used for blog post pagination (i.e. 1)
+    @recent_posts # Array of blog posts
+
+post: /blog/:post-slug
+----------------------
+.. code:: ruby
+
+    @post # All content for a blog post
+    
+    =begin
+    @post has the following structure
+    "url": "https://buttercms.com/blog/the-state-of-company-blogs",
+    "created": "05/16/2015",
+    "author": {
+    "first_name": "Butter",
+    "last_name": "Cms",
+    "slug": "butter-cms"
+    },
+    "categories": [
+    {
+    "name": "blogs",
+    "slug": "blogs"
+    },
+    {
+    "name": "butter",
+    "slug": "butter"
+    }
+    ],
+    "slug": "the-state-of-company-blogs",
+    "title": "The State of Company Blogs",
+    "body": "<h3>The problem</h3><p>Countless people and essentially every...</p>",
+    "summary": <h3>The problem</h3><p>Countless people and essentially...</p>,
+    "status": "published"
+    =end
+
+author: /blog/author/:author-slug
+---------------------------------
+.. code:: ruby
+
+    @first_name # First name of author
+    @last_name # Last name of author
+    @recent_posts # Array of blog posts
+
+category: /blog/category/:category-slug
+---------------------------------------
+.. code:: ruby
+
+    @name # Name of the category
+    @recent_posts # Array of blog posts
+
+
+=====================
+Customizing your blog
+=====================
+
 Specify the Blog Layout
 -----------------------
 We've provided a default layout but we expect you'll want the blog to appear your branded layout so we've made this as simple as defining config.blog_layout.
@@ -55,35 +143,51 @@ We've provided a default layout but we expect you'll want the blog to appear you
     # In application.rb (or an initializer like constants.rb)
     config.blog_layout = "<your_blog_layout>"
 
-Note that an ideal layout simply defines the header and footer for the page and <%= yields %> the main body.  Restart the server and go to localhost:3000/blog and you'll see your new branded blog!
+Note that an ideal layout simply defines the header and footer for the page and `<%= yields %>` the main body.  Restart the server and go to localhost:3000/blog and you'll see your new branded blog!
+
+Customizing the view templates
+------------------------------
+You can customize any view of your blog. Here is full list of page types + settings:
+
+.. code:: ruby
+
+    # In application.rb
+    config.blog_home_template = "blog/home"
+    config.blog_post_template = "blog/post"
+    config.blog_author_template = "blog/author"
+    config.blog_category_template = "blog/category"
+
+We recommend putting any custom templates in `views/blog/<template>.html.erb`
+
+Below is a specific example of how to customize your blog post view to include Discus comments.
 
 Add comments to blog post template
 ----------------------------------
 If you want to customize the blog post template (for example to add `Disqus 
 <https://disqus.com/>`_ comments at the bottom), it's simple:
 
-First create your template. We recommend putting it in `views/blog/post.html.erb`
+First create your template: `views/blog/post.html.erb`
 
 .. code:: html
     
-    <div class="post-preview">
-        <h2 class="post-title">
+    <div class="post">
+        <h2 class="title">
             <%= @post['title'] %>
         </h2>
 
-        <p class="post-meta">
+        <p class="meta">
         Posted by 
         <%= link_to("#{@post['author']['first_name']} #{@post['author']['last_name']}", blog_author_path(:author_slug => @post['author']['slug'])) %>
          on <%= @post['created'] %>
 
         <% @post['categories'].each do |category| %>
-        <span class="label label-default">
+        <span class="label">
         <%= link_to(category['name'], blog_category_path(:category_slug => category['slug'])) %>
         </span>
         <% end %>
         </p>
 
-        <p class="post-body">
+        <p class="body">
             <%= @post['body'].html_safe %>
         </p>
     </div>
@@ -99,15 +203,4 @@ Then tell Butter about this template:
     # In application.rb
     config.blog_post_template = "blog/post"
 
-
-Customize other templates
--------------------------
-You can customize other parts of the blog as well by following the same pattern. A full list of page types + settings is below:
-
-.. code:: ruby
-
-    # In application.rb
-    config.blog_home_template = "blog/home"
-    config.blog_post_template = "blog/post"
-    config.blog_author_template = "blog/author"
-    config.blog_category_template = "blog/category"
+That's it. Reload the server and you'll see your new customized blog post with comments!

data/app/controllers/buttercms/blog_controller.rb

@@ -15,7 +15,11 @@ module Buttercms
     end
 
     def get_token
-      if Rails.application.secrets.BUTTER_CMS_TOKEN
+      # Rails 3
+      if defined? Buttercms::BUTTER_CMS_TOKEN
+        return Buttercms::BUTTER_CMS_TOKEN
+      # Rails 4
+      elsif defined? Rails.application.secrets.BUTTER_CMS_TOKEN
         return Rails.application.secrets.BUTTER_CMS_TOKEN
       else
         return DEFAULT_TOKEN
@@ -28,6 +32,8 @@ module Buttercms
       rescue SocketError => e
         raise Exception.new("Unable to connect to ButterCms. Please double check your internet connection.")
       rescue => e
+        puts e.message
+
         case e.response.code
           when 404
             not_found

data/buttercms.gemspec

@@ -20,14 +20,10 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0")
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
 
-  # spec.files = Dir["{app,config,db,lib}/**/*", "MIT-LICENSE", "Rakefile", "README.rdoc"]
-  # spec.test_files = Dir["test/**/*"]
-  # spec.add_dependency "rails", "~> 4.2.1"
-
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "json"
-  spec.add_development_dependency "rest-client"
+  spec.add_dependency "bundler", "~> 1.7"
+  spec.add_dependency "rake", "~> 10.0"
+  spec.add_dependency "json"
+  spec.add_dependency "rest-client"
 
 
 end

data/lib/buttercms/version.rb

@@ -1,3 +1,3 @@
 module Buttercms
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: buttercms
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - ButterCms
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-13 00:00:00.000000000 Z
+date: 2015-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -17,7 +17,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -31,7 +31,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -45,7 +45,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -59,7 +59,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements: