buttercms 0.0.8 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8cfd9c6d155d1d6af4e7ce36410d02caec5f155
-  data.tar.gz: 3e7eea1416ff87e322a4af8c55f63741a4e8c46c
+  metadata.gz: 93c8abdd5de9af65a95f692c1f3476bee23346a9
+  data.tar.gz: 49b2f0ed710503c5703cb86618aa9970f2c6a8ad
 SHA512:
-  metadata.gz: 67b0cc540d0b9c3ea17fbaac22cc2712b1d173fdeb7c6c94900412d239635f92da05200747c3acb94923090179e288012cae745b88bb9ce9299702e028a63dba
-  data.tar.gz: c92fce92b78b7989aef456e793433957e1087dade9fa5bd39b5c051772e47543ec2a4e1042d0ed6ffb9832c9f36acb32682eededaea28a144f552089a3759e71
+  metadata.gz: 034030908557fda92ec5ae37868d821db406264738adf7274ebe0af7693bc1537aca26b9e58420c929822a6b7ee3b6ef3ea77696d8f30779f7eaac1986a7192d
+  data.tar.gz: a04979ccac4f823f9ef932642a11ab0256ae9eaf0c5b1f4dbee5d9c3f1c06c55d87388bba2e1f2f11d1cd39828dd0bd999303946af95f80519458dba6aa4e8aa

data/README.rst

@@ -28,40 +28,15 @@ Add buttercms gem to your Gemfile and install it.
 
     $ gem install buttercms
 
-Mount the Buttercms engine in your config/routes.rb and define your blog path.
+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".
 
-.. code-block:: ruby
-
-    # In config/routes.rb
-    mount Buttercms::Engine => "/blog"
-
-Grab your API token from https://buttercms.com/api_token
-
-**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:
-    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
+.. code-block:: bash
 
-    # In config/initializers/butter.rb
-    Buttercms::BUTTER_CMS_TOKEN = <your_api_token>
+    $ rails g buttercms:install
 
+Grab your API token from https://buttercms.com/api_token and throw it in `config/initializers/butter.rb` or set it on your ENV like so `$ export BUTTER_TOKEN=yourtokenhere"`
 
-Nice job. You've now got a blog running natively in your Rails project. Nothing but Ruby goodness. (No PHP scripts here ;))
+That's it! You’ve now got a blog running natively in your Rails project.
 
 Check it out: localhost:3000/blog
 

data/app/controllers/buttercms/application_controller.rb

@@ -3,11 +3,13 @@ module Buttercms
     layout :get_layout
 
     def get_layout
-      begin
-        Rails.application.config.blog_layout
-      rescue NoMethodError
-        # Default to the included layout.
+      if defined? Buttercms.configuration
+        if defined? Buttercms.configuration.blog_layout
+          return Buttercms.configuration.blog_layout
+        end
       end
+      
+      # Default to the included layout.
     end
   end
 end

data/app/controllers/buttercms/blog_controller.rb

@@ -4,8 +4,6 @@ require 'rest-client'
 
 module Buttercms
 
-  # Displays a default blog post with instructions on getting a personal token.
-  DEFAULT_TOKEN = 'f97d131d955f48af0769a4c827bb47728cbd5d05'
   API_URL = 'https://buttercms.com/api/'
 
   class BlogController < ApplicationController
@@ -15,15 +13,15 @@ module Buttercms
     end
 
     def get_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
+      
+      # Make sure the Buttercms has been initialized.
+      if defined? Buttercms.configuration
+        if defined? Buttercms.configuration.token
+          return Buttercms.configuration.token
+        end
       end
+
+      raise Exception.new("/config/intitializer/butter.rb is missing. Please run $ rails g buttercms:install")
     end
 
     def make_request(path)
@@ -61,10 +59,10 @@ module Buttercms
       @previous_page = response_json['previous_page']
       @recent_posts = response_json['results']
 
