twalk 0.0.1 → 0.0.2

data/README.md

@@ -6,30 +6,22 @@ The idea is that in some situations you may only want a [Twitter](http://twitter
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Although you can get nicknames and tweets as you please, I've used the following:
 
+    gem 'twitter       # To get tweets
     gem 'twalk'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install twalk
+    gem 'twitter-text' # To format tweets
 
 ## Usage
 
 ```ruby
+nicknames = %w(_gareth cardiffrb)
+tweets = Twitter.home_timeline.collect { |tweet| tweet.text }
 
-# your_controller.rb
-users = User.all.collect { |user| user.nickname }
-users = %w(_gareth cardiffrb)
-
-@tweets = Twalk::Twalk.tweets_between(users)
+@twalks = Twalk.tweets_between(nicknames, tweets)
 
 # your_view.html.erb
-@tweets.each do |tweet|
+@twalks.each do |tweet|
   <div class="tweet">auto_link tweet.text</div>
 end
 ```    

data/Rakefile

@@ -1,2 +1,9 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['spec/*_spec.rb']
+  t.verbose = true
+end

data/lib/twalk.rb

@@ -1,5 +1,33 @@
 require "twalk/version"
 
 module Twalk
-  # Your code goes here...
+
+  class << self
+    # Public: Return an Array of Strings where nicknames mention each other
+    #
+    # nicknames - the Array of String twitter nicknames to be scanned
+    # tweets - the Array of Strings to be scanned
+    #
+    # Examples
+    #
+    # nicknames = %w(_gareth cardiffrb)
+    # tweets = Twitter.home_timeline.collect { |tweet| tweet.text }
+    #
+    # tweets_between(nicknames, tweets)
+    # # ...some processing...
+    # # => @_gareth: hey @cardiffrb!
+    # # => @cardiffrb: nice to meet you, @_gareth
+    #
+    # Returns an array of Strings
+    def tweets_between(nicknames, tweets)
+      tweets_to_show = []
+      tweets.each do |tweet|
+        nicknames.each do |user|
+          tweets_to_show << tweet if tweet.downcase.include? user
+        end
+      end
+      tweets_to_show.uniq
+    end
+  end
+
 end

data/lib/twalk/version.rb

@@ -1,3 +1,3 @@
 module Twalk
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/twalk_spec.rb

@@ -0,0 +1,53 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+
+path = File.expand_path(File.dirname(__FILE__) + "/../lib/")
+$LOAD_PATH.unshift(path) unless $LOAD_PATH.include?(path)
+require "twalk"
+
+describe Twalk do
+
+  def setup
+    @nicknames = %w(_gareth cardiffrb)
+    @tweets = ["hello @_gareth", "hi there @cardiffrb", "Tweet to no one", "Hi @_gareth and @cardiffrb"]
+  end
+
+  it "should return tweets that mention a nickname" do
+    Twalk::tweets_between(["@_gareth"], ["Hey @_gareth"]).size.must_equal 1
+  end
+
+  it "should not return tweets that do not mention a nickname" do
+    Twalk::tweets_between(["@_gareth"], ["Hey @twitter"]).size.must_equal 0
+  end
+
+  it "should not return duplicate tweets for tweets that mention several nickname" do
+    Twalk::tweets_between(["@_gareth", "@cardiffrb"], ["Hey @_gareth and @cardiffrb"]).size.must_equal 1
+  end
+
+  it "should not return duplicate tweets for tweets that mention the same nickname more than once" do
+    Twalk::tweets_between(["@_gareth"], ["Hey @_gareth. How are you @_gareth?"]).size.must_equal 1
+  end
+
+  it "should return tweets that mention a known and unknown nickname" do
+    Twalk::tweets_between(["@_gareth", "@twitter"], ["Hey @_gareth and @twitter"]).size.must_equal 1
+  end
+
+  it "should return multiple tweets that mention a nickname" do
+    Twalk::tweets_between(["@_gareth"], ["Hey @_gareth", "Hello @_gareth"]).size.must_equal 2
+  end
+
+  it "should return multiple tweets that mention individual nicknames" do
+    nicknames = ["@_gareth", "@cardiffrb"]
+    tweets = ["Hey @_gareth", "Hello @cardiffrb"]
+    Twalk::tweets_between(nicknames, tweets).size.must_equal 2
+  end
+
+  it "should return multiple tweets that mention individual nicknames, but not tweets to no one" do
+    Twalk::tweets_between(["@_gareth"], @tweets).size.must_equal 2
+  end
+
+  it "should return mutiple tweets that mention multiple nicknames, but not tweets to no one" do
+    Twalk::tweets_between(@nicknames, @tweets).size.must_equal 3
+  end
+
+end

data/twalk.gemspec

@@ -14,6 +14,4 @@ Gem::Specification.new do |gem|
   gem.name          = "twalk"
   gem.require_paths = ["lib"]
   gem.version       = Twalk::VERSION
-
-  gem.add_dependency('twitter', '>= 2.0.0')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twalk
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-27 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: twitter
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 2.0.0
+date: 2012-04-28 00:00:00.000000000 Z
+dependencies: []
 description: Twalk displays tweets of your followers who are talking to one another
 email:
 - gareth.h.rees@gmail.com
@@ -41,6 +25,7 @@ files:
 - Rakefile
 - lib/twalk.rb
 - lib/twalk/version.rb
+- spec/twalk_spec.rb
 - twalk.gemspec
 homepage: http://github.com/garethrees/twalk
 licenses: []
@@ -66,4 +51,5 @@ rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Twalk displays tweets of your followers who are talking to one another
-test_files: []
+test_files:
+- spec/twalk_spec.rb