Web.Tweet

Various utilities to tweet using the twitter api

Make sure you have a file credentials file (default the executable looks for is `.cred`) with the following info:

api-key: API_KEY

api-sec: API_SECRE

tok: OAUTH_TOKEN

tok-sec: TOKEN_SECRET

Functions to tweet

basicTweet :: String -> FilePath -> IO Int

Tweet a string given a path to credentials; return the id of the status.

basicTweet "On the airplane." ".cred"

thread :: String -> [String] -> Maybe Int -> Int -> FilePath -> IO ()

thread tweets together nicely. Takes a string, a list of handles to reply to, plus the ID of the status you're replying to. If you need to thread tweets without replying, pass a Nothing as the third argument.

thread "Hi I'm back in New York!" ["friend1","friend2"] Nothing 1 ".cred"

Data type for a tweet

data Tweet

Data type for our request: consists of the status text, whether to trium user information in the response, the handles to mention, and optionally the id of the status to reply to.

Constructors

Tweet

Fields

• _status :: String
• _handles :: [String]
• _replyID :: Maybe Int

Instances

Generic Tweet

Associated Types

type Rep Tweet :: * -> *

Methods

from :: Tweet -> Rep Tweet x

to :: Rep Tweet x -> Tweet

Default Tweet

Methods

def :: Tweet

type Rep Tweet

type Rep Tweet = D1 (MetaData "Tweet" "Web.Tweet.Types" "tweet-hs-0.6.1.3-12P8jBqKX754PuEi3szdfU" False) (C1 (MetaCons "Tweet" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_status") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) ((:*:) (S1 (MetaSel (Just Symbol "_handles") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])) (S1 (MetaSel (Just Symbol "_replyID") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int))))))

data TweetEntity

Data type for tweets as they are returned

Constructors

TweetEntity

Fields

• _text :: String
• _name :: String
• _screenName :: String
• _tweetId :: Int
• _quoted :: Maybe TweetEntity
• _retweets :: Int
• _favorites :: Int

Instances

Eq TweetEntity

Methods

(==) :: TweetEntity -> TweetEntity -> Bool

(/=) :: TweetEntity -> TweetEntity -> Bool

Show TweetEntity

Methods

showsPrec :: Int -> TweetEntity -> ShowS

show :: TweetEntity -> String

showList :: [TweetEntity] -> ShowS

Generic TweetEntity

Associated Types

type Rep TweetEntity :: * -> *

Methods

from :: TweetEntity -> Rep TweetEntity x

to :: Rep TweetEntity x -> TweetEntity

Default TweetEntity

Methods

def :: TweetEntity

type Rep TweetEntity

type Rep TweetEntity = D1 (MetaData "TweetEntity" "Web.Tweet.Types" "tweet-hs-0.6.1.3-12P8jBqKX754PuEi3szdfU" False) (C1 (MetaCons "TweetEntity" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_text") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) ((:*:) (S1 (MetaSel (Just Symbol "_name") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) (S1 (MetaSel (Just Symbol "_screenName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_tweetId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_quoted") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe TweetEntity)))) ((:*:) (S1 (MetaSel (Just Symbol "_retweets") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_favorites") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int))))))

type Timeline = [TweetEntity]

Stores data like (name, text, favoriteCount, retweetCount)

type Config = (OAuth, Credential)

Contains an OAuth and a Credential; encapsulates everything needed to sign a request.

status :: Lens' Tweet String

Lens for Tweet accessing the status field.

handles :: Lens' Tweet [String]

Lens for Tweet accessing the handles field.

replyID :: Lens' Tweet (Maybe Int)

Lens for Tweet accessing the _replyID field.

text :: Lens' TweetEntity String

Lens for TweetEntity accessing the _text field.

name :: Lens' TweetEntity String

Lens for TweetEntity accessing the _name field.

screenName :: Lens' TweetEntity String

Lens for TweetEntity accessing the _screenName field.

tweetId :: Lens' TweetEntity Int

Lens for TweetEntity accessing the _tweetId field.

quoted :: Lens' TweetEntity (Maybe TweetEntity)

Lens for TweetEntity accessing the _quoted field.

retweets :: Lens' TweetEntity Int

Lens for TweetEntity accessing the _retweets field.

favorites :: Lens' TweetEntity Int

Lens for TweetEntity accessing the _favorites field.

Various API calls

getMarkov :: String -> Maybe Int -> FilePath -> IO [String]

Get tweets (text only) for some user

getAll :: String -> Maybe Int -> FilePath -> IO Timeline

Get all tweets by some user

tweetData :: Tweet -> FilePath -> IO Int

tweet, given a Tweet and path to credentials. Return id of posted tweet.

getProfileMax :: String -> Int -> FilePath -> Maybe Int -> IO (Either (ParseError Char Dec) Timeline)

Gets user profile with max_id set.

