twitter 5.0.0.rc.1 → 5.0.0

data/lib/twitter/media/photo.rb

@@ -4,17 +4,19 @@ module Twitter
   module Media
     class Photo < Twitter::Identity
       attr_reader :indices
-      uri_attr_reader :display_uri, :expanded_uri, :media_uri, :media_uri_https, :uri
+      display_uri_attr_reader
+      uri_attr_reader :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.new(value)
+        Array(@attrs[:sizes]).inject({}) do |object, (key, value)|
+          object[key] = Size.new(value)
           object
         end
       end
+      memoize :sizes
 
     end
   end

data/lib/twitter/media_factory.rb

@@ -4,13 +4,17 @@ require 'twitter/media/photo'
 module Twitter
   class MediaFactory < Twitter::Factory
 
-    # 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.new(attrs={})
-      super(:type, Twitter::Media, attrs)
+    class << self
+
+      # Construct a new media object
+      #
+      # @param attrs [Hash]
+      # @raise [IndexError] Error raised when supplied argument is missing a :type key.
+      # @return [Twitter::Media]
+      def new(attrs={})
+        super(:type, Media, attrs)
+      end
+
     end
 
   end

data/lib/twitter/null_object.rb

@@ -1,21 +1,22 @@
-require 'singleton'
-
 module Twitter
   class NullObject
-    include Singleton
 
+    # @return [TrueClass] This method always returns true.
     def nil?
       true
     end
 
+    # @return [Twitter::NullObject] This method always returns self.
     def method_missing(*args, &block)
       self
     end
 
+    # @return [TrueClass] This method always returns true.
     def respond_to?(method_name, include_private=false)
       true
     end if RUBY_VERSION < "1.9"
 
+    # @return [TrueClass] This method always returns true.
     def respond_to_missing?(method_name, include_private=false)
       true
     end if RUBY_VERSION >= "1.9"

data/lib/twitter/place.rb

@@ -1,7 +1,9 @@
-require 'twitter/identity'
+require 'equalizer'
+require 'twitter/base'
 
 module Twitter
-  class Place < Twitter::Identity
+  class Place < Twitter::Base
+    include Equalizer.new(:woeid)
     attr_reader :attributes, :country, :full_name, :name, :woeid
     alias woe_id woeid
     object_attr_reader :GeoFactory, :bounding_box
@@ -11,29 +13,21 @@ module Twitter
 
     # @return [String]
     def country_code
-      memoize(:country_code) do
-        @attrs[:country_code] || @attrs[:countryCode]
-      end
+      @attrs[:country_code] || @attrs[:countryCode]
     end
+    memoize :country_code
 
     # @return [Integer]
     def parent_id
-      memoize(:parent_id) do
-        @attrs[:parentid]
-      end
+      @attrs[:parentid]
     end
+    memoize :parent_id
 
     # @return [String]
     def place_type
-      memoize(:place_type) do
-        @attrs[:place_type] || @attrs[:placeType] && @attrs[:placeType][:name]
-      end
-    end
-
-    # return [Integer]
-    def id
-      @attrs[:id] || @attrs[:woeid]
+      @attrs[:place_type] || @attrs[:placeType] && @attrs[:placeType][:name]
     end
+    memoize :place_type
 
   end
 end

data/lib/twitter/profile_banner.rb

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

data/lib/twitter/rate_limit.rb

@@ -6,18 +6,21 @@ module Twitter
       limit = @attrs['x-rate-limit-limit']
       limit.to_i if limit
     end
+    memoize :limit
 
     # @return [Integer]
     def remaining
       remaining = @attrs['x-rate-limit-remaining']
       remaining.to_i if remaining
     end
+    memoize :remaining
 
     # @return [Time]
     def reset_at
       reset = @attrs['x-rate-limit-reset']
       Time.at(reset.to_i) if reset
     end
+    memoize :reset_at
 
     # @return [Integer]
     def reset_in

data/lib/twitter/relationship.rb

@@ -13,14 +13,5 @@ module Twitter
       @attrs = attrs[:relationship]
     end
 
-    # Update the attributes of a Relationship
-    #
-    # @param attrs [Hash]
-    # @return [Twitter::Relationship]
-    def update(attrs)
-      @attrs.update(attrs[:relationship]) unless attrs[:relationship].nil?
-      self
-    end
-
   end
 end

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

@@ -102,14 +102,15 @@ module Twitter
         # @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)
+        # @overload destroy_direct_message(*ids)
         #   @param ids [Enumerable<Integer>] A collection of direct message IDs.
-        # @overload direct_message_destroy(*ids, options)
+        # @overload destroy_direct_message(*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)
+        def destroy_direct_message(*args)
           threaded_objects_from_response(Twitter::DirectMessage, :post, "/1.1/direct_messages/destroy.json", args)
         end
+        deprecate_alias :direct_message_destroy, :destroy_direct_message
 
         # Sends a new direct message to the specified user from the authenticating user
         #
@@ -121,13 +122,15 @@ module Twitter
         # @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={})
