ifttt-twitter 2.1.1

data/lib/twitter/client/local_trends.rb

@@ -0,0 +1,46 @@
+require 'twitter/place'
+require 'twitter/trend'
+
+module Twitter
+  class Client
+    # Defines methods related to local trends
+    # @see Twitter::Client::Trends
+    module LocalTrends
+
+      # Returns the top 10 trending topics for a specific WOEID
+      #
+      # @see https://dev.twitter.com/docs/api/1/get/trends/:woeid
+      # @rate_limited Yes
+      # @requires_authentication No
+      # @param woeid [Integer] The {https://developer.yahoo.com/geo/geoplanet Yahoo! Where On Earth ID} of the location to return trending information for. WOEIDs can be retrieved by calling {Twitter::Client::LocalTrends#trend_locations}. Global information is available by using 1 as the WOEID.
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :exclude Setting this equal to 'hashtags' will remove all hashtags from the trends list.
+      # @return [Array<Twitter::Trend>]
+      # @example Return the top 10 trending topics for San Francisco
+      #   Twitter.local_trends(2487956)
+      def local_trends(woeid=1, options={})
+        get("/1/trends/#{woeid}.json", options).first['trends'].map do |trend|
+          Twitter::Trend.new(trend)
+        end
+      end
+
+      # Returns the locations that Twitter has trending topic information for
+      #
+      # @see https://dev.twitter.com/docs/api/1/get/trends/available
+      # @rate_limited Yes
+      # @requires_authentication No
+      # @param options [Hash] A customizable set of options.
+      # @option options [Float] :lat If provided with a :long option the available trend locations will be sorted by distance, nearest to furthest, to the co-ordinate pair. The valid ranges for latitude are -90.0 to +90.0 (North is positive) inclusive.
+      # @option options [Float] :long If provided with a :lat option the available trend locations will be sorted by distance, nearest to furthest, to the co-ordinate pair. The valid ranges for longitude are -180.0 to +180.0 (East is positive) inclusive.
+      # @return [Array<Twitter::Place>]
+      # @example Return the locations that Twitter has trending topic information for
+      #   Twitter.trend_locations
+      def trend_locations(options={})
+        get("/1/trends/available.json", options).map do |place|
+          Twitter::Place.new(place)
+        end
+      end
+
+    end
+  end
+end

data/lib/twitter/client/notification.rb

@@ -0,0 +1,49 @@
+require 'twitter/core_ext/hash'
+require 'twitter/user'
+
+module Twitter
+  class Client
+    # Defines methods related to notification
+    module Notification
+
+      # Enables device notifications for updates from the specified user to the authenticating user
+      #
+      # @see https://dev.twitter.com/docs/api/1/post/notifications/follow
+      # @rate_limited No
+      # @requires_authentication Yes
+      # @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 specified user.
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example Enable device notifications for updates from @sferik
+      #   Twitter.enable_notifications("sferik")
+      #   Twitter.enable_notifications(7505382)  # Same as above
+      def enable_notifications(user, options={})
+        options.merge_user!(user)
+        user = post("/1/notifications/follow.json", options)
+        Twitter::User.new(user)
+      end
+
+      # Disables notifications for updates from the specified user to the authenticating user
+      #
+      # @see https://dev.twitter.com/docs/api/1/post/notifications/leave
+      # @rate_limited No
+      # @requires_authentication Yes
+      # @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 specified user.
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example Disable device notifications for updates from @sferik
+      #   Twitter.disable_notifications("sferik")
+      #   Twitter.disable_notifications(7505382)  # Same as above
+      def disable_notifications(user, options={})
+        options.merge_user!(user)
+        user = post("/1/notifications/leave.json", options)
+        Twitter::User.new(user)
+      end
+
+    end
+  end
+end

data/lib/twitter/client/places_and_geo.rb

