buttercms 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2eef23f799e7a261812947a3943864262da177f
-  data.tar.gz: 005f028b3d6c2faff3ca130fa84b795f0ea5709d
+  metadata.gz: cb1cc49cec49263c6cc7235b04bd6374e0b71ed3
+  data.tar.gz: e58a86c5bba9639451a2506ebf9104b5de94df0d
 SHA512:
-  metadata.gz: 1c554e5c945396a62caf280637f1735d0d2f496d6676c453f5c97baa4a55e93f066e8c96efc9b948903e645b4ec7cef7e3835a505e0c6ed97bd1e2297d82b76b
-  data.tar.gz: a480d3f73e3739233c180e6485eb6302df5bf7c40519d43fcfe4d6b1922eb369ddf32075f0a2d16451e019732a4dda3d20fe48d17293527e8b63715469ee6fa3
+  metadata.gz: c4ff507582245843ff9f4ef7791aca1a9e1a1e570e7e1a392132055c8079cd96998699874dd6adcb79b3ae0c0a57fd47b6297bc7d771a08e25b5c11447349b50
+  data.tar.gz: 2a677b384a44964f6e86112a8daef94e99e670027bdcff04734fdc07ad9a3fa7d98f92aa9d837c230bdc22e30fd4ec8977779af510197eac18e06dda8c3a73ac

data/.gitignore

