buttercms 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45e2252eee39b31c0a91efb2dfeeeeac7e305a95
-  data.tar.gz: 8e33b39e32a8dac8806b84297af2554b7aa6d697
+  metadata.gz: 3244e5e1565d4a57f022236036ce1950e27744f2
+  data.tar.gz: fc3fbffba109a913e350b518f58309f35ff4bbbe
 SHA512:
-  metadata.gz: c52380177f1a93f317d6dbb7dcc56996c2838a9d335c3e7a21314310f71fb5ae76fdc78ad3312d5a44ea717602124b6bb1da9afb79dfb428f90576169ae41b04
-  data.tar.gz: 911ee20a90c3887948b13fe4d3a8a2f7dc95b4e3049154412fca87d51274f8686273698ad3431875c0b226e05f793d66da1659d82637169c05bfb71c49112710
+  metadata.gz: 2b5c1fdcd7884125147391c7c03d99d8b507226caeb1037ca872126c29d1f0cdcf480abbd489b30140c49b4766f296c4d68a2004eb37e84c4d444919b6a73b75
+  data.tar.gz: 07aed0d6394defb4db0c39672095981cceee77936d6c60e5ef6378463aaeb47973d763d46f23193b37ec1d415ff75343bde248d0bc043115c11e0bbf3313d71e

data/README.rst

@@ -59,126 +59,3 @@ We've provided a default layout but we expect you'll want the blog to appear you
     config.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 http://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 initializers/butter.rb
-    config.home_template = "blog/home"
-    config.post_template = "blog/post"
-    config.author_template = "blog/author"
-    config.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: `views/blog/post.html.erb`
-
-.. code:: html
-    
-    <div class="post">
-        <h2 class="title">
-            <%= @post['title'] %>
-        </h2>
-
-        <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">
-        <%= link_to(category['name'], blog_category_path(:category_slug => category['slug'])) %>
-        </span>
-        <% end %>
-        </p>
-
-        <p class="body">
-            <%= @post['body'].html_safe %>
-        </p>
-    </div>
-
-    <hr>
-
-    <!-- Paste your Disqus embed code here --->
-
-Then tell Butter about this template:
-
-.. code:: ruby
-
-    # In initializers/butter.rb
-    config.post_template = "blog/post"
-
-That's it. Reload the server and you'll see your new customized blog post with comments!
-
-
-==========================
-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

data/app/controllers/buttercms/blog_controller.rb

@@ -95,22 +95,14 @@ module Buttercms
       @previous_page = response_json['previous_page']
       @recent_posts = response_json['results']
 
-      if defined? Buttercms.configuration
-        if !Buttercms.configuration.home_template.nil?
-          render template: Buttercms.configuration.home_template
-        end
-      end
+      render template: "blog/home"
     end
 
     def butter_post
       response = make_butter_request("#{API_URL}posts/#{params[:slug]}")
       @post = JSON.parse(response)
 
-      if defined? Buttercms.configuration
-        if !Buttercms.configuration.post_template.nil?
-          render template: Buttercms.configuration.post_template
-        end
-      end
+      render template: "blog/post"
     end
 
     def butter_author
@@ -121,11 +113,7 @@ module Buttercms
       @email = response_json['email']
       @recent_posts = response_json['recent_posts']
 
-      if defined? Buttercms.configuration
-        if !Buttercms.configuration.author_template.nil?
-          render template: Buttercms.configuration.author_template
-        end
-      end
+      render template: "blog/author"
     end
 
     def butter_category
@@ -134,11 +122,7 @@ module Buttercms
       @name = response_json['name']
       @recent_posts = response_json['recent_posts']
 
-      if defined? Buttercms.configuration
-        if !Buttercms.configuration.category_template.nil?
-          render template: Buttercms.configuration.category_template
-        end
-      end
+      render template: "blog/category"
     end
   end
 end

data/lib/buttercms/version.rb

@@ -1,3 +1,3 @@
 module Buttercms
-  VERSION = "0.1.8"
+  VERSION = "0.1.9"
 end

data/lib/generators/buttercms/install_generator.rb

@@ -2,13 +2,22 @@ module Buttercms
   module Generators
     class InstallGenerator < Rails::Generators::Base
       source_root File.expand_path("../../templates", __FILE__)
