twitter4r 0.2.3 → 0.2.4

data/lib/twitter/core.rb

@@ -101,6 +101,7 @@ module Twitter
   #  /i_am_crap.json
   class RESTError < Exception
     include ClassUtilMixin
+    @@ATTRIBUTES = [:code, :message, :uri]
     attr_accessor :code, :message, :uri
     
     # Returns string in following format:

data/lib/twitter/ext/stdlib.rb

@@ -21,12 +21,16 @@ 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"
-  def to_s
-    self.rfc2822
+  # 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

data/lib/twitter/meta.rb

@@ -34,7 +34,7 @@ class Twitter::Meta #:nodoc:
   
   # Returns list of specification files
   def spec_files
-    @spec_files ||= Dir.glob(File.join(@root_dir, 'spec/**/*.rb'))
+    @spec_files ||= Dir.glob(File.join(@root_dir, 'spec/**/*_spec.rb'))
     @spec_files
   end
   

data/lib/twitter/rails.rb

@@ -0,0 +1,89 @@
+# File that contains extensions to the Twitter4R library directly related to providing
+# seamless Rails integration.
+
+require 'active_support'
+#require 'active_support/core_ext'
+require 'active_record/xml_serialization'
+
+# Extend +String+ with +#xmlize+ method for convenience.
+class String
+  def xmlize
+    # Forget module/namespace for now as this is totally broken in Rails 1.2.x 
+    # (search for namespaced models on the Rails Trac site)
+    cls = self.split('::').pop
+    cls.dasherize.downcase
+  end
+end
+
+# Parent mixin module that defines +InstanceMethods+ for Twitter4R model classes.
+# 
+# Defines/overrides the following methods for:
+# * Twitter::RailsPatch::InstanceMethods#to_param
+# * Twitter::RailsPatch::InstanceMethods#to_xml
+# * Twitter::RailsPatch::InstanceMethods#to_json
+module Twitter::RailsPatch
+  class << self
+    def included(base)
+      base.send(:include, InstanceMethods)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      # Dummy method to satisfy ActiveRecord's XmlSerializer.
+      def inheritance_column
+        nil
+      end
+      
+      # Returns Hash of name-column pairs
+      def columns_hash
+        {}
+      end      
+    end
+    
+    module InstanceMethods
+      # Returns an Array of attribute names of the model
+      def attribute_names
+        self.class.class_eval("@@ATTRIBUTES").collect {|att| att.to_s }
+      end
+      
+      # Override default +#to_param+ implementation.
+      def to_param
+        self.id.to_s
+      end
+
+      # Returns XML representation of model.      
+      def to_xml(options = {})
+        ActiveRecord::XmlSerializer.new(self, options.merge(:root => self.class.name.xmlize)).to_s
+      end
+      
+      # Returns JSON representation of model.
+      # 
+      # The current implementation basically ignoring +options+, so reopen and override 
+      # this implementation or live with it for the moment:)
+      def to_json(options = {})
+        JSON.unparse(self.to_hash)
+      end
+    end
+  end
+end
+
+class Twitter::User
+  include Twitter::RailsPatch
+end
+
+class Twitter::Status
+  include Twitter::RailsPatch
+end
+
+class Twitter::Message
+  include Twitter::RailsPatch
+end
+
+class Twitter::RESTError
+  include Twitter::RailsPatch
+  alias :id :code
+  def to_hash
+    { :code => @code, :message => @message, :uri => @uri }
+  end
+end
+

data/lib/twitter/version.rb

@@ -4,7 +4,7 @@
 module Twitter::Version #:nodoc:
   MAJOR = 0
   MINOR = 2
-  REVISION = 3
+  REVISION = 4
   class << self
     # Returns X.Y.Z formatted version string
     def to_version

data/spec/twitter/client/base_spec.rb

@@ -35,13 +35,13 @@ describe Twitter::Client, "#http_header" do
       'User-Agent' => "Twitter4R v#{Twitter::Version.to_version} [#{@user_agent}]",
     }
     @twitter = client_context
-    # resent @@http_header class variable in Twitter::Client class
+    # reset @@http_header class variable in Twitter::Client class
     Twitter::Client.class_eval("@@http_header = nil")
   end
   
   it "should always return expected HTTP headers" do
     headers = @twitter.send(:http_header)
