trajectory 0.1.0

data/spec/unit/client_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+module Trajectory
+  describe Client do
+    it 'raises an exceptions when environment variables are not set' do
+      begin
+        original_api_key = ENV['TRAJECTORY_API_KEY']
+        original_account_keyword = ENV['TRAJECTORY_ACCOUNT_KEYWORD']
+        ENV['TRAJECTORY_API_KEY'] = nil
+        ENV['TRAJECTORY_ACCOUNT_KEYWORD'] = nil
+
+        expect do
+          Client.new
+        end.to raise_error(BadEvnrionmentError)
+      ensure
+        ENV['TRAJECTORY_API_KEY'] = original_api_key
+        ENV['TRAJECTORY_ACCOUNT_KEYWORD'] = original_account_keyword
+      end
+    end
+
+    it 'delegate fetching of projects to the data store' do
+      DataStore.should_receive(:projects)
+
+      Client.new.projects
+    end
+  end
+end

data/spec/unit/core_ext/hash_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Hash do
+  it 'can symbolize hash keys' do
+    hash = {'foo' => 'bar', 'baz' => 'qux'}
+
+    hash.symbolize_keys!
+
+    hash.should == {:foo => 'bar', :baz => 'qux'}
+  end
+end

data/spec/unit/data_access/api_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+require 'ostruct'
+
+module Trajectory
+  describe Api do
+    describe '#projects' do
+      it 'make an API call to retrieve all trajectory projects' do
+        query = '/projects.json'
+        body = [{'id' => '1234'}]
+        headers = {:headers => {'Content-Type' => 'application/json'}}
+
+        Api.should_receive(:get).
+          with(query, headers).
+          and_return(OpenStruct.new :headers => headers, :body => body.to_json)
+
+        Api.projects.should == body
+      end
+    end
+
+    let(:project) { double(:project, :keyword => 'project-keyword') }
+
+    describe '#users_for_project' do
+      it 'make an API call to retrieve all users of a given project' do
+
+        query = "/projects/#{project.keyword}/users.json"
+        body = [{'id' => '1234'}]
+        headers = {:headers => {'Content-Type' => 'application/json'}}
+
+        Api.should_receive(:get).
+          with(query, headers).
+          and_return(OpenStruct.new :headers => headers, :body => body.to_json)
+
+        Api.users_for_project(project).should == body
+      end
+    end
+
+    describe '#stories_for_project' do
+      it 'make an API call to retrieve all users of a given project' do
+        not_completed_stories_query = "/projects/#{project.keyword}/stories.json"
+        completed_stories_query = "/projects/#{project.keyword}/stories/completed.json"
+        not_completed_stories_body = {'stories' => [{'id' => '1234'}]}
+        completed_stories_body = {'stories' => [{'id' => '1234'}]}
+        headers = {:headers => {'Content-Type' => 'application/json'}}
+
+        Api.should_receive(:get).
+          with(not_completed_stories_query, headers).
+          and_return(OpenStruct.new :headers => headers, :body => not_completed_stories_body.to_json)
+        Api.should_receive(:get).
+          with(completed_stories_query, headers).
+          and_return(OpenStruct.new :headers => headers, :body => completed_stories_body.to_json)
+
+        Api.stories_for_project(project).should == completed_stories_body['stories'] + not_completed_stories_body['stories']
+      end
+    end
+
+    describe '#iterations_for_project' do
+      it 'make an API call to retrieve all users of a given project' do
+        query = "/projects/#{project.keyword}/iterations.json"
+        body = [{'id' => '1234'}]
+        headers = {:headers => {'Content-Type' => 'application/json'}}
+
+        Api.should_receive(:get).
+          with(query, headers).
+          and_return(OpenStruct.new :headers => headers, :body => body.to_json)
+
+        Api.iterations_for_project(project).should == body
+      end
+    end
+
+    describe '#ideas_for_project' do
+      it 'make an API call to retrieve all users of a given project' do
+        query = "/projects/#{project.keyword}/ideas.json"
+        body = [{'id' => '1234'}]
+        headers = {:headers => {'Content-Type' => 'application/json'}}
+
+        Api.should_receive(:get).
+          with(query, headers).
+          and_return(OpenStruct.new :headers => headers, :body => body.to_json)
+
+        Api.ideas_for_project(project).should == body
+      end
+    end
+
+    describe '#updates_for_project' do
+      it 'make an API call to retrieve all users of a given project' do
+        since = DateTime.now
+
+        query = "/projects/#{project.keyword}/updates.json?since=#{since}"
+        body = [{'id' => '1234'}]
+        headers = {:headers => {'Content-Type' => 'application/json'}}
+
+        Api.should_receive(:get).
+          with(query, headers).
+          and_return(OpenStruct.new :headers => headers, :body => body.to_json)
+
+        Api.updates_for_project(project, since).should == body
+      end
+    end
+  end
+end

