biceps 0.0.1 → 0.0.2

data/lib/biceps.rb

@@ -1,5 +1,11 @@
-require 'biceps/routing'
+require 'biceps/core_ext/action_dispatch/routing/mapper'
+require 'biceps/core_ext/action_controller/base'
 
 module Biceps
-  autoload :ApiVersion, 'biceps/api_version'
+  autoload :ApiVersion,      'biceps/api_version'
+  autoload :ModelVersioning, 'biceps/model_versioning'
+  autoload :Jsonp,           'biceps/jsonp'
+  autoload :Serializer,      'biceps/serializer'
+  autoload :Parser,          'biceps/parser'
+  autoload :Builder,         'biceps/builder'
 end

data/lib/biceps/api_version.rb

@@ -1,36 +1,13 @@
 module Biceps
   class ApiVersion
-    attr_accessor :version, :accept
+    attr_accessor :version
 
     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
+      Biceps::Parser.new(request, version).valid?
     end
   end
 end

data/lib/biceps/builder.rb

@@ -0,0 +1,32 @@
+module Biceps
+  module Builder
+
+    # instiantiate_for_api(User, params[:user]) == Constructor.new(User,params[:user], 1)
+    def self.new(resource, params, version)
+      begin
+        constant = "Builders::#{resource}::V#{version}".constantize
+        instance = constant.new(resource.new, params).resource
+      rescue NameError
+        #
+        # The builder for that version is not defined
+        # Use the model's internal initialize
+        instance = resource.new params
+      end
+
+      instance
+    end
+
+    class Base
+      attr_reader :resource, :params
+
+      extend ActiveModel::Callbacks
+      define_model_callbacks :initialize, :only => :after
+
+      def initialize(resource, params)
+        run_callbacks :initialize do
+          @resource, @params = resource, params
+        end
+      end
+    end
+  end
+end

data/lib/biceps/core_ext/action_controller/base.rb

@@ -0,0 +1,7 @@
+ActionController::Base.class_eval do
+
+  def initialize_for_api(resource, params)
+    api_version = Biceps::Parser.new(request).version
+    Biceps::Builder.new(resource, params, api_version)
+  end
+end

data/lib/biceps/{routing.rb → core_ext/action_dispatch/routing/mapper.rb}

@@ -1,3 +1,4 @@
+require 'action_controller'
 #
 # Monkey Patching routes to add the `api_version` method
 # This allows us to define both the namespace and the constraint all together
@@ -5,9 +6,14 @@
 module ActionDispatch::Routing
   class Mapper
 
-    def api_version(version)
+    def api_version(version, opts={})
+      if opts[:module] && opts[:module].empty?
+        scope_module = nil
+      else
+        scope_module = opts[:module] || "v#{version}"
+      end
 
-      scope :module => "v#{version}" do
+      scope :module => scope_module do
         constraints Biceps::ApiVersion.new(version) do
           yield if block_given?
         end

data/lib/biceps/jsonp.rb

@@ -0,0 +1,67 @@
+module Biceps
+  class Jsonp
+    attr_reader :app, :callback_param
+
+    def initialize(app, options = {})
+      @app = app
+      @callback_param = options[:callback_param] || 'callback'
+    end
+
+    # Proxies the request to the application, stripping out the JSON-P callback
+    # method and padding the response with the appropriate callback format.
+    #
+    # Changes nothing if no <tt>callback</tt> param is specified.
+    #
+    def call(env)
+      Parser.new(self, env).perform
+    end
+
+    class Parser
+      attr_reader :jsonp, :env, :request
+      attr_accessor :status, :headers, :response
+
+      delegate :callback_param, :to => :jsonp
+      delegate :app, :to => :jsonp
+
+      def initialize(jsonp, env)
+        @jsonp, @env = jsonp, env
+        @request = Rack::Request.new(@env)
+        @status, @headers, @response = app.call(env)
+      end
+
+      def perform
+        if callback && headers['Content-Type'] =~ /json/i
+          @response = pad
+          headers['Content-Length'] = response.first.length.to_s
+          headers['Content-Type'] = 'application/javascript'
+        end
+        [status, headers, response]
+      end
+
+      private
+      def callback
+        @callback ||= request.params.delete(callback_param)
+      end
+
+      # Pads the response with the appropriate callback format according to the
+      # JSON-P spec/requirements.
+      #
+      # The Rack response spec indicates that it should be enumerable. The method
+      # of combining all of the data into a single string makes sense since JSON
+      # is returned as a full string.
+      #
+      def pad(body = "")
+        response.each {|s| body << s }
+        ["#{callback}({'metadata': #{metadata}, 'data': #{body}})"]
+      end
+
+      def metadata
+        # TODO : add all the non-core HTTP headers
+        {
+          "status" => status
+        }.to_json
+      end
+
+    end
+  end
+end

