twitter 4.8.1 → 5.0.0.rc.1

data/lib/twitter/error/unauthorized.rb

@@ -1,9 +1,9 @@
-require 'twitter/error/client_error'
+require 'twitter/error'
 
 module Twitter
   class Error
     # Raised when Twitter returns the HTTP status code 401
-    class Unauthorized < Twitter::Error::ClientError
+    class Unauthorized < Twitter::Error
       HTTP_STATUS_CODE = 401
     end
   end

data/lib/twitter/error/unprocessable_entity.rb

@@ -1,9 +1,9 @@
-require 'twitter/error/client_error'
+require 'twitter/error'
 
 module Twitter
   class Error
     # Raised when Twitter returns the HTTP status code 422
-    class UnprocessableEntity < Twitter::Error::ClientError
+    class UnprocessableEntity < Twitter::Error
       HTTP_STATUS_CODE = 422
     end
   end

data/lib/twitter/factory.rb

@@ -1,17 +1,11 @@
 module Twitter
   class Factory
 
-    # Instantiates a new action object
-    #
-    # @param attrs [Hash]
-    # @raise [ArgumentError] Error raised when supplied argument is missing an :action key.
-    # @return [Twitter::Action::Favorite, Twitter::Action::Follow, Twitter::Action::ListMemberAdded, Twitter::Action::Mention, Twitter::Action::Reply, Twitter::Action::Retweet]
-    def self.fetch_or_new(method, klass, attrs={})
-      return unless attrs
+    def self.new(method, klass, attrs={})
       type = attrs.delete(method.to_sym)
       if type
         const_name = type.gsub(/\/(.?)/){"::#{$1.upcase}"}.gsub(/(?:^|_)(.)/){$1.upcase}
-        klass.const_get(const_name.to_sym).fetch_or_new(attrs)
+        klass.const_get(const_name.to_sym).new(attrs)
       else
         raise ArgumentError, "argument must have :#{method} key"
       end

data/lib/twitter/geo_factory.rb

@@ -5,12 +5,12 @@ require 'twitter/geo/polygon'
 module Twitter
   class GeoFactory < Twitter::Factory
 
-    # Instantiates a new geo object
+    # Construct a new geo object
     #
     # @param attrs [Hash]
     # @raise [ArgumentError] Error raised when supplied argument is missing a :type key.
     # @return [Twitter::Geo]
-    def self.fetch_or_new(attrs={})
+    def self.new(attrs={})
       super(:type, Twitter::Geo, attrs)
     end
 

data/lib/twitter/geo_results.rb

@@ -0,0 +1,36 @@
+require 'twitter/enumerable'
+
+module Twitter
+  class GeoResults
+    include Twitter::Enumerable
+    attr_reader :attrs
+    alias to_h attrs
+    alias to_hash attrs
+    alias to_hsh attrs
+
+    # Construct a new SearchResults object from a response hash
+    #
+    # @param response [Hash]
+    # @return [Twitter::Base]
+    def self.from_response(response={})
+      new(response[:body])
+    end
+
+    # Initializes a new SearchResults object
+    #
+    # @param attrs [Hash]
+    # @return [Twitter::GeoResults]
+    def initialize(attrs={})
+      @attrs = attrs
+      @collection = Array(@attrs[:result][:places]).map do |place|
+        Twitter::Place.new(place)
+      end
+    end
+
+    # @return [String]
+    def token
+      @attrs[:token]
+    end
+
+  end
+end

data/lib/twitter/identity.rb

@@ -1,30 +1,8 @@
 require 'twitter/base'
-require 'twitter/error/identity_map_key_error'
 
 module Twitter
   class Identity < Twitter::Base
 
-    def self.fetch(attrs)
-      return unless identity_map
-
-      id = attrs[:id]
-      if id  && object = identity_map.fetch(id)
-        return object.update(attrs)
-      end
-
-      return yield if block_given?
-      raise Twitter::Error::IdentityMapKeyError, "key not found"
-    end
-
-    # Stores an object in the identity map.
-    #
-    # @param object [Object]
-    # @return [Twitter::Identity]
-    def self.store(object)
-      return object unless identity_map
-      identity_map.store(object.id, object)
-    end
-
     # Initializes a new object
     #
     # @param attrs [Hash]

data/lib/twitter/list.rb

@@ -5,12 +5,26 @@ module Twitter
   class List < Twitter::Identity
     include Twitter::Creatable
     attr_reader :description, :following, :full_name, :member_count,
