gitlab-fogbugz 0.0.1 → 0.0.2

data/README.markdown

@@ -51,12 +51,11 @@ Set up your repositories on GitLab to send a post-receive hook to the root url o
 ### gitlab-fogbugz-server (this app):
 The configuration file holds several variables that you'll need to edit.
 
-* **fb\_submit\_url**: The url to the cvsSubmit.[php|asp] file on your FogBugz server.
 * **fb\_main\_url**: The url to your FogBugz's installation.
-* **curl**: The path to the curl binary. Curl is used to submit the commit to FogBugz.
 * **repos**: A list of the SCM repositories that you're using.  Each repo has two urls:
   * *log_url*: The url to the commit log for a specific file 
   * *diff_url*: The url to the specific commit or revision.
+* (Currently unsupported: **fb\_submit\_url**: The url to the cvsSubmit.[php|asp] file on your FogBugz server.)
 
 Each repo name must match the the values that are in the *sRepo* field in FogBug's *CVS* table.
 

data/Rakefile

@@ -4,7 +4,7 @@ require "rake/testtask"
 require "rake/gempackagetask"
 
 GEM = "gitlab-fogbugz"
-VERSION = "0.0.1"
+VERSION = "0.0.2"
 AUTHOR = ["John Reilly", "François Beausoleil", "Markus Fischer"]
 EMAIL = ["jr@trms.com", "francois@teksol.info", "markus@fischer.name"]
 HOMEPAGE = "http://github.com/mfn/gitlab-fogbugz"
@@ -24,7 +24,10 @@ spec = Gem::Specification.new do |s|
   s.executables = ["gitlab-fogbugz-server", "gitlab-fogbugz"]
   
   # Uncomment this to add a dependency
-  s.add_dependency "json", "~> 1.1.2"
+  s.add_dependency "sinatra", "~> 1.3.2"
+  s.add_dependency "json", "~> 1.7.3"
+  s.add_dependency "ruby-fogbugz", "~> 0.1.1"
+  s.add_development_dependency "mocha"
   
   s.require_path = "lib"
 

data/TODO

@@ -1,4 +1,3 @@
 TODO:
-Fix LICENSE with your name
-Fix Rakefile with your name and contact info
-Add your code to lib/<%= name %>.rb
+- Implement FogBugz checkins once GitLab provides this feature
+  (see https://github.com/gitlabhq/gitlabhq/issues/747 )

data/bin/gitlab-fogbugz-server

@@ -5,6 +5,7 @@ require 'sinatra'
 require 'yaml'
 require 'cgi'
 require 'fileutils'
+require 'fogbugz'
 
 $: << File.dirname(__FILE__) + "/../lib"
 require 'fogbugz_service'
@@ -91,15 +92,11 @@ end
 
 post "/authenticate" do
   begin
-    service = FogbugzService.new(config["fb_main_url"], config["curl"])
-    service.connect do
-      token = service.logon(params["email"], params["password"])
-      tokens[params["email"]] = token
-    end
-
+    api = Fogbugz::Interface.new(:email => params["email"], :password => params["password"], :uri => config["fb_main_url"])
+    tokens[ params["email"] ] = api.authenticate
     write_tokens
     redirect "/authenticated"
-  rescue FogbugzService::BadCredentials
+  rescue Fogbugz::AuthenticationException
     "<p>Failed authentication: <strong>#{$!.message}</strong></p>" + AUTH_FORM.call(config['fb_main_url'], params)
   end
 end
@@ -126,7 +123,7 @@ get "/authenticated" do
         <li><tt>implements</tt></li>
         <li><tt>reopens</tt></li>
         <li><tt>references</tt> or <tt>refs</tt><br>Does not change the state of the case, just adds the commit message to this case.</li>
-        <li><tt>resolves</tt><br>Resolves is different then <tt>closes</tt>, <tt>completes</tt>, <tt>fixes</tt> and <tt>implements</tt>: it does not explicitly sets the FogBugz case status, thus changes the case to it's categories default status for resolved cases: Bug -&gt; "fixed", Feature -&gt; "Implemented", Inquirt -&gt; "Responded" and Schedule Item -&gt; "Completed"</li>
+        <li><tt>resolves</tt><br>Resolves is different then <tt>closes</tt>, <tt>completes</tt>, <tt>fixes</tt> and <tt>implements</tt>: it does not explicitly sets the FogBugz case status, thus changes the case to it's categories default status for resolved cases: Bug -&gt; "fixed", Feature -&gt; "Implemented", Inquiry -&gt; "Responded" and Schedule Item -&gt; "Completed"</li>
     </ul>
     <p>NOTE:  FogBugz does not allow closing a case that isn't resolved, so you really must use "Implements X, closes X", or else it won't work.</p>
     <p>Back to <a href="/tokens">Authenticated users</a></p>
@@ -198,7 +195,7 @@ class GitlabFogbugz
     branch = payload["ref"].split('/').last
     
     payload["commits"].each do |c|
-      process_commit(c["id"], c, repo, branch, payload['before'], config['fb_submit_url'], config['curl'])
+      process_commit(c["id"], c, repo, branch, payload['before'])
     end
     
     rescue
@@ -207,16 +204,14 @@ class GitlabFogbugz
       raise
   end
 
-  def submit_to_fogbugz(sha1, commit, token, curl_path)
+  def submit_to_fogbugz(sha1, commit, api)
     listener = FogbugzListener.new(:commit_url => commit["url"], :message => commit["message"], :sha1 => sha1)
     MessageParser.parse(commit["message"], listener)
-    service = FogbugzService.new(config["fb_main_url"], curl_path, token)
-    service.connect do
-      listener.update_fogbugz(service)
-    end
+    service = FogbugzService.new(api)
+    listener.update_fogbugz(service)
   end
 
-  def process_commit(sha1, commit, repo, branch, before, fb_submit_url, curl_path)
+  def process_commit(sha1, commit, repo, branch, before)
     
     # from each commit in the payload, we need to extract:
     # - name of repo, renamed as "gitlab-<repo>"
@@ -229,7 +224,10 @@ class GitlabFogbugz
     author = commit["author"]["email"]
 
     token = tokens[author]
-    submit_to_fogbugz(sha1, commit, token, curl_path) if token
+    raise Exception, "No token available for email '#{author}'" if !token
+    api = Fogbugz::Interface.new(:uri => config["fb_main_url"], :token => token)
+
+    submit_to_fogbugz(sha1, commit, api)
 
     files = commit["removed"] | commit["added"] | commit["modified"]
     files = [] if !files
@@ -247,15 +245,12 @@ class GitlabFogbugz
     # when fogbugz asks for the scm viewer url.
     bug_list.each do |fb_bugzid|
       files.each do |f|
-        fb_repo = CGI.escape("gitlab-#{repo}")
-        fb_r1 = CGI.escape("#{before}")
-        fb_r2 = CGI.escape("#{sha1}")
-        fb_file = CGI.escape("#{branch}/#{f}")
-        
-        #build the GET request, and send it to fogbugz
-        fb_url = "#{fb_submit_url}?ixBug=#{fb_bugzid}&sRepo=#{fb_repo}&sFile=#{fb_file}&sPrev=#{fb_r1}&sNew=#{fb_r2}"
-        puts `#{curl_path} --insecure --silent --output /dev/null '#{fb_url}'`
-
+        # TODO: this is untested code and probably misses the ixRepository
+          # parameter; but since gitlab doesn't expose the filenames yet (as of
+          # 2.6), can't test
+        api.command(:newCheckin, {"ixBug" => fb_bugzid, "sRepo" =>
+                    "gitlab-#{repo}", "sFile" => "#{branch}/#{f}", "sPrev" =>
+                    before, "sNew" => sha1} )
       end
     end
   end

data/config/config.yml.example

@@ -4,14 +4,13 @@
 # Setup your gitlab-fogbugz integration through this configuration file.
 #
 # The URL to the cvsSubmit.[php|asp] file on your server.  This is to add the list of changed files to the cases.
-fb_submit_url:  "http://fogbugz.server.com/cvsSubmit.php"
+# Note: for gitlab-fogbugz this is currently not used; gitlab as of 2.6 lacks
+# the support of file names as part of their post hook
+# fb_submit_url:  "http://fogbugz.server.com/cvsSubmit.php"
 
 # The URL to the root of your FogBugz installation.
 fb_main_url:  "http://fogbugz.server.com/"
 
-# The path to the Curl binary.  Curl is used because of issues with SSL in Ruby's libraries.
-curl: "/usr/bin/curl"
-
 # A list of repositories that are known to your FogBugz installation.
 # Each repository is identified by a name and has 2 values: log_url and diff_url.
 # The repository's name must match the value given in the sRepos field of your FogBugz installation.

data/lib/fogbugz_service.rb

@@ -1,44 +1,9 @@
-require "uri"
-require "rexml/document"
-require "rexml/xpath"
-require "cgi"
+require 'fogbugz'
 
 class FogbugzService
-  class FogbugzError < RuntimeError; end
-  class ClientOutOfDate < FogbugzError; end
-  class BadXml < FogbugzError; end
-  class BadCredentials < FogbugzError; end
 
-  attr_reader :root_uri, :api_uri
-
-  def initialize(root, curl, token=nil)
-    @root_uri = root.respond_to?(:scheme) ? root : URI.parse(root)
-    @curl = curl
-    @token = token
-  end
-
-  def validate!
-    document = get(@root_uri.merge("api.xml"))
-    raise BadXml, "Did not find the expected root response element.  Instead, I found:\n#{document.root}" unless document.root.name == "response"
-
-    minversion = REXML::XPath.first(document.root, "//minversion/text()").to_s
-    raise ClientOutOfDate, "This client expected to find a minversion <= 3 in the api.xml file.  Instead it found #{minversion.inspect}" unless minversion.to_i <= 3
-
-    relative_path = REXML::XPath.first(document.root, "//url/text()")
-    @api_uri = @root_uri.merge(relative_path.to_s)
-  end
-
-  def connect
-    validate!
-    yield self
-  end
-
-  def logon(email, password)
-    params = {"cmd" => "logon", "email" => email, "password" => password}
-    document = get(@api_uri, params)
-    bad_logon = REXML::XPath.first(document.root, "//error")
-    raise BadCredentials, "Bad credentials supplied to Fogbugz: #{bad_logon}" if bad_logon
-    REXML::XPath.first(document.root, "//token/text()").to_s
+  def initialize(api)
+    @api = api
   end
 
   def implement(data)
@@ -76,29 +41,10 @@ class FogbugzService
   end
 
   protected
-  # Returns an REXML::Document to the specified URI
-  def get(uri, params=nil)
-    cmd = if params then
-      query = params.map {|k, v| "#{CGI::escape(k.to_s)}=#{CGI::escape(v.to_s)}"}.join("&")
-      "#{@curl} --data '#{query}' --silent '#{uri.to_s}'"
-    else
-      "#{@curl} --silent '#{uri.to_s}'"
-    end
-
-    puts cmd
-    data = `#{cmd}`
-    begin
-      REXML::Document.new(data)
-    rescue REXML::ParseException
-      raise BadXml, "Could not parse response data:\n#{data}"
-    end
-  end
-
   def tell_fogbugz(operation, data, status=nil)
-    params = {"cmd" => operation.to_s, "ixBug" => data[:case], "sEvent" => data[:message],
-      "token" => @token}
+    params = {"ixBug" => data[:case], "sEvent" => data[:message]}
     params["ixStatus"] = status if status
-    get(@api_uri, params)
+    @api.command(operation, params)
   end
 
   STATES = {:fixed => 2, :completed => 15, :implemented => 8}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-fogbugz
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,6 +13,22 @@ bindir: bin
 cert_chain: []
 date: 2012-07-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.2
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -20,7 +36,23 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 1.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.3
+- !ruby/object:Gem::Dependency
+  name: ruby-fogbugz
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -28,7 +60,23 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Fork of github-fogbugz, a gem that acts as the gateway between GitLab
   and Fogbugz.
 email:
@@ -52,10 +100,7 @@ files:
 - lib/message_parser_machine.rb
 - lib/fogbugz_listener.rb
 - lib/fogbugz_service.rb
-- test/fogbugz_service_logon_test.rb
-- test/fogbugz_service_test.rb
 - test/fogbugz_listener_test.rb
-- test/fogbugz_service_case_editing_test.rb
 - test/message_parser_test.rb
 - test/test_helper.rb
 - config/config.yml.example

data/test/fogbugz_service_case_editing_test.rb

@@ -1,61 +0,0 @@
-require File.dirname(__FILE__) + "/test_helper"
-require "fogbugz_service"
-
-class FogbugzServiceCaseEditingTest < Test::Unit::TestCase
-  TOKEN = "andf09j"
-
-  def setup
-    @service_uri = URI.parse("http://fogbugz.my-service.com/")
-    @service = FogbugzService.new(@service_uri, "/path/to/curl", TOKEN)
-    @service.stubs(:get).returns(REXML::Document.new(VALID_API_RESPONSE))
-    @uri = @service.validate!
-  end
-
-  def test_implement_calls_fogbugz_with_cmd_set_to_resolve_and_status_set_to_implement
-    params = {"cmd" => "resolve", "ixBug" => "2211", "ixStatus" => FogbugzService::STATES[:implemented],
-        "sEvent" => "this is the message", "token" => TOKEN}
-    @service.expects(:get).with(@uri, params).returns(REXML::Document.new(VALID_EDIT_RESPONSE))
-    @service.implement(:case => "2211", :message => "this is the message")
-  end
-
-  def test_fix_calls_fogbugz_with_cmd_set_to_resolve_and_status_set_to_fixed
-    params = {"cmd" => "resolve", "ixBug" => "2211", "ixStatus" => FogbugzService::STATES[:fixed],
-        "sEvent" => "this is the message", "token" => TOKEN}
-    @service.expects(:get).with(@uri, params).returns(REXML::Document.new(VALID_EDIT_RESPONSE))
-    @service.fix(:case => "2211", :message => "this is the message")
-  end
-
-  def test_complete_calls_fogbugz_with_cmd_set_to_resolve_and_status_set_to_completed
-    params = {"cmd" => "resolve", "ixBug" => "2211", "ixStatus" => FogbugzService::STATES[:completed],
-        "sEvent" => "this is the message", "token" => TOKEN}
-    @service.expects(:get).with(@uri, params).returns(REXML::Document.new(VALID_EDIT_RESPONSE))
-    @service.complete(:case => "2211", :message => "this is the message")
-  end
-
-  def test_close_calls_fogbugz_with_cmd_set_to_close
-    params = {"cmd" => "close", "ixBug" => "2211",
-        "sEvent" => "this is the message", "token" => TOKEN}
-    @service.expects(:get).with(@uri, params).returns(REXML::Document.new(VALID_EDIT_RESPONSE))
-    @service.close(:case => "2211", :message => "this is the message")
-  end
-
-  def test_append_message_calls_fogbugz_with_cmd_set_to_edit
-    params = {"cmd" => "edit", "ixBug" => "2211",
-        "sEvent" => "this is the message", "token" => TOKEN}
-    @service.expects(:get).with(@uri, params).returns(REXML::Document.new(VALID_EDIT_RESPONSE))
-    @service.append_message(:case => "2211", :message => "this is the message")
-  end
-
-  VALID_API_RESPONSE = <<-API
-<?xml version="1.0" encoding="UTF-8" ?>
-<response>
-<version>3</version>
-<minversion>1</minversion>
-<url>api.asp?</url>
-</response>
-API
-
-  VALID_EDIT_RESPONSE = <<-API
-  <?xml version="1.0" encoding="UTF-8" ?>
-API
-end

data/test/fogbugz_service_logon_test.rb

@@ -1,47 +0,0 @@
-require File.dirname(__FILE__) + "/test_helper"
-require "fogbugz_service"
-
-class FogbugzServiceLogonTest < Test::Unit::TestCase
-  def setup
-    @service_uri = URI.parse("http://fogbugz.my-service.com/")
-    @service = FogbugzService.new(@service_uri, "/path/to/curl")
-    @service.stubs(:get).returns(REXML::Document.new(VALID_API_RESPONSE))
-    @uri = @service.validate!
-  end
-
-  def test_logon_calls_fogbugz_to_retrieve_token
-    params = {"cmd" => "logon", "email" => "me@my-domain.com", "password" => "my-super-duper-password"}
-    @service.expects(:get).with(@uri, params).returns(REXML::Document.new(VALID_LOGON_RESPONSE))
-    @service.logon("me@my-domain.com", "my-super-duper-password")
-  end
-
-  def test_logon_returns_token
-    @service.stubs(:get).returns(REXML::Document.new(VALID_LOGON_RESPONSE))
-    assert_equal "24dsg34lok43un23", @service.logon("me@my-domain.com", "my-super-duper-password")
-  end
-
-  def test_logon_raises_bad_credentials_when_logon_fails
-    @service.stubs(:get).returns(REXML::Document.new(FAILED_LOGON_RESPONSE))
-    assert_raise FogbugzService::BadCredentials do
-      @service.logon("me@my-domain.com", "my-super-duper-password")
-    end
-  end
-
-  VALID_API_RESPONSE = <<-API
-<?xml version="1.0" encoding="UTF-8" ?>
-<response>
-<version>3</version>
-<minversion>1</minversion>
-<url>api.asp?</url>
-</response>
-  API
-
-  VALID_LOGON_RESPONSE = <<-API
-<?xml version="1.0" encoding="UTF-8" ?>
-<response><token>24dsg34lok43un23</token></response>
-  API
-
-  FAILED_LOGON_RESPONSE = <<-API
-<response><error code="1">Error Message To Show User</error></response>
-  API
-end

data/test/fogbugz_service_test.rb

@@ -1,83 +0,0 @@
-require File.dirname(__FILE__) + "/test_helper"
-require "fogbugz_service"
-
-class FogbugzServiceTest < Test::Unit::TestCase
-  def setup
-    @service_uri = URI.parse("http://fogbugz.my-service.com/")
-    @service = FogbugzService.new(@service_uri, "/path/to/curl")
-  end
-
-  def test_validate_connects_to_fogbugz_and_retrieves_the_api_url
-    @service.expects(:get).with(@service_uri.merge("api.xml")).returns(REXML::Document.new(VALID_API_RESPONSE))
-    @service.validate!
-  end
-
-  def test_validate_parses_response_to_find_url
-    @service.stubs(:get).returns(REXML::Document.new(VALID_API_RESPONSE))
-    @service.validate!
-    assert_equal @service_uri.merge("api.asp?"), @service.api_uri
-  end
-
-  def test_validate_returns_the_api_uri
-    @service.stubs(:get).returns(REXML::Document.new(VALID_API_RESPONSE))
-    assert_equal @service_uri.merge("api.asp?"), @service.validate!
-  end
-
-  def test_validate_raises_if_minimum_version_is_not_one
-    @service.stubs(:get).returns(REXML::Document.new(RECENT_API_RESPONSE))
-    assert_raise(FogbugzService::ClientOutOfDate) do
-      @service.validate!
-    end
-  end
-
-  def test_validate_raises_if_xhtml_returned
-    @service.stubs(:get).returns(REXML::Document.new(VALID_XHTML_RESPONSE))
-    assert_raise(FogbugzService::BadXml) do
-      @service.validate!
-    end
-  end
-
-  def test_validate_does_validation_only_once
-    @service.expects(:get).once.returns(REXML::Document.new(VALID_API_RESPONSE))
-    @service.validate!
-  end
-
-  def test_connect_calls_validate_and_yields
-    @service.expects(:validate!)
-    yielded = false
-    @service.connect do |service|
-      assert_equal service, @service
-      yielded = true
-    end
-
-    assert yielded
-  end
-
-  VALID_API_RESPONSE = <<-API
-    <?xml version="1.0" encoding="UTF-8" ?>
-    <response>
-    <version>3</version>
-    <minversion>1</minversion>
-    <url>api.asp?</url>
-    </response>
-  API
-
-  RECENT_API_RESPONSE = <<-API
-  <?xml version="1.0" encoding="UTF-8" ?>
-   <response>
-    <version>9</version>
-    <minversion>7</minversion>
-    <url>api.asp?</url>
-   </response>
-  API
-
-  VALID_XHTML_RESPONSE = <<-API
-    <html>
-    <head>
-        <title>Fogbugz API</title>
-      </head>
-      <body>
-      </body>
-    </html>
-  API
-end