api_versioning 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (53) hide show
  1. data/MIT-LICENSE +20 -0
  2. data/README.md +131 -0
  3. data/Rakefile +22 -0
  4. data/app/controllers/api_versioning/action_controller_extension.rb +63 -0
  5. data/app/models/api/base_api.rb +39 -0
  6. data/lib/api_versioning.rb +4 -0
  7. data/lib/api_versioning/engine.rb +12 -0
  8. data/lib/api_versioning/version.rb +3 -0
  9. data/test/dummy/README.rdoc +261 -0
  10. data/test/dummy/Rakefile +7 -0
  11. data/test/dummy/app/assets/javascripts/application.js +15 -0
  12. data/test/dummy/app/assets/stylesheets/application.css +13 -0
  13. data/test/dummy/app/controllers/application_controller.rb +3 -0
  14. data/test/dummy/app/controllers/posts_controller.rb +19 -0
  15. data/test/dummy/app/helpers/application_helper.rb +2 -0
  16. data/test/dummy/app/models/api/posts_api.rb +38 -0
  17. data/test/dummy/app/models/post.rb +3 -0
  18. data/test/dummy/app/views/layouts/application.html.erb +14 -0
  19. data/test/dummy/config.ru +4 -0
  20. data/test/dummy/config/application.rb +59 -0
  21. data/test/dummy/config/boot.rb +10 -0
  22. data/test/dummy/config/database.yml +25 -0
  23. data/test/dummy/config/environment.rb +5 -0
  24. data/test/dummy/config/environments/development.rb +37 -0
  25. data/test/dummy/config/environments/production.rb +67 -0
  26. data/test/dummy/config/environments/test.rb +37 -0
  27. data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
  28. data/test/dummy/config/initializers/inflections.rb +15 -0
  29. data/test/dummy/config/initializers/mime_types.rb +5 -0
  30. data/test/dummy/config/initializers/secret_token.rb +7 -0
  31. data/test/dummy/config/initializers/session_store.rb +8 -0
  32. data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
  33. data/test/dummy/config/locales/en.yml +5 -0
  34. data/test/dummy/config/routes.rb +4 -0
  35. data/test/dummy/db/development.sqlite3 +0 -0
  36. data/test/dummy/db/migrate/20121119074223_create_posts.rb +11 -0
  37. data/test/dummy/db/schema.rb +24 -0
  38. data/test/dummy/db/test.sqlite3 +0 -0
  39. data/test/dummy/log/development.log +52 -0
  40. data/test/dummy/log/test.log +23544 -0
  41. data/test/dummy/public/404.html +26 -0
  42. data/test/dummy/public/422.html +26 -0
  43. data/test/dummy/public/500.html +25 -0
  44. data/test/dummy/public/favicon.ico +0 -0
  45. data/test/dummy/script/rails +6 -0
  46. data/test/factories/post_factory.rb +9 -0
  47. data/test/integration/posts_integration_test.rb +58 -0
  48. data/test/support/helper_test.rb +5 -0
  49. data/test/support/integration_test.rb +14 -0
  50. data/test/support/unit_test.rb +3 -0
  51. data/test/test_helper.rb +25 -0
  52. data/test/unit/api_versioning_test.rb +49 -0
  53. metadata +269 -0
