Hunter is a Elixir client for Mastodon: https://github.com/milmazz/hunter #myelixirstatus
", created_at: "2017-04-08T04:41:38.643Z", favourited: nil, favourites_count: 1, id: 118635, in_reply_to_account_id: nil, in_reply_to_id: nil, media_attachments: [], mentions: [], reblog: nil, reblogged: nil, reblogs_count: 0, sensitive: nil, spoiler_text: "", tags: [%Hunter.Tag{name: "myelixirstatus", url: "https://social.lou.lt/tags/myelixirstatus"}], uri: "tag:social.lou.lt,2017-04-08:objectId=118635:objectType=Status", url: "https://social.lou.lt/@milmazz/118635", visibility: "public"}, ... ] ``` Returns a list of `Hunter.Status` ### Fetching a user's favourites ``` iex> Hunter.favourites(conn) [] ``` Returns a list of `Hunter.Status` favourited by the authenticated user. ### Favouriting/unfavouriting a status ```elixir iex> Hunter.favourite(conn, 442) %Hunter.Status{account: %Hunter.Account{acct: "FriendlyPootis", avatar: "https://social.lou.lt/system/accounts/avatars/000/000/034/original/565da0399c2c26cf.jpg?1491228302", created_at: "2017-04-03T13:50:06.485Z", display_name: "FriendlyPootis 🚉", followers_count: 62, following_count: 53, header: "https://social.lou.lt/system/accounts/headers/000/000/034/original/b009ddb5a8ce41c1.jpg?1491228302", id: 34, locked: false, note: "fermé comme un carré, Vladimir Pootin sur YT (https://www.youtube.com/VladimirPootin)", statuses_count: 253, url: "https://social.lou.lt/@FriendlyPootis", username: "FriendlyPootis"}, application: %Hunter.Application{client_id: nil, client_secret: nil, id: nil}, content: "les gens pensez à migrer d'instance pour en aller sur une moins chargée tant que vous pouvez, plus vous attendrez plus vous aurez la flemme
", created_at: "2017-04-03T16:22:04.286Z", favourited: true, favourites_count: 5, id: 442, in_reply_to_account_id: nil, in_reply_to_id: nil, media_attachments: [], mentions: [], reblog: nil, reblogged: false, reblogs_count: 4, sensitive: false, spoiler_text: "", tags: [], uri: "tag:social.lou.lt,2017-04-03:objectId=442:objectType=Status", url: "https://social.lou.lt/@FriendlyPootis/442", visibility: "public"} ``` ```elixir iex> Hunter.unfavourite(conn, 442) %Hunter.Status{account: %Hunter.Account{acct: "FriendlyPootis", avatar: "https://social.lou.lt/system/accounts/avatars/000/000/034/original/565da0399c2c26cf.jpg?1491228302", created_at: "2017-04-03T13:50:06.485Z", display_name: "FriendlyPootis 🚉", followers_count: 62, following_count: 53, header: "https://social.lou.lt/system/accounts/headers/000/000/034/original/b009ddb5a8ce41c1.jpg?1491228302", id: 34, locked: false, note: "fermé comme un carré, Vladimir Pootin sur YT (https://www.youtube.com/VladimirPootin)", statuses_count: 253, url: "https://social.lou.lt/@FriendlyPootis", username: "FriendlyPootis"}, application: %Hunter.Application{client_id: nil, client_secret: nil, id: nil}, content: "les gens pensez à migrer d'instance pour en aller sur une moins chargée tant que vous pouvez, plus vous attendrez plus vous aurez la flemme
", created_at: "2017-04-03T16:22:04.286Z", favourited: true, favourites_count: 5, id: 442, in_reply_to_account_id: nil, in_reply_to_id: nil, media_attachments: [], mentions: [], reblog: nil, reblogged: false, reblogs_count: 4, sensitive: false, spoiler_text: "", tags: [], uri: "tag:social.lou.lt,2017-04-03:objectId=442:objectType=Status", url: "https://social.lou.lt/@FriendlyPootis/442", visibility: "public"} ``` Returns the target `Hunter.Status` ### Get instance information ```elixir iex> Hunter.instance_info(conn) %Hunter.Instance{description: "Mostly French instance - Read full description for rules.", email: "maxime+mastodon@melinon.fr", title: "Loultstodon", uri: "social.lou.lt"} ``` Returns the current `Hunter.Instance`. Does not require authentication. ### Fetch user's notifications ```elixir iex> Hunter.notifications(conn) [%Hunter.Notification{account: %Hunter.Account{acct: "paperswelove@mstdn.io", avatar: "https://social.lou.lt/system/accounts/avatars/000/007/126/original/60ecc8225809c008.png?1491486258", created_at: "2017-04-06T13:44:18.281Z", display_name: "Papers We Love", followers_count: 1, following_count: 1, header: "https://social.lou.lt/system/accounts/headers/000/007/126/original/missing.png?1491486258", id: 7126, locked: false, note: "Building Bridges Between Academia and Industry\n\nhttp://paperswelove.org\nhttp://pwlconf.org", statuses_count: 8, url: "https://mstdn.io/@paperswelove", username: "paperswelove"}, created_at: "2017-04-08T12:15:53.467Z", id: 17476, status: nil, type: "follow"}, ... ] ``` Returns a list of `Hunter.Notification` for the authenticated user. ### Fetch a single notification ```elixir iex> Hunter.notification(conn, 17476) %Hunter.Notification{account: %Hunter.Account{acct: "paperswelove@mstdn.io", avatar: "https://social.lou.lt/system/accounts/avatars/000/007/126/original/60ecc8225809c008.png?1491486258", created_at: "2017-04-06T13:44:18.281Z", display_name: "Papers We Love", followers_count: 1, following_count: 1, header: "https://social.lou.lt/system/accounts/headers/000/007/126/original/missing.png?1491486258", id: 7126, locked: false, note: "Building Bridges Between Academia and Industry\n\nhttp://paperswelove.org\nhttp://pwlconf.org", statuses_count: 8, url: "https://mstdn.io/@paperswelove", username: "paperswelove"}, created_at: "2017-04-08T12:15:53.467Z", id: 17476, status: nil, type: "follow"} ``` Returns a single `Hunter.Notification` ### Clear notifications ```elixir iex> Hunter.clear_notifications(conn) "{}" iex> Hunter.notifications(conn) [] ``` Deletes all notifications from the Mastodon server for the authenticated user. ### Get a card associated with a status ```elixir iex> Hunter.card_by_status(conn, 118635) %Hunter.Card{description: "hunter - A Elixir client for Mastodon, a GNU Social compatible micro-blogging service", image: "https://social.lou.lt/system/preview_cards/images/000/000/378/original/34700?1491626499", title: "milmazz/hunter", url: "https://github.com/milmazz/hunter"} ``` Returns a `Hunter.Card` ### Fetch a list of follow requests ```elixir iex> Hunter.follow_requests(conn) [] ``` Returns a list of `Hunter.Account` which have requested to follow the authenticated user. ### Fetch user's blocks ```elixir iex> Hunter.blocks(conn) [] ``` Returns a list of `Hunter.Account` blocked by the authenticated user. ### Fetch user's mutes ```elixir iex> Hunter.mutes(conn) [] ``` Returns a list of `Hunter.Account` muted by the authenticated user. ### Fetch user's reports ```elixir iex> Hunter.reports(conn) [] ``` Returns a list of `Hunter.Report` made by the authenticated user. ### Filter statuses given a hashtag ```elixir iex> Hunter.hashtag_timeline(conn, "paperswelove") [%Hunter.Status{account: %Hunter.Account{acct: "paperswelove@mstdn.io", avatar: "https://social.lou.lt/system/accounts/avatars/000/007/126/original/60ecc8225809c008.png?1491486258", created_at: "2017-04-06T13:44:18.281Z", display_name: "Papers We Love", followers_count: 1, following_count: 1, header: "https://social.lou.lt/system/accounts/headers/000/007/126/original/missing.png?1491486258", id: 7126, locked: false, note: "Building Bridges Between Academia and Industry\n\nhttp://paperswelove.org\nhttp://pwlconf.org", statuses_count: 8, url: "https://mstdn.io/@paperswelove", username: "paperswelove"}, application: nil, content: "One Pass Real-Time Generational Mark-Sweep Garbage Collection - Armstrong, Virding
Link: http://buff.ly/2pdh7iS
In this paper we present a simple scheme for reclaiming data for such language classes with a single pass mark-sweep collector. We also show how the simple scheme can be modified so that the collection can be done in an incremental manner (making it suitable for real-time collection).
", created_at: "2017-04-10T11:40:45.000Z", favourited: nil, favourites_count: 0, id: 186397, in_reply_to_account_id: nil, in_reply_to_id: nil, media_attachments: [%Hunter.Attachment{id: 10284, preview_url: "https://social.lou.lt/system/media_attachments/files/000/010/284/small/b0432b95264e141c.png?1491824449", remote_url: "https://mstdn.io/system/media_attachments/files/000/009/562/original/b0432b95264e141c.png", text_url: nil, type: "image", url: "https://social.lou.lt/system/media_attachments/files/000/010/284/original/b0432b95264e141c.png?1491824449"}], mentions: [], reblog: nil, reblogged: nil, reblogs_count: 0, sensitive: false, spoiler_text: "", tags: [%Hunter.Tag{name: "paperswelove", url: "https://social.lou.lt/tags/paperswelove"}, %Hunter.Tag{name: "compsci", url: "https://social.lou.lt/tags/compsci"}, %Hunter.Tag{name: "garbagecollection", url: "https://social.lou.lt/tags/garbagecollection"}], uri: "tag:mstdn.io,2017-04-10:objectId=171105:objectType=Status", url: "https://mstdn.io/users/paperswelove/updates/9954", visibility: "public"}, ... ] ``` Returns a list of `Hunter.Status`, most recent ones first. ### Updating the current user ```elixir iex> Hunter.update_credentials(conn, %{note: "Enum.random(~w(programming cycling tennis elixir learning mojitos grill))"}) %Hunter.Account{acct: "milmazz", avatar: "https://social.lou.lt/avatars/original/missing.png", created_at: "2017-04-06T17:43:55.325Z", display_name: "Milton Mazzarri", followers_count: 4, following_count: 4, header: "https://social.lou.lt/headers/original/missing.png", id: 8039, locked: false, note: "Enum.random(~w(programming cycling tennis elixir learning mojitos grill))", statuses_count: 3, url: "https://social.lou.lt/@milmazz", username: "milmazz"} ``` Returns a `Hunter.Account` ### Configuration Hunter uses [HTTPoison](https://hex.pm/packages/httpoison) as HTTP client layer. HTTPoison understands a set of [HTTP options](https://hexdocs.pm/httpoison/HTTPoison.Request.html) which can be configured through Hunter configuration : ```elixir config :hunter, http_options: [follow_redirect: true, hackney: [{:force_redirect, true}]] ``` will tell HTTPoison to follow redirected (301) links when calling mastodon API. If you want to provide another API adapter, you can change the following option: ```elixir config :hunter, hunter_api: Hunter.Api.HTTPClient ``` For example, to run local tests we use the following adapter: ```elixir config :hunter, hunter_api: Hunter.Api.InMemory ``` Finally, you can also change the default API base url (`https://mastodon.social`): ```elixir config :hunter, api_base_url: "https://mastodon.social" ``` ## License Hunter source code is released under Apache 2 License. Check the [LICENSE](LICENSE) for more information.