mbbx6spp-twitter4r 0.3.1

data/lib/twitter/client/user.rb

@@ -0,0 +1,65 @@
+class Twitter::Client
+  @@USER_URIS = {
+  	:info => '/users/show',
+  	:friends => '/statuses/friends.json',
+  	:followers => '/statuses/followers.json',
+  }
+  
+  # Provides access to Twitter's User APIs
+  # 
+  # Returns user instance for the <tt>id</tt> given.  The <tt>id</tt>
+  # can either refer to the numeric user ID or the user's screen name.
+  # 
+  # For example,
+  #  @twitter.user(234943) #=> Twitter::User object instance for user with numeric id of 234943
+  #  @twitter.user('mylogin') #=> Twitter::User object instance for user with screen name 'mylogin'
+  # 
+  # Where <tt>options</tt> is a +Hash+ of options that can include:
+  # * <tt>:page</tt> - optional.  Retrieves the next set of friends.  There are 100 friends per page.  Default: 1.
+  # * <tt>:lite</tt> - optional.  Prevents the inline inclusion of current status.  Default: false.
+  # * <tt>:since</tt> - optional.  Only relevant for <tt>:friends</tt> action.  Narrows the results to just those friends added after the date given as value of this option.  Must be HTTP-formatted date.
+  #
+  # An <tt>ArgumentError</tt> will be raised if an invalid <tt>action</tt> 
+  # is given.  Valid actions are:
+  # * +:info+
+  # * +:friends+
+  # 
+  # +Note:+ You should not use this method to attempt to retrieve the 
+  # authenticated user's followers.  Please use any of the following 
+  # ways of accessing this list:
+  #  followers = client.my(:followers)
+  # OR
+  #  followers = client.my(:info).followers
+  def user(id, action = :info, options = {})
+    raise ArgumentError, "Invalid user action: #{action}" unless @@USER_URIS.keys.member?(action)
+    id = id.to_i if id.is_a?(Twitter::User)
+    params = options.merge(:id => id)
+    response = http_connect {|conn| create_http_get_request(@@USER_URIS[action], params) }
+    bless_models(Twitter::User.unmarshal(response.body))
+  end
+  
+  # Syntactic sugar for queries relating to authenticated user in Twitter's User API
+  # 
+  # Where <tt>action</tt> is one of the following:
+  # * <tt>:info</tt> - Returns user instance for the authenticated user.
+  # * <tt>:friends</tt> - Returns Array of users that are authenticated user's friends
+  # * <tt>:followers</tt> - Returns Array of users that are authenticated user's followers
+  # 
+  # Where <tt>options</tt> is a +Hash+ of options that can include:
+  # * <tt>:page</tt> - optional.  Retrieves the next set of friends.  There are 100 friends per page.  Default: 1.
+  # * <tt>:lite</tt> - optional.  Prevents the inline inclusion of current status.  Default: false.
+  # * <tt>:since</tt> - optional.  Only relevant for <tt>:friends</tt> action.  Narrows the results to just those friends added after the date given as value of this option.  Must be HTTP-formatted date.
+  #
+  # An <tt>ArgumentError</tt> will be raised if an invalid <tt>action</tt> 
+  # is given.  Valid actions are:
+  # * +:info+
+  # * +:friends+
+  # * +:followers+
+  def my(action, options = {})
+    raise ArgumentError, "Invalid user action: #{action}" unless @@USER_URIS.keys.member?(action)
+    params = options.merge(:id => @login)
+    response = http_connect {|conn| create_http_get_request(@@USER_URIS[action], params) }
+    users = Twitter::User.unmarshal(response.body)
+    bless_models(users)
+  end
+end

data/lib/twitter/client.rb

