Web.Tweet

Various utilities to tweet using the twitter api

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

api-key = API_KEY

api-sec = API_SECRET

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.toml"

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"

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

Reply with a single tweet. Works the same as thread but doesn't take the fourth argument.

reply "Idk what that means" ["friend1"] (Just 189943500) ".cred"

Data type for a tweet

data Tweet

Data type for our request: consists of the status text, whether to trium u 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

data TweetEntity

Data type for tweets as they are returned

Constructors

TweetEntity

Fields

• _text :: String
• _replyTo :: Maybe Int
• _name :: String
• _screenName :: String
• _tweetId :: Int
• _withheld :: [String]
• _quoted :: Maybe TweetEntity
• _retweets :: Int
• _favorites :: Int

Instances

Eq TweetEntity

Defined in Web.Tweet.Types

Methods

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

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

pricklyTweet :: Tweet

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

module Web.Tweet.API

type Filter = Timeline -> Timeline

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.

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

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

Display user timeline

showFilteredTL :: [Filter] -> String -> Int -> Bool -> FilePath -> IO String

showTweets :: Bool -> Either (ParseErrorBundle String Void) Timeline -> String

Display user timeline in color, as appropriate

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

Display a user's favorites

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

oAuthMem

Arguments

:: ByteString

API key

-> ByteString

API secret

-> OAuth

Create an OAuth api key from two ByteStrings.

credentialMem

Arguments

:: ByteString

Token

-> ByteString

Token secret

-> Credential

Functions to generate a URL string from a Tweet

urlString :: Tweet -> String

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

Timeline filters

filterReplies :: Timeline -> Timeline

Filter out replies

filterRTs :: Timeline -> Timeline

Filter out retweets

filterQuotes :: Timeline -> Timeline

Filter out quotes

Helper function to print a bird

bird :: String