siyelo-tweetify 0.1.2

data/CHANGELOG

@@ -0,0 +1,12 @@
+== 0.1.0
+
+* initial commit
+
+* enhancements
+  * n/a
+
+* bug fix
+  * n/a
+
+* deprecation
+  * none

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2010 Siyelo. http://www.siyelo.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.

data/README.rdoc

@@ -0,0 +1,70 @@
+== Tweetify
+
+A Rails engine for embedding Twitter extracts
+
+== Dependencies
+
+Tweetify needs;
+
+  dancroak-twitter-search
+
+== Installation
+
+All gems are on gemcutter, so you need to add gemcutter to your sources if you havent yet:
+
+  sudo gem sources -a http://gemcutter.org/
+
+Install required gem if you dont already have them
+
+  sudo gem install dancroak-twitter-search
+
+Install the tweetify gem:
+
+  sudo gem install siyelo-tweetify
+
+Configure gems inside your app:
+
+  config.gem 'rufus-scheduler'
+  config.gem 'dancroak-twitter-search', :lib => "twitter_search"
+  config.gem 'siyelo-tweetify', :lib => "tweetify"
+
+Run the generator:
+
+	ruby script/generate tweetify
+
+The generator will install an initializer which describes Tweetify's configuration options. Be sure to update this with your own Twitter search string and 'search agent' name.
+
+== Basic Usage
+
+Once the rufus scheduler task is running, it will go off and cache your last N (Tweet.tweet_limit) twitter serach matches.
+
+Inside your relevant controller, all you need to do is read the cached posts from your database.
+
+  @tweets            = Tweet.find(:all, :limit => 3)
+
+And render them in your view as you wish
+
+For convenience, some partials are included
+
+  = render :partial => '/tweets/list', :locals => { :tweets => @tweets }
+
+== TODO
+
+Please refer to TODO file.
+
+== Maintainers
+
+* Glenn Roberts
+
+== Contributors
+
+Check them in the CHANGELOG or do `git shortlog -s -n` in the cloned repository.
+
+== Bugs and Feedback
+
+If you discover any bugs or want to drop a line, feel free to create an issue on
+GitHub.
+
+http://github.com/siyelo/tweetify/issues
+
+MIT License. Copyright 2010. Siyelo Software CC. http://www.siyelo.com

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "siyelo-tweetify"
+    gem.summary = %Q{A Rails engine for embedding Twitter extracts}
+    gem.description = %Q{A Rails engine for embedding Twitter extracts}
+    gem.email = "glenn.roberts@siyelo.com"
+    gem.homepage = "http://github.com/siyelo/siyelo-tweetify"
+    gem.authors = ["Glenn Roberts"]
+    gem.add_dependency 'edgar-twitter-search', '>=0.5.10'
+    gem.files =  FileList["[A-Z]*", "{app,config,generators,lib}/**/*", "init.rb"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+desc 'Run Tweetify unit tests.'
+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 Tweetify.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Tweetify'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Default: run unit tests.'
+task :default => :test

data/TODO

@@ -0,0 +1,2 @@
+
+write tests

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/app/models/tweet.rb

@@ -0,0 +1,65 @@
+class Tweet < ActiveRecord::Base
+
+  cattr_accessor :search_string
+  @@search_string = "siyelo OR \"siyelo software\""
+
+  cattr_accessor :search_agent
+  @@search_agent = 'tweetify_agent'
+
+  cattr_accessor :read_timeout
+  @@read_timeout = 5.seconds
+
+  cattr_accessor :tweet_limit
+  @@tweet_limit = 3
+
+  attr_accessible :tweet_created_at,
+                  :text,
+                  :from_user,
+                  :tweet_id,
+                  :link
+
+  def self.cache_tweets
+    tweets = self.read_tweets
+    self.update_tweets(tweets)
+  end
+
+  protected
+
+    def self.read_tweets
+      tweets = []
+      begin
+        timeout(read_timeout) do
+          client = TwitterSearch::Client.new(search_agent)
+          tweets = client.query(:q => search_string, :rpp => tweet_limit, :page => '1')
+        end
+      rescue TimeoutError
+        logger.warn("Timeout accessing Twitter: #{$!}, #{$@}")
+      rescue
+        unless $!.message.match /302 Moved Temporarily/  #then no search results returned.
+          logger.warn("Error accessing Twitter: #{$!}")
+        end
+      end
+
+      tweets.nil? ? [] : tweets
+    end
+
+    def self.update_tweets(tweets)
+      unless tweets.empty?
+        old_tweets = Tweet.find(:all, :order => 'tweet_created_at')
+
+        tweets.each do |t|
+          n = self.create(:tweet_created_at   => t.created_at.to_time,
+                          :text               => t.text,
+                          :from_user          => t.from_user,
+                          :tweet_id           => t.id,
+                          :link               => "http://twitter.com/#{t.from_user}/status/#{t.id}")
+
+          # expire oldest tweet
+          old_tweets.pop.destroy unless old_tweets.empty?
+        end
+      else
+        logger.info("No new tweets found.")
+      end
+    end
+
+end

data/app/views/tweets/_list.html.haml

@@ -0,0 +1,5 @@
+.tweets
+  - tweets.each do |t|
+    .tweet
+      .title=     link_to time_ago_in_words(t.tweet_created_at) + " ago by #{h t.from_user}", t.link
+      .body=      auto_link t.text

data/generators/tweetify_install/USAGE

@@ -0,0 +1,4 @@
+To copy a Tweetify initializer & migration & partials to your Rails App, with some configuration values, just do:
+
+    script/generate tweetify_install
+

data/generators/tweetify_install/templates/README

@@ -0,0 +1,15 @@
+
+===============================================================================
+
+Some setup you must do manually if you haven't yet:
+
+  1. Ensure you have defined your Twitter user name in config/tweetify.rb
+
+  2. Ensure you have defined your Twitter search agent in config/tweetify.rb
+
+  3. Run rake db:migrate to create the Tweets table.
+
+Note: the initializer creates its own Rufus scheduler task - so if you have
+other Rufus tasks, you may want to consolidate them.
+
+===============================================================================

data/generators/tweetify_install/templates/migration.rb

@@ -0,0 +1,18 @@
+class CreateTweets < ActiveRecord::Migration
+  def self.up
+    create_table :tweets do |t|
+      t.string    :type
+      t.datetime :tweet_created_at
+      t.string  :from_user
+      t.text    :text
+      t.string  :tweet_id
+      t.string  :link
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :tweets
+  end
+end

data/generators/tweetify_install/templates/tweetify.rb

@@ -0,0 +1,11 @@
+Tweet.search_string = "siyelo OR \"siyelo software\""
+Tweet.search_agent = "SOME_UNIQUE_IDENTIFIER"
+
+require 'rubygems'
+require 'rufus/scheduler'
+
+scheduler = Rufus::Scheduler.start_new(:frequency => 900.0)
+
+scheduler.every '1h' do
+  Tweet.cache_tweets
+end

data/generators/tweetify_install/tweetify_install_generator.rb

@@ -0,0 +1,15 @@
+
+class TweetifyInstallGenerator < Rails::Generator::Base
+
+  def manifest
+    record do |m|
+
+      m.migration_template 'migration.rb', 'db/migrate', :migration_file_name => "tweetify_create_blog_posts"
+
+      m.directory "config/initializers"
+      m.template  "tweetify.rb", "config/initializers/tweetify.rb"
+
+    end
+  end
+
+end

data/generators/tweetify_views/USAGE

@@ -0,0 +1,3 @@
+To copy the view partialsfrom tweetify to your app just run the following command:
+
+    script/generate tweetify_views

data/generators/tweetify_views/tweetify_views_generator.rb

@@ -0,0 +1,21 @@
+class TweetifyViewsGenerator < Rails::Generator::Base
+
+  def initialize(*args)
+    super
+    @source_root = options[:source] || File.join(spec.path, '..', '..')
+  end
+
+  def manifest
+    record do |m|
+      m.directory "app/views"
+
+      Dir[File.join(@source_root, "app", "views", "**/*.haml")].each do |file|
+        file = file.gsub(@source_root, "")[1..-1]
+
+        m.directory  File.dirname(file)
+        m.file       file, file
+      end
+    end
+  end
+
+end

data/init.rb

@@ -0,0 +1 @@
+require 'tweetify'

data/lib/tweetify.rb

@@ -0,0 +1,14 @@
+begin
+  require 'twitter_search'
+rescue
+  gem 'dancroak-twitter-search'
+  require 'twitter_search'
+end
+
+
+begin
+  require 'rufus/scheduler'
+rescue
+  gem 'rufus-scheduler'
+  require 'rufus/scheduler'
+end

data/test/performance/browsing_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+require 'performance_test_help'
+
+# Profiling results for each test method are written to tmp/performance.
+class BrowsingTest < ActionController::PerformanceTest
+  def test_homepage
+    get '/'
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,38 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
+require 'test_help'
+
+class ActiveSupport::TestCase
+  # Transactional fixtures accelerate your tests by wrapping each test method
+  # in a transaction that's rolled back on completion.  This ensures that the
+  # test database remains unchanged so your fixtures don't have to be reloaded
+  # between every test method.  Fewer database queries means faster tests.
+  #
+  # Read Mike Clark's excellent walkthrough at
+  #   http://clarkware.com/cgi/blosxom/2005/10/24#Rails10FastTesting
+  #
+  # Every Active Record database supports transactions except MyISAM tables
+  # in MySQL.  Turn off transactional fixtures in this case; however, if you
+  # don't care one way or the other, switching from MyISAM to InnoDB tables
+  # is recommended.
+  #
+  # The only drawback to using transactional fixtures is when you actually 
+  # need to test transactions.  Since your test is bracketed by a transaction,
+  # any transactions started in your code will be automatically rolled back.
+  self.use_transactional_fixtures = true
+
+  # Instantiated fixtures are slow, but give you @david where otherwise you
+  # would need people(:david).  If you don't want to migrate your existing
+  # test cases which use the @david style and don't mind the speed hit (each
+  # instantiated fixtures translates to a database query per test method),
+  # then set this back to true.
+  self.use_instantiated_fixtures  = false
+
+  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
+  #
+  # Note: You'll currently still have to declare fixtures explicitly in integration tests
+  # -- they do not yet inherit this setting
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

data/test/unit/blog_post_test.rb

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

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: siyelo-tweetify
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors: 
+- Glenn Roberts
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-04 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: edgar-twitter-search
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 0
+        - 5
+        - 10
+        version: 0.5.10
+  type: :runtime
+  version_requirements: *id001
+description: A Rails engine for embedding Twitter extracts
+email: glenn.roberts@siyelo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- TODO
+files: 
+- CHANGELOG
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- TODO
+- VERSION
+- app/models/tweet.rb
+- app/views/tweets/_list.html.haml
+- generators/tweetify_install/USAGE
+- generators/tweetify_install/templates/README
+- generators/tweetify_install/templates/migration.rb
+- generators/tweetify_install/templates/tweetify.rb
+- generators/tweetify_install/tweetify_install_generator.rb
+- generators/tweetify_views/USAGE
+- generators/tweetify_views/tweetify_views_generator.rb
+- init.rb
+- lib/tweetify.rb
+- test/performance/browsing_test.rb
+- test/test_helper.rb
+- test/unit/blog_post_test.rb
+has_rdoc: true
+homepage: http://github.com/siyelo/siyelo-tweetify
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --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: A Rails engine for embedding Twitter extracts
+test_files: 
+- test/performance/browsing_test.rb
+- test/test_helper.rb
+- test/unit/blog_post_test.rb