Skip to content
Fetching contributors…
Cannot retrieve contributors at this time
2823 lines (2552 sloc) 107 KB
/*
Copyright © 2011 MLstate
This file is part of Opa.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
/**
* Twitter modules
*
* This file provides the implemented methods of Twitter API
* IMPORTANT NOTE: This API implementation uses OAuth.
*
* @category web
* @author Nicolas Glondu, 2010
* @destination
* - Twitter_private : private (and poorly documented)
* - Twitter : public (and well documented)
* @stability Work in progress
*/
package stdlib.apis.twitter
import stdlib.web.client
import stdlib.apis.common
import stdlib.apis.oauth
/* ---------------- */
/* Type definitions */
/* ---------------- */
/**
* Twitter error
*/
type Twitter.error = {
code : int
message : string
}
/**
* Twitter failure
*/
type Twitter.failure =
{ network : WebClient.failure }
/ { twitter : list(Twitter.error) }
/**
* Twitter outcome
*/
type Twitter.outcome('res) = outcome('res,Twitter.failure)
/**
* Wrapper type for paged replies.
*/
type Twitter.might_be_paged('a) =
{ previous_cursor : string next_cursor : string paged : 'a }
/ { unpaged : 'a }
/**
* Twitter configuration
*/
type Twitter.configuration = {
consumer_key : string
consumer_secret : string
}
/**
* OAuth credentials of a user
*/
type Twitter.credentials = {
access_token : string
access_secret : string
}
/**
* User definition for Twitter commands, either numerical ID or screen name.
* The IDs are strings because they're 64-bit.
*/
type Twitter.user =
{ user_id : string } /** Unique identifier of a user */
/ { screen_name : string } /** Screen name of a user */
/**
* Twitter result type for some commands.
*/
type Twitter.result_type = {mixed} / {recent} / {popular}
/**
* Options of a Twitter search
*
* - [geocode] Returns tweets by users located within a given radius of the given latitude/longitude.
* - [lang] Restricts results to given language
* - [locale] Restricts tweets to the given language, given by an ISO 639-1 code.
* - [result_type] Specifies what type of search results you would prefer to receive. (mixed, popular, recent)
* - [count] Tweets returned per page
* - [until] Returns tweets generated before the given date.
* - [since_id] Returns only tweets which id greater than since_id
* - [max_id] Returns results with an ID less than (that is, older than) or equal to the specified ID.
* - [include_entities] The entities node will be disincluded when set to false.
* - [callback] If supplied, the response will use the JSONP format with a callback of the given name.
*/
type Twitter.search_options = {
geocode : string
lang : string
locale : string
result_type : option(Twitter.result_type)
count : int
until : option(Date.date)
since_id : string
max_id : string
include_entities : option(bool)
callback : string
}
/**
* Options of a timeline request
*
* - [count] The number of statuses to return. Default is 20, may not be greater than 200
* - [since_id] Allows to get statuses with id greater than this id
* - [max_id] Allows to get statuses with id smaller than this id
* - [trim_user] When set to either true, t or 1, each tweet returned in a timeline will include a user object including only the status authors numerical ID.
* - [exclude_replies] This parameter will prevent replies from appearing in the returned timeline. (user_timeline and home_timeline only)
* - [contributor_details] This parameter enhances the contributors element of the status response to include the screen_name of the contributor.
* - [include_entities] The entities node will be disincluded when set to false.
* - [include_rts] When set to false, the timeline will strip any native retweets. (user_timeline only)
*/
type Twitter.timeline_options = {
count : int
since_id : string
max_id : string
trim_user : option(bool)
exclude_replies : option(bool)
contributor_details : option(bool)
include_entities : option(bool)
include_rts : option(bool)
}
/**
* Options for a general statuses resource request.
*
* - [trim_user] When set to either true, t or 1, each tweet returned in a timeline will include a user object including only the status authors numerical ID.
* - [include_my_retweet] When set to either true, t or 1, any Tweets returned that have been retweeted by the authenticating user will include an additional current_user_retweet node, containing the ID of the source status for the retweet.
* - [include_entities] The entities node will be disincluded when set to false.
*/
type Twitter.statuses_options = {
count : int
trim_user : option(bool)
include_my_retweet : option(bool)
include_entities : option(bool)
}
/**
* Options for statuses/update.
*/
type Twitter.update_options = {
in_reply_to_status_id : string /** The ID of an existing status that the update is in reply to. */
lat : option(float) /** The latitude of the location this tweet refers to. */
long : option(float) /** The longitude of the location this tweet refers to. */
place_id : string /** A place in the world. These IDs can be retrieved from GET geo/reverse_geocode. */
display_coordinates : option(bool) /** Whether or not to put a pin on the exact coordinates a tweet has been sent from. */
trim_user : option(bool) /** When set to either true, t or 1, each tweet returned in a timeline will include a user object including only the status authors numerical ID. */
}
type Twitter.settings_options = {
trend_location_woeid : option(int) /** The Yahoo! Where On Earth ID to use as the user's default trend location. */
sleep_time_enabled : option(bool) /** When set to true, t or 1, will enable sleep time for the user. */
start_sleep_time : option(int) /** The hour that sleep time should begin if it is enabled. */
end_sleep_time : option(int) /** The hour that sleep time should end if it is enabled. */
time_zone : string /** The timezone dates and times should be displayed in for the user. */
lang : string /** The language which Twitter should render in for this user. */
}
type Twitter.favorites_options = {
since_id : string /** Returns results with an ID greater than (that is, more recent than) the specified ID. */
max_id : string /** Returns results with an ID less than (that is, older than) or equal to the specified ID. */
count : int /** Specifies the number of records to retrieve. */
include_entities : option(bool) /** The entities node will be omitted when set to false. */
}
type Twitter.reverse_geocode_options = {
accuracy : string /** A hint on the "region" in which to search. */
granularity : string /** This is the minimal granularity of place types to return and must be one of: poi, neighborhood, city, admin or country. */
max_results : int /** A hint as to the number of results to return. */
callback : string /** If supplied, the response will use the JSONP format with a callback of the given name. */
}
type Twitter.geo_search_options = {
lat : option(float) /** The latitude to search around. */
long : option(float) /** The longitude to search around. */
query : string /** Free-form text to match against while executing a geo-based query, best suited for finding nearby locations by name. */
ip : string /** An IP address. Used when attempting to fix geolocation based off of the user's IP address. */
granularity : string /** This is the minimal granularity of place types to return and must be one of: poi, neighborhood, city, admin or country. */
accuracy : string /** A hint on the "region" in which to search. */
max_results : int /** A hint as to the number of results to return. */
contained_within : string /** This is the place_id which you would like to restrict the search results to. */
attribute_street_address : string /** This parameter searches for places which have this given street address. */
callback : string /** If supplied, the response will use the JSONP format with a callback of the given name. */
}
/**
* A Twitter list ID for commands.
* Must be either the list ID or the combination of a slug plus a user ID (numerical ID or screen name).
*/
type Twitter.list_id = {list_id:string} / {slug:string owner:{owner_id:string} / {owner_screen_name:string}}
type Twitter.lists_options = {
since_id : string /** Returns results with an ID greater than (that is, more recent than) the specified ID. */
max_id : string /** Returns results with an ID less than (that is, older than) or equal to the specified ID. */
count : int /** Specifies the number of results to retrieve per "page." */
include_entities : option(bool) /** Entities are ON by default in API 1.1, each tweet includes a node called "entities". */
include_rts : option(bool) /** When set to either true, t or 1, the list timeline will contain native retweets (if they exist) in addition to the standard stream of tweets. */
}
type Twitter.direct_messages_options = {
since_id : string /** Returns results with an ID greater than (that is, more recent than) the specified ID. */
max_id : string /** Returns results with an ID less than (that is, older than) or equal to the specified ID. */
count : int /** Specifies the number of direct messages to try and retrieve, up to a maximum of 200. */
page : int /** Specifies the page of results to retrieve. */
include_entities : option(bool) /** The entities node will not be included when set to false. */
skip_status : option(bool) /** When set to either true, t or 1 statuses will not be included in the returned user objects. */
}
/**
* Type of Twitter OAuth parameters
*/
type Twitter.oauth_mode =
{ fast } /** Use [fast] if you want Twitter to skip user authorization if he has already accepted your application once. {{:http://dev.twitter.com/pages/sign_in_with_twitter}Look here} for more information about this. */
/ { full } /** Use [full] if you want Twitter to always follow full OAuth flow, no matter which interaction current user had with your application. */
/* ---------------- */
/* Data types */
/* ---------------- */
/**
* Note for Twitter data types:
*
* The end user is not supposed to build object with those types. Those types are defined to structure
* the data passed back to the user. It is hence necessary that the end user knows which information
* the type contains.
*/
/**
* A Twitter trend.
*
* A trend on Twitter in one of the words mostly used in messages at a given date.
*/
type Twitter.trend = {
name : string; /** The name of the trend */
query : string; /** A query to access messages containing this trend */
url : string;
promoted_content : string;
events : string;
}
type Twitter.location = {
name : string
woeid : int
}
type Twitter.place = {
name : string
country_code : string
country : string
attributes : RPC.Json.json
url : string
id : string
bounding_box : Twitter.coordinates
full_name : string
place_type : string
geometry : RPC.Json.json
polylines : RPC.Json.json
contained_within : RPC.Json.json // It's actually a Twitter.place
}
type Twitter.place_type = {
code : int
name : string
}
type Twitter.full_location = {
country : string
countryCode : string
name : string
parentid : int
placeType : Twitter.place_type
url : string
woeid : int
}
/**
* Twitter trends.
*/
type Twitter.trends = {
as_of : string
created_at : string
locations : list(Twitter.location)
trends : list(Twitter.trend)
}
type Twitter.metadata = { result_type : string iso_language_code : string }
type Twitter.url = {
url : string
expanded_url : string
indices : list(int)
}
type Twitter.urls = {
urls : list(Twitter.url)
}
type Twitter.hashtag = {
text : string
indices : list(int)
}
type Twitter.entities = {
url : Twitter.urls
description : Twitter.urls
hashtags : list(Twitter.hashtag)
user_mentions : list(Twitter.user_mention)
}
type Twitter.full_user = {
contributors_enabled : bool /** Indicates that the user has an account with "contributor mode" enabled, allowing for Tweets issued by the user to be co-authored by another account. */
created_at : string /** The UTC datetime that the user account was created on Twitter. */
default_profile : bool /** When true, indicates that the user has not altered the theme or background of their user profile. */
default_profile_image : bool /** When true, indicates that the user has not uploaded their own avatar and a default egg avatar is used instead. */
description : string /** Nullable. The user-defined UTF-8 string describing their account. */
entities : Twitter.entities /** Entities which have been parsed out of the url or description fields defined by the user. */
favourites_count : int /** The number of tweets this user has favorited in the account's lifetime. */
follow_request_sent : bool /** Nullable. Perspectival. When true, indicates that the authenticating user has issued a follow request to this protected user account. */
//following : bool /** Nullable. Perspectival. Deprecated. When true, indicates that the authenticating user is following this user. */
followers_count : int /** The number of followers this account currently has. */
friends_count : int /** The number of users this account is following (AKA their "followings"). */
geo_enabled : bool /** When true, indicates that the user has enabled the possibility of geotagging their Tweets. */
id : string /** The string representation of the unique identifier for this Tweet. */
is_translator : bool /** When true, indicates that the user is a participant in Twitter's translator community. */
lang : string /** The ISO 639-1 two-letter character code for the user's self-declared user interface language. */
listed_count : int /** The number of public lists that this user is a member of. */
location : string /** Nullable. The user-defined location for this account's profile. */
name : string /** The name of the user, as they've defined it. */
//notifications : bool /** Nullable. Deprecated. Indicates whether the authenticated user has chosen to receive this user's tweets by SMS. */
profile_background_color : string /** The hexadecimal color chosen by the user for their background. */
profile_background_image_url : string /** A HTTP-based URL pointing to the background image the user has uploaded for their profile. */
profile_background_image_url_https : string /** A HTTPS-based URL pointing to the background image the user has uploaded for their profile. */
profile_background_tile : bool /** When true, indicates that the user's profile_background_image_url should be tiled when displayed. */
profile_banner_url : string /** The HTTPS-based URL pointing to the standard web representation of the user's uploaded profile banner. */
profile_image_url : string /** A HTTP-based URL pointing to the user's avatar image. */
profile_image_url_https : string /** A HTTPS-based URL pointing to the user's avatar image. */
profile_link_color : string /** The hexadecimal color the user has chosen to display links with in their Twitter UI. */
profile_sidebar_border_color : string /** The hexadecimal color the user has chosen to display sidebar borders with in their Twitter UI. */
profile_sidebar_fill_color : string /** The hexadecimal color the user has chosen to display sidebar backgrounds with in their Twitter UI. */
profile_text_color : string /** The hexadecimal color the user has chosen to display text with in their Twitter UI. */
profile_use_background_image : bool /** When true, indicates the user wants their uploaded background image to be used. */
protected : bool /** When true, indicates that this user has chosen to protect their Tweets. */
screen_name : string /** The screen name, handle, or alias that this user identifies themselves with. */
show_all_inline_media : bool /** Indicates that the user would like to see media inline. Somewhat disused. */
status : RPC.Json.json /** Nullable. If possible, the user's most recent tweet or retweet. */
statuses_count : int /** The number of tweets (including retweets) issued by the user. */
time_zone : string /** Nullable. A string describing the Time Zone this user declares themselves within. */
url : string /** Nullable. A URL provided by the user in association with their profile. */
utc_offset : int /** Nullable. The offset from GMT/UTC in seconds. */
verified : bool /** When true, indicates that the user has a verified account. */
withheld_in_countries : string /** When present, indicates a textual representation of the two-letter country codes this user is withheld from. */
withheld_scope : string /** When present, indicates whether the content being withheld is the "status" or a "user." */
}
type Twitter.slug = {
name : string
slug : string
size : int
users : list(Twitter.full_user)
}
type Twitter.search_metadata = {
completed_in : float
max_id : string
next_results : string
query : string
refresh_url : string
count : int
since_id : string
}
type Twitter.search_result = {
statuses : list(Twitter.tweet)
search_metadata : Twitter.search_metadata
}
type Twitter.user_mention = {
name : string
screen_name : string
indices : list(int)
id : string
}
type Twitter.coordinates = { // TODO: representation of geoJSON objects
coordinates : RPC.Json.json
`type` : string
}
type Twitter.id = {
id : string
}
type Twitter.idsn = {
id : string
screen_name : string
}
type Twitter.tweet = {
//annotations : unknown /** Unused. Future/beta home for status annotations. */
contributors : list(Twitter.idsn) /** Nullable. An collection of brief user objects (usually only one) indicating users who contributed to the authorship of the tweet, on behalf of the official tweet author. */
coordinates : Twitter.coordinates /** Nullable. Represents the geographic location of this Tweet as reported by the user or client application. */
created_at : string /** UTC time when this Tweet was created. */
current_user_retweet : Twitter.id /** Perspectival. Only surfaces on methods supporting the include_my_retweet parameter, when set to true. */
entities : Twitter.entities /** Entities which have been parsed out of the text of the Tweet. */
favorited : bool /** Nullable. Perspectival. Indicates whether this Tweet has been favorited by the authenticating user. */
//geo : Twitter.coordinates /** Deprecated. Nullable. Use the "coordinates" field instead. */
id : string /** The integer representation of the unique identifier for this Tweet. (64-bit int) */
in_reply_to_screen_name : string /** Nullable. If the represented Tweet is a reply, this field will contain the screen name of the original Tweet's author. */
in_reply_to_status_id : string /** Nullable. If the represented Tweet is a reply, this field will contain the integer representation of the original Tweet's ID. */
in_reply_to_user_id : string /** Nullable. If the represented Tweet is a reply, this field will contain the integer representation of the original Tweet's author ID. */
place : Twitter.place /** Nullable. When present, indicates that the tweet is associated (but not necessarily originating from) a Place. */
possibly_sensitive : bool /** Nullable. This field only surfaces when a tweet contains a link. */
scopes : RPC.Json.json /** A set of key-value pairs indicating the intended contextual delivery of the containing Tweet. */
retweet_count : int /** Number of times this Tweet has been retweeted. */
retweeted : bool /** Perspectival. Indicates whether this Tweet has been retweeted by the authenticating user. */
source : string /** Utility used to post the Tweet, as an HTML-formatted string. */
text : string /** The actual UTF-8 text of the status update. */
truncated : bool /** Indicates whether the value of the text parameter was truncated, for example, as a result of a retweet exceeding the 140 character Tweet length. */
user : Twitter.full_user /** The user who posted this Tweet. */
withheld_copyright : bool /** When present and set to "true", it indicates that this piece of content has been withheld due to a DMCA complaint. */
withheld_in_countries : string /** When present, indicates a textual representation of the two-letter country codes this content is withheld from. */
withheld_scope : string /** When present, indicates whether the content being withheld is the "status" or a "user." */
}
type Twitter.message_result = {
entities : Twitter.entities
sender_screen_name : string
id : string
created_at : string
recipient : Twitter.full_user
sender : Twitter.full_user
recipient_screen_name : string
recipient_id : int
sender_id : int
text : string
}
type Twitter.connection = {following} / {following_requested} / {followed_by} / {none}
type Twitter.friendship = {
name : string
id : string
connections : list(Twitter.connection)
screen_name : string
}
type Twitter.relation = {
id : string
screen_name : string
following : bool
followed_by : bool
can_dm : bool
blocking : bool
all_replies : bool
want_retweets : bool
marked_spam : bool
notifications_enabled : bool
}
type Twitter.relationship = {
target : Twitter.relation
source : Twitter.relation
}
type Twitter.rate_limit_context = {
access_token : string
}
type Twitter.resource_elt = {
remaining : int
reset : int
limit : int
}
type Twitter.resource = list((string, Twitter.resource_elt))
type Twitter.resources = {
rate_limit_context : Twitter.rate_limit_context
resources : list((string, Twitter.resource))
}
type Twitter.list = {
created_at : string
slug : string
name : string
full_name : string
description : string
mode : string
following : bool
user : Twitter.full_user
member_count : int
subscriber_count : int
id : string
uri : string
}
type Twitter.saved_search = {
created_at : string
id : string
name : string
position : string
query : string
}
type Twitter.size = {
h : int
w : int
resize : string
}
type Twitter.config = {
characters_reserved_per_media : int
max_media_per_upload : int
non_username_paths : list(string)
photo_size_limit : int
photo_sizes : {
large : Twitter.size
medium : Twitter.size
small : Twitter.size
thumb : Twitter.size
}
short_url_length : int
short_url_length_https : int
}
type Twitter.lang = {
code : string
name : string
status : string
}
/**
* @author Nicolas Glondu, March 2010
* @category Twitter ?
* @category External API ?
* @destination private
* @stability Quite stable
*/
/**
* {1 About this module}
*
* This module contains the core functions of the Twitter API.
*
* {1 Where should I start?}
*
* First are the treatment functions. Those functions are mainly json parsers
* returning Twitter objects from json. Then come the download functions, some
* constants specific to Twitter and some intermediate functions.
*
* {1 What if I need more?}
*
* If you want to add a method, you should first identify the type of its response,
* if it does not exist, you should add it. Then create a json parser for it.
* Once done, add a function to the Twitter module to access your work once
* OPA has been compiled.
*/
@private TwitParse = {{
/* ------------------- */
/* Treatment functions */
/* ------------------- */
@private _check_date_parser = parser
| ([0-9][0-9][0-9][0-9]) "-" month=([0-9][0-9]) "-" day=([0-9][0-9]) ->
month = Int.of_string(Text.to_string(month))
day = Int.of_string(Text.to_string(day))
day > 0 && day < 32 && month > 0 && month < 13
| .* -> false
@private _check_date(date:string) = Parser.try_parse(_check_date_parser, date) ? false
@private get_json_int(json) = match json with | {Int=i} -> i | _ -> -1
@private get_json_string(json) = match json with | {String=s} -> s | _ -> ""
@private get_unknown(name, map) = Map.get(name, map) ? {String = "missing unknown type" }
@private get_int = API_libs_private.map_get_int
@private get_float = API_libs_private.map_get_float
@private get_string = API_libs_private.map_get_string
@private get_bool = API_libs_private.map_get_bool
@private get_date(name, map) = Json.to_string(Map.get(name, map) ? {String = "Error in date" })
@private get_raw_obj(json, get_elt) = get_elt(json)
@private get_obj(name, map, get_elt) = get_raw_obj((Map.get(name, map)) ? {Record=[]}, get_elt)
@private get_raw_list(json, get_elt) =
match json with
| {List=_} -> List.map(get_elt, JsonOpa.to_list(json) ? [])
| _ -> []
@private get_list(name, map, get_elt) = get_raw_list(Map.get(name, map) ? {List=[]}, get_elt)
get_error_elt(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{ code = get_int("code", map);
message = get_string("message", map)
} : Twitter.error
_check_errors(s, on_ok) =
json = API_libs_private.parse_json(s)
match json with
| {Record=r} ->
match List.assoc("errors",r) with
| {some={String=message}} -> {failure={twitter=[{code=-1 ~message}]}}
| {some=errs} -> {failure={twitter=get_raw_list(errs, get_error_elt)}}
| {none} -> {success=on_ok(json)}
end
| _ -> {success=on_ok(json)}
_check_paged(json, on_paged, on_unpaged) : Twitter.might_be_paged('a) =
match json with
| {Record=r} ->
match (List.assoc("previous_cursor_str",r),List.assoc("next_cursor_str",r)) with
| ({some={String=previous_cursor}},{some={String=next_cursor}}) ->
~{previous_cursor next_cursor paged=on_paged(json)}
| _ -> {unpaged=on_unpaged(json)}
end
| _ -> {unpaged=on_unpaged(json)}
get_user_mention(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{
name = get_string("name", map)
screen_name = get_string("screen_name", map)
indices = get_list("indices", map, get_json_int)
id = get_string("id_str", map)
} : Twitter.user_mention
get_coordinates(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{
coordinates = get_unknown("coordinates", map) // the type varies: list(int), list(list(list(int))) etc.
`type` = get_string("type", map)
} : Twitter.coordinates
get_place(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{
name = get_string("name", map)
country_code = get_string("country_code", map)
country = get_string("country", map)
attributes = get_unknown("attributes", map)
url = get_string("url", map)
id = get_string("id", map)
bounding_box = get_obj("bounding_box", map, get_coordinates)
full_name = get_string("full_name", map)
place_type = get_string("place_type", map)
geometry = get_unknown("geometry", map)
polylines = get_unknown("polylines", map)
contained_within = get_unknown("contained_within", map)
} : Twitter.place
get_idsn(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{
id = get_string("id_str", map)
screen_name = get_string("screen_name", map)
} : Twitter.idsn
get_id(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{
id = get_string("id_str", map)
} : Twitter.id
get_tweet(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{
contributors = get_list("contributors", map, get_idsn)
coordinates = get_obj("coordinates", map, get_coordinates)
created_at = get_date("created_at", map)
current_user_retweet = get_obj("current_user_retweet", map, get_id)
entities = get_obj("entities", map, get_entities)
favorited = get_bool("favorited", map, false)
id = get_string("id_str", map)
in_reply_to_screen_name = get_string("in_reply_to_screen_name", map)
in_reply_to_status_id = get_string("in_reply_to_status_id_str", map)
in_reply_to_user_id = get_string("in_reply_to_user_id_str", map)
place = get_obj("place", map, get_place)
possibly_sensitive = get_bool("possibly_sensitive", map, false)
scopes = get_unknown("scopes", map)
retweet_count = get_int("retweet_count", map)
retweeted = get_bool("retweeted", map, false)
source = get_string("source", map)
text = get_string("text", map)
truncated = get_bool("truncated", map, false)
user = get_obj("user", map, get_full_user)
withheld_copyright = get_bool("withheld_copyright", map, false)
withheld_in_countries = get_string("withheld_in_countries", map)
withheld_scope = get_string("withheld_scope", map)
} : Twitter.tweet
_build_tweet(s) =
_check_errors(s, get_tweet)
_build_tweets(s) =
_check_errors(s, get_raw_list(_, get_tweet))
get_trend_elt(elt) =
elt = JsonOpa.record_fields(elt) ? Map.empty
{ name = get_string("name", elt);
query = get_string("query", elt);
url = get_string("url", elt);
promoted_content = get_string("promoted_content", elt);
events = get_string("events", elt);
} : Twitter.trend
get_location_elt(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{ name = get_string("name", map);
woeid = get_int("woeid", map)
} : Twitter.location
get_place_type(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{ code = get_int("code", map)
name = get_string("name", map);
} : Twitter.place_type
get_full_location_elt(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{
country = get_string("country", map);
countryCode = get_string("countryCode", map);
name = get_string("name", map);
parentid = get_int("parentid", map)
placeType = get_obj("placeType", map, get_place_type)
url = get_string("url", map);
woeid = get_int("woeid", map)
} : Twitter.full_location
get_trends_elt(json) =
map = JsonOpa.record_fields(json) ? Map.empty
as_of = get_date("as_of", map)
created_at = get_date("created_at", map)
locations = get_list("locations", map, get_location_elt)
trends = get_list("trends", map, get_trend_elt)
~{ as_of; created_at; locations; trends } : Twitter.trends
_build_trend_place_response(s:string) =
_check_errors(s, get_raw_list(_, get_trends_elt))
_build_trend_locations_response(s:string) =
_check_errors(s, get_raw_list(_, get_full_location_elt))
get_metadata(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{
result_type = get_string("result_type", map)
iso_language_code = get_string("iso_language_code", map)
} : Twitter.metadata
get_url(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{
url = get_string("url", map)
expanded_url = get_string("expanded_url", map)
indices = get_list("indices", map, get_json_int)
} : Twitter.url
get_urls(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{
urls = get_list("urls", map, get_url)
} : Twitter.urls
get_hashtag(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{
text = get_string("text", map)
indices = get_list("indices", map, get_json_int)
} : Twitter.hashtag
get_entities(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{
url = get_obj("url", map, get_urls)
description = get_obj("description", map, get_urls)
hashtags = get_list("hashtags", map, get_hashtag)
user_mentions = get_list("user_mentions", map, get_user_mention)
} : Twitter.entities
get_full_user(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{
contributors_enabled = get_bool("contributors_enabled", map, false)
created_at = get_date("created_at", map)
default_profile = get_bool("default_profile", map, false)
default_profile_image = get_bool("default_profile_image", map, false)
description = get_string("description", map)
entities = get_obj("entities", map, get_entities)
favourites_count = get_int("favourites_count", map)
follow_request_sent = get_bool("follow_request_sent", map, false)
followers_count = get_int("followers_count", map)
friends_count = get_int("friends_count", map)
geo_enabled = get_bool("get_bool", map, false)
id = get_string("id_str", map)
is_translator = get_bool("is_translator", map, false)
lang = get_string("lang", map)
listed_count = get_int("listed_count", map)
location = get_string("location", map)
name = get_string("name", map)
profile_background_color = get_string("profile_background_color", map)
profile_background_image_url = get_string("profile_background_image_url", map)
profile_background_image_url_https = get_string("profile_background_image_url_https", map)
profile_background_tile = get_bool("profile_background_tile", map, false)
profile_banner_url = get_string("profile_banner_url", map)
profile_image_url = get_string("profile_image_url", map)
profile_image_url_https = get_string("profile_image_url_https", map)
profile_link_color = get_string("profile_link_color", map)
profile_sidebar_border_color = get_string("profile_sidebar_border_color", map)
profile_sidebar_fill_color = get_string("profile_sidebar_fill_color", map)
profile_text_color = get_string("profile_text_color", map)
profile_use_background_image = get_bool("profile_use_background_image", map, false)
protected = get_bool("protected", map, false)
screen_name = get_string("screen_name", map)
show_all_inline_media = get_bool("show_all_inline_media", map, false)
status = get_unknown("status", map)
statuses_count = get_int("statuses_count", map)
time_zone = get_string("time_zone", map)
url = get_string("url", map)
utc_offset = get_int("utc_offset", map)
verified = get_bool("verified", map, false)
withheld_in_countries = get_string("withheld_in_countries", map)
withheld_scope = get_string("withheld_scope", map)
} : Twitter.full_user
_build_full_user(s) =
_check_errors(s, get_full_user)
_build_full_users(s) =
_check_errors(s, get_raw_list(_, get_full_user))
get_slug(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{
name = get_string("name", map)
slug = get_string("slug", map)
size = get_int("size", map)
users = get_list("users", map, get_full_user)
} : Twitter.slug
_build_slug(s) =
_check_errors(s, get_slug)
_build_slugs(s) =
_check_errors(s, get_raw_list(_, get_slug))
get_search_metadata(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{
completed_in = get_float("completed_in", map)
max_id = get_string("max_id_str", map)
next_results = get_string("next_results", map)
query = get_string("query", map)
refresh_url = get_string("refresh_url", map)
count = get_int("count", map)
since_id = get_string("since_id_str", map)
} : Twitter.search_metadata
_build_search_response(s) =
_check_errors(s, (json ->
map = JsonOpa.record_fields(json) ? Map.empty
{
statuses = get_list("statuses", map, get_tweet)
search_metadata = get_obj("search_metadata", map, get_search_metadata)
} : Twitter.search_result))
get_rate_limit_context(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{
access_token = get_string("access_token", map)
} : Twitter.rate_limit_context
get_resource_elt(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{
remaining = get_int("remaining", map)
reset = get_int("reset", map)
limit = get_int("limit", map)
} : Twitter.resource_elt
get_resource(json) : Twitter.resource =
match json with
| {Record=r} -> List.map(((n, v) -> (n,get_resource_elt(v))), r)
| _ -> []
get_resources(json) : list((string, Twitter.resource)) =
match json with
| {Record=r} -> List.map(((n, v) -> (n,get_resource(v))), r)
| _ -> []
_build_rate_limit(s) =
_check_errors(s, (json ->
map = JsonOpa.record_fields(json) ? Map.empty
{
rate_limit_context = get_obj("rate_limit_context", map, get_rate_limit_context)
resources = get_obj("resources", map, get_resources)
} : Twitter.resources))
get_message_result(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{
entities = get_obj("entities", map, get_entities)
sender_screen_name = get_string("sender_screen_name", map)
id = get_string("id_str", map)
created_at = get_string("created_at", map)
recipient = get_obj("recipient", map, get_full_user)
sender = get_obj("sender", map, get_full_user)
recipient_screen_name = get_string("recipient_screen_name", map)
recipient_id = get_int("recipient_id", map)
sender_id = get_int("sender_id", map)
text = get_string("text", map)
}
_build_message_result(s) =
_check_errors(s, get_message_result)
_build_message_results(s) =
_check_errors(s, get_raw_list(_, get_message_result))
connection_of_string(s) : Twitter.connection =
match s with
| "following" -> {following}
| "following_requested" -> {following_requested}
| "followed_by" -> {followed_by}
| _ -> {none}
string_of_connection(c:Twitter.connection) =
match c with
| {following} -> "following"
| {following_requested} -> "following_requested"
| {followed_by} -> "followed_by"
| {none} -> "none"
get_connection(json) : Twitter.connection =
match json with
| {String=s} -> connection_of_string(s)
| _ -> {none}
get_friendship(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{
name = get_string("name", map)
id = get_string("id_str", map)
connections = get_list("connections", map, get_connection)
screen_name = get_string("screen_name", map)
} : Twitter.friendship
_build_friendship(s) =
_check_errors(s, get_friendship)
_build_friendships(s) =
_check_errors(s, get_raw_list(_, get_friendship))
get_relation(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{
id = get_string("id_str", map)
screen_name = get_string("screen_name", map)
following = get_bool("following", map, false)
followed_by = get_bool("followed_by", map, false)
can_dm = get_bool("can_dm", map, false)
blocking = get_bool("blocking", map, false)
all_replies = get_bool("all_replies", map, false)
want_retweets = get_bool("want_retweets", map, false)
marked_spam = get_bool("marked_spam", map, false)
notifications_enabled = get_bool("notifications_enabled", map, false)
} : Twitter.relation
get_relationship(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{
target = get_obj("target", map, get_relation)
source = get_obj("source", map, get_relation)
} : Twitter.relationship
_build_relationship(s) =
_check_errors(s, (json ->
map = JsonOpa.record_fields(json) ? Map.empty
get_obj("relationship", map, get_relationship)))
get_time_zone(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{
name = get_string("name", map)
tzinfo_name = get_string("tzinfo_name", map)
utc_offset = get_int("utc_offset", map)
}
_build_settings(s) =
_check_errors(s, (json ->
map = JsonOpa.record_fields(json) ? Map.empty
{
always_use_https = get_bool("always_use_https", map, false)
discoverable_by_email = get_bool("discoverable_by_email", map, false)
geo_enabled = get_bool("geo_enabled", map, false)
language = get_string("language", map)
protected = get_bool("protected", map, false)
screen_name = get_string("screen_name", map)
show_all_inline_media = get_bool("show_all_inline_media", map, false)
time_zone = get_obj("time_zone", map, get_time_zone)
trend_location = get_list("trend_location", map, get_full_location_elt)
use_cookie_personalization = get_bool("use_cookie_personalization", map, false)
}))
_build_paged_users(s) : Twitter.outcome(Twitter.might_be_paged(list(Twitter.full_user))) =
_check_errors(s, _check_paged(_,
(json ->
map = JsonOpa.record_fields(json) ? Map.empty
get_list("users", map, get_full_user)),
(json -> get_raw_list(json, get_full_user))))
_build_paged_ids(s) : Twitter.outcome(Twitter.might_be_paged(list(string))) =
_check_errors(s, _check_paged(_,
(json ->
map = JsonOpa.record_fields(json) ? Map.empty
get_list("ids", map, get_json_string)),
(json -> get_raw_list(json, get_json_string))))
_build_paged_lists(s) : Twitter.outcome(Twitter.might_be_paged(list(Twitter.list))) =
_check_errors(s, _check_paged(_,
(json ->
map = JsonOpa.record_fields(json) ? Map.empty
get_list("lists", map, get_twitter_list)),
(json -> get_raw_list(json, get_twitter_list))))
get_twitter_list(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{
created_at = get_string("created_at", map)
slug = get_string("slug", map)
name = get_string("name", map)
full_name = get_string("full_name", map)
description = get_string("description", map)
mode = get_string("mode", map)
following = get_bool("following", map, false)
user = get_obj("user", map, get_full_user)
member_count = get_int("member_count", map)
subscriber_count = get_int("subscriber_count", map)
id = get_string("id_str", map)
uri = get_string("uri", map)
}
_build_list(s) =
_check_errors(s, get_twitter_list)
get_saved_search(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{
created_at = get_string("created_at", map)
id = get_string("id_str", map)
name = get_string("name", map)
position = get_string("position", map)
query = get_string("query", map)
}
_build_saved_search(s) =
_check_errors(s, get_saved_search)
_build_saved_searches(s) =
_check_errors(s, get_raw_list(_, get_saved_search))
_build_place(s) =
_check_errors(s, get_place)
_build_places(s) =
_check_errors(s, get_raw_list(_, get_place))
get_query_result(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{
query = get_unknown("query", map) // Is it worth decoding this?
result = get_obj("result", map, (json ->
map = JsonOpa.record_fields(json) ? Map.empty
{places = get_list("places", map, get_place)}))
}
_build_query_result(s) =
_check_errors(s, get_query_result)
get_size(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{
h = get_int("h", map)
w = get_int("w", map)
resize = get_string("resize", map)
} : Twitter.size
get_sizes(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{
large = get_obj("large", map, get_size)
medium = get_obj("medium", map, get_size)
small = get_obj("small", map, get_size)
thumb = get_obj("thumb", map, get_size)
}
get_config(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{
characters_reserved_per_media = get_int("characters_reserved_per_media", map)
max_media_per_upload = get_int("max_media_per_upload", map)
non_username_paths = get_list("non_username_paths", map, get_json_string)
photo_size_limit = get_int("photo_size_limit", map)
photo_sizes = get_obj("photo_sizes", map, get_sizes)
short_url_length = get_int("short_url_length", map)
short_url_length_https = get_int("short_url_length_https", map)
} : Twitter.config
_build_config(s) =
_check_errors(s, get_config)
get_lang(json) =
map = JsonOpa.record_fields(json) ? Map.empty
{
code = get_string("code", map)
name = get_string("name", map)
status = get_string("status", map)
} : Twitter.lang
_build_langs(s) =
_check_errors(s, get_raw_list(_, get_lang))
_simple_decoder(data) =
decode_data =
[ ("\\u00e9", "é"), ("\\u00e8", "è"), ("\\u00e0", "à"),
("\\u00c9", "É"), ("\\u00c8", "È"), ("\\u00c0", "À"),
("\\u00ea", "ê"), ("\\u00ca", "Ê"), ("\\u00ef", "ï"),
("\\u00cf", "Ï"), ("\\u00f4", "ô"), ("\\u00e7", "ç"),
("\\u00c7", "Ç"), ("\\u00f9", "ù"), ("\\u00d9", "Ù"),
("\\u20ac", "€"), ("\\u00a0", " "), ("\\u00ee", "î") ]
aux((from, to), acc) = String.replace(from, to, acc)
List.fold(aux, decode_data, data)
}}
@private Twitter_private(conf:Twitter.configuration) = {{
/* ----------------------- */
/* Twitter-specific values */
/* ----------------------- */
_api_host = "https://api.twitter.com"
/* ------------------ */
/* Download functions */
/* ------------------ */
twOAuth(http_method) = OAuth({
consumer_key = conf.consumer_key
consumer_secret = conf.consumer_secret
auth_method = {HMAC_SHA1}
request_token_uri = "https://api.twitter.com/oauth/request_token"
authorize_uri = "https://api.twitter.com/oauth/authorize"
access_token_uri = "https://api.twitter.com/oauth/access_token"
http_method = http_method
inlined_auth = false
custom_headers = []
} : OAuth.parameters)
_wget_generic(path:string, wget_fun, parse_fun) =
do API_libs_private.apijlog("-- Fetching {_api_host} - {path} \n data --")
//do jlog("_wget_generic: path={path}")
(t, res) = Duration.execution_time( -> wget_fun("{_api_host}{path}"))
match res with
| {success=res} ->
//do jlog("_wget_generic: got={res}")
do API_libs_private.apijlog("Download: {Duration.in_seconds(t)} seconds")
(t, res) = Duration.execution_time( -> parse_fun(res.content))
//do jlog("_wget_generic: parsed={res}")
do API_libs_private.apijlog("Parsing: {Duration.in_seconds(t)} seconds")
res
| {failure=f} ->
//do jlog("_wget_generic: Network failure {f}")
{failure={network=f}}
_get_res(path, params, credentials:Twitter.credentials, parse_fun) =
f(uri) =
twOAuth({GET}).get_protected_resource_2(uri,params,
credentials.access_token,credentials.access_secret);
_wget_generic(path, f, parse_fun)
_post_res(path, params, credentials:Twitter.credentials, parse_fun) =
f(uri) =
twOAuth({POST}).get_protected_resource_2(uri,params,
credentials.access_token,credentials.access_secret)
_wget_generic(path, f, parse_fun)
}}
/**
* @author Nicolas Glondu, March 2010
* @category Twitter ?
* @category External API ?
* @destination public
* @stability Quite stable
*/
/**
* {1 About this module}
*
* This module contains the implemented methods for the Twitter API. Quite few aspects
* of the social aspect of Twitter are implemented. The focus is made on the statuses.
* A drawback of this is that not all methods are implemented, but the advantage is that
* the implemented methods return formatted results easier to use.
*
* Information about Twitter API can be found here: https://dev.twitter.com/docs
*
* {1 Where should I start?}
*
* This implementation was made to be as simple as possible. Simply call the required
* method and it will return the object indicated in its documentation. You only have
* to display (or not) the result as you wish.
*
* If you have already worked with the Facebook Opa API, the mechanism used here
* is the same.
*
* Note: From the Twitter API 1.1 onwards, all endpoints are authenticated so you
* need a Twitter account to access any of these functions.
*
* {1 What if I need more?}
*
* If you want to make a call not implemented, you should use custom_get_request or
* custom_post_request and build your request and the parser for its answer
* yourself. Consult https://dev.twitter.com/docs/api/1.1 for a
* list of available methods.
*
* An example of path: /1.1/trends/44418.json (returns the trends in London)
*/
Twitter(conf:Twitter.configuration) = {{
@private c = conf
@private add_if(key, elt, cond) = list ->
if cond(elt)
then List.cons((key, "{elt}"), list)
else list
@private add_opt(key, elt, tos) = list ->
if Option.is_some(elt)
then List.cons((key, tos(Option.get(elt))), list)
else list
@private add_sopt(key, elt) = add_opt(key, elt, (s->s))
@private add_iopt(key, elt) = add_opt(key, elt, Int.to_string)
@private add_bopt(key, elt) = add_opt(key, elt, Bool.to_string)
@private add_fopt(key, elt) = add_opt(key, elt, Float.to_string)
@private add_user(user, list) =
List.cons((match user with
| ~{user_id} -> ("user_id", user_id)
| ~{screen_name} -> ("screen_name", screen_name)), list)
oauth_params(mode:Twitter.oauth_mode) = {
consumer_key = conf.consumer_key
consumer_secret = conf.consumer_secret
auth_method = {HMAC_SHA1}
request_token_uri = "https://api.twitter.com/oauth/request_token"
authorize_uri =
match mode with
| {fast} -> "https://api.twitter.com/oauth/authenticate"
| {full} -> "https://api.twitter.com/oauth/authorize"
access_token_uri = "https://api.twitter.com/oauth/access_token"
http_method = {POST}
inlined_auth = false
custom_headers = []
} : OAuth.parameters
// Custom requests
/**
* Custom GET request (advanced)
*
* Allows the user to do a custom GET request on Twitter.
* Returns the API_libs.answer resulting to final_fun applyed to the
* raw result from Twitter as a string.
*
* @param path Path corrsponding to request built according to the Twitter's API
* @param params (optional) Parameters as a (key, value) list if required
* @param credentials User credentials.
* @param final_fun A parser function for the raw reply.
*/
custom_get_request(path, params, credentials, final_fun) =
Twitter_private(c)._get_res(path, params, credentials, final_fun)
/**
* Custom POST request (advanced)
*
* Allows the user to do a custom POST request on Twitter.
* Returns the API_libs.answer resulting to final_fun applied to the
* raw result from Twitter as a string.
*
* @param path Path corrsponding to request built according to the Twitter's API
* @param params (optional) Parameters as a (key, value) list if required
* @param credentials User credentials.
* @param final_fun A parser function for the raw reply.
*/
custom_post_request(path, params, credentials, final_fun) =
Twitter_private(c)._post_res(path, params, credentials, final_fun)
default_search = {
geocode = ""
lang = ""
locale = ""
result_type = none
count = 0
until = none
since_id = ""
max_id = ""
include_entities = none
callback = ""
} : Twitter.search_options
// Search
/**
* Search request : http://search.twitter.com/search.json[?q=<search request>&params]
*
* Makes a Twitter search of given request.
* Returns a Twitter.outcome of a Twitter.search_result object
*
* @param request The request (will be url encoded)
* @param options
*/
@private string_of_result_type(rt) =
match rt with
| {mixed} -> "mixed"
| {recent} -> "recent"
| {popular} -> "popular"
@private yyyymmdd_of_date =
printer = Date.generate_printer("%F")
d -> Date.to_formatted_string(printer,d)
search(request, options:Twitter.search_options, credentials) : Twitter.outcome(Twitter.search_result) =
path = "/1.1/search/tweets.json"
//do jlog("yyyymmdd={yyyymmdd_of_date(Date.now())}")
params =
[("q", request)]
|> add_if("geocode", options.geocode, (_!=""))
|> add_if("lang", options.lang, (_!=""))
|> add_if("locale", options.locale, (_!=""))
|> add_opt("result_type", options.result_type, string_of_result_type)
|> add_if("count", options.count, (_!=0))
|> add_opt("until", options.until, yyyymmdd_of_date)
|> add_if("since_id", options.since_id, (_!=""))
|> add_if("max_id", options.max_id, (_!=""))
|> add_bopt("include_entities", options.include_entities)
|> add_if("callback", options.callback, (_!=""))
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_search_response)
// Trends
/**
* trends/place
*
* (The trends on Twitter are the words mostly used in messages during a given period.)
* This function returns trends/place where id is a WOEID.
* Returns a Twitter.trends outcome.
*
* @param id The place WOEID (eg. France = 23424819)
* @param exclude Indicates whether or not hashtags (#abcd) should be excluded from the trends result
* @param credentials Valid access credentials
*/
get_trends_place(id:string, exclude:bool, credentials) : Twitter.outcome(list(Twitter.trends)) =
path = "/1.1/trends/place.json"
params =
[("id",id)]
|> add_if("exclude", "hashtags", (_ -> exclude))
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_trend_place_response)
@private _get_trends_locations(trends_type, params, credentials) : Twitter.outcome(list(Twitter.full_location)) =
path = "/1.1/trends/{trends_type}.json"
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_trend_locations_response)
/**
* trends/available
*
* (The trends on Twitter are the words mostly used in messages during a given period.)
* This function returns a list of locations for which trends are available.
* Returns an outcome of a list of Twitter.full_location objects.
*
* @param credentials Valid access credentials
*/
get_trends_available(credentials) =
_get_trends_locations("available", [], credentials)
/**
* trends/closest
*
* (The trends on Twitter are the words mostly used in messages during a given period.)
* This function returns a list of locations which are closest to the given latitude and longitude.
* Returns an outcome of a list of Twitter.full_location objects.
*
* @param lat Optional latitude value
* @param long Optional longitude value
* @param credentials Valid access credentials
*/
get_trends_closest(lat:option(float), long:option(float), credentials) =
params =
[]
|> add_fopt("lat",lat)
|> add_fopt("long",long)
_get_trends_locations("closest", params, credentials)
default_timeline = {
count = 0
since_id = ""
max_id = ""
trim_user = none
exclude_replies = none
contributor_details = none
include_entities = none
include_rts = none
} : Twitter.timeline_options
// Timelines
_get_generic_timeline(path, p:Twitter.timeline_options, more, credentials) =
params = more
|> add_if("count", p.count, (_>0))
|> add_if("since_id", p.since_id, (_!=""))
|> add_if("max_id", p.max_id, (_!=""))
|> add_bopt("trim_user", p.trim_user)
|> add_bopt("exclude_replies", p.exclude_replies)
|> add_bopt("contributor_details", p.contributor_details)
|> add_bopt("include_entities", p.include_entities)
|> add_bopt("include_rts", p.include_rts)
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_tweets)
/**
* Mentions timeline
*
* Returns the 20 most recent mentions (tweets containing a users's @screen_name) for the authenticating user.
* Returns a Twitter.outcome of a list of Twitter.tweet objects.
*
*/
get_mentions_timeline(params, credentials) =
path = "/1.1/statuses/mentions_timeline.json"
_get_generic_timeline(path, params, [], credentials)
/**
* Home timeline
*
* Returns the most recent status updates of current user and of his friends.
* Will display the same tweets than those displayed in the user's homepage.
* Returns a list of Twitter.tweet objects.
*
* @param params Options of the request [Twitter.timeline_options]
* @param credentials The user credentials
*/
get_home_timeline(params, credentials) =
path = "/1.1/statuses/home_timeline.json"
_get_generic_timeline(path, params, [], credentials)
/**
* User timeline
*
* This function returns the most recent status updates of specified user. Will display the same
* tweets than those displayed in the user's profile. Required authentication if the
* requested user is protected. There should only be one or none among id, uid and
* screen name. If none, requires authentification and returning the user timeline of
* current user.
* Returns a list of Twitter.tweet objects.
*
* @param user The screen name or the unique id of the requested user.
* @param options Common options of the request [Twitter.timeline_options]
* @param credentials The user credentials
*/
get_user_timeline(user:Twitter.user, options, credentials) =
path = "/1.1/statuses/user_timeline.json"
more = add_user(user, [])
_get_generic_timeline(path, options, more, credentials)
// Direct messages
default_direct_messages = {
since_id = ""
max_id = ""
count = 20
page = 0
include_entities = none
skip_status = none
} : Twitter.direct_messages_options
/**
* Get a single direct message
*
* @param id The ID of the direct message.
*/
direct_message(id:string, credentials) =
path = "/1.1/direct_messages/show.json"
params = [("id",id)]
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_message_result)
/**
* Get the most recent direct messsages.
*
* This function returns the messages received by the authenticated user.
*
* @param options The command options.
*/
direct_messages(options:Twitter.direct_messages_options, credentials) =
path = "/1.1/direct_messages.json"
params =
[]
|> add_if("since_id", options.since_id, (_!=""))
|> add_if("max_id", options.max_id, (_!=""))
|> add_if("count", options.count, (_>0))
|> add_if("page", options.page, (_>0))
|> add_bopt("include_entities", options.include_entities)
|> add_bopt("skip_status", options.skip_status)
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_message_results)
/**
* Get the most recent direct messsages sent.
*
* This function returns the messages sent by the authenticated user.
*
* @param options The command options.
*/
sent_direct_messages(options:Twitter.direct_messages_options, credentials) =
path = "/1.1/direct_messages/sent.json"
params =
[]
|> add_if("since_id", options.since_id, (_!=""))
|> add_if("max_id", options.max_id, (_!=""))
|> add_if("count", options.count, (_>0))
|> add_if("page", options.page, (_>0))
|> add_bopt("include_entities", options.include_entities)
|> add_bopt("skip_status", options.skip_status)
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_message_results)
/**
* Send a direct message
*
* This function sends a direct message to a user from the authenticated user.
*
* @param user The recipient of the message.
* @param text The text of your direct message. Keep the message under 140 characters.
*/
send_direct_message(user:Twitter.user, message, credentials) =
path = "/1.1/direct_messages/new.json"
params =
add_user(user, [])
|> List.cons(("text",message),_)
Twitter_private(c)._post_res(path, params, credentials, TwitParse._build_message_result)
/**
* Delete a direct message
*
* This function deletes the direct message with the given ID.
* Returns the deleted message, if successful.
*
* @param id The ID of the message.
* @param include_entities The entities node will not be included when set to false.
*/
delete_direct_message(id:string, include_entities:option(bool), credentials) =
path = "/1.1/direct_messages/destroy.json"
params =
[("id",id)]
|> add_bopt("include_entities", include_entities)
Twitter_private(c)._post_res(path, params, credentials, TwitParse._build_message_result)
// Friendships
@private _get_generic_socgraph(user, cursor, graphtype:string, credentials) =
path = "/1.1/{graphtype}/ids.json"
params =
add_user(user, [])
|> add_if("cursor", cursor, (_!=""))
|> List.cons(("stringify_ids","true"),_) // essential
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_paged_ids)
/**
* Get friends
*
* This function returns a list of the friends (=the peoples the user follows) of
* given user. Requires authentication if this user is protected.
* Returns a Twitter.paged_ids object.
*
* @param user The user id or screen name of the requested user.
* @param cursor Creates page to navigate among the friends. Useful for users with a lot of friends. Starts with -1.
* @param credentials The user credentials.
*/
get_friends(user, cursor, credentials) =
_get_generic_socgraph(user, cursor, "friends", credentials)
/**
* Get followers
*
* This function returns a list of the followers of given user. Requires
* authentication if this user is protected.
* Returns a Twitter.paged_ids object.
*
* @param user The user id or screen name of the requested user.
* @param cursor Creates page to navigate among the friends. Useful for users with a lot of friends. Starts with -1.
* @param credentials The user credentials.
*/
get_followers(user, cursor, credentials) =
_get_generic_socgraph(user, cursor, "followers", credentials)
/**
* Lookup friendships.
*
* Returns the relationships of the authenticating user to the comma-separated list of up to 100 screen_names or user_ids provided.
*
* @param user The user id or screen name of the requested user.
* @param credentials The user credentials.
*/
connection_of_string = TwitParse.connection_of_string
string_of_connection = TwitParse.string_of_connection
friendships_lookup(user, credentials) =
params = add_user(user, [])
Twitter_private(c)._get_res("/1.1/friendships/lookup.json", params, credentials, TwitParse._build_friendships)
/**
* Incoming friendships.
*
* Returns a collection of numeric IDs for every user who has a pending request to follow the authenticating user.
*
* @param cursor Creates page to navigate among the friends. Useful for users with a lot of friends. Starts with -1.
* @param credentials The user credentials.
*/
friendships_incoming(cursor, credentials) =
params =
[]
|> add_if("cursor", cursor, (_!=""))
|> List.cons(("stringify_ids","true"),_) // essential
Twitter_private(c)._get_res("/1.1/friendships/incoming.json", params, credentials, TwitParse._build_paged_ids)
/**
* Outgoing friendships.
*
* Returns a collection of numeric IDs for every protected user for whom the authenticating user has a pending follow request.
*
* @param cursor Creates page to navigate among the friends. Useful for users with a lot of friends. Starts with -1.
* @param credentials The user credentials.
*/
friendships_outgoing(cursor, credentials) =
params =
[]
|> add_if("cursor", cursor, (_!=""))
|> List.cons(("stringify_ids","true"),_) // essential
Twitter_private(c)._get_res("/1.1/friendships/outgoing.json", params, credentials, TwitParse._build_paged_ids)
/**
* Show friendship.
*
* Returns detailed information about the relationship between two arbitrary users.
*
* @param source The user id or screen name of the source user.
* @param target The user id or screen name of the target user.
* @param credentials The user credentials.
*/
friendship_show(source, target, credentials) =
params =
[(match source with
| {~user_id} -> ("source_id", user_id)
| {~screen_name} -> ("source_screen_name", screen_name)),
(match target with
| {~user_id} -> ("target_id", user_id)
| {~screen_name} -> ("target_screen_name", screen_name))]
Twitter_private(c)._get_res("/1.1/friendships/show.json", params, credentials, TwitParse._build_relationship)
/**
* Create friendship.
*
* Allows the authenticating users to follow the user specified in the ID parameter.
*
* @param user The user id or screen name of the requested user.
* @param credentials The user credentials.
*/
friendship_create(user, follow, credentials) =
params =
add_user(user, [])
|> add_bopt("follow", follow)
Twitter_private(c)._post_res("/1.1/friendships/create.json", params, credentials, TwitParse._build_full_user)
/**
* Destroy friendship.
*
* Allows the authenticating user to unfollow the user specified in the ID parameter.
*
* @param user The user id or screen name of the requested user.
* @param credentials The user credentials.
*/
friendship_destroy(user, credentials) =
params = add_user(user, [])
Twitter_private(c)._post_res("/1.1/friendships/destroy.json", params, credentials, TwitParse._build_full_user)
/**
* Update friendship.
*
* Allows one to enable or disable retweets and device notifications from the specified user.
*
* @param user The user id or screen name of the requested user.
* @param credentials The user credentials.
*/
friendship_update(user, device:option(bool), retweets:option(bool), credentials) =
params =
add_user(user, [])
|> add_bopt("device", device)
|> add_bopt("retweets", retweets)
Twitter_private(c)._post_res("/1.1/friendships/update.json", params, credentials, TwitParse._build_relationship)
// Rate limits
/**
* Get rate_limit_status
*
* Returns the current rate limits for methods belonging to the specified resource families.
*
* @param resources List of resource families.
* @param credentials The user credentials.
*/
get_rate_limit_status(resources, credentials) =
params =
match resources with
| [] -> []
| _ -> [("resources", String.concat(",",resources))]
Twitter_private(c)._get_res("/1.1/application/rate_limit_status.json", params, credentials, TwitParse._build_rate_limit)
default_update = {
in_reply_to_status_id = ""
lat = none
long = none
place_id = ""
display_coordinates = none
trim_user = none
} : Twitter.update_options
// Statuses
default_statuses = {
count = 0
trim_user = none
include_my_retweet = none
include_entities = none
} : Twitter.statuses_options
/**
* Get specific message
*
* This function returns the message having the specified id.
* Returns a Twitter.tweet object.
*
* @param id The id of the requested message.
* @param credentials The user credentials
*/
get_specific_message(id:string, options:Twitter.statuses_options, credentials) =
path = "/1.1/statuses/show.json"
params =
[("id",id)]
|> add_bopt("trim_user", options.trim_user)
|> add_bopt("include_my_retweet", options.include_my_retweet)
|> add_bopt("include_entities", options.include_entities)
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_tweet)
/**
* Get retweets of a message
*
* Returns up to 100 of the first retweets of a given tweet.
* Returns a Twitter.retweet object.
*
* @param id The id of the requested message.
* @param options The command options (count, trim_user).
* @param credentials The user credentials.
* @returns List of retweets.
*/
get_message_retweets(id:string, options:Twitter.statuses_options, credentials) =
path = "/1.1/statuses/retweets/{id}.json"
params =
[("id",id)]
|> add_if("count", options.count, (_>0))
|> add_bopt("trim_user", options.trim_user)
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_tweets)
/**
* Post status
*
* This function updates the status of the authenticated user.
* Returns a Twitter.tweet object corresponding to the created status.
*
* @param message The text of the status update.
* @param options Optional arguments for the update.
* @param credentials The user credentials.
*/
post_status(message, options:Twitter.update_options, credentials) =
path = "/1.1/statuses/update.json"
params =
[("status",message)]
|> add_if("in_reply_to_status_id", options.in_reply_to_status_id, (_!=""))
|> add_fopt("lat", options.lat)
|> add_fopt("long", options.long)
|> add_if("place_id", options.place_id, (_!=""))
|> add_bopt("display_coordinates", options.display_coordinates)
|> add_bopt("trim_user", options.trim_user)
Twitter_private(c)._post_res(path, params, credentials, TwitParse._build_tweet)
/**
* Post retweet status
*
* Retweets a tweet.
* Returns the original tweet with retweet details embedded.
*
* @param id The numerical ID of the desired status.
* @param trim_user When set to either true, t or 1, each tweet returned in a timeline will include a user object including only the status authors numerical ID.
* @param credentials The user credentials.
*/
retweet_status(id:string, trim_user:option(bool), credentials) =
path = "/1.1/statuses/retweet/{id}.json"
params =
[]
|> add_bopt("trim_user", trim_user)
Twitter_private(c)._post_res(path, params, credentials, TwitParse._build_tweet)
/**
* Delete status
*
* This function deletes the status with given if posted by the authenticated user.
* Returns a Twitter.tweet object corresponding to the deleted status.
*
* @param id The ID of the status to delete.
* @param trim_user When set to either true, t or 1, each tweet returned in a timeline will include a user object including only the status authors numerical ID.
* @param credentials The user credentials.
*/
delete_status(id:string, trim_user:option(bool), credentials) =
path = "/1.1/statuses/destroy/{id}.json"
params =
[]
|> add_bopt("trim_user", trim_user)
Twitter_private(c)._post_res(path, params, credentials, TwitParse._build_tweet)
// TODO: (unlikely) streaming API
// Users
/**
* Account settings
*
* Returns settings (including current trend, geo and sleep time information) for the authenticating user.
*
* @param credentials The user credentials.
*/
account_settings(credentials) =
path = "/1.1/account/settings.json"
Twitter_private(c)._get_res(path, [], credentials, TwitParse._build_settings)
/**
* Check credentials
*
* This function checks if provided credentials are correct.
* Returns a Twitter.full_user object corresponding to the last status of the user if the credentials are correct. If incorrect, returns an empty Twitter.full_user object.
*
* @param include_entities The entities node will not be included when set to false.
* @param skip_status When set to either true, t or 1 statuses will not be included in the returned user objects.
* @param credentials The user credentials.
*/
verify_credentials(include_entities:option(bool), skip_status:option(bool), credentials) =
path = "/1.1/account/verify_credentials.json"
params =
[]
|> add_bopt("include_entities", include_entities)
|> add_bopt("skip_status", skip_status)
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_full_user)
default_settings = {
trend_location_woeid = none
sleep_time_enabled = none
start_sleep_time = none
end_sleep_time = none
time_zone = ""
lang = ""
} : Twitter.settings_options
/**
* Update account settings
*
* Updates the authenticating user's settings.
*
* @param credentials The user credentials.
*/
update_account_settings(options:Twitter.settings_options, credentials) =
path = "/1.1/account/settings.json"
params =
[]
|> add_iopt("trend_location_woeid", options.trend_location_woeid)
|> add_bopt("sleep_time_enabled", options.sleep_time_enabled)
|> add_iopt("start_sleep_time", options.start_sleep_time)
|> add_iopt("end_sleep_time", options.end_sleep_time)
|> add_if("time_zone", options.time_zone, (_!=""))
|> add_if("lang", options.lang, (_!=""))
Twitter_private(c)._post_res(path, params, credentials, TwitParse._build_settings)
default_profile = {
name = ""
url = ""
location = ""
description = ""
include_entities = none
skip_status = none
}
/**
* Update account profile
*
* Sets values that users are able to set under the "Account" tab of their settings page.
*
* @param options The options for the command
* @param credentials The user credentials.
*/
update_account_profile(options, credentials) =
path = "/1.1/account/update_profile.json"
params =
[]
|> add_if("name", options.name, (_!=""))
|> add_if("url", options.url, (_!=""))
|> add_if("location", options.location, (_!=""))
|> add_if("description", options.description, (_!=""))
|> add_bopt("include_entities", options.include_entities)
|> add_bopt("skip_status", options.skip_status)
Twitter_private(c)._post_res(path, params, credentials, TwitParse._build_full_user)
default_profile_background_image = {
image = ""
tile = none
include_entities = none
skip_status = none
use = none
}
/**
* Update account profile background image.
*
* Updates the authenticating user's profile background image.
*
* @param options The options for the command
* @param credentials The user credentials.
*/
update_account_profile_background_image(options, credentials) =
path = "/1.1/account/update_profile_background_image.json"
params =
[]
|> add_if("image", options.image, (_!=""))
|> add_bopt("tile", options.tile)
|> add_bopt("include_entities", options.include_entities)
|> add_bopt("skip_status", options.skip_status)
|> add_bopt("use", options.use)
Twitter_private(c)._post_res(path, params, credentials, TwitParse._build_full_user)
default_profile_colors = {
profile_background_color = ""
profile_link_color = ""
profile_sidebar_border_color = ""
profile_sidebar_fill_color = ""
profile_text_color = ""
include_entities = none
skip_status = none
}
/**
* Update account profile colors.
*
* Sets one or more hex values that control the color scheme of the authenticating user's profile page on twitter.com.
*
* @param options The options for the command
* @param credentials The user credentials.
*/
update_account_profile_colors(options, credentials) =
path = "/1.1/account/update_profile_colors.json"
params =
[]
|> add_if("profile_background_color", options.profile_background_color, (_!=""))
|> add_if("profile_link_color", options.profile_link_color, (_!=""))
|> add_if("profile_sidebar_border_color", options.profile_sidebar_border_color, (_!=""))
|> add_if("profile_sidebar_fill_color", options.profile_sidebar_fill_color, (_!=""))
|> add_if("profile_text_color", options.profile_text_color, (_!=""))
|> add_bopt("include_entities", options.include_entities)
|> add_bopt("skip_status", options.skip_status)
Twitter_private(c)._post_res(path, params, credentials, TwitParse._build_full_user)
// default_profile_image = {
// filename = ""
// content_type = ""
// source = ""
// include_entities = none
// skip_status = none
// }
// Needs multipart added to oauth
/**
* Update account profile image.
*
* Updates the authenticating user's profile image.
*
* @param options The options for the command
* @param credentials The user credentials.
*/
//update_account_profile_image(options, credentials) =
// path = "/1.1/account/update_profile_image.json"
// forms = FbLib.forms([{file=("image",options.filename,options.content_type,options.source)},
// {bopt=("include_entities", options.include_entities)},
// {bopt=("skip_status", options.skip_status)}])
// Twitter_private(c)._post_multi(path, forms, credentials, TwitParse._build_full_user)
/**
* Blocks list
*
* Returns a collection of user objects that the authenticating user is blocking.
*
* @param include_entities The entities node will not be included when set to false.
* @param skip_status When set to either true, t or 1 statuses will not be included in the returned user objects.
* @param cursor The cursor page number.
* @param credentials The user credentials.
*/
blocks_list(include_entities:option(bool), skip_status:option(bool), cursor:string, credentials) =
path = "/1.1/blocks/list.json"
params =
[]
|> add_bopt("include_entities", include_entities)
|> add_bopt("skip_status", skip_status)
|> add_if("cursor", cursor, (_!=""))
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_paged_users)
/**
* Blocks ids
*
* Returns an array of numeric user ids the authenticating user is blocking.
*
* @param cursor The cursor page number.
* @param credentials The user credentials.
*/
blocks_ids(cursor:string, credentials) =
path = "/1.1/blocks/ids.json"
params =
[("stringify_ids", "true")]
|> add_if("cursor", cursor, (_!=""))
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_paged_ids)
/**
* Blocks create.
*
* Blocks the specified user from following the authenticating user.
*
* @param user The screen name or the unique id of the requested user.
* @param include_entities The entities node will not be included when set to false.
* @param skip_status When set to either true, t or 1 statuses will not be included in the returned user objects.
* @param credentials The user credentials.
* @returns Twitter.full_user
*/
blocks_create(user, include_entities:option(bool), skip_status:option(bool), credentials) =
path = "/1.1/blocks/create.json"
params =
add_user(user, [])
|> add_bopt("include_entities", include_entities)
|> add_bopt("skip_status", skip_status)
Twitter_private(c)._post_res(path, params, credentials, TwitParse._build_full_user)
/**
* Blocks destroy.
*
* Un-blocks the user specified in the ID parameter for the authenticating user.
*
* @param user The screen name or the unique id of the requested user.
* @param include_entities The entities node will not be included when set to false.
* @param skip_status When set to either true, t or 1 statuses will not be included in the returned user objects.
* @param credentials The user credentials.
* @returns Twitter.full_user
*/
blocks_destroy(user, include_entities:option(bool), skip_status:option(bool), credentials) =
path = "/1.1/blocks/destroy.json"
params =
add_user(user, [])
|> add_bopt("include_entities", include_entities)
|> add_bopt("skip_status", skip_status)
Twitter_private(c)._post_res(path, params, credentials, TwitParse._build_full_user)
/**
* Users lookup
*
* Returns fully-hydrated user objects for up to 100 users per request, as specified by comma-separated values passed to the user_id and/or screen_name parameters.
*
* @param user The screen name or the unique id of the requested user.
* @param include_entities The entities node will not be included when set to false.
* @param credentials The user credentials.
*/
users_lookup(user, include_entities:option(bool), credentials) =
path = "/1.1/users/lookup.json"
params =
add_user(user, [])
|> add_bopt("include_entities", include_entities)
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_full_users)
/**
* Users show
*
* Returns a variety of information about the user specified by the required user_id or screen_name parameter.
*
* @param user The screen name or the unique id of the requested user.
* @param include_entities The entities node will not be included when set to false.
* @param credentials The user credentials.
*/
users_show(user, include_entities:option(bool), credentials) =
path = "/1.1/users/show.json"
params =
add_user(user, [])
|> add_bopt("include_entities", include_entities)
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_full_user)
/**
* Users search
*
* Provides a simple, relevance-based search interface to public user accounts on Twitter.
*
* @param q The search query to run against people search.
* @param page Specifies the page of results to retrieve.
* @param count The number of potential user results to retrieve per page. This value has a maximum of 20.
* @param include_entities The entities node will not be included when set to false.
* @param credentials The user credentials.
*/
users_search(q, page:option(int), count:option(int), include_entities:option(bool), credentials) =
path = "/1.1/users/search.json"
params =
[("q",q)]
|> add_iopt("page", page)
|> add_iopt("count", count)
|> add_bopt("include_entities", include_entities)
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_full_users)
/**
* Users contributees
*
* Returns a collection of users that the specified user can "contribute" to.
*
* @param user The screen name or the unique id of the requested user.
* @param include_entities The entities node will not be included when set to false.
* @param skip_status When set to either true, t or 1 statuses will not be included in the returned user objects.
* @param credentials The user credentials.
*/
users_contributees(user, include_entities:option(bool), skip_status:option(bool), credentials) =
path = "/1.1/users/contributees.json"
params =
add_user(user, [])
|> add_bopt("include_entities", include_entities)
|> add_bopt("skip_status", skip_status)
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_full_users)
/**
* Users contributors
*
* Returns a collection of users who can contribute to the specified account.
*
* @param user The screen name or the unique id of the requested user.
* @param include_entities The entities node will not be included when set to false.
* @param skip_status When set to either true, t or 1 statuses will not be included in the returned user objects.
* @param credentials The user credentials.
*/
users_contributors(user, include_entities:option(bool), skip_status:option(bool), credentials) =
path = "/1.1/users/contributors.json"
params =
add_user(user, [])
|> add_bopt("include_entities", include_entities)
|> add_bopt("skip_status", skip_status)
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_full_users)
/**
* Users suggestions slug
*
* Access the users in a given category of the Twitter suggested user list.
*
* @param slug The short name of list or a category
* @param lang Restricts the suggested categories to the requested language.
* @param credentials The user credentials.
*/
users_suggestions_slug(slug, lang:string, credentials) =
path = "/1.1/users/suggestions/{slug}.json"
params =
[]
|> add_if("lang", lang, (_!=""))
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_slug)
/**
* Users suggestions
*
* Access to Twitter's suggested user list. This returns the list of suggested user categories.
*
* @param lang Restricts the suggested categories to the requested language.
* @param credentials The user credentials.
*/
users_suggestions(lang:string, credentials) =
path = "/1.1/users/suggestions.json"
params =
[]
|> add_if("lang", lang, (_!=""))
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_slugs)
/**
* Users suggestions slug members
*
* 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.
*
* @param slug The short name of list or a category
* @param credentials The user credentials.
*/
users_suggestions_slug_members(slug, credentials) =
path = "/1.1/users/suggestions/{slug}/members.json"
Twitter_private(c)._get_res(path, [], credentials, TwitParse._build_full_users)
default_favorites = {
since_id = ""
max_id = ""
count = 0
include_entities = none
} : Twitter.favorites_options
/**
* Favorites list
*
* Returns the 20 most recent Tweets favorited by the authenticating or specified user.
*
* @param user The screen name or the unique id of the requested user.
* @param options The command options.
*/
favorites_list(user, options:Twitter.favorites_options, credentials) =
path = "/1.1/favorites/list.json"
params =
add_user(user, [])
|> add_if("since_id", options.since_id, (_!=""))
|> add_if("max_id", options.max_id, (_!=""))
|> add_if("count", options.count, (_>0))
|> add_bopt("include_entities", options.include_entities)
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_tweets)
/**
* Favorites create.
*
* Favorites the specified user from following the authenticating user.
*
* @param id The numerical ID of the desired status.
* @param include_entities The entities node will not be included when set to false.
* @param credentials The user credentials.
* @returns Twitter.tweet
*/
favorites_create(id, include_entities:option(bool), credentials) =
path = "/1.1/favorites/create.json"
params =
[("id",id)]
|> add_bopt("include_entities", include_entities)
Twitter_private(c)._post_res(path, params, credentials, TwitParse._build_tweet)
/**
* Favorites destroy.
*
* Un-favorites the status specified in the ID parameter as the authenticating user.
*
* @param id The numerical ID of the desired status.
* @param include_entities The entities node will not be included when set to false.
* @param credentials The user credentials.
* @returns Twitter.tweet
*/
favorites_destroy(id, include_entities:option(bool), credentials) =
path = "/1.1/favorites/destroy.json"
params =
[("id",id)]
|> add_bopt("include_entities", include_entities)
Twitter_private(c)._post_res(path, params, credentials, TwitParse._build_tweet)
// Lists
@private add_list_id(list_id:Twitter.list_id, list) =
List.append(
(match list_id with
| ~{list_id} -> [("list_id", list_id)]
| ~{slug owner} -> [("slug", slug),
match owner with
| {~owner_id} -> ("owner_id", owner_id)
| {~owner_screen_name} -> ("owner_screen_name", owner_screen_name)]),list)
/**
* Lists list
*
* Returns all lists the authenticating or specified user subscribes to, including their own.
*
* @param user The screen name or the unique id of the requested user.
*/
lists_list(user, credentials) =
path = "/1.1/lists/list.json"
params = add_user(user, [])
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_full_users)
default_lists = {
since_id = ""
max_id = ""
count = 0
include_entities = none
include_rts = none
} : Twitter.lists_options
/**
* Lists statuses
*
* Returns tweet timeline for members of the specified list.
*
* @param list_id The list ID.
*/
lists_statuses(list_id:Twitter.list_id, options:Twitter.lists_options, credentials) =
path = "/1.1/lists/list.json"
params =
add_list_id(list_id, [])
|> add_if("since_id", options.since_id, (_!=""))
|> add_if("max_id", options.max_id, (_!=""))
|> add_if("count", options.count, (_>0))
|> add_bopt("include_entities", options.include_entities)
|> add_bopt("include_rts", options.include_rts)
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_tweets)
/**
* Lists members destroy
*
* Removes the specified member from the list.
*
* @param list_id The list ID or the slug/owner combination of the list.
* @param user The screen name or the unique id of the requested user.
*/
lists_members_destroy(list_id:Twitter.list_id, user:option(Twitter.user), credentials) =
path = "/1.1/lists/members/destroy.json"
params =
add_list_id(list_id, [])
|> (l -> if Option.is_some(user) then add_user(Option.get(user),l) else l)
Twitter_private(c)._post_res(path, params, credentials, TwitParse._build_tweets) // ??? Docs don't say what this returns
/**
* Lists memberships
*
* Returns the lists the specified user has been added to.
*
* @param user The screen name or the unique id of the requested user.
* @param cursor Breaks the results into pages.
* @param filter_to_owned_lists When set to true, t or 1, will return just lists the authenticating user owns, and the user represented by user_id or screen_name is a member of.
*/
lists_memberships(user, cursor, filter_to_owned_lists, credentials) =
path = "/1.1/lists/memberships.json"
params =
add_user(user, [])
|> add_if("cursor", cursor, (_!=""))
|> add_bopt("filter_to_owned_lists", filter_to_owned_lists)
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_paged_lists)
/**
* Lists subscribers
*
* Returns the subscribers of the specified list.
*
* @param list_id The list ID or the slug/owner combination of the list.
* @param cursor Breaks the results into pages.
* @param include_entities The entities node will not be included when set to false.
* @param skip_status When set to either true, t or 1 statuses will not be included in the returned user objects.
* @param credentials The user credentials.
*/
lists_subscribers(list_id, cursor, include_entities, skip_status, credentials) =
path = "/1.1/lists/subscribers.json"
params =
add_list_id(list_id, [])
|> add_if("cursor", cursor, (_!=""))
|> add_bopt("include_entities", include_entities)
|> add_bopt("skip_status", skip_status)
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_paged_users)
/**
* Lists subscribers create
*
* Subscribes the authenticated user to the specified list.
*
* @param list_id The list ID or the slug/owner combination of the list.
* @param credentials The user credentials.
*/
lists_subscribers_create(list_id, credentials) =
path = "/1.1/lists/subscribers/create.json"
params = add_list_id(list_id, [])
Twitter_private(c)._post_res(path, params, credentials, TwitParse._build_full_user)
/**
* Lists subscribers show
*
* Check if the specified user is a subscriber of the specified list. Returns the user if they are subscriber.
*
* @param list_id The list ID or the slug/owner combination of the list.
* @param user The screen name or the unique id of the requested user.
* @param include_entities The entities node will not be included when set to false.
* @param skip_status When set to either true, t or 1 statuses will not be included in the returned user objects.
* @param credentials The user credentials.
*/
lists_subscribers_show(list_id:Twitter.list_id, user:Twitter.user, include_entities, skip_status, credentials) =
path = "/1.1/lists/subscribers/show.json"
params =
add_list_id(list_id, [])
|> add_user(user,_)
|> add_bopt("include_entities", include_entities)
|> add_bopt("skip_status", skip_status)
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_full_user)
/**
* Lists subscribers destroy
*
* Unsubscribes the authenticated user from the specified list.
*
* @param list_id The list ID or the slug/owner combination of the list.
* @param credentials The user credentials.
*/
lists_subscribers_destroy(list_id, credentials) =
path = "/1.1/lists/subscribers/destroy.json"
params = add_list_id(list_id, [])
Twitter_private(c)._post_res(path, params, credentials, TwitParse._build_full_user)
/**
* Lists create all
*
* Adds multiple members to a list, by specifying a comma-separated list of member ids or screen names.
*
* @param list_id The list ID or the slug/owner combination of the list.
* @param user The screen name or the unique id of the requested user.
* @param credentials The user credentials.
*/
lists_create_all(list_id, user, credentials) =
path = "/1.1/lists/create_all.json"
params =
add_list_id(list_id, [])
|> add_user(user,_)
Twitter_private(c)._post_res(path, params, credentials, TwitParse._build_full_users)
/**
* Lists members show
*
* Check if the specified user is a member of the specified list.
*
* @param list_id The list ID or the slug/owner combination of the list. (multiple,ids,or,names)
* @param user The screen name or the unique id of the requested user.
* @param include_entities The entities node will not be included when set to false.
* @param skip_status When set to either true, t or 1 statuses will not be included in the returned user objects.
* @param credentials The user credentials.
*/
lists_members_show(list_id:Twitter.list_id, user:Twitter.user, include_entities, skip_status, credentials) =
path = "/1.1/lists/members/show.json"
params =
add_list_id(list_id, [])
|> add_user(user,_)
|> add_bopt("include_entities", include_entities)
|> add_bopt("skip_status", skip_status)
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_full_user)
/**
* Lists members
*
* Returns the members of the specified list.
*
* @param list_id The list ID or the slug/owner combination of the list.
* @param cursor Breaks the results into pages.
* @param include_entities The entities node will not be included when set to false.
* @param skip_status When set to either true, t or 1 statuses will not be included in the returned user objects.
* @param credentials The user credentials.
*/
lists_members(list_id, cursor, include_entities, skip_status, credentials) =
path = "/1.1/lists/members.json"
params =
add_list_id(list_id, [])
|> add_if("cursor", cursor, (_!=""))
|> add_bopt("include_entities", include_entities)
|> add_bopt("skip_status", skip_status)
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_paged_users)
/**
* Lists members create
*
* Add a member to a list.
*
* @param list_id The list ID or the slug/owner combination of the list.
* @param user The screen name or the unique id of the requested user.
* @param credentials The user credentials.
*/
lists_members_create(list_id, user, credentials) =
path = "/1.1/lists/members/create.json"
params =
add_list_id(list_id, [])
|> add_user(user,_)
Twitter_private(c)._post_res(path, params, credentials, TwitParse._build_full_user)
/**
* Lists destroy
*
* Deletes the specified list.
*
* @param list_id The list ID or the slug/owner combination of the list.
* @param credentials The user credentials.
*/
lists_destroy(list_id, credentials) =
path = "/1.1/lists/destroy.json"
params = add_list_id(list_id, [])
Twitter_private(c)._post_res(path, params, credentials, TwitParse._build_list)
/**
* Lists update
*
* Updates the specified list.
*
* @param list_id The list ID or the slug/owner combination of the list.
* @param name The name for the list.
* @param mode Whether your list is public or private. Values can be public or private.
* @param description The description to give the list.
* @param credentials The user credentials.
*/
lists_update(list_id, name, mode:option({`public`}/{`private`}), description, credentials) =
path = "/1.1/lists/update.json"
params =
add_list_id(list_id, [])
|> add_if("name", name, (_!=""))
|> (l ->
if Option.is_some(mode)
then List.cons(("mode",match Option.get(mode) with | {`public`} -> "public" | {`private`} -> "private"),l)
else l)
|> add_if("description", description, (_!=""))
Twitter_private(c)._post_res(path, params, credentials, TwitParse._build_list)
/**
* Lists create
*
* Creates a new list for the authenticated user.
*
* @param name The name for the list.
* @param mode Whether your list is public or private. Values can be public or private.
* @param description The description to give the list.
* @param credentials The user credentials.
*/
lists_create(name, mode:option({`public`}/{`private`}), description, credentials) =
path = "/1.1/lists/create.json"
params =
[]
|> add_if("name", name, (_!=""))
|> (l ->
if Option.is_some(mode)
then List.cons(("mode",match Option.get(mode) with | {`public`} -> "public" | {`private`} -> "private"),l)
else l)
|> add_if("description", description, (_!=""))
Twitter_private(c)._post_res(path, params, credentials, TwitParse._build_list)
/**
* Lists show
*
* Returns the specified list.
*
* @param name The name for the list.
* @param mode Whether your list is public or private. Values can be public or private.
* @param description The description to give the list.
* @param credentials The user credentials.
*/
lists_show(list_id, credentials) =
path = "/1.1/lists/show.json"
params = add_list_id(list_id, [])
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_list)
/**
* Lists subscriptions
*
* Obtain a collection of the lists the specified user is subscribed to, 20 lists per page by default.
*
* @param user The screen name or the unique id of the requested user.
* @param cursor Breaks the results into pages.
* @param count The amount of results to return per page.
* @param credentials The user credentials.
*/
lists_subscriptions(user, cursor, count, credentials) =
path = "/1.1/lists/subscriptions.json"
params =
add_user(user, [])
|> add_if("cursor", cursor, (_!=""))
|> add_if("count", count, (_>0))
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_paged_lists)
/**
* Lists destroy all
*
* Removes multiple members from a list, by specifying a comma-separated list of member ids or screen names.
*
* @param list_id The list ID or the slug/owner combination of the list.
* @param user The screen name or the unique id of the requested user.
* @param credentials The user credentials.
*/
lists_destroy_all(list_id, user, credentials) =
path = "/1.1/lists/destroy_all.json"
params =
add_list_id(list_id, [])
|> add_user(user,_)
Twitter_private(c)._post_res(path, params, credentials, TwitParse._build_full_users) // ?? check return type
// Saved Searches
/**
* Saved searches list
*
* Returns the authenticated user's saved search queries.
*
* @param credentials The user credentials.
*/
saved_searches_list(credentials) =
path = "/1.1/saved_searches/list.json"
params = []
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_saved_searches)
/**
* Saved searches show
*
* Retrieve the information for the saved search represented by the given id.
*
* @param id The ID of the saved search.
* @param credentials The user credentials.
*/
saved_searches_show(id:string, credentials) =
path = "/1.1/saved_searches/show/{id}.json"
params = []
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_saved_search)
/**
* Saved searches create
*
* Create a new saved search for the authenticated user.
*
* @param query The query of the search the user would like to save.
* @param credentials The user credentials.
*/
saved_searches_create(query:string, credentials) =
path = "/1.1/saved_searches/create.json"
params = [("query",query)]
Twitter_private(c)._post_res(path, params, credentials, TwitParse._build_saved_search)
/**
* Saved searches destroy
*
* Destroys a saved search for the authenticated user.
*
* @param id The ID of the saved search.
* @param credentials The user credentials.
*/
saved_searches_destroy(id:string, credentials) =
path = "/1.1/saved_searches/destroy/{id}.json"
params = []
Twitter_private(c)._post_res(path, params, credentials, TwitParse._build_saved_search)
// Places & Geo
/**
* Geo id place
*
* Returns all the information about a known place.
*
* @param place_id A place in the world. These IDs can be retrieved from geo/reverse_geocode.
* @param credentials The user credentials.
*/
geo_id_place(place_id:string, credentials) =
path = "/1.1/geo/id/{place_id}.json"
params = []
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_place)
default_reverse_geocode_options = {
accuracy = ""
granularity = ""
max_results = 0
callback = ""
}
/**
* Geo reverse geocode
*
* Given a latitude and a longitude, searches for up to 20 places that can be used as a place_id when updating a status.
*
* @param lat The latitude to search around.
* @param long The longitude to search around.
* @param options The optional parameters.
* @param credentials The user credentials.
*/
geo_reverse_geocode(lat:float, long:float, options:Twitter.reverse_geocode_options, credentials) =
path = "/1.1/geo/reverse_geocode.json"
params =
[("lat","{lat}"),("long","{long}")]
|> add_if("accuracy", options.accuracy, (_!=""))
|> add_if("granularity", options.granularity, (_!=""))
|> add_if("max_results", options.max_results, (_>0))
|> add_if("callback", options.callback, (_!=""))
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_query_result)
default_geo_search = {
lat = none
long = none
query = ""
ip = ""
granularity = ""
accuracy = ""
max_results = 0
contained_within = ""
attribute_street_address = ""
callback = ""
}
/**
* Geo search
*
* Search for places that can be attached to a statuses/update.
*
* @param options The optional parameters.
* @param credentials The user credentials.
*/
geo_search(options:Twitter.geo_search_options, credentials) =
path = "/1.1/geo/search.json"
params =
[]
|> add_fopt("lat", options.lat)
|> add_fopt("long", options.long)
|> add_if("query", options.query, (_!=""))
|> add_if("ip", options.ip, (_!=""))
|> add_if("granularity", options.granularity, (_!=""))
|> add_if("accuracy", options.accuracy, (_!=""))
|> add_if("max_results", options.max_results, (_>0))
|> add_if("contained_within", options.contained_within, (_!=""))
|> add_if("attribute:street_address", options.attribute_street_address, (_!=""))
|> add_if("callback", options.callback, (_!=""))
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_query_result)
/**
* Geo similar places
*
* Locates places near the given coordinates which are similar in name.
*
* @param lat The latitude to search around.
* @param long The longitude to search around.
* @param name The name a place is known as.
* @param contained_within This is the place_id which you would like to restrict the search results to.
* @param attribute_street_address This parameter searches for places which have this given street address.
* @param callback If supplied, the response will use the JSONP format with a callback of the given name.
* @param credentials The user credentials.
*/
geo_similar_places(lat:float, long:float, name:string,
contained_within:string, attribute_street_address:string, callback:string, credentials) =
path = "/1.1/geo/similar_places.json"
params =
[("lat","{lat}"),("long","{long}"),("name",name)]
|> add_if("contained_within", contained_within, (_!=""))
|> add_if("attribute:street_address", attribute_street_address, (_!=""))
|> add_if("callback", callback, (_!=""))
Twitter_private(c)._get_res(path, params, credentials, TwitParse._build_query_result)
/**
* Geo place
*
* Creates a new place object at the given latitude and longitude.
*
* @param name The name a place is known as.
* @param contained_within This is the place_id which you would like to restrict the search results to.
* @param token The token found in the response from geo/similar_places.
* @param lat The latitude to search around.
* @param long The longitude to search around.
* @param attribute_street_address This parameter searches for places which have this given street address.
* @param callback If supplied, the response will use the JSONP format with a callback of the given name.
* @param credentials The user credentials.
*/
geo_place(name:string, contained_within:string, token:string, lat:float, long:float,
attribute_street_address:string, callback:string, credentials) =
path = "/1.1/geo/create.json" // ?? Inconsistency in docs
params =
[("name", name),("contained_within", contained_within),("token",token),("lat","{lat}"),("long","{long}")]
|> add_if("attribute:street_address", attribute_street_address, (_!=""))
|> add_if("callback", callback, (_!=""))
Twitter_private(c)._post_res(path, params, credentials, TwitParse._build_place)
/**
* Report spam
*
* The user specified in the id is blocked by the authenticated user and reported as a spammer.
*
* @param user The screen name or the unique id of the requested user.
*/
report_spam(user, credentials) =
path = "/1.1/users/report_spam.json"
params = add_user(user, [])
Twitter_private(c)._post_res(path, params, credentials, TwitParse._build_full_user)
// Help
/**
* Help configuration
*
* Returns the current configuration used by Twitter including twitter.com slugs which are not usernames, maximum photo resolutions, and t.co URL lengths.
*
*/
help_configuration(credentials) =
path = "/1.1/help/configuration.json"
params = []
Twitter_private(c)._post_res(path, params, credentials, TwitParse._build_config)
/**
* Help languages
*
* Returns the list of languages supported by Twitter along with their ISO 639-1 code.
*
*/
help_languages(credentials) =
path = "/1.1/help/languages.json"
params = []
Twitter_private(c)._post_res(path, params, credentials, TwitParse._build_langs)
}}
Something went wrong with that request. Please try again.