buttercms 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7cb03623d267a31f33e523cc55a1e4ac0cf069ba
-  data.tar.gz: 6b03e44d81a54578cb2ceb3efd06b1072aa15928
+  metadata.gz: 93b6a0e0792ce8b2169b4667e7b9ec9c9dd14de5
+  data.tar.gz: f800f177dca63d6ae49f47c572339de495e0b31f
 SHA512:
-  metadata.gz: cd284525b8af3361ed2635bd8b4ef3337b318352c4f9104bce12b0b60467f50549c2ec39653573aa1394e73d1cb8ff9dedb63d7f2aa2ba16f4670ec9c21bbd99
-  data.tar.gz: 8bd51b1f960943058dcfb088f0bddac206290c7ba5ad67f7d3828e9daff41293ada5e8f3f3ce4bcfadd7ed2e52332ee59277f16bcf4dc5d70051652d482f6d72
+  metadata.gz: 7e24e9f5b41556dc688da01f17ffb074371fa42b44caa22dbaf182c8ff539f998abb26d8258dd21ab59eeb6c1778b4532767f017bb3bb0444f6da2f3a9aade0b
+  data.tar.gz: e758cff407b66f481f8e6988c22a9c37cb9ed1cfefccd2adb00753c79aded5edbe97f0919532fec7fe9edbf2b934140707afeae52ec77ef611b48a67ee79a06b

data/.gitignore

@@ -33,3 +33,5 @@ bower.json
 
 # Ignore pow environment settings
 .powenv
+
+pkg/*

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in buttercms.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]
+

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    buttercms (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    domain_name (0.5.24)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    json (1.8.2)
+    mime-types (2.4.3)
+    netrc (0.10.3)
+    rake (10.4.2)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  buttercms!
+  json
+  rake (~> 10.0)
+  rest-client

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Jake Lumetta
+
+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.rst

@@ -0,0 +1,60 @@
+Butter CMS for Rails
+=========================
+
+https://www.buttercms.com
+
+**Why Butter?**
+
+Butter makes setting up a professional company blog on Rails insanely easy. It's built for developers to save us from hosting, DB setup, themeing, maintaining yet another Wordpress install. It's designed to be quickly integrated to an existing Rails project.
+
+Butter provides a user friendly blogging UI, hosted on buttercms.com, and exposes content created via an API.
+
+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
+
+    # In Gemfile
+    gem 'buttercms'
+
+.. code-block:: bash
+
+    $ gem install buttercms
+
+Mount the Buttercms engine in your config/routes.rb and define your blog path.
+
+.. code-block:: ruby
+
+    # In config/routes.rb
+    mount Buttercms::Engine => "/blog"
+
+Grab your API token from https://buttercms.com/api_token
+
+.. code:: ruby
+
+    # In config/secrets.yml
+    # Add your BUTTER_CMS_TOKEN to both development: and production:
+    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 ;))
+
+Check it out! localhost:3000/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.
+
+.. code:: ruby
+
+    # In application.rb (or an initializer like constants.rb)
+    config.blog_layout = "<your_main_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 professional branded blog!
+
+Log into https://buttercms.com/ to start blogging!

data/Rakefile

@@ -0,0 +1,39 @@
+require "bundler/gem_tasks"
+
+# begin
+#   require 'bundler/setup'
+# rescue LoadError
+#   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+# end
+
+# require 'rdoc/task'
+
+# RDoc::Task.new(:rdoc) do |rdoc|
+#   rdoc.rdoc_dir = 'rdoc'
+#   rdoc.title    = 'Buttercms'
+#   rdoc.options << '--line-numbers'
+#   rdoc.rdoc_files.include('README.rdoc')
+#   rdoc.rdoc_files.include('lib/**/*.rb')
+# end
+
+# APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+# load 'rails/tasks/engine.rake'
+
+
+# load 'rails/tasks/statistics.rake'
+
+
+
+# Bundler::GemHelper.install_tasks
+
+# require 'rake/testtask'
+
+# Rake::TestTask.new(:test) do |t|
+#   t.libs << 'lib'
+#   t.libs << 'test'
+#   t.pattern = 'test/**/*_test.rb'
+#   t.verbose = false
+# end
+
+
+# task default: :test

data/app/assets/javascripts/buttercms/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/buttercms/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/buttercms/application_controller.rb

@@ -0,0 +1,13 @@
+module Buttercms
+  class ApplicationController < ActionController::Base
+    layout :get_layout
+
+    def get_layout
+      begin
+        Rails.application.config.blog_layout
+      rescue NoMethodError
+        # Default to the included layout.
+      end
+    end
+  end
+end

data/app/controllers/buttercms/blog_controller.rb

