blogit 0.6.0 → 0.7.0

data/README.md

@@ -54,8 +54,9 @@ we'll also throw in:
 
 * An XML Sitemap located at `/blog/posts.xml`
 * An RSS feed located at `/blog/posts.rss`
+* Sitemap submission to the major search engines (via [Pingr](http://github.com/katanacode/pingr "Pingr") - off by default)
 * Page Caching and Sweeping
-* Internationalization (see the [locales file](https://github.com/KatanaCode/blogit/blob/master/config/locales/en.yml) for configurable options)
+* Internationalization (see the [locales file](config/locales/en.yml) for configurable options)
 * Share links (Google+, Twitter & Facebook)
 * [Disquss Comments](http://disqus.com)
 
@@ -78,24 +79,7 @@ You're welcome to contribute to Blogit. Please consult the [contribution guideli
 
 Copyright 2011 [Katana Code Ltd.](http://katanacode.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.
+See (LEGAL)[LEGAL] for full details.
 
 ## Credits
 
@@ -105,7 +89,8 @@ with generous contributions from:
 
 * [Philou](https://github.com/philou)
 * [Stewart McKee](https://github.com/stewartmckee)
+* [Karsten Silkenbäumer](https://github.com/kassi)
 
 ## About Katana Code
 
-Katana Code are [Ruby on Rails Developers Based in Edinburgh, Scotland](http://katanacode.com/ "Katana Code").
+Katana Code are [Ruby on Rails Developers Based in Edinburgh, Scotland](http://katanacode.com/ "Katana Code").

data/app/controllers/blogit/posts_controller.rb

@@ -4,6 +4,14 @@ module Blogit
   # the main_app
   class PostsController < ::Blogit::ApplicationController
 
+  
+    # If using Blogit's Create, Update and Destroy actions AND ping_search_engines is
+    # set, call ping_search_engines after these requests
+    if Blogit.configuration.include_admin_actions
+      after_filter :ping_search_engines, only: [:create, :update, :destroy], :if => lambda { Blogit.configuration.ping_search_engines }
+    end
+    
+    # Raise a 404 error if the admin actions aren't to be included
     # We can't use blogit_conf here because it sometimes raises NoMethodError in main app's routes
     unless Blogit.configuration.include_admin_actions
       before_filter :raise_404, except: [:index, :show, :tagged]
@@ -75,6 +83,20 @@ module Blogit
       # Don't include admin actions if include_admin_actions is false
       render file: "#{Rails.root}/public/404.html", status: :not_found, layout: false
     end
+    
+    
+    # @See the Pingr gem for more info https://github.com/KatanaCode/pingr
+    def ping_search_engines
+      case blogit_conf.ping_search_engines
+      when Array
+        search_engines = blogit_conf.ping_search_engines
+      when true
+        search_engines = Pingr::SUPPORTED_SEARCH_ENGINES
+      end
+      for search_engine in search_engines
+        Pingr::Request.new(search_engine, posts_url(format: :xml)).ping
+      end
+    end
 
   end
 

data/app/models/blogit/post.rb

@@ -13,7 +13,7 @@ module Blogit
     # ==============
     # = Attributes =
     # ==============
-    attr_accessible :title, :body, :tag_list
+    attr_accessible :title, :body, :tag_list, :blogger_type, :blogger_id
 
     # ===============
     # = Validations =

data/app/views/blogit/posts/_form.html.erb

@@ -37,7 +37,7 @@
 
   <%= actions do %>
     <%= f.submit %> <%=t :or, scope: 'blogit.posts'%>
-    <%= link_to(t(:cancel, scope: 'blogit.posts'), @post.new_record? ? root_path : post_path(@post)) %>
+    <%= link_to(t(:cancel, scope: 'blogit.posts'), @post.new_record? ? blog_root_path : post_path(@post)) %>
   <% end %>
 
 <% end %>

data/app/views/blogit/posts/index.rss.builder

@@ -1,21 +1,21 @@
 xml.instruct!
 xml.rss "version" => "2.0", "xmlns:dc" => "htt://purl.org/dc/elements/1.1/" do
   xml.channel do
-    
+
     xml.title blogit_conf.rss_feed_title
-    
+
     xml.description blogit_conf.rss_feed_description
-    
+
     xml.pubDate CGI.rfc1123_date @posts.first.try(:updated_at)
-    
-    xml.link root_url
-    
+
+    xml.link blog_root_url
+
     xml.lastBuildDate CGI.rfc1123_date @posts.first.try(:updated_at)
-    
-    xml.language blogit_conf.rss_feed_language
+
+    xml.language I18n.locale
     
     @posts.each do |post|
-    
+
       xml.item do
         xml.title post.title
         xml.description format_content(truncate(post.body, length: 400)).html_safe
@@ -24,7 +24,7 @@ xml.rss "version" => "2.0", "xmlns:dc" => "htt://purl.org/dc/elements/1.1/" do
         xml.guid post_url(post)
         xml.author post.blogger_display_name
       end
-    
+
     end
   end
 end

data/config/routes.rb

@@ -1,12 +1,12 @@
 Blogit::Engine.routes.draw do
-  
+
   # Keep these above the posts resources block
   match "posts/page/:page" => "posts#index"
   match "posts/tagged/:tag" => 'posts#tagged', as: :tagged_blog_posts
-    
+
   resources :posts do
     resources :comments, only: [:create, :destroy]
   end
 
-  root to: "posts#index"
-end
+  match "/" => "posts#index", as: :blog_root
+end

data/lib/blogit.rb

@@ -2,6 +2,7 @@
 require "acts-as-taggable-on"
 require "kaminari"
 require "redcarpet"
+require "pingr"
 
 require "blogit/configuration"
 require "blogit/blogs"

data/lib/blogit/configuration.rb

@@ -79,14 +79,15 @@ module Blogit
     # Defaults to "[Application Name] Blog Posts"
     attr_accessor :rss_feed_description
 
-    # The default language of the RSS feed
-    # Defaults to 'en'
-    attr_accessor :rss_feed_language
-
     # Should the routes of the main app be accessible without
     # the "main_app." prefix ?
     attr_accessor :inline_main_app_named_routes
 
+    # Should blogit ping search engines with your sitemap
+    # when posts are created, updated or destroyed?
+    # Defaults to false
+    attr_accessor :ping_search_engines
+    
     # When using redcarpet as content parser, pass these options as defaults.
     REDCARPET_OPTIONS = {
       hard_wrap: true,
@@ -116,7 +117,7 @@ module Blogit
       @highlight_code_syntax       = true
       @rss_feed_title              = "#{Rails.application.engine_name.titleize} Blog Posts"
       @rss_feed_description        = "#{Rails.application.engine_name.titleize} Blog Posts"
-      @rss_feed_language           = "en"
+      @ping_search_engines         = false
       @redcarpet_options           = REDCARPET_OPTIONS
     end
 
@@ -142,6 +143,10 @@ module Blogit
       @twitter_username = username
     end
 
+    def rss_feed_language=(locale)
+      blogit_warn "#{self.class}#rss_feed_language has been deprecated. You can remove this from your blogit.rb configuration file"
+    end
+    
     private
 
     def blogit_warn(message)

data/lib/blogit/version.rb

@@ -1,3 +1,3 @@
 module Blogit
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/lib/generators/templates/blogit.rb

@@ -60,9 +60,15 @@ Blogit.configure do |config|
   # RSS Feed description content
   # config.rss_feed_description = "Get your daily pony news here!"
 
-  # RSS Feed language
-  # config.rss_feed_language = "en"
-
+  # Should blogit ping search engines with your sitemap
+  # when posts are created, updated or destroyed?
+  # 
+  # Can pass true to ping all supported search engines, or an array of search
+  # engine names. e.g. [:google, :bing]
+  # 
+  # Defaults to false
+  # config.ping_search_engines = false
+  
   # When using redcarpet as content parser, pass these options as defaults.
   # @see here for more options: https://github.com/tanoku/redcarpet
   # config.redcarpet_options = {

data/spec/controllers/blogit/posts_controller_spec.rb

@@ -116,7 +116,30 @@ describe PostsController do
           do_post
           response.should redirect_to(controller.posts_url)
         end
+        
+        it "should ping all search engines in ping_search_engines config if array" do
+          Blogit.configuration.ping_search_engines = search_engines = [:google]
+          search_engines.each do |search_engine|
+            Pingr::Request.expects(:new).with(search_engine, controller.posts_url(format: :xml))
+          end
+          do_post
+        end
+
+        it "should ping all search engines in Pingr::SUPPORTED_SEARCH_ENGINES if config is true" do
+          Blogit.configuration.ping_search_engines = true
+          Pingr::SUPPORTED_SEARCH_ENGINES.each do |search_engine|
+            Pingr::Request.expects(:new).with(search_engine, controller.posts_url(format: :xml))
+          end
+          do_post
+        end
 
+        it "should not ping any search engines if ping_search_engines is false" do
+          Blogit.configuration.ping_search_engines = false
+          Pingr::SUPPORTED_SEARCH_ENGINES.each do |search_engine|
+            Pingr::Request.expects(:new).with(search_engine, controller.posts_url(format: :xml)).never
+          end
+          do_post
+        end
       end
 
     end
@@ -192,6 +215,31 @@ describe PostsController do
         do_put
         flash[:notice].should be_present
       end
+      
+      it "should ping all search engines in ping_search_engines config if array" do
+        Blogit.configuration.ping_search_engines = search_engines = [:google, :bing]
+        search_engines.each do |search_engine|
+          Pingr::Request.expects(:new).with(search_engine, controller.posts_url(format: :xml))
+        end
+        do_put
+      end
+
+      it "should ping all search engines in Pingr::SUPPORTED_SEARCH_ENGINES if config is true" do
+        Blogit.configuration.ping_search_engines = true
+        Pingr::SUPPORTED_SEARCH_ENGINES.each do |search_engine|
+          Pingr::Request.expects(:new).with(search_engine, controller.posts_url(format: :xml))
+        end
+        do_put
+      end
+
+      it "should not ping any search engines if ping_search_engines is false" do
+        Blogit.configuration.ping_search_engines = false
+        Pingr::SUPPORTED_SEARCH_ENGINES.each do |search_engine|
+          Pingr::Request.expects(:new).with(search_engine, controller.posts_url(format: :xml)).never
+        end
+        do_put
+      end
+      
     end
 
     context "when not logged in" do
@@ -261,6 +309,30 @@ describe PostsController do
         do_delete
         flash[:notice].should be_present
       end
+      
+      it "should ping all search engines in ping_search_engines config if array" do
+        Blogit.configuration.ping_search_engines = search_engines = [:google, :bing]
+        search_engines.each do |search_engine|
+          Pingr::Request.expects(:new).with(search_engine, controller.posts_url(format: :xml))
+        end
+        do_delete
+      end
+
+      it "should ping all search engines in Pingr::SUPPORTED_SEARCH_ENGINES if config is true" do
+        Blogit.configuration.ping_search_engines = true
+        Pingr::SUPPORTED_SEARCH_ENGINES.each do |search_engine|
+          Pingr::Request.expects(:new).with(search_engine, controller.posts_url(format: :xml))
+        end
+        do_delete
+      end
+
+      it "should not ping any search engines if ping_search_engines is false" do
+        Blogit.configuration.ping_search_engines = false
+        Pingr::SUPPORTED_SEARCH_ENGINES.each do |search_engine|
+          Pingr::Request.expects(:new).with(search_engine, controller.posts_url(format: :xml)).never
+        end
+        do_delete
+      end
 
     end
 

data/spec/dummy/app/views/layouts/application.html.erb

@@ -15,7 +15,7 @@
       <%= link_to("log in", main_app.new_session_path) %>
     <% end %>
 
-    <h1><%= link_to("My Awesome Blog", root_path) %></h1>
+    <h1><%= link_to("My Awesome Blog", blog_root_path) %></h1>
 
     <%= yield %>
   </div>

data/spec/dummy/config/initializers/blogit.rb

@@ -1,62 +1,91 @@
 # These configuration options can be used to customise the behaviour of Blogit
+# these are all commented out in testing to use the defaults
 Blogit.configure do |config|
 
   # What kind of comments do you want to add to your blog ? (:active_record, :disqus or :no)
-  config.include_comments = :active_record
+  # config.include_comments = :active_record
 
   # When using disqus comments, what is the shortname of your forum ?
-  config.disqus_shortname = ""
+  # config.disqus_shortname = ""
 
   # Should there be a share bar on every post ?
-  config.include_share_bar = true
+  # config.include_share_bar = false
 
   # Twitter username used in the share bar
-  config.twitter_username = "blogit"
+  # config.twitter_username = ""
 
   # The name of the controller method we'll call to return the current blogger.
   # Change this if you use something other than current_user.
   # Eg. current_admin_user (if using ActiveAdmin)
-  config.current_blogger_method = :current_user
+  # config.current_blogger_method = :current_user
 
   # What method do we call on blogger to show who they are?
-  config.blogger_display_name_method = :username
+  # config.blogger_display_name_method = :username
 
   # Which DateTime::FORMATS format do we use to display blog and comment publish time
-  config.datetime_format = :short
+  # config.datetime_format = :short
 
   # Should the controllers cache the blog pages as HTML?
-  config.cache_pages = true
+  # config.cache_pages = false
 
   # No. of posts to show per page
-  config.posts_per_page = 5
+  # config.posts_per_page = 5
 
   # The name of the before filter we'll call to authenticate the current user.
-  config.authentication_method = :login_required
+  # config.authentication_method = :login_required
 
   # If set to true, the comments form will POST and DELETE to the comments
   # controller using AJAX calls.
-  config.ajax_comments = true
+  # config.ajax_comments = true
 
   # If set to true, the create, edit, update and destroy actions
   # will be included. If set to false, you'll have to set these
   # yourself elsewhere in the app.
-  config.include_admin_actions = true
+  # config.include_admin_actions = true
 
   # If set to true, links for new posts, editing posts and deleting comments
   # will be available. If set to false, you'll have to set these
   # yourself in the templates.
-  config.include_admin_links = true
+  # config.include_admin_links = true
 
   # The default format for parsing the blog content.
-  config.default_parser = :textile
+  # config.default_parser = :markdown
 
   # If blog content contains code, this should be highlighted using
   # albino.
-  config.highlight_code_syntax = true
-
+  # config.highlight_code_syntax = true
+
+  # RSS Feed title content
+  # config.rss_feed_title = "A blog about ponies!"
+
+  # RSS Feed description content
+  # config.rss_feed_description = "Get your daily pony news here!"
+
+  # Should blogit ping search engines with your sitemap
+  # when posts are created, updated or destroyed?
+  # 
+  # Can pass true to ping all supported search engines, or an array of search
+  # engine names. e.g. [:google, :bing]
+  # 
+  # Defaults to false
+  config.ping_search_engines = true
+  
   # When using redcarpet as content parser, pass these options as defaults.
   # @see here for more options: https://github.com/tanoku/redcarpet
-  # config.redcarpet_options = [:hard_wrap, :filter_html, :autolink,
-  #   :no_intraemphasis, :fenced_code, :gh_blockcode]
-
-end
+  # config.redcarpet_options = {
+  #   hard_wrap: true,
+  #   filter_html: true,
+  #   autolink: true,
+  #   no_intraemphasis: true,
+  #   fenced_code_blocks: true,
+  #   gh_blockcode: true
+  # }
+
+  # If set to true, it will be possible to call named routes of the main app
+  # directly, without the "main_app." prefix.
+  # Useful in the case where you don't want to change the main app's layout,
+  # but it does not expand correctly from inside blogit because some main
+  # app's named routes are missing.
+  # config.inline_main_app_named_routes = true
+
+end