RubyGems - acts_as_api - Versions diffs - 0.2.2 → 0.3.0 - Mend

acts_as_api 0.2.2 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (73) hide show

data/.gitignore +10 -0
data/Gemfile +12 -0
data/History.txt +8 -0
data/README.rdoc +29 -225
data/Rakefile +20 -28
data/acts_as_api.gemspec +31 -0
data/examples/introduction/docco.css +186 -0
data/examples/introduction/index.html +340 -0
data/examples/introduction/index.rb +132 -0
data/examples/introduction/layout.mustache +64 -0
data/lib/acts_as_api.rb +11 -25
data/lib/acts_as_api/api_template.rb +14 -0
data/lib/acts_as_api/base.rb +61 -56
data/lib/acts_as_api/config.rb +34 -0
data/lib/acts_as_api/rails_renderer.rb +15 -0
data/lib/acts_as_api/rendering.rb +11 -8
data/lib/acts_as_api/version.rb +4 -0
data/spec/controllers/respond_with_users_controller_spec.rb +5 -0
data/spec/controllers/users_controller_spec.rb +161 -0
data/spec/models/base_spec.rb +437 -0
data/spec/rails_app/.gitignore +4 -0
data/spec/rails_app/Rakefile +7 -0
data/spec/rails_app/app/controllers/application_controller.rb +3 -0
data/spec/rails_app/app/controllers/respond_with_users_controller.rb +15 -0
data/spec/rails_app/app/controllers/users_controller.rb +21 -0
data/spec/rails_app/app/helpers/application_helper.rb +2 -0
data/spec/rails_app/app/models/task.rb +3 -0
data/spec/rails_app/app/models/untouched.rb +2 -0
data/spec/rails_app/app/models/user.rb +69 -0
data/spec/rails_app/app/views/layouts/application.html.erb +14 -0
data/spec/rails_app/config.ru +4 -0
data/spec/rails_app/config/application.rb +42 -0
data/spec/rails_app/config/boot.rb +6 -0
data/spec/rails_app/config/database.yml +23 -0
data/spec/rails_app/config/environment.rb +5 -0
data/spec/rails_app/config/environments/development.rb +26 -0
data/spec/rails_app/config/environments/production.rb +49 -0
data/spec/rails_app/config/environments/test.rb +35 -0
data/spec/rails_app/config/initializers/backtrace_silencers.rb +7 -0
data/spec/rails_app/config/initializers/inflections.rb +10 -0
data/spec/rails_app/config/initializers/mime_types.rb +5 -0
data/spec/rails_app/config/initializers/secret_token.rb +7 -0
data/spec/rails_app/config/initializers/session_store.rb +8 -0
data/spec/rails_app/config/locales/en.yml +5 -0
data/spec/rails_app/config/routes.rb +7 -0
data/spec/rails_app/db/migrate/20110214201640_create_tables.rb +35 -0
data/spec/rails_app/db/schema.rb +34 -0
data/spec/rails_app/db/seeds.rb +7 -0
data/spec/rails_app/lib/tasks/.gitkeep +0 -0
data/spec/rails_app/public/404.html +26 -0
data/spec/rails_app/public/422.html +26 -0
data/spec/rails_app/public/500.html +26 -0
data/spec/rails_app/public/favicon.ico +0 -0
data/spec/rails_app/public/images/rails.png +0 -0
data/spec/rails_app/public/index.html +239 -0
data/spec/rails_app/public/javascripts/application.js +2 -0
data/spec/rails_app/public/javascripts/controls.js +965 -0
data/spec/rails_app/public/javascripts/dragdrop.js +974 -0
data/spec/rails_app/public/javascripts/effects.js +1123 -0
data/spec/rails_app/public/javascripts/prototype.js +6001 -0
data/spec/rails_app/public/javascripts/rails.js +191 -0
data/spec/rails_app/public/robots.txt +5 -0
data/spec/rails_app/public/stylesheets/.gitkeep +0 -0
data/spec/rails_app/script/rails +6 -0
data/spec/spec_helper.rb +12 -13
data/spec/support/api_test_helpers.rb +23 -0
metadata +137 -35
data/Manifest.txt +0 -15
data/script/console +0 -10
data/script/destroy +0 -14
data/script/generate +0 -14
data/spec/acts_as_api_spec.rb +0 -87
data/tasks/rspec.rake +0 -21

