friend_collection 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1 @@
+USE THIS CODE HOWEVER YOU WANT

data/README.rdoc

@@ -0,0 +1,3 @@
+= friend_collection
+
+YES!

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "friend_collection"
+    gem.summary = %Q{A way to pull all of a given users friends/followers}
+    gem.description = %Q{A way to pull all of a given users friends/followers}
+    gem.email = "matt.swasey@gmail.com"
+    gem.homepage = "http://github.com/mig/friend_collection"
+    gem.authors = ["Matt Swasey"]
+    gem.add_development_dependency "shoulda", ">= 0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "friend_collection #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/examples/config_store.rb

@@ -0,0 +1,38 @@
+class ConfigStore
+  attr_reader :file
+  
+  def initialize(file)
+    @file = file
+  end
+  
+  def load
+    @config ||= YAML::load(open(file))
+    self
+  end
+  
+  def [](key)
+    load
+    @config[key]
+  end
+  
+  def []=(key, value)
+    @config[key] = value
+  end
+  
+  def delete(*keys)
+    keys.each { |key| @config.delete(key) }
+    save
+    self
+  end
+  
+  def update(c={})
+    @config.merge!(c)
+    save
+    self
+  end
+  
+  def save
+    File.open(file, 'w') { |f| f.write(YAML.dump(@config)) }
+    self
+  end
+end