data/lib/biceps/model_versioning.rb

@@ -0,0 +1,33 @@
+module Biceps
+  module ModelVersioning
+
+    def self.included(klass)
+      klass.class_eval do
+
+        protected
+        alias :old_api_behavior :api_behavior
+        def api_behavior(error)
+          if api_version
+            begin
+              constant = "Serializers::#{resource.class}::V#{api_version}".constantize
+
+              @resource = constant.new(resource)
+            rescue NameError
+              #
+              # The serializer for that version is not defined
+              # Use the model's internal serialize
+              #
+            end
+          end
+
+          old_api_behavior(error)
+        end
+
+        private
+        def api_version
+          Biceps::Parser.new(request).version
+        end
+      end
+    end
+  end
+end

data/lib/biceps/parser.rb

@@ -0,0 +1,31 @@
+module Biceps
+  class Parser
+    attr_accessor :request, :valid_versions
+
+    def initialize(request, valid_versions=nil)
+      @request = request
+      @valid_versions = [valid_versions].flatten
+    end
+
+    def valid?
+      valid_versions.include?(version)
+    end
+
+    def version
+      is_api_call?[1].to_i if is_api_call?
+    end
+
+    private
+    def is_api_call?
+      request.accept.match(regex) if request.accept
+    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/serializer.rb

@@ -0,0 +1,22 @@
+module Biceps
+  class Serializer
+    include ActiveModel::Serialization
+    include ActiveModel::Serializers::JSON
+    include ActiveModel::Serializers::Xml
+
+    attr_accessor :parent
+    delegate :respond_to?, :to => :parent
+
+    def initialize(parent)
+      @parent = parent
+    end
+
+    def method_missing(method, *args, &block)
+      if parent.respond_to?(method)
+        parent.send(method, *args, &block)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/biceps/version.rb

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

metadata

@@ -1,31 +1,33 @@
 --- !ruby/object:Gem::Specification
 name: biceps
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
-- Evome
-- Damien MATHIEU
+- Damien Mathieu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-30 00:00:00.000000000Z
+date: 2011-10-27 00:00:00.000000000Z
 dependencies: []
-description: Create a versionned API with rails
-email: 
+description: ! '[description]'
+email: 42@dmathieu.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/biceps.rb
 - lib/biceps/api_version.rb
-- lib/biceps/routing.rb
+- lib/biceps/builder.rb
+- lib/biceps/core_ext/action_controller/base.rb
+- lib/biceps/core_ext/action_dispatch/routing/mapper.rb
+- lib/biceps/jsonp.rb
+- lib/biceps/model_versioning.rb
+- lib/biceps/parser.rb
+- lib/biceps/serializer.rb
 - lib/biceps/version.rb
-- lib/biceps.rb
-- MIT-LICENSE
-- Rakefile
-- README.md
-homepage: 
+homepage: https://github.com//biceps
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -44,9 +46,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
+rubyforge_project: ! '[none]'
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Easy versionned API routing
+summary: ! '[summary]'
 test_files: []

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-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

@@ -1,89 +0,0 @@
-# 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

@@ -1,24 +0,0 @@
-# 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