track-r 1.9.1 → 1.9.2

data/lib/track-r/comment.rb

@@ -1,22 +1,24 @@
-class Comment
-  attr_accessor :id, :text, :author, :noted_at, :story_id, :project_id, :token
+module TrackR
+  class Comment
+    attr_accessor :id, :text, :author, :noted_at, :story_id, :project_id, :token
 
-  def initialize(options = {})
-    @token = options[:token].to_s
-    @project_id = options[:project_id]
-    @story_id = options[:story_id]
-    @comment = Hpricot(options[:comment])
-    build_comment
-  end
+    def initialize(options = {})
+      @token = options[:token].to_s
+      @project_id = options[:project_id]
+      @story_id = options[:story_id]
+      @comment = Hpricot(options[:comment])
+      build_comment
+    end
 
-  private
+    private
 
-  def build_comment
-    if @comment
-      @id       = @comment.at('id').inner_html.chomp       unless @comment.at('id').nil?
-      @text     = @comment.at('text').inner_html.chomp     unless @comment.at('text').nil?
-      @author   = @comment.at('author').inner_html.chomp   unless @comment.at('author').nil?
-      @noted_at = @comment.at('noted_at').inner_html.chomp unless @comment.at('noted_at').nil?
+    def build_comment
+      if @comment
+        @id       = @comment.at('id').inner_html.chomp       unless @comment.at('id').nil?
+        @text     = @comment.at('text').inner_html.chomp     unless @comment.at('text').nil?
+        @author   = @comment.at('author').inner_html.chomp   unless @comment.at('author').nil?
+        @noted_at = @comment.at('noted_at').inner_html.chomp unless @comment.at('noted_at').nil?
+      end
     end
   end
 end

data/lib/track-r/project.rb

@@ -1,130 +1,132 @@
-# Container for project's attributes.
-# Receives a hash with either :project key pointing to an hpricot object or a
-# project_id and a token with which to fetch and build the project object
-class Project
-  attr_reader :name, :iteration_length, :id, :week_start_day, :point_scale,
-    :api_url, :url, :token
-
-  def initialize(options = {})
-    if options.include?(:project_id) && options.include?(:token)
-      @id      = options[:project_id]
-      @token   = options[:token].to_s
-      @api_url = "#{CONFIG[:api_url]}projects/#{@id}"
-      @url     = "http://www.pivotaltracker.com/projects/#{@id}"
-      @project = Hpricot(open(@api_url, {"X-TrackerToken" => @token}))
-      @stories = nil
-    elsif options.include?(:project) && options.include?(:token)
-      @project = options[:project]
-      @token   = options[:token].to_s
-    else
-      raise ArgumentError, "Valid options are: :project (receives an Hpricot Object) OR :project_id + :token"
+module TrackR
+  # Container for project's attributes.
+  # Receives a hash with either :project key pointing to an hpricot object or a
+  # project_id and a token with which to fetch and build the project object
+  class TrackR::Project
+    attr_reader :name, :iteration_length, :id, :week_start_day, :point_scale,
+      :api_url, :url, :token
+
+    def initialize(options = {})
+      if options.include?(:project_id) && options.include?(:token)
+        @id      = options[:project_id]
+        @token   = options[:token].to_s
+        @api_url = "#{CONFIG[:api_url]}projects/#{@id}"
+        @url     = "http://www.pivotaltracker.com/projects/#{@id}"
+        @project = Hpricot(open(@api_url, {"X-TrackerToken" => @token}))
+        @stories = nil
+      elsif options.include?(:project) && options.include?(:token)
+        @project = options[:project]
+        @token   = options[:token].to_s
+      else
+        raise ArgumentError, "Valid options are: :project (receives an Hpricot Object) OR :project_id + :token"
+      end
+      build_project
     end
