restfulie 1.0.0 → 1.0.3

data/full-examples/rest_from_scratch/part_3/public/javascripts/rails.js

@@ -0,0 +1,175 @@
+(function() {
+  // Technique from Juriy Zaytsev
+  // http://thinkweb2.com/projects/prototype/detecting-event-support-without-browser-sniffing/
+  function isEventSupported(eventName) {
+    var el = document.createElement('div');
+    eventName = 'on' + eventName;
+    var isSupported = (eventName in el);
+    if (!isSupported) {
+      el.setAttribute(eventName, 'return;');
+      isSupported = typeof el[eventName] == 'function';
+    }
+    el = null;
+    return isSupported;
+  }
+
+  function isForm(element) {
+    return Object.isElement(element) && element.nodeName.toUpperCase() == 'FORM'
+  }
+
+  function isInput(element) {
+    if (Object.isElement(element)) {
+      var name = element.nodeName.toUpperCase()
+      return name == 'INPUT' || name == 'SELECT' || name == 'TEXTAREA'
+    }
+    else return false
+  }
+
+  var submitBubbles = isEventSupported('submit'),
+      changeBubbles = isEventSupported('change')
+
+  if (!submitBubbles || !changeBubbles) {
+    // augment the Event.Handler class to observe custom events when needed
+    Event.Handler.prototype.initialize = Event.Handler.prototype.initialize.wrap(
+      function(init, element, eventName, selector, callback) {
+        init(element, eventName, selector, callback)
+        // is the handler being attached to an element that doesn't support this event?
+        if ( (!submitBubbles && this.eventName == 'submit' && !isForm(this.element)) ||
+             (!changeBubbles && this.eventName == 'change' && !isInput(this.element)) ) {
+          // "submit" => "emulated:submit"
+          this.eventName = 'emulated:' + this.eventName
+        }
+      }
+    )
+  }
+
+  if (!submitBubbles) {
+    // discover forms on the page by observing focus events which always bubble
+    document.on('focusin', 'form', function(focusEvent, form) {
+      // special handler for the real "submit" event (one-time operation)
+      if (!form.retrieve('emulated:submit')) {
+        form.on('submit', function(submitEvent) {
+          var emulated = form.fire('emulated:submit', submitEvent, true)
+          // if custom event received preventDefault, cancel the real one too
+          if (emulated.returnValue === false) submitEvent.preventDefault()
+        })
+        form.store('emulated:submit', true)
+      }
+    })
+  }
+
+  if (!changeBubbles) {
+    // discover form inputs on the page
+    document.on('focusin', 'input, select, texarea', function(focusEvent, input) {
+      // special handler for real "change" events
+      if (!input.retrieve('emulated:change')) {
+        input.on('change', function(changeEvent) {
+          input.fire('emulated:change', changeEvent, true)
+        })
+        input.store('emulated:change', true)
+      }
+    })
+  }
+
+  function handleRemote(element) {
+    var method, url, params;
+
+    var event = element.fire("ajax:before");
+    if (event.stopped) return false;
+
+    if (element.tagName.toLowerCase() === 'form') {
+      method = element.readAttribute('method') || 'post';
+      url    = element.readAttribute('action');
+      params = element.serialize();
+    } else {
+      method = element.readAttribute('data-method') || 'get';
+      url    = element.readAttribute('href');
+      params = {};
+    }
+
+    new Ajax.Request(url, {
+      method: method,
+      parameters: params,
+      evalScripts: true,
+
+      onComplete:    function(request) { element.fire("ajax:complete", request); },
+      onSuccess:     function(request) { element.fire("ajax:success",  request); },
+      onFailure:     function(request) { element.fire("ajax:failure",  request); }
+    });
+
+    element.fire("ajax:after");
+  }
+
+  function handleMethod(element) {
+    var method = element.readAttribute('data-method'),
+        url = element.readAttribute('href'),
+        csrf_param = $$('meta[name=csrf-param]')[0],
+        csrf_token = $$('meta[name=csrf-token]')[0];
+
+    var form = new Element('form', { method: "POST", action: url, style: "display: none;" });
+    element.parentNode.insert(form);
+
+    if (method !== 'post') {
+      var field = new Element('input', { type: 'hidden', name: '_method', value: method });
+      form.insert(field);
+    }
+
+    if (csrf_param) {
+      var param = csrf_param.readAttribute('content'),
+          token = csrf_token.readAttribute('content'),
+          field = new Element('input', { type: 'hidden', name: param, value: token });
+      form.insert(field);
+    }
+
+    form.submit();
+  }
+
+
+  document.on("click", "*[data-confirm]", function(event, element) {
+    var message = element.readAttribute('data-confirm');
+    if (!confirm(message)) event.stop();
+  });
+
+  document.on("click", "a[data-remote]", function(event, element) {
+    if (event.stopped) return;
+    handleRemote(element);
+    event.stop();
+  });
+
+  document.on("click", "a[data-method]", function(event, element) {
+    if (event.stopped) return;
+    handleMethod(element);
+    event.stop();
+  });
+
+  document.on("submit", function(event) {
+    var element = event.findElement(),
+        message = element.readAttribute('data-confirm');
+    if (message && !confirm(message)) {
+      event.stop();
+      return false;
+    }
+
+    var inputs = element.select("input[type=submit][data-disable-with]");
+    inputs.each(function(input) {
+      input.disabled = true;
+      input.writeAttribute('data-original-value', input.value);
+      input.value = input.readAttribute('data-disable-with');
+    });
+
+    var element = event.findElement("form[data-remote]");
+    if (element) {
+      handleRemote(element);
+      event.stop();
+    }
+  });
+
+  document.on("ajax:after", "form", function(event, element) {
+    var inputs = element.select("input[type=submit][disabled=true][data-disable-with]");
+    inputs.each(function(input) {
+      input.value = input.readAttribute('data-original-value');
+      input.removeAttribute('data-original-value');
+      input.disabled = false;
+    });
+  });
+})();

