buzz_feed 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [Kristijan Sedlak]
+
+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.rdoc

@@ -0,0 +1,58 @@
+= BuzzFeed - Automated Buzz From The Web Model
+
+It is popular to have a "Buzz From The Web" widget on the site. This plugin will allow you 
+just that.
+Use this plugin for automated combining RSS/Atom links from various internet sources. It provides a
+background worker that periodically updates the Buzz model with fresh RSS/Atom links from 
+sources you define.
+
+
+== Installation (Rails 3 ready)
+
+Add this line to your Gemfile (and run bundle install):
+
+  gem 'buzz_feed'
+
+Run the generator which will generate some configuration files.
+
+  rails g buzz_feed
+  rake db:migrate
+
+The plugin comes with a Buzz model file. You can override the default model by creating a 
+new app/models/buzz.rb file.
+
+== Setup
+
+The generator creates a config/buzz_feed.yml where you configure the plugin. Here is a sample where
+I defined two sources (smashingmagazine and github RSS sources; the name can be whatever).
+
+  development: &defaults
+    service:
+      smashingmagazine:
+        url: 'http://rss1.smashingmagazine.com/feed/'
+      github:
+        url: 'https://github.com/xpepermint.private.atom?token=1b4b0b956ba3130cc47e420fdb44556f'
+
+The generator also creates config/initializers/buzz_feed.rb that has defined a Rufus scheduler for
+periodical reading/updating the Buzz model. You can comment this out to disable periodical updates.
+
+== Examples
+
+You can manually read a feed like this:
+
+  data = BuzzFeed::Client.read('github').each do |item|
+    puts item[:id]
+    puts item[:title]
+    puts item[:url]
+    puts item[:created_at]
+  end
+
+To manually update the Buzz model with fresh links do this:
+
+  BuzzFeed::Client.update('smashingmagazine')
+
+You can list all defined service names like this:
+
+  data = BuzzFeed::Client.service_names.each do |name|
+    puts name
+  end

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the buzz_feed plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the buzz_feed plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'BuzzFeed'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/buzz_feed/client.rb

@@ -0,0 +1,50 @@
+module BuzzFeed
+  module Client
+    
+    # Lists all defined services
+    def self.service_names
+      list = []
+      service = BuzzFeed.config['service'].keys.each do |name|
+        list << name
+      end
+    end
+    
+    # Returns data of a service
+    def self.read(name)
+      read_blogspot(BuzzFeed.config['service'][name]['url'])
+    end
+    
+    # Updates the Buzz model with fresh links from the service
+    def self.update(name)
+      fresh_data = self.read(name)
+      fresh_ids = fresh_data.map{|b| b[:id]}
+      old_ids = Buzz.select('service_item_id').where('service_name=?', name).where('service_item_id in (?)', fresh_ids).all.map(&:service_item_id)
+      new_ids = fresh_data.map{|b| b[:id]} - old_ids
+
+      fresh_data.each do |buzz|
+        Buzz.create(:title => buzz[:title], :service_name => name, :service_item_id => buzz[:id], :url => buzz[:url], 
+          :created_at => buzz[:created_at]) unless new_ids.rindex(buzz[:id]).nil?
+      end
+      true
+    end
+
+    protected
+    
+    def self.read_blogspot(url)
+      data = []
+      xml = Nokogiri::XML(open(url)).remove_namespaces!
+      xml.xpath('//feed/entry').each do |item|
+        id = item.xpath('id').text
+        title = item.xpath('title').text.strip
+        created_at = item.xpath('published').text.strip.to_time
+        url = nil
+        item.xpath('link').each do |link|
+          url = link['href'] if link['rel'] == 'alternate'
+        end
+        data << {:id => id, :title => title, :url => url, :created_at => created_at}
+      end
+      data
+    end
+
+  end
+end

data/lib/buzz_feed/version.rb

@@ -0,0 +1,9 @@
+module BuzzFeed
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/buzz_feed.rb