-    build_project
-  end
-
-  # Builds an array containing the project's story
-  def stories ; @stories || get_stories ; end
-
-  # Fetches a story with given id
-  def story(id)
-    Story.new(:story_id => id, :project_id => @id, :token => @token)
-  end
-
-  # Creates a story for this project. Receives a set of valid attributes.
-  # Returns a Story object
-  # TODO: Validate attributes
-  def create_story(attributes = {})
-    api_url = URI.parse("#{CONFIG[:api_url]}projects/#{@id}/stories")
-    query_string = attributes.map { |key, value| "story[#{key}]=#{CGI::escape(value)}"}.join('&')
-    begin
-      http = Net::HTTP.new(api_url.host, api_url.port)
-      http.use_ssl = true
-      response, data = http.post(api_url.path, query_string.concat("&token=#{@token}"))
-
-      raise ResponseError, "Wrong response code" unless response.code.to_i == 200
-      story = (Hpricot(response.body)/:story)
-      Story.new(:story => story, :project_id => @id, :token => @token)
-    rescue ResponseError => e
-      print "Got response code [#{response.code}]:\t"
-      puts response.message
-      raise
+
+    # Builds an array containing the project's story
+    def stories ; @stories || get_stories ; end
+
+    # Fetches a story with given id
+    def story(id)
+      TrackR::Story.new(:story_id => id, :project_id => @id, :token => @token)
     end
-  end
-
-  # Deletes a story given a Story object or a story_id
-  def delete_story(story)
-    if story.is_a?(Story)
-      api_url = URI.parse("#{CONFIG[:api_url]}projects/#{@id}/stories/#{story.id}")
-    elsif story.is_a?(Integer) || story.to_i.is_a?(Integer)
-      api_url = URI.parse("#{CONFIG[:api_url]}projects/#{@id}/stories/#{story}")
-    else
-      raise ArgumentError, "Should receive a story id or a Story object."
+
+    # Creates a story for this project. Receives a set of valid attributes.
+    # Returns a TrackR::Story object
+    # TODO: Validate attributes
+    def create_story(attributes = {})
+      api_url = URI.parse("#{CONFIG[:api_url]}projects/#{@id}/stories")
+      query_string = attributes.map { |key, value| "story[#{key}]=#{CGI::escape(value)}"}.join('&')
+      begin
+        http = Net::HTTP.new(api_url.host, api_url.port)
+        http.use_ssl = true
+        response, data = http.post(api_url.path, query_string.concat("&token=#{@token}"))
+
+        raise ResponseError, "Wrong response code" unless response.code.to_i == 200
+        story = (Hpricot(response.body)/:story)
+        TrackR::Story.new(:story => story, :project_id => @id, :token => @token)
+      rescue ResponseError => e
+        print "Got response code [#{response.code}]:\t"
+        puts response.message
+        raise
+      end
     end
-    begin
-      http = Net::HTTP.new(api_url.host, api_url.port)
-      http.use_ssl = true
-      response, data = http.delete(api_url.path, {"X-TrackerToken" => @token})
-      raise ResponseError, "Wrong response code" unless response.code.to_i == 200
-      story = (Hpricot(response.body)/:story)
-      Story.new(:story => story, :project_id => @id, :token => @token)
-    rescue ResponseError => e
-      print "Got response code [#{response.code}]:\t"
-      puts response.message
-      raise
+
+    # Deletes a story given a TrackR::Story object or a story_id
+    def delete_story(story)
+      if story.is_a?(TrackR::Story)
+        api_url = URI.parse("#{CONFIG[:api_url]}projects/#{@id}/stories/#{story.id}")
+      elsif story.is_a?(Integer) || story.to_i.is_a?(Integer)
+        api_url = URI.parse("#{CONFIG[:api_url]}projects/#{@id}/stories/#{story}")
+      else
+        raise ArgumentError, "Should receive a story id or a TrackR::Story object."
+      end
+      begin
+        http = Net::HTTP.new(api_url.host, api_url.port)
+        http.use_ssl = true
+        response, data = http.delete(api_url.path, {"X-TrackerToken" => @token})
+        raise ResponseError, "Wrong response code" unless response.code.to_i == 200
+        story = (Hpricot(response.body)/:story)
+        TrackR::Story.new(:story => story, :project_id => @id, :token => @token)
+      rescue ResponseError => e
+        print "Got response code [#{response.code}]:\t"
+        puts response.message
+        raise
+      end
     end