@@ -0,0 +1,113 @@
+require 'twitter/place'
+
+module Twitter
+  class Client
+    # Defines methods related to geography
+    # @see https://dev.twitter.com/terms/geo-developer-guidelines Developer Guidelines
+    module PlacesAndGeo
+
+      # Search for places that can be attached to a {Twitter::Client::Tweets#update}
+      #
+      # @see https://dev.twitter.com/docs/api/1/get/geo/search
+      # @rate_limited Yes
+      # @requires_authentication No
+      # @param options [Hash] A customizable set of options.
+      # @option options [Float] :lat The latitude to search around. This option will be ignored unless it is inside the range -90.0 to +90.0 (North is positive) inclusive. It will also be ignored if there isn't a corresponding :long option.
+      # @option options [Float] :long The longitude to search around. The valid range for longitude is -180.0 to +180.0 (East is positive) inclusive. This option will be ignored if outside that range, if it is not a number, if geo_enabled is disabled, or if there not a corresponding :lat option.
+      # @option options [String] :query Free-form text to match against while executing a geo-based query, best suited for finding nearby locations by name.
+      # @option options [String] :ip An IP address. Used when attempting to fix geolocation based off of the user's IP address.
+      # @option options [String] :granularity ('neighborhood') This is the minimal granularity of place types to return and must be one of: 'poi', 'neighborhood', 'city', 'admin' or 'country'.
+      # @option options [String] :accuracy ('0m') A hint on the "region" in which to search. If a number, then this is a radius in meters, but it can also take a string that is suffixed with ft to specify feet. If coming from a device, in practice, this value is whatever accuracy the device has measuring its location (whether it be coming from a GPS, WiFi triangulation, etc.).
+      # @option options [Integer] :max_results A hint as to the number of results to return. This does not guarantee that the number of results returned will equal max_results, but instead informs how many "nearby" results to return. Ideally, only pass in the number of places you intend to display to the user here.
+      # @option options [String] :contained_within This is the place_id which you would like to restrict the search results to. Setting this value means only places within the given place_id will be found.
+      # @option options [String] :"attribute:street_address" This option searches for places which have this given street address. There are other well-known and application-specific attributes available. Custom attributes are also permitted.
+      # @return [Array<Twitter::Place>]
+      # @example Return an array of places near the IP address 74.125.19.104
+      #   Twitter.places_nearby(:ip => "74.125.19.104")
+      def places_nearby(options={})
+        get("/1/geo/search.json", options)['result']['places'].map do |place|
+          Twitter::Place.new(place)
+        end
+      end
+      alias :geo_search :places_nearby
+
+      # Locates places near the given coordinates which are similar in name
+      #
+      # @see https://dev.twitter.com/docs/api/1/get/geo/similar_places
+      # @note Conceptually, you would use this method to get a list of known places to choose from first. Then, if the desired place doesn't exist, make a request to {Twitter::Client::Geo#place} to create a new one. The token contained in the response is the token necessary to create a new place.
+      # @rate_limited Yes
+      # @requires_authentication No
+      # @param options [Hash] A customizable set of options.
+      # @option options [Float] :lat The latitude to search around. This option will be ignored unless it is inside the range -90.0 to +90.0 (North is positive) inclusive. It will also be ignored if there isn't a corresponding :long option.
+      # @option options [Float] :long The longitude to search around. The valid range for longitude is -180.0 to +180.0 (East is positive) inclusive. This option will be ignored if outside that range, if it is not a number, if geo_enabled is disabled, or if there not a corresponding :lat option.
+      # @option options [String] :name The name a place is known as.
+      # @option options [String] :contained_within This is the place_id which you would like to restrict the search results to. Setting this value means only places within the given place_id will be found.
+      # @option options [String] :"attribute:street_address" This option searches for places which have this given street address. There are other well-known and application-specific attributes available. Custom attributes are also permitted.
+      # @return [Array<Twitter::Place>]
+      # @example Return an array of places similar to Twitter HQ
+      #   Twitter.places_similar(:lat => "37.7821120598956", :long => "-122.400612831116", :name => "Twitter HQ")
+      def places_similar(options={})
+        get("/1/geo/similar_places.json", options)['result']['places'].map do |place|
+          Twitter::Place.new(place)
+        end
+      end
+
+      # Searches for up to 20 places that can be used as a place_id
+      #
+      # @see https://dev.twitter.com/docs/api/1/get/geo/reverse_geocode
+      # @note This request is an informative call and will deliver generalized results about geography.
+      # @rate_limited Yes
+      # @requires_authentication No
+      # @param options [Hash] A customizable set of options.
+      # @option options [Float] :lat The latitude to search around. This option will be ignored unless it is inside the range -90.0 to +90.0 (North is positive) inclusive. It will also be ignored if there isn't a corresponding :long option.
+      # @option options [Float] :long The longitude to search around. The valid range for longitude is -180.0 to +180.0 (East is positive) inclusive. This option will be ignored if outside that range, if it is not a number, if geo_enabled is disabled, or if there not a corresponding :lat option.
+      # @option options [String] :accuracy ('0m') A hint on the "region" in which to search. If a number, then this is a radius in meters, but it can also take a string that is suffixed with ft to specify feet. If coming from a device, in practice, this value is whatever accuracy the device has measuring its location (whether it be coming from a GPS, WiFi triangulation, etc.).
+      # @option options [String] :granularity ('neighborhood') This is the minimal granularity of place types to return and must be one of: 'poi', 'neighborhood', 'city', 'admin' or 'country'.
+      # @option options [Integer] :max_results A hint as to the number of results to return. This does not guarantee that the number of results returned will equal max_results, but instead informs how many "nearby" results to return. Ideally, only pass in the number of places you intend to display to the user here.
+      # @return [Array<Twitter::Place>]
+      # @example Return an array of places within the specified region
+      #   Twitter.reverse_geocode(:lat => "37.7821120598956", :long => "-122.400612831116")
+      def reverse_geocode(options={})
+        get("/1/geo/reverse_geocode.json", options)['result']['places'].map do |place|
+          Twitter::Place.new(place)
+        end
+      end
+
+      # Returns all the information about a known place
+      #
+      # @see https://dev.twitter.com/docs/api/1/get/geo/id/:place_id
+      # @rate_limited Yes
+      # @requires_authentication No
+      # @param place_id [String] A place in the world. These IDs can be retrieved from {Twitter::Client::Geo#reverse_geocode}.
+      # @param options [Hash] A customizable set of options.
+      # @return [Twitter::Place] The requested place.
+      # @example Return all the information about Twitter HQ
+      #   Twitter.place("247f43d441defc03")
+      def place(place_id, options={})
+        place = get("/1/geo/id/#{place_id}.json", options)
+        Twitter::Place.new(place)
+      end
+
+      # Creates a new place at the given latitude and longitude
+      #
+      # @see https://dev.twitter.com/docs/api/1/post/geo/place
+      # @rate_limited Yes
+      # @requires_authentication No
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :name The name a place is known as.
+      # @option options [String] :contained_within This is the place_id which you would like to restrict the search results to. Setting this value means only places within the given place_id will be found.
+      # @option options [String] :token The token found in the response from {Twitter::Client::Geo#places_similar}.
+      # @option options [Float] :lat The latitude to search around. This option will be ignored unless it is inside the range -90.0 to +90.0 (North is positive) inclusive. It will also be ignored if there isn't a corresponding :long option.
+      # @option options [Float] :long The longitude to search around. The valid range for longitude is -180.0 to +180.0 (East is positive) inclusive. This option will be ignored if outside that range, if it is not a number, if geo_enabled is disabled, or if there not a corresponding :lat option.
+      # @option options [String] :"attribute:street_address" This option searches for places which have this given street address. There are other well-known and application-specific attributes available. Custom attributes are also permitted.
+      # @return [Twitter::Place] The created place.
+      # @example Create a new place
+      #   Twitter.place_create(:name => "@sferik's Apartment", :token => "22ff5b1f7159032cf69218c4d8bb78bc", :contained_within => "41bcb736f84a799e", :lat => "37.783699", :long => "-122.393581")
+      def place_create(options={})
+        place = post("/1/geo/place.json", options)
+        Twitter::Place.new(place)
+      end
+
+    end
+  end
+end

