Agile Web Development with Rails, Edition 4

13.1 Iteration H1: Email Notifications 12.2 Iteration G2: Atom Feeds

12.4 Playtime

Add the xml format to the controller

edit app/controllers/products_controller.rb

  def who_bought

    @product = Product.find(params[:id])

    @latest_order = @product.orders.order(:updated_at).last

    if stale?(:etag => @latest_order, :last_modified => @latest_order.created_at.utc)

      respond_to do |format|

        format.xml { render :xml => @product }

        format.atom

end

end

end

Fetch the XML, see that there are no orders there

curl --max-time 15 --silent --user dave:secret http://localhost:3000/products/2/who_bought.atom

<?xml version="1.0" encoding="UTF-8"?>

<feed xml:lang="en-US" xmlns="http://www.w3.org/2005/Atom">

  <id>tag:localhost,2005:/products/2/who_bought</id>

  <link type="text/html" rel="alternate" href="http://localhost:3000"/>

  <link type="application/atom+xml" rel="self" href="http://localhost:3000/products/2/who_bought.atom"/>

  <title>Who bought CoffeeScript</title>

  <updated>2014-02-04T19:51:00Z</updated>

  <entry>

    <id>tag:localhost,2005:Order/1</id>

    <published>2014-02-04T19:51:00Z</published>

    <updated>2014-02-04T19:51:00Z</updated>

    <link type="text/html" rel="alternate" href="http://localhost:3000/orders/1"/>

    <title>Order 1</title>

    <summary type="xhtml">

      <div xmlns="http://www.w3.org/1999/xhtml">

        <p>Shipped to 123 Main St</p>

        <table>

          <tr>

            <th>Product</th>

            <th>Quantity</th>

            <th>Total Price</th>

          </tr>

          <tr>

            <td>CoffeeScript</td>

            <td>1</td>

            <td>$36.00</td>

          </tr>

          <tr>

            <th colspan="2">total</th>

            <th>$36.00</th>

          </tr>

        </table>

        <p>Paid by Check</p>

      </div>

    </summary>

    <author>

      <name>Dave Thomas</name>

      <email>customer@example.com</email>

    </author>

  </entry>

</feed>

Include "orders" in the response

edit app/controllers/products_controller.rb

  def who_bought

    @product = Product.find(params[:id])

    @latest_order = @product.orders.order(:updated_at).last

    if stale?(:etag => @latest_order, :last_modified => @latest_order.created_at.utc)

      respond_to do |format|

        format.xml { render :xml => @product.to_xml(:include => :orders) }

        format.atom

end

end

end

Fetch the xml, see that the orders are included

curl --max-time 15 --silent --user dave:secret http://localhost:3000/products/2/who_bought.xml

<?xml version="1.0" encoding="UTF-8"?>

<product>

  <created-at type="datetime">2014-02-04T19:49:22Z</created-at>

  <description>&lt;p&gt;

        CoffeeScript is JavaScript done right. It provides all of JavaScript's

	functionality wrapped in a cleaner, more succinct syntax. In the first

	book on this exciting new language, CoffeeScript guru Trevor Burnham

	shows you how to hold onto all the power and flexibility of JavaScript

	while writing clearer, cleaner, and safer code.

      &lt;/p&gt;</description>

  <price type="decimal">36.0</price>

  <updated-at type="datetime">2014-02-04T19:49:22Z</updated-at>

  <image-url>/images/cs.jpg</image-url>

  <title>CoffeeScript</title>

  <id type="integer">2</id>

  <orders type="array">

    <order>

      <name>Dave Thomas</name>

      <created-at type="datetime">2014-02-04T19:51:00Z</created-at>

      <address>123 Main St</address>

      <pay-type>Check</pay-type>

      <email>customer@example.com</email>

      <updated-at type="datetime">2014-02-04T19:51:00Z</updated-at>

      <id type="integer">1</id>

    </order>

  </orders>

</product>

Define an HTML view

edit app/views/products/who_bought.html.erb

<h3>People Who Bought <%= @product.title %></h3>

<ul>

  <% for order in @product.orders %>

    <li>

      <%= mail_to order.email, order.name %>

    </li>

  <% end %>

</ul>

Add the html format to the controller

edit app/controllers/products_controller.rb

  def who_bought

    @product = Product.find(params[:id])

    @latest_order = @product.orders.order(:updated_at).last

    if stale?(:etag => @latest_order, :last_modified => @latest_order.created_at.utc)

      respond_to do |format|

        format.html

        format.xml { render :xml => @product.to_xml(:include => :orders) }

        format.atom

end

end

end

See the (raw) HTML

curl --max-time 15 --silent --user dave:secret http://localhost:3000/products/2/who_bought

<!-- START:head -->

<!DOCTYPE html>

<html>