-  end
-
-  # Gets the backlog's stories
-  def backlog
-    get_stories_by_iteration("backlog")
-  end
-
-  # Gets the current iteration's stories
-  def current
-    get_stories_by_iteration("current")
-  end
-
-  # Gets the icebox iteration's stories
-  def icebox
-    get_stories_by_iteration("icebox")
-  end
-
-  # Gets the done iteration's stories
-  def done
-    get_stories_by_iteration("done")
-  end
-
-  protected
-
-  # Builds a project given an hpricot object stored at instance variable
-  # @project
-  def build_project
-    @id               ||= @project.at('id').inner_html
-    @api_url          ||= "#{CONFIG[:api_url]}projects/#{@id}"
-    @url              ||= "http://www.pivotaltracker.com/projects/#{@id}"
-    @name             = @project.at('name').inner_html
-    @iteration_length = @project.at('iteration_length').inner_html
-    @week_start_day   = @project.at('week_start_day').inner_html
-    @point_scale      = @project.at('point_scale').inner_html.split(',')
-  end
-
-  # Builds an array containing the project's stories
-  def get_stories
-    api_url = "#{CONFIG[:api_url]}projects/#{@id}/stories"
-    @stories = (Hpricot(open(api_url, {"X-TrackerToken" => @token.to_s}))/:story).map {|story| Story.new(:story => story, :project_id => @id, :token => @token)}
-  end
-
-  # Builds an array containing the project's stories for a given iteration
-  def get_stories_by_iteration(name)
-    case name
-    when "icebox"
-      api_url = "#{CONFIG[:api_url]}projects/#{@id}/stories?filter=current_state%3Aunscheduled"
-    else
-      api_url = "#{CONFIG[:api_url]}projects/#{@id}/iterations/#{name}"
+
+    # Gets the backlog's stories
+    def backlog
+      get_stories_by_iteration("backlog")
+    end
+
+    # Gets the current iteration's stories
+    def current
+      get_stories_by_iteration("current")
+    end
+
+    # Gets the icebox iteration's stories
+    def icebox
+      get_stories_by_iteration("icebox")
+    end
+
+    # Gets the done iteration's stories
+    def done
+      get_stories_by_iteration("done")
+    end
+
+    protected
+
+    # Builds a project given an hpricot object stored at instance variable
+    # @project
+    def build_project
+      @id               ||= @project.at('id').inner_html
+      @api_url          ||= "#{CONFIG[:api_url]}projects/#{@id}"
+      @url              ||= "http://www.pivotaltracker.com/projects/#{@id}"
+      @name             = @project.at('name').inner_html
+      @iteration_length = @project.at('iteration_length').inner_html
+      @week_start_day   = @project.at('week_start_day').inner_html
+      @point_scale      = @project.at('point_scale').inner_html.split(',')
+    end
+
+    # Builds an array containing the project's stories
+    def get_stories
+      api_url = "#{CONFIG[:api_url]}projects/#{@id}/stories"
+      @stories = (Hpricot(open(api_url, {"X-TrackerToken" => @token.to_s}))/:story).map {|story| TrackR::Story.new(:story => story, :project_id => @id, :token => @token)}
+    end
+
+    # Builds an array containing the project's stories for a given iteration
+    def get_stories_by_iteration(name)
+      case name
+      when "icebox"
+        api_url = "#{CONFIG[:api_url]}projects/#{@id}/stories?filter=current_state%3Aunscheduled"
+      else
+        api_url = "#{CONFIG[:api_url]}projects/#{@id}/iterations/#{name}"
+      end
+      @stories = (Hpricot(open(api_url, {"X-TrackerToken" => @token.to_s}))/:story).map {|story| TrackR::Story.new(:story => story, :project_id => @id, :token => @token)}
     end
