taskmapper-github 0.10.0

data/lib/provider/ticket.rb

@@ -0,0 +1,129 @@
+module TaskMapper::Provider
+  module Github
+    # Ticket class for taskmapper-github
+    
+    class Ticket < TaskMapper::Provider::Base::Ticket
+      
+      @@allowed_states = %w{open close}
+      attr_accessor :prefix_options
+      # declare needed overloaded methods here
+      
+      def initialize(*object) 
+        if object.first
+          object = object.first
+          unless object.is_a? Hash
+            hash = {:id => object.number,
+                    :status => object.state,
+                    :description => object.body,
+                    :user => object.user,
+                    :project_id => object.project_id}
+          else 
+            hash = object
+          end
+          super hash
+        end
+      end
+
+      def id
+        self.number
+      end
+
+      def status
+        self.state
+      end
+
+      def description
+        self.body
+      end
+      
+      def description=(val)
+        self.body = val
+      end
+      
+      def author
+        self.user.respond_to?('login') ? self.user.login : self.user
+      end
+
+      def requestor
+        self.user.respond_to?('login') ? self.user.login : self.user
+      end
+
+      def assignee
+        self.user.respond_to?('login') ? self.user.login : self.user
+      end
+
+      def self.find_by_id(project_id, number) 
+        issue = TaskMapper::Provider::Github.api.issue(project_id, number)
+        issue.merge!(:project_id => project_id)
+        self.new issue
+      end
+
+      def self.find(project_id, *options)
+        if options[0].empty?
+          self.find_all(project_id)
+        elsif options[0].first.is_a? Array
+          options[0].first.collect { |number| self.find_by_id(project_id, number) }
+        elsif options[0].first.is_a? Hash
+          self.find_by_attributes(project_id, options[0].first)
+        end
+      end
+
+      def self.find_by_attributes(project_id, attributes = {})
+        issues = self.find_all(project_id)
+        search_by_attribute(issues, attributes)
+      end
+
+      def self.find_all(project_id)
+        issues = []
+        issues += TaskMapper::Provider::Github.api.issues(project_id)
+        issues += TaskMapper::Provider::Github.api.issues(project_id, {:state => "closed"})
+        issues.collect do |issue| 
+          issue.merge!(:project_id => project_id)
+          Ticket.new issue
+        end
+      end
+
+      def self.open(project_id, *options)
+        ticket_hash = options.first
+        body = ticket_hash.delete(:description)
+        title = ticket_hash.delete(:title)
+        new_issue = TaskMapper::Provider::Github.api.create_issue(project_id, title, body, options.first)
+        new_issue.merge!(:project_id => project_id)
+        self.new new_issue
+      end
+
+      def created_at
+        begin 
+          Time.parse(self[:created_at]) 
+        rescue
+          self[:created_at]
+        end
+      end
+
+      def updated_at
+        begin
+          Time.parse(self[:updated_at]) 
+        rescue
+          self[:updated_at]
+        end
+      end
+
+      def save
+        TaskMapper::Provider::Github.api.update_issue(project_id, number, title, description)
+        true
+      end
+
+      def reopen
+        Ticket.new(project_id, TaskMapper::Provider::Github.api.reopen_issue(project_id, number))
+      end
+
+      def close
+        Ticket.new(project_id, TaskMapper::Provider::Github.api.close_issue(project_id, number)) 
+      end
+
+      def comment!(attributes)
+        Comment.create(project_id, number, attributes)
+      end
+    end
+  end
+end

data/lib/taskmapper-github.rb

@@ -0,0 +1,8 @@
+#require YOUR_PROVIDER_API
+require 'octokit'
+require 'active_support/core_ext/string'
+require 'net/http'
+
+%w{ github ticket project comment }.each do |f|
+  require File.dirname(__FILE__) + '/provider/' + f + '.rb';
+end

data/spec/comment_spec.rb

