sferik/twitter

View on GitHub
lib/twitter/rest/help.rb

Summary

Maintainability
A
0 mins
Test Coverage
require "twitter/language"
require "twitter/rest/request"
require "twitter/rest/utils"

module Twitter
  module REST
    module Help
      include Twitter::REST::Utils

      # Returns the list of languages supported by Twitter
      #
      # @see https://dev.twitter.com/rest/reference/get/help/languages
      # @rate_limited Yes
      # @authentication Requires user context
      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
      # @return [Array<Twitter::Language>]
      def languages(options = {})
        perform_get_with_objects("/1.1/help/languages.json", options, Twitter::Language)
      end

      # Returns {https://twitter.com/privacy Twitter's Privacy Policy}
      #
      # @see https://dev.twitter.com/rest/reference/get/help/privacy
      # @rate_limited Yes
      # @authentication Requires user context
      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
      # @return [String]
      def privacy(options = {})
        perform_get("/1.1/help/privacy.json", options)[:privacy]
      end

      # Returns {https://twitter.com/tos Twitter's Terms of Service}
      #
      # @see https://dev.twitter.com/rest/reference/get/help/tos
      # @rate_limited Yes
      # @authentication Requires user context
      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
      # @return [String]
      def tos(options = {})
        perform_get("/1.1/help/tos.json", options)[:tos]
      end
    end
  end
end