-    @stories = (Hpricot(open(api_url, {"X-TrackerToken" => @token.to_s}))/:story).map {|story| Story.new(:story => story, :project_id => @id, :token => @token)}
-  end
 
-end # class Tracker::Project
+  end # class TrackR::Tracker::TrackR::Project
 
-class ResponseError < Exception ;end
+  class ResponseError < Exception ;end
+end

data/lib/track-r/story.rb

@@ -1,122 +1,123 @@
-#Typhoon TODO: Documentation ☻
-class Story
-  attr_accessor :story_type, :estimate, :current_state,
-    :description, :name, :requested_by, :owned_by, :created_at, :accepted_at,
-    :labels, :project_id, :comments, :story
+module TrackR
+  #Typhoon TODO: Documentation ☻
+  class TrackR::Story
+    attr_accessor :story_type, :estimate, :current_state,
+      :description, :name, :requested_by, :owned_by, :created_at, :accepted_at,
+      :labels, :project_id, :comments, :story
 
-  attr_reader :id, :url
+    attr_reader :id, :url
 
-  def initialize(options = {})
-    @token      = options[:token].to_s
-    if options.include?(:project_id) && options.include?(:story_id) && options.include?(:token)
-      @id         = options[:story_id]
-      @project_id = options[:project_id]
-      @url        = "http://www.pivotaltracker.com/story/show/#{@id}"
-      @api_url    = "#{CONFIG[:api_url]}projects/#{@project_id}/stories/#{@id}"
-      @story      = Hpricot(open(@api_url, {"X-TrackerToken" => @token}))
-    elsif options.include?(:story) && options.include?(:project_id) && options.include?(:token)
-      @project_id = options[:project_id]
-      @story      = options[:story]
-    else
-      raise ArgumentError, "Valid options are: :story (receives an Hpricot Object) + :project_id OR :project_id + :story_id + :token"
+    def initialize(options = {})
+      @token      = options[:token].to_s
+      if options.include?(:project_id) && options.include?(:story_id) && options.include?(:token)
+        @id         = options[:story_id]
+        @project_id = options[:project_id]
+        @url        = "http://www.pivotaltracker.com/story/show/#{@id}"
+        @api_url    = "#{CONFIG[:api_url]}projects/#{@project_id}/stories/#{@id}"
+        @story      = Hpricot(open(@api_url, {"X-TrackerToken" => @token}))
+      elsif options.include?(:story) && options.include?(:project_id) && options.include?(:token)
+        @project_id = options[:project_id]
+        @story      = options[:story]
+      else
+        raise ArgumentError, "Valid options are: :story (receives an Hpricot Object) + :project_id OR :project_id + :story_id + :token"
+      end
+      build_story
     end
-    build_story
-  end
 
