twitter 4.0.0

data/lib/twitter/request/multipart_with_file.rb

@@ -0,0 +1,41 @@
+require 'faraday'
+
+module Twitter
+  module Request
+    class MultipartWithFile < Faraday::Middleware
+      CONTENT_TYPE = 'Content-Type'.freeze
+      class << self
+        attr_accessor :mime_type
+      end
+      self.mime_type = 'multipart/form-data'.freeze
+
+      def call(env)
+        if env[:body].is_a?(Hash)
+          env[:body].each do |key, value|
+            if value.respond_to?(:to_io)
+              env[:body][key] = Faraday::UploadIO.new(value, mime_type(value.path), value.path)
+              env[:request_headers][CONTENT_TYPE] = self.class.mime_type
+            end
+          end
+        end
+        @app.call(env)
+      end
+
+    private
+
+      def mime_type(path)
+        case path
+        when /\.jpe?g/i
+          'image/jpeg'
+        when /\.gif$/i
+          'image/gif'
+        when /\.png$/i
+          'image/png'
+        else
+          'application/octet-stream'
+        end
+      end
+
+    end
+  end
+end

data/lib/twitter/response/parse_json.rb

@@ -0,0 +1,25 @@
+require 'faraday'
+require 'multi_json'
+
+module Twitter
+  module Response
+    class ParseJson < Faraday::Response::Middleware
+
+      def parse(body)
+        case body
+        when /\A^\s*$\z/, nil
+          nil
+        else
+          MultiJson.load(body, :symbolize_keys => true)
+        end
+      end
+
+      def on_complete(env)
+        if respond_to?(:parse)
+          env[:body] = parse(env[:body]) unless [204, 301, 302, 304].include?(env[:status])
+        end
+      end
+
+    end
+  end
+end

data/lib/twitter/response/raise_error.rb

@@ -0,0 +1,30 @@
+require 'faraday'
+require 'twitter/error/bad_gateway'
+require 'twitter/error/bad_request'
+require 'twitter/error/forbidden'
+require 'twitter/error/gateway_timeout'
+require 'twitter/error/internal_server_error'
+require 'twitter/error/not_acceptable'
+require 'twitter/error/not_found'
+require 'twitter/error/rate_limited'
+require 'twitter/error/service_unavailable'
+require 'twitter/error/unauthorized'
+
+module Twitter
+  module Response
+    class RaiseError < Faraday::Response::Middleware
+
+      def on_complete(env)
+        status_code = env[:status].to_i
+        error_class = @klass.errors[status_code]
+        raise error_class.from_response(env) if error_class
+      end
+
+      def initialize(app, klass)
+        @klass = klass
+        super(app)
+      end
+
+    end
+  end
+end

data/lib/twitter/saved_search.rb

@@ -0,0 +1,9 @@
+require 'twitter/creatable'
+require 'twitter/identity'
+
+module Twitter
+  class SavedSearch < Twitter::Identity
+    include Twitter::Creatable
+    attr_reader :name, :position, :query
+  end
+end

data/lib/twitter/search_results.rb

@@ -0,0 +1,48 @@
+require 'twitter/base'
+require 'twitter/tweet'
+
+module Twitter
+  class SearchResults < Twitter::Base
+
+    # @return [Array<Twitter::Tweet>]
+    def statuses
+      @results ||= Array(@attrs[:statuses]).map do |tweet|
+        Twitter::Tweet.fetch_or_new(tweet)
+      end
+    end
+    alias collection statuses
+    alias results statuses
+
+    # @return [Float]
+    def completed_in
+      @attrs[:search_metadata][:completed_in] unless @attrs[:search_metadata].nil?
+    end
+
+    # @return [Integer]
+    def max_id
+      @attrs[:search_metadata][:max_id] unless @attrs[:search_metadata].nil?
+    end
+
+    # @return [Integer]
+    def page
+      @attrs[:search_metadata][:page] unless @attrs[:search_metadata].nil?
+    end
+
+    # @return [String]
+    def query
+      @attrs[:search_metadata][:query] unless @attrs[:search_metadata].nil?
+    end
+
+    # @return [Integer]
+    def results_per_page
+      @attrs[:search_metadata][:results_per_page] unless @attrs[:search_metadata].nil?
+    end
+    alias rpp results_per_page
+
+    # @return [Integer]
+    def since_id
+      @attrs[:search_metadata][:since_id] unless @attrs[:search_metadata].nil?
+    end
+
+  end
+end