data/examples/introduction/layout.mustache ADDED

@@ -0,0 +1,64 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=utf-8">
+  <title>acts_as_api</title>
+  <link rel="stylesheet" href="./docco.css">
+  <link  href="http://fonts.googleapis.com/css?family=Copse:regular" rel="stylesheet" type="text/css" >
+  <style>
+  h1, h2, h3, h4, h5 {
+    font-family: 'Copse', serif;
+    font-style: normal;
+    font-weight: 700;
+    text-shadow: none;
+    text-decoration: none;
+    text-transform: none;
+    letter-spacing: 0em;
+    word-spacing: 0em;
+    line-height: 1.2;
+  }
+  </style>
+</head>
+<body>
+<div id='container'>
+  <div id="background"></div>
+  {{#sources?}}
+  <div id="jump_to">
+    Jump To &hellip;
+    <div id="jump_wrapper">
+      <div id="jump_page">
+        {{#sources}}
+          <a class="source" href="{{ url }}">{{ basename }}</a>
+        {{/sources}}
+      </div>
+    </div>
+  </div>
+  {{/sources?}}
+  <table cellspacing=0 cellpadding=0>
+  <thead>
+    <tr>
+      <th class=docs>
+        <h1>acts_as_api</h1>
+        <p>Makes creating XML/JSON responses in Rails 3 easy and fun.</p>
+      </th>
+      <th class=code></th>
+    </tr>
+  </thead>
+  <tbody>
+    {{#sections}}
+    <tr id='section-{{ section_id }}'>
+      <td class=docs>
+        <div class="pilwrap">
+          <a class="pilcrow" href="#section-{{ section_id }}">&#182;</a>
+        </div>
+        {{{ docs }}}
+      </td>
+      <td class=code>
+        <div class='highlight'><pre>{{{ code }}}</pre></div>
+      </td>
+    </tr>
+    {{/sections}}
+  </table>
+</div>
+<a href="https://github.com/fabrik42/acts_as_api"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://assets1.github.com/img/7afbc8b248c68eb468279e8c17986ad46549fb71?repo=&url=http%3A%2F%2Fs3.amazonaws.com%2Fgithub%2Fribbons%2Fforkme_right_darkblue_121621.png&path=" alt="Fork me on GitHub"></a>
+</body>

data/lib/acts_as_api.rb CHANGED

@@ -1,11 +1,12 @@
-require "rubygems"
+require 'set'
+require 'active_model'
+require 'active_support/core_ext/class'
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
-require "acts_as_api/base"
-require "acts_as_api/rendering"
-require "acts_as_api/array"
+ require "acts_as_api/array"
+ require "acts_as_api/rails_renderer"
 # acts_as_api is a gem that aims to make the construction of JSON and XML
 # responses in rails 3 easy and fun.
@@ -16,26 +17,10 @@ require "acts_as_api/array"
 # acts_as_api uses the default serializers of your rails app and doesn't
 # force you into more dependencies.
 module ActsAsApi
-  VERSION = '0.2.2'
-  # The accepted response formats
-  # Default is +[:xml, :json]+
-  ACCEPTED_API_FORMATS = [:xml, :json]
-  # Holds references to formats that need
-  # to get added an additional root node
-  # with the name of the model.
-  ADD_ROOT_NODE_FOR = [:json]
-  # Holds formats that should be dasherized
-  DASHERIZE_FOR = [:xml]
-  # The default name of a root node of a response
-  # if no root paramter is passed in render_for_api
-  # and the gem is not able to determine a root name
-  # automatically
-  DEFAULT_ROOT = :record
+  autoload :Config,       "acts_as_api/config"
+  autoload :ApiTemplate,  "acts_as_api/api_template"
+  autoload :Base,         "acts_as_api/base"
+  autoload :Rendering,    "acts_as_api/rendering"
 end
 # Attach ourselves to active record
@@ -46,4 +31,5 @@ end
 # Attach ourselves to the action controller of rails
 if defined?(ActionController::Base)
   ActionController::Base.send :include, ActsAsApi::Rendering
+  ActsAsApi::RailsRenderer.setup
 end

data/lib/acts_as_api/api_template.rb ADDED

@@ -0,0 +1,14 @@
+module ActsAsApi
+  #
+  class ApiTemplate < Hash
+    def add(val, options = {})
+      self[(options[:as] || val).to_sym] = val
+    end
+    def remove(key)
+      self.delete(key)
+    end
+  end
+end

data/lib/acts_as_api/base.rb CHANGED

@@ -16,6 +16,10 @@ module ActsAsApi
         extend ActsAsApi::Base::ClassMethods
       end
+      if block_given?
+        yield ActsAsApi::Config
+      end
     end
     module ClassMethods
@@ -28,12 +32,28 @@ module ActsAsApi
       # *Note*: There is only whitelisting for api accessible attributes.
       # So once the model acts as api, you have to determine all attributes here that should
       # be contained in the api responses.
-      def api_accessible(api_templates)
+      def api_accessible_deprecated(api_templates)
         api_templates.each do |api_template, attributes|
           write_inheritable_attribute("api_accessible_#{api_template}".to_sym, Set.new(attributes) + (api_accessible_attributes(api_template) || []))
         end
       end
+      def api_accessible(api_template, options = {}, &block)
+        #        return api_accessible_deprecated([api_template]) if api_template.is_a? Hash
+        attributes = api_accessible_attributes(api_template) || ApiTemplate.new
+        attributes.merge!(api_accessible_attributes(options[:extend])) if options[:extend]
+        if block_given?
+          yield attributes
+        end
+        write_inheritable_attribute("api_accessible_#{api_template}".to_sym, attributes)
+      end
       # Returns an array of all the attributes that have been made accessible to the api response.
       def api_accessible_attributes(api_template)
         read_inheritable_attribute("api_accessible_#{api_template}".to_sym)
@@ -52,82 +72,67 @@ module ActsAsApi
         return api_output if api_attributes.nil?
-        api_attributes.each do |attribute|
-          case attribute
-          when Symbol
-            if self.respond_to?(attribute)
-              out = send attribute
-              if out.respond_to?(:as_api_response)
-                out = out.send(:as_api_response, api_template)
-              end
-              api_output[attribute] = out
-            end
-          when String
-            # go up the call chain
-            out = self
-            attribute.split(".").each do |method|
-              out = out.send(method.to_sym)
-            end
-            api_output[attribute] = out
-          when Hash
-            queue = []
-            queue << { :parent =>  api_output, :item => attribute}
+        queue = []
+        queue << { :parent =>  api_output, :item => api_attributes}
-            until queue.empty? do
+        until queue.empty? do
-              leaf = queue.pop
+            leaf = queue.pop
-              leaf[:item].each do |k,v|
+            leaf[:item].each do |k,v|
-                case v
-                when Symbol
+              case v
+              when Symbol
-                  if self.respond_to?(v)
-                    out = send v
-                    if out.respond_to?(:as_api_response)
-                      out = out.send(:as_api_response, api_template)
-                    end
-                    leaf[:parent][k] = out
+                if self.respond_to?(v)
+                  out = send v
+                  if out.respond_to?(:as_api_response)
+                    out = out.send(:as_api_response, api_template)
                   end
-                when String
-                  # go up the call chain
-                  out = self
-                  v.split(".").each do |method|
-                    out = out.send(method.to_sym)
-                  end
                   leaf[:parent][k] = out
-                when Hash
-                  leaf[:parent][k] ||= {}
-                  queue << { :parent =>  leaf[:parent][k], :item => v}
                 end
+              when Proc
+                out = v.call(self)
+                if out.respond_to?(:as_api_response)
+                  out = out.send(:as_api_response, api_template)
+                end
+                leaf[:parent][k] = out
+              when String
+                # go up the call chain
+                out = self
+                v.split(".").each do |method|
+                  out = out.send(method.to_sym)
+                end
+                if out.respond_to?(:as_api_response)
+                  out = out.send(:as_api_response, api_template)
+                end
+                leaf[:parent][k] = out
+              when Hash
+                leaf[:parent][k] ||= {}
+                queue << { :parent =>  leaf[:parent][k], :item => v}
               end
             end
           end
-        end
+          api_output
-        api_output
+        end
       end
     end
   end
-end

data/lib/acts_as_api/config.rb ADDED

@@ -0,0 +1,34 @@
+module ActsAsApi
+  module Config
+    class << self
+      # The accepted response formats
+      # Default is <tt>[:xml, :json]</tt>
+      attr_accessor_with_default :accepted_api_formats, [:xml, :json] # :nodoc:
+      # Holds formats that should be dasherized
+      # Default is <tt>[:xml]</tt>
+      attr_accessor_with_default :dasherize_for, [:xml]
+      # Holds references to formats that need
+      # to get added an additional root node
+      # with the name of the model.
+      attr_accessor_with_default :add_root_node_for, [:json]
+      # The default name of a root node of a response
+      # if no root paramter is passed in render_for_api
+      # and the gem is not able to determine a root name
+      # automatically
+      attr_accessor_with_default :default_root, :record
+      attr_accessor_with_default :allow_jsonp_callback, false
+      attr_accessor_with_default :add_http_status_to_jsonp_response, true
+    end
+  end
+end

data/lib/acts_as_api/rails_renderer.rb ADDED

@@ -0,0 +1,15 @@
+module ActsAsApi
+  # Contains rails specific renderers used by acts_as_api
+  module RailsRenderer
+    def self.setup
+      ActionController.add_renderer :acts_as_api_jsonp do |json, options|
+        json = ActiveSupport::JSON.encode(json) unless json.respond_to?(:to_str)
+        json = "#{options[:callback]}(#{json}, #{response.status})" unless options[:callback].blank?
+        self.content_type ||= Mime::JSON
+        self.response_body = json
+      end
+    end
+  end
+end

data/lib/acts_as_api/rendering.rb CHANGED

@@ -13,7 +13,7 @@ module ActsAsApi
       # extract the api format and model
       api_format_options = {}
-      ActsAsApi::ACCEPTED_API_FORMATS.each do |item|
+      ActsAsApi::Config.accepted_api_formats.each do |item|
         if render_options.has_key?(item)
           api_format_options[item] = render_options[item]
           render_options.delete item
@@ -28,13 +28,12 @@ module ActsAsApi
       # set the params to render
       output_params = render_options
       api_root_name = nil
       if !output_params[:root].nil?
         api_root_name = output_params[:root].to_s
+      elsif api_model.respond_to?(:collection_name)
+        api_root_name = api_model.collection_name
       elsif api_model.respond_to?(:model_name)
         api_root_name = api_model.model_name
       elsif api_model.is_a?(Array) && !api_model.empty? && api_model.first.class.respond_to?(:model_name)
@@ -42,7 +41,7 @@ module ActsAsApi
       elsif api_model.class.respond_to?(:model_name)
         api_root_name = api_model.class.model_name
       else
-        api_root_name = ActsAsApi::DEFAULT_ROOT.to_s
+        api_root_name = ActsAsApi::Config.default_root.to_s
       end
       api_root_name = api_root_name.underscore.tr('/', '_')
@@ -51,7 +50,7 @@ module ActsAsApi
         api_root_name = api_root_name.pluralize
       end
-      api_root_name = api_root_name.dasherize if ActsAsApi::DASHERIZE_FOR.include? api_format.to_sym
+      api_root_name = api_root_name.dasherize if ActsAsApi::Config.dasherize_for.include? api_format.to_sym
       output_params[:root] = api_root_name
@@ -60,17 +59,21 @@ module ActsAsApi
       api_response = api_model.as_api_response(api_template)
-      if meta_hash or ActsAsApi::ADD_ROOT_NODE_FOR.include? api_format
+      if meta_hash or ActsAsApi::Config.add_root_node_for.include? api_format
         api_response = { api_root_name.to_sym =>  api_response}
       end
       api_response = meta_hash.merge api_response if meta_hash
+      if ActsAsApi::Config.allow_jsonp_callback && params[:callback]
+        output_params[:callback] = params[:callback]
+        api_format = :acts_as_api_jsonp if ActsAsApi::Config.add_http_status_to_jsonp_response
+      end
       # create the Hash as response
       output_params[api_format] = api_response
       render output_params
     end
   end

data/lib/acts_as_api/version.rb ADDED

@@ -0,0 +1,4 @@
+module ActsAsApi
+  VERSION = "0.3.0"
+end

data/spec/controllers/respond_with_users_controller_spec.rb ADDED

@@ -0,0 +1,5 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+describe RespondWithUsersController do
+  pending "we need to fix the root node for json first"
+end

data/spec/controllers/users_controller_spec.rb ADDED

@@ -0,0 +1,161 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+describe UsersController do
+  include ApiTestHelpers
+  before(:each) do
+    @luke = User.create({ :first_name => 'Luke',      :last_name => 'Skywalker', :age => 25, :active => true  })
+    @han  = User.create({ :first_name => 'Han',       :last_name => 'Solo',      :age => 35, :active => true  })
+    @leia = User.create({ :first_name => 'Princess',  :last_name => 'Leia',      :age => 25, :active => false })
+  end
+  after(:each) do
+    User.delete_all
+  end
+  describe 'xml responses' do
+    describe 'get all users' do
+      before(:each) do
+        get :index, :format => 'xml', :api_template => :name_only
+      end
+      it "should have a root node named users" do
+        response_body.should have_selector("users")
+      end
+      it "should contain all users" do
+        response_body.should have_selector("users > user") do |users|
+          users.size.should eql(3)
+        end
+      end
+      it "should contain the specified attributes" do
+        response_body.should have_selector("users > user > first-name")
+        response_body.should have_selector("users > user > last-name")
+      end
+    end
+    describe 'get a single user' do
+      before(:each) do
+        get :show, :format => 'xml', :api_template => :name_only, :id => @luke.id
+      end
+      it "should have a root node named user" do
+        response_body.should have_selector("user")
+      end
+      it "should contain the specified attributes" do
+        response_body.should have_selector("user > first-name")
+        response_body.should have_selector("user > last-name")
+      end
+    end
+  end
+  describe 'json responses' do
+    describe 'get all users' do
+      before(:each) do
+        get :index, :format => 'json', :api_template => :name_only
+      end
+      it "should have a root node named users" do
+        response_body_json.should have_key("users")
+      end
+      it "should contain all users" do
+        response_body_json["users"].should be_a(Array)
+      end
+      it "should contain the specified attributes" do
+        response_body_json["users"].first.should have_key("first_name")
+        response_body_json["users"].first.should have_key("last_name")
+      end
+      it "should contain the specified values" do
+        response_body_json["users"].first["first_name"].should eql("Luke")
+        response_body_json["users"].first["last_name"].should eql("Skywalker")
+      end
+    end
+    describe 'get a single user' do
+      before(:each) do
+        get :show, :format => 'json', :api_template => :name_only, :id => @luke.id
+      end
+      it "should have a root node named user" do
+        response_body_json.should have_key("user")
+      end
+      it "should contain the specified attributes" do
+        response_body_json["user"].should have_key("first_name")
+        response_body_json["user"].should have_key("last_name")
+      end
+      it "should contain the specified values" do
+        response_body_json["user"]["first_name"].should eql("Luke")
+        response_body_json["user"]["last_name"].should eql("Skywalker")
+      end
+    end
+  end
+  describe 'jsonp responses with callback' do
+    it "should be disabled by default" do
+      @callback = "mycallback"
+      get :index, :format => 'json', :api_template => :name_only, :callback => @callback
+      response_body_jsonp(@callback).should be_nil
+    end
+    describe "enabled jsonp callbacks" do
+      before(:each) do
+        @callback = "mycallback"
+        User.acts_as_api do |config|
+          config.allow_jsonp_callback = true
+        end
+      end
+      describe 'get all users' do
+        before(:each) do
+          get :index, :format => 'json', :api_template => :name_only, :callback => @callback
+        end
+        it "should wrap the response in the callback" do
+          response_body_jsonp(@callback).should_not be_nil
+        end
+      end
+      describe 'get a single user' do
+        before(:each) do
+          get :show, :format => 'json', :api_template => :name_only, :id => @luke.id, :callback => @callback
+        end
+        it "should wrap the response in the callback" do
+          response_body_jsonp(@callback).should_not be_nil
+        end
+      end
+    end
+  end
+end