-    headers.should eql(@expected_headers)
+    headers.should === @expected_headers
   end
   
   it "should cache HTTP headers Hash in class variable after first invocation" do
@@ -50,7 +50,7 @@ describe Twitter::Client, "#http_header" do
     @twitter.send(:http_header)
     cache = Twitter::Client.class_eval("@@http_header")
     cache.should_not be_nil
-    cache.should eql(@expected_headers)
+    cache.should === @expected_headers
   end
   
   after(:each) do

data/spec/twitter/config_spec.rb

@@ -55,8 +55,8 @@ describe Twitter::Config, "#eql?" do
       :proxy_host => @proxy_host,
       :proxy_port => @proxy_port,
     }
-    @obj = stubbed_twitter_config(Twitter::Config.new, attrs)
-    @other = stubbed_twitter_config(Twitter::Config.new, attrs)
+    @obj = Twitter::Config.new(attrs)
+    @other = Twitter::Config.new(attrs)
     
     @different = stubbed_twitter_config(Twitter::Config.new, attrs.merge(:proxy_host => 'different.proxy'))
     @same = @obj

data/spec/twitter/meta_spec.rb

@@ -17,7 +17,7 @@ module ERBMetaMixin
 
   # Needed to make the YAML load work...
   def spec_files
-    glob_files(@root_dir, 'spec', '**/*.rb')
+    glob_files(@root_dir, 'spec', '**/*_spec.rb')
   end
 end
 

data/spec/twitter/rails_spec.rb

@@ -0,0 +1,110 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe String, "representing a class name" do
+
+  before(:each) do
+    @class_name = Twitter::User.class.name
+    @xmlized_name = @class_name.downcase # simple case for the moment...since Rails' support for namespaced models sucks!
+  end
+
+  it "should be downcased (minus module namespaces) when xmlized" do
+    @class_name.xmlize.should eql(@xmlized_name)
+  end
+
+  after(:each) do
+    nilize(@class_name, @xmlized_name)
+  end  
+end
+
+describe "Rails model extensions for model classes", :shared => true do
+
+  before(:each) do
+    @id = 3242334
+    @id_s = @id.to_s
+    @model = model(@id)
+    @model_hash = @model.to_hash
+    @json = JSON.unparse(@model_hash)
+    @serializer = ActiveRecord::XmlSerializer.new(@model, {:root => @model.class.name.downcase})
+    @xml = @serializer.to_s
+  end
+
+  it "should invoke #to_param as expected" do
+    @model.should_receive(:id).and_return(@id)
+    @model.to_param
+  end
+  
+  it "should return string representation for id for #to_param" do
+    @model.to_param.class.should eql(String)
+  end
+  
+  it "should return output from JSON.unparse for #to_json" do
+    @model.should_receive(:to_hash).and_return(@model_hash)
+    JSON.should_receive(:unparse).and_return(@json)
+    @model.to_json
+  end
+  
+  it "should return XmlSerializer string output for #to_xml" do
+    ActiveRecord::XmlSerializer.should_receive(:new).and_return(@serializer)
+    @serializer.should_receive(:to_s).and_return(@xml)
+    @model.to_xml
+  end
+  
+  after(:each) do
+    nilize(@id, @model)
+  end
+end
+
+describe Twitter::User, "Rails extensions" do
+
+  def model(id)
+    Twitter::User.new(:id => id)
+  end
+
+  it_should_behave_like "Rails model extensions for model classes"
+end
+
+describe Twitter::Status, "Rails extensions" do
+
+  def model(id)
+    Twitter::Status.new(:id => id)
+  end
+
+  it_should_behave_like "Rails model extensions for model classes"
+end
+
+describe Twitter::Message, "Rails extensions" do
+
+  def model(id)
+    Twitter::Message.new(:id => id)
+  end
+
+  it_should_behave_like "Rails model extensions for model classes"
+end
+
+describe Twitter::RESTError, "Rails extensions" do
+  
+  before(:each) do
+    @attributes = { :code => 200, :message => 'Success', :uri => 'http://twitter.com/statuses' }
+    @model = Twitter::RESTError.new(@attributes)
+    @json = "JSON" # doesn't really matter what the value is
+  end
+  
+  it "should return a Hash of attribute name-value pairs for #to_hash" do
+    @model.to_hash.should === @attributes
+  end
+
+  it "should invoke XmlSerializer for #to_xml" do
+    
+    @model.to_xml
+  end
+
+  it "should return expected JSON for #to_json" do
+    @model.to_hash
+    JSON.should_receive(:unparse).and_return(@json)
+    @model.to_json
+  end
+
+  after(:each) do
+    nilize(@attributes, @model)
+  end  
+end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
+rubygems_version: 0.9.4
 specification_version: 1
 name: twitter4r
 version: !ruby/object:Gem::Version 