-      :mode, :name, :slug, :subscriber_count, :uri
+      :mode, :name, :slug, :subscriber_count
+    object_attr_reader :User, :user
 
-    # @return [Twitter::User]
-    def user
-      @user ||= Twitter::User.fetch_or_new(@attrs[:user])
+    # @return [URI] The URI to the list members.
+    def members_uri
+      @members_uri ||= ::URI.parse("https://twitter.com/#{user.screen_name}/#{slug}/members")
     end
+    alias members_url members_uri
+
+    # @return [URI] The URI to the list subscribers.
+    def subscribers_uri
+      @subscribers_uri ||= ::URI.parse("https://twitter.com/#{user.screen_name}/#{slug}/subscribers")
+    end
+    alias subscribers_url subscribers_uri
+
+    # @return [URI] The URI to the list.
+    def uri
+      @uri ||= ::URI.parse("https://twitter.com/#{user.screen_name}/#{slug}")
+    end
+    alias url uri
 
   end
 end

data/lib/twitter/media/photo.rb

@@ -3,15 +3,15 @@ require 'twitter/identity'
 module Twitter
   module Media
     class Photo < Twitter::Identity
-      attr_reader :display_url, :expanded_url, :indices, :media_url,
-        :media_url_https, :url
+      attr_reader :indices
+      uri_attr_reader :display_uri, :expanded_uri, :media_uri, :media_uri_https, :uri
 
       # Returns an array of photo sizes
       #
       # @return [Array<Twitter::Size>]
       def sizes
         @sizes ||= Array(@attrs[:sizes]).inject({}) do |object, (key, value)|
-          object[key] = Twitter::Size.fetch_or_new(value)
+          object[key] = Twitter::Size.new(value)
           object
         end
       end

data/lib/twitter/media_factory.rb

@@ -4,12 +4,12 @@ require 'twitter/media/photo'
 module Twitter
   class MediaFactory < Twitter::Factory
 
-    # Instantiates a new media object
+    # Construct a new media object
     #
     # @param attrs [Hash]
     # @raise [ArgumentError] Error raised when supplied argument is missing a :type key.
     # @return [Twitter::Media]
-    def self.fetch_or_new(attrs={})
+    def self.new(attrs={})
       super(:type, Twitter::Media, attrs)
     end
 

data/lib/twitter/null_object.rb

@@ -0,0 +1,24 @@
+require 'singleton'
+
+module Twitter
+  class NullObject
+    include Singleton
+
+    def nil?
+      true
+    end
+
+    def method_missing(*args, &block)
+      self
+    end
+
+    def respond_to?(method_name, include_private=false)
+      true
+    end if RUBY_VERSION < "1.9"
+
+    def respond_to_missing?(method_name, include_private=false)
+      true
+    end if RUBY_VERSION >= "1.9"
+
+  end
+end

data/lib/twitter/oembed.rb

@@ -2,7 +2,8 @@ require 'twitter/base'
 
 module Twitter
   class OEmbed < Twitter::Base
-    attr_reader :author_name, :author_url, :cache_age, :height, :html,
-      :provider_name, :provider_url, :type, :url, :version, :width
+    attr_reader :author_name, :cache_age, :height, :html, :provider_name,
+      :type, :version, :width
+    uri_attr_reader :author_uri, :provider_uri, :uri
   end
 end

data/lib/twitter/place.rb

@@ -2,29 +2,35 @@ require 'twitter/identity'
 
 module Twitter
   class Place < Twitter::Identity
-    attr_reader :attributes, :country, :full_name, :name, :url, :woeid
+    attr_reader :attributes, :country, :full_name, :name, :woeid
     alias woe_id woeid
-
-    # @return [Twitter::Geo]
-    def bounding_box
-      @bounding_box ||= Twitter::GeoFactory.fetch_or_new(@attrs[:bounding_box])
-    end
+    object_attr_reader :GeoFactory, :bounding_box
+    object_attr_reader :Place, :contained_within
+    alias contained? contained_within?
+    uri_attr_reader :uri
 
     # @return [String]
     def country_code
-      @country_code ||= @attrs[:country_code] || @attrs[:countryCode]
+      memoize(:country_code) do
+        @attrs[:country_code] || @attrs[:countryCode]
+      end
     end
 
     # @return [Integer]
     def parent_id
-      @parent_id ||= @attrs[:parentid]
+      memoize(:parent_id) do
+        @attrs[:parentid]
+      end
     end
 
     # @return [String]
     def place_type