-      desc "Creates Buttercms initializer for your application"
+      desc "Creates Butter initializer and blog views for your application."
 
       def copy_initializer
-        template "butter_initializer.rb", "config/initializers/butter.rb"
-        route "mount Buttercms::Engine => '/blog'"
+        puts "Copying blog templates into app/views/blog/"
+        copy_file "home.html.erb", "app/views/blog/home.html.erb"
+        copy_file "post.html.erb", "app/views/blog/post.html.erb"
+        copy_file "author.html.erb", "app/views/blog/author.html.erb"
+        copy_file "category.html.erb", "app/views/blog/category.html.erb"
+        copy_file "_pagers.html.erb", "app/views/blog/_pagers.html.erb"
+        copy_file "_post.html.erb", "app/views/blog/_post.html.erb"
+        puts "Success"
 
-        puts "Butter token and route installed! See your blog at localhost:3000/blog"
+        puts "Installing ButterCMS API token and /blog route."
+        copy_file "butter_initializer.rb", "config/initializers/butter.rb"
+        route "mount Buttercms::Engine => '/blog'"
+        puts "Success! View your blog at localhost:3000/blog"
       end
     end
   end

data/{app/views/buttercms/blog → lib/generators/templates}/_pagers.html.erb

@@ -1,6 +1,6 @@
 <ul class="pager">
   <% if next_page %>
-  <li class="previous">
+  <li class="next">
     <%= link_to("&larr; Older Posts".html_safe, archive_path(:page => next_page)) %>
   </li>
   <% end %>

data/{app/views/buttercms/blog → lib/generators/templates}/_post.html.erb

@@ -6,7 +6,7 @@
   <p class="post-meta">
     Posted by 
     <%= link_to("#{post['author']['first_name']} #{post['author']['last_name']}", blog_author_path(:author_slug => post['author']['slug'])) %>
-    on <%= post['created'] %>
+    on <%= post['published'] %>
 
     <% post['categories'].each do |category| %>
     <span class="label label-default">

data/lib/generators/templates/author.html.erb

@@ -0,0 +1,3 @@
+<h2>Recent posts from  <%=@first_name %> <%=@last_name %> (<%=@email %>)</h2>
+
+<%= render partial: "blog/post", collection: @recent_posts %>

data/lib/generators/templates/butter_initializer.rb

@@ -8,20 +8,4 @@ Buttercms.configure do |config|
   # For example uncomment the line below and define the layout in /view/layout/blog.html.erb
   # You can of course also use your existing main application layout.
   # config.layout = "blog"
-
-
-  # You can customize any view of your blog. Here is full list of page types + settings.
-  # We recommend putting custom templates in views/blog/<template>.html.erb
-
-  # This is the blog home page. Route: /blog
-  # config.home_template = "blog/home"
-
-  # This is the blog post page. Route: /blog/:post-slug
-  # config.post_template = "blog/post"
-
-  # This is the author page. Route: /blog/author/:author-slug
-  # config.author_template = "blog/author"
-
-  # This is the category page. Route: /blog/category/:category-slug
-  # config.category_template = "blog/category"
 end

data/lib/generators/templates/category.html.erb

@@ -0,0 +1,3 @@
+<h2>Recent <%=@name %> posts</h2>
+
+<%= render partial: "blog/post", collection: @recent_posts %>

data/lib/generators/templates/home.html.erb

@@ -0,0 +1,3 @@
+<%= render partial: "blog/post", collection: @recent_posts %>
+
+<%= render partial: "blog/pagers", locals: {next_page: @next_page, previous_page: @previous_page} %>

data/lib/generators/templates/post.html.erb