-  def build_story
-    @id            ||= @story.at('id').inner_html if @story.at('id')
-    @url           ||= "http://www.pivotaltracker.com/story/show/#{@id}"
-    @api_url       ||= "#{CONFIG[:api_url]}projects/#{@project_id}/stories/#{@id}"
-    @story_type    = @story.at('story_type').inner_html    unless @story.at('story_type').nil?
-    @estimate      = @story.at('estimate').inner_html      unless @story.at('estimate').nil?
-    @current_state = @story.at('current_state').inner_html unless @story.at('current_state').nil?
-    @description   = @story.at('description').inner_html   unless @story.at('description').nil?
-    @name          = @story.at('name').inner_html          unless @story.at('name').nil?
-    @requested_by  = @story.at('requested_by').inner_html  unless @story.at('requested_by').nil?
-    @owned_by      = @story.at('owned_by').inner_html      unless @story.at('owned_by').nil?
-    @created_at    = @story.at('created_at').inner_html    unless @story.at('created_at').nil?
-    @accepted_at   = @story.at('accepted_at').inner_html   unless @story.at('accepted_at').nil?
-    @labels        = @story.at('labels').inner_html        unless @story.at('labels').nil?
-    @comments      ||= build_comments(@story.at('notes').inner_html)         unless @story.at('notes').nil?
-  end
+    def build_story
+      @id            ||= @story.at('id').inner_html if @story.at('id')
+      @url           ||= "http://www.pivotaltracker.com/story/show/#{@id}"
+      @api_url       ||= "#{CONFIG[:api_url]}projects/#{@project_id}/stories/#{@id}"
+      @story_type    = @story.at('story_type').inner_html    unless @story.at('story_type').nil?
+      @estimate      = @story.at('estimate').inner_html      unless @story.at('estimate').nil?
+      @current_state = @story.at('current_state').inner_html unless @story.at('current_state').nil?
+      @description   = @story.at('description').inner_html   unless @story.at('description').nil?
+      @name          = @story.at('name').inner_html          unless @story.at('name').nil?
+      @requested_by  = @story.at('requested_by').inner_html  unless @story.at('requested_by').nil?
+      @owned_by      = @story.at('owned_by').inner_html      unless @story.at('owned_by').nil?
+      @created_at    = @story.at('created_at').inner_html    unless @story.at('created_at').nil?
+      @accepted_at   = @story.at('accepted_at').inner_html   unless @story.at('accepted_at').nil?
+      @labels        = @story.at('labels').inner_html        unless @story.at('labels').nil?
+      @comments      ||= build_comments(@story.at('notes').inner_html)         unless @story.at('notes').nil?
+    end
 
-  # TODO: Test this method
-  def update(attrs = {})
-    unless attrs.empty?
-      if validate_attributes(attrs)
-        attrs.each do |attribute, value|
-          virt_attr = "#{attribute}="
-          self.send(virt_attr, value)
+    # TODO: Test this method
+    def update(attrs = {})
+      unless attrs.empty?
+        if validate_attributes(attrs)
+          attrs.each do |attribute, value|
+            virt_attr = "#{attribute}="
+            self.send(virt_attr, value)
+          end
+          return save
+        else
+          raise ArgumentError
         end
-        return save
-      else
-        raise ArgumentError
       end
     end
-  end
 
-  def save
-    parameters = build_story_xml
-    api_url = URI.parse("#{CONFIG[:api_url]}projects/#{@project_id}/stories/#{@id}")
-    begin
-      http = Net::HTTP.new(api_url.host, api_url.port)
-      http.use_ssl = true
-      response, data = http.put(api_url.path, parameters, {'X-TrackerToken' => @token, 'Content-Type' => 'application/xml'})
+    def save
+      parameters = build_story_xml
+      api_url = URI.parse("#{CONFIG[:api_url]}projects/#{@project_id}/stories/#{@id}")
+      begin
+        http = Net::HTTP.new(api_url.host, api_url.port)
+        http.use_ssl = true
+        response, data = http.put(api_url.path, parameters, {'X-TrackerToken' => @token, 'Content-Type' => 'application/xml'})
 
-      raise ResponseError, "Wrong response code" unless response.code.to_i == 200
-    rescue ResponseError => e
-      print "Got response code [#{response.code}]:\t"
-      puts response.message
-      raise
-    end
+        raise ResponseError, "Wrong response code" unless response.code.to_i == 200
+      rescue ResponseError => e
+        print "Got response code [#{response.code}]:\t"
+        puts response.message
+        raise
+      end
 
-    @story = (Hpricot(response.body)/:story)
-    build_story
-  end
+      @story = (Hpricot(response.body)/:story)
+      build_story
+    end
 