@@ -0,0 +1,21 @@
+# client.rb contains the classes, methods and extends <tt>Twitter4R</tt> 
+# features to define client calls to the Twitter REST API.
+# 
+# See:
+# * <tt>Twitter::Client</tt>
+
+# Used to query or post to the Twitter REST API to simplify code.
+class Twitter::Client
+  include Twitter::ClassUtilMixin
+end
+
+require('twitter/client/base.rb')
+require('twitter/client/timeline.rb')
+require('twitter/client/status.rb')
+require('twitter/client/friendship.rb')
+require('twitter/client/messaging.rb')
+require('twitter/client/user.rb')
+require('twitter/client/auth.rb')
+require('twitter/client/favorites.rb')
+require('twitter/client/blocks.rb')
+require('twitter/client/account.rb')

data/lib/twitter/config.rb

@@ -0,0 +1,71 @@
+# config.rb contains classes, methods and extends existing Twitter4R classes 
+# to provide easy configuration facilities.
+
+module Twitter
+  # Represents global configuration for Twitter::Client.
+  # Can override the following configuration options:
+  # * <tt>protocol</tt> - <tt>:http</tt>, <tt>:https</tt> or <tt>:ssl</tt> supported.  <tt>:ssl</tt> is an alias for <tt>:https</tt>.  Defaults to <tt>:ssl</tt>
+  # * <tt>host</tt> - hostname to connect to for the Twitter service.  Defaults to <tt>'twitter.com'</tt>.
+  # * <tt>port</tt> - port to connect to for the Twitter service.  Defaults to <tt>443</tt>.
+  # * <tt>proxy_host</tt> - proxy host to use.  Defaults to nil.
+  # * <tt>proxy_port</tt> - proxy host to use.  Defaults to nil.
+  # * <tt>proxy_user</tt> - proxy username to use.  Defaults to nil.
+  # * <tt>proxy_pass</tt> - proxy password to use.  Defaults to nil.
+  # * <tt>user_agent</tt> - user agent string to use for each request of the HTTP header.
+  # * <tt>application_name</tt> - name of your client application.  Defaults to 'Twitter4R'
+  # * <tt>application_version</tt> - version of your client application.  Defaults to current <tt>Twitter::Version.to_version</tt>.
+  # * <tt>application_url</tt> - URL of your client application.  Defaults to http://twitter4r.rubyforge.org.
+  # * <tt>source</tt> - the source id given to you by Twitter to identify your application in their web interface.  Note: you must contact Twitter.com developer directly so they can configure their servers appropriately.
+  class Config
+    include ClassUtilMixin
+    @@ATTRIBUTES = [
+      :protocol, 
+      :host, 
+      :port, 
+      :proxy_host, 
+      :proxy_port, 
+      :proxy_user, 
+      :proxy_pass, 
+      :user_agent,
+      :application_name,
+      :application_version,
+      :application_url,
+      :source,
+    ]
+    attr_accessor *@@ATTRIBUTES
+    
+    # Override of Object#eql? to ensure RSpec specifications run 
+    # correctly. Also done to follow Ruby best practices.
+    def eql?(other)
+      return true if self == other
+      @@ATTRIBUTES.each do |att|
+        return false unless self.send(att).eql?(other.send(att))
+      end
+      true
+    end
+  end
+
+  class Client
+    @@defaults = { :host => 'twitter.com', 
+                   :port => 443, 
+                   :protocol => :ssl,
+                   :proxy_host => nil,
+                   :proxy_port => nil,
+                   :user_agent => "default",
+                   :application_name => 'Twitter4R',
+                   :application_version => Twitter::Version.to_version,
+                   :application_url => 'http://twitter4r.rubyforge.org',
+                   :source => 'twitter4r',
+    }
+    @@config = Twitter::Config.new(@@defaults)
+
+    # Twitter::Client class methods
+    class << self
+      # Yields to given <tt>block</tt> to configure the Twitter4R API.
+      def configure(&block)
+        raise ArgumentError, "Block must be provided to configure" unless block_given?
+        yield @@config
+      end # configure
+    end # class << self    
+  end # Client class
+end # Twitter module

data/lib/twitter/console.rb

