twitter4r 0.6.0 → 0.7.0

data/lib/twitter.rb

@@ -8,7 +8,7 @@ def require_local(suffix)
 end
 
 # For better unicode support in 1.8
-if RUBY_VERSION < '1.9'
+if RUBY_VERSION < '1.9.0'
   $KCODE = 'u'
   require 'jcode'
 end
@@ -23,10 +23,6 @@ require('cgi')
 require('json')
 require('oauth')
 
-if RUBY_VERSION < "1.9.0"
-  require('yaml')
-end
-
 # Ordering matters...pay attention here!
 require_local('twitter/ext')
 require_local('twitter/version')

data/lib/twitter/client.rb

@@ -22,3 +22,4 @@ require('twitter/client/account')
 require('twitter/client/graph')
 require('twitter/client/profile')
 require('twitter/client/search')
+require('twitter/client/trends')

data/lib/twitter/client/base.rb

@@ -74,8 +74,7 @@ class Twitter::Client
           key = access[:key] || access["key"]
           secret = access[:secret] || access["secret"]
         else
-          key = ""
-          secret = ""
+          raise Error, "No access tokens are set"
         end
         @rest_access_token = OAuth::AccessToken.new(rest_consumer, key, secret)
       end

data/lib/twitter/client/status.rb

@@ -23,12 +23,20 @@ class Twitter::Client
   #  twitter.status(:get, 107786772)
   #  twitter.status(:post, "New Ruby open source project Twitter4R version 0.2.0 released.")
   #  twitter.status(:delete, 107790712)
+  #  twitter.status(:reply, :in_reply_to_status_id => 1390482942342, :status => "@t4ruby This new v0.7.0 release is da bomb! #ruby #twitterapi #twitter4r")
+  #  twitter.status(:post, "My brand new status in all its glory here tweeted from Greenwich (the real one). #withawesomehashtag #booyah", :lat => 0, :long => 0)
   # 
   # An <tt>ArgumentError</tt> will be raised if an invalid <tt>action</tt> 
   # is given.  Valid actions are:
   # * +:get+
   # * +:post+
   # * +:delete+
+  #
+  # The third argument +options+ sends on a Hash to the Twitter API with the following keys allowed:
+  # * +:lat+ - latitude (for posting geolocation)
+  # * +:long+ - longitude (for posting geolocation)
+  # * +:place_id+ - using a place ID give by geo/reverse_geocode
+  # * +:display_coordinates+ - whether or not to put a pin in the exact coordinates
   def status(action, value = nil)
     return self.timeline_for(action, value || {}) if :replies == action
     raise ArgumentError, "Invalid status action: #{action}" unless @@STATUS_URIS.keys.member?(action)
@@ -39,7 +47,14 @@ class Twitter::Client
     when :get
       response = rest_oauth_connect(:get, uri, {:id => value.to_i})
     when :post
-      response = rest_oauth_connect(:post, uri, :status => value, :source => self.class.config.source)
+      if value.is_a?(Hash)
+        params = value.delete_if { |k, v|
+          ![:status, :lat, :long, :place_id, :display_coordinates].member?(k)
+        }
+      else
+        params = {:status => value}
+      end
+      response = rest_oauth_connect(:post, uri, params.merge(:source => self.class.config.source))
     when :delete
       response = rest_oauth_connect(:delete, uri, {:id => value.to_i})
     when :reply

data/lib/twitter/client/trends.rb

@@ -0,0 +1,23 @@
+class Twitter::Client
+  @@TRENDS_URIS = {
+    :locations => '/trends/available.json',
+    :global => '/trends.json',
+    :current => '/trends/current.json',
+    :daily => '/trends/daily.json',
+    :weekly => '/trends/weekly.json',
+    :local => '/trends/',
+  }
+
+  # Provides access to the Twitter list trends API.
+  # 
+  # By default you will receive top ten topics that are trending on Twitter.
+  def trends(type = :global)
+    uri = @@TRENDS_URIS[type]
+    response = rest_oauth_connect(:get, uri)
+    if type === :locations
+      bless_models(Twitter::Location.unmarshal(response.body))
+    else
+      bless_models(Twitter::Trendline.unmarshal(response.body))
+    end
+  end
+end