data/examples/connect.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/config_store'
+
+class Connect
+  attr_reader :client
+
+  def self.go!
+    new.client
+  end
+
+  def initialize
+    config = ConfigStore.new("#{ENV['HOME']}/.twitter")
+    oauth  = Twitter::OAuth.new(config['token'], config['secret'])
+
+    if config['atoken'] && config['asecret']
+      oauth.authorize_from_access(config['atoken'], config['asecret'])
+      @client = Twitter::Base.new(oauth)
+      
+    elsif config['rtoken'] && config['rsecret']  
+      oauth.authorize_from_request(config['rtoken'], config['rsecret'], config['pin'])
+      @client = Twitter::Base.new(oauth)
+      
+      config.update({
+                      'atoken'  => oauth.access_token.token,
+                      'asecret' => oauth.access_token.secret,
+                    }).delete('rtoken', 'rsecret')
+    else
+      config.update({
+                      'rtoken'  => oauth.request_token.token,
+                      'rsecret' => oauth.request_token.secret,
+                    })
+      
+      # authorize in browser
+      %x(open #{oauth.request_token.authorize_url})
+    end
+
+  end
+end

data/examples/friends.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'twitter'
+
+require 'connect'
+require File.dirname(__FILE__) + '/../lib/friend_collection'
+
+client = Connect.go!
+fc = Twitter::FriendCollection.new(client)
+fc.fetch_all
+puts fc.collection
+puts fc.collection.length

data/friend_collection.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{friend_collection}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Matt Swasey"]
+  s.date = %q{2010-03-17}
+  s.description = %q{A way to pull all of a given users friends/followers}
+  s.email = %q{matt.swasey@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "examples/config_store.rb",
+     "examples/connect.rb",
+     "examples/friends.rb",
+     "friend_collection.gemspec",
+     "lib/friend_collection.rb",
+     "test/helper.rb",
+     "test/test_friend_collection.rb"
+  ]
+  s.homepage = %q{http://github.com/mig/friend_collection}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A way to pull all of a given users friends/followers}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_friend_collection.rb",
+     "examples/config_store.rb",
+     "examples/connect.rb",
+     "examples/friends.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<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end
+

data/lib/friend_collection.rb

@@ -0,0 +1,58 @@
+require 'forwardable'
+
+module Twitter
+  class FriendCollection
+    extend Forwardable
+
+    attr_accessor :client, 
+                  :relationship_type, 
+                  :page, 
+                  :collection,
+                  :limit
+
+    def_delegators :client, :friends, :followers
+    
+    def initialize(client, relationship_type = :friends, limit = 500)
+      @client = client
+      @relationship_type = relationship_type.to_sym
+      @collection = []
+      @limit = limit
+    end
+
+    def first_cursor
+      -1
+    end
+
+    def next_cursor
+      page['next_cursor']
+    end
+
+    def first_or_next_cursor
+      if page.nil?
+        first_cursor
+      else 
+        next_cursor
+      end
+    end
+
+    def no_more_cursors
+      first_or_next_cursor == 0
+    end
+
+    def over_limit?
+      collection.length >= limit
+    end
+
+    def fetch
+      self.page = send(relationship_type, {:cursor => first_or_next_cursor})
+    end
+
+    def fetch_all
+      until no_more_cursors || over_limit?
+        fetch
+        collection << page['users']
+      end
+      collection.flatten!
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'friend_collection'
+
+class Test::Unit::TestCase
+end

data/test/test_friend_collection.rb

@@ -0,0 +1,81 @@
+require 'helper'
+
+class TestFriendCollection < Test::Unit::TestCase
+  context "an instance of FriendCollection" do
+    setup do
+      @client = stub('client')
+      @friend_collection = Twitter::FriendCollection.new(@client)
+    end
+
+    should "call friends on client for fetch when friends is relationship type" do
+      @client.expects(:friends)
+      @friend_collection.stubs(:relationship_type).returns(:friends)
+      @friend_collection.fetch
+    end
+
+    should "call followers on client for fetch when followers is relationship type" do
+      @client.expects(:followers)
+      @friend_collection.stubs(:relationship_type).returns(:followers)
+      @friend_collection.fetch
+    end
+
+    should "set page to be result of relationship_type called on client" do
+      @client.expects(:friends).returns('result')
+      @friend_collection.fetch
+      assert_equal 'result', @friend_collection.page
+    end
+
+    should "use first_or_next_cursor value when calling relation_type on client" do
+      @client.expects(:friends).with(:cursor => "12345")
+      @friend_collection.stubs(:first_or_next_cursor).returns("12345")
+      @friend_collection.fetch
+    end
+
+    should "use -1 as the first cursor" do
+      assert_equal -1, @friend_collection.first_cursor
+    end
+
+    should "use value in page as next cursor" do
+      @friend_collection.expects(:page).returns('next_cursor' => '1234')
+      assert_equal '1234', @friend_collection.next_cursor
+    end
+
+    should "set initial cursor to -1" do
+      assert_equal -1, @friend_collection.first_or_next_cursor
+    end
+
+    should "set next cursor to next_cursor value in page" do
+      @friend_collection.page = {'next_cursor' => '12345'}
+      assert_equal "12345", @friend_collection.first_or_next_cursor
+    end
+
+    should "determine if there are no more cursors by next_cursor" do
+      @friend_collection.expects(:first_or_next_cursor).returns(1)
+      assert_equal false, @friend_collection.no_more_cursors
+    end
+    
+    should "determine if we are over friend limits" do
+      @friend_collection.limit = 2
+
+      @friend_collection.collection << "1"
+      assert_equal false, @friend_collection.over_limit?
+
+      @friend_collection.collection << "2"
+      assert_equal true, @friend_collection.over_limit?
+    end
+
+    should "fetch pages of results till there are no more cursors" do
+      @friend_collection.expects(:no_more_cursors).times(3).returns(false, false, true)
+      @friend_collection.expects(:first_or_next_cursor).times(2).returns(-1, 12345)
+      @client.expects(:friends).with({:cursor => -1}).returns('users' => ['friends'])
+      @client.expects(:friends).with({:cursor => 12345}).returns('users' => [])
+      @friend_collection.fetch_all
+    end
+
+    should "fetch page of results till over limit" do
+      @friend_collection.limit = 1
+      @client.expects(:friends).returns({'users' => ['1']}, {'users' => []})
+      @friend_collection.fetch_all
+    end
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: friend_collection
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Matt Swasey
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-17 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: A way to pull all of a given users friends/followers
+email: matt.swasey@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- examples/config_store.rb
+- examples/connect.rb
+- examples/friends.rb
+- friend_collection.gemspec
+- lib/friend_collection.rb
+- test/helper.rb
+- test/test_friend_collection.rb
+has_rdoc: true
+homepage: http://github.com/mig/friend_collection
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A way to pull all of a given users friends/followers
+test_files: 
+- test/helper.rb
+- test/test_friend_collection.rb
+- examples/config_store.rb
+- examples/connect.rb
+- examples/friends.rb