-      @place_type ||= @attrs[:place_type] || @attrs[:placeType] && @attrs[:placeType][:name]
+      memoize(:place_type) do
+        @attrs[:place_type] || @attrs[:placeType] && @attrs[:placeType][:name]
+      end
     end
 
+    # return [Integer]
     def id
       @attrs[:id] || @attrs[:woeid]
     end

data/lib/twitter/profile_banner.rb

@@ -7,9 +7,11 @@ module Twitter
     #
     # @return [Array<Twitter::Size>]
     def sizes
-      @sizes ||= Array(@attrs[:sizes]).inject({}) do |object, (key, value)|
-        object[key] = Twitter::Size.fetch_or_new(value)
-        object
+      memoize(:sizes) do
+        Array(@attrs[:sizes]).inject({}) do |object, (key, value)|
+          object[key] = Twitter::Size.new(value)
+          object
+        end
       end
     end
 

data/lib/twitter/rate_limit.rb

@@ -1,12 +1,5 @@
 module Twitter
-  class RateLimit
-    attr_reader :attrs
-    alias to_hash attrs
-
-    # @return [Twitter::RateLimit]
-    def initialize(attrs={})
-      @attrs = attrs
-    end
+  class RateLimit < Twitter::Base
 
     # @return [Integer]
     def limit
@@ -32,14 +25,5 @@ module Twitter
     end
     alias retry_after reset_in
 
-    # Update the attributes of a RateLimit
-    #
-    # @param attrs [Hash]
-    # @return [Twitter::RateLimit]
-    def update(attrs)
-      @attrs.update(attrs)
-      self
-    end
-
   end
 end

data/lib/twitter/relationship.rb

@@ -2,6 +2,8 @@ require 'twitter/base'
 
 module Twitter
   class Relationship < Twitter::Base
+    object_attr_reader :SourceUser, :source
+    object_attr_reader :TargetUser, :target
 
     # Initializes a new object
     #
@@ -11,16 +13,6 @@ module Twitter
       @attrs = attrs[:relationship]
     end
 
-    # @return [Twitter::SourceUser]
-    def source
-      @source ||= Twitter::SourceUser.fetch_or_new(@attrs[:source])
-    end
-
-    # @return [Twitter::TargetUser]
-    def target
-      @target ||= Twitter::TargetUser.fetch_or_new(@attrs[:target])
-    end
-
     # Update the attributes of a Relationship
     #
     # @param attrs [Hash]

data/lib/twitter/rest/api/direct_messages.rb

