acts_as_api_sequel 0.0.1

data/lib/acts_as_api/rails_renderer.rb

@@ -0,0 +1,17 @@
+module ActsAsApi
+  # Contains rails specific renderers used by acts_as_api to render a jsonp response
+  #
+  # See ActsAsApi::Config about the possible configurations
+  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

@@ -0,0 +1,95 @@
+module ActsAsApi
+
+  # The methods of this module are included into the AbstractController::Rendering
+  # module.
+  module Rendering
+
+    # Provides an alternative to the +render+ method used within the controller
+    # to simply generate API outputs.
+    #
+    # The default Rails serializers are used to serialize the data.
+    def render_for_api(api_template_or_options, render_options)
+      if api_template_or_options.is_a?(Hash)
+        api_template = []
+        api_template << api_template_or_options.delete(:prefix)
+        api_template << api_template_or_options.delete(:template)
+        api_template << api_template_or_options.delete(:postfix)
+        api_template = api_template.reject(&:blank?).join('_')
+      else
+        api_template = api_template_or_options
+      end
+
+      # extract the api format and model
+      api_format_options = {}
+
+      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
+        end
+      end
+
+      meta_hash = render_options[:meta] if render_options.has_key?(:meta)
+
+      api_format =  api_format_options.keys.first
+      api_model  =  api_format_options.values.first
+
+      # 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.class.respond_to?(:model_name)        
+        api_root_name = api_model.class.model_name        
+      elsif api_model.respond_to?(:collection_name)
+        api_root_name = api_model.collection_name
+      elsif api_model.is_a?(Array) && !api_model.empty? && api_model.first.class.respond_to?(:model_name)
+        api_root_name = api_model.first.class.model_name
+      elsif api_model.is_a?(Array) && !api_model.empty? && api_model.first.respond_to?(:model_name)
+        api_root_name = api_model.first.model_name
+      elsif api_model.respond_to?(:model_name)
+        api_root_name = api_model.model_name        
+      else
+        api_root_name = ActsAsApi::Config.default_root.to_s
+      end
+      api_root_name = api_root_name.to_s.underscore.tr('/', '_')
+
+      if api_model.is_a?(Array) || (defined?(ActiveRecord) && api_model.is_a?(ActiveRecord::Relation))
+        api_root_name = api_root_name.pluralize
+      end
+
+      api_root_name = api_root_name.dasherize if ActsAsApi::Config.dasherize_for.include? api_format.to_sym
+
+      output_params[:root] = api_root_name
+
+      #output_params[:root] = output_params[:root].camelize if render_options.has_key?(:camelize) && render_options[:camelize]
+      #output_params[:root] = output_params[:root].dasherize if !render_options.has_key?(:dasherize) || render_options[:dasherize]
+
+      api_response = api_model.as_api_response(api_template)
+
+      if api_response.is_a?(Array) && api_format.to_sym == :json && ActsAsApi::Config.include_root_in_json_collections
+        api_response = api_response.collect{|f| { api_root_name.singularize => f } }
+      end
+
+      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
+
+end

data/lib/acts_as_api/responder.rb

@@ -0,0 +1,39 @@
+module ActsAsApi
+  # A custom Rails responder class to automatically use render_for_api in your
+  # controller actions.
+  #
+  # Example:
+  #
+  #  class UsersController < ApplicationController
+  #    # Set this controller to use our custom responder
+  #    # (This could be done in a base controller class, if desired)
+  #    self.responder = ActsAsApi::Responder
+  #
+  #    respond_to :json, :xml
+  #
+  #    def index
+  #      @users = User.all
+  #      respond_with @users, :api_template => :name_only
+  #    end
+  #  end
+  #
+  # The `:api_template` parameter is required so the responder knows which api template it should render.
+
+  class Responder < ActionController::Responder
+    module Module
+      # Overrides the base implementation of display, replacing it with
+      # the render_for_api method whenever api_template is specified.
+      def display(resource, given_options={})
+        api_template = options[:api_template]
+
+        if api_template.nil? || !resource.respond_to?(:as_api_response)
+          controller.render given_options.merge!(options).merge!(format => resource)
+        else
+          controller.render_for_api api_template, given_options.merge!(options).merge!(format => resource)
+        end
+      end
+    end
+
+    include Module
+  end
+end

data/lib/acts_as_api/version.rb

@@ -0,0 +1,3 @@
+module ActsAsApi
+  VERSION = "0.0.1"
+end

data/spec/README.md

@@ -0,0 +1,55 @@
+# Spec folder intro
+
+## Running specs
+
+Every ORM has a rake task. Run `rake -T` to see them all.
+
+`rake spec:all` will run all spec suites in a row.
+
+`rake spec:#{orm_name}` will run the spec suite for a specific ORM.
+
+## Working with the specs
+
+acts_as_api can be used with lots of different configurations, depending e.g. on the ORM (ActiveRecord, Mongoid, vanilla ruby) or the way the content is rendered (usual Rails controller, vs. Responder).
+
+A goal of the lib is to stay consistent in its behaviour over these different configurations, so it won't get in your way, once you change other parts of your application.
+
+To achieve this goal and because of the need to keep the specs as DRY as possible, the following spec setup was created:
+
+### A shared engine
+
+In order to keep the spec suite DRY it uses a Rails engine, available at `./shared_engine`.
+
+It contains the controllers that are re-used by the ORM-specific Rails apps and some mixins that can be shared over the models of different ORMs.
+
+### Dummy Rails apps
+
+There used to be one Rails app that contained all supported ORMs. But multiple times this setup veiled problems e.g. with ORM-specific dependencies.
+
+Now there are multiple Rails apps, one for every supported ORM: `./active_record_dummy` and `./mongoid_dummy`.
+
+These are very simple apps, basically just clicked together on [railswizard.org](http://railswizard.org).
+
+They contain **no controllers** to be tested, just models that match the tested ones.
+
+### Adding a dummy Rails app
+
+* Create a new Rails app in the folder `./spec/#{orm_name}_dummy`.
+
+* Create to Models used in the spec (`User, Profile, Untouched, Task`).
+
+* Include `UserTemplate` in your `User` model.
+
+* Add `mount SharedEngine::Engine => "/shared", :as => "shared"` to your `routes.rb`
+
+* Add the following lines to your Gemfile:
+
+```ruby
+gem 'shared_engine', :path => '../shared_engine'
+gem 'acts_as_api', :path => '../../'
+```
+
+* Add your dummy app to the `Rakefile` in the root folder by adding it to the `supported_orms` array.
+
+
+If you have to do some special setup (e.g. creating a schema) you can do this in `./spec_helper.rb`.

data/spec/active_record_dummy/.gitignore

@@ -0,0 +1,15 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+# Ignore bundler config
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/spec/active_record_dummy/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gem 'rails', '3.2.3'
+
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+gem 'sqlite3'
+
+gem 'shared_engine', :path => '../shared_engine'
+gem 'acts_as_api', :path => '../../'
+
+group :test do
+  gem 'rspec-rails', '>= 2.5.0'
+  gem 'webrat'  
+end

data/spec/active_record_dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.