twitter 4.0.0

data/lib/twitter/core_ext/string.rb

@@ -0,0 +1,10 @@
+class String
+
+  # Converts a snake_case string to CamelCase
+  #
+  # @return [String]
+  def camelize
+    self.gsub(/\/(.?)/){"::#{$1.upcase}"}.gsub(/(?:^|_)(.)/){$1.upcase}
+  end unless method_defined?(:camelize)
+
+end

data/lib/twitter/creatable.rb

@@ -0,0 +1,20 @@
+require 'time'
+
+module Twitter
+  module Creatable
+
+    # Time when the object was created on Twitter
+    #
+    # @return [Time]
+    def created_at
+      @created_at ||= Time.parse(@attrs[:created_at]) if created?
+    end
+
+  private
+
+    def created?
+      !@attrs[:created_at].nil?
+    end
+
+  end
+end

data/lib/twitter/cursor.rb

@@ -0,0 +1,87 @@
+require 'twitter/core_ext/kernel'
+
+module Twitter
+  class Cursor
+    include Enumerable
+    attr_reader :attrs, :collection
+    alias to_hash attrs
+
+    # Initializes a new Cursor object
+    #
+    # @param response [Hash]
+    # @param collection_name [String, Symbol] The name of the method to return the collection
+    # @param klass [Class] The class to instantiate object in the collection
+    # @param client [Twitter::Client]
+    # @param method_name [String, Symbol]
+    # @param method_options [Hash]
+    # @return [Twitter::Cursor]
+    def self.from_response(response, collection_name, klass, client, method_name, method_options)
+      new(response[:body], collection_name, klass, client, method_name, method_options)
+    end
+
+    # Initializes a new Cursor
+    #
+    # @param attrs [Hash]
+    # @param collection_name [String, Symbol] The name of the method to return the collection
+    # @param klass [Class] The class to instantiate object in the collection
+    # @param client [Twitter::Client]
+    # @param method_name [String, Symbol]
+    # @param method_options [Hash]
+    # @return [Twitter::Cursor]
+    def initialize(attrs, collection_name, klass, client, method_name, method_options)
+      @attrs = attrs
+      @client = client
+      @method_name = method_name
+      @method_options = method_options
+      @collection = Array(attrs[collection_name.to_sym]).map do |item|
+        if klass
+          klass.fetch_or_new(item)
+        else
+          item
+        end
+      end
+      class_eval do
+        alias_method(collection_name.to_sym, :collection)
+      end
+    end
+
+    # @param collection [Array]
+    # @param cursor [Integer]
+    # @return [Array]
+    def all(collection=collection, cursor=next_cursor)
+      cursor = @client.send(@method_name.to_sym, @method_options.merge(:cursor => cursor))
+      collection += cursor.collection
+      cursor.last? ? collection.flatten : all(collection, cursor.next_cursor)
+    end
+
+    # @return [Enumerable]
+    def each
+      all(collection, next_cursor).each do |element|
+        yield element
+      end
+    end
+
+    def next_cursor
+      @attrs[:next_cursor] || -1
+    end
+    alias next next_cursor
+
+    def previous_cursor
+      @attrs[:previous_cursor]
+    end
+    alias previous previous_cursor
+
+    # @return [Boolean]
+    def first?
+      previous_cursor.zero?
+    end
+    alias first first?
+
+    # @return [Boolean]
+    def last?
+      next_cursor.zero?
+    end
+    alias last last?
+
+  end
+end

data/lib/twitter/default.rb