data/lib/twitter/model.rb

@@ -30,7 +30,7 @@ module Twitter
       # from JSON serialization.  Currently JSON is only supported 
       # since this is all <tt>Twitter4R</tt> needs.
       def unmarshal(raw)
-        input = JSON.parse(raw)
+        input = JSON.parse(raw) if raw.is_a?(String)
         def unmarshal_model(hash)
           self.new(hash)
         end
@@ -155,6 +155,118 @@ module Twitter
     end
   end
 
+  # Represents a location in Twitter
+  class Location
+    include ModelMixin
+
+    @@ATTRIBUTES = [:name, :woeid, :country, :url, :countryCode, :parentid, :placeType]
+    attr_accessor(*@@ATTRIBUTES)
+
+    class << self
+      def attributes; @@ATTRIBUTES; end
+    end
+
+    # Alias to +countryCode+ for those wanting to use consistent naming 
+    # convention for attribute
+    def country_code
+      @countryCode
+    end
+
+    # Alias to +parentid+ for those wanting to use consistent naming 
+    # convention for attribute
+    def parent_id
+      @parentid
+    end
+
+    # Alias to +placeType+ for those wanting to use consistent naming 
+    # convention for attribute
+    def place_type
+      @place_type
+    end
+
+    # Convenience method to output meaningful representation to STDOUT as per 
+    # Ruby convention
+    def inspect
+      "#{name} / #{woeid} / #{countryCode}\n#{url}\n"
+    end
+
+    protected
+      def init
+        puts @placeType
+        @placeType = ::Twitter::PlaceType.new(:name => @placeType["name"], 
+                                              :code => @placeType["code"]) if @placeType.is_a?(Hash)
+      end
+  end
+
+  # Represents a type of a place.
+  class PlaceType
+    include ModelMixin
+
+    @@ATTRIBUTES = [:name, :code]
+    attr_accessor(*@@ATTRIBUTES)
+
+    class << self
+      def attributes; @@ATTRIBUTES; end
+    end
+  end
+
+  # Represents a sorted, dated and typed list of trends.
+  #
+  # To find out when this +Trendline+ was created query the +as_of+ attribute.
+  # To find out what type +Trendline+ is use the +type+ attribute.
+  # You can iterator over the trends in the +Trendline+ with +each+ or by 
+  # index, whichever you prefer.
+  class Trendline
+    include ModelMixin
+    include Enumerable
+    include Comparable
+
+    @@ATTRIBUTES = [:as_of, :type]
+    attr_accessor(*@@ATTRIBUTES)
+
+    class << self
+      def attributes; @@ATTRIBUTES; end
+    end
+
+    # Spaceship operator definition needed by Comparable mixin
+    # for sort, etc.
+    def <=>(other)
+      self.type === other.type && self.as_of <=> other.as_of
+    end
+
+    # each definition needed by Enumerable mixin for first, ...
+    def each
+      trends.each do |t|
+        yield t
+      end
+    end
+
+    # index operator definition needed to iterate over trends 
+    # in the +::Twitter::Trendline+ object using for or otherwise
+    def [](index)
+      trends[index]
+    end
+
+    protected
+      attr_accessor(:trends)
+      # Constructor callback
+      def init
+        @trends = @trends.collect do |trend|
+          ::Twitter::Trend.new(trend) if trend.is_a?(Hash)
+        end if @trends.is_a?(Array)
+      end
+  end
+
+  class Trend
+    include ModelMixin
+    @@ATTRIBUTES = [:name, :url]
+    attr_accessor(*@@ATTRIBUTES)
+
+    class << self
+      def attributes; @@ATTRIBUTES; end
+    end
+  end
+
   # Represents a <tt>Twitter</tt> user
   class User
     include ModelMixin