data/lib/twitter/settings.rb

@@ -0,0 +1,17 @@
+require 'twitter/base'
+require 'twitter/place'
+
+module Twitter
+  class Settings < Twitter::Base
+    attr_reader :always_use_https, :discoverable_by_email, :geo_enabled,
+      :language, :protected, :screen_name, :show_all_inline_media, :sleep_time,
+      :time_zone
+    alias protected? protected
+
+    # @return [Twitter::Place]
+    def trend_location
+      @trend_location ||= Twitter::Place.fetch_or_new(Array(@attrs[:trend_location]).first)
+    end
+
+  end
+end

data/lib/twitter/size.rb

@@ -0,0 +1,24 @@
+require 'twitter/base'
+
+module Twitter
+  class Size < Twitter::Base
+    attr_reader :h, :resize, :w
+    alias height h
+    alias width w
+
+    # @param other [Twitter::Size]
+    # @return [Boolean]
+    def ==(other)
+      super || size_equal(other) || attrs_equal(other)
+    end
+
+  protected
+
+    # @param other [Twitter::Size]
+    # @return [Boolean]
+    def size_equal(other)
+      self.class == other.class && !other.h.nil? && h == other.h && !other.w.nil? && w == other.w
+    end
+
+  end
+end

data/lib/twitter/source_user.rb

@@ -0,0 +1,15 @@
+require 'twitter/basic_user'
+
+module Twitter
+  class SourceUser < Twitter::BasicUser
+    attr_reader :all_replies, :blocking, :can_dm, :followed_by, :marked_spam,
+      :notifications_enabled, :want_retweets
+    alias all_replies? all_replies
+    alias blocking? blocking
+    alias can_dm? can_dm
+    alias followed_by? followed_by
+    alias marked_spam? marked_spam
+    alias notifications_enabled? notifications_enabled
+    alias want_retweets? want_retweets
+  end
+end

data/lib/twitter/suggestion.rb

@@ -0,0 +1,22 @@
+require 'twitter/base'
+require 'twitter/user'
+
+module Twitter
+  class Suggestion < Twitter::Base
+    attr_reader :name, :size, :slug
+
+    # @param other [Twitter::Suggestion]
+    # @return [Boolean]
+    def ==(other)
+      super || attr_equal(:slug, other) || attrs_equal(other)
+    end
+
+    # @return [Array<Twitter::User>]
+    def users
+      @users ||= Array(@attrs[:users]).map do |user|
+        Twitter::User.fetch_or_new(user)
+      end
+    end
+
+  end
+end

data/lib/twitter/target_user.rb

@@ -0,0 +1,8 @@
+require 'twitter/basic_user'
+
+module Twitter
+  class TargetUser < Twitter::BasicUser
+    attr_reader :followed_by
+    alias followed_by? followed_by
+  end
+end

data/lib/twitter/trend.rb

@@ -0,0 +1,14 @@
+require 'twitter/base'
+
+module Twitter
+  class Trend < Twitter::Base
+    attr_reader :events, :name, :promoted_content, :query, :url
+
+    # @param other [Twitter::Trend]
+    # @return [Boolean]
+    def ==(other)
+      super || attr_equal(:name, other) || attrs_equal(other)
+    end
+
+  end
+end

data/lib/twitter/tweet.rb