-  version: 0.2.3
-date: 2007-07-22 00:00:00 -05:00
+  version: 0.2.4
+date: 2007-07-25 00:00:00 -05:00
 summary: A clean Twitter client API in pure Ruby. Will include Twitter add-ons also in Ruby.
 require_paths: 
 - lib
@@ -30,38 +30,39 @@ authors:
 - Susan Potter
 files: 
 - lib/twitter.rb
+- lib/twitter/ext/stdlib.rb
+- lib/twitter/console.rb
+- lib/twitter/ext.rb
+- lib/twitter/rails.rb
+- lib/twitter/meta.rb
+- lib/twitter/client.rb
+- lib/twitter/client/status.rb
+- lib/twitter/client/friendship.rb
+- lib/twitter/client/user.rb
+- lib/twitter/client/timeline.rb
+- lib/twitter/client/messaging.rb
+- lib/twitter/client/base.rb
 - lib/twitter/config.rb
+- lib/twitter/model.rb
 - lib/twitter/extras.rb
 - lib/twitter/version.rb
-- lib/twitter/client.rb
-- lib/twitter/model.rb
-- lib/twitter/meta.rb
-- lib/twitter/ext.rb
 - lib/twitter/core.rb
-- lib/twitter/console.rb
-- lib/twitter/client/user.rb
-- lib/twitter/client/base.rb
-- lib/twitter/client/status.rb
-- lib/twitter/client/messaging.rb
-- lib/twitter/client/timeline.rb
-- lib/twitter/client/friendship.rb
-- lib/twitter/ext/stdlib.rb
-- spec/spec_helper.rb
-- spec/twitter/model_spec.rb
-- spec/twitter/core_spec.rb
+- spec/twitter/meta_spec.rb
+- spec/twitter/ext/stdlib_spec.rb
 - spec/twitter/client_spec.rb
-- spec/twitter/extras_spec.rb
 - spec/twitter/version_spec.rb
 - spec/twitter/console_spec.rb
-- spec/twitter/meta_spec.rb
-- spec/twitter/config_spec.rb
-- spec/twitter/client/timeline_spec.rb
 - spec/twitter/client/base_spec.rb
-- spec/twitter/client/status_spec.rb
+- spec/twitter/client/user_spec.rb
 - spec/twitter/client/friendship_spec.rb
 - spec/twitter/client/messaging_spec.rb
-- spec/twitter/client/user_spec.rb
-- spec/twitter/ext/stdlib_spec.rb
+- spec/twitter/client/timeline_spec.rb
+- spec/twitter/client/status_spec.rb
+- spec/twitter/extras_spec.rb
+- spec/twitter/core_spec.rb
+- spec/twitter/rails_spec.rb
+- spec/twitter/config_spec.rb
+- spec/twitter/model_spec.rb
 test_files: []
 
 rdoc_options: []

data/spec/spec_helper.rb