@@ -0,0 +1,76 @@
+<!--
+For reference, @post has the following attributes:
+
+"url": "https://buttercms.com/blog/the-state-of-company-blogs",
+"created": "05/16/2015",
+"published": "05/16/2015",
+"author": {
+    "first_name": "Butter",
+    "last_name": "Cms",
+    "email": "buttercms@example.com",
+    "slug": "butter-cms"
+},
+"categories": [
+    {
+    "name": "blogs",
+    "slug": "blogs"
+    },
+    {
+    "name": "butter",
+    "slug": "butter"
+    }
+],
+"slug": "the-state-of-company-blogs",
+"title": "The State of Company Blogs",
+"featured_image": "http://www.example.com/image.png",
+"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"
+-->
+
+<div class="post-preview">
+    <h2 class="post-title">
+        <%= @post['title'] %>
+    </h2>
+
+    <p class="post-meta">
+    Posted by 
+    <%= link_to("#{@post['author']['first_name']} #{@post['author']['last_name']}", 
+        blog_author_path(:author_slug => @post['author']['slug'])) %>
+     on 
+     <%= @post['published'] %>
+
+    <% @post['categories'].each do |category| %>
+        <span class="label label-default">
+            <%= link_to(category['name'], blog_category_path(:category_slug => category['slug'])) %>
+        </span>
+    <% end %>
+    </p>
+
+    <p class="post-body">
+        <%= @post['body'].html_safe %>
+    </p>
+</div>
+
+
+<!-- 
+// For post comments, we recommend https://disqus.com/ 
+// Create a Disqus account and paste your embed code below.
+// Here's a sample
+<hr>
+
+<div id="disqus_thread"></div>
+<script type="text/javascript">
+    /* * * CONFIGURATION VARIABLES * * */
+    var disqus_shortname = 'XXXXXXXX';
+    
+    /* * * DON'T EDIT BELOW THIS LINE * * */
+    (function() {
+        var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
+        dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
+        (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
+    })();
+</script>
+-->
+
+</div>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: buttercms
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - ButterCms
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-16 00:00:00.000000000 Z
+date: 2015-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -85,12 +85,6 @@ files:
 - app/assets/stylesheets/buttercms/application.css
 - app/controllers/buttercms/blog_controller.rb
 - app/helpers/buttercms/application_helper.rb
-- app/views/buttercms/blog/_pagers.html.erb
-- app/views/buttercms/blog/_post.html.erb
-- app/views/buttercms/blog/butter_author.html.erb
-- app/views/buttercms/blog/butter_category.html.erb
-- app/views/buttercms/blog/butter_home.html.erb
-- app/views/buttercms/blog/butter_post.html.erb
 - app/views/layouts/buttercms/application.html.erb
 - buttercms.gemspec
 - config/routes.rb
@@ -98,7 +92,13 @@ files:
 - lib/buttercms/engine.rb
 - lib/buttercms/version.rb
 - lib/generators/buttercms/install_generator.rb
+- lib/generators/templates/_pagers.html.erb
+- lib/generators/templates/_post.html.erb
+- lib/generators/templates/author.html.erb
 - lib/generators/templates/butter_initializer.rb
+- lib/generators/templates/category.html.erb
+- lib/generators/templates/home.html.erb
+- lib/generators/templates/post.html.erb
 - lib/tasks/buttercms_tasks.rake
 - test/buttercms_test.rb
 - test/integration/navigation_test.rb

data/app/views/buttercms/blog/butter_author.html.erb

@@ -1,3 +0,0 @@
-<h2>Recent posts from  <%=@first_name %> <%=@last_name %></h2>
-
-<%= render partial: "post", collection: @recent_posts %>

data/app/views/buttercms/blog/butter_category.html.erb

@@ -1,3 +0,0 @@
-<h2>Recent <%=@name %> posts</h2>
-
-<%= render partial: "post", collection: @recent_posts %>

data/app/views/buttercms/blog/butter_home.html.erb

@@ -1,3 +0,0 @@
-<%= render partial: "post", collection: @recent_posts %>
-
-<%= render partial: "pagers", locals: {next_page: @next_page, previous_page: @previous_page} %>

data/app/views/buttercms/blog/butter_post.html.erb

@@ -1,22 +0,0 @@
-<div class="post-preview">
-
-    <h2 class="post-title">
-        <%= @post['title'] %>
-    </h2>
-
-    <p class="post-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">
-    <%= link_to(category['name'], blog_category_path(:category_slug => category['slug'])) %>
-    </span>
-    <% end %>
-    </p>
-
-    <p class="post-body">
-        <%= @post['body'].html_safe %>
-    </p>
-</div>