@@ -0,0 +1,20 @@
1
+ Copyright 2012 YOURNAME
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,131 @@
1
+ ApiVersioning
2
+ =============
3
+
4
+ Model based API versioning. Extracted from [launch.ly](http://launch.ly).
5
+
6
+
7
+ Installation
8
+ ------------
9
+
10
+ Add this line to your application's Gemfile:
11
+
12
+ gem 'api_versioning'
13
+
14
+ And then execute:
15
+
16
+ $ bundle
17
+
18
+ Or install it yourself as:
19
+
20
+ $ gem install api_versioning
21
+
22
+
23
+ Setting up an API model (presenter)
24
+ ===================================
25
+
26
+ Let's create a model that will present our API response.
27
+
28
+ Under your models directory, create a folder called api.
29
+ Create your model that will handle API Responses in that api_folder, for example posts_api.rb.
30
+
31
+ ```
32
+ class Api::PostsApi < Api::BaseApi
33
+
34
+ def v1(posts)
35
+
36
+ Jbuilder.encode do |json|
37
+ json.awesome_response 'Hello World'
38
+ end
39
+
40
+ end
41
+
42
+ end
43
+ ```
44
+
45
+ Now if I wanted to add a new API version, I would do something like this
46
+
47
+ ```
48
+ class Api::PostsApi < Api::BaseApi
49
+
50
+ def v1(posts)
51
+
52
+ Jbuilder.encode do |json|
53
+ json.awesome_response 'Hello World'
54
+ end
55
+
56
+ end
57
+
58
+ def v1_1(posts)
59
+
60
+ Jbuilder.encode do |json|
61
+ json.posts items do |json, post|
62
+ timestamps json, post
63
+ json.post post.title
64
+ end
65
+ end
66
+
67
+ end
68
+
69
+ end
70
+ ```
71
+
72
+ I used DHH [JBuilder](https://github.com/rails/jbuilder) to format out the JSON responses, but you can use whatever you like.
73
+
74
+ Setting up your Controller
75
+ ==========================
76
+
77
+ 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:
78
+
79
+ ```
80
+ class PostsController < ApplicationController
81
+
82
+ def index
83
+
84
+ @posts = Post.all
85
+
86
+ respond_to do |format|
87
+ format.json { render_json posts: @posts }
88
+ end
89
+
90
+ end
91
+
92
+ end
93
+ ```
94
+
95
+ Requesting an API Version
96
+ =========================
97
+
98
+ ### About API Version Numbers
99
+
100
+ 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
101
+
102
+ if an API version number is not detected, the latest version is used.
103
+
104
+ ### Requesting an API Version by Request Header
105
+
106
+ ```
107
+ curl -H "X-Api-Version:v1_2" http://localhost/posts.json
108
+ ```
109
+
110
+ ### Requesting an API Version by Query String Parameter
111
+
112
+ Just add the api_version parameter to your request's query string like this
113
+
114
+ ```
115
+ http://localhost/posts.json?api_version=v1_2
116
+ ````
117
+
118
+ ### Order of Precedence
119
+
120
+ If you request API versions via multiple methods, the following order of precedence will apply:
121
+
122
+ 1. Request Parameter params['api_version']
123
+ 2. Request Header HTTP_X_API_VERSION
124
+
125
+ ## Contributing
126
+
127
+ 1. Fork it
128
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
129
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
130
+ 4. Push to the branch (`git push origin my-new-feature`)
131
+ 5. Create new Pull Request
@@ -0,0 +1,22 @@
1
+ #!/usr/bin/env rake
2
+ begin
3
+ require 'bundler/setup'
4
+ rescue LoadError
5
+ puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
6
+ end
7
+
8
+ APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
9
+ load 'rails/tasks/engine.rake'
10
+
11
+ Bundler::GemHelper.install_tasks
12
+
13
+ require 'rake/testtask'
14
+
15
+ Rake::TestTask.new(:test) do |t|
16
+ t.libs << 'lib'
17
+ t.libs << 'test'
18
+ t.test_files = FileList['test/**/*_test.rb']
19
+ t.verbose = false
20
+ end
21
+
22
+ task :default => :test
@@ -0,0 +1,63 @@
1
+ module ApiVersioning
2
+ module ActionControllerExtension
3
+
4
+ def self.included(base)
5
+ base.send(:include, InstanceMethods)
6
+ end
7
+
8
+ module InstanceMethods
9
+
10
+ def api_version
11
+ @api_version ||= detect_api_version
12
+ end
13
+
14
+ def detect_api_version
15
+ extract_api_version_from_param || extract_api_version_from_header
16
+ end
17
+
18
+ def extract_api_version_from_param
19
+ api_version_filter(params['api_version'])
20
+ end
21
+
22
+ def extract_api_version_from_header
23
+ api_version_filter(request.headers["HTTP_X_API_VERSION"])
24
+ end
25
+
26
+ def api_version_filter(version)
27
+ return nil if version.nil?
28
+ matches = version.match(Api::BaseApi::API_VERSION_REGEX)
29
+ matches.nil? ? nil : matches[0].to_sym
30
+ end
31
+
32
+ def render_json(presenters)
33
+
34
+ results = []
35
+
36
+ presenters.each do |key, value|
37
+
38
+ begin
39
+ presenter = Api.const_get("#{key.to_s.camelize}Api").new(api_version)
40
+ rescue NameError => e
41
+ render_api_error "Unknown Presenter"
42
+ end
43
+
44
+ begin
45
+ results << presenter.render(value)
46
+ render :json => results.join(','), :callback => params[:callback]
47
+ rescue Exception => e
48
+ render_api_error "Bad API Request"
49
+ end
50
+
51
+ end
52
+
53
+ end
54
+
55
+ def render_api_error(message, status=400)
56
+ status_code = Rack::Utils.status_code(status)
57
+ status_description = Rack::Utils::HTTP_STATUS_CODES[status_code]
58
+ render :status => status, :json => { status_code: status_code, status_description: status_description, message: message }.to_json
59
+ end
60
+
61
+ end
62
+ end
63
+ end
@@ -0,0 +1,39 @@
1
+ class Api::BaseApi
2
+
3
+ attr_accessor :api_version
4
+
5
+ API_VERSION_REGEX = /v[0-9]+(_[0-9]+)*/i
6
+
7
+ def initialize(version=nil)
8
+ set_api_version(version)
9
+ end
10
+
11
+ def render(data)
12
+ respond_to?(api_version) ? self.send(api_version, data) : nil
13
+ end
14
+
15
+ def timestamps(json, data)
16
+ json.id data.id.to_s
17
+ json.created_at data.created_at
18
+ json.updated_at data.updated_at
19
+ end
20
+
21
+ private
22
+ def latest_version
23
+ api_versions.sort.last
24
+ end
25
+
26
+ def api_versions
27
+ @@api_versions ||= self.class.instance_methods.grep(API_VERSION_REGEX)
28
+ end
29
+
30
+ def api_version?(version)
31
+ return false if version.nil?
32
+ api_versions.include?(version.to_sym)
33
+ end
34
+
35
+ def set_api_version(version)
36
+ self.api_version = (api_version?(version) ? version.to_sym : latest_version)
37
+ end
38
+
39
+ end
@@ -0,0 +1,4 @@
1
+ require "api_versioning/engine"
2
+
3
+ module ApiVersioning
4
+ end
@@ -0,0 +1,12 @@
1
+ module ApiVersioning
2
+ class Engine < ::Rails::Engine
3
+ isolate_namespace ApiVersioning
4
+
5
+ initializer 'api_versioning.controller' do |app|
6
+ ActiveSupport.on_load(:action_controller) do
7
+ include ApiVersioning::ActionControllerExtension
8
+ end
9
+ end
10
+
11
+ end
12
+ end
@@ -0,0 +1,3 @@
1
+ module ApiVersioning
2
+ VERSION = "0.0.1"
3
+ end
@@ -0,0 +1,261 @@
1
+ == Welcome to Rails
2
+
3
+ Rails is a web-application framework that includes everything needed to create
4
+ database-backed web applications according to the Model-View-Control pattern.
5
+
6
+ This pattern splits the view (also called the presentation) into "dumb"
7
+ templates that are primarily responsible for inserting pre-built data in between
8
+ HTML tags. The model contains the "smart" domain objects (such as Account,
9
+ Product, Person, Post) that holds all the business logic and knows how to
10
+ persist themselves to a database. The controller handles the incoming requests
11
+ (such as Save New Account, Update Product, Show Post) by manipulating the model
12
+ and directing data to the view.
13
+
14
+ In Rails, the model is handled by what's called an object-relational mapping
15
+ layer entitled Active Record. This layer allows you to present the data from
16
+ database rows as objects and embellish these data objects with business logic
17
+ methods. You can read more about Active Record in
18
+ link:files/vendor/rails/activerecord/README.html.
19
+
20
+ The controller and view are handled by the Action Pack, which handles both
21
+ layers by its two parts: Action View and Action Controller. These two layers
22
+ are bundled in a single package due to their heavy interdependence. This is
23
+ unlike the relationship between the Active Record and Action Pack that is much
24
+ more separate. Each of these packages can be used independently outside of
25
+ Rails. You can read more about Action Pack in
26
+ link:files/vendor/rails/actionpack/README.html.
27
+
28
+
29
+ == Getting Started
30
+
31
+ 1. At the command prompt, create a new Rails application:
32
+ <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
33
+
34
+ 2. Change directory to <tt>myapp</tt> and start the web server:
35
+ <tt>cd myapp; rails server</tt> (run with --help for options)
36
+
37
+ 3. Go to http://localhost:3000/ and you'll see:
38
+ "Welcome aboard: You're riding Ruby on Rails!"
39
+
40
+ 4. Follow the guidelines to start developing your application. You can find
41
+ the following resources handy:
42
+
43
+ * The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
44
+ * Ruby on Rails Tutorial Book: http://www.railstutorial.org/
45
+
46
+
47
+ == Debugging Rails
48
+
49
+ Sometimes your application goes wrong. Fortunately there are a lot of tools that
50
+ will help you debug it and get it back on the rails.
51
+
52
+ First area to check is the application log files. Have "tail -f" commands
53
+ running on the server.log and development.log. Rails will automatically display
54
+ debugging and runtime information to these files. Debugging info will also be
55
+ shown in the browser on requests from 127.0.0.1.
56
+
57
+ You can also log your own messages directly into the log file from your code
58
+ using the Ruby logger class from inside your controllers. Example:
59
+
60
+ class WeblogController < ActionController::Base
61
+ def destroy
62
+ @weblog = Weblog.find(params[:id])
63
+ @weblog.destroy
64
+ logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
65
+ end
66
+ end
67
+
68
+ The result will be a message in your log file along the lines of:
69
+
70
+ Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
71
+
72
+ More information on how to use the logger is at http://www.ruby-doc.org/core/
73
+
74
+ Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
75
+ several books available online as well:
76
+
77
+ * Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
78
+ * Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
79
+
80
+ These two books will bring you up to speed on the Ruby language and also on
81
+ programming in general.
82
+
83
+
84
+ == Debugger
85
+
86
+ Debugger support is available through the debugger command when you start your
87
+ Mongrel or WEBrick server with --debugger. This means that you can break out of
88
+ execution at any point in the code, investigate and change the model, and then,
89
+ resume execution! You need to install ruby-debug to run the server in debugging
90
+ mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
91
+
92
+ class WeblogController < ActionController::Base
93
+ def index
94
+ @posts = Post.all
95
+ debugger
96
+ end
97
+ end
98
+
99
+ So the controller will accept the action, run the first line, then present you
100
+ with a IRB prompt in the server window. Here you can do things like:
101
+
102
+ >> @posts.inspect
103
+ => "[#<Post:0x14a6be8
104
+ @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
105
+ #<Post:0x14a6620
106
+ @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
107
+ >> @posts.first.title = "hello from a debugger"
108
+ => "hello from a debugger"
109
+
110
+ ...and even better, you can examine how your runtime objects actually work:
111
+
112
+ >> f = @posts.first
113
+ => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
114
+ >> f.
115
+ Display all 152 possibilities? (y or n)
116
+
117
+ Finally, when you're ready to resume execution, you can enter "cont".
118
+
119
+
120
+ == Console
121
+
122
+ The console is a Ruby shell, which allows you to interact with your
123
+ application's domain model. Here you'll have all parts of the application
124
+ configured, just like it is when the application is running. You can inspect
125
+ domain models, change values, and save to the database. Starting the script
126
+ without arguments will launch it in the development environment.
127
+
128
+ To start the console, run <tt>rails console</tt> from the application
129
+ directory.
130
+
131
+ Options:
132
+
133
+ * Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
134
+ made to the database.
135
+ * Passing an environment name as an argument will load the corresponding
136
+ environment. Example: <tt>rails console production</tt>.
137
+
138
+ To reload your controllers and models after launching the console run
139
+ <tt>reload!</tt>
140
+
141
+ More information about irb can be found at:
142
+ link:http://www.rubycentral.org/pickaxe/irb.html
143
+
144
+
145
+ == dbconsole
146
+
147
+ You can go to the command line of your database directly through <tt>rails
148
+ dbconsole</tt>. You would be connected to the database with the credentials
149
+ defined in database.yml. Starting the script without arguments will connect you
150
+ to the development database. Passing an argument will connect you to a different
151
+ database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
152
+ PostgreSQL and SQLite 3.
153
+
154
+ == Description of Contents
155
+
156
+ The default directory structure of a generated Ruby on Rails application:
157
+
158
+ |-- app
159
+ | |-- assets
160
+ | |-- images
161
+ | |-- javascripts
162
+ | `-- stylesheets
163
+ | |-- controllers
164
+ | |-- helpers
165
+ | |-- mailers
166
+ | |-- models
167
+ | `-- views
168
+ | `-- layouts
169
+ |-- config
170
+ | |-- environments
171
+ | |-- initializers
172
+ | `-- locales
173
+ |-- db
174
+ |-- doc
175
+ |-- lib
176
+ | `-- tasks
177
+ |-- log
178
+ |-- public
179
+ |-- script
180
+ |-- test
181
+ | |-- fixtures
182
+ | |-- functional
183
+ | |-- integration
184
+ | |-- performance
185
+ | `-- unit
186
+ |-- tmp
187
+ | |-- cache
188
+ | |-- pids
189
+ | |-- sessions
190
+ | `-- sockets
191
+ `-- vendor
192
+ |-- assets
193
+ `-- stylesheets
194
+ `-- plugins
195
+
196
+ app
197
+ Holds all the code that's specific to this particular application.
198
+
199
+ app/assets
200
+ Contains subdirectories for images, stylesheets, and JavaScript files.
201
+
202
+ app/controllers
203
+ Holds controllers that should be named like weblogs_controller.rb for
204
+ automated URL mapping. All controllers should descend from
205
+ ApplicationController which itself descends from ActionController::Base.
206
+
207
+ app/models
208
+ Holds models that should be named like post.rb. Models descend from
209
+ ActiveRecord::Base by default.
210
+
211
+ app/views
212
+ Holds the template files for the view that should be named like
213
+ weblogs/index.html.erb for the WeblogsController#index action. All views use
214
+ eRuby syntax by default.
215
+
216
+ app/views/layouts
217
+ Holds the template files for layouts to be used with views. This models the
218
+ common header/footer method of wrapping views. In your views, define a layout
219
+ using the <tt>layout :default</tt> and create a file named default.html.erb.
220
+ Inside default.html.erb, call <% yield %> to render the view using this
221
+ layout.
222
+
223
+ app/helpers
224
+ Holds view helpers that should be named like weblogs_helper.rb. These are
225
+ generated for you automatically when using generators for controllers.
226
+ Helpers can be used to wrap functionality for your views into methods.
227
+
228
+ config
229
+ Configuration files for the Rails environment, the routing map, the database,
230
+ and other dependencies.
231
+
232
+ db
233
+ Contains the database schema in schema.rb. db/migrate contains all the
234
+ sequence of Migrations for your schema.
235
+
236
+ doc
237
+ This directory is where your application documentation will be stored when
238
+ generated using <tt>rake doc:app</tt>
239
+
240
+ lib
241
+ Application specific libraries. Basically, any kind of custom code that
242
+ doesn't belong under controllers, models, or helpers. This directory is in
243
+ the load path.
244
+
245
+ public
246
+ The directory available for the web server. Also contains the dispatchers and the
247
+ default HTML files. This should be set as the DOCUMENT_ROOT of your web
248
+ server.
249
+
250
+ script
251
+ Helper scripts for automation and generation.
252
+
253
+ test
254
+ Unit and functional tests along with fixtures. When using the rails generate
255
+ command, template test files will be generated for you and placed in this
256
+ directory.
257
+
258
+ vendor
259
+ External libraries that the application depends on. Also includes the plugins
260
+ subdirectory. If the app has frozen rails, those gems also go here, under
261
+ vendor/rails/. This directory is in the load path.