@@ -0,0 +1,101 @@
+require 'faraday'
+require 'twitter/configurable'
+require 'twitter/error/client_error'
+require 'twitter/error/server_error'
+require 'twitter/identity_map'
+require 'twitter/request/multipart_with_file'
+require 'twitter/response/parse_json'
+require 'twitter/response/raise_error'
+require 'twitter/version'
+
+module Twitter
+  module Default
+    ENDPOINT = 'https://api.twitter.com' unless defined? ENDPOINT
+    CONNECTION_OPTIONS = {
+      :headers => {
+        :accept => 'application/json',
+        :user_agent => "Twitter Ruby Gem #{Twitter::Version}"
+      },
+      :open_timeout => 5,
+      :raw => true,
+      :ssl => {:verify => false},
+      :timeout => 10,
+    } unless defined? CONNECTION_OPTIONS
+    IDENTITY_MAP = false unless defined? IDENTITY_MAP
+    MIDDLEWARE = Faraday::Builder.new(
+      &Proc.new do |builder|
+        # Convert file uploads to Faraday::UploadIO objects
+        builder.use Twitter::Request::MultipartWithFile
+        # Checks for files in the payload
+        builder.use Faraday::Request::Multipart
+        # Convert request params to "www-form-urlencoded"
+        builder.use Faraday::Request::UrlEncoded
+        # Handle 4xx server responses
+        builder.use Twitter::Response::RaiseError, Twitter::Error::ClientError
+        # Parse JSON response bodies using MultiJson
+        builder.use Twitter::Response::ParseJson
+        # Handle 5xx server responses
+        builder.use Twitter::Response::RaiseError, Twitter::Error::ServerError
+        # Set Faraday's HTTP adapter
+        builder.adapter Faraday.default_adapter
+      end
+    )
+
+    class << self
+
+      # @return [Hash]
+      def options
+        Hash[Twitter::Configurable.keys.map{|key| [key, send(key)]}]
+      end
+
+      # @return [String]
+      def consumer_key
+        ENV['TWITTER_CONSUMER_KEY']
+      end
+
+      # @return [String]
+      def consumer_secret
+        ENV['TWITTER_CONSUMER_SECRET']
+      end
+
+      # @return [String]
+      def oauth_token
+        ENV['TWITTER_OAUTH_TOKEN']
+      end
+
+      # @return [String]
+      def oauth_token_secret
+        ENV['TWITTER_OAUTH_TOKEN_SECRET']
+      end
+
+      # @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
+      # @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
+      # @return [String]
+      def endpoint
+        ENDPOINT
+      end
+
+      # @return [Hash]
+      def connection_options
+        CONNECTION_OPTIONS
+      end
+
+      # @return [Twitter::IdentityMap]
+      def identity_map
+        IDENTITY_MAP
+      end
+
+      # @note Faraday's middleware stack implementation is comparable to that of Rack middleware.  The order of middleware is important: the first middleware on the list wraps all others, while the last middleware is the innermost one.
+      # @see https://github.com/technoweenie/faraday#advanced-middleware-usage
+      # @see http://mislav.uniqpath.com/2011/07/faraday-advanced-http/
+      # @return [Faraday::Builder]
+      def middleware
+        MIDDLEWARE
+      end
+
+    end
+  end
+end

data/lib/twitter/direct_message.rb

@@ -0,0 +1,21 @@
+require 'twitter/creatable'
+require 'twitter/identity'
+require 'twitter/user'
+
+module Twitter
+  class DirectMessage < Twitter::Identity
+    include Twitter::Creatable
+    attr_reader :text
+
+    # @return [Twitter::User]
+    def recipient
+      @recipient ||= Twitter::User.fetch_or_new(@attrs[:recipient])
+    end
+
+    # @return [Twitter::User]
+    def sender
+      @sender ||= Twitter::User.fetch_or_new(@attrs[:sender])
+    end
+
+  end
+end

data/lib/twitter/entity.rb

@@ -0,0 +1,7 @@
+require 'twitter/base'
+
+module Twitter
+  class Entity < Twitter::Base
+    attr_reader :indices
+  end
+end

data/lib/twitter/entity/hashtag.rb

@@ -0,0 +1,9 @@
+require 'twitter/entity'
+
+module Twitter
+  class Entity
+    class Hashtag < Twitter::Entity
+      attr_reader :text
+    end
+  end
+end

data/lib/twitter/entity/url.rb

@@ -0,0 +1,9 @@
+require 'twitter/entity'
+
+module Twitter
+  class Entity
+    class Url < Twitter::Entity
+      attr_reader :display_url, :expanded_url, :url
+    end
+  end
+end

data/lib/twitter/entity/user_mention.rb

@@ -0,0 +1,9 @@
+require 'twitter/entity'
+
+module Twitter
+  class Entity
+    class UserMention < Twitter::Entity
+      attr_reader :id, :name, :screen_name
+    end
+  end
+end