data/lib/twitter/client/saved_searches.rb

@@ -0,0 +1,73 @@
+require 'twitter/saved_search'
+
+module Twitter
+  class Client
+    # Defines methods related to saved searches
+    module SavedSearches
+
+      # Returns the authenticated user's saved search queries
+      #
+      # @see https://dev.twitter.com/docs/api/1/get/saved_searches
+      # @rate_limited Yes
+      # @requires_authentication Yes
+      # @param options [Hash] A customizable set of options.
+      # @return [Array<Twitter::SavedSearch>] Saved search queries.
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example Return the authenticated user's saved search queries
+      #   Twitter.saved_searches
+      def saved_searches(options={})
+        get("/1/saved_searches.json", options).map do |saved_search|
+          Twitter::SavedSearch.new(saved_search)
+        end
+      end
+
+      # Retrieve the data for a saved search owned by the authenticating user specified by the given ID
+      #
+      # @see https://dev.twitter.com/docs/api/1/get/saved_searches/show/:id
+      # @rate_limited Yes
+      # @requires_authentication Yes
+      # @param id [Integer] The ID of the saved search.
+      # @param options [Hash] A customizable set of options.
+      # @return [Twitter::SavedSearch] The saved search.
+      # @raise [Twitter::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @example Retrieve the data for a saved search owned by the authenticating user with the ID 16129012
+      #   Twitter.saved_search(16129012)
+      def saved_search(id, options={})
+        saved_search = get("/1/saved_searches/show/#{id}.json", options)
+        Twitter::SavedSearch.new(saved_search)
+      end
+
+      # Creates a saved search for the authenticated user
+      #
+      # @see https://dev.twitter.com/docs/api/1/post/saved_searches/create
+      # @rate_limited No
+      # @requires_authentication Yes
+      # @param query [String] The query of the search the user would like to save.
+      # @param options [Hash] A customizable set of options.
+      # @return [Twitter::SavedSearch] The created saved search.
+      # @example Create a saved search for the authenticated user with the query "twitter"
+      #   Twitter.saved_search_create("twitter")
+      def saved_search_create(query, options={})
+        saved_search = post("/1/saved_searches/create.json", options.merge(:query => query))
+        Twitter::SavedSearch.new(saved_search)
+      end
+
+      # Destroys a saved search for the authenticated user
+      #
+      # @see https://dev.twitter.com/docs/api/1/post/saved_searches/destroy/:id
+      # @note The search specified by ID must be owned by the authenticating user.
+      # @rate_limited No
+      # @requires_authentication Yes
+      # @param id [Integer] The ID of the saved search.
+      # @param options [Hash] A customizable set of options.
+      # @return [Twitter::SavedSearch] The deleted saved search.
+      # @example Destroys a saved search for the authenticated user with the ID 16129012
+      #   Twitter.saved_search_destroy(16129012)
+      def saved_search_destroy(id, options={})
+        saved_search = delete("/1/saved_searches/destroy/#{id}.json", options)
+        Twitter::SavedSearch.new(saved_search)
+      end
+
+    end
+  end
+end