@@ -273,8 +385,13 @@ module Twitter
       !!@in_reply_to_status_id
     end
 
-    def reply(status)
-      client.status(:reply, :status => status, :in_reply_to_status_id => @id)
+    # Convenience method to allow client developers to not have to worry about 
+    # setting the +in_reply_to_status_id+ attribute or prefixing the status 
+    # text with the +screen_name+ being replied to.
+    def reply(reply)
+      status_reply = "@#{user.screen_name} #{reply}"
+      client.status(:reply, :status => status_reply, 
+                    :in_reply_to_status_id => @id)
     end
     
     protected

data/lib/twitter/version.rb

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

data/spec/twitter/client/favorites_spec.rb

@@ -87,10 +87,6 @@ module FavoriteSpecMixin
     "#{@base_uri}/#{method.to_s}/#{id.to_i.to_s}.json"
   end
   
-  def connection=(connection)
-    @connection = connection
-  end
-  
   def finalize
     nilize(@uri, @request, @twitter, @default_header, @response, @error_response, @connection)
   end

data/spec/twitter/client/status_spec.rb

@@ -45,6 +45,16 @@ describe Twitter::Client, "#status" do
     @twitter.status(:post, @message)
   end
 
+  it "should create expected HTTP POST request for :post case when passing Hash with lat/long instead of String" do
+    @twitter.should_receive(:rest_oauth_connect).with(:post, @uris[:post], :lat => 0, :long => 0, :status => @message, :source => @source).and_return(@response)
+    @twitter.status(:post, :status => @message, :lat => 0, :long => 0)
+  end
+
+  it "should create expected HTTP POST request for :post case when passing Hash with place_idinstead of String" do
+    @twitter.should_receive(:rest_oauth_connect).with(:post, @uris[:post], :place_id => 1234, :status => @message, :source => @source).and_return(@response)
+    @twitter.status(:post, :status => @message, :place_id => 1234)
+  end
+
   it "should return nil if nil is passed as value argument for :post case" do
     status = @twitter.status(:post, nil)
     status.should be_nil

data/spec/twitter/client/trends_spec.rb

@@ -0,0 +1,51 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'spec_helper'))
+
+describe Twitter::Client, "#trends" do
+  before(:each) do
+    @uri = '/trends.json'
+    @request = mas_net_http_get
+    @twitter = client_context
+    @default_header = @twitter.send(:http_header)
+    @response = mas_net_http_response(:success)
+    @connection = mas_net_http(@response)
+    @favorites = []
+    Twitter::Status.stub!(:unmarshal).and_return(@favorites)
+  end
+  
+  it "should create expected HTTP GET request when not giving options" do
+    @twitter.should_receive(:rest_oauth_connect).with(:get, @uri).and_return(@response)
+    @twitter.trends
+  end
+  
+  it "should raise Twitter::RESTError when 401 HTTP response received without giving options" do
+    @connection = mas_net_http(mas_net_http_response(:not_authorized))
+    lambda {
+      @twitter.trends
+    }.should raise_error(Twitter::RESTError)
+  end
+  
+  it "should raise Twitter::RESTError when 401 HTTP response received" do
+    @connection = mas_net_http(mas_net_http_response(:not_authorized))
+    lambda {
+      @twitter.trends
+    }.should raise_error(Twitter::RESTError)
+  end
+  
+  it "should raise Twitter::RESTError when 403 HTTP response received" do
+    @connection = mas_net_http(mas_net_http_response(:forbidden))
+    lambda {
+      @twitter.trends
+    }.should raise_error(Twitter::RESTError)
+  end
+  
+  it "should raise Twitter::RESTError when 500 HTTP response received" do
+    @connection = mas_net_http(mas_net_http_response(:server_error))
+    lambda {
+      @twitter.trends
+    }.should raise_error(Twitter::RESTError)
+  end
+  
+  after(:each) do
+    nilize(@uri, @request, @twitter, @default_header, @response, @error_response, @connection)
+  end
+end

