Agile Web Development with Rails, Edition 4

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

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?(@latest_order)

      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 --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 rel="alternate" type="text/html" href="http://localhost:3000"/>

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

  <title>Who bought CoffeeScript</title>

  <updated>2013-02-24T15:21:20Z</updated>

  <entry>

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

    <published>2013-02-24T15:21:20Z</published>

    <updated>2013-02-24T15:21:20Z</updated>

    <link rel="alternate" type="text/html" 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?(@latest_order)

      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 --silent --user dave:secret http://localhost:3000/products/2/who_bought.xml

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

<product>

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

  <title>CoffeeScript</title>

  <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>

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

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

  <created-at type="dateTime">2013-02-24T15:17:19Z</created-at>

  <updated-at type="dateTime">2013-02-24T15:17:19Z</updated-at>

  <orders type="array">

    <order>

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

      <name>Dave Thomas</name>

      <address>123 Main St</address>

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

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

      <created-at type="dateTime">2013-02-24T15:21:20Z</created-at>

      <updated-at type="dateTime">2013-02-24T15:21:20Z</updated-at>

    </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?(@latest_order)

      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 --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="/assets/application.css?body=1" media="all" rel="stylesheet" />

<link data-turbolinks-track="true" href="/assets/carts.css?body=1" media="all" rel="stylesheet" />

<link data-turbolinks-track="true" href="/assets/line_items.css?body=1" media="all" rel="stylesheet" />

<link data-turbolinks-track="true" href="/assets/orders.css?body=1" media="all" rel="stylesheet" />

<link data-turbolinks-track="true" href="/assets/products.css?body=1" media="all" rel="stylesheet" />

<link data-turbolinks-track="true" href="/assets/scaffolds.css?body=1" media="all" rel="stylesheet" />

<link data-turbolinks-track="true" href="/assets/store.css?body=1" media="all" rel="stylesheet" />

  <script data-turbolinks-track="true" src="/assets/jquery.js?body=1"></script>

<script data-turbolinks-track="true" src="/assets/jquery-ui.js?body=1"></script>

<script data-turbolinks-track="true" src="/assets/jquery_ujs.js?body=1"></script>

<script data-turbolinks-track="true" src="/assets/turbolinks.js?body=1"></script>

<script data-turbolinks-track="true" src="/assets/carts.js?body=1"></script>

<script data-turbolinks-track="true" src="/assets/line_items.js?body=1"></script>

<script data-turbolinks-track="true" src="/assets/orders.js?body=1"></script>

<script data-turbolinks-track="true" src="/assets/products.js?body=1"></script>

<script data-turbolinks-track="true" src="/assets/store.js?body=1"></script>

<script data-turbolinks-track="true" src="/assets/application.js?body=1"></script>

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

<meta content="sWMDOdy/QJ5G2zllVebKtLnazR4+kD2K1gprsKCIq9s=" name="csrf-token" />

</head>

<!-- END:head -->

<body class="products">

  <div id="banner">

    <img alt="Logo" src="/assets/logo.png" />

    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?(@latest_order)

      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 --silent --user dave:secret http://localhost:3000/products/2/who_bought.json

{"product":{"id":2,"title":"CoffeeScript","description":"\u003Cp\u003E\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      \u003C/p\u003E","image_url":"cs.jpg","price":"36.0","created_at":"2013-02-24T15:17:19.460Z","updated_at":"2013-02-24T15:17:19.460Z","orders":[{"id":1,"name":"Dave Thomas","address":"123 Main St","email":"customer@example.com","pay_type":"Check","created_at":"2013-02-24T15:21:20.274Z","updated_at":"2013-02-24T15:21:20.274Z"}]}}

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?(@latest_order)

      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 --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

Run options: --seed 17133

# Running tests:

.......

Finished tests in 0.493312s, 14.1898 tests/s, 56.7592 assertions/s.

7 tests, 28 assertions, 0 failures, 0 errors, 0 skips

Run options: --seed 61845

# Running tests:

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

Finished tests in 2.117065s, 15.5876 tests/s, 32.1199 assertions/s.

33 tests, 68 assertions, 0 failures, 0 errors, 0 skips

Commit

git commit -a -m "Orders"

[master 3d56623] Orders

 4 files changed, 43 insertions(+), 21 deletions(-)

git tag iteration-g

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