getProfileRaw :: String -> Int -> FilePath -> Maybe Int -> IO ByteString

Gets user profile with max_id set.

mentions :: Int -> FilePath -> IO (Either (ParseError Char Dec) Timeline)

Get mentions and parse response as a list of tweets

mentionsRaw :: Int -> FilePath -> IO ByteString

Gets mentions

getProfile :: String -> Int -> FilePath -> IO (Either (ParseError Char Dec) Timeline)

Get user profile given screen name and how many tweets to return

showProfile :: String -> Int -> Bool -> FilePath -> IO String

Show a user profile given screen name, how many tweets to return, and whether to print them in color.

showBest :: String -> Int -> Bool -> FilePath -> IO String

Show the most successful tweets by a given user, given their screen name.

showBest' :: String -> Int -> Bool -> FilePath -> IO String

Show the most successful tweets by a given user, given their screen name. Additionally filter out replies.

mute :: String -> FilePath -> IO ()

Mute a user given their screen name

unmute :: String -> FilePath -> IO ()

Unmute a user given their screen name

muteUserRaw :: String -> FilePath -> IO ByteString

Mute a user given their screen name

unmuteUserRaw :: String -> FilePath -> IO ByteString

Unmute a user given their screen name

showTimeline :: Int -> Bool -> FilePath -> IO String

Display user timeline

showTweets :: Bool -> Either (ParseError Char Dec) Timeline -> String

Display user timeline in color, as appropriate

getDMsRaw :: Show t => t -> FilePath -> IO ByteString

Get user's DMs.

getTimeline :: Int -> FilePath -> IO (Either (ParseError Char Dec) Timeline)

Get a timeline

getTimelineRaw :: Int -> FilePath -> IO ByteString

Get a user's timeline and return response as a bytestring

deleteTweet :: Integer -> FilePath -> IO ()

Delete a tweet given its id

deleteTweetResponse :: Integer -> FilePath -> IO (Either (ParseError Char Dec) Timeline)

Get response, i.e. the tweet deleted

favoriteTweet :: Integer -> FilePath -> IO ()

Favorite a tweet given its id

favoriteTweetResponse :: Integer -> FilePath -> IO (Either (ParseError Char Dec) Timeline)

Favorite a tweet and returned the (parsed) response

unfavoriteTweet :: Integer -> FilePath -> IO ()

Unfavorite a tweet given its id

unfavoriteTweetResponse :: Integer -> FilePath -> IO (Either (ParseError Char Dec) Timeline)

Unfavorite a tweet and returned the (parsed) response

unretweetTweet :: Integer -> FilePath -> IO ()

Unretweet a tweet given its id

unretweetTweetResponse :: Integer -> FilePath -> IO (Either (ParseError Char Dec) Timeline)

Unretweet a tweet and returned the (parsed) response

unfollow :: String -> FilePath -> IO ()

Unfollow a user given their screen name

follow :: String -> FilePath -> IO ()

Follow a user given their screen name

block :: String -> FilePath -> IO ()

Block a user given their screen name

unblock :: String -> FilePath -> IO ()

Unblock a user given their screen name

retweetTweet :: Integer -> FilePath -> IO ()

Retweet a tweet given its id

retweetTweetResponse :: Integer -> FilePath -> IO (Either (ParseError Char Dec) Timeline)

Retweet a tweet and returned the (parsed) response

favoriteTweetRaw :: Integer -> FilePath -> IO ByteString

Favorite a tweet given its id; return bytestring response

retweetTweetRaw :: Integer -> FilePath -> IO ByteString

Retweet a tweet given its id; return bytestring response

sendDMRaw :: String -> [Char] -> FilePath -> IO ByteString

Send a DM given text, screen name of recipient.

getDMs :: Int -> FilePath -> IO ByteString

Get DMs, return bytestring of response

followUserRaw :: String -> FilePath -> IO ByteString

Follow a user given their screen name

blockUserRaw :: String -> FilePath -> IO ByteString

Block a user given their screen name

unblockUserRaw :: String -> FilePath -> IO ByteString

Unblock a user given their screen name

unfollowUserRaw :: String -> FilePath -> IO ByteString

Follow a user given their screen name

unretweetTweetRaw :: Integer -> FilePath -> IO ByteString

Unretweet a tweet given its id; return bytestring response

unfavoriteTweetRaw :: Integer -> FilePath -> IO ByteString

Favorite a tweet given its id; return bytestring response

deleteTweetRaw :: Integer -> FilePath -> IO ByteString

Delete a tweet given its id; return bytestring response

Functions to sign API requests

signRequest :: FilePath -> Request -> IO Request

Sign a request using your OAuth dev token, as stored in a config file. Uses the IO monad because signatures require a timestamp

Functions to generate a URL string from a Tweet

urlString :: Tweet -> String

Convert a tweet to a percent-encoded url for querying an API

Helper function to print a bird

bird :: String