data/spec/twitter/model_spec.rb

@@ -72,25 +72,25 @@ describe Twitter::User, "unmarshaling" do
 end
 
 describe "Twitter::ModelMixin#to_hash" do
-	before(:all) do
+  before(:all) do
     class Model
-    	include Twitter::ModelMixin
-    	@@ATTRIBUTES = [:id, :name, :value, :unused_attr]
-    	attr_accessor *@@ATTRIBUTES
-    	def self.attributes; @@ATTRIBUTES; end
+      include Twitter::ModelMixin
+      @@ATTRIBUTES = [:id, :name, :value, :unused_attr]
+      attr_accessor *@@ATTRIBUTES
+      def self.attributes; @@ATTRIBUTES; end
     end
     
     class Hash
-    	def eql?(other)
-    		return false unless other # trivial nil case.
-    		return false unless self.keys.eql?(other.keys)
-    		self.each do |key,val|
-    			return false unless self[key].eql?(other[key])
-    		end
-    		true
-    	end
+      def eql?(other)
+        return false unless other # trivial nil case.
+        return false unless self.keys.eql?(other.keys)
+        self.each do |key,val|
+          return false unless self[key].eql?(other[key])
+        end
+        true
+      end
     end
-	end
+  end
 
   before(:each) do
     @attributes = {:id => 14, :name => 'State', :value => 'Illinois'}
@@ -115,7 +115,7 @@ describe Twitter::User, ".find" do
   end
   
   it "should invoke given Twitter::Client's #user method with expected arguments" do
-		# case where id => @id
+    # case where id => @id
     @twitter.should_receive(:user).with(@id).and_return(@expected_user)
     user = Twitter::User.find(@id, @twitter)
     user.should eql(@expected_user)
@@ -232,13 +232,13 @@ end
 
 describe Test::Model, "#to_i" do
   before(:each) do
-  	@id = 234324285
-  	class Test::Model
-  		attr_accessor :id
-  	end
+    @id = 234324285
+    class Test::Model
+      attr_accessor :id
+    end
     @model = Test::Model.new(:id => @id)
   end
- 	
+   
   it "should return @id attribute" do
     @model.to_i.should eql(@id)
   end
@@ -250,10 +250,10 @@ end
 
 describe Test::Model, "#to_s" do
   before(:each) do
-  	class Test::Model
-  		attr_accessor :text
-  	end
-  	@text = 'Some text for the message body here'
+    class Test::Model
+      attr_accessor :text
+    end
+    @text = 'Some text for the message body here'
     @model = Test::Model.new(:text => @text)
   end
   
@@ -269,7 +269,7 @@ end
 describe Twitter::Message, ".find" do
   it "should raise NotImplementedError due to Twitter (as opposed to Twitter4R) API limitation" do
     lambda {
-    	Twitter::Message.find(123, nil)
+      Twitter::Message.find(123, nil)
     }.should raise_error(NotImplementedError)
   end
 end
@@ -288,26 +288,26 @@ describe Twitter::Status, ".create" do
   
   it "should raise an ArgumentError when no client is given in params" do
     lambda {
-    	Twitter::Status.create(:text => @text)
+      Twitter::Status.create(:text => @text)
     }.should raise_error(ArgumentError)
   end
   
   it "should raise an ArgumentError when no text is given in params" do
-  	@twitter.should_receive(:is_a?).with(Twitter::Client)
+    @twitter.should_receive(:is_a?).with(Twitter::Client)
     lambda {
-    	Twitter::Status.create(:client => @twitter)
+      Twitter::Status.create(:client => @twitter)
     }.should raise_error(ArgumentError)
   end
   
   it "should raise an ArgumentError when text given in params is not a String" do
     lambda {
-    	Twitter::Status.create(:client => @twitter, :text => 234493)
+      Twitter::Status.create(:client => @twitter, :text => 234493)
     }.should raise_error(ArgumentError)
   end
   
   it "should raise an ArgumentError when client context given in params is not a Twitter::Client object" do
     lambda {
-    	Twitter::Status.create(:client => 'a string instead of a Twitter::Client', :text => @text)
+      Twitter::Status.create(:client => 'a string instead of a Twitter::Client', :text => @text)
     }.should raise_error(ArgumentError)
   end
   