@@ -1,133 +0,0 @@
-require 'spec'
-require 'twitter'
-require 'twitter/console'
-require 'twitter/extras'
-
-# Add helper methods here if relevant to multiple _spec.rb files
-
-# Spec helper that sets attribute <tt>att</tt> for given objects <tt>obj</tt> 
-# and <tt>other</tt> to given <tt>value</tt>.
-def equalizer(obj, other, att, value)
-  setter = "#{att}="
-  obj.send(setter, value)
-  other.send(setter, value)
-end
-
-# Spec helper that nil-izes objects passed in
-def nilize(*objects)
-  objects.each {|obj| obj = nil }
-end
-
-# Returns default <tt>client</tt> context object
-def client_context(file = 'config/twitter.yml')
-  Twitter::Client.from_config(file)
-end
-
-# Spec helper that returns a mocked <tt>Twitter::Config</tt> object
-# with stubbed attributes and <tt>attrs</tt> for overriding attribute 
-# values.
-def stubbed_twitter_config(config, attrs = {})
-  opts = { 
-    :protocol => :ssl,
-    :host => 'twitter.com',
-    :port => 443,
-    :proxy_host => 'proxy.host',
-    :proxy_port => 8080,
-  }.merge(attrs)
-  config.stub!(:protocol).and_return(opts[:protocol])
-  config.stub!(:host).and_return(opts[:host])
-  config.stub!(:port).and_return(opts[:port])
-  config.stub!(:proxy_host).and_return(opts[:proxy_host])
-  config.stub!(:proxy_port).and_return(opts[:proxy_port])
-  config
-end
-
-def mas_twitter_config(attrs = {})
-  config = mock(Twitter::Config)
-  stubbed_twitter_conf(config, attrs)
-end
-
-# Spec helper that returns the project root directory as absolute path string
-def project_root_dir
-  File.expand_path(File.join(File.dirname(__FILE__), '..'))
-end
-
-# Spec helper that returns stubbed <tt>Net::HTTP</tt> object 
-# with given <tt>response</tt> and <tt>obj_stubs</tt>.
-# The <tt>host</tt> and <tt>port</tt> are used to initialize 
-# the Net::HTTP object.
-def stubbed_net_http(response, obj_stubs = {}, host = 'twitter.com', port = 80)
-  http = Net::HTTP.new(host, port)
-  Net::HTTP.stub!(:new).and_return(http)
-  http.stub!(:request).and_return(response)
-  http
-end
-
-# Spec helper that returns a mocked <tt>Net::HTTP</tt> object and 
-# stubs out the <tt>request</tt> method to return the given 
-# <tt>response</tt>
-def mas_net_http(response, obj_stubs = {})
-  http = mock(Net::HTTP, obj_stubs)
-  Net::HTTP.stub!(:new).and_return(http)
-  http.stub!(:request).and_return(response)
-  http.stub!(:start).and_yield(http)
-  http.stub!(:use_ssl=)
-  http.stub!(:verify_mode=)
-  http
-end
-
-# Spec helper that returns a mocked <tt>Net::HTTP::Get</tt> object and 
-# stubs relevant class methods and given <tt>obj_stubs</tt> 
-# for endo-specing
-def mas_net_http_get(obj_stubs = {})
-  request = Spec::Mocks::Mock.new(Net::HTTP::Get)
-  Net::HTTP::Get.stub!(:new).and_return(request)
-  obj_stubs.each do |method, value|
-    request.stub!(method).and_return(value)
-  end
-  request
-end
-
-# Spec helper that returns a mocked <tt>Net::HTTP::Post</tt> object and 
-# stubs relevant class methods and given <tt>obj_stubs</tt> 
-# for endo-specing
-def mas_net_http_post(obj_stubs = {})
-  request = Spec::Mocks::Mock.new(Net::HTTP::Post)
-  Net::HTTP::Post.stub!(:new).and_return(request)
-  obj_stubs.each do |method, value|
-    request.stub!(method).and_return(value)
-  end
-  request
-end
-
-# Spec helper that returns a mocked <tt>Net::HTTPResponse</tt> object and 
-# stubs given <tt>obj_stubs</tt> for endo-specing.
-# 
-def mas_net_http_response(status = :success, 
-                          body = '', 
-                          obj_stubs = {})
-  response = Spec::Mocks::Mock.new(Net::HTTPResponse)
-  response.stub!(:body).and_return(body)
-  case status
-  when :success || 200
-    _create_http_response(response, "200", "OK")
-  when :created || 201
-    _create_http_response(response, "201", "Created")
-  when :redirect || 301
-    _create_http_response(response, "301", "Redirect")
-  when :not_authorized || 403
-    _create_http_response(response, "403", "Not Authorized")
-  when :file_not_found || 404
-    _create_http_response(response, "404", "File Not Found")
-  when :server_error || 500
-    _create_http_response(response, "500", "Server Error")
-  end
-  response
-end
-
-# Local helper method to DRY up code.
-def _create_http_response(mock_response, code, message)
-  mock_response.stub!(:code).and_return(code)
-  mock_response.stub!(:message).and_return(message)
-  mock_response.stub!(:is_a?).and_return(true) if ["200", "201"].member?(code)
-end