twitter 5.4.1 → 5.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: baa0ce3302ef65ee7f6c6472b847ce5c71ce005a
+  data.tar.gz: 8933bed1f45fd295836a0cd4b75873f41aee8189
+SHA512:
+  metadata.gz: b3a5cb3b3259de32cd96dd7e913b816b3c063230d64c375e53cb9e9b84cdd22856c75b575b98c2fd3d99dc22d438a634a3f38739b0992703a9d11750e84ee713
+  data.tar.gz: cbf5b4fb759e16ae6c6146a2081e479533ea11a640270b153d86d25478e688e5b910410c06c19711436acf7151b340275777d077609776afe6902b33b43bdb98

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+5.5.0
+-----
+* [Add entities to `Twitter::DirectMessage`](https://github.com/sferik/twitter/commit/d911deb456cb2da6e14d0b3c69ba4d068ca85868)
+* [Add conversion methods to `Twitter::NullObject`](https://github.com/sferik/twitter/commit/4900fee474feaa1514c06d459a9da6d52c45a60e)
+
 5.4.1
 -----
 * [Default to maximum number of tweets per request](https://github.com/sferik/twitter/commit/1e41b5d4dde8678f5968b57dafe9da63b092646c)

data/CONTRIBUTING.md

@@ -35,16 +35,14 @@ Ideally, a bug report should include a pull request with failing specs.
 3. Add specs for your unimplemented feature or bug fix.
 4. Run `bundle exec rake spec`. If your specs pass, return to step 3.
 5. Implement your feature or bug fix.
-6. Run `bundle exec rake default`. If your specs fail, return to step 5.
+6. Run `bundle exec rake`. If your specs fail, return to step 5.
 7. Run `open coverage/index.html`. If your changes are not completely covered
    by your tests, return to step 3.
-8. Run `RUBYOPT=W2 bundle exec rake spec 2>&1 | grep twitter`. If your changes
-   produce any warnings, return to step 5.
-9. Add documentation for your feature or bug fix.
-10. Run `bundle exec rake verify_measurements`. If your changes are not 100% documented, go
-    back to step 9.
-11. Commit and push your changes.
-12. [Submit a pull request.][pr]
+8. Add documentation for your feature or bug fix.
+9. Run `bundle exec rake verify_measurements`. If your changes are not 100%
+   documented, go back to step 8.
+10. Commit and push your changes.
+11. [Submit a pull request.][pr]
 
 [fork]: http://help.github.com/fork-a-repo/
 [branch]: http://learn.github.com/p/branching.html

data/README.md

@@ -82,6 +82,13 @@ does not work on Ruby 2.0.0][bug].
 [tweetstream]: http://rubygems.org/gems/tweetstream
 [bug]: https://github.com/tweetstream/tweetstream/issues/117
 
+Site Streams are restricted to whitelisted accounts. To apply for access,
+[follow the steps in the Site Streams documentation][site-streams]. [User
+Streams][user-streams] do not require prior approval.
+
+[site-streams]: https://dev.twitter.com/docs/streaming-apis/streams/site#Applying_for_access
+[user-streams]: https://dev.twitter.com/docs/streaming-apis/streams/user
+
 Unlike the rest of this library, this feature is not well tested and not
 recommended for production applications. That said, if you need to do Twitter
 streaming on Ruby 2.0.0, this is probably your best option. I've decided to
@@ -577,6 +584,7 @@ versions:
 * Ruby 1.9.2
 * Ruby 1.9.3
 * Ruby 2.0.0
+* Ruby 2.1.0
 
 If something doesn't work on one of these versions, it's a bug.
 

data/Rakefile

@@ -16,7 +16,6 @@ begin
   require 'rubocop/rake_task'
   Rubocop::RakeTask.new
 rescue LoadError
-  desc 'Run RuboCop'
   task :rubocop do
     $stderr.puts 'Rubocop is disabled'
   end
@@ -32,7 +31,7 @@ end
 
 require 'yardstick/rake/verify'
 Yardstick::Rake::Verify.new do |verify|
-  verify.threshold = 59.9
+  verify.threshold = 59.8
 end
 
 task :default => [:spec, :rubocop, :verify_measurements]

data/lib/twitter/base.rb

@@ -73,7 +73,7 @@ module Twitter
       # @param key2 [Symbol]
       def define_uri_method(key1, key2)
         define_method(key1) do ||
-          Addressable::URI.parse(@attrs[key2]) if @attrs[key2]
+          Addressable::URI.parse(@attrs[key2]) unless @attrs[key2].nil?
         end
         memoize(key1)
       end
@@ -88,11 +88,11 @@ module Twitter
           if klass.nil?
             @attrs[key1]
           else
-            if @attrs[key1]
+            if @attrs[key1].nil?
+              NullObject.new
+            else
               attrs = attrs_for_object(key1, key2)
               Twitter.const_get(klass).new(attrs)
-            else
-              NullObject.new
             end
           end
         end

data/lib/twitter/creatable.rb

@@ -9,7 +9,7 @@ module Twitter
     #
     # @return [Time]
     def created_at
-      Time.parse(@attrs[:created_at]) if @attrs[:created_at]
+      Time.parse(@attrs[:created_at]) unless @attrs[:created_at].nil?
     end
     memoize :created_at
 

data/lib/twitter/cursor.rb

@@ -42,7 +42,7 @@ module Twitter
       @path = path
       @options = options
       @collection = []
-      set_attrs(attrs)
+      self.attrs = attrs
     end
 
   private
@@ -59,10 +59,10 @@ module Twitter
 
     def fetch_next_page
       response = @client.send(@request_method, @path, @options.merge(:cursor => next_cursor))
-      set_attrs(response[:body])
+      self.attrs = response[:body]
     end
 
-    def set_attrs(attrs)
+    def attrs=(attrs)
       @attrs = attrs
       Array(attrs[@key]).each do |element|
         @collection << (@klass ? @klass.new(element) : element)

data/lib/twitter/direct_message.rb

@@ -1,9 +1,11 @@
 require 'twitter/creatable'
+require 'twitter/entities'
 require 'twitter/identity'
 
 module Twitter
   class DirectMessage < Twitter::Identity
     include Twitter::Creatable
+    include Twitter::Entities
     attr_reader :text
     alias_method :full_text, :text
     object_attr_reader :User, :recipient

data/lib/twitter/entities.rb

@@ -0,0 +1,69 @@
+require 'memoizable'
+require 'twitter/entity/hashtag'
+require 'twitter/entity/symbol'
+require 'twitter/entity/uri'
+require 'twitter/entity/user_mention'
+require 'twitter/media_factory'
+
+module Twitter
+  module Entities
+    include Memoizable
+
+    # @note Must include entities in your request for this method to work
+    # @return [Array<Twitter::Entity::Hashtag>]
+    def hashtags
+      entities(Entity::Hashtag, :hashtags)
+    end
+    memoize :hashtags
+
+    # @note Must include entities in your request for this method to work
+    # @return [Array<Twitter::Media>]
+    def media
+      entities(MediaFactory, :media)
+    end
+    memoize :media
+
+    # @note Must include entities in your request for this method to work
+    # @return [Array<Twitter::Entity::Symbol>]
+    def symbols
+      entities(Entity::Symbol, :symbols)
+    end
+    memoize :symbols
+
+    # @note Must include entities in your request for this method to work
+    # @return [Array<Twitter::Entity::URI>]
+    def uris
+      entities(Entity::URI, :urls)
+    end
+    memoize :uris
+    alias_method :urls, :uris
+
+    # @note Must include entities in your request for this method to work
+    # @return [Array<Twitter::Entity::UserMention>]
+    def user_mentions
+      entities(Entity::UserMention, :user_mentions)
+    end
+    memoize :user_mentions
+
+  private
+
+    # @return [Boolean]
+    def entities?
+      !@attrs[:entities].nil? && @attrs[:entities].any? { |_, array| !array.empty? }
+    end
+    memoize :entities?
+
+    # @param klass [Class]
+    # @param key [Symbol]
+    def entities(klass, key)
+      if entities?
+        Array(@attrs[:entities][key.to_sym]).map do |entity|
+          klass.new(entity)
+        end
+      else
+        warn "#{Kernel.caller.first}: To get #{key.to_s.tr('_', ' ')}, you must pass `:include_entities => true` when requesting the #{self.class}."
+        []
+      end
+    end
+  end
+end

data/lib/twitter/enumerable.rb

@@ -16,6 +16,8 @@ module Twitter
       self
     end
 
+  private
+
     # @return [Boolean]
     def last?
       true

data/lib/twitter/error.rb

@@ -5,7 +5,8 @@ module Twitter
   # Custom error class for rescuing from all Twitter errors
   class Error < StandardError
     extend DescendantsTracker
-    attr_reader :rate_limit, :wrapped_exception, :code
+    attr_reader :cause, :code, :rate_limit
+    alias_method :wrapped_exception, :cause
 
     # If error code is missing see https://dev.twitter.com/docs/error-codes-responses
     module Codes
@@ -75,9 +76,9 @@ module Twitter
     # @param response_headers [Hash]
     # @param code [Integer]
     # @return [Twitter::Error]
-    def initialize(exception = $ERROR_INFO, response_headers = {}, code = nil) # rubocop:disable MethodLength
+    def initialize(exception = $ERROR_INFO, response_headers = {}, code = nil)
       @rate_limit = RateLimit.new(response_headers)
-      @wrapped_exception = exception
+      @cause = exception
       @code = code
       exception.respond_to?(:message) ? super(exception.message) : super(exception.to_s)
     end

data/lib/twitter/null_object.rb

@@ -1,9 +1,12 @@
+require 'forwardable'
+
 module Twitter
   class NullObject
-    # @return [TrueClass] This method always returns true.
-    def nil?
-      true
-    end
+    extend Forwardable
+    def_instance_delegators :nil, :nil?, :to_a, :to_c, :to_c, :to_f, :to_h,
+                            :to_i, :to_r, :to_s
+    alias_method :to_ary, :to_a
+    alias_method :to_str, :to_s
 
     # @return [Twitter::NullObject] This method always returns self.
     def method_missing(*args, &block)

data/lib/twitter/profile.rb

@@ -0,0 +1,94 @@
+require 'addressable/uri'
+require 'memoizable'
+
+module Twitter
+  module Profile
+    PROFILE_IMAGE_SUFFIX_REGEX = /_normal(\.gif|\.jpe?g|\.png)$/i
+    PREDICATE_URI_METHOD_REGEX = /_uri\?$/
+    include Memoizable
+
+    class << self
+    private
+
+      def alias_predicate_uri_methods(method)
+        %w(_url? _uri_https? _url_https?).each do |replacement|
+          alias_method_sub(method, PREDICATE_URI_METHOD_REGEX, replacement)
+        end
+      end
+
+      def alias_method_sub(method, pattern, replacement)
+        alias_method(method.to_s.sub(pattern, replacement).to_sym, method)
+      end
+    end
+
+    # Return the URL to the user's profile banner image
+    #
+    # @param size [String, Symbol] The size of the image. Must be one of: 'mobile', 'mobile_retina', 'web', 'web_retina', 'ipad', or 'ipad_retina'
+    # @return [String]
+    def profile_banner_uri(size = :web)
+      parse_encoded_uri(insecure_uri([@attrs[:profile_banner_url], size].join('/'))) unless @attrs[:profile_banner_url].nil?
+    end
+    alias_method :profile_banner_url, :profile_banner_uri
+
+    # Return the secure URL to the user's profile banner image
+    #
+    # @param size [String, Symbol] The size of the image. Must be one of: 'mobile', 'mobile_retina', 'web', 'web_retina', 'ipad', or 'ipad_retina'
+    # @return [String]
+    def profile_banner_uri_https(size = :web)
+      parse_encoded_uri([@attrs[:profile_banner_url], size].join('/')) unless @attrs[:profile_banner_url].nil?
+    end
+    alias_method :profile_banner_url_https, :profile_banner_uri_https
+
+    # @return [Boolean]
+    def profile_banner_uri?
+      !!@attrs[:profile_banner_url]
+    end
+    memoize :profile_banner_uri?
+    alias_predicate_uri_methods :profile_banner_uri?
+
+    # Return the URL to the user's profile image
+    #
+    # @param size [String, Symbol] The size of the image. Must be one of: 'mini', 'normal', 'bigger' or 'original'
+    # @return [String]
+    def profile_image_uri(size = :normal)
+      parse_encoded_uri(insecure_uri(profile_image_uri_https(size))) unless @attrs[:profile_image_url_https].nil?
+    end
+    alias_method :profile_image_url, :profile_image_uri
+
+    # Return the secure URL to the user's profile image
+    #
+    # @param size [String, Symbol] The size of the image. Must be one of: 'mini', 'normal', 'bigger' or 'original'
+    # @return [String]
+    def profile_image_uri_https(size = :normal)
+      # The profile image URL comes in looking like like this:
+      # https://a0.twimg.com/profile_images/1759857427/image1326743606_normal.png
+      # It can be converted to any of the following sizes:
+      # https://a0.twimg.com/profile_images/1759857427/image1326743606.png
+      # https://a0.twimg.com/profile_images/1759857427/image1326743606_mini.png
+      # https://a0.twimg.com/profile_images/1759857427/image1326743606_bigger.png
+      parse_encoded_uri(@attrs[:profile_image_url_https].sub(PROFILE_IMAGE_SUFFIX_REGEX, profile_image_suffix(size))) unless @attrs[:profile_image_url_https].nil?
+    end
+    alias_method :profile_image_url_https, :profile_image_uri_https
+
+    # @return [Boolean]
+    def profile_image_uri?
+      !!@attrs[:profile_image_url_https]
+    end
+    memoize :profile_image_uri?
+    alias_predicate_uri_methods :profile_image_uri?
+
+  private
+
+    def parse_encoded_uri(uri)
+      Addressable::URI.parse(URI.encode(uri))
+    end
+
+    def insecure_uri(uri)
+      uri.to_s.sub(/^https/i, 'http')
+    end
+
+    def profile_image_suffix(size)
+      :original == size.to_sym ? '\\1' : "_#{size}\\1"
+    end
+  end
+end

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

@@ -109,7 +109,7 @@ module Twitter
         #   @param ids [Enumerable<Integer>] A collection of direct message IDs.
         #   @param options [Hash] A customizable set of options.
         def destroy_direct_message(*args)
-          threaded_objects_from_response(Twitter::DirectMessage, :post, '/1.1/direct_messages/destroy.json', args)
+          parallel_objects_from_response(Twitter::DirectMessage, :post, '/1.1/direct_messages/destroy.json', args)
         end
         deprecate_alias :direct_message_destroy, :destroy_direct_message
 

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

@@ -49,7 +49,7 @@ module Twitter
         #   @param tweets [Enumerable<Integer, String, URI, Twitter::Tweet>] A collection of Tweet IDs, URIs, or objects.
         #   @param options [Hash] A customizable set of options.
         def unfavorite(*args)
-          threaded_objects_from_response(Twitter::Tweet, :post, '/1.1/favorites/destroy.json', args)
+          parallel_objects_from_response(Twitter::Tweet, :post, '/1.1/favorites/destroy.json', args)
         end
         alias_method :destroy_favorite, :unfavorite
         deprecate_alias :favorite_destroy, :unfavorite

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

@@ -157,7 +157,7 @@ module Twitter
         #   @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 unfollow(*args)
-          threaded_user_objects_from_response(:post, '/1.1/friendships/destroy.json', args)
+          parallel_user_objects_from_response(:post, '/1.1/friendships/destroy.json', args)
         end
         alias_method :destroy_friendship, :unfollow
         deprecate_alias :friendship_destroy, :unfollow

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

@@ -20,7 +20,7 @@ module Twitter
         #   @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 report_spam(*args)
-          threaded_user_objects_from_response(:post, '/1.1/users/report_spam.json', args)
+          parallel_user_objects_from_response(:post, '/1.1/users/report_spam.json', args)
         end
       end
     end

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

@@ -77,7 +77,7 @@ module Twitter
         #   @param options [Hash] A customizable set of options.
         #   @option options [Boolean, String, Integer] :trim_user Each tweet returned in a timeline will include a user object with only the author's numerical ID when set to true, 't' or 1.
         def statuses(*args)
-          threaded_tweets_from_response(:get, '/1.1/statuses/show', args)
+          parallel_tweets_from_response(:get, '/1.1/statuses/show', args)
         end
 
         # Destroys the specified Tweets
@@ -95,7 +95,7 @@ module Twitter
         #   @param options [Hash] A customizable set of options.
         #   @option options [Boolean, String, Integer] :trim_user Each tweet returned in a timeline will include a user object with only the author's numerical ID when set to true, 't' or 1.
         def destroy_status(*args)
-          threaded_tweets_from_response(:post, '/1.1/statuses/destroy', args)
+          parallel_tweets_from_response(:post, '/1.1/statuses/destroy', args)
         end
         alias_method :destroy_tweet, :destroy_status
         deprecate_alias :status_destroy, :destroy_status
@@ -280,7 +280,7 @@ module Twitter
         # @param path [String]
         # @param args [Array]
         # @return [Array<Twitter::Tweet>]
-        def threaded_tweets_from_response(request_method, path, args)
+        def parallel_tweets_from_response(request_method, path, args)
           arguments = Twitter::Arguments.new(args)
           Twitter::Utils.parallel_map(arguments) do |tweet|
             id = extract_id(tweet)

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

@@ -167,13 +167,13 @@ module Twitter
         def block?(user, options = {})
           merge_default_cursor!(options)
           user_id = case user
-                    when Integer
-                      user
-                    when String, URI, Addressable::URI
-                      user(user).id
-                    when Twitter::User
-                      user.id
-                    end
+          when Integer
+            user
+          when String, URI, Addressable::URI
+            user(user).id
+          when Twitter::User
+            user.id
+          end
           blocked_ids(options).map(&:to_i).include?(user_id)
         end
 
@@ -191,7 +191,7 @@ module Twitter
         #   @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 block(*args)
-          threaded_user_objects_from_response(:post, '/1.1/blocks/create.json', args)
+          parallel_user_objects_from_response(:post, '/1.1/blocks/create.json', args)
         end
 
         # Un-blocks the users specified by the authenticating user
@@ -207,7 +207,7 @@ module Twitter
         #   @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 unblock(*args)
-          threaded_user_objects_from_response(:post, '/1.1/blocks/destroy.json', args)
+          parallel_user_objects_from_response(:post, '/1.1/blocks/destroy.json', args)
         end
 
         # Returns extended information for up to 100 users