@@ -331,54 +331,54 @@ describe Twitter::Message, ".create" do
   
   it "should raise an ArgumentError if no client context is given in params" do
     lambda {
-    	Twitter::Message.create(:text => @text, :recipient => @recipient)
+      Twitter::Message.create(:text => @text, :recipient => @recipient)
     }.should raise_error(ArgumentError)
   end
   
   it "should raise an ArgumentError if client conext given in params is not a Twitter::Client object" do
     lambda {
-    	Twitter::Message.create(
-    		:client => 3.14159, 
-    		:text => @text, 
-    		:recipient => @recipient)
+      Twitter::Message.create(
+        :client => 3.14159, 
+        :text => @text, 
+        :recipient => @recipient)
     }.should raise_error(ArgumentError)
   end
   
   it "should raise an ArgumentError if no text is given in params" do
-  	@twitter.should_receive(:is_a?).with(Twitter::Client)
+    @twitter.should_receive(:is_a?).with(Twitter::Client)
     lambda {
-    	Twitter::Message.create(
-    		:client => @twitter,
-    		:recipient => @recipient)
+      Twitter::Message.create(
+        :client => @twitter,
+        :recipient => @recipient)
     }.should raise_error(ArgumentError)
   end
   
   it "should raise an ArgumentError if text given in params is not a String" do
     @twitter.should_receive(:is_a?).with(Twitter::Client)
     lambda {
-    	Twitter::Message.create(
-    		:client => @twitter,
-    		:text => Object.new,
-    		:recipient => @recipient)
+      Twitter::Message.create(
+        :client => @twitter,
+        :text => Object.new,
+        :recipient => @recipient)
     }.should raise_error(ArgumentError)
   end
   
   it "should raise an ArgumentError if no recipient is given in params" do
     @text.should_receive(:is_a?).with(String)
     lambda {
-    	Twitter::Message.create(
-    		:client => @twitter,
-    		:text => @text)
+      Twitter::Message.create(
+        :client => @twitter,
+        :text => @text)
     }.should raise_error(ArgumentError)
   end
   
   it "should raise an ArgumentError if recipient given in params is not a Twitter::User, Integer or String object" do
     @text.should_receive(:is_a?).with(String)
     lambda {
-    	Twitter::Message.create(
-    		:client => @twitter,
-    		:text => @text,
-    		:recipient => 3.14159)
+      Twitter::Message.create(
+        :client => @twitter,
+        :text => @text,
+        :recipient => 3.14159)
     }.should raise_error(ArgumentError)
   end
   
@@ -391,13 +391,13 @@ describe Twitter::User, "#befriend" do
   before(:each) do
     @twitter = client_context
     @user = Twitter::User.new(
-    	:id => 1234, 
-    	:screen_name => 'mylogin',
-    	:client => @twitter)
+      :id => 1234, 
+      :screen_name => 'mylogin',
+      :client => @twitter)
     @friend = Twitter::User.new(
-    	:id => 5678, 
-    	:screen_name => 'friend',
-    	:client => @twitter)
+      :id => 5678, 
+      :screen_name => 'friend',
+      :client => @twitter)
   end
   
   it "should invoke #friend(:add, user) on client context" do
@@ -414,13 +414,13 @@ describe Twitter::User, "#defriend" do
   before(:each) do
     @twitter = client_context
     @user = Twitter::User.new(
-    	:id => 1234, 
-    	:screen_name => 'mylogin',
-    	:client => @twitter)
+      :id => 1234, 
+      :screen_name => 'mylogin',
+      :client => @twitter)
     @friend = Twitter::User.new(
-    	:id => 5678, 
-    	:screen_name => 'friend',
-    	:client => @twitter)
+      :id => 5678, 
+      :screen_name => 'friend',
+      :client => @twitter)
   end
   
   it "should invoke #friend(:remove, user) on client context" do
