api_versioning 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,131 @@
+ApiVersioning
+=============
+
+Model based API versioning. Extracted from [launch.ly](http://launch.ly).
+
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+    gem 'api_versioning'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install api_versioning
+
+
+Setting up an API model (presenter)
+===================================
+
+Let's create a model that will present our API response.
+
+Under your models directory, create a folder called api.
+Create your model that will handle API Responses in that api_folder, for example posts_api.rb.
+
+```
+class Api::PostsApi < Api::BaseApi
+
+	def v1(posts)
+
+		Jbuilder.encode do |json|
+			json.awesome_response 'Hello World'
+		end
+
+	end
+
+end
+```
+
+Now if I wanted to add a new API version, I would do something like this
+
+```
+class Api::PostsApi < Api::BaseApi
+
+	def v1(posts)
+
+		Jbuilder.encode do |json|
+			json.awesome_response 'Hello World'
+		end
+
+	end
+
+	def v1_1(posts)
+
+		Jbuilder.encode do |json|
+			json.posts items do |json, post|
+				timestamps json, post
+				json.post post.title
+			end
+		end
+
+	end
+
+end
+```
+
+I used DHH [JBuilder](https://github.com/rails/jbuilder) to format out the JSON responses, but you can use whatever you like.
+
+Setting up your Controller
+==========================
+
+There is a method called render_json that accepts the collections that you would like rendered as an API response. Here is a sample implementation:
+
+```
+class PostsController < ApplicationController
+
+	def index
+
+		@posts = Post.all
+      
+		respond_to do |format|
+			format.json { render_json posts: @posts }
+		end
+
+	end
+
+end
+```
+
+Requesting an API Version
+=========================
+
+### About API Version Numbers
+
+We have adopted API version numbers that consist of a major and minor API version number. The major and minor API version number consists of digits 0-9 and are spearated by an underscore. For example, 1_2 refers to API version 1.2
+
+if an API version number is not detected, the latest version is used.
+
+### Requesting an API Version by Request Header
+
+```
+curl -H "X-Api-Version:v1_2" http://localhost/posts.json
+```
+
+### Requesting an API Version by Query String Parameter
+
+Just add the api_version parameter to your request's query string like this
+
+```
+http://localhost/posts.json?api_version=v1_2
+````
+
+### Order of Precedence
+
+If you request API versions via multiple methods, the following order of precedence will apply:
+
+1. Request Parameter params['api_version']
+2. Request Header HTTP_X_API_VERSION
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,22 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = false
+end
+
+task :default => :test

data/app/controllers/api_versioning/action_controller_extension.rb

@@ -0,0 +1,63 @@
+module ApiVersioning
+	module ActionControllerExtension
+	
+		def self.included(base)
+			base.send(:include, InstanceMethods)
+		end
+
+		module InstanceMethods
+
+			def api_version
+				@api_version ||= detect_api_version
+			end
+
+			def detect_api_version
+				extract_api_version_from_param || extract_api_version_from_header
+			end
+
+			def extract_api_version_from_param
+				api_version_filter(params['api_version'])
+			end
+
+			def extract_api_version_from_header
+				api_version_filter(request.headers["HTTP_X_API_VERSION"])
+			end
+
+			def api_version_filter(version)
+				return nil if version.nil?
+				matches = version.match(Api::BaseApi::API_VERSION_REGEX)
+				matches.nil? ? nil : matches[0].to_sym
+			end
+
+			def render_json(presenters)
+
+				results = []
+
+				presenters.each do |key, value|
+
+					begin
+						presenter = Api.const_get("#{key.to_s.camelize}Api").new(api_version)
+					rescue NameError => e
+						render_api_error "Unknown Presenter"
+					end
+
+					begin
+						results << presenter.render(value)
+						render :json => results.join(','), :callback => params[:callback]
+					rescue Exception => e
+						render_api_error "Bad API Request"
+					end
+
+				end
+
+			end
+		  
+			def render_api_error(message, status=400)
+				status_code = Rack::Utils.status_code(status)
+				status_description = Rack::Utils::HTTP_STATUS_CODES[status_code]
+				render :status => status, :json => { status_code: status_code, status_description: status_description, message: message }.to_json
+			end  
+
+		end
+	end
+end

data/app/models/api/base_api.rb

@@ -0,0 +1,39 @@
+class Api::BaseApi
+  
+  attr_accessor :api_version
+
+  API_VERSION_REGEX = /v[0-9]+(_[0-9]+)*/i
+  
+  def initialize(version=nil)
+    set_api_version(version)
+  end
+  
+  def render(data)
+    respond_to?(api_version) ? self.send(api_version, data) : nil
+  end
+  
+  def timestamps(json, data)
+    json.id data.id.to_s
+    json.created_at data.created_at
+    json.updated_at data.updated_at
+  end
+  
+  private
+  def latest_version
+    api_versions.sort.last
+  end
+
+  def api_versions
+    @@api_versions ||= self.class.instance_methods.grep(API_VERSION_REGEX)
+  end
+  
+  def api_version?(version)
+    return false if version.nil?
+    api_versions.include?(version.to_sym)
+  end
+
+  def set_api_version(version)
+    self.api_version = (api_version?(version) ? version.to_sym : latest_version)
+  end
+
+end

data/lib/api_versioning.rb

@@ -0,0 +1,4 @@
+require "api_versioning/engine"
+
+module ApiVersioning
+end

data/lib/api_versioning/engine.rb

@@ -0,0 +1,12 @@
+module ApiVersioning
+  class Engine < ::Rails::Engine
+    isolate_namespace ApiVersioning
+
+    initializer 'api_versioning.controller' do |app|
+      ActiveSupport.on_load(:action_controller) do  
+        include ApiVersioning::ActionControllerExtension
+      end
+    end
+
+  end
+end

data/lib/api_versioning/version.rb

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

data/test/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.