@@ -0,0 +1,135 @@
+require 'twitter/arguments'
+require 'twitter/direct_message'
+require 'twitter/rest/api/utils'
+require 'twitter/user'
+
+module Twitter
+  module REST
+    module API
+      module DirectMessages
+        include Twitter::REST::API::Utils
+
+        # Returns the 20 most recent direct messages sent to the authenticating user
+        #
+        # @see https://dev.twitter.com/docs/api/1.1/get/direct_messages
+        # @note This method requires an access token with RWD (read, write & direct message) permissions. Consult The Application Permission Model for more information.
+        # @rate_limited Yes
+        # @authentication Requires user context
+        # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+        # @return [Array<Twitter::DirectMessage>] Direct messages sent to the authenticating user.
+        # @param options [Hash] A customizable set of options.
+        # @option options [Integer] :since_id Returns results with an ID greater than (that is, more recent than) the specified ID.
+        # @option options [Integer] :max_id Returns results with an ID less than (that is, older than) or equal to the specified ID.
+        # @option options [Integer] :count Specifies the number of records to retrieve. Must be less than or equal to 200.
+        # @option options [Integer] :page Specifies the page of results to retrieve.
+        def direct_messages_received(options={})
+          objects_from_response(Twitter::DirectMessage, :get, "/1.1/direct_messages.json", options)
+        end
+
+        # Returns the 20 most recent direct messages sent by the authenticating user
+        #
+        # @see https://dev.twitter.com/docs/api/1.1/get/direct_messages/sent
+        # @note This method requires an access token with RWD (read, write & direct message) permissions. Consult The Application Permission Model for more information.
+        # @rate_limited Yes
+        # @authentication Requires user context
+        # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+        # @return [Array<Twitter::DirectMessage>] Direct messages sent by the authenticating user.
+        # @param options [Hash] A customizable set of options.
+        # @option options [Integer] :since_id Returns results with an ID greater than (that is, more recent than) the specified ID.
+        # @option options [Integer] :max_id Returns results with an ID less than (that is, older than) or equal to the specified ID.
+        # @option options [Integer] :count Specifies the number of records to retrieve. Must be less than or equal to 200.
+        # @option options [Integer] :page Specifies the page of results to retrieve.
+        def direct_messages_sent(options={})
+          objects_from_response(Twitter::DirectMessage, :get, "/1.1/direct_messages/sent.json", options)
+        end
+
+        # Returns a direct message
+        #
+        # @see https://dev.twitter.com/docs/api/1.1/get/direct_messages/show
+        # @note This method requires an access token with RWD (read, write & direct message) permissions. Consult The Application Permission Model for more information.
+        # @rate_limited Yes
+        # @authentication Requires user context
+        # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+        # @return [Twitter::DirectMessage] The requested messages.
+        # @param id [Integer] A direct message ID.
+        # @param options [Hash] A customizable set of options.
+        def direct_message(id, options={})
+          options[:id] = id
+          object_from_response(Twitter::DirectMessage, :get, "/1.1/direct_messages/show.json", options)
+        end
+
+        # @note This method requires an access token with RWD (read, write & direct message) permissions. Consult The Application Permission Model for more information.
+        # @rate_limited Yes
+        # @authentication Requires user context
+        # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+        # @return [Array<Twitter::DirectMessage>] The requested messages.
+        # @overload direct_messages(options={})
+        #   Returns the 20 most recent direct messages sent to the authenticating user
+        #
+        #   @see https://dev.twitter.com/docs/api/1.1/get/direct_messages
+        #   @param options [Hash] A customizable set of options.
+        #   @option options [Integer] :since_id Returns results with an ID greater than (that is, more recent than) the specified ID.
+        #   @option options [Integer] :max_id Returns results with an ID less than (that is, older than) or equal to the specified ID.
+        #   @option options [Integer] :count Specifies the number of records to retrieve. Must be less than or equal to 200.
+        #   @option options [Integer] :page Specifies the page of results to retrieve.
+        # @overload direct_messages(*ids)
+        #   Returns direct messages
+        #
+        #   @see https://dev.twitter.com/docs/api/1.1/get/direct_messages/show
+        #   @param ids [Enumerable<Integer>] A collection of direct message IDs.
+        # @overload direct_messages(*ids, options)
+        #   Returns direct messages
+        #
+        #   @see https://dev.twitter.com/docs/api/1.1/get/direct_messages/show
+        #   @param ids [Enumerable<Integer>] A collection of direct message IDs.
+        #   @param options [Hash] A customizable set of options.
+        def direct_messages(*args)
+          arguments = Twitter::Arguments.new(args)
+          if arguments.empty?
+            direct_messages_received(arguments.options)
+          else
+            arguments.flatten.threaded_map do |id|
+              direct_message(id, arguments.options)
+            end
+          end
+        end
+
+        # Destroys direct messages
+        #
+        # @see https://dev.twitter.com/docs/api/1.1/post/direct_messages/destroy
+        # @note This method requires an access token with RWD (read, write & direct message) permissions. Consult The Application Permission Model for more information.
+        # @rate_limited No
+        # @authentication Requires user context
+        # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+        # @return [Array<Twitter::DirectMessage>] Deleted direct message.
+        # @overload direct_message_destroy(*ids)
+        #   @param ids [Enumerable<Integer>] A collection of direct message IDs.
+        # @overload direct_message_destroy(*ids, options)
+        #   @param ids [Enumerable<Integer>] A collection of direct message IDs.
+        #   @param options [Hash] A customizable set of options.
+        def direct_message_destroy(*args)
+          threaded_objects_from_response(Twitter::DirectMessage, :post, "/1.1/direct_messages/destroy.json", args)
+        end
+
+        # Sends a new direct message to the specified user from the authenticating user
+        #
+        # @see https://dev.twitter.com/docs/api/1.1/post/direct_messages/new
+        # @rate_limited No
+        # @authentication Requires user context
+        # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+        # @return [Twitter::DirectMessage] The sent message.
+        # @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
+        # @param text [String] The text of your direct message, up to 140 characters.
+        # @param options [Hash] A customizable set of options.
+        def direct_message_create(user, text, options={})
+          merge_user!(options, user)
+          options[:text] = text
+          object_from_response(Twitter::DirectMessage, :post, "/1.1/direct_messages/new.json", options)
+        end
+        alias d direct_message_create
+        alias m direct_message_create
+
+      end
+    end
+  end
+end