jmoses_apipie-rails 0.0.23

data/spec/dummy/public/javascripts/rails.js

@@ -0,0 +1,202 @@
+(function() {
+  Ajax.Responders.register({
+    onCreate: function(request) {
+      var token = $$('meta[name=csrf-token]')[0];
+      if (token) {
+        if (!request.options.requestHeaders) request.options.requestHeaders = {};
+        request.options.requestHeaders['X-CSRF-Token'] = token.readAttribute('content');
+      }
+    }
+  });
+
+  // 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, textarea', 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');
+      // serialize the form with respect to the submit button that was pressed
+      params = element.serialize({ submit: element.retrieve('rails:submit-button') });
+      // clear the pressed submit button information
+      element.store('rails:submit-button', null);
+    } else {
+      method = element.readAttribute('data-method') || 'get';
+      url    = element.readAttribute('href');
+      params = {};
+    }
+
+    new Ajax.Request(url, {
+      method: method,
+      parameters: params,
+      evalScripts: true,
+
+      onCreate:   function(response) { element.fire("ajax:create",   response); },
+      onComplete: function(response) { element.fire("ajax:complete", response); },
+      onSuccess:  function(response) { element.fire("ajax:success",  response); },
+      onFailure:  function(response) { element.fire("ajax:failure",  response); }
+    });
+
+    element.fire("ajax:after");
+  }
+
+  function insertHiddenField(form, name, value) {
+    form.insert(new Element('input', { type: 'hidden', name: name, value: value }));
+  }
+
+  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') {
+      insertHiddenField(form, '_method', method);
+    }
+
+    if (csrf_param) {
+      insertHiddenField(form, csrf_param.readAttribute('content'), csrf_token.readAttribute('content'));
+    }
+
+    form.submit();
+  }
+
+  function disableFormElements(form) {
+    form.select('input[type=submit][data-disable-with]').each(function(input) {
+      input.store('rails:original-value', input.getValue());
+      input.setValue(input.readAttribute('data-disable-with')).disable();
+    });
+  }
+  
+  function enableFormElements(form) {
+    form.select('input[type=submit][data-disable-with]').each(function(input) {
+      input.setValue(input.retrieve('rails:original-value')).enable();
+    });
+  }
+
+  function allowAction(element) {
+    var message = element.readAttribute('data-confirm');
+    return !message || confirm(message);
+  }
+
+  document.on('click', 'a[data-confirm], a[data-remote], a[data-method]', function(event, link) {
+    if (!allowAction(link)) {
+      event.stop();
+      return false;
+    }
+
+    if (link.readAttribute('data-remote')) {
+      handleRemote(link);
+      event.stop();
+    } else if (link.readAttribute('data-method')) {
+      handleMethod(link);
+      event.stop();
+    }
+  });
+
+  document.on("click", "form input[type=submit], form button[type=submit], form button:not([type])", function(event, button) {
+    // register the pressed submit button
+    event.findElement('form').store('rails:submit-button', button.name || false);
+  });
+
+  document.on("submit", function(event) {
+    var form = event.findElement();
+
+    if (!allowAction(form)) {
+      event.stop();
+      return false;
+    }
+
+    if (form.readAttribute('data-remote')) {
+      handleRemote(form);
+      event.stop();
+    } else {
+      disableFormElements(form);
+    }
+  });
+
+  document.on('ajax:create', 'form', function(event, form) {
+    if (form == event.findElement()) disableFormElements(form);
+  });
+  
+  document.on('ajax:complete', 'form', function(event, form) {
+    if (form == event.findElement()) enableFormElements(form);
+  });
+})();

data/spec/dummy/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/spec/lib/application_spec.rb

@@ -0,0 +1,38 @@
+require "spec_helper"
+
+describe Apipie::Application do
+
+  describe "get_resource_name" do
+    subject {Apipie.get_resource_name(Api::V2::Nested::ArchitecturesController)}
+
+    context "with namespaced_resources enabled" do
+      before { Apipie.configuration.namespaced_resources = true }
+      context "with a defined base url" do
+        
+        it "should not overwrite the parent resource" do
+          should_not eq(Apipie.get_resource_name(Api::V2::ArchitecturesController))
+        end
+        
+      end
+
+      context "with an undefined base url" do
+        before {Apipie.app.stub(:get_base_url) { nil }}
+
+        it "should not raise an error" do
+          expect { Apipie.get_resource_name(Api::V2::ArchitecturesController) }.
+            not_to raise_error
+        end
+      end
+
+      after { Apipie.configuration.namespaced_resources = false }
+    end
+
+    context "with namespaced_resources enabled" do
+      before { Apipie.configuration.namespaced_resources = false }
+
+      it "should overwrite the the parent" do
+        should eq(Apipie.get_resource_name(Api::V2::ArchitecturesController))
+      end
+    end
+  end
+end

data/spec/lib/method_description_spec.rb

@@ -0,0 +1,30 @@
+require "spec_helper"
+
+describe Apipie::MethodDescription do
+
+  let(:dsl_data) { ActionController::Base.send(:_apipie_dsl_data_init) }
+
+  describe "params descriptions" do
+
+    before(:each) do
+      @resource = Apipie::ResourceDescription.new(ApplicationController, "dummy")
+      dsl_data[:params] = [[:a, String, nil, {}, nil],
+                           [:b, String, nil, {}, nil],
+                           [:c, String, nil, {}, nil]]
+      @method = Apipie::MethodDescription.new(:a, @resource, dsl_data)
+      @resource.add_method_description @method
+    end
+
+    it "should be ordered" do
+      @method.params.keys.should == [:a, :b, :c]
+      @method.to_json[:params].map{|h| h[:name]}.should == ['a', 'b', 'c']
+    end
+
+    it "should be still ordered" do
+      @method.params.keys.should == [:a, :b, :c]
+      @method.to_json[:params].map{|h| h[:name]}.should == ['a', 'b', 'c']
+    end
+
+  end
+
+end

