faketwitter 0.1.4

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ben Mabey
+
+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.textile

@@ -0,0 +1,21 @@
+h1. faketwitter
+
+Factory goodness for twitter search responses wrapped in FakeWeb awesomeness.
+
+<pre>
+irb(main):001:0> require 'faketwitter'
+=> true
+irb(main):002:0> require 'twitter_search'
+=> true
+irb(main):003:0> FakeTwitter.register_search("#cheese", {:results => [{:text => "#cheese is good"}]})
+=> [#<FakeWeb::Responder:0x19792c0 @times=1, @uri="http://search.twitter.com/search.json?q=%23cheese", @options={:body=>"{"results":[{"text":"#cheese is good","from_user":"jojo","to_user_id":null,"id":1,"from_user_id":1,"iso_language_code":"en","source":"&lt;a href=&quot;http:\\/\\/twitter.com\\/&quot;&gt;web&lt;\\/a&gt;","created_at":"Fri, 21 Aug 2009 09:31:27 +0000","profile_image_url":"http:\\/\\/s3.amazonaws.com\\/twitter_production\\/profile_images\\/1\\/photo.jpg"}],"since_id":0,"max_id":1,"results_per_page":15,"completed_in":0.008646,"page":1,"query":"%23cheese"}"}, method:get]
+irb(main):004:0> TwitterSearch::Client.new('').query('#cheese')
+=> [#<TwitterSearch::Tweet:0x196cef8 @id=1, @text="#cheese is good", @created_at="Fri, 21 Aug 2009 09:31:27 +0000", @to_user_id=nil, @from_user_id=1, @to_user=nil, @source="&lt;a href=&quot;http://twitter.com/&quot;&gt;web&lt;/a&gt;", @iso_language_code="en", @from_user="jojo", @language="en", @profile_image_url="http://s3.amazonaws.com/twitter_production/profile_images/1/photo.jpg">]
+irb(main):005:0> 
+
+</pre>
+
+For an example on how to use this in Cucumber see this "scenario":http://github.com/bmabey/codenote/blob/master/features/twitter_quiz.feature#L31-34 and the corresponding "step definitions":http://github.com/bmabey/codenote/blob/master/features/step_definitions/twitter_search_steps.rb#L1-12.
+
+Documentation is lacking at this point, but there really isn't much to this gem.  Take a look at the "code":http://github.com/bmabey/faketwitter/blob/master/lib/faketwitter.rb and the corresponding "RSpec examples":http://github.com/bmabey/faketwitter/blob/master/spec/faketwitter_spec.rb.
+

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "faketwitter"
+    gem.summary = %Q{Easily stub out Twitter searches}
+    gem.description = %Q{FakeWeb wrapper for Twitter and factories to build tweets and search responses}
+    gem.email = "ben@benmabey.com"
+    gem.homepage = "http://github.com/bmabey/faketwitter"
+    gem.authors = ["Ben Mabey"]
+    gem.add_development_dependency "rspec"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "faketwitter #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.4

data/faketwitter.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{faketwitter}
+  s.version = "0.1.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ben Mabey"]
+  s.date = %q{2009-11-03}
+  s.description = %q{FakeWeb wrapper for Twitter and factories to build tweets and search responses}
+  s.email = %q{ben@benmabey.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "faketwitter.gemspec",
+     "lib/core_ext/hash.rb",
+     "lib/faketwitter.rb",
+     "spec/faketwitter_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/bmabey/faketwitter}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{Easily stub out Twitter searches}
+  s.test_files = [
+    "spec/faketwitter_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end

data/lib/core_ext/hash.rb

@@ -0,0 +1,10 @@
+class Hash
+  # stolen from ActiveSupport
+  def stringify_keys
+    inject({}) do |options, (key, value)|
+      options[key.to_s] = value
+      options
+    end
+  end
+end
+

data/lib/faketwitter.rb

@@ -0,0 +1,172 @@
+require 'fakeweb'
+require 'cgi'
+require File.dirname(__FILE__) + "/core_ext/hash"
+
+module FakeTwitter
+
+  class << self
+
+    def register_search(query, search_options = {})
+      return register_searches(query, search_options) if search_options.is_a?(Array)
+      escaped_query = CGI.escape(query)
+      search_options['query'] = escaped_query
+      FakeWeb.register_uri(
+        :get,
+        search_url(escaped_query),
+        fake_web_options(search_options)
+      )
+    end
+
+    def register_searches(query, rotated_search_options)
+      escaped_query = CGI.escape(query)
+      search_results = rotated_search_options.map do |search_options|
+        search_options['query'] = escaped_query
+        fake_web_options(search_options)
+      end
+      FakeWeb.register_uri(
+        :get,
+        search_url(escaped_query),
+        search_results
+      )
+    end
+
+    def reset
+      FakeWeb.clean_registry
+      TweetFactory.reset
+    end
+
+    def new_tweet(attributes)
+      TweetFactory.create(attributes)
+    end
+
+    def search_response(options={})
+      SearchResponseFactory.create(options)
+    end
+
+    def tweets_from(user)
+      TweetFactory.tweets_from(user)
+    end
+
+    private
+
+    def search_url(escaped_query)
+      "http://search.twitter.com/search.json?q=#{escaped_query}"
+    end
+
+    def fake_web_options(search_options)
+      {:body => search_response(search_options).to_json}
+    end
+
+  end
+
+
+  class SearchResponseFactory
+    DEFAULTS = {
+      'results' => [],
+      'since_id' => 0,
+      'max_id' => -1,
+      'results_per_page' => 15,
+      'completed_in' => 0.008646,
+      'page' => 1,
+      'query' => ''
+    }
+
+    class << self
+
+      def create(attributes)
+        # TODO: remove duplication between factories.
+        response =   DEFAULTS.merge(attributes.stringify_keys)
+        response['results'] = create_tweets(response['results'].dup)
+
+        unless response['results'].empty?
+          response['max_id'] = response['results'].map { |t| t['id'] }.max
+        end
+
+        response
+      end
+
+
+      private
+      def create_tweets(tweets)
+        now = Time.now
+        tweets.sort! do |tweet_a, tweet_b|
+          (tweet_b['created_at'] || now) <=> (tweet_a['created_at'] || now)
+        end
+        # We do the reverses so that the id's are auto-incremented correctly
+        tweets.reverse!.map! do |tweet_hash|
+          tweet = FakeTwitter.new_tweet(tweet_hash)
+          # hardcoding +0000 because %z was giving -0700 for UTC for some reason (leopard MRI)..
+          tweet['created_at'] = tweet['created_at'].utc.strftime("%a, %d %b %Y %H:%M:%S +0000")
+          tweet['source'] = CGI.escapeHTML(tweet['source'])
+          tweet
+        end
+
+        tweets.reverse!
+      end
+
+    end
+
+  end
+
+  class TweetFactory
+    DEFAULTS = {
+       "text"=>"just some tweet",
+       "from_user"=>"jojo",
+       "to_user_id"=>nil,
+       "iso_language_code"=>"en",
+       "source"=>'<a href="http://twitter.com/">web</a>',
+    }
+
+    class << self
+
+      def reset
+        @counter = nil
+        @users = nil
+        @tweet_repo = nil
+      end
+
+      def create(attributes)
+        tweet                       =   DEFAULTS.merge(attributes.stringify_keys)
+        clean_user_names(tweet)
+        tweet['id']                 ||= counter(:id)
+        tweet['from_user_id']       ||= user_id_for(tweet['from_user'])
+        tweet['to_user_id']         ||= user_id_for(tweet['to_user'])
+        tweet['profile_image_url']  ||= "http://s3.amazonaws.com/twitter_production/profile_images/#{tweet['from_user_id']}/photo.jpg"
+        tweet['created_at']         ||= Time.now
+
+        tweet_repo << tweet
+        tweet
+      end
+
+      def tweets_from(user)
+        tweet_repo.select { |tweet| tweet['from_user'] == user }
+      end
+
+      private
+
+      def counter(counter_type)
+        @counter ||= Hash.new(0)
+        @counter[counter_type] += 1
+      end
+
+      def user_id_for(user)
+        return unless user
+        @users ||= {}
+        @users[user] ||= counter(:user_id)
+      end
+
+      def clean_user_names(tweet)
+        ['from_user', 'to_user'].each do |key|
+          next unless tweet[key]
+          tweet[key].sub!('@','')
+        end
+      end
+
+      def tweet_repo
+        @tweet_repo ||= []
+      end
+
+    end
+  end
+
+end

data/spec/faketwitter_spec.rb

@@ -0,0 +1,195 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'activesupport'
+
+describe FakeTwitter do
+  before(:each) do
+    FakeTwitter.reset
+  end
+
+  describe '::register_search' do
+    it "registers the twitter search url and the specified query with FakeWeb" do
+      # expect
+      FakeWeb.should_receive(:register_uri).with(:get, "http://search.twitter.com/search.json?q=%23foo+%22some+string%22", anything)
+      # when
+      FakeTwitter.register_search('#foo "some string"', {})
+    end
+
+    it "uses the provided tweets for the stubbed response" do
+      # given
+      created_at = Time.parse("Thu, 20 Aug 2009 23:23:09 +0000")
+      tweets = [
+        {:from_user => "bmabey", :id => 1000, :from_user_id => 100,
+         :created_at => created_at, :text => 'making FakeTwitter'}
+      ]
+
+      # expect
+      expected_json_tweet = <<-EOT
+  {
+      "text": "making FakeTwitter",
+      "to_user_id": null,
+      "from_user": "bmabey",
+      "id": 1000,
+      "from_user_id": 100,
+      "iso_language_code": "en",
+      "source": "&lt;a href=&quot;http:\/\/twitter.com\/&quot;&gt;web&lt;\/a&gt;",
+      "profile_image_url": "http:\/\/s3.amazonaws.com\/twitter_production\/profile_images\/100\/photo.jpg",
+      "created_at": "Thu, 20 Aug 2009 23:23:09 +0000"
+  }
+      EOT
+
+      FakeWeb.should_receive(:register_uri).with do |_, _, fakeweb_return_options|
+        json = fakeweb_return_options[:body]
+        JSON.parse(json)['results'].first.should == JSON.parse(expected_json_tweet)
+      end
+
+      # when
+      FakeTwitter.register_search('foo', :results => tweets)
+    end
+
+    it "includes the escaped query in the response" do
+      FakeWeb.should_receive(:register_uri).with do |_, _, fakeweb_return_options|
+        json = fakeweb_return_options[:body]
+        JSON.parse(json)['query'].should == "%23foo"
+      end
+
+      # when
+      FakeTwitter.register_search('#foo')
+    end
+
+  end
+
+  describe '::register_searches' do
+    it "registers the multiple search results with FakeWeb to be rotated" do
+      # expect
+      FakeWeb.should_receive(:register_uri).with do |_, _, fakeweb_return_options|
+        fakeweb_return_options.size.should == 2
+        first_result_set = JSON.parse(fakeweb_return_options.first[:body])
+        second_result_set = JSON.parse(fakeweb_return_options.last[:body])
+        first_result_set['results'].should be_empty
+        second_result_set['results'].first['text'] == 'foo bar'
+      end
+
+      # when
+      FakeTwitter.register_searches('foo', [
+        {:results => []},
+        {:results => [{:text => 'foo bar'}]}
+      ])
+    end
+  end
+
+
+  describe '::search_response' do
+    it "has sane defaults for the other response values" do
+      response = FakeTwitter.search_response()
+      response.slice(*%w[since_id max_id results_per_page completed_in page query]).should == {
+          'since_id' =>   0,
+          'max_id'   =>  -1,
+          'results_per_page' => 15,
+          'completed_in' => 0.008646,
+          'page' => 1,
+          'query' => ''
+      }
+    end
+
+    it "sets the max_id based on the highest tweet id in the result set" do
+      response = FakeTwitter.search_response(:results => [{:id => 1}, {:id => 100}])
+      response['max_id'].should == 100
+    end
+
+    it "creates the tweets based on the defined created_at times if possible" do
+      response = FakeTwitter.search_response(:results => [
+        {'created_at' => Time.now - 100, :text => 'first tweet'},
+        {'created_at' => Time.now, :text => 'most recent tweet'}
+      ])
+      response['results'].first['text'].should == 'most recent tweet'
+      response['results'].first['id'].should > response['results'].last['id']
+    end
+  end
+
+
+
+  describe '::new_tweet' do
+    it "returns hash of an API compliant tweet with sane defaults" do
+      tweet = FakeTwitter.new_tweet({})
+      tweet.slice(*%w[text from_user to_user_id iso_language_code source]).should == {
+       "text"=>"just some tweet",
+       "from_user"=>"jojo",
+       "to_user_id"=>nil,
+       "iso_language_code"=>"en",
+       "source"=>'<a href="http://twitter.com/">web</a>',
+      }
+    end
+
+    it "auto-increments the tweet ids when they are not provided" do
+      FakeTwitter.new_tweet({})['id'].should == 1
+      FakeTwitter.new_tweet({})['id'].should == 2
+    end
+
+    it "auto-increments user ids when none are provided" do
+      FakeTwitter.new_tweet({'from_user' => 'jojo'})['from_user_id'].should == 1
+      FakeTwitter.new_tweet({'from_user' => 'krusty'})['from_user_id'].should == 2
+    end
+
+    it "assigns a user_id for to_user when needed" do
+      FakeTwitter.new_tweet({'to_user' => 'billy'})['to_user_id'].should_not be_nil
+    end
+
+
+    it "resuses the same user id for tweets made for the same user" do
+      FakeTwitter.new_tweet({'from_user' => 'jojo'})['from_user_id'].should == 1
+      FakeTwitter.new_tweet({'from_user' => 'jojo'})['from_user_id'].should == 1
+    end
+
+    it "defaults create_at to Time.now" do
+      Time.stub!(:now => 'current time')
+      FakeTwitter.new_tweet({})['created_at'].should == 'current time'
+    end
+
+    it "bases the default profile_image_url off of the user id" do
+      FakeTwitter.new_tweet('from_user_id' => 123)['profile_image_url'].
+        should == "http://s3.amazonaws.com/twitter_production/profile_images/123/photo.jpg"
+    end
+
+    it "strips leading @s from user names" do
+      tweet = FakeTwitter.new_tweet('from_user' => '@james', 'to_user' => '@john')
+      tweet['from_user'].should == 'james'
+      tweet['to_user'].should == 'john'
+    end
+  end
+
+  describe '::tweets_from' do
+    it "returns all the tweets that have been created from the specified user" do
+      FakeTwitter.search_response(:results => [
+        {'from_user' => 'ben', 'text' => 'hello'},
+        {'from_user' => 'ben', 'text' => 'goodbye'},
+        {'from_user' => 'someone_else', 'text' => 'just sending a tweet'}
+      ])
+
+      tweets = FakeTwitter.tweets_from('ben')
+      tweets.map { |t| t['text'] }.should == ['goodbye', 'hello']
+    end
+  end
+
+  describe '::reset' do
+    it "tells FakeWeb to clean it's registry" do
+      FakeWeb.should_receive(:clean_registry)
+      FakeTwitter.reset
+    end
+    it "resets the user id counter for tweets" do
+      FakeTwitter.new_tweet('from_user' => 'foo')['from_user_id'].should == 1
+      FakeTwitter.reset
+      FakeTwitter.new_tweet('from_user' => 'bar')['from_user_id'].should == 1
+    end
+    it "resets the tweet id counter" do
+      FakeTwitter.new_tweet('from_user' => 'foo')['id'].should == 1
+      FakeTwitter.reset
+      FakeTwitter.new_tweet('from_user' => 'foo')['id'].should == 1
+    end
+    it "clears the sent tweets" do
+      FakeTwitter.new_tweet('from_user' => 'foo')
+      FakeTwitter.reset
+      FakeTwitter.tweets_from('foo').should be_empty
+    end
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+-c
+-f
+nested
+--diff

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'faketwitter'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: faketwitter
+version: !ruby/object:Gem::Version 
+  version: 0.1.4
+platform: ruby
+authors: 
+- Ben Mabey
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-03 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: FakeWeb wrapper for Twitter and factories to build tweets and search responses
+email: ben@benmabey.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- faketwitter.gemspec
+- lib/core_ext/hash.rb
+- lib/faketwitter.rb
+- spec/faketwitter_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/bmabey/faketwitter
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.3
+signing_key: 
+specification_version: 3
+summary: Easily stub out Twitter searches
+test_files: 
+- spec/faketwitter_spec.rb
+- spec/spec_helper.rb