@@ -0,0 +1,44 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe TaskMapper::Provider::Github::Comment do
+
+  before(:each) do
+    @github = TaskMapper.new(:github, {:login => 'taskmapper-user', :password => 'Tm123456'})
+    stub_get('https://taskmapper-user:Tm123456@github.com/api/v2/json/organizations/repositories', 'repositories.json')
+    stub_get('https://taskmapper-user:Tm123456@api.github.com/repos/taskmapper-user/tmtest-repo', 'project.json')
+    stub_get('https://taskmapper-user:Tm123456@api.github.com/repos/taskmapper-user/tmtest-repo/issues','issues.json')
+    stub_get('https://taskmapper-user:Tm123456@api.github.com/repos/taskmapper-user/tmtest-repo/issues?state=closed','closed_issues.json')
+    stub_get('https://taskmapper-user:Tm123456@api.github.com/repos/taskmapper-user/tmtest-repo/issues/1/comments', 'comments.json')
+    stub_post('https://taskmapper-user:Tm123456@api.github.com/repos/taskmapper-user/tmtest-repo/issues/1/comments', 'comments/3951282.json')
+    stub_post('https://taskmapper-user:Tm123456@api.github.com/repos/taskmapper-user/tmtest-repo/issues/comments/3951282', 'comments/3951282_update.json')
+    @project = @github.project('tmtest-repo')
+    @ticket = @project.tickets.first
+    @klass = TaskMapper::Provider::Github::Comment
+    @api = Octokit::Client
+  end
+
+  it "should be able to load all comments" do
+    comments = @ticket.comments
+    comments.should be_an_instance_of(Array)
+    comments.first.should be_an_instance_of(@klass)
+    comments.first.body.should == "for testing"
+  end
+  
+  it "should be able to create a new comment" do  
+    comment = @ticket.comment!(:body => 'for testing')
+    comment.should be_an_instance_of(@klass)
+    comment.body.should == 'for testing'
+  end
+  
+  #see bug 116 tm-github: Bug Ticket#comments returning comments with weird text in the body
+  it "should be able to load a ticket and clean comment body" do
+    comments = @ticket.comments.map(&:body).should == ["for testing", "test comment"]
+  end
+  
+  it "should be able to update comments" do
+    comment = @ticket.comments.first
+    comment.body = "updated comment"
+    comment.save.should be_true
+  end
+
+end

data/spec/fixtures/closed_issues.json

@@ -0,0 +1,3 @@
+[
+
+]

data/spec/fixtures/comments.json

@@ -0,0 +1,30 @@
+[
+  {
+    "url": "https://api.github.com/repos/taskmapper-user/tmtest-repo/issues/comments/3951282",
+    "created_at": "2012-02-13T22:49:55Z",
+    "body": "for testing",
+    "updated_at": "2012-02-13T22:49:55Z",
+    "id": 3951282,
+    "user": {
+      "url": "https://api.github.com/users/taskmapper-user",
+      "gravatar_id": "42bd18419413dfbd6e7ec4fefdec94ae",
+      "login": "taskmapper-user",
+      "avatar_url": "https://secure.gravatar.com/avatar/42bd18419413dfbd6e7ec4fefdec94ae?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png",
+      "id": 1434902
+    }
+  },
+  {
+    "url": "https://api.github.com/repos/taskmapper-user/tmtest-repo/issues/comments/3951282",
+    "created_at": "2012-02-13T22:49:55Z",
+    "body": "--- \nbody: test comment\n",
+    "updated_at": "2012-02-13T22:49:55Z",
+    "id": 3951283,
+    "user": {
+      "url": "https://api.github.com/users/taskmapper-user",
+      "gravatar_id": "42bd18419413dfbd6e7ec4fefdec94ae",
+      "login": "taskmapper-user",
+      "avatar_url": "https://secure.gravatar.com/avatar/42bd18419413dfbd6e7ec4fefdec94ae?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png",
+      "id": 1434902
+    }
+  }
+]

data/spec/fixtures/comments/3951282.json

@@ -0,0 +1,16 @@
+  {
+    "url": "https://api.github.com/repos/taskmapper-user/tmtest-repo/issues/comments/3951282",
+    "created_at": "2012-02-13T22:49:55Z",
+    "body": {
+      "body": "for testing"
+    },
+    "updated_at": "2012-02-13T22:49:55Z",
+    "id": 3951282,
+    "user": {
+      "url": "https://api.github.com/users/taskmapper-user",
+      "gravatar_id": "42bd18419413dfbd6e7ec4fefdec94ae",
+      "login": "taskmapper-user",
+      "avatar_url": "https://secure.gravatar.com/avatar/42bd18419413dfbd6e7ec4fefdec94ae?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png",
+      "id": 1434902
+    }
+  }

data/spec/fixtures/comments/3951282_update.json