data/spec/unit/data_access/data_store_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+module Trajectory
+  describe DataStore do
+    before(:each) do
+      DataStore.instance_variable_set(:@projects, nil)
+    end
+
+    it 'maps JSON projects to actual collection of projects' do
+      json_projects_collection = double
+      Api.stub(:projects).and_return(json_projects_collection)
+      Projects.should_receive(:from_json).with(json_projects_collection)
+
+      DataStore.projects
+    end
+
+    let(:project) { double(:project, :id => 4567) }
+
+    it 'maps JSON users to actual collection of users' do
+      json_users_collection = double
+      Api.stub(:users_for_project).and_return(json_users_collection)
+      Users.should_receive(:from_json).with(json_users_collection)
+
+      DataStore.users_for_project(project)
+    end
+
+    it 'maps JSON stories to actual collection of stories' do
+      json_stories_collection = double
+      Api.stub(:stories_for_project).and_return(json_stories_collection)
+      Stories.should_receive(:from_json).with(project, json_stories_collection)
+
+      DataStore.stories_for_project(project)
+    end
+
+    it 'maps JSON iterations to actual collection of iterations' do
+      json_iterations_collection = double
+      Api.stub(:iterations_for_project).and_return(json_iterations_collection)
+      Iterations.should_receive(:from_json).with(project, json_iterations_collection)
+
+      DataStore.iterations_for_project(project)
+    end
+
+    it 'maps JSON ideas to actual collection of ideas' do
+      json_ideas_collection = double
+      Api.stub(:ideas_for_project).and_return(json_ideas_collection)
+      Ideas.should_receive(:from_json).with(project, json_ideas_collection)
+
+      DataStore.ideas_for_project(project)
+    end
+
+    it 'maps JSON updates to acutal array of updates with properly updated stories and iterations' do
+      updated_stories = double
+      updated_iterations = double
+
+      json_stories_collection = double
+      json_iterations_collection = double
+
+      Api.stub(:updates_for_project).and_return({'stories' => json_stories_collection, 'iterations' => json_iterations_collection})
+
+      Stories.should_receive(:from_json).with(project, json_stories_collection).and_return(updated_stories)
+      Iterations.should_receive(:from_json).with(project, json_iterations_collection).and_return(updated_iterations)
+
+      updates = DataStore.updates_for_project(project)
+
+      updates.stories.should == updated_stories
+      updates.iterations.should == updated_iterations
+    end
+
+    it 'delegates fetching of project by id to the project collection' do
+      projects_collection = double
+      DataStore.stub(:projects).and_return(projects_collection)
+
+      id = 12
+      projects_collection.should_receive(:find_by_id).with(id)
+
+      DataStore.find_project_by_id(id)
+    end
+
+    it 'delegates fetching of user of a project to the project' do
+      id = 12
+      project.should_receive(:find_user_by_id).with(id)
+
+      DataStore.find_user_of_project_with_id(project, id)
+    end
+  end
+end

data/spec/unit/domain/idea_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+module Trajectory
+  describe Idea do
+    let(:idea) { Idea.new(id: 42, subject: 'foo') }
+
+    it 'can be initialized with named parameters' do
+      idea.id.should == 42
+      idea.subject.should == 'foo'
+    end
+
+    it 'requires an id attribute' do
+      expect do
+        Idea.new.id
+      end.to raise_error(MissingAttributeError)
+    end
+
+    it 'is the same idea when ids are the same' do
+      idea.should == Idea.new(id: 42, subject: 'bar')
+    end
+
+    context 'it has attributes accessors' do
+      %w(id subject stories_count comments_count last_comment_user_name last_comment_created_at editable_by_current_user user_id subscribed_user_ids project_id).each do |attribute|
+        it "'#{attribute}' accessor" do
+          Idea.new.should respond_to(attribute.to_sym)
+        end
+      end
+    end
+
+    it 'delegates project fetching to data store' do
+      DataStore.should_receive(:find_project_by_id)
+
+      Idea.new.project
+    end
+
+    it 'delegates user fetching to data store' do
+      project = double
+      idea = Idea.new(user_id: 42)
+      idea.stub(:project).and_return(project)
+
+      DataStore.should_receive(:find_user_of_project_with_id).with(project, 42)
+
+      idea.user
+    end
+  end
+end