+        def create_direct_message(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
+        alias d create_direct_message
+        alias m create_direct_message
+        alias dm create_direct_message
+        deprecate_alias :direct_message_create, :create_direct_message
 
       end
     end

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

@@ -31,12 +31,9 @@ module Twitter
         #   @option options [Integer] :since_id Returns results with an ID greater than (that is, more recent than) the specified ID.
         def favorites(*args)
           arguments = Twitter::Arguments.new(args)
-          if user = arguments.pop
-            merge_user!(arguments.options, user)
-          end
+          merge_user!(arguments.options, arguments.pop) if arguments.last
           objects_from_response(Twitter::Tweet, :get, "/1.1/favorites/list.json", arguments.options)
         end
-        alias favourites favorites
 
         # Un-favorites the specified Tweets as the authenticating user
         #
@@ -53,9 +50,8 @@ module Twitter
         def unfavorite(*args)
           threaded_objects_from_response(Twitter::Tweet, :post, "/1.1/favorites/destroy.json", args)
         end
-        alias favorite_destroy unfavorite
-        alias favourite_destroy unfavorite
-        alias unfavourite unfavorite
+        alias destroy_favorite unfavorite
+        deprecate_alias :favorite_destroy, :unfavorite
 
         # Favorites the specified Tweets as the authenticating user
         #
@@ -82,8 +78,7 @@ module Twitter
         end
         alias fav favorite
         alias fave favorite
-        alias favorite_create favorite
-        alias favourite_create favorite
+        deprecate_alias :favorite_create, :favorite
 
         # Favorites the specified Tweets as the authenticating user and raises an error if one has already been favorited
         #
@@ -109,10 +104,10 @@ module Twitter
             end
           end
         end
+        alias create_favorite! favorite!
         alias fav! favorite!
         alias fave! favorite!
-        alias favorite_create! favorite!
-        alias favourite_create! favorite!
+        deprecate_alias :favorite_create!, :favorite!
 
       end
     end

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

@@ -110,9 +110,6 @@ module Twitter
         #   @option options [Boolean] :follow (false) Enable notifications for the target user.
         def follow(*args)
           arguments = Twitter::Arguments.new(args)
-          # Twitter always turns on notifications if the "follow" option is present, even if it's set to false
-          # so only send follow if it's true
-          arguments.options[:follow] = true if !!arguments.options.delete(:follow)
           existing_friends = Thread.new do
             friend_ids.to_a
           end
@@ -121,7 +118,8 @@ module Twitter
           end
           follow!(new_friends.value - existing_friends.value, arguments.options)
         end
-        alias friendship_create follow
+        alias create_friendship follow
+        deprecate_alias :friendship_create, :follow
 
         # Allows the authenticating user to follow the specified users
         #
@@ -138,9 +136,6 @@ module Twitter
         #   @option options [Boolean] :follow (false) Enable notifications for the target user.
         def follow!(*args)
           arguments = Twitter::Arguments.new(args)
-          # Twitter always turns on notifications if the "follow" option is present, even if it's set to false
-          # so only send follow if it's true
-          arguments.options[:follow] = true if !!arguments.options.delete(:follow)
           arguments.flatten.threaded_map do |user|
             begin
               object_from_response(Twitter::User, :post, "/1.1/friendships/create.json", merge_user(arguments.options, user))
@@ -150,7 +145,8 @@ module Twitter
             end
           end.compact
         end
-        alias friendship_create! follow!
+        alias create_friendship! follow!
+        deprecate_alias :friendship_create!, :follow!
 
         # Allows the authenticating user to unfollow the specified users
         #
@@ -167,7 +163,8 @@ module Twitter
         def unfollow(*args)
           threaded_user_objects_from_response(:post, "/1.1/friendships/destroy.json", args)
         end
-        alias friendship_destroy unfollow
+        alias destroy_friendship unfollow
+        deprecate_alias :friendship_destroy, :unfollow
 
         # Allows one to enable or disable retweets and device notifications from the specified user.
         #

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

@@ -69,18 +69,19 @@ module Twitter
         # @authentication Requires user context
         # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
         # @return [Twitter::List] The list.
-        # @overload list_remove_member(list, user_to_remove, options={})
+        # @overload remove_list_member(list, user_to_remove, options={})
         #   @param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
         #   @param user_to_remove [Integer, String] The user id or screen name of the list member to remove.
         #   @param options [Hash] A customizable set of options.
-        # @overload list_remove_member(user, list, user_to_remove, options={})
+        # @overload remove_list_member(user, list, user_to_remove, options={})
         #   @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
         #   @param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
         #   @param user_to_remove [Integer, String] The user id or screen name of the list member to remove.
         #   @param options [Hash] A customizable set of options.
-        def list_remove_member(*args)
+        def remove_list_member(*args)
           list_from_response_with_user(:post, "/1.1/lists/members/destroy.json", args)
         end
+        deprecate_alias :list_remove_member, :remove_list_member
 
         # List the lists the specified user has been added to
         #
@@ -187,18 +188,19 @@ module Twitter
         # @authentication Requires user context
         # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
         # @return [Twitter::List] The list.
-        # @overload list_add_members(list, users, options={})
+        # @overload add_list_members(list, users, options={})
         #   @param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
         #   @param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.
         #   @param options [Hash] A customizable set of options.
-        # @overload list_add_members(user, list, users, options={})
+        # @overload add_list_members(user, list, users, options={})
         #   @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
         #   @param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
         #   @param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.
         #   @param options [Hash] A customizable set of options.
-        def list_add_members(*args)
+        def add_list_members(*args)
           list_from_response_with_users(:post, "/1.1/lists/members/create_all.json", args)
         end
+        deprecate_alias :list_add_members, :add_list_members
 
         # Check if a user is a member of the specified list
         #
@@ -248,18 +250,19 @@ module Twitter
         # @authentication Requires user context
         # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
         # @return [Twitter::List] The list.
-        # @overload list_add_member(list, user_to_add, options={})
+        # @overload add_list_member(list, user_to_add, options={})
         #   @param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
         #   @param user_to_add [Integer, String] The user id or screen name to add to the list.
         #   @param options [Hash] A customizable set of options.
-        # @overload list_add_member(user, list, user_to_add, options={})
+        # @overload add_list_member(user, list, user_to_add, options={})
         #   @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
         #   @param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
         #   @param user_to_add [Integer, String] The user id or screen name to add to the list.
         #   @param options [Hash] A customizable set of options.
-        def list_add_member(*args)
+        def add_list_member(*args)
           list_from_response_with_user(:post, "/1.1/lists/members/create.json", args)
         end
+        deprecate_alias :list_add_member, :add_list_member
 
         # Deletes the specified list
         #
@@ -269,16 +272,17 @@ module Twitter
         # @authentication Requires user context
         # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
         # @return [Twitter::List] The deleted list.
-        # @overload list_destroy(list, options={})
+        # @overload destroy_list(list, options={})
         #   @param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
         #   @param options [Hash] A customizable set of options.
-        # @overload list_destroy(user, list, options={})
+        # @overload destroy_list(user, list, options={})
         #   @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
         #   @param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
         #   @param options [Hash] A customizable set of options.
-        def list_destroy(*args)
+        def destroy_list(*args)
           list_from_response(:post, "/1.1/lists/destroy.json", args)
         end
+        deprecate_alias :list_destroy, :destroy_list
 
         # Updates the specified list
         #
@@ -314,9 +318,10 @@ module Twitter
         # @param options [Hash] A customizable set of options.
         # @option options [String] :mode ('public') Whether your list is public or private. Values can be 'public' or 'private'.
         # @option options [String] :description The description to give the list.
-        def list_create(name, options={})
+        def create_list(name, options={})
           object_from_response(Twitter::List, :post, "/1.1/lists/create.json", options.merge(:name => name))
         end
+        deprecate_alias :list_create, :create_list
 
         # Show the specified list
         #
@@ -362,18 +367,19 @@ module Twitter
         # @authentication Requires user context
         # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
         # @return [Twitter::List] The list.
-        # @overload list_remove_members(list, users, options={})
+        # @overload remove_list_members(list, users, options={})
         #   @param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
         #   @param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.
         #   @param options [Hash] A customizable set of options.
-        # @overload list_remove_members(user, list, users, options={})
+        # @overload remove_list_members(user, list, users, options={})
         #   @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
         #   @param list [Integer, String, Twitter::List] A Twitter list ID, slug, URI, or object.
         #   @param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen names, or objects.
         #   @param options [Hash] A customizable set of options.
-        def list_remove_members(*args)
+        def remove_list_members(*args)
           list_from_response_with_users(:post, "/1.1/lists/members/destroy_all.json", args)
         end
+        deprecate_alias :list_remove_members, :remove_list_members
 
         # Returns the lists owned by the specified Twitter user
         #
@@ -382,17 +388,18 @@ module Twitter
         # @authentication Requires user context
         # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
         # @return [Array<Twitter::List>]
-        # @overload lists_owned(options={})
+        # @overload owned_lists(options={})
         #   @param options [Hash] A customizable set of options.
         #   @option options [Integer] :count The amount of results to return per page. Defaults to 20. No more than 1000 results will ever be returned in a single page.
-        # @overload lists_owned(user, options={})
+        # @overload owned_lists(user, options={})
         #   @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
         #   @param options [Hash] A customizable set of options.
         #   @option options [Integer] :count The amount of results to return per page. Defaults to 20. No more than 1000 results will ever be returned in a single page.
-        def lists_owned(*args)
+        def owned_lists(*args)
           cursor_from_response_with_user(:lists, Twitter::List, :get, "/1.1/lists/ownerships.json", args)
         end
-        alias lists_ownerships lists_owned
+        deprecate_alias :lists_ownerships, :owned_lists
+        deprecate_alias :lists_owned, :owned_lists
 
       private