@@ -0,0 +1,14 @@
+module BuzzFeed
+  
+  # Return the config yml
+  def self.config
+    @config ||= YAML.load_file(File.join(Rails.root, 'config', 'buzz_feed.yml'))[RAILS_ENV]
+  end
+
+end
+
+%w( buzz_feed/version
+    buzz_feed/client
+).each do |lib|
+  require File.join(File.dirname(__FILE__), lib)
+end

data/lib/generators/buzz_feed_generator.rb

@@ -0,0 +1,33 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class BuzzFeedGenerator < Rails::Generators::Base  
+  include Rails::Generators::Migration
+  
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+  
+  # Implement the required interface for Rails::Generators::Migration.
+  # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+     "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+  
+  def create_migration_file
+    migration_template 'migration.rb', 'db/migrate/buzz_feed_migration.rb'
+  end
+
+  def create_initializer_file
+    copy_file "initializer.rb", "config/initializers/buzz_feed.rb"
+  end  
+
+  def create_config_file
+    copy_file "buzz_feed.yml", "config/buzz_feed.yml"
+  end  
+
+end

data/lib/generators/templates/buzz_feed.yml

@@ -0,0 +1,15 @@
+development: &defaults
+  service:
+    smashingmagazine:
+      url: 'http://rss1.smashingmagazine.com/feed/'
+    github:
+      url: 'https://github.com/xpepermint.private.atom?token=1b4b0b956ba3130cc47e420fdb44556f'
+
+staging:
+  <<: *defaults
+
+production:
+  <<: *defaults
+  
+test:
+  <<: *defaults

data/lib/generators/templates/initializer.rb

@@ -0,0 +1,19 @@
+#
+# BuzzFeed WORKER
+#
+# This worker periodically updates the Buzz model with fresh links from the web
+# defined in the config/buzz_feed.yml.
+#
+if !defined?(Rake) && !defined?(IRB) && Rails.env.to_s != 'development'
+
+  Rufus::Scheduler.start_new.every '12h', :first_in => '60s', :blocking => true do |job|
+    Rails.logger.info "[Rufus][#{Time.now}] BuzzFeed worker started."
+    
+    data = BuzzFeed::Client.service_names.each do |name|
+      BuzzFeed::Client.update(name)
+    end
+
+    Rails.logger.info "[Rufus][#{Time.now}] BuzzFeed worker finished."
+  end
+
+end

data/lib/generators/templates/migration.rb

@@ -0,0 +1,15 @@
+class BuzzFeedMigration < ActiveRecord::Migration
+  def self.up
+    create_table :buzzs do |t|
+      t.string :title
+      t.string :service_name, :default => 'website'
+      t.string :service_item_id
+      t.string :url
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :buzzs
+  end
+end

data/test/buzz_feed_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class BuzzFeedTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support'

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: buzz_feed
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kristijan Sedlak
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-07 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rufus-scheduler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 2
+        - 0
+        - 7
+        version: 2.0.7
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 4
+        - 4
+        version: 1.4.4
+  type: :runtime
+  version_requirements: *id002
+description: Use this plugin for automated combining RSS/Atom links from various internet sources.
+email: xpepermint@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- MIT-LICENSE
+files: 
+- Rakefile
+- lib/buzz_feed/client.rb
+- lib/buzz_feed/version.rb
+- lib/buzz_feed.rb
+- lib/generators/buzz_feed_generator.rb
+- lib/generators/templates/buzz_feed.yml
+- lib/generators/templates/initializer.rb
+- lib/generators/templates/migration.rb
+- lib/initializers/worker.rb
+- test/buzz_feed_test.rb
+- test/test_helper.rb
+- README.rdoc
+- MIT-LICENSE
+has_rdoc: true
+homepage: http://github.com/xpepermint/buzz_feed
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: BuzzFeed - Automated Buzz From The Web Model.
+test_files: []
+