@@ -459,16 +459,19 @@ end
 describe Twitter::Status, "#reply(status_text)" do
   before(:each) do
     @twitter = client_context
+    @user = Twitter::User.new(:screen_name => "ilovephpnot")
     @status = Twitter::Status.new(
         :id => 1234,
         :text => "The status text",
+        :user => @user,
         :client => @twitter)
     @reply_text = "Reply text goes here"
     @reply_status = Twitter::Status.new()
   end
 
   it "should invoke #status(:reply, :status => ..., :in_reply_to_status_id => ...) on client context" do
-    @twitter.should_receive(:status).with(:reply, :status => @reply_text, :in_reply_to_status_id => @status.id).and_return(@reply_status)
+    @twitter.should_receive(:status).with(:reply, :status => "@#{@user.screen_name} #{@reply_text}",
+                                          :in_reply_to_status_id => @status.id).and_return(@reply_status)
     @status.reply(@reply_text)
   end
 
@@ -494,7 +497,7 @@ end
 
 describe Twitter::Message, "#to_s" do
   before(:each) do
-	  @text = 'Aloha'
+    @text = 'Aloha'
     @message = Twitter::Message.new(:text => @text)
   end
   
@@ -506,3 +509,19 @@ describe Twitter::Message, "#to_s" do
     nilize(@text, @message)
   end
 end
+
+describe Twitter::Trendline, ".new" do
+  it "should initialize trends into an Array of Twitter::Trend objects" do
+    trendline = Twitter::Trendline.new(:trends => [
+                                       {:name => "booyah", :url => "http://twitter.com/search?q=booyah"},
+                                       {:name => "twitter4r", :url => "http://twitter.com/search?q=twitter4r"},
+    ])
+    trendline.each do |t|
+      t.should be_a(Twitter::Trend)
+    end
+    booyah = trendline.first
+    booyah.name.should === "booyah"
+    twitter4r = trendline[-1]
+    twitter4r.name.should === "twitter4r"
+  end
+end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: twitter4r
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 6
-  - 0
-  version: 0.6.0
+  prerelease: 
+  version: 0.7.0
 platform: ruby
 authors: 
 - Susan Potter
@@ -14,7 +10,7 @@ autorequire: twitter
 bindir: bin
 cert_chain: []
 
-date: 2010-11-03 00:00:00 -05:00
+date: 2011-07-11 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,10 +21,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 1
-        - 1
         version: 1.1.1
   type: :runtime
   version_requirements: *id001
@@ -40,10 +32,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 4
-        - 1
         version: 0.4.1
   type: :runtime
   version_requirements: *id002
@@ -64,6 +52,7 @@ files:
 - lib/twitter/version.rb
 - lib/twitter/client/status.rb
 - lib/twitter/client/timeline.rb
+- lib/twitter/client/trends.rb
 - lib/twitter/client/search.rb
 - lib/twitter/client/graph.rb
 - lib/twitter/client/favorites.rb
@@ -88,6 +77,7 @@ files:
 - spec/twitter/client/friendship_spec.rb
 - spec/twitter/client/blocks_spec.rb
 - spec/twitter/client/graph_spec.rb
+- spec/twitter/client/trends_spec.rb
 - spec/twitter/client/search_spec.rb
 - spec/twitter/client/auth_spec.rb
 - spec/twitter/client/account_spec.rb
@@ -126,25 +116,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 8
-      - 6
       version: 1.8.6
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: 
 - Ruby 1.8.6+
 - json gem, version 0.4.3 or higher
 - jcode (for unicode support)
 rubyforge_project: twitter4r
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A clean Twitter client API in pure Ruby. Will include Twitter add-ons also in Ruby.