@@ -0,0 +1,14 @@
+  {
+    "url": "https://api.github.com/repos/taskmapper-user/tmtest-repo/issues/comments/3951282",
+    "created_at": "2012-02-13T22:49:55Z",
+    "body": "for testing",
+    "updated_at": "2012-02-13T22:49:55Z",
+    "id": 3951282,
+    "user": {
+      "url": "https://api.github.com/users/taskmapper-user",
+      "gravatar_id": "42bd18419413dfbd6e7ec4fefdec94ae",
+      "login": "taskmapper-user",
+      "avatar_url": "https://secure.gravatar.com/avatar/42bd18419413dfbd6e7ec4fefdec94ae?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png",
+      "id": 1434902
+    }
+  }

data/spec/fixtures/issues.json

@@ -0,0 +1,32 @@
+[
+  {
+    "title": "for testing",
+    "url": "https://api.github.com/repos/taskmapper-user/tmtest-repo/issues/1",
+    "closed_at": null,
+    "created_at": "2012-02-13T22:45:27Z",
+    "milestone": null,
+    "labels": [
+
+    ],
+    "number": 1,
+    "body": "",
+    "html_url": "https://github.com/taskmapper-user/tmtest-repo/issues/1",
+    "updated_at": "2012-02-13T22:49:55Z",
+    "comments": 1,
+    "state": "open",
+    "pull_request": {
+      "diff_url": null,
+      "patch_url": null,
+      "html_url": null
+    },
+    "assignee": null,
+    "id": 3210729,
+    "user": {
+      "url": "https://api.github.com/users/taskmapper-user",
+      "gravatar_id": "42bd18419413dfbd6e7ec4fefdec94ae",
+      "login": "taskmapper-user",
+      "avatar_url": "https://secure.gravatar.com/avatar/42bd18419413dfbd6e7ec4fefdec94ae?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png",
+      "id": 1434902
+    }
+  }
+]

data/spec/fixtures/issues/1.json

@@ -0,0 +1 @@
+{"issue":{"comments":1,"position":1.0,"number":1,"state":"open","updated_at":"2012/02/13 14:49:55 -0800","labels":[],"user":"taskmapper-user","body":"","title":"for testing","html_url":"https://github.com/taskmapper-user/tmtest-repo/issues/1","created_at":"2012/02/13 14:45:27 -0800","votes":0,"gravatar_id":"42bd18419413dfbd6e7ec4fefdec94ae"}}

data/spec/fixtures/issues/new_ticket.json

@@ -0,0 +1 @@
+{"issue":{"comments":1,"position":1.0,"number":1,"state":"open","updated_at":"2012/02/13 14:49:55 -0800","labels":[],"user":"taskmapper-user","body":"","title":"for testing","html_url":"https://github.com/taskmapper-user/tmtest-repo/issues/1","created_at":"2012/02/13 14:45:27 -0800","votes":0,"gravatar_id":"42bd18419413dfbd6e7ec4fefdec94ae"}}

data/spec/fixtures/project.json

@@ -0,0 +1,34 @@
+{
+  "watchers": 1,
+  "url": "https://api.github.com/repos/taskmapper-user/tmtest-repo",
+  "master_branch": null,
+  "created_at": "2012-02-13T22:20:10Z",
+  "html_url": "https://github.com/taskmapper-user/tmtest-repo",
+  "ssh_url": "git@github.com:taskmapper-user/tmtest-repo.git",
+  "description": "",
+  "has_wiki": true,
+  "clone_url": "https://github.com/taskmapper-user/tmtest-repo.git",
+  "forks": 1,
+  "fork": false,
+  "pushed_at": null,
+  "git_url": "git://github.com/taskmapper-user/tmtest-repo.git",
+  "mirror_url": null,
+  "open_issues": 1,
+  "private": false,
+  "svn_url": "https://github.com/taskmapper-user/tmtest-repo",
+  "homepage": "",
+  "size": 0,
+  "has_issues": true,
+  "updated_at": "2012-02-13T22:20:10Z",
+  "owner": {
+    "url": "https://api.github.com/users/taskmapper-user",
+    "gravatar_id": "42bd18419413dfbd6e7ec4fefdec94ae",
+    "login": "taskmapper-user",
+    "avatar_url": "https://secure.gravatar.com/avatar/42bd18419413dfbd6e7ec4fefdec94ae?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png",
+    "id": 1434902
+  },
+  "name": "tmtest-repo",
+  "id": 3434734,
+  "has_downloads": true,
+  "language": null
+}

data/spec/fixtures/projects.json