data/full-examples/rest_from_scratch/part_3/public/robots.txt

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-Agent: *
+# Disallow: /

data/full-examples/rest_from_scratch/part_3/public/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/full-examples/rest_from_scratch/part_3/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/full-examples/rest_from_scratch/part_3/spec/buying_process_spec.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'restfulie'
+require 'client/buying_process.rb'
+
+class Restfulie::Client::Cache::Basic
+  def cache_hit(response)
+    puts "Saving your time and money: cache hit!"
+    response
+  end
+end
+
+require 'spec_helper'
+
+describe ItemsController do
+
+  context "when creating an item" do
+
+    it "should keep its values" do
+      BuyingProcess.run
+    end
+
+  end
+  
+end

data/full-examples/rest_from_scratch/part_3/spec/client/buying_process.rb

@@ -0,0 +1,23 @@
+class BuyingProcess < Restfulie::Client::Mikyung::RestProcessModel
+  at "http://localhost:3000/items"
+  accept "application/xml"
+  current_dir File.dirname(__FILE__)
+
+  def initialize(*what)
+    @what = what
+  end
+  
+  def completed?(resource)
+    resource.keys.first == "payment"
+  end
+
+  def self.run
+    Restfulie::Common::Logger.logger.level = Logger::ERROR
+    goal = BuyingProcess.new("Rest", "Calpis")
+    result = Restfulie::Mikyung.new.achieve(goal).run
+    
+    result.response.code.should == 200
+    result.payment.amount.should == 410.0
+    puts "Goal Achieved"
+  end
+end

data/full-examples/rest_from_scratch/part_3/spec/client/scenarios/buying_process.scenario