data/lib/twitter/client/search.rb

@@ -0,0 +1,94 @@
+require 'twitter/status'
+
+module Twitter
+  class Client
+    # Defines methods related to Search
+    module Search
+
+      # Returns recent statuses that contain images related to a query
+      #
+      # @note Undocumented
+      # @rate_limited Yes
+      # @requires_authentication No
+      # @param q [String] A search term.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :count Specifies the number of records to retrieve. Must be less than or equal to 100.
+      # @option options [Boolean, String, Integer] :include_entities Include {http://dev.twitter.com/pages/tweet_entities Tweet Entities} when set to true, 't' or 1.
+      # @return [Array<Twitter::Status>] An array of statuses that contain images
+      # @example Return recent statuses that contain images related to a query
+      #   Twitter.images('twitter')
+      def images(q, options={})
+        get("/i/search/image_facets.json", options.merge(:q => q), :phoenix => true).map do |status|
+          Twitter::Status.new(status)
+        end
+      end
+
+      # Returns recent statuses that contain videos related to a query
+      #
+      # @note Undocumented
+      # @rate_limited Yes
+      # @requires_authentication No
+      # @param q [String] A search term.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :count Specifies the number of records to retrieve. Must be less than or equal to 100.
+      # @option options [Boolean, String, Integer] :include_entities Include {http://dev.twitter.com/pages/tweet_entities Tweet Entities} when set to true, 't' or 1.
+      # @return [Array<Twitter::Status>] An array of statuses that contain videos
+      # @example Return recent statuses that contain videos related to a query
+      #   Twitter.videos('twitter')
+      def videos(q, options={})
+        get("/i/search/video_facets.json", options.merge(:q => q), :phoenix => true).map do |status|
+          Twitter::Status.new(status)
+        end
+      end
+
+      # Returns tweets that match a specified query.
+      #
+      # @see https://dev.twitter.com/docs/api/1/get/search
+      # @see https://dev.twitter.com/docs/using-search
+      # @see https://dev.twitter.com/docs/history-rest-search-api
+      # @note As of April 1st 2010, the Search API provides an option to retrieve "popular tweets" in addition to real-time search results. In an upcoming release, this will become the default and clients that don't want to receive popular tweets in their search results will have to explicitly opt-out. See the result_type parameter below for more information.
+      # @rate_limited Yes
+      # @requires_authentication No
+      # @param q [String] A search term.
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :geocode Returns tweets by users located within a given radius of the given latitude/longitude. The location is preferentially taking from the Geotagging API, but will fall back to their Twitter profile. The parameter value is specified by "latitude,longitude,radius", where radius units must be specified as either "mi" (miles) or "km" (kilometers). Note that you cannot use the near operator via the API to geocode arbitrary locations; however you can use this geocode parameter to search near geocodes directly.
+      # @option options [String] :lang Restricts tweets to the given language, given by an ISO 639-1 code.
+      # @option options [String] :locale Specify the language of the query you are sending (only ja is currently effective). This is intended for language-specific clients and the default should work in the majority of cases.
+      # @option options [Integer] :page The page number (starting at 1) to return, up to a max of roughly 1500 results (based on rpp * page).
+      # @option options [String] :result_type Specifies what type of search results you would prefer to receive. The current default is "mixed."
+      # @option options [Integer] :rpp The number of tweets to return per page, up to a max of 100.
+      # @option options [String] :until Optional. Returns tweets generated before the given date. Date should be formatted as YYYY-MM-DD.
+      # @option options [Integer] :since_id Returns results with an ID greater than (that is, more recent than) the specified ID. There are limits to the number of Tweets which can be accessed through the API. If the limit of Tweets has occured since the since_id, the since_id will be forced to the oldest ID available.
+      # @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] :with_twitter_user_id When set to either true, t or 1, the from_user_id, from_user_id_str, to_user_id, and to_user_id_str values in the response will map to "official" user IDs which will match those returned by the REST API.
+      # @return [Array<Twitter::Status>] Return tweets that match a specified query
+      # @example Returns tweets related to twitter
+      #   Twitter.search('twitter')
+      def search(q, options={})
+        get("/search.json", options.merge(:q => q), :endpoint => search_endpoint)['results'].map do |status|
+          Twitter::Status.new(status)
+        end
+      end
+
+      # Returns recent statuses related to a query with images and videos embedded
+      #
+      # @note Undocumented
+      # @rate_limited Yes
+      # @requires_authentication No
+      # @param q [String] A search term.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :count Specifies the number of records to retrieve. Must be less than or equal to 100.
+      # @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 [Integer] :since_id Returns results with an ID greater than (that is, more recent than) the specified ID.
+      # @return [Array<Twitter::Status>] An array of statuses that contain videos
+      # @example Return recent statuses related to twitter with images and videos embedded
+      #   Twitter.phoenix_search('twitter')
+      def phoenix_search(q, options={})
+        get("/phoenix_search.phoenix", options.merge(:q => q), :phoenix => true)['statuses'].map do |status|
+          Twitter::Status.new(status)
+        end
+      end
+
+    end
+  end
+end