@@ -0,0 +1,34 @@
+[{
+  "watchers":"1",
+  "url":"https://api.github.com/repos/taskmapper-user/tmtest-repo",
+  "created_at":"2012-02-13T22:20:10Z",
+  "mirror_url":"null",
+  "has_wiki":"true",
+  "html_url":"https://github.com/taskmapper-user/tmtest-repo",
+  "ssh_url":"git@github.com:taskmapper-user/tmtest-repo.git",
+  "description":"",
+  "forks":"1",
+  "clone_url":"https://github.com/taskmapper-user/tmtest-repo.git",
+  "fork":false,
+  "open_issues":"1",
+  "private":false,
+  "homepage":"",
+  "size":"0",
+  "has_issues":true,
+  "master_branch":"null",
+  "pushed_at":"null",
+  "updated_at":"2012-02-13T22:20:10Z",
+  "owner": {
+    "url":"https://api.github.com/users/taskmapper-user",
+    "avatar_url":"https://secure.gravatar.com/avatar/42bd18419413dfbd6e7ec4fefdec94ae?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png",
+    "gravatar_id":"42bd18419413dfbd6e7ec4fefdec94ae",
+    "login":"taskmapper-user",
+    "id":"1434902"
+  },
+  "name":"tmtest-repo",
+  "has_downloads":true,
+  "id":"3434734",
+  "git_url":"git://github.com/taskmapper-user/tmtest-repo.git",
+  "svn_url":"https://github.com/taskmapper-user/tmtest-repo",
+  "language":"null"
+}]

data/spec/fixtures/repositories.json

@@ -0,0 +1 @@
+{"repositories":[]}

data/spec/project_spec.rb

@@ -0,0 +1,49 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe TaskMapper::Provider::Github::Project do
+
+  before(:all) do 
+    @repo_name = "tmtest-repo"
+    @returned_repo = "taskmapper-user/tmtest-repo"
+    @klass = TaskMapper::Provider::Github::Project
+  end
+
+  before(:each) do
+    @github = TaskMapper.new(:github, :login => 'taskmapper-user', :password => 'Tm123456')
+  end
+
+  it "should be able to load all projects" do
+    stub_get('https://taskmapper-user:Tm123456@api.github.com/users/taskmapper-user/repos', 'projects.json')
+    stub_get('https://taskmapper-user:Tm123456@github.com/api/v2/json/organizations/repositories', 'repositories.json')
+    @projects = @github.projects
+    @projects.should be_an_instance_of(Array)
+    @projects.first.should be_an_instance_of(@klass)
+  end
+
+  it "should be able to load all projects based on an array of name(id)" do 
+    stub_get('https://taskmapper-user:Tm123456@api.github.com/repos/taskmapper-user/tmtest-repo', 'project.json')
+    @projects = @github.projects([@repo_name])
+    @projects.should be_an_instance_of(Array)
+    @projects.first.should be_an_instance_of(@klass)
+    @projects.first.id.should == @returned_repo
+  end
+
+  it "should be able to load a single project based on a single name(id)" do 
+    @project = @github.projects(@repo_name)
+    @project.should be_an_instance_of(@klass)
+    @project.id.should == @returned_repo
+  end
+
+  it "should be able to find by name(id)" do
+    @project = @github.project(@repo_name)
+    @project.should be_an_instance_of(@klass)
+    @project.id.should == @returned_repo
+  end
+
+  it "should be able to find by attributes" do
+    @projects = @github.projects(:name => 'tmtest-repo')
+    @projects.should be_an_instance_of(Array)
+    @projects.first.id.should be_eql(@returned_repo)
+  end
+end
+

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'taskmapper'
+require 'active_support/core_ext/string'
+require 'rspec'
+require 'taskmapper-github'
+require 'fakeweb'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end
+
+FakeWeb.allow_net_connect = false
+
+def fixture_file(filename)
+  return '' if filename == ''
+  file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/' + filename)
+  File.read(file_path)
+end
+
+
+def stub_request(method, url, filename, status=nil)
+  options = {:body => ""}
+  options.merge!({:body => fixture_file(filename)}) if filename
+  options.merge!({:body => status.last}) if status
+  options.merge!({:status => status}) if status
+
+  FakeWeb.register_uri(method, url, options) 
+end
+
+def stub_get(*args); stub_request(:get, *args) end
+def stub_post(*args); stub_request(:post, *args) end
+def stub_delete(*args); stub_request(:delete, *args) end