@@ -0,0 +1,15 @@
+When there is a required item
+And there is a basket
+But didnt create a basket
+Then create the basket
+
+When there is a required item
+And there is a basket
+Then add to the basket
+
+When it is a basket
+And there are still products to buy
+Then start again
+
+When there is a payment
+Then pay

data/full-examples/rest_from_scratch/part_3/spec/client/steps/buying_process.rb

@@ -0,0 +1,56 @@
+def i_want?(name)
+  @what.find { |desired| name[desired] }
+end
+
+When "there is a required item" do |resource|
+  if resource.keys.first == "items"
+    @desired = resource.items.item.find { |item| i_want?(item.name) }
+  else
+    false
+  end
+end
+
+When "there is a basket" do |resource|
+  resource.values.first.links.basket
+end
+
+When "there is a payment" do |resource|
+  resource.values.first.links.payment
+end
+
+When "it is a basket" do |resource|
+  resource.keys.first == "basket"
+end
+
+When "didnt create a basket" do |resource|
+  @basket_resource.nil?
+end
+
+When "there are still products to buy" do |resource|
+  !@what.empty?
+end
+
+Then "start again" do |resource, regex, mikyung|
+  mikyung.start
+end
+
+def pick_desired
+  @what.delete_if { |desired| @desired.name[desired] }
+end
+
+Then "create the basket" do |resource|
+  pick_desired
+  basket = {:basket => {:items => [{:id => @desired['id']}]} }
+  @basket_resource = resource.items.links.basket.post! basket
+end
+
+Then "add to the basket" do |resource|
+  pick_desired
+  items = {"items" => [{:id => @desired['id']}]}
+  @basket_resource = @basket_resource.basket.links.self.patch! items
+end
+
+Then "pay" do |resource|
+  payment = {:payment => {:cardnumber => "4850000000000001", :cardholder => "guilherme silveira", :amount => resource.basket.price}}
+  resource.basket.links.payment.post! payment
+end

data/full-examples/rest_from_scratch/part_3/spec/full_cycle_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe ItemsController do
+  
+  context "when retrieving data" do
+    
+    it "should retrieve an array" do
+      # retrieves the list
+      resource = Restfulie.at("http://localhost:3000/items").accepts("application/xml").get
+
+      # picks the first item
+      basket = {"basket" => {"items" => [{"id" => resource.items.item.first["id"]}]}}
+
+      # creates the basket
+      resource = resource.items.links.basket.post! basket
+
+      # prepares the payment
+      payment = {"payment" => {"cardnumber" => "4850000000000001", "cardholder" => "guilherme silveira", :amount => resource.basket.price}}
+
+      # creates the payment
+      resource = resource.basket.links.payment.post! payment
+      
+      resource.payment.cardholder.should == "guilherme silveira"
+
+    end
+    
+  end
+  
+end
+

data/full-examples/rest_from_scratch/part_3/spec/items_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe ItemsController do
+  
+  context "when creating an item" do
+
+    it "should keep its values" do
+      p = Restfulie.at('http://localhost:3000/items').as("application/xml").post("<item><name>Agile Training</name><price>500</price></item>")
+      p.item.name.should == "Agile Training"
+      p.item.price.should == 500
+    end
+
+  end
+
+  context "when retrieving data" do
+    it "should retrieve one single element" do
+      p = Restfulie.at('http://localhost:3000/items/1').get
+      p.item.name.should == "Rest in practice"
+      p.item.price.should == 400
+    end
+    
+    it "should retrieve an array" do
+      p = Restfulie.at('http://localhost:3000/items').get
+      p.items.item[0].name.should == "Rest in practice"
+      p.items.item[0].price.should == "400.0"
+    end
+    
+  end
+  
+end
+

data/full-examples/rest_from_scratch/part_3/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+# This file is copied to ~/spec when you run 'ruby script/generate rspec'
+# from the project root directory.
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path("../../config/environment", __FILE__)
+require 'rspec/rails'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, comment the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+end