@@ -0,0 +1,145 @@
+require 'twitter/core_ext/hash'
+require 'twitter/creatable'
+require 'twitter/entity/hashtag'
+require 'twitter/entity/url'
+require 'twitter/entity/user_mention'
+require 'twitter/geo_factory'
+require 'twitter/identity'
+require 'twitter/media_factory'
+require 'twitter/metadata'
+require 'twitter/place'
+require 'twitter/user'
+
+module Twitter
+  class Tweet < Twitter::Identity
+    include Twitter::Creatable
+    attr_reader :favorited, :favoriters, :from_user_id, :from_user_name,
+      :in_reply_to_screen_name, :in_reply_to_attrs_id, :in_reply_to_status_id,
+      :in_reply_to_user_id, :iso_language_code, :profile_image_url,
+      :profile_image_url_https, :repliers, :retweeted, :retweeters, :source,
+      :text, :to_user, :to_user_id, :to_user_name, :truncated
+    alias in_reply_to_tweet_id in_reply_to_status_id
+    alias favorited? favorited
+    alias favourited favorited
+    alias favourited? favorited
+    alias retweeted? retweeted
+    alias truncated? truncated
+
+    # @return [Integer]
+    def favoriters_count
+      favoriters_count = @attrs[:favoriters_count]
+      favoriters_count.to_i if favoriters_count
+    end
+    alias favorite_count favoriters_count
+    alias favourite_count favoriters_count
+    alias favouriters_count favoriters_count
+
+    # @return [String]
+    def from_user
+      @attrs[:from_user] || user && user.screen_name
+    end
+
+    # @return [String]
+    # @note May be > 140 characters.
+    def full_text
+      retweeted_status && retweeted_status.user ? "RT @#{retweeted_status.user.screen_name}: #{retweeted_status.text}" : text
+    end
+
+    # @return [Twitter::Geo]
+    def geo
+      @geo ||= Twitter::GeoFactory.fetch_or_new(@attrs[:geo])
+    end
+
+    # @note Must include entities in your request for this method to work
+    # @return [Array<Twitter::Entity::Hashtag>]
+    def hashtags
+      @hashtags ||= entities(Twitter::Entity::Hashtag, :hashtags)
+    end
+
+    # @note Must include entities in your request for this method to work
+    # @return [Array<Twitter::Media>]
+    def media
+      @media ||= entities(Twitter::MediaFactory, :media)
+    end
+
+    # @return [Twitter::Metadata]
+    def metadata
+      @metadata ||= Twitter::Metadata.fetch_or_new(@attrs[:metadata])
+    end
+
+    # @return [Twitter::Place]
+    def place
+      @place ||= Twitter::Place.fetch_or_new(@attrs[:place])
+    end
+
+    # @return [Integer]
+    def repliers_count
+      repliers_count = @attrs[:repliers_count]
+      repliers_count.to_i if repliers_count
+    end
+    alias reply_count repliers_count
+
+    def retweet?
+      !!retweeted_status
+    end
+
+    # If this Tweet is a retweet, the original Tweet is available here.
+    #
+    # @return [Twitter::Tweet]
+    def retweeted_status
+      @retweeted_status ||= self.class.fetch_or_new(@attrs[:retweeted_status])
+    end
+    alias retweeted_tweet retweeted_status
+    alias retweet retweeted_status
+
+    # @return [String]
+    def retweeters_count
+      retweeters_count = (@attrs[:retweet_count] || @attrs[:retweeters_count])
+      retweeters_count.to_i if retweeters_count
+    end
+    alias retweet_count retweeters_count
+
+    # @note Must include entities in your request for this method to work
+    # @return [Array<Twitter::Entity::Url>]
+    def urls
+      @urls ||= entities(Twitter::Entity::Url, :urls)
+    end
+
+    # @return [Twitter::User]
+    def user
+      @user ||= Twitter::User.fetch_or_new(@attrs.dup[:user].merge(:status => @attrs.except(:user))) if user?
+    end
+
+    # @note Must include entities in your request for this method to work
+    # @return [Array<Twitter::Entity::UserMention>]
+    def user_mentions
+      @user_mentions ||= entities(Twitter::Entity::UserMention, :user_mentions)
+    end
+
+    def entities?
+      !@attrs[:entities].nil?
+    end
+
+  private
+
+    # @param klass [Class]
+    # @param method [Symbol]
+    def entities(klass, method)
+      if entities?
+        Array(@attrs[:entities][method.to_sym]).map do |user_mention|
+          klass.fetch_or_new(user_mention)
+        end
+      else
+        warn "#{Kernel.caller.first}: To get #{method.to_s.tr('_', ' ')}, you must pass `:include_entities => true` when requesting the #{self.class.name}."
+        []
+      end
+    end
+
+    def user?
+      !@attrs[:user].nil?
+    end
+
+  end
+
+  Status = Tweet
+end