data/spec/lib/param_description_spec.rb

@@ -0,0 +1,174 @@
+require "spec_helper"
+
+describe Apipie::ParamDescription do
+
+  let(:dsl_data) { ActionController::Base.send(:_apipie_dsl_data_init) }
+
+  let(:resource_desc) do
+    Apipie::ResourceDescription.new(UsersController, "users")
+  end
+
+  let(:method_desc) do
+    Apipie::MethodDescription.new(:show, resource_desc, dsl_data)
+  end
+
+  describe "validator selection" do
+
+    it "should allow nil validator" do
+      param = Apipie::ParamDescription.new(method_desc, :hidden_param, nil)
+      param.validator.should be_nil
+    end
+
+    it "should throw exception on unknown validator" do
+      proc { Apipie::ParamDescription.new(method_desc, :param, :unknown) }.should raise_error(RuntimeError, /Validator.*not found/)
+    end
+
+    it "should pick type validator" do
+      Apipie::Validator::BaseValidator.should receive(:find).and_return(:validator_instance)
+      param = Apipie::ParamDescription.new(method_desc, :param, String)
+      param.validator.should == :validator_instance
+    end
+
+  end
+
+  describe "concern substitution" do
+
+    let(:concern_dsl_data) { dsl_data.merge(:from_concern => true) }
+
+    let(:concern_resource_desc) do
+      Apipie::ResourceDescription.new(ConcernsController, "concerns")
+    end
+
+    let(:concern_method_desc) do
+      Apipie::MethodDescription.new(:show, concern_resource_desc, concern_dsl_data)
+    end
+
+    it "should replace string parameter name with colon prefix" do
+      param = Apipie::ParamDescription.new(concern_method_desc, ":string_subst", String)
+      param.name.should == "string"
+    end
+
+    it "should replace symbol parameter name" do
+      param = Apipie::ParamDescription.new(concern_method_desc, :concern, String)
+      param.name.should == :user
+    end
+
+    it "should keep original value for strings without colon prefixes" do
+      param = Apipie::ParamDescription.new(concern_method_desc, "string_subst", String)
+      param.name.should == "string_subst"
+    end
+
+    it "should keep the original value when a string can't be replaced" do
+      param = Apipie::ParamDescription.new(concern_method_desc, ":param", String)
+      param.name.should == ":param"
+    end
+
+    it "should keep the original value when a symbol can't be replaced" do
+      param = Apipie::ParamDescription.new(concern_method_desc, :param, String)
+      param.name.should == :param
+    end
+  end
+
+
+  describe "required_by_default config option" do
+    context "parameters required by default" do
+
+      before { Apipie.configuration.required_by_default = true }
+
+      it "should set param as required by default" do
+        param = Apipie::ParamDescription.new(method_desc, :required_by_default, String)
+        param.required.should be_true
+      end
+
+      it "should be possible to set param as optional" do
+        param = Apipie::ParamDescription.new(method_desc, :optional, String, :required => false)
+        param.required.should be_false
+      end
+
+    end
+
+    context "parameters optional by default" do
+
+      before { Apipie.configuration.required_by_default = false }
+
+      it "should set param as optional by default" do
+        param = Apipie::ParamDescription.new(method_desc, :optional_by_default, String)
+        param.required.should be_false
+      end
+
+      it "should be possible to set param as required" do
+        param = Apipie::ParamDescription.new(method_desc, :required, String, 'description','required' => true)
+        param.required.should be_true
+      end
+
+    end
+
+  end
+
+  describe "required params in action aware validator" do
+
+    subject { method_description.params[:user].validator.hash_params_ordered }
+
+    let(:required) do
+      subject.find_all(&:required).map(&:name)
+    end
+
+    let(:allowed_nil) do
+      subject.find_all(&:allow_nil).map(&:name)
+    end
+
+    context "with resource creation" do
+
+      let(:method_description) do
+        Apipie.get_method_description(UsersController, :create)
+      end
+
+      it "makes the param required" do
+        required.should include :name
+        required.should include :pass
+      end
+
+      it "doesn't allow nil" do
+        allowed_nil.should_not include :name
+        allowed_nil.should_not include :pass
+      end
+    end
+
+    context "with resource update" do
+
+      let(:method_description) do
+        Apipie.get_method_description(UsersController, :update)
+      end
+
+      it "doesn't make the param required" do
+        required.should_not include :name
+        required.should_not include :pass
+      end
+
+      it "doesn't allow nil" do
+        allowed_nil.should_not include :name
+        allowed_nil.should_not include :pass
+      end
+
+      it "doesn't touch params with explicitly set allow_nil" do
+        allowed_nil.should_not include :membership
+      end
+    end
+
+    context "with explicitly setting action type in param group" do
+      let(:method_description) do
+        Apipie.get_method_description(UsersController, :admin_create)
+      end
+
+      it "makes the param required" do
+        required.should include :name
+        required.should include :pass
+      end
+
+      it "doesn't allow nil" do
+        allowed_nil.should_not include :name
+        allowed_nil.should_not include :pass
+      end
+    end
+  end
+end