@@ -0,0 +1,28 @@
+# Contains hooks for the twitter console
+
+module Twitter
+  class Client
+    class << self
+      # Helper method mostly for irb shell prototyping.
+      # 
+      # Reads in login/password Twitter credentials from YAML file
+      # found at the location given by <tt>config_file</tt> that has 
+      # the following format:
+      #  envname:
+      #    login: mytwitterlogin
+      #    password: mytwitterpassword
+      # 
+      # Where <tt>envname</tt> is the name of the environment like 'test', 
+      # 'dev' or 'prod'.  The <tt>env</tt> argument defaults to 'test'.
+      # 
+      # To use this in the shell you would do something like the following 
+      # examples:
+      #  twitter = Twitter::Client.from_config('config/twitter.yml', 'dev')
+      #  twitter = Twitter::Client.from_config('config/twitter.yml')
+      def from_config(config_file, env = 'test')
+        yaml_hash = YAML.load(File.read(config_file))
+        self.new yaml_hash[env]
+      end
+    end # class << self
+  end
+end

data/lib/twitter/core.rb

@@ -0,0 +1,137 @@
+# The Twitter4R API provides a nicer Ruby object API to work with 
+# instead of coding around the REST API.
+
+# Module to encapsule the Twitter4R API.
+module Twitter
+  # Mixin module for classes that need to have a constructor similar to
+  # Rails' models, where a <tt>Hash</tt> is provided to set attributes
+  # appropriately.
+  # 
+  # To define a class that uses this mixin, use the following code:
+  #  class FilmActor
+  #    include ClassUtilMixin
+  #  end
+  module ClassUtilMixin #:nodoc:
+    def self.included(base) #:nodoc:
+      base.send(:include, InstanceMethods)
+    end
+    
+    # Instance methods defined for <tt>Twitter::ModelMixin</tt> module.
+    module InstanceMethods #:nodoc:
+      # Constructor/initializer that takes a hash of parameters that 
+      # will initialize *members* or instance attributes to the 
+      # values given.  For example,
+      # 
+      #  class FilmActor
+      #    include Twitter::ClassUtilMixin
+      #    attr_accessor :name
+      #  end
+      #  
+      #  class Production
+      #    include Twitter::ClassUtilMixin
+      #    attr_accessor :title, :year, :actors
+      #  end
+      #  
+      #  # Favorite actress...
+      #  jodhi = FilmActor.new(:name => "Jodhi May")
+      #  jodhi.name # => "Jodhi May"
+      #  
+      #  # Favorite actor...
+      #  robert = FilmActor.new(:name => "Robert Lindsay")
+      #  robert.name # => "Robert Lindsay"
+      #  
+      #  # Jane is also an excellent pick...gotta love her accent!
+      #  jane = FilmActor.new(name => "Jane Horrocks")
+      #  jane.name # => "Jane Horrocks"
+      #  
+      #  # Witty BBC series...
+      #  mrs_pritchard = Production.new(:title => "The Amazing Mrs. Pritchard", 
+      #                                 :year => 2005, 
+      #                                 :actors => [jodhi, jane])
+      #  mrs_pritchard.title  # => "The Amazing Mrs. Pritchard"
+      #  mrs_pritchard.year   # => 2005
+      #  mrs_pritchard.actors # => [#<FilmActor:0xb79d6bbc @name="Jodhi May">, 
+      #  <FilmActor:0xb79d319c @name="Jane Horrocks">]
+      #  # Any Ros Pritchard's out there to save us from the Tony Blair
+      #  # and Gordon Brown *New Labour* debacle?  You've got my vote! 
+      #  
+      #  jericho = Production.new(:title => "Jericho", 
+      #                           :year => 2005, 
+      #                           :actors => [robert])
+      #  jericho.title   # => "Jericho"
+      #  jericho.year    # => 2005
+      #  jericho.actors  # => [#<FilmActor:0xc95d3eec @name="Robert Lindsay">]
+      # 
+      # Assuming class <tt>FilmActor</tt> includes 
+      # <tt>Twitter::ClassUtilMixin</tt> in the class definition 
+      # and has an attribute of <tt>name</tt>, then that instance 
+      # attribute will be set to "Jodhi May" for the <tt>actress</tt> 
+      # object during object initialization (aka construction for 
+      # you Java heads).
+      def initialize(params = {})
+        params.each do |key,val|
+          self.send("#{key}=", val) if self.respond_to? key
+        end
+        self.send(:init) if self.respond_to? :init
+      end
+      
+      protected
+        # Helper method to provide an easy and terse way to require 
+        # a block is provided to a method.
+        def require_block(block_given)
+          raise ArgumentError, "Must provide a block" unless block_given
+        end
+    end
+  end # ClassUtilMixin
+  
+  # Exception subclass raised when there is an error encountered upon 
+  # querying or posting to the remote Twitter REST API.
+  # 
+  # To consume and query any <tt>RESTError</tt> raised by Twitter4R:
+  #  begin
+  #    # Do something with your instance of <tt>Twitter::Client</tt>.
+  #    # Maybe something like:
+  #    timeline = twitter.timeline_for(:public)
+  #  rescue RESTError => re
+  #    puts re.code, re.message, re.uri
+  #  end
+  # Which on the code raising a <tt>RESTError</tt> will output something like:
+  #  404
+  #  Resource Not Found
+  #  /i_am_crap.json
+  class RESTError < Exception
+    include ClassUtilMixin
+    @@ATTRIBUTES = [:code, :message, :uri]
+    attr_accessor :code, :message, :uri
+    
+    # Returns string in following format:
+    #  "HTTP #{@code}: #{@message} at #{@uri}"
+    # For example,
+    #  "HTTP 404: Resource Not Found at /i_am_crap.json"
+    def to_s
+      "HTTP #{@code}: #{@message} at #{@uri}"
+    end
+  end # RESTError
+  
+  # Remote REST API interface representation
+  # 
+  class RESTInterfaceSpec
+  	include ClassUtilMixin
+  	
+  end
+  
+  # Remote REST API method representation
+  # 
+  class RESTMethodSpec
+  	include ClassUtilMixin
+  	attr_accessor :uri, :method, :parameters
+  end
+  
+  # Remote REST API method parameter representation
+  # 
+  class RESTParameterSpec
+  	include ClassUtilMixin
+  	attr_accessor :name, :type, :required
+  	def required?; @required; end
+  end
+end

