Merge pull request #96 from BanzaiMan/gh82_atom_feed

Implement Atom feed

lib/travis/api/app/helpers/mime_types.rb

@@ -18,6 +18,10 @@ class Travis::Api::App
       def png?
         request.accept =~ %r(image/png)
       end
+
+      def atom?
+        request.accept =~ %r(application/atom+xml)
+      end
     end
   end
 end

lib/travis/api/app/helpers/respond_with.rb

@@ -49,7 +49,7 @@ class Travis::Api::App
         end
 
         def responders(resource, options)
-          [:Json, :Image, :Xml, :Plain].map do |name|
+          [:Json, :Atom, :Image, :Xml, :Plain].map do |name|
             Responders.const_get(name)
           end
         end

lib/travis/api/app/middleware/rewrite.rb

@@ -3,7 +3,7 @@ require 'travis/api/app'
 class Travis::Api::App
   class Middleware
     class Rewrite < Middleware
-      FORMAT      = %r(\.(json|xml|png|txt)$)
+      FORMAT      = %r(\.(json|xml|png|txt|atom)$)
       V1_REPO_URL = %r(^(/[^/]+/[^/]+(?:/builds(?:/[\d]+)?|/cc)?)$)
 
       helpers :accept
@@ -56,6 +56,10 @@ class Travis::Api::App
           env['travis.format'] == 'xml'
         end
 
+        def atom?
+          env['travis.format'] == 'atom'
+        end
+
         def v1?
           accept_version == 'v1'
         end

lib/travis/api/app/responders.rb

@@ -2,6 +2,7 @@ require 'travis/api/app'
 
 class Travis::Api::App
   module Responders
+    autoload :Atom,    'travis/api/app/responders/atom'
     autoload :Base,    'travis/api/app/responders/base'
     autoload :Image,   'travis/api/app/responders/image'
     autoload :Json,    'travis/api/app/responders/json'

lib/travis/api/app/responders/atom.rb

@@ -0,0 +1,60 @@
+module Travis::Api::App::Responders
+  require 'date'
+
+  class Atom < Base
+    ATOM_FEED_ERB = ERB.new <<-EOF
+<?xml version="1.0" encoding="utf-8"?>
+ 
+<feed xmlns="http://www.w3.org/2005/Atom">
+ 
+  <title><%= resource.first.repository.slug %> Builds</title>
+  <link href="<%= endpoint.url %>" type="application/atom+xml" rel = "self" />
+  <id>repo:<%= resource.first.repository.id %></id>
+  <rights>Copyright (c) <%= DateTime.now.strftime("%Y") %> Travis CI GmbH</rights>
+  <updated><%= DateTime.now.rfc3339 %></updated>
+ 
+  <% resource.each  do |build| %>
+  <entry>
+    <title><%= build.repository.slug %> Build #<%= build.number %></title>
+    <link href="<%= File.join("https://", Travis.config.host, build.repository.slug, "builds", build.id.to_s) %>" />
+    <id>repo:<%= build.repository.id %>:build:<%= build.id %></id>
+    <updated><%= ::DateTime.parse(build.updated_at.to_s).rfc3339 %></updated>
+    <summary type="html">
+    &lt;p&gt;
+      <%= build.commit.message.encode(:xml => :text) %> (<%= build.commit.committer_name %>)
+      &lt;br/&gt;&lt;br/&gt;
+      State: <%= build.state %>
+      &lt;br/&gt;
+      Started at: <%= build.started_at ? build.started_at : 'not started' %>
+      &lt;br/&gt;
+      Finished at: <%= build.finished_at ? build.finished_at :
+        build.started_at ? 'still running' : 'not started' %>
+    &lt;/p&gt;
+    </summary>
+    <author>
+      <name><%= build.commit.committer_name %></name>
+    </author>
+  </entry>
+  <% end  %>
+ 
+</feed>
+    EOF
+
+    def apply?
+      super && resource.is_a?(ActiveRecord::Relation) && resource.first.is_a?(Build)
+    end
+
+    def apply
+      super
+
+      ATOM_FEED_ERB.result(binding)
+    end
+
+    private
+
+    def content_type
+      'application/atom+xml;charset=utf-8'
+    end
+
+  end
+end

spec/integration/v1/repositories_spec.rb

@@ -95,4 +95,20 @@ describe 'v1 repos' do
       get('/svenfuchs/minimal.png?branch=foo,bar').should deliver_result_image_for('passing')
     end
   end
+
+  context 'with "Accept: application/atom+xml" header' do
+    let(:headers) { { 'HTTP_ACCEPT' => 'application/atom+xml' } }
+    it 'GET /repositories/svenfuchs/minimal/builds' do
+      response = get '/repositories/svenfuchs/minimal/builds', {}, headers
+      response.content_type.should =~ /^application\/atom\+xml/
+    end
+  end
+
+  context 'with .atom extension and "Accept: */*" header' do
+    let(:headers) { { 'HTTP_ACCEPT' => '*/*' } }
+    it 'GET /repositories/svenfuchs/minimal/builds.atom' do
+      response = get '/repositories/svenfuchs/minimal/builds.atom', {}, headers
+      response.content_type.should =~ /^application\/atom\+xml/
+    end
+  end
 end

spec/integration/v2/repositories_spec.rb

@@ -139,4 +139,20 @@ describe 'Repos' do
       result.should deliver_result_image_for('passing')
     end
   end
+
+  context 'with "Accept: application/atom+xml" header' do
+    let(:headers) { { 'HTTP_ACCEPT' => 'application/atom+xml' } }
+    it 'GET /repositories/svenfuchs/minimal/builds' do
+      response = get '/repositories/svenfuchs/minimal/builds', {}, headers
+      response.content_type.should =~ /^application\/atom\+xml/
+    end
+  end
+
+  context 'with .atom extension' do
+    let(:headers) { { 'HTTP_ACCEPT' => '*/*' } }
+    it 'GET /repositories/svenfuchs/minimal/builds.atom' do
+      response = get '/repositories/svenfuchs/minimal/builds.atom', {}, headers
+      response.content_type.should =~ /^application\/atom\+xml/
+    end
+  end
 end

travis-api.gemspec

@@ -22,7 +22,8 @@ Gem::Specification.new do |s|
     "Nick Schonning",
     "Patrick Williams",
     "James Dennes",
-    "Tim Carey-Smith"
+    "Tim Carey-Smith",
+    "Hiro Asari"
   ]
 
   s.email = [
@@ -135,6 +136,7 @@ Gem::Specification.new do |s|
     "lib/travis/api/app/middleware/rewrite.rb",
     "lib/travis/api/app/middleware/scope_check.rb",
     "lib/travis/api/app/responders.rb",
+    "lib/travis/api/app/responders/atom.rb",
     "lib/travis/api/app/responders/base.rb",
     "lib/travis/api/app/responders/image.rb",
     "lib/travis/api/app/responders/json.rb",