<head>

  <title>Pragprog Books Online Store</title>

  <link data-turbolinks-track="true" href="/stylesheets/depot.css?1391543456" media="all" rel="stylesheet" type="text/css" />

  <script data-turbolinks-track="true" src="/javascripts/depot.js" type="text/javascript"></script>

  <meta name="csrf-param" content="authenticity_token"/>

<meta name="csrf-token" content="1fFQNwRGbUx4nCqTQTihLTfqviGzB7BTm+7MY914BA4="/>

</head>

<!-- END:head -->

<body class="products">

  <div id="banner">

    <img alt="Logo" src="/images/logo.png?1391543361" />

    Pragmatic Bookshelf

  </div>

  <div id="columns">

    <div id="side">

<!-- START_HIGHLIGHT -->

      <!-- START:hidden_div -->

<!-- START_HIGHLIGHT -->

<!-- END_HIGHLIGHT -->

    <!-- END:hidden_div -->

<!-- END_HIGHLIGHT -->

      <ul>

        <li><a href="http://www....">Home</a></li>

        <li><a href="http://www..../faq">Questions</a></li>

        <li><a href="http://www..../news">News</a></li>

        <li><a href="http://www..../contact">Contact</a></li>

      </ul>

    </div>

    <div id="main">

      <h3>People Who Bought CoffeeScript</h3>

<ul>

    <li>

      <a href="mailto:customer@example.com">Dave Thomas</a>

    </li>

</ul>

    </div>

  </div>

</body>

</html>

Anything that XML can do, JSON can too...

edit app/controllers/products_controller.rb

  def who_bought

    @product = Product.find(params[:id])

    @latest_order = @product.orders.order(:updated_at).last

    if stale?(:etag => @latest_order, :last_modified => @latest_order.created_at.utc)

      respond_to do |format|

        format.html

        format.xml { render :xml => @product.to_xml(:include => :orders) }

        format.atom

        format.json { render :json => @product.to_json(:include => :orders) }

end

end

end

Fetch the data in JSON format

curl --max-time 15 --silent --user dave:secret http://localhost:3000/products/2/who_bought.json

{"product":{"created_at":"2014-02-04T19:49:22Z","description":"<p>\n        CoffeeScript is JavaScript done right. It provides all of JavaScript's\n\tfunctionality wrapped in a cleaner, more succinct syntax. In the first\n\tbook on this exciting new language, CoffeeScript guru Trevor Burnham\n\tshows you how to hold onto all the power and flexibility of JavaScript\n\twhile writing clearer, cleaner, and safer code.\n      </p>","price":"36.0","updated_at":"2014-02-04T19:49:22Z","image_url":"/images/cs.jpg","title":"CoffeeScript","id":2,"orders":[{"name":"Dave Thomas","created_at":"2014-02-04T19:51:00Z","pay_type":"Check","address":"123 Main St","updated_at":"2014-02-04T19:51:00Z","email":"customer@example.com","id":1}]}}

Customize the xml

edit app/views/products/who_bought.xml.builder

xml.order_list(:for_product => @product.title) do

  for o in @product.orders

    xml.order do

      xml.name(o.name)

      xml.email(o.email)

end

end

end

Change the rendering to use templates

edit app/controllers/products_controller.rb

  def who_bought

    @product = Product.find(params[:id])

    @latest_order = @product.orders.order(:updated_at).last

    if stale?(:etag => @latest_order, :last_modified => @latest_order.created_at.utc)

      respond_to do |format|

        format.html

        format.xml

        format.atom

        format.json { render :json => @product.to_json(:include => :orders) }

end

end

end

Fetch the (much streamlined) XML

curl --max-time 15 --silent --user dave:secret http://localhost:3000/products/2/who_bought.xml

<order_list for_product="CoffeeScript">

  <order>

    <name>Dave Thomas</name>

    <email>customer@example.com</email>

  </order>

</order_list>

Verify that the tests still pass

rake test

Loaded suite /home/rubys/.rvm/gems/ruby-1.8.7-p374/gems/rake-10.1.1/lib/rake/rake_test_loader

Started

[deprecated] I18n.enforce_available_locales will default to true in the future. If you really want to skip validation of your locale you can set I18n.enforce_available_locales = false to avoid this message.

.........

Finished in 0.284988 seconds.

9 tests, 30 assertions, 0 failures, 0 errors

Loaded suite /home/rubys/.rvm/gems/ruby-1.8.7-p374/gems/rake-10.1.1/lib/rake/rake_test_loader

Started

[deprecated] I18n.enforce_available_locales will default to true in the future. If you really want to skip validation of your locale you can set I18n.enforce_available_locales = false to avoid this message.

.................................

Finished in 0.649835 seconds.

33 tests, 55 assertions, 0 failures, 0 errors

Commit

git commit -a -m "Orders"

[master e3a306f] Orders

 5 files changed, 79 insertions(+), 21 deletions(-)

git tag iteration-g

13.1 Iteration H1: Email Notifications 12.2 Iteration G2: Atom Feeds