ifttt-twitter 2.1.1

data/lib/twitter/client/urls.rb

@@ -0,0 +1,26 @@
+module Twitter
+  class Client
+
+    # Defines methods related to URLs
+    module Urls
+      # Returns the canonical version of a URL shortened by Twitter
+      #
+      # @note Undocumented
+      # @rate_limited Yes
+      # @requires_authentication Yes
+      # @overload resolve(urls, options={})
+      #   @param urls [String] A list of shortened URLs.
+      #   @param options [Hash] A customizable set of options.
+      #   @return [Hash] A hash of URLs with the shortened URLs as the key
+      #   @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      #   @example Return the canonical version of a URL shortened by Twitter
+      #     Twitter.resolve('http://t.co/uw5bn1w', 'http://t.co/dXvMz9i')
+      #     Twitter.resolve(['http://t.co/uw5bn1w', 'http://t.co/dXvMz9i']) # Same as above
+      def resolve(*args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        get("/1/urls/resolve.json", options.merge("urls[]" => args), :phoenix => true)
+      end
+    end
+
+  end
+end

data/lib/twitter/client/users.rb

@@ -0,0 +1,203 @@
+require 'twitter/core_ext/hash'
+require 'twitter/error/not_found'
+require 'twitter/user'
+
+module Twitter
+  class Client
+    # Defines methods related to users
+    module Users
+
+      # Returns extended information for up to 100 users
+      #
+      # @see https://dev.twitter.com/docs/api/1/get/users/lookup
+      # @rate_limited Yes
+      # @requires_authentication Yes
+      # @overload users(*users, options={})
+      #   @param users [Array<Integer, String>, Set<Integer, String>] Twitter user IDs or screen names.
+      #   @param options [Hash] A customizable set of options.
+      #   @option options [Boolean, String, Integer] :include_entities Include {https://dev.twitter.com/docs/tweet-entities Tweet Entities} when set to true, 't' or 1.
+      #   @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      #   @return [Array<Twitter::User>] The requested users.
+      #   @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      #   @example Return extended information for @sferik and @pengwynn
+      #     Twitter.users("sferik", "pengwynn")
+      #     Twitter.users("sferik", 14100886)   # Same as above
+      #     Twitter.users(7505382, 14100886)    # Same as above
+      def users(*args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        users = args
+        options.merge_users!(Array(users))
+        get("/1/users/lookup.json", options).map do |user|
+          Twitter::User.new(user)
+        end
+      end
+
+      # Access the profile image in various sizes for the user with the indicated screen name
+      #
+      # @see https://dev.twitter.com/docs/api/1/get/users/profile_image/:screen_name
+      # @rate_limited No
+      # @requires_authentication No
+      # @overload profile_image(screen_name, options={})
+      #   @param screen_name [String] The screen name of the user for whom to return results for.
+      #   @param options [Hash] A customizable set of options.
+      #   @option options [String] :size ('normal') Specifies the size of image to fetch. Valid options include: 'bigger' (73px by 73px), 'normal' (48px by 48px), and 'mini' (24px by 24px).
+      #   @example Return the URL for the 24px by 24px version of @sferik's profile image
+      #     Twitter.profile_image("sferik", :size => 'mini')
+      # @return [String] The URL for the requested user's profile image.
+      def profile_image(*args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        screen_name = args.pop || self.current_user.screen_name
+        get("/1/users/profile_image/#{screen_name}", options, :raw => true).headers['location']
+      end
+
+      # Returns users that match the given query
+      #
+      # @see https://dev.twitter.com/docs/api/1/get/users/search
+      # @rate_limited Yes
+      # @requires_authentication Yes
+      # @param query [String] The search query to run against people search.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :per_page The number of people to retrieve. Maxiumum of 20 allowed per page.
+      # @option options [Integer] :page Specifies the page of results to retrieve.
+      # @option options [Boolean, String, Integer] :include_entities Include {https://dev.twitter.com/docs/tweet-entities Tweet Entities} when set to true, 't' or 1.
+      # @return [Array<Twitter::User>]
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example Return users that match "Erik Michaels-Ober"
+      #   Twitter.user_search("Erik Michaels-Ober")
+      def user_search(query, options={})
+        get("/1/users/search.json", options.merge(:q => query)).map do |user|
+          Twitter::User.new(user)
+        end
+      end
+
+      # Returns extended information of a given user
+      #
+      # @see https://dev.twitter.com/docs/api/1/get/users/show
+      # @rate_limited Yes
+      # @requires_authentication No
+      # @overload user(user, options={})
+      #   @param user [Integer, String] A Twitter user ID or screen name.
+      #   @param options [Hash] A customizable set of options.
+      #   @option options [Boolean, String, Integer] :include_entities Include {https://dev.twitter.com/docs/tweet-entities Tweet Entities} when set to true, 't' or 1.
+      #   @return [Twitter::User] The requested user.
+      #   @example Return extended information for @sferik
+      #     Twitter.user("sferik")
+      #     Twitter.user(7505382)  # Same as above
+      def user(*args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        if user = args.pop
+          options.merge_user!(user)
+          user = get("/1/users/show.json", options)
+        else
+          user = get("/1/account/verify_credentials.json", options)
+        end
+        Twitter::User.new(user)
+      end
+
+      # Returns true if the specified user exists
+      #
+      # @param user [Integer, String] A Twitter user ID or screen name.
+      # @return [Boolean] true if the user exists, otherwise false.
+      # @example Return true if @sferik exists
+      #     Twitter.user?("sferik")
+      #     Twitter.user?(7505382)  # Same as above
+      # @requires_authentication No
+      # @rate_limited Yes
+      def user?(user, options={})
+        options.merge_user!(user)
+        get("/1/users/show.json", options, :raw => true)
+        true
+      rescue Twitter::Error::NotFound
+        false
+      end
+
+      # Returns an array of users that the specified user can contribute to
+      #
+      # @see http://dev.twitter.com/docs/api/1/get/users/contributees
+      # @rate_limited Yes
+      # @requires_authentication No unless requesting it from a protected user
+      #
+      #   If getting this data of a protected user, you must authenticate (and be allowed to see that user).
+      # @overload contributees(options={})
+      #   @param options [Hash] A customizable set of options.
+      #   @option options [Boolean, String, Integer] :include_entities Include {http://dev.twitter.com/pages/tweet_entities Tweet Entities} when set to true, 't' or 1.
+      #   @option options [Boolean, String, Integer] :skip_status Do not include contributee's statuses when set to true, 't' or 1.
+      #   @return [Array<Twitter::User>]
+      #   @example Return the authenticated user's contributees
+      #     Twitter.contributees
+      ## @overload contributees(user, options={})
+      #   @param user [Integer, String] A Twitter user ID or screen name.
+      #   @param options [Hash] A customizable set of options.
+      #   @option options [Boolean, String, Integer] :include_entities Include {http://dev.twitter.com/pages/tweet_entities Tweet Entities} when set to true, 't' or 1.
+      #   @option options [Boolean, String, Integer] :skip_status Do not include contributee's statuses when set to true, 't' or 1.
+      #   @return [Array<Twitter::User>]
+      #   @example Return users @sferik can contribute to
+      #     Twitter.contributees("sferik")
+      #     Twitter.contributees(7505382)  # Same as above
+      def contributees(*args)
+        options = {}
+        options.merge!(args.last.is_a?(Hash) ? args.pop : {})
+        user = args.pop || self.current_user.screen_name
+        options.merge_user!(user)
+        get("/1/users/contributees.json", options).map do |user|
+          Twitter::User.new(user)
+        end
+      end
+
+      # Returns an array of users who can contribute to the specified account
+      #
+      # @see http://dev.twitter.com/docs/api/1/get/users/contributors
+      # @rate_limited Yes
+      # @requires_authentication No unless requesting it from a protected user
+      #
+      #   If getting this data of a protected user, you must authenticate (and be allowed to see that user).
+      # @overload contributors(options={})
+      #   @param options [Hash] A customizable set of options.
+      #   @option options [Boolean, String, Integer] :include_entities Include {http://dev.twitter.com/pages/tweet_entities Tweet Entities} when set to true, 't' or 1.
+      #   @option options [Boolean, String, Integer] :skip_status Do not include contributee's statuses when set to true, 't' or 1.
+      #   @return [Array<Twitter::User>]
+      #   @example Return the authenticated user's contributors
+      #     Twitter.contributors
+      ## @overload contributors(user, options={})
+      #   @param user [Integer, String] A Twitter user ID or screen name.
+      #   @param options [Hash] A customizable set of options.
+      #   @option options [Boolean, String, Integer] :include_entities Include {http://dev.twitter.com/pages/tweet_entities Tweet Entities} when set to true, 't' or 1.
+      #   @option options [Boolean, String, Integer] :skip_status Do not include contributee's statuses when set to true, 't' or 1.
+      #   @return [Array<Twitter::User>]
+      #   @example Return users who can contribute to @sferik's account
+      #     Twitter.contributors("sferik")
+      #     Twitter.contributors(7505382)  # Same as above
+      def contributors(*args)
+        options = {}
+        options.merge!(args.last.is_a?(Hash) ? args.pop : {})
+        user = args.pop || self.current_user.screen_name
+        options.merge_user!(user)
+        get("/1/users/contributors.json", options).map do |user|
+          Twitter::User.new(user)
+        end
+      end
+
+      # Returns recommended users for the authenticated user
+      #
+      # @note {https://dev.twitter.com/discussions/1120 Undocumented}
+      # @rate_limited Yes
+      # @requires_authentication Yes
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :limit (20) Specifies the number of records to retrieve.
+      # @option options [String] :excluded Comma-separated list of user IDs to exclude.
+      # @option options [String] :screen_name Find users similar to this screen_name
+      # @option options [Integer] :user_id Find users similar to this user ID.
+      # @return [Array<Twitter::User>]
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example Return recommended users for the authenticated user
+      #   Twitter.recommendations
+      def recommendations(options={})
+        options[:excluded] = options[:excluded].join(',') if options[:excluded].is_a?(Array)
+        get("/1/users/recommendations.json", options).map do |recommendation|
+          Twitter::User.new(recommendation['user'])
+        end
+      end
+
+    end
+  end
+end

data/lib/twitter/config.rb

@@ -0,0 +1,106 @@
+require 'twitter/version'
+
+module Twitter
+  # Defines constants and methods related to configuration
+  module Config
+
+    # The HTTP connection adapter that will be used to connect if none is set
+    DEFAULT_ADAPTER = :net_http
+
+    # The Faraday connection options if none is set
+    DEFAULT_CONNECTION_OPTIONS = {}
+
+    # The consumer key if none is set
+    DEFAULT_CONSUMER_KEY = nil
+
+    # The consumer secret if none is set
+    DEFAULT_CONSUMER_SECRET = nil
+
+    # The endpoint that will be used to connect if none is set
+    #
+    # @note This is configurable in case you want to use HTTP instead of HTTPS, specify a different API version, or use a Twitter-compatible endpoint.
+    # @see http://status.net/wiki/Twitter-compatible_API
+    # @see http://en.blog.wordpress.com/2009/12/12/twitter-api/
+    # @see http://staff.tumblr.com/post/287703110/api
+    # @see http://developer.typepad.com/typepad-twitter-api/twitter-api.html
+    DEFAULT_ENDPOINT = 'https://api.twitter.com'
+
+    # The gateway server if none is set
+    DEFAULT_GATEWAY = nil
+
+    # This endpoint will be used by default when updating statuses with media
+    DEFAULT_MEDIA_ENDPOINT = 'https://upload.twitter.com'
+
+    # The oauth token if none is set
+    DEFAULT_OAUTH_TOKEN = nil
+
+    # The oauth token secret if none is set
+    DEFAULT_OAUTH_TOKEN_SECRET = nil
+
+    # The proxy server if none is set
+    DEFAULT_PROXY = nil
+
+    # The search endpoint that will be used to connect if none is set
+    #
+    # @note This is configurable in case you want to use HTTP instead of HTTPS or use a Twitter-compatible endpoint.
+    # @see http://status.net/wiki/Twitter-compatible_API
+    DEFAULT_SEARCH_ENDPOINT = 'https://search.twitter.com'
+
+    # The value sent in the 'User-Agent' header if none is set
+    DEFAULT_USER_AGENT = "Twitter Ruby Gem #{Twitter::Version}"
+
+    # An array of valid keys in the options hash when configuring a {Twitter::Client}
+    VALID_OPTIONS_KEYS = [
+      :adapter,
+      :connection_options,
+      :consumer_key,
+      :consumer_secret,
+      :endpoint,
+      :gateway,
+      :oauth_token,
+      :oauth_token_secret,
+      :proxy,
+      :search_endpoint,
+      :user_agent,
+      :media_endpoint
+    ]
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+      self
+    end
+
+    # Create a hash of options and their values
+    def options
+      options = {}
+      VALID_OPTIONS_KEYS.each{|k| options[k] = send(k)}
+      options
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.adapter            = DEFAULT_ADAPTER
+      self.connection_options = DEFAULT_CONNECTION_OPTIONS
+      self.consumer_key       = DEFAULT_CONSUMER_KEY
+      self.consumer_secret    = DEFAULT_CONSUMER_SECRET
+      self.endpoint           = DEFAULT_ENDPOINT
+      self.gateway            = DEFAULT_GATEWAY
+      self.media_endpoint     = DEFAULT_MEDIA_ENDPOINT
+      self.oauth_token        = DEFAULT_OAUTH_TOKEN
+      self.oauth_token_secret = DEFAULT_OAUTH_TOKEN_SECRET
+      self.proxy              = DEFAULT_PROXY
+      self.search_endpoint    = DEFAULT_SEARCH_ENDPOINT
+      self.user_agent         = DEFAULT_USER_AGENT
+      self
+    end
+
+  end
+end

data/lib/twitter/configuration.rb

@@ -0,0 +1,20 @@
+require 'active_support/core_ext/enumerable'
+require 'twitter/base'
+require 'twitter/size'
+
+module Twitter
+  class Configuration < Twitter::Base
+    lazy_attr_reader :characters_reserved_per_media, :max_media_per_upload,
+      :non_username_paths, :photo_size_limit, :short_url_length, :short_url_length_https
+
+    # Returns an array of photo sizes
+    #
+    # @return [Array<Twitter::Size>]
+    def photo_sizes
+      @photo_sizes ||= Array(@attrs['photo_sizes']).each_with_object({}) do |(key, value), object|
+        object[key] = Twitter::Size.new(value)
+      end
+    end
+
+  end
+end

data/lib/twitter/connection.rb

@@ -0,0 +1,43 @@
+require 'faraday'
+require 'twitter/core_ext/hash'
+require 'twitter/request/gateway'
+require 'twitter/request/multipart_with_file'
+require 'twitter/request/phoenix'
+require 'twitter/request/oauth'
+require 'twitter/response/parse_json'
+require 'twitter/response/raise_client_error'
+require 'twitter/response/raise_server_error'
+
+module Twitter
+  module Connection
+  private
+
+    # Returns a Faraday::Connection object
+    #
+    # @param options [Hash] A hash of options
+    # @return [Faraday::Connection]
+    def connection(options={})
+      default_options = {
+        :headers => {
+          :accept => 'application/json',
+          :user_agent => user_agent,
+        },
+        :proxy => proxy,
+        :ssl => {:verify => false},
+        :url => options.fetch(:endpoint, endpoint),
+      }
+      @connection ||=Faraday.new(default_options.deep_merge(connection_options)) do |builder|
+        builder.use Twitter::Request::Phoenix
+        builder.use Twitter::Request::MultipartWithFile
+        builder.use Twitter::Request::TwitterOAuth, credentials if credentials?
+        builder.use Faraday::Request::Multipart
+        builder.use Faraday::Request::UrlEncoded
+        builder.use Twitter::Request::Gateway, gateway if gateway
+        builder.use Twitter::Response::RaiseClientError
+        builder.use Twitter::Response::ParseJson
+        builder.use Twitter::Response::RaiseServerError
+        builder.adapter(adapter)
+      end
+    end
+  end
+end

data/lib/twitter/core_ext/hash.rb

@@ -0,0 +1,81 @@
+class Hash
+
+  # Merges self with another hash, recursively
+  #
+  # @param hash [Hash] The hash to merge
+  # @return [Hash]
+  def deep_merge(hash)
+    target = self.dup
+    hash.keys.each do |key|
+      if hash[key].is_a?(Hash) && self[key].is_a?(Hash)
+        target[key] = target[key].deep_merge(hash[key])
+        next
+      end
+      target[key] = hash[key]
+    end
+    target
+  end
+
+  # Take a single user ID or screen name and merge it into self with the correct key
+  #
+  # @param user_id_or_screen_name [Integer, String] A Twitter user ID or screen_name.
+  # @return [Hash]
+  def merge_user!(user_id_or_screen_name)
+    case user_id_or_screen_name
+    when Integer
+      self[:user_id] = user_id_or_screen_name
+    when String
+      self[:screen_name] = user_id_or_screen_name
+    end
+    self
+  end
+
+  # Take a multiple user IDs and screen names and merge them into self with the correct keys
+  #
+  # @param users_id_or_screen_names [Array] An array of Twitter user IDs or screen_names.
+  # @return [Hash]
+  def merge_users!(user_ids_or_screen_names)
+    user_ids, screen_names = [], []
+    user_ids_or_screen_names.flatten.each do |user_id_or_screen_name|
+      case user_id_or_screen_name
+      when Integer
+        user_ids << user_id_or_screen_name
+      when String
+        screen_names << user_id_or_screen_name
+      end
+    end
+    self[:user_id] = user_ids.join(',') unless user_ids.empty?
+    self[:screen_name] = screen_names.join(',') unless screen_names.empty?
+    self
+  end
+
+  # Take a single owner ID or owner screen name and merge it into self with the correct key
+  # (for Twitter API endpoints that want :owner_id and :owner_screen_name)
+  #
+  # @param owner_id_or_owner_screen_name [Integer, String] A Twitter user ID or screen_name.
+  # @return [Hash]
+  def merge_owner!(owner_id_or_owner_screen_name)
+    case owner_id_or_owner_screen_name
+    when Integer
+      self[:owner_id] = owner_id_or_owner_screen_name
+    when String
+      self[:owner_screen_name] = owner_id_or_owner_screen_name
+    end
+    self
+  end
+
+  # Take a single list ID or slug and merge it into self with the correct key
+  #
+  # @param list_id_or_slug [Integer, String] A Twitter list ID or slug.
+  # @return [Hash]
+  def merge_list!(list_id_or_screen_name)
+    case list_id_or_screen_name
+    when Integer
+      self[:list_id] = list_id_or_screen_name
+    when String
+      self[:slug] = list_id_or_screen_name
+    end
+    self
+  end
+
+end