Agile Web Development with Rails, Edition 4

12.3 Iteration G3: Downloading an eBook 12.1 Iteration G1: Capturing an Order

12.2 Iteration G2: Atom Feeds

Demonstrate various respond_to/format options, as well as "through" relations and basic authentication.

Define a "who_bought" member action

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.atom
      end
    end
  end

Define an Atom view (using the Atom builder)

edit app/views/products/who_bought.atom.builder
atom_feed do |feed|
  feed.title "Who bought #{@product.title}"
 
  feed.updated @latest_order.try(:updated_at) 
 
  @product.orders.each do |order|
    feed.entry(order) do |entry|
      entry.title "Order #{order.id}"
      entry.summary type: 'xhtml' do |xhtml|
        xhtml.p "Shipped to #{order.address}"
 
        xhtml.table do
          xhtml.tr do
            xhtml.th 'Product'
            xhtml.th 'Quantity'
            xhtml.th 'Total Price'
          end
          order.line_items.each do |item|
            xhtml.tr do
              xhtml.td item.product.title
              xhtml.td item.quantity
              xhtml.td number_to_currency item.total_price
            end
          end
          xhtml.tr do
            xhtml.th 'total', colspan: 2
            xhtml.th number_to_currency \
              order.line_items.map(&:total_price).sum
          end
        end
 
        xhtml.p "Paid by #{order.pay_type}"
      end
      entry.author do |author|
        author.name order.name
        author.email order.email
      end
    end
  end
end

Add "orders" to the Product class

edit app/models/product.rb
class Product < ActiveRecord::Base
  has_many :line_items
  has_many :orders, through: :line_items
  #...
end

Add to the routes

edit config/routes.rb
Depot::Application.routes.draw do
  resources :orders
 
  resources :line_items
 
  resources :carts
 
  get "store/index"
  resources :products do
    get :who_bought, on: :member
  end
 
  # The priority is based upon order of creation:
  # first created -> highest priority.
  # See how all your routes lay out with "rake routes".
 
  # You can have the root of your site routed with "root"
  root 'store#index', as: 'store'
  # ...
end

Fetch the Atom feed

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 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>2014-07-25T01:41:35Z</updated>
  <entry>
    <id>tag:localhost,2005:Order/1</id>
    <published>2014-07-25T01:41:35Z</published>
    <updated>2014-07-25T01:41:35Z</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>

Look at the headers

curl --max-time 15 --silent --dump - --output /dev/null --user dave:secret http://localhost:3000/products/2/who_bought.atom
HTTP/1.1 200 OK 
X-Frame-Options: SAMEORIGIN
X-Xss-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Ua-Compatible: chrome=1
Etag: "5fa9308ea2ec57b9eaa4d09cc53b8cec"
Last-Modified: Fri, 25 Jul 2014 01:41:35 GMT
Content-Type: application/atom+xml; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 27dc6ffc-19d1-4741-a081-ccefc9ef4f64
X-Runtime: 0.014759
Server: WEBrick/1.3.1 (Ruby/2.0.0/2014-05-08)
Date: Fri, 25 Jul 2014 01:41:35 GMT
Content-Length: 1324
Connection: Keep-Alive
Set-Cookie: request_method=GET; path=/
 
curl --max-time 15 --silent --dump - --output /dev/null --user dave:secret http://localhost:3000/products/2/who_bought.atom -H 'If-None-Match: "5fa9308ea2ec57b9eaa4d09cc53b8cec"'
HTTP/1.1 304 Not Modified 
X-Frame-Options: SAMEORIGIN
X-Xss-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Ua-Compatible: chrome=1
Etag: "5fa9308ea2ec57b9eaa4d09cc53b8cec"
Last-Modified: Fri, 25 Jul 2014 01:41:35 GMT
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 1758cefd-445f-4c99-8256-a080b73fdcf7
X-Runtime: 0.007229
Server: WEBrick/1.3.1 (Ruby/2.0.0/2014-05-08)
Date: Fri, 25 Jul 2014 01:41:35 GMT
Connection: Keep-Alive
Set-Cookie: request_method=GET; path=/
 
curl --max-time 15 --silent --dump - --output /dev/null --user dave:secret http://localhost:3000/products/2/who_bought.atom -H 'If-Modified-Since: Fri, 25 Jul 2014 01:41:35 GMT'
HTTP/1.1 304 Not Modified 
X-Frame-Options: SAMEORIGIN
X-Xss-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Ua-Compatible: chrome=1
Etag: "5fa9308ea2ec57b9eaa4d09cc53b8cec"
Last-Modified: Fri, 25 Jul 2014 01:41:35 GMT
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 4fcc8146-0180-4eed-82f7-683cb1b82734
X-Runtime: 0.005521
Server: WEBrick/1.3.1 (Ruby/2.0.0/2014-05-08)
Date: Fri, 25 Jul 2014 01:41:35 GMT
Connection: Keep-Alive
Set-Cookie: request_method=GET; path=/
 

12.3 Iteration G3: Downloading an eBook 12.1 Iteration G1: Capturing an Order