data/lib/twitter/user.rb

@@ -0,0 +1,97 @@
+require 'twitter/basic_user'
+require 'twitter/core_ext/hash'
+require 'twitter/creatable'
+require 'twitter/tweet'
+
+module Twitter
+  class User < Twitter::BasicUser
+    PROFILE_IMAGE_SUFFIX_REGEX = /_normal(\.gif|\.jpe?g|\.png)$/
+    include Twitter::Creatable
+    attr_reader :connections, :contributors_enabled, :default_profile,
+      :default_profile_image, :description, :favourites_count,
+      :follow_request_sent, :followers_count, :friends_count, :geo_enabled,
+      :is_translator, :lang, :listed_count, :location, :name, :notifications,
+      :profile_background_color, :profile_background_image_url,
+      :profile_background_image_url_https, :profile_background_tile,
+      :profile_link_color, :profile_sidebar_border_color,
+      :profile_sidebar_fill_color, :profile_text_color,
+      :profile_use_background_image, :protected, :statuses_count, :time_zone,
+      :url, :utc_offset, :verified
+    alias contributors_enabled? contributors_enabled
+    alias default_profile? default_profile
+    alias default_profile_image? default_profile_image
+    alias follow_request_sent? follow_request_sent
+    alias favorite_count favourites_count
+    alias favorites_count favourites_count
+    alias favourite_count favourites_count
+    alias follower_count followers_count
+    alias friend_count friends_count
+    alias geo_enabled? geo_enabled
+    alias is_translator? is_translator
+    alias notifications? notifications
+    alias profile_background_tile? profile_background_tile
+    alias profile_use_background_image? profile_use_background_image
+    alias protected? protected
+    alias status_count statuses_count
+    alias translator is_translator
+    alias translator? is_translator
+    alias tweet_count statuses_count
+    alias tweets_count statuses_count
+    alias update_count statuses_count
+    alias updates_count statuses_count
+    alias verified? verified
+
+    # 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_url(size=:normal)
+      # The profile image URL comes in looking like like this:
+      # http://a0.twimg.com/profile_images/1759857427/image1326743606_normal.png
+      # It can be converted to any of the following sizes:
+      # http://a0.twimg.com/profile_images/1759857427/image1326743606.png
+      # http://a0.twimg.com/profile_images/1759857427/image1326743606_mini.png
+      # http://a0.twimg.com/profile_images/1759857427/image1326743606_bigger.png
+      resize_profile_image_url(@attrs[:profile_image_url], size)
+    end
+
+    # 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_url_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
+      resize_profile_image_url(@attrs[:profile_image_url_https], size)
+    end
+
+    # @return [Twitter::Tweet]
+    def status
+      @status ||= Twitter::Tweet.fetch_or_new(@attrs.dup[:status].merge(:user => @attrs.except(:status))) if status?
+    end
+
+    def status?
+      !@attrs[:status].nil?
+    end
+
+  private
+
+    def resize_profile_image_url(url, size)
+      return if url.nil?
+      url.sub(PROFILE_IMAGE_SUFFIX_REGEX, profile_image_suffix(size))
+    end
+
+    def profile_image_suffix(size)
+      if :original == size.to_sym
+        "\\1"
+      else
+        "_#{size}\\1"
+      end
+    end
+
+  end
+end