buttercms-rails 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5b7d9e3d4a7a3c021b5f5722d36969dc3a923ebe
+  data.tar.gz: e0c31ec249e7275ed72c017d6d70c16c9cc0a9a7
+SHA512:
+  metadata.gz: ea18f9957675892feabc232b766c300d46a6a9e7c2451e95890a7849c8d2ce57c000d79bf34fe41cff8b9d90fdb24d8fc0ca859279a159aa113b2c903ed9497f
+  data.tar.gz: 0198992bd5ddbd2b263d12624181ae4dfbe017ebbcb22934c42e768c6d8bad9ae88d857b28f18d9d70821068d1f2025f1eb69d83135bf13970b36aad7b1eee7c

data/.gitignore

@@ -0,0 +1,44 @@
+*.rbc
+capybara-*.html
+.rspec
+/log
+/tmp
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/public/system
+/coverage/
+/spec/tmp
+/Gemfile.lock
+**.orig
+rerun.txt
+pickle-email-*.html
+
+# TODO Comment out these rules if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+config/secrets.yml
+
+## Environment normalisation:
+/.bundle
+/vendor/bundle
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv
+
+pkg/*
+*.log
+
+.DS_Store
+
+
+test/dummy/tmp/
+test/dummy/db/development.sqlite3
+test/dummy/db/production.sqlite3
+test/dummy/log/test.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec
+

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Butter
+https://buttercms.com/
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+# ButterCMS Rails SDK
+
+The ButterCMS Rails SDK provides a generator that expedites setup of your blog.
+
+### Installation
+
+To get started, first install the gem by adding it to your Gemfile:
+
+```
+gem 'buttercms-rails', '1.0.0'
+```
+
+After installing, run the genereator provided by the gem:
+
+```
+rails generate butter:install_blog
+```
+
+The generator creates an initializer file and default controllers and views:
+
+```
+|-- app
+    |-- controllers
+        |-- buttercms
+            |-- authors_controller.rb
+            |-- base_controller.rb
+            |-- categories_controller.rb
+            |-- feeds_controller.rb
+            |-- posts_controller.rb
+    |-- views
+        |-- buttercms
+            |-- authors
+                |-- show.html.erb
+            |-- categories
+                |-- show.html.erb
+            |-- posts
+                |-- _post.html.erb
+                |-- index.html.erb
+                |-- show.html.erb
+        |-- layouts
+            |-- buttercms
+                |-- default.html.erb
+
+|-- config
+    |-- initializers
+        |-- buttercms.rb
+```
+
+It also adds routes to your `routes.rb`  file:
+
+```ruby
+  scope :module => 'buttercms' do
+    get '/categories/:slug' => 'categories#show', :as => :buttercms_category
+    get '/author/:slug' => 'authors#show', :as => :buttercms_author
+
+    get '/blog/rss' => 'feeds#rss', :format => 'rss', :as => :buttercms_blog_rss
+    get '/blog/atom' => 'feeds#atom', :format => 'atom', :as => :buttercms_blog_atom
+    get '/blog/sitemap.xml' => 'feeds#sitemap', :format => 'xml', :as => :buttercms_blog_sitemap
+
+    get '/blog(/page/:page)' => 'posts#index', :defaults => {:page => 1}, :as => :buttercms_blog
+    get '/blog/:slug' => 'posts#show', :as => :buttercms_post
+  end
+```
+
+After running the generator, set your API token in `config/initializers/buttercms.rb` and then start your server to view your blog.
+
+### Customization
+
+Extending and customizing your blog is easy. The ButterCMS Rails SDK uses the [ButterCMS Ruby API Client](https://github.com/buttercms/buttercms-ruby). Email [support@buttercms.com](mailto:support@buttercms.com) for help!

data/VERSION

@@ -0,0 +1 @@
+1.0.1

data/buttercms-rails.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+require "butter/version"
+
+Gem::Specification.new do |s|
+  s.name = "buttercms-rails"
+  s.version = Butter::VERSION
+  s.required_ruby_version = '>= 1.9.3'
+  s.require_paths = ["lib"]
+  s.summary = 'A Rails gem for the buttercms.com REST API'
+  s.description = 'Butter is a blogging platform loved by engineers. See https://buttercms.com for details.'
+  s.authors = ["ButterCMS"]
+  s.email= ["support@buttercms.com"]
+  s.homepage = "https://buttercms.com/docs"
+  s.license = 'MIT'
+
+  s.add_runtime_dependency "buttercms-ruby", "~> 1.0.1"
+  s.add_development_dependency "rails", ">= 3.2.0"
+
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+end

data/lib/butter/version.rb

@@ -0,0 +1,3 @@
+module Butter
+  VERSION = "1.0.1"
+end

data/lib/buttercms-rails.rb

@@ -0,0 +1,5 @@
+require 'rails/generators'
+require "generators/butter/install_blog_generator"
+
+module Butter
+end

data/lib/generators/butter/install_blog_generator.rb

@@ -0,0 +1,39 @@
+module Butter
+  module Generators
+    class InstallBlogGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates ButterCMS initializer, controllers, views, and routes."
+      def install
+        # Create initializer
+        copy_file "config/initializers/buttercms.rb", "config/initializers/buttercms.rb"
+
+        # Create controllers
+        directory "app/controllers/buttercms", "app/controllers/buttercms"
+
+        # Create views
+        directory "app/views/buttercms", "app/views/buttercms"
+
+        # Create default layout
+        directory "app/views/layouts/buttercms", "app/views/layouts/buttercms"
+
+        # Add routes
+        route %{
+  scope :module => 'buttercms' do
+    get '/categories/:slug' => 'categories#show', :as => :buttercms_category
+    get '/author/:slug' => 'authors#show', :as => :buttercms_author
+
+    get '/blog/rss' => 'feeds#rss', :format => 'rss', :as => :buttercms_blog_rss
+    get '/blog/atom' => 'feeds#atom', :format => 'atom', :as => :buttercms_blog_atom
+    get '/blog/sitemap.xml' => 'feeds#sitemap', :format => 'xml', :as => :buttercms_blog_sitemap
+
+    get '/blog(/page/:page)' => 'posts#index', :defaults => {:page => 1}, :as => :buttercms_blog
+    get '/blog/:slug' => 'posts#show', :as => :buttercms_post
+  end
+}
+
+        puts "Success! Configure your API token in config/initializers/buttercms.rb, restart your server, and view your blog at /blog"
+      end
+    end
+  end
+end

data/lib/generators/templates/app/controllers/buttercms/authors_controller.rb

@@ -0,0 +1,5 @@
+class Buttercms::AuthorsController < Buttercms::BaseController
+  def show
+    @author = ButterCMS::Author.find(params[:slug], :include => :recent_posts)
+  end
+end

data/lib/generators/templates/app/controllers/buttercms/base_controller.rb

@@ -0,0 +1,5 @@
+class Buttercms::BaseController < ActionController::Base
+  # You can of course change this layout to your main application layout
+  # to have your blog match the rest of your site.
+  layout 'buttercms/default'
+end

data/lib/generators/templates/app/controllers/buttercms/categories_controller.rb

@@ -0,0 +1,5 @@
+class Buttercms::CategoriesController < Buttercms::BaseController
+  def show
+    @category = ButterCMS::Category.find(params[:slug], :include => :recent_posts)
+  end
+end

data/lib/generators/templates/app/controllers/buttercms/feeds_controller.rb

@@ -0,0 +1,19 @@
+class Buttercms::FeedsController < Buttercms::BaseController
+  def sitemap
+    feed = ButterCMS::Feed.find(:sitemap)
+
+    render :xml => feed.data
+  end
+
+  def atom
+    feed = ButterCMS::Feed.find(:atom)
+
+    render :xml => feed.data
+  end
+
+  def rss
+    feed = ButterCMS::Feed.find(:rss)
+
+    render :xml => feed.data
+  end
+end

data/lib/generators/templates/app/controllers/buttercms/posts_controller.rb

@@ -0,0 +1,15 @@
+class Buttercms::PostsController < Buttercms::BaseController
+  def index
+    @posts = ButterCMS::Post.all(:page => params[:page], :page_size => 10)
+
+    @next_page = @posts.meta.next_page
+    @previous_page = @posts.meta.previous_page
+  end
+
+  def show
+    @post = ButterCMS::Post.find(params[:slug])
+
+    @next_post = @post.meta.next_post
+    @previous_post = @post.meta.previous_post
+  end
+end

data/lib/generators/templates/app/views/buttercms/authors/show.html.erb

@@ -0,0 +1,17 @@
+<%= content_for :html_title, "#{@author.first_name} #{@author.last_name}" %>
+<%= content_for :meta_description, @author.bio %>
+
+<!-- Author name -->
+<h2><%= @author.first_name %> <%= @author.last_name %></h2>
+
+<!-- Author profile -->
+<div>
+  <%= @author.title %>
+  <%= @author.bio %>
+</div>
+
+<!-- Recent posts -->
+<h4>Recent posts</h4>
+<% @author.recent_posts.each do |post| %>
+  <%= render :partial => 'buttercms/posts/post', :locals => {:post => post} %>
+<% end %>

data/lib/generators/templates/app/views/buttercms/categories/show.html.erb

@@ -0,0 +1,10 @@
+<%= content_for :html_title, @category.name %>
+
+<!-- Category name -->
+<h2><%= @category.name %></h2>
+
+<!-- Recent posts -->
+<h4>Recent posts</h4>
+<% @category.recent_posts.each do |post| %>
+  <%= render :partial => 'buttercms/posts/post', :locals => {:post => post} %>
+<% end %>

data/lib/generators/templates/app/views/buttercms/posts/_post.html.erb

@@ -0,0 +1,18 @@
+<div>
+  <!-- Featured image -->
+  <%= image_tag(post.featured_image) if post.featured_image %>
+
+  <!-- Post title -->
+  <%= link_to post.title, buttercms_post_path(post.slug), :title => post.title %>
+
+  <!-- Post author -->
+  <%= link_to "#{post.author.first_name} #{post.author.last_name}", buttercms_author_path(post.author.slug) %>
+
+  <!-- Post summary -->
+  <%= post.summary %>
+
+  <!-- Post categories -->
+  <% post.categories.each do |category| %>
+    <%= link_to category.name, buttercms_category_path(category.slug), :title => category.name %>
+  <% end %>
+</div>

data/lib/generators/templates/app/views/buttercms/posts/index.html.erb

@@ -0,0 +1,17 @@
+<h2>Posts</h2>
+
+<!-- List of posts -->
+<% @posts.each do |post| %>
+  <%= render :partial => 'post', :locals => {:post => post} %>
+<% end %>
+
+<!-- Pagination links -->
+<div>
+  <% if @previous_page %>
+    <%= link_to "Prev", buttercms_blog_path(:page => @previous_page) %>
+  <% end %>
+
+  <% if @next_page %>
+    <%= link_to "Next", buttercms_blog_path(:page => @next_page) %>
+  <% end %>
+</div>

data/lib/generators/templates/app/views/buttercms/posts/show.html.erb

@@ -0,0 +1,42 @@
+<%= content_for :html_title, @post.seo_title %>
+<%= content_for :meta_description, @post.meta_description %>
+
+<!-- Post title -->
+<h2><%= @post.title %></h2>
+
+<!-- Post author -->
+<%= link_to "#{@post.author.first_name} #{@post.author.last_name}", buttercms_author_path(@post.author.slug) %>
+
+<!-- Post categories -->
+<% @post.categories.each do |category| %>
+  <%= link_to category.name, buttercms_category_path(category.slug), :title => category.name %>
+<% end %>
+
+<!-- Publish date -->
+<%= @post.published %>
+
+<!-- Post body -->
+<%= @post.body.html_safe %>
+
+<!-- Link to Next Post -->
+<% if @next_post %>
+  <%= link_to @next_post.title, buttercms_post_path(@next_post.slug), :title => @next_post.title %>
+<% end %>
+
+<!--
+// For commenting, we recommend https://disqus.com/
+// Create a Disqus account and paste your snippet below
+
+<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>
+-->

data/lib/generators/templates/app/views/layouts/buttercms/default.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <title><%= content_for?(:html_title) ? "#{content_for(:html_title)} | My Blog" : "My Blog" %></title>
+
+    <meta name="description" content="<%= content_for?(:meta_description) ? content_for(:meta_description) : "My Blog" %>">
+
+    <link rel="alternate" type="application/atom+xml" title="My Blog - Atom" href="<%= buttercms_blog_atom_path %>">
+    <link rel="alternate" type="application/rss+xml" title="My Blog - RSS" href="<%= buttercms_blog_rss_path %>">
+</head>
+<body>
+    <%= link_to "Blog home", buttercms_blog_path %>
+
+    <%= yield %>
+</body>
+</html>

data/lib/generators/templates/config/initializers/buttercms.rb

@@ -0,0 +1,6 @@
+require 'buttercms-ruby'
+
+# If you added the Heroku Butter add-on, ENV["BUTTER_TOKEN"] will be defined.
+# Otherwise, grab your token at https://buttercms.com/profile/ and either set it below
+# or in an environment variable.
+ButterCMS::api_token = ENV['BUTTER_TOKEN']

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: buttercms-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- ButterCMS
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: buttercms-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: Butter is a blogging platform loved by engineers. See https://buttercms.com
+  for details.
+email:
+- support@buttercms.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- VERSION
+- buttercms-rails.gemspec
+- lib/butter/version.rb
+- lib/buttercms-rails.rb
+- lib/generators/butter/install_blog_generator.rb
+- lib/generators/templates/app/controllers/buttercms/authors_controller.rb
+- lib/generators/templates/app/controllers/buttercms/base_controller.rb
+- lib/generators/templates/app/controllers/buttercms/categories_controller.rb
+- lib/generators/templates/app/controllers/buttercms/feeds_controller.rb
+- lib/generators/templates/app/controllers/buttercms/posts_controller.rb
+- lib/generators/templates/app/views/buttercms/authors/show.html.erb
+- lib/generators/templates/app/views/buttercms/categories/show.html.erb
+- lib/generators/templates/app/views/buttercms/posts/_post.html.erb
+- lib/generators/templates/app/views/buttercms/posts/index.html.erb
+- lib/generators/templates/app/views/buttercms/posts/show.html.erb
+- lib/generators/templates/app/views/layouts/buttercms/default.html.erb
+- lib/generators/templates/config/initializers/buttercms.rb
+homepage: https://buttercms.com/docs
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: A Rails gem for the buttercms.com REST API
+test_files: []