data/spec/unit/domain/ideas_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+
+module Trajectory
+  describe Ideas do
+    it 'can be initialized from json array of components attributes' do
+      project = double(:project, :id => 4567)
+      json_ideas_collection = [{'id' => 1234, 'subject' => 'idea-subject'}, {'id' => 42, 'subject' => 'other-idea-subject'}]
+
+      ideas = Ideas.from_json(project, json_ideas_collection)
+
+      ideas.should be_kind_of(Ideas)
+      ideas.first.id.should == 1234
+      ideas.first.subject.should == 'idea-subject'
+
+      ideas[1].id.should == 42
+      ideas[1].subject.should == 'other-idea-subject'
+
+      ideas.first.project_id.should == 4567
+      ideas[1].project_id.should == 4567
+    end
+  end
+end

data/spec/unit/domain/iteration_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+module Trajectory
+  describe Iteration do
+    let(:iteration) { Iteration.new(id: 42) }
+
+    it 'can be initialized with named parameters' do
+      iteration.id.should == 42
+    end
+
+    it 'requires an id attribute' do
+      expect do
+        Iteration.new.id
+      end.to raise_error(MissingAttributeError)
+    end
+
+    it 'is the same story when ids are the same' do
+      iteration.should == Iteration.new(id: 42)
+    end
+
+    it 'knows when the iteration is a past one' do
+      Iteration.new(:complete => true).past?.should == true
+      Iteration.new(:complete => false).past?.should == false
+    end
+
+    it 'knows when the iteration is a future one' do
+      Iteration.new(:complete => true, :current => true).future?.should == false
+      Iteration.new(:complete => true, :current => false).future?.should == false
+      Iteration.new(:complete => false, :current => true).future?.should == false
+      Iteration.new(:complete => false, :current => false).future?.should == true
+    end
+
+    context 'it has attributes accessors' do
+      %w(percent_complete started_stories_count created_at estimated_velocity delivered_stories_count updated_at unstarted_stories_count starts_on current stories_count id complete accepted_points estimated_points comments_count accepted_stories_count).each do |attribute|
+        it "'#{attribute}' accessor" do
+          Iteration.new.should respond_to(attribute.to_sym)
+        end
+      end
+    end
+
+    it 'delegates fetching of its stories to its project' do
+      project = double
+      iteration = Iteration.new(:id => 42)
+      iteration.project = project
+
+      project.should_receive(:stories_in_iteration).with(iteration)
+
+      iteration.stories
+    end
+  end
+end

data/spec/unit/domain/iterations_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+module Trajectory
+  describe Iterations do
+    it 'can be initializes from a json array of components attributes' do
+      project = double(:project, :id => 4567)
+      json_iterations_collection = [{'id' => 1234, 'estimated_points' => 12}, {'id' => 42, 'estimated_points' => 10}]
+
+      iterations = Iterations.from_json project, json_iterations_collection
+
+      iterations.should be_kind_of(Iterations)
+      iterations.first.id.should == 1234
+      iterations.first.estimated_points.should == 12
+
+      iterations[1].id.should == 42
+      iterations[1].estimated_points.should == 10
+
+      iterations.first.project_id.should == 4567
+      iterations[1].project_id.should == 4567
+    end
+
+    it 'can retrieve current iteration' do
+      current_iteration = double(:current? => true)
+      iterations = Iterations.new(double(:current? => false),
+                                  current_iteration,
+                                  double(:current? => false))
+
+      iterations.current.should == current_iteration
+    end
+
+    it 'can retrieve pasts iterations' do
+      past_iteration_1 = double(:past? => true)
+      past_iteration_2 = double(:past? => true)
+      iterations = Iterations.new(past_iteration_1, double(:past? => false), double(:past? => false), past_iteration_2)
+
+      iterations.past.should == Iterations.new(past_iteration_1, past_iteration_2)
+    end
+
+    it 'can retrieve future iterations' do
+      future_iteration_1 = double(:future? => true)
+      future_iteration_2 = double(:future? => true)
+      iterations = Iterations.new(future_iteration_1, double(:future? => false), double(:future? => false), future_iteration_2)
+
+      iterations.future.should == Iterations.new(future_iteration_1, future_iteration_2)
+    end
+  end
+end

data/spec/unit/domain/project_spec.rb

@@ -0,0 +1,163 @@
+require 'spec_helper'
+
+module Trajectory
+  describe Project do
+    let(:project) { Project.new(id: 42, name: 'foo') }
+
+    it 'can be initialized with named parameters' do
+      project.id.should == 42
+      project.name.should == 'foo'
+    end
+
+    it 'requires an id attribute' do
+      expect do
+        Project.new.id
+      end.to raise_error(MissingAttributeError)
+    end
+
+    it 'is the same project when ids are the same' do
+      project.should == Project.new(id: 42, name: 'bar')
+    end
+
+    context 'it has attributes accessors' do
+      %w(archived? created_at estimated_velocity historic_velocity id keyword updated_at completed_iterations_count completed_stories_count).each do |attribute|
+        it "'#{attribute}' accessor" do
+          Project.new.should respond_to(attribute.to_sym)
+        end
+      end
+    end
+
+    it 'can sum the points of all its stories' do
+      stories = Stories.new(double(:story, :points => 2),
+                            double(:story, :points => 10),
+                            double(:story, :points => 8))
+      DataStore.stub(:stories_for_project).and_return(stories)
+
+      Project.new.total_points.should == 20
+    end
+
+    it 'can evaluate remaining points' do
+      stories = Stories.new(double(:story, :points => 2, :completed? => false),
+                            double(:story, :points => 10, :completed? => false),
+                            double(:story, :points => 8, :completed? => true))
+      DataStore.stub(:stories_for_project).and_return(stories)
+
+      Project.new.remaining_points.should == 12
+    end
+
+    it 'can evaluate the number of days to the end' do
+      stories = Stories.new(double(:story, :points => 2, :completed? => false),
+                            double(:story, :points => 10, :completed? => false),
+                            double(:story, :points => 8, :completed? => false))
+      DataStore.stub(:stories_for_project).and_return(stories)
+
+      project = Project.new(:estimated_velocity => 20)
+
+      project.remaining_days.should == 7
+    end
+
+    it 'can evaluate project end date' do
+      stories = Stories.new(double(:story, :points => 20, :completed? => false),
+                            double(:story, :points => 10, :completed? => false),
+                            double(:story, :points => 10, :completed? => false))
+      DataStore.stub(:stories_for_project).and_return(stories)
+
+      project = Project.new(:estimated_velocity => 20)
+
+      project.estimated_end_date.should == Date.today + 14
+    end
+
+    it 'can evaluate velocity per day' do
+      Project.new(:estimated_velocity => 20).estimated_velocity_per_day.should == 20 / 7.0
+      Project.new(:estimated_velocity => 21).estimated_velocity_per_day.should == 21 / 7.0
+      Project.new(:estimated_velocity => 7).estimated_velocity_per_day.should == 7 / 7.0
+    end
+
+    it 'can count the number of remaining working days' do
+      stories = Stories.new(double(:story, :points => 2, :completed? => false),
+                            double(:story, :points => 10, :completed? => false),
+                            double(:story, :points => 8, :completed? => false))
+      DataStore.stub(:stories_for_project).and_return(stories)
+
+      project = Project.new(:estimated_velocity => 20)
+
+      project.remaining_working_days.should == 5
+    end
+
+    it 'can estimate velocity per working day' do
+      Project.new(:estimated_velocity => 20).estimated_velocity_per_working_day.should == 20 / 5.0
+      Project.new(:estimated_velocity => 21).estimated_velocity_per_working_day.should == 21 / 5.0
+      Project.new(:estimated_velocity => 7).estimated_velocity_per_working_day.should == 7 / 5.0
+    end
+
+    it 'can estimate the percentage of completion' do
+      stories = Stories.new(double(:story, :points => 1, :completed? => false),
+                            double(:story, :points => 10, :completed? => false),
+                            double(:story, :points => 9, :completed? => true))
+      DataStore.stub(:stories_for_project).and_return(stories)
+
+      Project.new.percent_complete.should == 45.0
+    end
+
+    it 'can return the sum of completed stories points' do
+      stories = Stories.new(double(:story, :points => 1, :completed? => false),
+                            double(:story, :points => 10, :completed? => true),
+                            double(:story, :points => 9, :completed? => true))
+      DataStore.stub(:stories_for_project).and_return(stories)
+
+      Project.new.accepted_points.should == 19
+    end
+
+    it 'delegates fetching of iterations of a project to the data store' do
+      DataStore.should_receive(:iterations_for_project).with(project)
+
+      project.iterations
+    end
+
+    it 'delegates fetching of updates of a project to the data store' do
+      since = double
+      DataStore.should_receive(:updates_for_project).with(project, since)
+
+      project.updates(since)
+    end
+
+    it 'delegates fetching of ideas of a project to the data store' do
+      DataStore.should_receive(:ideas_for_project).with(project)
+
+      project.ideas
+    end
+
+    it 'can get stories of a given iteration' do
+      stories = double
+      iteration = double
+
+      project.stories = stories
+      stories.should_receive(:in_iteration).with(iteration)
+
+      project.stories_in_iteration(iteration)
+    end
+
+    it 'can get one of its user by id' do
+      users = double
+
+      project.users_collection = users
+      users.should_receive(:find_by_id).with(1234)
+
+      project.find_user_by_id(1234)
+    end
+
+    context 'when estimated velocity is zero' do
+      it 'cannot estimate remaining days until the project end' do
+        expect do
+          Project.new(:estimated_velocity => 0).remaining_days
+        end.to raise_error(VelocityEqualToZeroError)
+      end
+
+      it 'cannot estimate remaining working days until the project end' do
+        expect do
+          Project.new(:estimated_velocity => 0).remaining_working_days
+        end.to raise_error(VelocityEqualToZeroError)
+      end
+    end
+  end
+end