-  # TODO: test this method:
-  def destroy
-    api_url = URI.parse("#{CONFIG[:api_url]}projects/#{@project_id}/stories/#{@id}")
-    begin
-      http = Net::HTTP.new(api_url.host, api_url.port)
-      http.use_ssl = true
-      response, data = http.delete(api_url.path, {"X-TrackerToken" => @token})
-      raise ResponseError, "Wrong response code" unless response.code.to_i == 200
-    rescue ResponseError => e
-      print "Got response code [#{response.code}]:\t"
-      puts response.message
-      raise
+    # TODO: test this method:
+    def destroy
+      api_url = URI.parse("#{CONFIG[:api_url]}projects/#{@project_id}/stories/#{@id}")
+      begin
+        http = Net::HTTP.new(api_url.host, api_url.port)
+        http.use_ssl = true
+        response, data = http.delete(api_url.path, {"X-TrackerToken" => @token})
+        raise ResponseError, "Wrong response code" unless response.code.to_i == 200
+      rescue ResponseError => e
+        print "Got response code [#{response.code}]:\t"
+        puts response.message
+        raise
+      end
     end
-  end
 
-  protected
+    protected
 
-  def build_comments(xml_comments)
-    (Hpricot(xml_comments)/:note).map {|comment| Comment.new(:comment => comment.to_s, :project_id => @project_id, :token => @token, :story_id => @id)}
-  end
+    def build_comments(xml_comments)
+      (Hpricot(xml_comments)/:note).map {|comment| Comment.new(:comment => comment.to_s, :project_id => @project_id, :token => @token, :story_id => @id)}
+    end
 
-  def to_param
-    query_string = attributes.map { |key, value| "story[#{key}]=#{CGI::escape(value)}" unless value.nil?}.compact.join('&')
-  end
+    def to_param
+      query_string = attributes.map { |key, value| "story[#{key}]=#{CGI::escape(value)}" unless value.nil?}.compact.join('&')
+    end
 
-  def build_story_xml
-    story_xml = "<story>"
-    attributes.each do |key, value|
-      story_xml << "<#{key}>#{(value.to_s)}</#{key}>" unless value.nil?
+    def build_story_xml
+      story_xml = "<story>"
+      attributes.each do |key, value|
+        story_xml << "<#{key}>#{(value.to_s)}</#{key}>" unless value.nil?
+      end
+      story_xml << "</story>"
     end
-    story_xml << "</story>"
-  end
 
-  def validate_attributes(attrs)
-    valid_attributes = attributes
-    attrs.each_key do |k|
-      return false unless valid_attributes.include? k
+    def validate_attributes(attrs)
+      valid_attributes = attributes
+      attrs.each_key do |k|
+        return false unless valid_attributes.include? k
+      end
+      return true
     end
-    return true
-  end
 
-  def attributes
-    {
+    def attributes
+      {
       "story_type"    => @story_type,
       "estimate"      => @estimate,
       "current_state" => @current_state,
@@ -125,6 +126,7 @@ class Story
       "requested_by"  => @requested_by,
       "owned_by"      => @owned_by,
       "labels"        => @labels
-    }
-  end
-end # class Tracker::Story
+      }
+    end
+  end # class TrackR::Tracker::TrackR::Story
+end

data/lib/track-r/token.rb

@@ -1,29 +1,31 @@
-class Token
-  def initialize(options = {})
-    @token = case
-             when options.include?(:token)
-               options[:token]
-             when options.include?(:username) &&
-               options.include?(:password)
-               # If a token is not provided, it can be generated by passing a
-               # hash with :user and :password keys
-               get_token(options[:username],
-                         options[:password]
-                        )
-             else
-               raise ArgumentError, "Invalid argument, expecting either <:token> or <:username> and <:password>"
-             end
-  end
+module TrackR
+  class TrackR::Token
+    def initialize(options = {})
+      @token = case
+               when options.include?(:token)
+                 options[:token]
+               when options.include?(:username) &&
+                 options.include?(:password)
+                 # If a token is not provided, it can be generated by passing a
+                 # hash with :user and :password keys
+                 get_token(options[:username],
+                           options[:password]
+                          )
+               else
+                 raise ArgumentError, "Invalid argument, expecting either <:token> or <:username> and <:password>"
+               end
+    end
 
