trajectory 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e4e38ce957170860b16f74c2ca873c005c978c5
+  data.tar.gz: 6e532e69b0e54ca48e3b469612644aea41e6ad67
+SHA512:
+  metadata.gz: d7892c02afbb0156a5f7880c6f23b3343d226c696230371409ab31a053f2076ca4663c6932ff6c77fe43c29413cb88258422f0f90aaecbc83d37d96a34687e86
+  data.tar.gz: 7a0300e0f14c9fe74fe52ad18c65249f1a977e4f71b7156c503ab4d3fc719c2e523a3b1d77cf8e9e8b18ac304a7b5cc756d79b9140d64b60d5a0234c309a6c98

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+bin

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format doc

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p0

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode

data/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+group :development, :test do
+  gem 'awesome_print'
+  gem 'rspec'
+  gem 'rake'
+  gem 'yard'
+end
+
+group :test do
+  gem 'vcr'
+  gem 'webmock'
+  gem 'fabrication'
+  gem 'simplecov', :require => false
+  gem 'timecop'
+end
+
+# Specify your gem's dependencies in trajectory.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Loïc Minaudier
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+# Trajectory Ruby Wrapper
+
+[![Build Status](https://travis-ci.org/lminaudier/trajectory.png?branch=master)](https://travis-ci.org/lminaudier/trajectory)
+
+This gem is a wrapper to the Thoughbot's Trajectory app ([apptrajectory.com](http://apptrajectory.com)).
+
+This is **work in progress** but you'll have read access to
+- projects
+- stories
+- iterations
+- ideas
+- updates
+
+Comments, Uploads wrappers are missing.
+
+No write wrapper is provided at the moment.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'trajectory'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install trajectory
+
+## Usage
+
+### Read Access
+
+#### Authentication
+
+By default, the wrapper will look for the Trajectory API key in
+`TRAJECTORY_API_KEY` environment variable. You can also pass it directly to the
+constructor.
+
+	require 'trajectory'
+
+	client = Trajectory::Client.new
+	client.projects
+
+#### API
+
+See [RDoc](http://rdoc.info/github/lminaudier/trajectory/master/frames) for api details
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = '--format progress'
+end
+
+task :default => :spec
+
+desc "List all code todos"
+task :todo do
+  require 'yard'
+  YARD::Registry.load!.all.each do |o|
+    if o.tag(:todo)
+      puts "#{o.file}:#{o.line} #{o.tag(:todo).text}"
+    end
+  end
+end

data/config/env.yml

@@ -0,0 +1,3 @@
+test:
+  trajectory_api_key: 76900a72434cfe249da911eea2a6c94a
+  trajectory_account_keyword: fake-user-for-api-test

data/lib/trajectory/client.rb

@@ -0,0 +1,24 @@
+module Trajectory
+  class Client
+    # Creates a new trajectory client
+    #
+    # @return [Client]
+    def initialize
+      check_environment!
+    end
+
+    # Checks if environment variables are set.
+    #
+    # @raise [BadEvnrionmentError] if TRAJECTORY_API_KEY and TRAJECTORY_ACCOUNT_KEYWORD are not set
+    def check_environment!
+      raise BadEvnrionmentError if ENV['TRAJECTORY_API_KEY'].nil? || ENV['TRAJECTORY_ACCOUNT_KEYWORD'].nil?
+    end
+
+    # Fetches all trajectory projects of the account
+    #
+    # @return [Projects] the projects collection
+    def projects
+      DataStore.projects
+    end
+  end
+end

data/lib/trajectory/core_ext/hash.rb

@@ -0,0 +1,8 @@
+class Hash
+  def symbolize_keys!
+    keys.each do |key|
+      self[(key.to_sym rescue key) || key] = delete(key)
+    end
+    self
+  end
+end

data/lib/trajectory/core_ext.rb

@@ -0,0 +1 @@
+require 'trajectory/core_ext/hash'

data/lib/trajectory/data_access/api.rb

@@ -0,0 +1,54 @@
+require 'httparty'
+
+module Trajectory
+  class Api
+    include HTTParty
+    base_uri "https://www.apptrajectory.com/api/#{ENV['TRAJECTORY_API_KEY']}/accounts/#{ENV['TRAJECTORY_ACCOUNT_KEYWORD']}"
+
+    class << self
+      # @return [JSON] a json array of all projects attributes from trajectory API
+      def projects
+        get_json("/projects.json")
+      end
+
+      # @return [JSON] a json array of all users (of the given project) attributes from trajectory API
+      def users_for_project(project)
+        get_json("/projects/#{project.keyword}/users.json")
+      end
+
+      # @return [JSON] a json array of all stories (of the given project) attributes from trajectory API
+      def stories_for_project(project)
+        get_json("/projects/#{project.keyword}/stories/completed.json")['stories'] +
+        get_json("/projects/#{project.keyword}/stories.json")['stories']
+      end
+
+      # @return [JSON] a json array of all iterations (of the given project) attributes from trajectory API
+      def iterations_for_project(project)
+        get_json("/projects/#{project.keyword}/iterations.json")
+      end
+
+      # @return [JSON] a json array of all ideas (of the given project) attributes from trajectory API
+      def ideas_for_project(project)
+        get_json("/projects/#{project.keyword}/ideas.json")
+      end
+
+      # @return [JSON] a json array of all updates (of the given project) attributes from trajectory API
+      def updates_for_project(project, since)
+        get_json("/projects/#{project.keyword}/updates.json?since=#{since.to_s}")
+      end
+
+      private
+      def get_json(url)
+        JSON.parse(get_body(url, options))
+      end
+
+      def options
+        {:headers => {'Content-Type' => 'application/json'}}
+      end
+
+      def get_body(*args)
+        get(*args).body
+      end
+    end
+  end
+end

data/lib/trajectory/data_access/data_store.rb

@@ -0,0 +1,70 @@
+module Trajectory
+  module DataStore
+    extend self
+
+    # @return [Projects] the collection of projects of the trajectory account
+    def projects
+      @projects ||= Projects.from_json(Api.projects)
+    end
+
+    # @return [Users] the collection of users of the trajectory account
+    def users_for_project(project)
+      Users.from_json Api.users_for_project(project)
+    end
+
+    # Fetches all stories of a given project
+    #
+    # @param project [Project] the project
+    # @return [Stories] the collection of stories
+    def stories_for_project(project)
+      Stories.from_json project, Api.stories_for_project(project)
+    end
+
+    # Fetches all ideas of a given project
+    #
+    # @param project [Project] the project
+    # @return [Ideas] the collection of ideas
+    def ideas_for_project(project)
+      Ideas.from_json project, Api.ideas_for_project(project)
+    end
+
+    # Fetches all updates of a given project since a given date
+    #
+    # @param project [Project] the project
+    # @param since [DateTime] a datetime
+    # @return [Ideas] the collection of updates
+    def updates_for_project(project, since = DateTime.now)
+      updates = Api.updates_for_project(project, since).symbolize_keys!
+
+      stories = Stories.from_json(project, updates[:stories])
+      iterations = Iterations.from_json(project, updates[:iterations])
+
+      Update.new(stories, iterations)
+    end
+
+    # Fetches a project by id in the collection of accessible projects
+    #
+    # @param id [Integer] the project id
+    # @return [Project, false] the found project or false
+    def find_project_by_id(id)
+      projects.find_by_id(id)
+    end
+
+    # Fetches a user of a given project by id
+    #
+    # @param project [Project] the project
+    # @param user_id [Integer] the user id
+    # @return [User, false] the found user or false
+    def find_user_of_project_with_id(project, user_id)
+      project.find_user_by_id(user_id)
+    end
+
+    # Fetches all iterations of a given project
+    #
+    # @param project [Project] the project
+    # @return [Iterations] the collection of iterations
+    def iterations_for_project(project)
+      Iterations.from_json project, Api.iterations_for_project(project)
+    end
+  end
+end

data/lib/trajectory/data_access.rb

@@ -0,0 +1,2 @@
+require 'trajectory/data_access/api'
+require 'trajectory/data_access/data_store'

data/lib/trajectory/domain/idea.rb

@@ -0,0 +1,70 @@
+module Trajectory
+  class Idea
+    include Virtus
+
+    # @return [Integer] the unique identifier of the idea.
+    # @raise [MissingAttributeError] if id is nil
+    attribute :id, Integer, default: lambda { |project, attribute| raise MissingAttributeError.new(project, :id) }
+    # @return [String] the subject (i.e title) of the idea
+    attribute :subject, String
+    # @return [Integer] the number of stories associated with the idea
+    attribute :stories_count, Integer
+    # @return [Integer] the number of comments on the idea
+    attribute :comments_count, Integer
+    # @return [String] Name of the last user that have commented on the idea
+    attribute :last_comment_user_name, String
+    # @return [DateTime] date of the last comment on the idea
+    attribute :last_comment_created_at, DateTime
+    # @return [DateTime] date of the last activity (i.e edit, comment, ...) on the idea
+    attribute :last_activity_at, DateTime
+    # @!method editable_by_current_user?
+    # @return [true, false] true if the user can edit the idea, false otherwise
+    attribute :editable_by_current_user, Boolean
+    # @return [Integer] idea of the user that created the idea
+    # @see #user
+    attribute :user_id, Integer
+    # @return [Array<Integer>] the ids of the users that have subscribed to the
+    # @see #subscribed_users
+    attribute :subscribed_user_ids, Array[Integer]
+    # @return [Integer] the id of the project the idea belongs to
+    # @see #project
+    attribute :project_id, Integer
+    # @return [String] the content of the idea
+    attribute :body, String
+
+    # Returns true if two ideas are the sames i.e they share the same id
+    # attribute
+    #
+    # @param other [Idea] the other object to compare
+    # @return [true, false]
+    def ==(other)
+      id == other.id
+    end
+
+    # Fetch the project the idea belongs to
+    #
+    # @return [Project]
+    def project
+      DataStore.find_project_by_id(project_id)
+    end
+
+    # Fetch the user that created the idea
+    #
+    # @return [User]
+    def user
+      DataStore.find_user_of_project_with_id(project, user_id)
+    end
+
+    # @todo Not Yet Implemented
+    def subscribed_users
+    end
+
+    # @todo Not Yet Implemented
+    def percent_complete
+    end
+
+    # @todo Not Yet Implemented
+    def stories
+    end
+  end
+end

data/lib/trajectory/domain/ideas.rb

@@ -0,0 +1,23 @@
+module Trajectory
+  class Ideas < SimpleDelegator
+    alias :ideas :__getobj__
+
+    # Creates a new collection of {Idea}
+    #
+    # @param ideas [Array<Idea>] a arbitrary lenght list of {Idea} objects
+    def initialize(*ideas)
+      super(ideas)
+    end
+
+    # Create a new collection of {Idea} from a JSON array of attributes from trajectory API
+    #
+    # @param project [Project] the project the iterations belongs to
+    # @param json_attributes [Hash] the hash of attributes of each idea of the collection
+    def self.from_json(project, json_attributes)
+      new(*json_attributes.map do |attributes|
+        attributes = attributes.symbolize_keys!.merge({project_id: project.id})
+        Idea.new(attributes)
+      end)
+    end
+  end
+end

data/lib/trajectory/domain/iteration.rb

@@ -0,0 +1,85 @@
+module Trajectory
+  class Iteration
+    include Virtus
+
+    attr_writer :project
+
+    # @return [Integer] the unique identifier of the iteration.
+    # @raise [MissingAttributeError] if id is nil
+    attribute :id, Integer, default: lambda { |project, attribute| raise MissingAttributeError.new(project, :id) }
+    # @return [Float] the completion percentage of the iteration
+    attribute :percent_complete, Float
+    # @return [Integer] number of started stories in the iteration
+    attribute :started_stories_count, Integer
+    # @return [DateTime] creation date of the iteration
+    attribute :created_at, DateTime
+    # @return [Integer] estimated velocity of the project
+    attribute :estimated_velocity, Integer
+    # @return [Integer] number of delivered stories in the iteration
+    attribute :delivered_stories_count, Integer
+    # @return [DateTime] last modification date of the iteration
+    attribute :updated_at, DateTime
+    # @return [Integer] number of unstarted stories
+    attribute :unstarted_stories_count, Integer
+    # @return [DateTime] start date of the iteration
+    attribute :starts_on, DateTime
+    # @!method current?
+    # @return [true, false] true if iteration is the current iteration, false otherwise
+    attribute :current, Boolean
+    # @return [Integer] number of stories in the iteration
+    attribute :stories_count, Integer
+    # @!method complete?
+    # @return [true, false] return true if the iteration has been completed, false otherwise
+    attribute :complete, Boolean
+    # Sum of points accepted stories in the iteration
+    #
+    # @return [Integer] number of accepted points
+    attribute :accepted_points, Integer
+    # Sum of all points of all stories of the iteration
+    #
+    # @return [Integer] number of estimated points
+    attribute :estimated_points, Integer
+    # @return [Integer] number of comments of the story
+    attribute :comments_count, Integer
+    # @return [Integer] bumber of accepted stories
+    attribute :accepted_stories_count, Integer
+    # @return [Integer] d of the project the iteration belongs to
+    # @see #project
+    attribute :project_id, Integer
+
+    # @!method past?
+    #
+    # Returns true if iteration is a past one i.e has been completed
+    #
+    # @return [true, false]
+    alias :past? :complete?
+
+    # Returns true if the iteration is a future one i.e not started and not completed
+    def future?
+      !current? && !complete?
+    end
+
+    # Returns true if two iterations are the sames i.e they share the same id
+    # attribute
+    #
+    # @param other [Iteration] the other object to compare
+    # @return [true, false]
+    def ==(other)
+      id == other.id
+    end
+
+    # Fetch the project the iteration belongs to
+    #
+    # @return [Project]
+    def project
+      @project ||= DataStore.find_project_by_id(project_id)
+    end
+
+    # Fetch the stories that belongs to the iteration
+    #
+    # @return [Stories] the stories collection
+    def stories
+      project.stories_in_iteration(self)
+    end
+  end
+end

data/lib/trajectory/domain/iterations.rb

@@ -0,0 +1,46 @@
+module Trajectory
+  class Iterations < SimpleDelegator
+    alias :iterations :__getobj__
+
+    # Creates a new collection of {Iteration}
+    #
+    # @param iterations [Array<Iteration>] a arbitrary lenght list of {Iteration} objects
+    def initialize(*iterations)
+      super(iterations)
+    end
+
+    # Create a new collection of {Iteration} from a JSON array of attributes from trajectory API
+    #
+    # @param project [Project] the project the iterations belongs to
+    # @param json_attributes [Hash] the hash of attributes of each iteration of the collection
+    def self.from_json(project, json_attributes)
+      new(*json_attributes.map do |attributes|
+        attributes = attributes.symbolize_keys!.merge({project_id: project.id})
+        attributes[:current] = attributes[:current?]
+        attributes.delete(:current?)
+        Iteration.new(attributes)
+      end)
+    end
+
+    # Returns the current iteration of the project or false it no current iteration can be found
+    #
+    # @return [Iteration, false] the current iteration or false
+    def current
+      iterations.find { |iteration| iteration.current? } || false
+    end
+
+    # Returns the future iterations of the project
+    #
+    # @return [Iterations] the future iterations
+    def future
+      iterations.select { |iteration| iteration.future? }
+    end
+
+    # Returns the past iterations of the project
+    #
+    # @return [Iterations] the past iterations
+    def past
+      iterations.select { |iteration| iteration.past? }
+    end
+  end
+end