I've created an example application with Phoenix here
Add the following to your mix.exs
...
def application do
[mod: {InstagramPhoenixExample, []},
applications: [:elixtagram]]
end
...
defp deps do
[{:elixtagram, "~> 0.2.5"}]
...
Elixtagram will first look for application variables, then environment variables. This is useful if you want to set application variables locally and environment variables in production (e.g. on Heroku). That being said, I recommend using Dotenv locally.
config/dev.exs
config :elixtagram,
instagram_client_id: "YOUR-CLIENT-ID",
instagram_client_secret: "YOUR-CLIENT-SECRET",
instagram_redirect_uri: "YOUR-REDIRECT-URI"
.env
INSTAGRAM_CLIENT_ID=YOUR-CLIENT-ID
INSTAGRAM_CLIENT_SECRET=YOUR-CLIENT-SECRET
INSTAGRAM_REDIRECT_URI=YOUR-REDIRECT-URI
You can also configure these programatically at runtime if you wish:
iex(1)> Elixtagram.configure("YOUR-CLIENT-ID", "YOUR-CLIENT-SECRET", "YOUR-REDIRECT-URI")
{:ok, []}
# Generate a URL to send them to
iex(1)> Elixtagram.authorize_url!
"https://api.instagram.com/oauth/authorize/?client_id=XXX&redirect_uri=localhost%3A4000&response_type=code"
# Instagram will redirect them back to your INSTAGRAM_REDIRECT_URI, so once they're there, you need to catch the url param 'code', and exchange it for an access token.
iex(2)> code = "XXXXXXXXXX"
"XXXXXXXXXX"
iex(3)> access_token = Elixtagram.get_token!(code: code).access_token
"XXXXXXXXXXXXXXXXXXXX"
# Now we can optionally set this as the global token, and make requests with it by passing :global instead of a token.
iex(4)> Elixtagram.configure(:global, access_token)
{:ok, []}
There are a lot of endpoints you can use without an access token from a user. Most methods can be called in one of three ways, for example:
# Unauthenticated
iex(1)> Elixtagram.tag("lifeisaboutdrugs")
%Elixtagram.Model.Tag{media_count: 27, name: "lifeisaboutdrugs"}
# Explicitly authenticated
iex(1)> Elixtagram.tag("lifeisaboutdrugs", "XXXXXXXXXXXXXXXXX")
%Elixtagram.Model.Tag{media_count: 27, name: "lifeisaboutdrugs"}
# Implicitly authenticated (only works if you have configured a global token)
iex(1)> Elixtagram.tag("lifeisaboutdrugs", :global)
%Elixtagram.Model.Tag{media_count: 27, name: "lifeisaboutdrugs"}
Authenticated endpoints are mostly things which are about getting the current user's stuff
iex(1)> Elixtagram.user_feed(%{count: 2}, "XXXXXXXXXXXXXXXXX")
[%Elixtagram.Model.Media{...}, %Elixtagram.Model.Media{...}]
iex(2)> Elixtagram.user_feed(%{count: 2}, :global)
[%Elixtagram.Model.Media{...}, %Elixtagram.Model.Media{...}]
All of the available methods and the ways to call them are in the docs
TL;DR: mix test
Longer answer:
$ mix deps.get
Running dependency resolution
All dependencies up to date
$ mix test
...........................................................................................
Finished in 17.6 seconds (2.9s on load, 14.7s on tests)
91 tests, 0 failures
Randomized with seed 846369
$ mix coveralls
...........................................................................................
Finished in 13.1 seconds (1.9s on load, 11.2s on tests)
91 tests, 0 failures
Randomized with seed 972312
----------------
COV FILE LINES RELEVANT MISSED
100.0% lib/elixtagram.ex 806 49 0
100.0% lib/elixtagram/api/base.ex 84 24 0
100.0% lib/elixtagram/api/comments.ex 30 3 0
100.0% lib/elixtagram/api/follows.ex 37 5 0
100.0% lib/elixtagram/api/likes.ex 30 3 0
100.0% lib/elixtagram/api/locations.ex 56 12 0
100.0% lib/elixtagram/api/media.ex 37 6 0
100.0% lib/elixtagram/api/tags.ex 33 5 0
100.0% lib/elixtagram/api/users.ex 59 14 0
100.0% lib/elixtagram/config.ex 42 10 0
0.0% lib/elixtagram/exception.ex 3 0 0
0.0% lib/elixtagram/model.ex 38 0 0
100.0% lib/elixtagram/oauth_strategy.ex 50 13 0
100.0% lib/elixtagram/parser.ex 48 10 0
[TOTAL] 100.0%
----------------
It's mostly complete, but these things are missing:
- Pagination of results for certain data types
- Real time subscriptions
- Secure requests
- Add credo in
devenvironment - Improve code readability and resolve credo warnings (thanks rrrene!)
- Update the OAuth2 library to
0.5(thanks for the PR steffenix!) - add a couple more test cases around pagination to get back to 100% coverage
- Minor pagination bugfix - was throwing a
KeyErrorwhen requesting a paginateduser_followsand on the last page of results.
- Add pagination support for
user_follows, this doesn't break the existinguser_follows/2anduser_follows/3API.
- Add
Elixtagram.authorize_url!/3, which takes astateargument to pass back to the callback url. This is useful for things like CSRF protection (read more here). This change doesn't break or change the existing API.
- Change the api of
Elixtagram.user_follows/1&Elixtagram.user_follows/2(now respectivelyElixtagram.user_follows/2&Elixtagram.user_follows/3) to accept acountargument.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent