janky 0.9.0 → 0.9.9

data/CHANGES

@@ -1,3 +1,33 @@
+= 0.9.9 / Not yet released
+
+ * HipChat support [Justin Smestad, Seth Chisamore, Simon Rozet]
+
+ * Support for GitHub Enterprise. [Dusty Burwell, Simon Rozet]
+
+ * Support for GitHub logins containing dashes. [Thom May]
+
+ * Support for branches containing slashes in their name. [Andres Torres]
+
+ * Respond with proper status code to invalid Jenkins notification
+   requests. [Chris Mytton]
+
+ * Support for Jenkins servers running behind SSL. [Vivek Pandey,
+   Gavin Heavyside, Thom May]
+
+ * Support for Jenkins servers running under a path [Piet Jaspers]
+
+ * Deprecate JANKY_CAMPFIRE_ACCOUNT. Please use JANKY_CHAT_CAMPFIRE_ACCOUNT
+   instead. [Simon Rozet]
+
+ * Deprecate JANKY_CAMPFIRE_TOKEN. Please use JANKY_CHAT_CAMPFIRE_TOKEN
+   instead. [Simon Rozet]
+
+ * Deprecate JANKY_CAMPFIRE_DEFAULT_ROOM. Please use
+   JANKY_CHAT_DEFAULT_ROOM instead. [Simon Rozet]
+
+ * Both JANKY_BASE_URL and JANKY_DEFAULT_BUILDER now require a trailing
+   slash. [Simon Rozet]
+
 = 0.9 / 2011-12-19
 
  * Initial public release.

data/README.md

@@ -5,7 +5,7 @@ This is Janky, a continuous integration server built on top of
 [Jenkins][], controlled by [Hubot][], and designed for [GitHub][].
 
 * **Built on top of Jenkins.** The power, vast amount of plugins and large
-  communauty of the popular CI server all wrapped up in a great experience.
+  community of the popular CI server all wrapped up in a great experience.
 
 * **Controlled by Hubot.** Day to day operations are exposed as simple
   Hubot commands that the whole team can use.
@@ -52,7 +52,7 @@ available rooms:
 
 Then pick one:
 
-    hubot ci set janky room The Serious Room
+    hubot ci set room janky The Serious Room
 
 Get the status of a build:
 
@@ -86,21 +86,24 @@ instructions and install the [Notification Plugin][np] version 1.4.
 
 Janky is designed to be deployed to [Heroku](https://heroku.com).
 
-Grab all the necessary files from [this gist][gist]:
+Grab all the necessary files from [the gist][gist]:
 
-    $ git clone gist://gist.github.com/123 janky
+    $ git clone git://gist.github.com/1497335 janky
 
 Then push up it to a new Heroku app:
 
     $ cd janky
     $ heroku create --stack cedar
+    $ bundle install
+    $ git add Gemfile.lock
+    $ git commit Gemfile.lock -m "lock bundle"
     $ git push heroku master
 
-After configuration the app (see below), create the database:
+After configuring the app (see below), create the database:
 
     $ heroku run rake db:migrate
 
-[gist]: https://gist.github.com/gist/1234
+[gist]: https://gist.github.com/1497335
 
 ### Configuring
 
@@ -111,10 +114,11 @@ command:
 
 Required settings:
 
-* `JANKY_BASE_URL`: The application URL with a trailing slash. Example:
+* `JANKY_BASE_URL`: The application URL **with** a trailing slash. Example:
   `http://mf-doom-42.heroku.com/`.
-* `JANKY_BUILDER_DEFAULT`: The Jenkins server URL with a trailing slash.
-   Example: `http://jenkins.example.com/`.
+* `JANKY_BUILDER_DEFAULT`: The Jenkins server URL **with** a trailing slash.
+   Example: `http://jenkins.example.com/`. For basic auth, include the
+   credentials in the URL: `http://user:pass@jenkins.example.com/`.
 * `JANKY_CONFIG_DIR`: Directory where build config templates are stored.
   Typically set to `/app/config` on Heroku.
 * `JANKY_HUBOT_USER`: Login used to protect the Hubot API.
@@ -124,11 +128,45 @@ Required settings:
 * `JANKY_GITHUB_PASSWORD`: The password for the GitHub user.
 * `JANKY_GITHUB_HOOK_SECRET`: Secret used to sign hook requests from
   GitHub.
-* `JANKY_CAMPFIRE_ACCOUNT`: The name of your Campfire account.
-* `JANKY_CAMPFIRE_TOKEN`: The authentication token of the user sending
+* `JANKY_CHAT_DEFAULT_ROOM`: Chat room where notifications are sent by default.
+
+#### GitHub Enterprise
+
+Using Janky with [GitHub Enterprise][ghe] requires one extra setting:
+
+* `JANKY_GITHUB_API_URL`: Full API URL of the instance, *with* a trailing
+  slash. Example: `https://github.example.com/api/v3/`.
+
+[ghe]: https://enterprise.github.com
+
+### Chat Notification
+
+#### Campfire
+Janky notifies [Campfire][] chat rooms by default. Required settings:
+
+* `JANKY_CHAT_CAMPFIRE_ACCOUNT`: account name.
+* `JANKY_CHAT_CAMPFIRE_TOKEN`: authentication token for the user sending
   build notifications.
-* `JANKY_CAMPFIRE_DEFAULT_ROOM`: The name of the room where notifications
-  are sent by default. Example: "Builds".
+
+[Campfire]: http://campfirenow.com/
+
+#### HipChat
+
+Required settings:
+
+* `JANKY_CHAT=hipchat`
+* `JANKY_CHAT_HIPCHAT_TOKEN`: authentication token
+* `JANKY_CHAT_HIPCHAT_FROM`: name that messages will appear be sent from.
+  Defaults to `CI`.
+
+Installation:
+
+* Add `require "janky/chat_service/hipchat"` to the `config.ru` file.
+* `echo 'gem "hipchat", "~>0.4" >> Gemfile'`
+* `bundle`
+* `git commit -am "install hipchat"`
+
+### Authentication
 
 To restrict access to members of a GitHub organization, [register a new
 OAuth application on GitHub](https://github.com/account/applications)
@@ -143,10 +181,10 @@ a few extra settings:
 
 ### Hubot
 
-Install the [ci script](http://git.io/hubot-ci-master) in your Hubot
+Install the [janky script](http://git.io/hubot-janky) in your Hubot
 then set the `HUBOT_JANKY_URL` environment variable. Example:
 `http://user:secret@janky.example.com/_hubot/`, with user and password
-replaced by `JANKY_HUBOT_USER` and `JANKY_HUBOT_PASSWORD` repectively.
+replaced by `JANKY_HUBOT_USER` and `JANKY_HUBOT_PASSWORD` respectively.
 
 ### Custom Build Configuration
 
@@ -168,6 +206,10 @@ server.
 Hacking
 -------
 
+Get your environment up and running:
+
+    $ script/bootstrap
+
 Create the databases:
 
     $ mysqladmin -uroot create janky_development
@@ -178,10 +220,6 @@ Create the tables:
     $ RACK_ENV=development bin/rake db:migrate
     $ RACK_ENV=test bin/rake db:migrate
 
-Get your environment up and running:
-
-    $ script/boostrap
-
 Seed some data into the development database:
 
     $ bin/rake db:seed
@@ -196,7 +234,7 @@ Open the app:
 
 Run the test suite:
 
-    $ ruby test/janky_spec.rb
+    $ bin/rake
 
 Contributing
 ------------
@@ -207,5 +245,5 @@ send a Pull Request.
 Copying
 -------
 
-Copyright © 2011, GitHub, Inc. See the `COPYING` file for license
+Copyright © 2011-2012, GitHub, Inc. See the `COPYING` file for license
 rights and limitations (MIT).

data/Rakefile

@@ -17,3 +17,10 @@ task "db:seed" do
     loader.read Zlib::GzipReader.open(dump)
   end
 end
+
+require "rake/testtask"
+Rake::TestTask.new(:test) do |t|
+  t.test_files = FileList["test/*_test.rb"]
+  t.ruby_opts << '-Itest -Ilib'
+end
+task :default => :test

data/janky.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new "janky", Janky::VERSION do |s|
   s.add_dependency "sinatra", "~>1.3"
   s.add_dependency "sinatra_auth_github", "~>0.1.5"
   s.add_dependency "mustache", "~>0.11"
-  s.add_dependency "yajl-ruby", "~>0.8"
+  s.add_dependency "yajl-ruby", "~>1.1.0"
   s.add_dependency "activerecord", "~>3.1.0"
   s.add_dependency "broach", "~>0.2"
   s.add_dependency "replicate", "~>1.4"
@@ -46,8 +46,10 @@ lib/janky/builder/mock.rb
 lib/janky/builder/payload.rb
 lib/janky/builder/receiver.rb
 lib/janky/builder/runner.rb
-lib/janky/campfire.rb
-lib/janky/campfire/mock.rb
+lib/janky/chat_service.rb
+lib/janky/chat_service/campfire.rb
+lib/janky/chat_service/hipchat.rb
+lib/janky/chat_service/mock.rb
 lib/janky/commit.rb
 lib/janky/database/migrate/1312115512_init.rb
 lib/janky/database/migrate/1312117285_non_unique_repo_uri.rb
@@ -72,7 +74,7 @@ lib/janky/helpers.rb
 lib/janky/hubot.rb
 lib/janky/job_creator.rb
 lib/janky/notifier.rb
-lib/janky/notifier/campfire.rb
+lib/janky/notifier/chat_service.rb
 lib/janky/notifier/mock.rb
 lib/janky/notifier/multi.rb
 lib/janky/public/css/base.css

data/lib/janky.rb

@@ -33,12 +33,14 @@ require "janky/builder/http"
 require "janky/builder/mock"
 require "janky/builder/payload"
 require "janky/builder/receiver"
-require "janky/campfire"
+require "janky/chat_service"
+require "janky/chat_service/campfire"
+require "janky/chat_service/mock"
 require "janky/exception"
 require "janky/notifier"
+require "janky/notifier/chat_service"
 require "janky/notifier/mock"
 require "janky/notifier/multi"
-require "janky/notifier/campfire"
 require "janky/app"
 require "janky/views/layout"
 require "janky/views/index"
@@ -53,9 +55,9 @@ module Janky
 
   # Setup the application, including the database and Jenkins connections.
   #
-  # settings - Hash of app settings. Typically ENV but any object responding
-  #            to #[] is valid. See required_settings for required keys.
-  #            The RACK_ENV setting is always required.
+  # settings - Hash of app settings. Typically ENV but any object that responds
+  #            to #[], #[]= and #each is valid. See required_settings for
+  #            required keys. The RACK_ENV key is always required.
   #
   # Raises an Error when required settings are missing.
   # Returns nothing.
@@ -75,13 +77,20 @@ module Janky
 
     if env != "production"
       settings["DATABASE_URL"] ||= "mysql2://root@localhost/janky_#{env}"
-      settings["JANKY_BASE_URL"] ||= "http://localhost:9393"
+      settings["JANKY_BASE_URL"] ||= "http://localhost:9393/"
       settings["JANKY_BUILDER_DEFAULT"] ||= "http://localhost:8080/"
       settings["JANKY_CONFIG_DIR"] ||= File.dirname(__FILE__)
+      settings["JANKY_CHAT"] = "campfire"
+      settings["JANKY_CHAT_CAMPFIRE_ACCOUNT"] = "account"
+      settings["JANKY_CHAT_CAMPFIRE_TOKEN"] = "token"
     end
 
     database = URI(settings["DATABASE_URL"])
     adapter  = database.scheme == "postgres" ? "postgresql" : database.scheme
+    if settings["JANKY_BASE_URL"][-1] != ?/
+      warn "JANKY_BASE_URL must have a trailing slash"
+      settings["JANKY_BASE_URL"] = settings["JANKY_BASE_URL"] + "/"
+    end
     base_url = URI(settings["JANKY_BASE_URL"]).to_s
 
     ActiveRecord::Base.establish_connection(
@@ -99,16 +108,32 @@ module Janky
     end
 
     # Setup the callback URL of this Janky host.
-    Janky::Builder.setup(base_url + "/_builder")
+    Janky::Builder.setup(base_url + "_builder")
 
     # Setup the default Jenkins build host
+    if settings["JANKY_BUILDER_DEFAULT"][-1] != ?/
+      raise Error, "JANKY_BUILDER_DEFAULT must have a trailing slash"
+    end
     Janky::Builder[:default] = settings["JANKY_BUILDER_DEFAULT"]
 
+    if settings.key?("JANKY_GITHUB_API_URL")
+      api_url  = settings["JANKY_GITHUB_API_URL"]
+      git_host = URI(api_url).host
+    else
+      api_url = "https://api.github.com/"
+      git_host = "github.com"
+    end
+    if api_url[-1] != ?/
+      raise Error, "JANKY_GITHUB_API_URL must have a trailing slash"
+    end
+    hook_url = base_url + "_github"
     Janky::GitHub.setup(
       settings["JANKY_GITHUB_USER"],
       settings["JANKY_GITHUB_PASSWORD"],
       settings["JANKY_GITHUB_HOOK_SECRET"],
-      base_url + "/_github"
+      hook_url,
+      api_url,
+      git_host
     )
 
     if settings.key?("JANKY_SESSION_SECRET")
@@ -132,15 +157,38 @@ module Janky
       :password => settings["JANKY_HUBOT_PASSWORD"]
     )
 
-    Janky::Campfire.setup(
-      settings["JANKY_CAMPFIRE_ACCOUNT"],
-      settings["JANKY_CAMPFIRE_TOKEN"],
-      settings["JANKY_CAMPFIRE_DEFAULT_ROOM"]
-    )
+    Janky::Exception.setup(Janky::Exception::Logger.new($stderr))
+
+    if campfire_account = settings["JANKY_CAMPFIRE_ACCOUNT"]
+      warn "JANKY_CAMPFIRE_ACCOUNT is deprecated. Please use " \
+        "JANKY_CHAT_CAMPFIRE_ACCOUNT instead."
+      settings["JANKY_CHAT_CAMPFIRE_ACCOUNT"] ||=
+        settings["JANKY_CAMPFIRE_ACCOUNT"]
+    end
+
+    if campfire_token = settings["JANKY_CAMPFIRE_TOKEN"]
+      warn "JANKY_CAMPFIRE_TOKEN is deprecated. Please use " \
+        "JANKY_CHAT_CAMPFIRE_TOKEN instead."
+      settings["JANKY_CHAT_CAMPFIRE_TOKEN"] ||=
+        settings["JANKY_CAMPFIRE_ACCOUNT"]
+    end
 
-    Janky::Exception.setup(Janky::Exception::Mock)
+    chat_name = settings["JANKY_CHAT"] || "campfire"
+    chat_settings = {}
+    settings.each do |key, value|
+      if key =~ /^JANKY_CHAT_#{chat_name.upcase}_/
+        chat_settings[key] = value
+      end
+    end
+    chat_room = settings["JANKY_CHAT_DEFAULT_ROOM"] ||
+      settings["JANKY_CAMPFIRE_DEFAULT_ROOM"]
+    if settings["JANKY_CAMPFIRE_DEFAULT_ROOM"]
+      warn "JANKY_CAMPFIRE_DEFAULT_ROOM is deprecated. Please use " \
+        "JANKY_CHAT_DEFAULT_ROOM instead."
+    end
+    ChatService.setup(chat_name, chat_settings, chat_room)
 
-    Notifier.setup(Notifier::Campfire)
+    Notifier.setup(Notifier::ChatService)
   end
 
   # List of settings required in production.
@@ -152,8 +200,7 @@ module Janky
       JANKY_BUILDER_DEFAULT
       JANKY_CONFIG_DIR
       JANKY_GITHUB_USER JANKY_GITHUB_PASSWORD JANKY_GITHUB_HOOK_SECRET
-      JANKY_HUBOT_USER JANKY_HUBOT_PASSWORD
-      JANKY_CAMPFIRE_ACCOUNT JANKY_CAMPFIRE_TOKEN JANKY_CAMPFIRE_DEFAULT_ROOM]
+      JANKY_HUBOT_USER JANKY_HUBOT_PASSWORD]
   end
 
   # Directory where Jenkins job configuration templates are located.
@@ -171,7 +218,7 @@ module Janky
     Janky::Builder.enable_mock!
     Janky::GitHub.enable_mock!
     Janky::Notifier.enable_mock!
-    Janky::Campfire.enable_mock!
+    Janky::ChatService.enable_mock!
     Janky::App.disable :github_team_id
   end
 
@@ -183,10 +230,10 @@ module Janky
     Janky::Builder.reset!
   end
 
-  # The Janky Rack application, assembled from four apps. Exceptions
-  # raised during the request cycle are caught by the Exception
-  # middleware which typically report exceptions to an external
-  # service before re-raising the exception.
+  # The Janky Rack application, assembled from four apps. Exceptions raised
+  # during the request cycle are caught by the Exception middleware which
+  # typically reports them to an external service before re-raising the
+  # exception.
   #
   # Returns a memoized Rack application.
   def self.app
@@ -221,4 +268,16 @@ module Janky
       end
     }
   end
+
+  # Register a Chat service implementation.
+  #
+  # name    - Service name as a String, e.g. "irc".
+  # service - Constant for the implementation.
+  #
+  # Returns nothing.
+  def self.register_chat_service(name, service)
+    Janky::ChatService.adapters[name] = service
+  end
+
+  register_chat_service "campfire", ChatService::Campfire
 end

data/lib/janky/app.rb

@@ -58,7 +58,7 @@ module Janky
       mustache :index
     end
 
-    get "/:repo_name/:branch" do |repo_name, branch|
+    get %r{\/([-_\.0-9a-zA-Z]+)\/([-_\.a-zA-z0-9\/]+)} do |repo_name, branch|
       repo = find_repo(repo_name)
       authorize_repo(repo)
 

data/lib/janky/build.rb

@@ -180,7 +180,7 @@ module Janky
     # Returns the String room name.
     def room_name
       if room_id && room_id > 0
-        Campfire.room_name(room_id)
+        ChatService.room_name(room_id)
       end
     end
 
@@ -212,6 +212,14 @@ module Janky
       commit.url
     end
 
+    def commit_message
+      commit.message
+    end
+
+    def commit_author
+      commit.author
+    end
+
     def number
       id.to_s
     end