data/lib/twitter/error.rb

@@ -0,0 +1,34 @@
+require 'twitter/rate_limit'
+
+module Twitter
+  # Custom error class for rescuing from all Twitter errors
+  class Error < StandardError
+    attr_reader :rate_limit, :wrapped_exception
+
+    # @return [Hash]
+    def self.errors
+      @errors ||= Hash[descendants.map{|klass| [klass.const_get(:HTTP_STATUS_CODE), klass]}]
+    end
+
+    # @return [Array]
+    def self.descendants
+      ObjectSpace.each_object(::Class).select{|klass| klass < self}
+    end
+
+    # Initializes a new Error object
+    #
+    # @param exception [Exception, String]
+    # @param response_headers [Hash]
+    # @return [Twitter::Error]
+    def initialize(exception=$!, response_headers={})
+      @rate_limit = Twitter::RateLimit.new(response_headers)
+      @wrapped_exception = exception
+      exception.respond_to?(:backtrace) ? super(exception.message) : super(exception.to_s)
+    end
+
+    def backtrace
+      @wrapped_exception.respond_to?(:backtrace) ? @wrapped_exception.backtrace : super
+    end
+
+  end
+end

data/lib/twitter/error/bad_gateway.rb

@@ -0,0 +1,11 @@
+require 'twitter/error/server_error'
+
+module Twitter
+  class Error
+    # Raised when Twitter returns the HTTP status code 502
+    class BadGateway < Twitter::Error::ServerError
+      HTTP_STATUS_CODE = 502
+      MESSAGE = "Twitter is down or being upgraded."
+    end
+  end
+end

data/lib/twitter/error/bad_request.rb

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

data/lib/twitter/error/client_error.rb

@@ -0,0 +1,35 @@
+require 'twitter/error'
+
+module Twitter
+  class Error
+    # Raised when Twitter returns a 4xx HTTP status code or there's an error in Faraday
+    class ClientError < Twitter::Error
+
+      # Create a new error from an HTTP environment
+      #
+      # @param response [Hash]
+      # @return [Twitter::Error]
+      def self.from_response(response={})
+        new(parse_error(response[:body]), response[:response_headers])
+      end
+
+    private
+
+      def self.parse_error(body)
+        if body.nil?
+          ''
+        elsif body[:error]
+          body[:error]
+        elsif body[:errors]
+          first = Array(body[:errors]).first
+          if first.kind_of?(Hash)
+            first[:message].chomp
+          else
+            first.chomp
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/twitter/error/decode_error.rb

@@ -0,0 +1,9 @@
+require 'twitter/error'
+
+module Twitter
+  class Error
+    # Raised when JSON parsing fails
+    class DecodeError < Twitter::Error
+    end
+  end
+end

data/lib/twitter/error/forbidden.rb

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

data/lib/twitter/error/gateway_timeout.rb

@@ -0,0 +1,11 @@
+require 'twitter/error/server_error'
+
+module Twitter
+  class Error
+    # Raised when Twitter returns the HTTP status code 504
+    class GatewayTimeout < Twitter::Error::ServerError
+      HTTP_STATUS_CODE = 504
+      MESSAGE = "The Twitter servers are up, but the request couldn't be serviced due to some failure within our stack. Try again later."
+    end
+  end
+end

data/lib/twitter/error/identity_map_key_error.rb

@@ -0,0 +1,9 @@
+require 'twitter/error'
+
+module Twitter
+  class Error
+    # Inherit from KeyError when Ruby 1.8 compatibility is removed
+    class IdentityMapKeyError < ::IndexError
+    end
+  end
+end

data/lib/twitter/error/internal_server_error.rb

@@ -0,0 +1,11 @@
+require 'twitter/error/server_error'
+
+module Twitter
+  class Error
+    # Raised when Twitter returns the HTTP status code 500
+    class InternalServerError < Twitter::Error::ServerError
+      HTTP_STATUS_CODE = 500
+      MESSAGE = "Something is technically wrong."
+    end
+  end
+end

data/lib/twitter/error/not_acceptable.rb

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