@@ -36,3 +36,7 @@ pkg/*
 *.log
 
 .DS_Store
+
+
+test/dummy/tmp/
+test/dummy/db/development.sqlite3

data/Rakefile

@@ -1 +1,37 @@
-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/controllers/buttercms/blog_controller.rb

@@ -1,47 +1,36 @@
 require 'json'
 require 'rest-client'
 
-
 module Buttercms
 
-  API_URL = 'https://buttercms.com/api/'
-
   class Error < StandardError
   end
 
+
   class ConnectionError < Error
     def message
       "Unable to connect to ButterCms. Please double check your internet connection."
     end
   end
 
+
   class TokenError < Error
     def message
       "This token has not been registered. Please register one @ https://buttercms.com/api_token/"
     end
   end
 
+
   class InvalidResponseError < Error
     def message
       "An error occured retrieving blog. Please try again later."
     end
   end
 
-  class BlogController < ApplicationController
-    layout :get_butter_layout
-    helper Rails.application.helpers
-    helper Buttercms::ApplicationHelper
-
-    def get_butter_layout
-      if defined? Buttercms.configuration
-        if !Buttercms.configuration.layout.nil?
-          return Buttercms.configuration.layout
-        end
-      end
 
-      # Default to the included layout.
-      return "buttercms/application"
-    end
+  # Thin wrapper around RestClient for talking to Butter API
+  module API
+    API_URL = 'https://buttercms.com/api/'
 
     def butter_not_found
       raise ActionController::RoutingError.new('Not Found')
@@ -62,7 +51,7 @@ module Buttercms
       begin
         # Get the content. If it takes longer than 10 seconds timeout.
         # TODO(jlumetta): Make :timeout configurable.
-        response = RestClient.get path, {:Authorization => "Token #{get_butter_token}", :timeout => 10}
+        response = RestClient.get "#{API_URL}#{path}", {:Authorization => "Token #{get_butter_token}", :timeout => 10}
       rescue SocketError => e
         raise Buttercms::ConnectionError
       rescue => e
@@ -77,9 +66,28 @@ module Buttercms
             raise Buttercms::InvalidResponseError
           end
       end
-
       return response
     end
+  end
+
+
+  class BlogController < ApplicationController
+    include Buttercms::API
+
+    layout :get_butter_layout
+    helper Rails.application.helpers
+    helper Buttercms::ApplicationHelper
+
+    def get_butter_layout
+      if defined? Buttercms.configuration
+        if !Buttercms.configuration.layout.nil?
+          return Buttercms.configuration.layout
+        end
+      end
+
+      # Default to the included layout.
+      return "buttercms/application"
+    end
 
     def butter_home
       # Check for pagination
@@ -89,7 +97,7 @@ module Buttercms
         page_param = ''
       end
 
-      response = make_butter_request("#{API_URL}posts/#{page_param}")
+      response = make_butter_request("posts/#{page_param}")
       response_json = JSON.parse(response)
       @next_page = response_json['next_page']
       @previous_page = response_json['previous_page']
@@ -99,14 +107,14 @@ module Buttercms
     end
 
     def butter_post
-      response = make_butter_request("#{API_URL}posts/#{params[:slug]}")
+      response = make_butter_request("posts/#{params[:slug]}")
       @post = JSON.parse(response)
 
       render template: "blog/post"
     end
 
     def butter_author
-      response = make_butter_request("#{API_URL}authors/#{params[:author_slug]}")
+      response = make_butter_request("authors/#{params[:author_slug]}")
       response_json = JSON.parse(response)
       @first_name = response_json['first_name']
       @last_name = response_json['last_name']
@@ -117,7 +125,7 @@ module Buttercms
     end
 
     def butter_category
-      response = make_butter_request("#{API_URL}categories/#{params[:category_slug]}")
+      response = make_butter_request("categories/#{params[:category_slug]}")
       response_json = JSON.parse(response)
       @name = response_json['name']
       @recent_posts = response_json['recent_posts']
@@ -127,7 +135,7 @@ module Buttercms
 
 
     def butter_feed
-      response = make_butter_request("#{API_URL}posts/")
+      response = make_butter_request("posts/")
       response_json = JSON.parse(response)
       @recent_posts = response_json['results']
       respond_to do |format|
@@ -137,7 +145,7 @@ module Buttercms
     end
 
     def butter_sitemap
-      response = make_butter_request("#{API_URL}sitemap/")
+      response = make_butter_request("sitemap/")
       response_json = JSON.parse(response)
       @recent_posts = response_json
     end

data/buttercms.gemspec

@@ -25,4 +25,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rails", "~> 4.2.1"
+  spec.add_development_dependency "sqlite3"
 end

data/lib/buttercms/version.rb

@@ -1,3 +1,3 @@
 module Buttercms
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/test/buttercms_test.rb

@@ -1,7 +1,207 @@
 require 'test_helper'
+require 'rest-client'
 
-class ButtercmsTest < ActiveSupport::TestCase
-  test "truth" do
-    assert_kind_of Module, Buttercms
+module Buttercms
+  class ButtercmsApiTest < ActiveSupport::TestCase
+    API_URL = 'https://buttercms.com/api/'
+    TEST_TOKEN = '6e9f14b48892b00079604c24c7c64a6a987456cf'
+
+    test "truth" do
+      assert_kind_of Module, Buttercms
+    end
+
+    test "API returns list of most recent posts in expected format" do
+      response = RestClient.get "#{API_URL}posts/", {:Authorization => "Token #{TEST_TOKEN}", :timeout => 10}
+      response_json = JSON.parse(response)
+
+      # Test the top level JSON structure
+      assert_equal response_json['next_page'], nil
+      assert_equal response_json['previous_page'], nil
+      assert_equal response_json['results'].length, 1
+
+      # Test the JSON structure of the post itself.
+      post = response_json['results'][0]
+      assert_equal post['id'], 101
+      assert_equal post['url'], 'http://www.example.com/blog/this-is-a-blog-post'
+      assert_equal post['created'], '06/12/2015'
+      assert_equal post['published'], '06/12/2015'
+      assert_equal post['slug'], 'this-is-a-blog-post'
+      assert_equal post['title'], 'This is a blog post'
+      assert_equal post['body'], '<p class="">This is a blog post to test the API.</p>'
+      assert_equal post['summary'], 'This is a blog post to test the API.'
+      assert_equal post['featured_image'], ''
+      assert_equal post['status'], 'published'
+
+      author = post['author']
+      assert_equal author['first_name'], 'API'
+      assert_equal author['last_name'], 'Test'
+      assert_equal author['email'], 'apitest@buttercms.com'
+      assert_equal author['slug'], 'api-test'
+
+      categories = post['categories']
+      assert_equal categories.length, 1
+      assert_equal categories[0]['name'], 'test category'
+      assert_equal categories[0]['slug'], 'test-category'
+    end
+
+    test "API returns details for a specific post based on slug" do
+      response = RestClient.get "#{API_URL}posts/this-is-a-blog-post", {:Authorization => "Token #{TEST_TOKEN}", :timeout => 10}
+      response_json = JSON.parse(response)
+
+      # Test the JSON structure of the post itself and ensure it's at the top level of the response body.
+      post = response_json
+      assert_equal post['id'], 101
+      assert_equal post['url'], 'http://www.example.com/blog/this-is-a-blog-post'
+      assert_equal post['created'], '06/12/2015'
+      assert_equal post['published'], '06/12/2015'
+      assert_equal post['slug'], 'this-is-a-blog-post'
+      assert_equal post['title'], 'This is a blog post'
+      assert_equal post['body'], '<p class="">This is a blog post to test the API.</p>'
+      assert_equal post['summary'], 'This is a blog post to test the API.'
+      assert_equal post['featured_image'], ''
+      assert_equal post['status'], 'published'
+
+      author = post['author']
+      assert_equal author['first_name'], 'API'
+      assert_equal author['last_name'], 'Test'
+      assert_equal author['email'], 'apitest@buttercms.com'
+      assert_equal author['slug'], 'api-test'
+
+      categories = post['categories']
+      assert_equal categories.length, 1
+      assert_equal categories[0]['name'], 'test category'
+      assert_equal categories[0]['slug'], 'test-category'
+    end
+
+
+    test "API returns details for a specific author based on slug" do
+      response = RestClient.get "#{API_URL}authors/api-test", {:Authorization => "Token #{TEST_TOKEN}", :timeout => 10}
+      response_json = JSON.parse(response)
+
+      # Ensure the author information is at the top level of the response.
+      author = response_json
+      assert_equal author['first_name'], 'API'
+      assert_equal author['last_name'], 'Test'
+      assert_equal author['email'], 'apitest@buttercms.com'
+      assert_equal author['slug'], 'api-test'
+
+      # Ensure we get all of their posts in the format we expect.
+      recent_posts = author['recent_posts']
+      assert_equal recent_posts.length, 1
+
+      post = recent_posts[0]
+      assert_equal post['id'], 101
+      assert_equal post['url'], 'http://www.example.com/blog/this-is-a-blog-post'
+      assert_equal post['created'], '06/12/2015'
+      assert_equal post['published'], '06/12/2015'
+      assert_equal post['slug'], 'this-is-a-blog-post'
+      assert_equal post['title'], 'This is a blog post'
+      assert_equal post['body'], '<p class="">This is a blog post to test the API.</p>'
+      assert_equal post['summary'], 'This is a blog post to test the API.'
+      assert_equal post['featured_image'], ''
+      assert_equal post['status'], 'published'
+
+      categories = post['categories']
+      assert_equal categories.length, 1
+      assert_equal categories[0]['name'], 'test category'
+      assert_equal categories[0]['slug'], 'test-category'
+    end
+
+    test "API returns details for a specific category based on slug" do
+      response = RestClient.get "#{API_URL}categories/test-category", {:Authorization => "Token #{TEST_TOKEN}", :timeout => 10}
+      response_json = JSON.parse(response)
+
+      # Ensure the author information is at the top level of the response.
+      category = response_json
+      assert_equal category['name'], 'test category'
+      assert_equal category['slug'], 'test-category'
+
+      # Ensure we get all of their posts in the format we expect.
+      recent_posts = category['recent_posts']
+      assert_equal recent_posts.length, 1
+
+      post = recent_posts[0]
+      assert_equal post['id'], 101
+      assert_equal post['url'], 'http://www.example.com/blog/this-is-a-blog-post'
+      assert_equal post['created'], '06/12/2015'
+      assert_equal post['published'], '06/12/2015'
+      assert_equal post['slug'], 'this-is-a-blog-post'
+      assert_equal post['title'], 'This is a blog post'
+      assert_equal post['body'], '<p class="">This is a blog post to test the API.</p>'
+      assert_equal post['summary'], 'This is a blog post to test the API.'
+      assert_equal post['featured_image'], ''
+      assert_equal post['status'], 'published'
+    end
+
+    test "API returns sitemap for blog" do
+      response = RestClient.get "#{API_URL}sitemap", {:Authorization => "Token #{TEST_TOKEN}", :timeout => 10}
+      response_json = JSON.parse(response)
+
+      assert_equal response_json.length, 1
+
+      sitemap_entry = response_json[0]
+      assert_equal sitemap_entry['url'], 'http://www.example.com/blog/this-is-a-blog-post'
+      assert_equal sitemap_entry['slug'], 'this-is-a-blog-post'
+    end
+  end
+
+
+
+  class BlogControllerTest < ActionController::TestCase
+    setup do
+      @routes = Engine.routes
+    end
+
+    test "should get blog home and it should have recent_posts defined" do
+      get "butter_home"
+      assert_response :success
+      assert_not_nil assigns(:recent_posts)
+    end
+
+    test "should get blog post and it should have post defined" do
+      get("butter_post", {'slug' => 'this-is-a-blog-post'})
+      assert_response :success
+      assert_not_nil assigns(:post)
+    end
+
+    test "should get author page" do
+      get("butter_author", {'author_slug' => 'api-test'})
+      assert_response :success
+      assert_not_nil assigns(:first_name)
+      assert_not_nil assigns(:last_name)
+      assert_not_nil assigns(:email)
+      assert_not_nil assigns(:recent_posts)
+    end
+
+    test "should get category page" do
+      get("butter_category", {'category_slug' => 'test-category'})
+      assert_response :success
+      assert_not_nil assigns(:name)
+      assert_not_nil assigns(:recent_posts)
+    end
+
+    test "sitemap should return xml" do
+      get("butter_sitemap", {'format' => 'xml'})
+      assert_select 'loc', "http://www.example.com/blog/this-is-a-blog-post"
+    end
+
+    test "atom feed should return xml" do
+      get("butter_feed", {'format' => 'atom'})
+      assert_select 'title', "This is a blog post"
+    end
+
+    test "rss feed should return xml" do
+      get("butter_feed", {'format' => 'rss'})
+      assert_select 'title', "This is a blog post"
+    end
+  end
+
+  # Ensure that the blog has access to the host application's helpers.
+  class ApplicationHelperTest < ActionView::TestCase
+    include ApplicationHelper
+   
+    test "should return the blog title" do
+      assert_equal blog_title_helper, 'This is the Blog Title'
+    end
   end
-end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.