-  def to_s
-    @token
-  end
+    def to_s
+      @token
+    end
 
-  protected
+    protected
 
-  # According to http://www.pivotaltracker.com/help/api#retrieve_token this should work:
-  def get_token(username, password)
-    (Hpricot(open("https://www.pivotaltracker.com/services/tokens/active", :http_basic_authentication => [username, password])).at('guid')).inner_html
-  end
+    # According to http://www.pivotaltracker.com/help/api#retrieve_token this should work:
+    def get_token(username, password)
+      (Hpricot(open("https://www.pivotaltracker.com/services/tokens/active", :http_basic_authentication => [username, password])).at('guid')).inner_html
+    end
 
-end # class Tracker::Token
+  end # class TrackR::Tracker::TrackR::Token
+end

data/lib/track-r/tracker.rb

@@ -1,50 +1,52 @@
-# The class is a wrapper for getting projects, stories and using tokens.  It's
-# main purpose is relating the three allowing to interact with a project, and
-# its stories using a token.
-# Expects a token when initialized.
-class Tracker
-
-  # To generate a token, use the "Create New Token" link on the My Profile
-  # page (http://www.pivotaltracker.com/profile).
-  def initialize(token)
-    @token = token
-    raise TypeError unless @token.is_a? Token
-  end
-
-  # Fetches project with given ID
-  # Returns a Project object
-  def project(project_id)
-    @project = Project.new(:project_id => project_id , :token => @token)
-  end
-
-  # Refresh the projects from the server
-  # Returns an array of projects
-  def sync
-    @projects = nil
-    get_projects
-  end
-
-  # Alias for get_projects
-  # Returns an array of projects
-  def projects ; get_projects ; end
-
-  # Receives a block with the condition to find a project. Should work the
-  # same as Enumerable.find method
-  # Returns a Project object
-  def find_project
-    get_projects unless defined?(@projects) && @projects.is_a?(Array)
-    @projects.find do |project|
-      yield(project)
+module TrackR
+  # The class is a wrapper for getting projects, stories and using tokens.  It's
+  # main purpose is relating the three allowing to interact with a project, and
+  # its stories using a token.
+  # Expects a token when initialized.
+  class TrackR::Tracker
+
+    # To generate a token, use the "Create New TrackR::Token" link on the My Profile
+    # page (http://www.pivotaltracker.com/profile).
+    def initialize(token)
+      @token = token
+      raise TypeError unless @token.is_a? TrackR::Token
     end
-  end
 
-  protected
+    # Fetches project with given ID
+    # Returns a TrackR::Project object
+    def project(project_id)
+      @project = TrackR::Project.new(:project_id => project_id , :token => @token)
+    end
+
+    # Refresh the projects from the server
+    # Returns an array of projects
+    def sync
+      @projects = nil
+      get_projects
+    end
 
-  # Fills @projects. NOTE: call sync method to refill/sync @projects
-  # Returns an Array stored in @projects
-  def get_projects
-    api_url = "#{CONFIG[:api_url]}projects/"
-    @projects ||= (Hpricot(open(api_url, {"X-TrackerToken" => @token.to_s}))/:project).map {|project| Project.new(:project => project, :token => @token)}
-  end
+    # Alias for get_projects
+    # Returns an array of projects
+    def projects ; get_projects ; end
+
+    # Receives a block with the condition to find a project. Should work the
+    # same as Enumerable.find method
+    # Returns a TrackR::Project object
+    def find_project
+      get_projects unless defined?(@projects) && @projects.is_a?(Array)
+      @projects.find do |project|
+        yield(project)
+      end
+    end
+
+    protected
+
+    # Fills @projects. NOTE: call sync method to refill/sync @projects
+    # Returns an Array stored in @projects
+    def get_projects
+      api_url = "#{CONFIG[:api_url]}projects/"
+      @projects ||= (Hpricot(open(api_url, {"X-TrackerToken" => @token.to_s}))/:project).map {|project| TrackR::Project.new(:project => project, :token => @token)}
+    end
 
