[PR] Adding API

[LuchoTurtle]

closes #53

This PR adds the ability for users to interact with Phoenix as an API. It should:

• create
• update
• update status

[LuchoTurtle]

Still very much in-progress but should be manageable.
Was stuck for a while trying to convert an Ecto.Changeset struct to a map but couldn't for a while. Tried several links:

• https://elixirforum.com/t/how-to-encode-ecto-schema-with-jason-with-all-fields/17221
• https://elixirforum.com/t/how-to-get-struct-from-map-elixir/4543
• https://elixirforum.com/t/convert-ecto-changeset-to-struct/3430
• https://stackoverflow.com/questions/36512627/elixir-convert-struct-to-map
• https://elixirforum.com/t/how-to-decode-a-json-into-a-struct-safely/14331
• https://elixirforum.com/t/use-ecto-schema-directly-or-convert-to-a-custom-struct/30196/3

But none were really useful. I really wanted a way of keeping the code clean to simply return a JSON object using Postman. I came across elixir-ecto/ecto#1348 but it was an old issue and didn't really seem the idiomatic way of doing things (even if José gave the answer).

Using Map.from_struct/1 wasn't helpful because it couldn't parse the __meta__ tag inside the changeset.

Came across https://alchemist.camp/episodes/encoding-ecto-structs-poison and it was it (though not at first). The answer was having to add the @derive notation on the top of the schema inside lib/app/todo/item.ex. The person in the video was using Poison but since Jason was being used in the project, I adapted it.

This only works because Jason is being used as the de facto parsing library inside config.exs.

# Use Jason for JSON parsing in Phoenix
config :phoenix, :json_library, Jason

[LuchoTurtle]

The API routes work under the "/api" scope, as per Phoenix 1.7rc's guide and recommendation. (even though we could use content negotiation, I personally don't see a problem with this path and it makes it simpler for the users).

I'm going to update the readme after standup.

[LuchoTurtle]

Finished adding tests. They aren't 100% but they technically are.

The missing lines are already covered on #56. Since this PR was created with auth, doesn't make sense to duplicate code and possibly making merging difficult. So it's best to merge #56 first and then this one.

If this PR is merged into main, I can merge main into this branch so coverage gets to 100%.

[codecov]

Codecov Report

Merging #60 (4f61445) into main (acb5d7f) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##              main       #60   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            8         9    +1     
  Lines           66        91   +25     
=========================================
+ Hits            66        91   +25     

Impacted Files	Coverage Δ
lib/app/todo/item.ex	100.00% <100.00%> (ø)
lib/app_web/controllers/api_controller.ex	100.00% <100.00%> (ø)
lib/app_web/router.ex	100.00% <100.00%> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[LuchoTurtle]

Just added tests, a guide and referred it in the main readme.
As I've stated before in #60 (comment), this PR makes sense to only be merged after #56. The README adds a section numbered 13, taking into account that auth is 12.

[nelsonic]

@LuchoTurtle please tidy the merge-conflicts when you can. Thanks.

[LuchoTurtle]

@nelsonic should be sorted. 👍

[nelsonic]

Thanks for fixing the merge-conflicts. 👍

[nelsonic]

Compiling 22 files (.ex)
warning: router paths should begin with a forward slash, got: "items"
  (phoenix 1.7.0-rc.0) lib/phoenix/router/scope.ex:113: Phoenix.Router.Scope.validate_path/1
  (phoenix 1.7.0-rc.0) lib/phoenix/router/resource.ex:31: Phoenix.Router.Resource.build/3
  lib/app_web/router.ex:35: (module)
  (elixir 1.14.1) src/elixir_compiler.erl:65: :elixir_compiler.dispatch/4
  (elixir 1.14.1) src/elixir_compiler.erl:50: :elixir_compiler.compile/3
  (elixir 1.14.1) src/elixir_module.erl:379: :elixir_module.eval_form/6

[nelsonic]

Great additions; thanks @LuchoTurtle! 🎉