data/lib/twitter/client/spam_reporting.rb

@@ -0,0 +1,30 @@
+require 'twitter/core_ext/hash'
+require 'twitter/user'
+
+module Twitter
+  class Client
+    # Defines methods related to spam reporting
+    # @see Twitter::Client::Block
+    module SpamReporting
+
+      # The user specified is blocked by the authenticated user and reported as a spammer
+      #
+      # @see https://dev.twitter.com/docs/api/1/post/report_spam
+      # @rate_limited Yes
+      # @requires_authentication No
+      # @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 reported user.
+      # @example Report @spam for spam
+      #   Twitter.report_spam("spam")
+      #   Twitter.report_spam(14589771) # Same as above
+      def report_spam(user, options={})
+        options.merge_user!(user)
+        user = post("/1/report_spam.json", options)
+        Twitter::User.new(user)
+      end
+
+    end
+  end
+end

data/lib/twitter/client/suggested_users.rb

@@ -0,0 +1,60 @@
+require 'twitter/suggestion'
+require 'twitter/user'
+
+module Twitter
+  class Client
+    # Defines methods related to users
+    module SuggestedUsers
+
+      # @overload suggestions(options={})
+      #   Returns the list of suggested user categories
+      #
+      #   @see https://dev.twitter.com/docs/api/1/get/users/suggestions
+      #   @rate_limited Yes
+      #   @requires_authentication No
+      #   @param options [Hash] A customizable set of options.
+      #   @return [Array<Twitter::Suggestion>]
+      #   @example Return the list of suggested user categories
+      #     Twitter.suggestions
+      # @overload suggestions(slug, options={})
+      #   Returns the users in a given category
+      #
+      #   @see https://dev.twitter.com/docs/api/1/get/users/suggestions/:slug
+      #   @rate_limited Yes
+      #   @requires_authentication No
+      #   @param slug [String] The short name of list or a category.
+      #   @param options [Hash] A customizable set of options.
+      #   @return [Array<Twitter::Suggestion>]
+      #   @example Return the users in the Art & Design category
+      #     Twitter.suggestions("art-design")
+      def suggestions(*args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        if slug = args.first
+          suggestion = get("/1/users/suggestions/#{slug}.json", options)
+          Twitter::Suggestion.new(suggestion)
+        else
+          get("/1/users/suggestions.json", options).map do |suggestion|
+            Twitter::Suggestion.new(suggestion)
+          end
+        end
+      end
+
+      # Access the users in a given category of the Twitter suggested user list and return their most recent status if they are not a protected user
+      #
+      # @see https://dev.twitter.com/docs/api/1/get/users/suggestions/:slug/members
+      # @rate_limited Yes
+      # @requires_authentication No
+      # @param slug [String] The short name of list or a category.
+      # @param options [Hash] A customizable set of options.
+      # @return [Array<Twitter::User>]
+      # @example Return the users in the Art & Design category and their most recent status if they are not a protected user
+      #   Twitter.suggest_users("art-design")
+      def suggest_users(slug, options={})
+        get("/1/users/suggestions/#{slug}/members.json", options).map do |user|
+          Twitter::User.new(user)
+        end
+      end
+
+    end
+  end
+end