buttercms 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93c8abdd5de9af65a95f692c1f3476bee23346a9
-  data.tar.gz: 49b2f0ed710503c5703cb86618aa9970f2c6a8ad
+  metadata.gz: 16e84fc7ba404ed82a8945ad1495498a03c3f2eb
+  data.tar.gz: dd9ac538f9700cf0c03b3ce82ce1c4a23601c7e6
 SHA512:
-  metadata.gz: 034030908557fda92ec5ae37868d821db406264738adf7274ebe0af7693bc1537aca26b9e58420c929822a6b7ee3b6ef3ea77696d8f30779f7eaac1986a7192d
-  data.tar.gz: a04979ccac4f823f9ef932642a11ab0256ae9eaf0c5b1f4dbee5d9c3f1c06c55d87388bba2e1f2f11d1cd39828dd0bd999303946af95f80519458dba6aa4e8aa
+  metadata.gz: 538bba2499246d2d1207729d7646812256781829259843814200232075fade6afd9f8eac4393e9f77d06aabb5322d1fe062b66cdaf776bda64d06837ac488965
+  data.tar.gz: 2da147dda13d145808a6543a17779d0eecca85d211af52a776fbba5bbf64af8ae7eb83c8fcf6fa355edfa276adf14245f572825cf2b7750623e212fd9d2b7cd1

data/README.rst

@@ -28,7 +28,7 @@ Add buttercms gem to your Gemfile and install it.
 
     $ gem install buttercms
 
-Now run the Butter install generator. This will create `config/initializers/butter.rb` and define a route in `config/routes.rb`. By default, your blog will live at "/blog".
+Now run the Butter install generator. This will setup a `butter.rb` initializer, which provides many customization options, and defines a route in `config/routes.rb`. By default, your blog will live at "/blog".
 
 .. code-block:: bash
 
@@ -38,87 +38,27 @@ Grab your API token from https://buttercms.com/api_token and throw it in `config
 
 That's it! You’ve now got a blog running natively in your Rails project.
 
-Check it out: localhost:3000/blog
+Check it out: http://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
 =====================
 
+Open `initializers/butter.rb` to see the full set of options available for 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.
+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.layout` in `initializers/butter.rb`
 
 .. code:: ruby
 
-    # In application.rb (or an initializer like constants.rb)
-    config.blog_layout = "<your_blog_layout>"
+    # In initializers/butter.rb
+    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 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 http://localhost:3000/blog and you'll see your new branded blog!
 
 Customizing the view templates
 ------------------------------
@@ -126,11 +66,11 @@ You can customize any view of your blog. Here is full list of page types + setti
 
 .. 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"
+    # 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`
 
@@ -175,7 +115,70 @@ Then tell Butter about this template:
 
 .. code:: ruby
 
-    # In application.rb
-    config.blog_post_template = "blog/post"
+    # 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!
+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/application_controller.rb

@@ -4,11 +4,11 @@ module Buttercms
 
     def get_layout
       if defined? Buttercms.configuration
-        if defined? Buttercms.configuration.blog_layout
-          return Buttercms.configuration.blog_layout
+        if defined? Buttercms.configuration.layout
+          return Buttercms.configuration.layout
         end
       end
-      
+
       # Default to the included layout.
     end
   end

data/app/controllers/buttercms/blog_controller.rb

@@ -60,8 +60,8 @@ module Buttercms
       @recent_posts = response_json['results']
 
       if defined? Buttercms.configuration
-        if !Buttercms.configuration.blog_home_template.nil?
-          render template: Buttercms.configuration.blog_home_template
+        if !Buttercms.configuration.home_template.nil?
+          render template: Buttercms.configuration.home_template
         end
       end
     end
@@ -71,8 +71,8 @@ module Buttercms
       @post = JSON.parse(response)
 
       if defined? Buttercms.configuration
-        if !Buttercms.configuration.blog_post_template.nil?
-          render template: Buttercms.configuration.blog_post_template
+        if !Buttercms.configuration.post_template.nil?
+          render template: Buttercms.configuration.post_template
         end
       end
     end
@@ -85,8 +85,8 @@ module Buttercms
       @recent_posts = response_json['recent_posts']
 
       if defined? Buttercms.configuration
-        if !Buttercms.configuration.blog_author_template.nil?
-          render template: Buttercms.configuration.blog_author_template
+        if !Buttercms.configuration.author_template.nil?
+          render template: Buttercms.configuration.author_template
         end
       end
     end
@@ -98,8 +98,8 @@ module Buttercms
       @recent_posts = response_json['recent_posts']
 
       if defined? Buttercms.configuration
-        if !Buttercms.configuration.blog_category_template.nil?
-          render template: Buttercms.configuration.blog_category_template
+        if !Buttercms.configuration.category_template.nil?
+          render template: Buttercms.configuration.category_template
         end
       end
     end

data/lib/buttercms.rb

@@ -11,7 +11,7 @@ module Buttercms
   end
 
   class Configuration
-    attr_accessor :token, :blog_layout, :blog_home_template, :blog_post_template, :blog_author_template, :blog_category_template
+    attr_accessor :token, :layout, :home_template, :post_template, :author_template, :category_template
 
     def initialize
       # Displays a default blog post with instructions on getting a personal token.

data/lib/buttercms/version.rb

@@ -1,3 +1,3 @@
 module Buttercms
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: buttercms
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - ButterCms