-      begin
-        # Check for overridden template.
-        render template: Rails.application.config.blog_home_template
-      rescue NoMethodError 
+      if defined? Buttercms.configuration
+        if !Buttercms.configuration.blog_home_template.nil?
+          render template: Buttercms.configuration.blog_home_template
+        end
       end
     end
 
@@ -72,11 +70,10 @@ module Buttercms
       response = make_request("#{API_URL}posts/#{params[:slug]}")
       @post = JSON.parse(response)
 
-      begin
-        # Check for overridden template.
-        render template: Rails.application.config.blog_post_template
-      rescue NoMethodError 
-        # Default to normal blog post template.
+      if defined? Buttercms.configuration
+        if !Buttercms.configuration.blog_post_template.nil?
+          render template: Buttercms.configuration.blog_post_template
+        end
       end
     end
 
@@ -87,10 +84,10 @@ module Buttercms
       @last_name = response_json['last_name']
       @recent_posts = response_json['recent_posts']
 
-      begin
-        # Check for overridden template.
-        render template: Rails.application.config.blog_author_template
-      rescue NoMethodError 
+      if defined? Buttercms.configuration
+        if !Buttercms.configuration.blog_author_template.nil?
+          render template: Buttercms.configuration.blog_author_template
+        end
       end
     end
 
@@ -100,10 +97,10 @@ module Buttercms
       @name = response_json['name']
       @recent_posts = response_json['recent_posts']
 
-      begin
-        # Check for overridden template.
-        render template: Rails.application.config.blog_category_template
-      rescue NoMethodError 
+      if defined? Buttercms.configuration
+        if !Buttercms.configuration.blog_category_template.nil?
+          render template: Buttercms.configuration.blog_category_template
+        end
       end
     end
   end

data/lib/buttercms.rb

@@ -1,5 +1,21 @@
 require "buttercms/engine"
 
 module Buttercms
-    # Some engines choose to use this file to put global configuration options for their engine. It's a relatively good idea, so if you want to offer configuration options, the file where your engine's module is defined is perfect for that. Place the methods inside the module and you'll be good to go.
-end
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :token, :blog_layout, :blog_home_template, :blog_post_template, :blog_author_template, :blog_category_template
+
+    def initialize
+      # Displays a default blog post with instructions on getting a personal token.
+      @token = 'f97d131d955f48af0769a4c827bb47728cbd5d05'
+    end
+  end
+end

data/lib/buttercms/version.rb

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

data/lib/generators/buttercms/install_generator.rb

@@ -0,0 +1,15 @@
+module Buttercms
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      desc "Creates Buttercms initializer for your application"
+
+      def copy_initializer
+        template "butter_initializer.rb", "config/initializers/butter.rb"
+        route "mount Buttercms::Engine => '/blog'"
+
+        puts "Butter token and route installed! See your blog at localhost:3000/blog"
+      end
+    end
+  end
+end

data/lib/generators/templates/butter_initializer.rb

@@ -0,0 +1,27 @@
+Buttercms.configure do |config|
+  # If you added the Heroku Butter add-on, ENV["BUTTER_TOKEN"] will be defined.
+  # Otherwise, grab your token at https://buttercms.com/api_token and either
+  # paste it below or set it on your ENV like so: $ export BUTTER_TOKEN=yourtokenhere"
+  config.token = ENV["BUTTER_TOKEN"]
+
+  # Specify a custom layout for your blog so it matches the rest of your site.
+  # 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: buttercms
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.1
 platform: ruby
 authors:
 - ButterCms
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-26 00:00:00.000000000 Z
+date: 2015-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,6 +100,8 @@ files:
 - lib/buttercms.rb
 - lib/buttercms/engine.rb
 - lib/buttercms/version.rb
+- lib/generators/buttercms/install_generator.rb
+- lib/generators/templates/butter_initializer.rb
 - lib/tasks/buttercms_tasks.rake
 - test/buttercms_test.rb
 - test/integration/navigation_test.rb