Merge pull request #391 from alphagov/update-api

Some tweaks to the API

Author: alanth

app/controllers/archived/petitions_controller.rb

@@ -1,13 +1,28 @@
 class Archived::PetitionsController < ApplicationController
+  respond_to :html, :json
+
+  before_action :fetch_petitions, only: [:index]
+  before_action :fetch_petition, only: [:show]
+
   def index
+    respond_with(@petitions)
+  end
+
+  def show
+    respond_with(@petition)
+  end
+
+  private
+
+  def fetch_petitions
     if params[:q].blank?
       @petitions = ArchivedPetition.search(params.merge({state: 'by_most_signatures'}))
     else
       @petitions = ArchivedPetition.search(params)
     end
   end
 
-  def show
+  def fetch_petition
     @petition = ArchivedPetition.find(params[:id])
   end
 end

app/presenters/petition_csv_presenter.rb

@@ -36,8 +36,8 @@ def self.attributes
   def self.timestamps
     [
       :created_at, :updated_at, :open_at, :closed_at, :government_response_at, :scheduled_debate_date,
-      :debate_threshold_reached_at, :rejected_at, :debate_outcome_at, :moderation_threshold_reached_at,
-      :government_response_created_at, :government_response_updated_at
+      :response_threshold_reached_at, :debate_threshold_reached_at, :rejected_at, :debate_outcome_at,
+      :moderation_threshold_reached_at, :government_response_created_at, :government_response_updated_at
     ]
   end
 

app/views/archived/petitions/_petition.json.jbuilder

@@ -0,0 +1,33 @@
+json.type "archived-petition"
+json.id petition.id
+
+json.links do
+  json.self archived_petition_url(petition, format: params[:format])
+end if defined?(is_collection)
+
+json.attributes do
+  json.title petition.title
+  json.description petition.description
+  json.state petition.state
+  json.signature_count petition.signature_count
+  json.opened_at api_date_format(petition.opened_at)
+  json.closed_at api_date_format(petition.closed_at)
+  json.created_at api_date_format(petition.created_at)
+  json.updated_at api_date_format(petition.updated_at)
+
+  if petition.rejected?
+    json.rejection do
+      json.details petition.reason_for_rejection
+    end
+  else
+    json.rejection nil
+  end
+
+  if petition.response?
+    json.government_response do
+      json.details petition.response
+    end
+  else
+    json.government_response nil
+  end
+end

app/views/archived/petitions/index.json.jbuilder

@@ -0,0 +1,8 @@
+json.links do
+  json.self request.url
+  json.merge! ApiPaginationLinksPresenter.new(@petitions).serialize
+end
+
+json.data @petitions do |petition|
+  json.partial! 'petition', petition: petition, is_collection: true
+end

app/views/archived/petitions/show.json.jbuilder

@@ -0,0 +1,9 @@
+json.cache! @petition, expires_in: 5.minutes do
+  json.links do
+    json.self request.url
+  end
+
+  json.data do
+    json.partial! 'petition', petition: @petition
+  end
+end

app/views/petitions/_petition.json.jbuilder

@@ -22,6 +22,7 @@ json.attributes do
   json.rejected_at api_date_format(petition.rejected_at)
   json.debate_outcome_at api_date_format(petition.debate_outcome_at)
   json.moderation_threshold_reached_at api_date_format(petition.moderation_threshold_reached_at)
+  json.response_threshold_reached_at api_date_format(petition.response_threshold_reached_at)
 
   if petition.open?
     json.creator_name petition.creator_name

app/views/petitions/show.json.jbuilder

@@ -1,7 +1,9 @@
-json.links do
-  json.self request.url
-end
+json.cache! @petition, expires_in: 5.minutes do
+  json.links do
+    json.self request.url
+  end
 
-json.data do
-  json.partial! 'petition', petition: @petition
+  json.data do
+    json.partial! 'petition', petition: @petition
+  end
 end

spec/presenters/petition_csv_presenter_spec.rb

@@ -54,6 +54,7 @@ def csvd_petition(petition)
       timestampify(petition.closed_at),
       timestampify(petition.government_response_at),
       datestampify(petition.scheduled_debate_date),
+      timestampify(petition.response_threshold_reached_at),
       timestampify(petition.debate_threshold_reached_at),
       timestampify(petition.rejected_at),
       timestampify(petition.debate_outcome_at),