data/lib/twitter/ext/stdlib.rb

@@ -0,0 +1,51 @@
+# Contains Ruby standard library extensions specific to <tt>Twitter4R</tt> library.
+
+# Extension to Hash to create URL encoded string from key-values
+class Hash
+  # Returns string formatted for HTTP URL encoded name-value pairs.
+  # For example,
+  #  {:id => 'thomas_hardy'}.to_http_str 
+  #  # => "id=thomas_hardy"
+  #  {:id => 23423, :since => Time.now}.to_http_str
+  #  # => "since=Thu,%2021%20Jun%202007%2012:10:05%20-0500&id=23423"
+  def to_http_str
+    result = ''
+    return result if self.empty?
+    self.each do |key, val|
+      result << "#{key}=#{CGI.escape(val.to_s)}&"
+    end
+    result.chop # remove the last '&' character, since it can be discarded
+  end
+end
+
+# Extension to Time that outputs RFC2822 compliant string on #to_s
+class Time
+  alias :old_to_s :to_s
+  
+  # Returns RFC2822 compliant string for <tt>Time</tt> object.
+  # For example,
+  #  # Tony Blair's last day in office (hopefully)
+  #  best_day_ever = Time.local(2007, 6, 27)
+  #  best_day_ever.to_s # => "Wed, 27 Jun 2007 00:00:00 +0100"
+  # You can also pass in an option <tt>format</tt> argument that 
+  # corresponds to acceptable values according to ActiveSupport's 
+  # +Time#to_formatted_s+ method.
+  def to_s(format = nil)
+    format ? self.to_formatted_s(format) : self.rfc2822
+  end
+end
+
+# Extension to Kernel to add #gem_present? without any exceptions raised
+module Kernel
+
+  # Returns whether or not a gem exists without raising a Gem::LoadError exception
+  def gem_present?(gem_name, version = nil)
+    present = false
+    begin
+      present = gem(gem_name, version)
+    rescue Gem::LoadError => le
+      warn("Gem load error: Couldn't load #{gem_name} with version requirement #{version}: #{le.to_s}")
+    end
+    present
+  end
+end

