Merge pull request #1 from diacode/feature/stories-endpoint

Stories list

Author: forest

lib/extracker/parser.ex

@@ -117,4 +117,46 @@ defmodule ExTracker.Parser do
   def parse_label(object) do
     struct(ExTracker.Record.Label, object)
   end
+
+  @doc """
+  Parse stories from the API response json.
+  """
+  @spec parse_stories([Map.t] | nil) :: [ExTracker.Record.Story.t] | nil
+  def parse_stories(nil), do: nil
+  def parse_stories(object) do
+    object |> Enum.map(&ExTracker.Parser.parse_story/1)
+  end
+
+  @doc """
+  Parse story from the API response json.
+  """
+  @spec parse_story(Map.t) :: ExTracker.Record.Story.t
+  def parse_story(object) do
+    struct(ExTracker.Record.Story, object)
+  end
+
+  @doc """
+  Parse story transactions from the API response json.
+  """
+  @spec parse_story_transactions([Map.t] | nil) :: [ExTracker.Record.StoryTransaction.t] | nil
+  def parse_story_transactions(nil), do: nil
+  def parse_story_transactions(object) do
+    object |> Enum.map(&ExTracker.Parser.parse_story_transaction/1)
+  end
+
+  @doc """
+  Parse story transactions from the API response json.
+  """
+  @spec parse_story_transaction(Map.t) :: ExTracker.Record.StoryTransaction.t
+  def parse_story_transaction(object) do
+    struct(ExTracker.Record.StoryTransaction, object)
+  end
+
+  @doc """
+  Parse cicle time details from the API response json.
+  """
+  @spec parse_cicle_time_details(Map.t) :: ExTracker.Record.CicleTimeDetails.t
+  def parse_cicle_time_details(object) do
+    struct(ExTracker.Record.CicleTimeDetails, object)
+  end
 end

lib/extracker/record.ex

@@ -148,3 +148,72 @@ defmodule ExTracker.Record.Account do
     kind:         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,
+              :label_ids, :task_ids, :follower_ids, :comment_ids, :created_at, :updated_at,
+              :before_id, :after_id, :integration_id, :external_id, :url, :transitions,
+              :cycle_time_details, :kind]
+
+  @type t :: %ExTracker.Record.Story{
+    id:                 pos_integer,
+    project_id:         pos_integer,
+    name:               binary,
+    description:        binary,
+    story_type:         binary,
+    current_state:      binary,
+    estimate:           float,
+    accepted_at:        binary,
+    deadline:           binary,
+    requested_by_id:    pos_integer,
+    owner_ids:          [pos_integer],
+    label_ids:          [pos_integer],
+    task_ids:           [pos_integer],
+    follower_ids:       [pos_integer],
+    comment_ids:        [pos_integer],
+    created_at:         binary,
+    updated_at:         binary,
+    before_id:          pos_integer,
+    after_id:           pos_integer,
+    integration_id:     pos_integer,
+    external_id:        binary,
+    url:                binary,
+    # transitions:        [ExTracker.Record.StoryTransition.t],
+    # cycle_time_details: ExTracker.Record.CycleTimeDetails.t,
+    kind:               binary
+  }
+end
+
+defmodule ExTracker.Record.StoryTransition do
+  defstruct [:state, :story_id, :project_id, :project_version, :occurred_at, :performed_by_id, :kind]
+
+  @type t :: %ExTracker.Record.StoryTransition{
+    state:           binary,
+    story_id:        pos_integer,
+    project_id:      pos_integer,
+    project_version: pos_integer,
+    occurred_at:     binary,
+    performed_by_id: pos_integer,
+    kind:            binary
+  }
+end
+
+defmodule  ExTracker.Record.CycleTimeDetails do
+  defstruct [:total_cycle_time, :started_time, :started_count, :finished_time,
+              :finished_count, :delivered_time, :delivered_count, :rejected_time,
+              :rejected_count, :story_id, :kind]
+
+  @type t :: %ExTracker.Record.CycleTimeDetails{
+    total_cycle_time:   pos_integer,
+    started_time:       pos_integer,
+    started_count:      pos_integer,
+    finished_time:      pos_integer,
+    finished_count:     pos_integer,
+    delivered_time:     pos_integer,
+    delivered_count:    pos_integer,
+    rejected_time:      pos_integer,
+    rejected_count:     pos_integer,
+    kind:               binary
+  }
+end

lib/extracker/stories.ex

@@ -0,0 +1,19 @@
+defmodule ExTracker.Stories do
+  import ExTracker
+  alias Extracker.Client
+
+  @doc """
+  Get all stories from project
+
+  ## Example
+
+      ExTracker.Stories.list(client, project_id)
+
+  More info at:https://www.pivotaltracker.com/help/api/rest/v5#Stories
+  """
+  @spec list(Client.t, pos_integer, [{atom, binary}] | []) :: [ExTracker.Record.Story.t] | []
+  def list(client, project_id, params \\ []) do
+    get("projects/#{project_id}/stories", client, params)
+    |> ExTracker.Parser.parse_stories
+  end
+end

mix.lock

@@ -2,7 +2,7 @@
   "earmark": {:hex, :earmark, "0.2.1"},
   "ex_doc": {:hex, :ex_doc, "0.11.4"},
   "exactor": {:hex, :exactor, "2.2.0"},
-  "excoveralls": {:hex, :excoveralls, "0.4.5"},
+  "excoveralls": {:hex, :excoveralls, "0.5.1"},
   "exjsx": {:hex, :exjsx, "3.2.0"},
   "exvcr": {:hex, :exvcr, "0.7.1"},
   "hackney": {:hex, :hackney, "1.4.8"},
@@ -12,5 +12,5 @@
   "jsx": {:hex, :jsx, "2.6.2"},
   "meck": {:hex, :meck, "0.8.4"},
   "mimerl": {:hex, :mimerl, "1.0.2"},
-  "poison": {:hex, :poison, "2.0.1"},
+  "poison": {:hex, :poison, "2.1.0"},
   "ssl_verify_hostname": {:hex, :ssl_verify_hostname, "1.0.5"}}

test/fixture/vcr_cassettes/stories#list.json

@@ -0,0 +1,24 @@
+defmodule ExTracker.StoriesTest do
+  use ExUnit.Case
+  use ExVCR.Mock, adapter: ExVCR.Adapter.Hackney
+
+  import ExTracker.Stories
+
+  doctest ExTracker.Stories
+
+  alias ExTracker.Support.Helpers
+
+  @client ExTracker.Client.new(%{access_token: Helpers.pt_user_1.token})
+  @project_id Helpers.pt_user_1.project_id
+
+  setup_all do
+    HTTPoison.start
+  end
+
+  test "list/2" do
+    use_cassette "stories#list" do
+      stories = list(@client, @project_id)
+      assert length(stories) == 63
+    end
+  end
+end