Make comment (#5)

* Fix JSON request to always specify content type so sending in a JSON body works
* Add ability to post comment to pivotal story
* Updating README to include POSTing a comment

Author: Steve Klebanoff

README.md

@@ -17,7 +17,11 @@ Based heavily on the [Tentacat](https://github.com/edgurgel/tentacat) and [ExTwi
 * [ ] Accounts
 * [ ] Activity
 * [ ] Attachments
-* [ ] Comments
+* [x] Comments
+  * [ ] Get
+  * [ ] Put
+  * [x] Post
+  * [ ] Delete
 * [ ] Epic
 * [ ] Epics
 * [ ] Exports

lib/extracker/comments.ex

@@ -0,0 +1,19 @@
+defmodule ExTracker.Comments do
+  import ExTracker
+  alias Extracker.Client
+
+  @doc """
+  Create a single `comment`.
+
+  ## Example
+
+      ExTracker.Comments.create(client, '1027488', '66727974', %{text: "Hello World From Elixir"})
+
+  More info at: https://www.pivotaltracker.com/help/api/rest/v5#projects_project_id_stories_story_id_comments_post
+  """
+  @spec create(Client.t, pos_integer, pos_integer, {atom, binary}) :: ExTracker.Record.Comment.t
+  def create(client, project_id, story_id, params) do
+    post("projects/#{project_id}/stories/#{story_id}/comments", client, params)
+    |> ExTracker.Parser.parse_comment
+  end
+end

lib/extracker/parser.ex

@@ -127,6 +127,14 @@ defmodule ExTracker.Parser do
     object |> Enum.map(&ExTracker.Parser.parse_story/1)
   end
 
+  @doc """
+  Parse comment from the API response json.
+  """
+  @spec parse_comment(Map.t) :: ExTracker.Record.Comment.t
+  def parse_comment(object) do
+    struct(ExTracker.Record.Comment, object)
+  end
+
   @doc """
   Parse story from the API response json.
   """

lib/extracker/record.ex

@@ -149,6 +149,20 @@ defmodule ExTracker.Record.Account do
   }
 end
 
+defmodule ExTracker.Record.Comment do
+  defstruct [:id, :created_at, :kind, :person_id, :story_id, :text, :updated_at]
+
+  @type t :: %ExTracker.Record.Comment{
+    id:         pos_integer,
+    created_at: binary,
+    kind:       binary,
+    person_id:  pos_integer,
+    story_id:   pos_integer,
+    text:       binary,
+    updated_at: binary
+  }
+end
+
 defmodule ExTracker.Record.Story do
   defstruct [:id, :project_id, :name, :description, :story_type, :current_state,
               :estimate, :accepted_at, :deadline, :requested_by_id, :owner_ids,

test/comments_test.exs

@@ -0,0 +1,28 @@
+defmodule ExTracker.CommentsTest do
+  use ExUnit.Case
+  use ExVCR.Mock, adapter: ExVCR.Adapter.Hackney
+
+  import ExTracker.Comments
+
+  doctest ExTracker.Comments
+
+  alias ExTracker.Support.Helpers
+  alias ExTracker.Record.Comment
+
+  @client ExTracker.Client.new(%{access_token: Helpers.pt_user_1.token})
+  @project_id Helpers.pt_user_1.project_id
+  @story_id Helpers.pt_user_1.story_id
+
+  setup_all do
+    HTTPoison.start
+  end
+
+  test "create/4" do
+    use_cassette "comments#create" do
+      %Comment{text: text} = create(
+        @client, @project_id, @story_id, %{text: "Sup from test"}
+      )
+      assert text == "Sup from test"
+    end
+  end
+end

test/fixture/vcr_cassettes/comments#create.json

@@ -0,0 +1,41 @@
+[
+  {
+    "request": {
+      "body": "{\"text\":\"Sup from test\"}",
+      "headers": {
+        "Content-Type": "application/json",
+        "User-agent": "extracker",
+        "X-TrackerToken": "d55c3bc1f74346b843ca84ba340b29bf"
+      },
+      "method": "post",
+      "options": [],
+      "request_body": "",
+      "url": "https://www.pivotaltracker.com/services/v5/projects/1027488/stories/66727974/comments"
+    },
+    "response": {
+      "body": "{\"kind\":\"comment\",\"id\":140902341,\"story_id\":66727974,\"text\":\"Sup from test\",\"person_id\":1266314,\"created_at\":\"2016-07-02T00:13:35Z\",\"updated_at\":\"2016-07-02T00:13:35Z\"}",
+      "headers": {
+        "Content-Type": "application/json; charset=utf-8",
+        "Transfer-Encoding": "chunked",
+        "Status": "200 OK",
+        "Cache-Control": "max-age=0, private, must-revalidate",
+        "Date": "Sat, 02 Jul 2016 00:13:35 GMT",
+        "X-Tracker-Project-Version": "148",
+        "X-Request-Id": "ec8dc444fb0ad05752bd7bbea3c7c6fd",
+        "X-UA-Compatible": "IE=Edge,chrome=1",
+        "ETag": "\"35779047e45b3cfc9b691b6b2e56a47e\"",
+        "X-Runtime": "0.171839",
+        "X-Rack-Cache": "invalidate, pass",
+        "X-Powered-By": "Phusion Passenger Enterprise",
+        "Server": "nginx + Phusion Passenger",
+        "Access-Control-Allow-Origin": "*",
+        "Access-Control-Allow-Credentials": "false",
+        "Access-Control-Allow-Methods": "GET, POST, PUT, DELETE, OPTIONS",
+        "Access-Control-Allow-Headers": "X-TrackerToken,DNT,X-Mx-ReqToken,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,X-Tracker-Warn-Unless-Project-Version-Is",
+        "X-Tracker-Client-Pinger-Interval": "12"
+      },
+      "status_code": 200,
+      "type": "ok"
+    }
+  }
+]