data/spec/unit/domain/projects_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+module Trajectory
+  describe Projects do
+    it 'can be initialized from an array of json attributes of its components' do
+      json_projects_collection = [{'id' => 1234, 'name' => 'foo'}, {'id' => 42, 'name' => 'bar'}]
+
+      projects = Projects.from_json(json_projects_collection)
+
+      projects.should be_kind_of(Projects)
+      projects.first.id.should == 1234
+      projects.first.name.should == 'foo'
+
+      projects[1].id.should == 42
+      projects[1].name.should == 'bar'
+    end
+
+    it 'can find a project by id' do
+      project = double(:project, id: 1234)
+      projects = Projects.new(double(:project, id: 1),
+                 double(:project, id: 2),
+                 project,
+                 double(:project, id: 3))
+
+      projects.find_by_id(1234).should == project
+    end
+
+    it "returns false when it can't find a project by id" do
+      projects = Projects.new(double(:project, id: 1),
+                              double(:project, id: 2),
+                              double(:project, id: 3))
+
+      projects.find_by_id(1234).should == false
+    end
+
+    it 'can find a project by keyword' do
+      project = double(:project, keyword: 'a_keyword')
+      projects = Projects.new(double(:project, keyword: 'some_identifier'),
+                              double(:project, keyword: 'another_identifier'),
+                              project,
+                              double(:project, keyword: 'the_last_identifier'))
+
+      projects.find_by_keyword('a_keyword').should == project
+    end
+
+    it "returns false when it can't find a project by keyword" do
+      projects = Projects.new(double(:project, keyword: 'some_identifier'),
+                              double(:project, keyword: 'another_identifier'),
+                              double(:project, keyword: 'the_last_identifier'))
+
+      projects.find_by_keyword('a_keyword').should == false
+    end
+
+    it 'can filter active projects' do
+      project_1 = double(:archived? => true)
+      project_2 = double(:archived? => true)
+      project_3 = double(:archived? => true)
+
+      projects = Projects.new(double(:archived? => false),
+                              project_1,
+                              double(:archived? => false),
+                              project_2,
+                              project_3,
+                              double(:archived? => false))
+
+      projects.archived.should include(project_1, project_2, project_3)
+    end
+
+    it 'can filter archived projects' do
+      project_1 = double(:archived? => false)
+      project_2 = double(:archived? => false)
+      project_3 = double(:archived? => false)
+
+      projects = Projects.new(double(:archived? => true),
+                              project_1,
+                              double(:archived? => true),
+                              project_2,
+                              project_3,
+                              double(:archived? => true))
+
+      projects.active.should include(project_1, project_2, project_3)
+    end
+  end
+end