blogpostify 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9af182d4d709ae1c185aa8d4ecba533667317764
+  data.tar.gz: 45b18953a7bee41d38042c513382d02f47e3fd95
+SHA512:
+  metadata.gz: 2070132e49cf7ed728825b513dabb6ad8daa3ef003cb88383b39abe1cb00cf774d3578449c7712115e98ad60e28820a3721fbe90d43bfc30f227476f63f5cec5
+  data.tar.gz: 96feee3872d01231abfcc8a3e872ffa9db499b2b040359ab3764ade9ec8021c63697bf19bf83d75ca082335fffe68a62d1f5fd179f3e18b0ae7018c28c78336b

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in blogpostify.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Dan Wentworth
+
+MIT License
+
+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,97 @@
+# Blogpostify
+
+Simple little gem to fetch the latest blog posts from multiple RSS or Atom feeds and cache them in an ActiveRecord model to be displayed in your Rails application.
+
+Blogpostify comes with rake tasks and view helpers to assit with integration into your existing application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'blogpostify'
+```
+
+And then execute:
+
+    $ bundle
+
+Once bundled with your application, run the migration included with the gem:
+
+```sh
+bundle exec rake db:migrate
+```
+
+## Usage
+
+### Configuration
+Add your blog details in an initializer `config/initializers/blogpostify.rb`:
+
+```ruby
+Blogpostify.configure do |config|
+  config.add_blog("Riding Rails", "http://weblog.rubyonrails.org/feed/atom.xml")
+end
+```
+
+The title of your blog will be parameterized to form an blog identifier for your cached posts. If you want to set this to something else, set the third parameter. You can also add a path to an icon that represents this blog if you like.
+
+```ruby
+Blogpostify.configure do |config|
+  config.add_blog("Riding Rails", "http://weblog.rubyonrails.org/feed/atom.xml")
+  config.add_blog("Signal v. Noise", "https://signalvnoise.com/posts.rss", "svn", "https://basecamp.com/assets/general/basecamp.png")
+end
+```
+
+Okay, great! You're all ready to start fetching blog posts.
+
+### Updating
+
+For your convenience we've included a couple of rake tasks to assist with updating blog posts. Feel free to use these in conjunction with `cron` to update your posts, if you're using something like `clockwork` to schedule tasks, we'll look at that in a second.
+
+`blogpostify:update_all` will go through each configured blog and attempt to fetch new posts for them:
+
+```sh
+bundle exec rake blogpostify:update_all
+=> 2 new posts added
+```
+
+`blogpostify:update` can be used to just update a single blog, pass BLOG as an environment variable to specifty the blog:
+
+```sh
+bundle exec rake blogpostify:update BLOG=svn
+=> 4 new posts added
+```
+
+So what if you're using something like `clockwork` or another ruby based worker to run your scheduled task? No problem. To update all blogs simply run:
+
+```ruby
+Blogpostify.update_blogs
+=> [#<Blogpostify::Post...]
+```
+
+Just want to update one blog? No problem:
+
+```ruby
+Blogpostify.update_blog('svn')
+=> [#<Blogpostify::Post...]
+```
+
+If we can't find the blog specified in the configuration you'll recieve a Blogpostify::BlogNotFound error.
+
+### Displaying Entries
+
+There are a couple of helpers included to assist you in displaying your post entries in your app. `blog_populated?` allows you to check if any blog posts have been fetched for a blog yet. `blog_posts_for` fetches the most recent posts for a particular blog, sorted by published date. Lets have a look at these in practice in `app/views/dashboard/index.html.haml`:
+
+```haml
+- if blog_populated?('svn')
+  %h4 Latest News
+  %ul.blog-posts
+  = blog_posts_for('svn', :count => 1) do |post|
+    %li.post
+      %span.title= post.title
+      %span.description= truncate post.description, :length => 90
+      %span.published= post.published_at.strftime("%-d %b %H:%M")
+      %span.link= link_to "Read More...", post.link
+```
+
+Note that you can optionally pass `count` to `blog_posts_for` to only get the n-latest posts. By default this is 3.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/blogpostify.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'blogpostify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "blogpostify"
+  spec.version       = Blogpostify::VERSION
+  spec.authors       = ["Dan Wentworth"]
+  spec.email         = ["dan@atechmedia.com"]
+  spec.summary       = %q{Fetch, cache and display blog posts in your Rails app.}
+  spec.homepage      = "http://darkphnx.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "rails", "~> 4"
+end

data/db/migrate/20150209104023_create_posts.rb

@@ -0,0 +1,14 @@
+class CreatePosts < ActiveRecord::Migration
+  def change
+    create_table :blogpostify_posts do |t|
+      t.string :blog
+      t.string :title
+      t.text :description
+      t.string :guid
+      t.string :link
+      t.timestamp :published_at
+
+      t.timestamps
+    end
+  end
+end

data/lib/blogpostify/blog.rb

@@ -0,0 +1,38 @@
+module Blogpostify
+  class Blog
+
+    attr_accessor :title, :url, :short_name, :icon 
+
+    def initialize(title, url, short_name, icon)
+      self.title = title
+      self.url = url
+      self.short_name = short_name
+      self.icon = icon
+    end
+
+    def update_posts
+      created = []
+
+      open(self.url) do |body|
+        rss = RSS::Parser.parse(body)
+        rss.items.each do |post|
+          post = Post.create_from_item(self.short_name, post)
+
+          # Post not saved if guid is already registered for this blog
+          created << post if post.persisted? 
+        end
+
+        created
+      end
+    end
+
+    def posts
+      Post.where(:blog => self.short_name).asc
+    end
+
+    def short_name
+      @short_name ||= title.parameterize
+    end
+
+  end
+end

data/lib/blogpostify/engine.rb

@@ -0,0 +1,15 @@
+module Blogpostify
+  class Engine < ::Rails::Engine
+    
+    initializer 'blogpostify.initialize' do |app|
+      config.paths["db/migrate"].expanded.each do |expanded_path|
+        app.config.paths["db/migrate"] << expanded_path
+      end
+
+      ActiveSupport.on_load :action_controller do
+        helper Blogpostify::ViewHelpers
+      end
+    end
+    
+  end
+end

data/lib/blogpostify/post.rb

@@ -0,0 +1,35 @@
+module Blogpostify
+  class Post < ActiveRecord::Base
+
+    self.table_name = 'blogpostify_posts'
+
+    scope :asc, -> { order(:published_at).reverse_order }
+
+    validates :guid, :uniqueness => { :scope => :blog }
+
+    class << self
+
+      include ActionView::Helpers::SanitizeHelper
+
+      def create_from_item(blog_name, post_item)
+        post = self.new
+        post.blog = blog_name
+        post.title = post_item.title
+        post.description = sanitize_description(post_item.description)
+        post.guid = post_item.guid.content
+        post.published_at = post_item.pubDate
+        post.link = post_item.link
+        post.save
+        post
+      end
+
+      private
+
+      # Truncate the description to the configured length to the nearest whole word
+      def sanitize_description(description)
+        ActionController::Base.helpers.strip_tags(description)
+      end
+    end
+
+  end
+end

data/lib/blogpostify/version.rb

@@ -0,0 +1,3 @@
+module Blogpostify
+  VERSION = "1.0.0"
+end

data/lib/blogpostify/view_helpers.rb

@@ -0,0 +1,26 @@
+module Blogpostify
+  module ViewHelpers
+
+    def blog_populated?(blog_name)
+      blog = Blogpostify.find_blog!(blog_name)
+      blog.posts.exists?
+    end
+
+    def blog_posts_for(blog_name, options={}, &block)
+      options.reverse_merge!({
+        :count => 3
+      })
+
+      blog = Blogpostify.find_blog!(blog_name)
+      posts_scope = blog.posts.asc.limit(options[:count])
+
+      if block_given?
+        posts_scope.each {|post| yield post }
+        return nil # Block should do all of the rendering
+      else
+        posts_scope.to_a
+      end
+    end
+
+  end
+end

data/lib/blogpostify.rb

@@ -0,0 +1,62 @@
+require 'open-uri'
+require 'rss'
+
+require "blogpostify/version"
+require "blogpostify/blog"
+require "blogpostify/post"
+require "blogpostify/view_helpers"
+require 'blogpostify/engine'
+
+module Blogpostify
+
+  class BlogNotFoundError < StandardError; end
+
+  class Configuration
+    def blogs
+      @blogs ||= []
+    end
+
+    def add_blog(title, url, icon=nil, short_name=nil)
+      self.blogs << Blog.new(title, url, short_name, icon)
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield configuration
+    end
+
+    def find_blog!(blog_short_name)
+      blog_short_name = blog_short_name.to_s
+
+      found_blog = blogs.find do |blog|
+        blog.short_name == blog_short_name
+      end
+
+      if found_blog.nil?
+        raise BlogNotFoundError, "Blog #{blog_short_name} is not configured. Check Blogpostify#blogs." 
+      else
+        found_blog
+      end
+    end
+
+    def blogs
+      configuration.blogs
+    end
+
+    def update_blogs
+      blogs.flat_map do |blog|
+        blog.update_posts
+      end
+    end
+
+    def update_blog(blog_name)
+      find_blog!(blog_name).update_posts
+    end
+
+  end
+
+end

data/lib/tasks/blogpostify.rake

@@ -0,0 +1,19 @@
+namespace :blogpostify do
+
+  desc 'Poll all configured blogs and update the posts'
+  task :update_all => :environment do
+    new_posts = Blogpostify.update_blogs
+    puts "#{new_posts.count} new posts added"
+  end
+
+  desc 'Update the posts for a single blog, pass blog identifier in BLOG'
+  task :update => :environment do
+    begin 
+      new_posts = Blogpostify.update_blog(ENV['BLOG'])
+      puts "#{new_posts.count} new posts added"
+    rescue Blogpostify::BlogNotFoundError
+      puts "Blog #{ENV['BLOG']} is not configured"
+    end
+  end
+
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: blogpostify
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dan Wentworth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: 
+email:
+- dan@atechmedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- blogpostify.gemspec
+- db/migrate/20150209104023_create_posts.rb
+- lib/blogpostify.rb
+- lib/blogpostify/blog.rb
+- lib/blogpostify/engine.rb
+- lib/blogpostify/post.rb
+- lib/blogpostify/version.rb
+- lib/blogpostify/view_helpers.rb
+- lib/tasks/blogpostify.rake
+homepage: http://darkphnx.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Fetch, cache and display blog posts in your Rails app.
+test_files: []