biceps 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Evome
+
+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,89 @@
+# Biceps
+
+Easily route your rails-based versionned API
+[![Travis](https://secure.travis-ci.org/evome/biceps.png)](http://travis-ci.org/evome/biceps)
+
+## Installation
+
+Biceps heavily uses the convention over configuration principle.  
+To install it, you just need to add it to your Gemfile.
+
+    gem 'biceps'
+
+## Defining routes
+
+Once Biceps is installed, you can start adding api-versionned routes.  
+Your `config/routes.rb` file could look like the following :
+
+    MyApp:Application.routes.draw do
+      root :to => "home#index"
+
+      api_version(1) do
+        get '/me' => "users#show"
+      end
+
+      api_version(2) do
+        get '/user' => "users#show"
+      end
+    end
+
+This will create two routes :
+
+    GET    /me(.:format)                                 {:controller=>"v1/users", :action=>"show"}
+    GET    /user(.:format)                               {:controller=>"v2/users", :action=>"show"}
+
+As you can see in the routing, both are leading to different namespaces
+: v1 and v2.  
+Both namespaces are the version of your API.
+
+## Calling the API
+
+When you want to call the API, you need to specify the Accept header
+like this :
+
+    application/json,application/vnd.my_app;ver=1
+
+When my_app is your application's name (based on the module name at
+`MyApp::Application`).
+
+Here is, for example, how you could do it with [faraday](https://github.com/technoweenie/faraday)
+
+    connexion = Faraday.new(:url => 'http://api.yourapplication')
+    connexion.get do |req|
+      req.url '/me'
+      req.headers['HTTP_ACCEPT'] = 'application/json, application/vnd.my_app;ver=1'
+      req.params['access_token'] = 'xxx'
+    end
+
+Or, with jQuery, we do it like this :
+
+    $.ajaxSetup({
+      accepts: {
+        my_app: "application/json,application/vnd.my_app;ver=1"
+      }
+    });
+
+    $.ajax({
+      url: '/me'
+      dataType: 'my_app'
+    }).always(function(response) {
+      json = JSON.parse(response.responseText)
+    });
+
+
+## Contributing
+
+We're open to any contribution. It has to be tested properly though.
+
+* [Fork](http://help.github.com/forking/) the project
+* Do your changes and commit them to your repository
+* Test your changes. We won't accept any untested contributions (except if they're not testable).
+* Create an [issue](https://github.com/evome/biceps/issues) with a link to your commits.
+
+## Maintainers
+
+* Evome ([evome.fr](http://evome.fr))
+* Damien MATHIEU ([github/dmathieu](http://github.com/dmathieu), [dmathieu.com](http://dmathieu.com))
+
+## License
+MIT License. Copyright 2010 Evome. http://evome.fr

data/Rakefile

@@ -0,0 +1,24 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/rdoctask'
+
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+task :default => :spec
+RSpec::Core::RakeTask.new(:spec)
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Oauned'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/biceps.rb

@@ -0,0 +1,5 @@
+require 'biceps/routing'
+
+module Biceps
+  autoload :ApiVersion, 'biceps/api_version'
+end

data/lib/biceps/api_version.rb

@@ -0,0 +1,36 @@
+module Biceps
+  class ApiVersion
+    attr_accessor :version, :accept
+
+    def initialize(version)
+      @version = version
+    end
+
+    def matches?(request)
+      @accept = request.accept
+      valid_api_version?
+    end
+
+
+    private
+    def valid_api_version?
+      request_version == version
+    end
+
+    def request_version
+      is_api_call?[1].to_i if is_api_call?
+    end
+
+    def is_api_call?
+      @is_api_call ||= accept.match(regex)
+    end
+
+    def regex
+      Regexp.new("application/vnd.#{app_name};ver=([0-9]+)")
+    end
+
+    def app_name
+      Rails.application.class.to_s.split('::').first.underscore
+    end
+  end
+end

data/lib/biceps/routing.rb

@@ -0,0 +1,17 @@
+#
+# Monkey Patching routes to add the `api_version` method
+# This allows us to define both the namespace and the constraint all together
+#
+module ActionDispatch::Routing
+  class Mapper
+
+    def api_version(version)
+
+      scope :module => "v#{version}" do
+        constraints Biceps::ApiVersion.new(version) do
+          yield if block_given?
+        end
+      end
+    end
+  end
+end

data/lib/biceps/version.rb

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

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: biceps
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Evome
+- Damien MATHIEU
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-30 00:00:00.000000000Z
+dependencies: []
+description: Create a versionned API with rails
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/biceps/api_version.rb
+- lib/biceps/routing.rb
+- lib/biceps/version.rb
+- lib/biceps.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Easy versionned API routing
+test_files: []