@@ -0,0 +1,56 @@
+require 'json'
+require 'rest-client'
+
+
+module Buttercms
+
+  # Displays a default blog post with instructions on getting a personal token.
+  DEFAULT_TOKEN = '6d7505c309afd84e80d806e8e2cb91be12b896ad'
+  API_URL = 'https://buttercms.com/api/'
+
+  class BlogController < ApplicationController
+
+    def not_found
+      raise ActionController::RoutingError.new('Not Found')
+    end
+
+    def get_token
+      if Rails.application.secrets.BUTTER_CMS_TOKEN
+        return Rails.application.secrets.BUTTER_CMS_TOKEN
+      else
+        return DEFAULT_TOKEN
+      end
+    end
+
+    def make_request(path)
+      begin
+        response = RestClient.get path, {:Authorization => "Token #{get_token}"}
+      rescue SocketError => e
+        raise Exception.new("Unable to connect to ButterCms. Please double check your internet connection.")
+      rescue => e
+        case e.response.code
+          when 404
+            not_found
+          when 401
+            raise Exception.new("This token has not been registered. Please register one @ https://buttercms.com/api_token/")
+          else
+            raise Exception.new("An error occured retrieving blog. Please try again later.")
+          end
+      end
+
+      return response
+    end
+
+    def home
+      response = make_request("#{API_URL}posts/")
+      @recent_posts = JSON.parse(response)
+    end
+
+    def post
+      response = make_request("#{API_URL}posts/#{params[:slug]}")
+      @blog_post = JSON.parse(response)
+    end
+  end
+end
+
+

data/app/helpers/buttercms/application_helper.rb

@@ -0,0 +1,4 @@
+module Buttercms
+  module ApplicationHelper
+  end
+end

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

@@ -0,0 +1,14 @@
+<% @recent_posts.each do |post| %>
+  <div class="post-preview">
+      <h2 class="post-title">
+        <%= link_to(post['title'], blog_post_path(:slug => post['slug'])) %>
+      </h2>
+
+      <p class="post-meta">Posted by <%= post['author']['first_name'] %> <%= post['author']['last_name'] %> on <%= post['created'] %></p>
+
+      <p class="post-summary">
+          <%= post['summary'] %>
+      </p>
+  </div>
+  <hr>
+<% end %>

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

@@ -0,0 +1,12 @@
+<div class="post-preview">
+
+    <h2 class="post-title">
+        <%= @blog_post['title'] %>
+    </h2>
+
+    <p class="post-meta">Posted by <%= @blog_post['author']['first_name'] %> <%= @blog_post['author']['last_name'] %> on <%= @blog_post['created'] %></p>
+
+    <p class="post-body">
+        <%= @blog_post['body'].html_safe %>
+    </p>
+</div>

data/app/views/layouts/buttercms/application.html.erb

@@ -0,0 +1,110 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta name="description" content="">
+    <meta name="author" content="">
+
+    <title>Blog</title>
+
+    <!-- Bootstrap Core CSS -->
+    <link href="https://buttercms.com/static/demoblog/css/bootstrap.min.css" rel="stylesheet">
+
+    <!-- Custom CSS -->
+    <link href="https://buttercms.com/static/demoblog/css/clean-blog.min.css" rel="stylesheet">
+
+    <!-- Custom Fonts -->
+    <link href="http://maxcdn.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.min.css" rel="stylesheet" type="text/css">
+    <link href='http://fonts.googleapis.com/css?family=Lora:400,700,400italic,700italic' rel='stylesheet' type='text/css'>
+    <link href='http://fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800' rel='stylesheet' type='text/css'>
+
+    <!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
+    <!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
+    <!--[if lt IE 9]>
+        <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
+        <script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
+    <![endif]-->
+
+</head>
+
+<body style="padding-top: 60px;">
+
+    <!-- Navigation -->
+    <nav class="navbar navbar-default navbar-custom" style="background-color: #404040;">
+        <div class="container-fluid">
+            <!-- Brand and toggle get grouped for better mobile display -->
+            <div class="navbar-header page-scroll">
+                <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
+                    <span class="sr-only">Toggle navigation</span>
+                    <span class="icon-bar"></span>
+                    <span class="icon-bar"></span>
+                    <span class="icon-bar"></span>
+                </button>
+
+                <%= link_to("Blog home", blog_path, class: "navbar-brand") %>
+            </div>
+
+
+        </div>
+        <!-- /.container -->
+    </nav>
+
+    <!-- Main Content -->
+    <div class="container">
+    <%= yield %>
+    </div>
+
+    <hr>
+
+    <!-- Footer -->
+    <footer>
+        <div class="container">
+            <div class="row">
+                <div class="col-lg-8 col-lg-offset-2 col-md-10 col-md-offset-1">
+                    <ul class="list-inline text-center">
+                        <li>
+                            <a href="#">
+                                <span class="fa-stack fa-lg">
+                                    <i class="fa fa-circle fa-stack-2x"></i>
+                                    <i class="fa fa-twitter fa-stack-1x fa-inverse"></i>
+                                </span>
+                            </a>
+                        </li>
+                        <li>
+                            <a href="#">
+                                <span class="fa-stack fa-lg">
+                                    <i class="fa fa-circle fa-stack-2x"></i>
+                                    <i class="fa fa-facebook fa-stack-1x fa-inverse"></i>
+                                </span>
+                            </a>
+                        </li>
+                        <li>
+                            <a href="#">
+                                <span class="fa-stack fa-lg">
+                                    <i class="fa fa-circle fa-stack-2x"></i>
+                                    <i class="fa fa-github fa-stack-1x fa-inverse"></i>
+                                </span>
+                            </a>
+                        </li>
+                    </ul>
+                    <p class="copyright text-muted">Copyright &copy; Your Website 2015</p>
+                </div>
+            </div>
+        </div>
+    </footer>
+
+    <!-- jQuery -->
+    <script src="https://buttercms.com/static/demoblog/js/jquery.min.js"></script>
+
+    <!-- Bootstrap Core JavaScript -->
+    <script src="https://buttercms.com/static/demoblog/js/bootstrap.min.js"></script>
+
+    <!-- Custom Theme JavaScript -->
+    <script src="https://buttercms.com/static/demoblog/js/clean-blog.min.js"></script>
+
+</body>
+</html>