data/lib/twitter/ext.rb

@@ -0,0 +1,2 @@
+
+require_local('twitter/ext/stdlib')

data/lib/twitter/extras.rb

@@ -0,0 +1,39 @@
+# extra.rb contains features that are not considered part of the core library.
+# This file is not imported by doing <tt>require('twitter')</tt>, so you will 
+# need to import this file separately like:
+#  require('twitter')
+#  require('twitter/extras')
+
+require('twitter')
+
+class Twitter::Client
+  @@FEATURED_URIS = {
+    :users => 'http://twitter.com/statuses/featured.json'
+  }
+  
+  # Provides access to the Featured Twitter API.
+  # 
+  # Currently the only value for <tt>type</tt> accepted is <tt>:users</tt>,
+  # which will return an Array of blessed Twitter::User objects that 
+  # represent Twitter's featured users.
+  def featured(type)
+    uri = @@FEATURED_URIS[type]
+    response = http_connect {|conn| create_http_get_request(uri) }
+    bless_models(Twitter::User.unmarshal(response.body))
+  end
+end
+
+class Twitter::User
+  class << self
+    # Provides access to the Featured Twitter API via the Twitter4R Model 
+    # interface.
+    # 
+    # The following lines of code are equivalent to each other:
+    #  users1 = Twitter::User.features(client)
+    #  users2 = client.featured(:users)
+    # where <tt>users1</tt> and <tt>users2</tt> would be logically equivalent.
+    def featured(client)
+      client.featured(:users)
+    end
+  end
+end

data/lib/twitter/meta.rb

@@ -0,0 +1,56 @@
+# meta.rb contains <tt>Twitter::Meta</tt> and related classes that
+# help define the metadata of the <tt>Twitter4R</tt> project.
+
+require('rubygems')
+require('erb')
+
+class Twitter::Meta #:nodoc:
+  attr_accessor :root_dir
+  attr_reader :gem_spec, :project_files, :spec_files
+
+  # Initializer for Twitter::Meta class.  Takes <tt>root_dir</tt> as parameter.
+  def initialize(root_dir)
+    @root_dir = root_dir
+  end
+
+  # Returns package information defined in <tt>root_dir</tt>/pkg-info.yml
+  def pkg_info
+    yaml_file = File.join(@root_dir, 'pkg-info.yml')
+    ryaml = ERB.new(File.read(yaml_file), 0)
+    s = ryaml.result(binding)
+    YAML.load(s)
+  end
+  
+  # Returns RubyGems spec information
+  def spec_info
+    self.pkg_info['spec'] if self.pkg_info
+  end
+  
+  # Returns list of project files
+  def project_files
+    @project_files ||= Dir.glob(File.join(@root_dir, 'lib/**/*.rb'))
+    @project_files
+  end
+  
+  # Returns list of specification files
+  def spec_files
+    @spec_files ||= Dir.glob(File.join(@root_dir, 'spec/**/*_spec.rb'))
+    @spec_files
+  end
+  
+  # Returns RubyGem specification for Twitter4R project
+  def gem_spec
+    @gem_spec ||= Gem::Specification.new do |spec|
+      self.spec_info.each do |key, val|
+        if val.is_a?(Hash)
+          val.each do |k, v|
+            spec.send(key, k, v)
+          end
+        else
+          spec.send("#{key}=", val)
+        end
+      end
+    end
+    @gem_spec
+  end
+end