-end # class Tracker::Tracker
+  end # class TrackR::Tracker::TrackR::Tracker
+end

data/test/unit/project_test.rb

@@ -1,12 +1,12 @@
 require File.dirname(__FILE__) + '/../test_helper'
 
-class ProjectTest < Test::Unit::TestCase
+class TrackR::ProjectTest < Test::Unit::TestCase
   context "A given project" do
 
     setup do
       @project_id = $config[:project_1][:id]
       token_options = {:username => $config[:username], :password => $config[:password]}
-      @tracker = Tracker.new(Token.new(token_options))
+      @tracker = TrackR::TrackR::Tracker.new(TrackR::TrackR::Token.new(token_options))
       @project = @tracker.project(@project_id)
     end
 

data/test/unit/story_test.rb

@@ -6,7 +6,7 @@ class TestStoryTest < Test::Unit::TestCase
 
     setup do
       token_options = {:username => $config[:username], :password => $config[:password]}
-      @tracker = Tracker.new(Token.new(token_options))
+      @tracker = Tracker::Tracker.new(Tracker::Token.new(token_options))
       @project_id = $config[:project_1][:id]
       @project = @tracker.project(@project_id)
       attributes = { :name => "Finish Track-R (sorry for cluttering :))",

data/test/unit/token_test.rb

@@ -10,7 +10,7 @@ class TestTokenTest < Test::Unit::TestCase
     end
 
     should "return a valid token" do
-      @token = Token.new(token_options)
+      @token = TrackR::Token.new(token_options)
       assert_equal $config[:token], @token.to_s
     end
 

data/test/unit/tracker_test.rb

@@ -2,11 +2,11 @@ require File.dirname(__FILE__) + '/../test_helper'
 
 class TestTrackerTest < Test::Unit::TestCase
 
-  context "with an invalid token" do 
+  context "with an invalid token" do
 
-    should "raise an TypeError if token is other than Token object" do 
+    should "raise an TypeError if token is other than TrackR::Token object" do
       token = "token"
-      assert_raise(TypeError) { Tracker.new(token) }
+      assert_raise(TypeError) { TrackR::Tracker.new(token) }
     end
 
   end
@@ -17,12 +17,12 @@ class TestTrackerTest < Test::Unit::TestCase
       @project_id = $config[:project_1][:id]
       def get_token
         token_options = {:username => $config[:username], :password => $config[:password]}
-        Token.new(token_options)
+        TrackR::Token.new(token_options)
       end
-      @tracker = Tracker.new(get_token)
+      @tracker = TrackR::Tracker.new(get_token)
     end
 
-    should "return a valid project by passing the id with correct attributes" do 
+    should "return a valid project by passing the id with correct attributes" do
       project = @tracker.project(@project_id)
       assert_equal $config[:project_1][:name], project.name
       assert_equal $config[:project_1][:point_scale], project.point_scale
@@ -30,12 +30,12 @@ class TestTrackerTest < Test::Unit::TestCase
       assert_equal $config[:project_1][:iteration_length], project.iteration_length
     end
 
-    should "return an array of all my projects" do 
+    should "return an array of all my projects" do
       projects = @tracker.projects
       assert_equal $config[:project_count], projects.size
     end
 
-    should "be able to find a project using Enumerable.find method" do 
+    should "be able to find a project using Enumerable.find method" do
       project_1 = (@tracker.find_project {|project| project.name == $config[:project_1][:name]})
       project_2 = (@tracker.find_project {|project| project.id == $config[:project_2][:id]})
       assert_equal $config[:project_1][:name], project_1.name, "Failed to find by name"

data/track-r.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{track-r}
-  s.version = "1.9.1"
+  s.version = "1.9.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jose Felix Gomez"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: track-r
 version: !ruby/object:Gem::Version 
-  version: 1.9.1
+  version: 1.9.2
 platform: ruby
 authors: 
 - Jose Felix Gomez