data/bin/rails

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/buttercms/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/buttercms.gemspec

@@ -0,0 +1,32 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "buttercms/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |spec|
+  spec.name          = "buttercms"
+  spec.version       = Buttercms::VERSION
+  spec.authors       = ["ButterCms"]
+  spec.email         = ["jake@buttercms.com"]
+  spec.summary       = %q{Company blogs as a service. Built for developers.}
+  spec.description   = %q{Butter makes setting up a company blog on Rails insanely easy. It's built for developers to save us from hosting, DB setup, themeing, maintaining yet another Wordpress install. It's designed to be quickly integrated to an existing Rails project.}
+  spec.homepage      = "https://www.buttercms.com"
+  spec.license       = "MIT"
+
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  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"
+
+
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+Buttercms::Engine.routes.draw do
+    get '/' => 'blog#home', as: :blog
+    get '/:slug' => 'blog#post', as: :blog_post
+end

data/lib/buttercms.rb

@@ -0,0 +1,5 @@
+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

data/lib/buttercms/engine.rb

@@ -0,0 +1,5 @@
+module Buttercms
+  class Engine < ::Rails::Engine
+    isolate_namespace Buttercms
+  end
+end

data/lib/buttercms/version.rb

@@ -0,0 +1,3 @@
+module Buttercms
+  VERSION = "0.0.2"
+end

data/lib/tasks/buttercms_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :buttercms do
+#   # Task goes here
+# end

data/test/buttercms_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class ButtercmsTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, Buttercms
+  end
+end

data/test/integration/navigation_test.rb

@@ -0,0 +1,10 @@
+require 'test_helper'
+
+class NavigationTest < ActionDispatch::IntegrationTest
+  fixtures :all
+
+  # test "the truth" do
+  #   assert true
+  # end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../../test/dummy/config/environment.rb",  __FILE__)
+ActiveRecord::Migrator.migrations_paths = [File.expand_path("../../test/dummy/db/migrate", __FILE__)]
+ActiveRecord::Migrator.migrations_paths << File.expand_path('../../db/migrate', __FILE__)
+require "rails/test_help"
+
+# Filter out Minitest backtrace while allowing backtrace from other libraries
+# to be shown.
+Minitest.backtrace_filter = Minitest::BacktraceFilter.new
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+# Load fixtures from the engine
+if ActiveSupport::TestCase.respond_to?(:fixture_path=)
+  ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
+  ActiveSupport::TestCase.fixtures :all
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: buttercms
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - ButterCms
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-23 00:00:00.000000000 Z
+date: 2015-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,8 +76,30 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- LICENSE
-- README.md
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.rst
+- Rakefile
+- app/assets/images/buttercms/.keep
+- app/assets/javascripts/buttercms/application.js
+- app/assets/stylesheets/buttercms/application.css
+- app/controllers/buttercms/application_controller.rb
+- app/controllers/buttercms/blog_controller.rb
+- app/helpers/buttercms/application_helper.rb
+- app/views/buttercms/blog/home.html.erb
+- app/views/buttercms/blog/post.html.erb
+- app/views/layouts/buttercms/application.html.erb
+- bin/rails
+- buttercms.gemspec
+- config/routes.rb
+- lib/buttercms.rb
+- lib/buttercms/engine.rb
+- lib/buttercms/version.rb
+- lib/tasks/buttercms_tasks.rake
+- test/buttercms_test.rb
+- test/integration/navigation_test.rb
+- test/test_helper.rb
 homepage: https://www.buttercms.com
 licenses:
 - MIT
@@ -102,4 +124,7 @@ rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Company blogs as a service. Built for developers.
-test_files: []
+test_files:
+- test/buttercms_test.rb
+- test/integration/navigation_test.rb
+- test/test_helper.rb

data/LICENSE

@@ -1,22 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2015 Jake Lumetta
-
-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

@@ -1,2 +0,0 @@
-# buttercms-rails
-Butter CMS Gem for Rails