raisin 0.1.2 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e79d5231cce8b38d975dd0b1bee00793e427d01d
+  data.tar.gz: 822e2c2868222cdef4265df60e3852c3c98611c0
+SHA512:
+  metadata.gz: d94015c5476fc070466a0299cedd2ce9d58d71a392fcf5e412a1ee12c880a638c84afff29f4782c113dd60347171dd7c0f076dde9c74c05b0bdff0bb03a0f461
+  data.tar.gz: 15d704101d562793fcb3ae885438eac47d49c5f44c081ae27fd3cc99949b990c5ab3ddf2c6ee1cd5be5c19116af9ceb02d1949046a49f2d689c3d936067735dd

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.byebug_history

data/Gemfile

@@ -2,3 +2,10 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in raisin.gemspec
 gemspec
+
+gem 'byebug'
+
+group :test do
+  gem 'minitest', '~> 5.10'
+  gem 'rake'
+end

data/{LICENSE.txt → MIT-LICENSE}

@@ -19,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,163 +1,52 @@
 # Raisin
 
-Elegant, modular and performant APIs in Rails
+API versioning via the Accept header.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install as a gem :
 
-    gem 'raisin'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install raisin
-
-## Usage
-
-Raisin is composed of two main elements : a router and a lists of API. An API is a file containing your endpoints,
-with their paths, implementation and documentation. The router is where you modelize your API, saying which
-API goes to which version.
-
-Under the hood, raisin will generate classes (one for each enpoint), enabling us to use unit test for them, but keeping it transparent for Rails router.
-
-Here's a basic example of an API
-
-```ruby
-class UsersAPI < Raisin::API
-  get '/users' do
-    expose(:user) { User.all }
-  end
-
-  post do
-    expose(:user) { User.new(params[:user]) }
-
-    response do
-      user.save
-      respond_with(user)
-    end
-  end
-end
 ```
-
-### Endpoints
-
-Each endoint is defined by the http verb used to access it, its path and its implementation. When the path is omitted, raisin will default it to '/'. And since we are in the UsersAPI, raisin will set a prefix to 'users'. So the `post do` is equivalent to `post '/users' do`.
-Same for the get method, since its path is the same as the prefix, it can be omitted.
-
-The `expose` method allows you to create variables elegantly and to access it in your endpoints body or your views (in you gems like jbuilder or rabl-rails). These exposed variables are evaluated in the response block so you have access to everything (like the params object).
-
-The response block is where your endpoint logic goes. It can be optionnal, as you can see in the get method. If no response is specified, raisin will behave like a a standart rails controller method (thus trying to render a file with tht same name as the endpoint or fallback to API rendering)
-
-We talk about the name of the endpoint but how is it determine? raisin is smart enough to recognize basic CRUD operations and RESTful endpoint
-
-```ruby
-class UsersAPI < Raisin::API
-  get '/users' {}       # index
-  post '/users' {}      # create
-
-  put '/users/:id/foo'  # foo
-end
+gem install raisin
 ```
 
-You can see theses names if you run `rake routes` in your console. If you prefer to name your endpoint yourself, you can do it by passing an `:as` option
+or add directly to your `Gemfile`
 
-```ruby
-get '/users', as: :my_method_name
 ```
-
-### Namespaces
-
-You often have endpoint that have a portion of their path in commons, a namespace in raisin. The most used is RESTful applications is the "member" namespace, that look like `/resource_name/:id`.
-
-raisin provides both generic namespace and member out of the box
-
-```ruby
-class UsersAPI < Raisin::API
-  namespace 'foo' do
-    get '/bar' {}   # GET /foo/bar
-  end
-
-  member do
-    put do          # PUT /users/:id
-      response do
-        user.update_attributes(params[:user])
-        respond_with(user)
-      end
-    end
-  end
-end
+gem 'raisin'
 ```
 
-You see that in the `update` method we used a user variable. This is because you can also expose variable for a whole namespace, which does member automatically (the variable name will be the resource name singularize, 'user' in our example)
-
-Namespaces can be nested.
-
-### Miscellanous
-
-You can add `single_resource` in your API for single resources.
-
-Resources can be nested just as regular Rails. For example
-
-```ruby
-class CommentsAPI < Raisin::API
-  nested_into_resource :posts
-
-  get '/comments/:id' do  # GET /posts/:post_id/comments/:id
-    expose(:comment) { post.comments.find(params[:id]) }
-  end
-end
-```
+## Usage
 
-### Router
+`raisin` allows you to encapsulate your routes within API versions, using a custom `Accept` header to routes them to your controller accordingly.
 
-raisin router is similar to the `routes.rb` in Rails. APIs that appears at the top have precedence on the ones after. Versionning is done by encapsulating APIs inside `version` block. `:all` can be used is a part of your api is accessible for all versions.
+It uses the fact that Rails router is resolved top to bottom.
 
 ```ruby
-# /app/api/my_api.rb
-class MyApi < Raisin::Router
-  version :v2, using: :header, vendor: 'mycompany' do
-    mount CommentsApi
-  end
+# config/routes.rb
 
-  version [:v2, :v1] do
-    mount PostsApi
-    mount UsersApi
+Rails.application.routes.draw do
+  api :v2 do
+    resources :users, only: :show
   end
 
-  version :all do
-    mount LoginApi
+  api :v1, default: true do
+    resources :users
+    get '/users/sign_in', to: 'sessions#new'
   end
 end
-
-# /config/routes.rb
-
-mount_api MyApi
 ```
 
-Versionning can be done via the HTTP Accept header (application/vnd.mycompany-v1+json for example) or via the URL
-(/v1/users/). When using the header versionning, the vendor must be set. These options can be set globally when configuring raisin.
+Clients using the version `v2` will have access to all the methods from the `v1` version plus their `/users/show` routes will be overriden the the new one define in the first `api` block.
 
 ## Configuration
 
 ```ruby
 Raisin.configure do |c|
-  c.version.using =   :header
-  c.version.vendor =  'mycompany'
+  c.vendor = 'mycompany' # replace with your vendor
 end
 ```
 
-If you are using versionning via header, you also need to add a middleware to your application stack
-
-```ruby
-#config/application.rb
-
-config.middleware.use Raisin::Middleware
-```
-
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1 +1,12 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/test_*.rb'
+  # t.verbose = true
+end
+
+
+task :default => :test

data/lib/raisin.rb

@@ -1,13 +1,19 @@
 require 'raisin/version'
-require 'raisin/configuration'
-
-require 'raisin/base'
+require 'raisin/mapper'
 require 'raisin/middleware'
 
+require 'raisin/railtie' if defined?(Rails)
+
 module Raisin
   def self.configure
-    yield Configuration if block_given?
+    yield self
   end
-end
 
-require 'raisin/railtie'
+  def self.vendor
+    @vendor || raise('`vendor` is not configured')
+  end
+
+  def self.vendor=(value)
+    @vendor = value
+  end
+end

data/lib/raisin/mapper.rb

@@ -0,0 +1,17 @@
+require 'raisin/version_constraint'
+
+module Raisin
+  module Mapper
+    def api(version, default: false)
+      return unless block_given?
+
+      version     = version.to_s
+      raise 'Version is missing in constraint' if version.blank?
+      constraint  = Raisin::VersionConstraint.new(version) unless default
+
+      scope(module: version, constraints: constraint) do
+        yield
+      end
+    end
+  end
+end

data/lib/raisin/middleware.rb

@@ -4,29 +4,27 @@ module Raisin
   # It stores version and format accepted by the client in the env.
   #
   class Middleware
-    ACCEPT_REGEXP = /application\/vnd\.(?<vendor>[a-z]+)-(?<version>v[0-9]+)\+(?<format>[a-z]+)?/
+    ACCEPT_REGEXP = /\Aapplication\/vnd\.(?<vendor>[a-z]+).(?<version>v[0-9]+)\+(?<format>[a-z]+)\Z/
 
     def initialize(app)
-      @app = app
-      @vendor = Configuration.version.vendor
+      @app    = app
+      @vendor = Raisin.vendor
     end
 
     def call(env)
-      @env = env
-      verify_accept_header
-      @app.call(@env)
+      extract_version_from_accept_header(ActionDispatch::Request.new(env))
+      @app.call(env)
     end
 
     private
 
-    def verify_accept_header
-      if (matches = ACCEPT_REGEXP.match(@env['HTTP_ACCEPT'])) && @vendor == matches[:vendor]
-        @env['raisin.version']  = matches[:version]
-        @env['raisin.format']   = "application/#{matches[:format]}"
-        true
-      else
-        false
+    def extract_version_from_accept_header(req)
+      header = req.get_header('HTTP_ACCEPT'.freeze).to_s.strip
+
+      if (matches = ACCEPT_REGEXP.match(header)) && @vendor == matches[:vendor]
+        req.set_header('raisin.version'.freeze, matches[:version])
+        req.format = matches[:format]
       end
     end
   end
-end
+end

data/lib/raisin/railtie.rb

@@ -1,7 +1,12 @@
-require 'raisin/rails/routes'
-require 'raisin/rails/request'
-
 module Raisin
   class Railtie < Rails::Railtie
+
+    initializer 'raisin.middleware' do |app|
+      app.middleware.use Raisin::Middleware
+    end
+
+    initializer 'raisin.patch_rails' do
+      ActionDispatch::Routing::Mapper.include(Raisin::Mapper)
+    end
   end
-end
+end

data/lib/raisin/version.rb

@@ -1,3 +1,3 @@
 module Raisin
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/lib/raisin/version_constraint.rb

@@ -0,0 +1,11 @@
+module Raisin
+  class VersionConstraint
+    def initialize(version)
+      @version  = version
+    end
+
+    def matches?(req)
+      @version == req.get_header('raisin.version'.freeze)
+    end
+  end
+end

data/raisin.gemspec

@@ -3,17 +3,23 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'raisin/version'
 
-Gem::Specification.new do |gem|
-  gem.name          = "raisin"
-  gem.version       = Raisin::VERSION
-  gem.authors       = ["ccocchi"]
-  gem.email         = ["cocchi.c@gmail.com"]
-  gem.description   = %q{An opiniated micro-framework to easily build elegant API on top of Rails}
-  gem.summary       = %q{An opiniated micro-framework to easily build elegant API on top of Rails}
-  gem.homepage      = "https://github.com/ccocchi/raisin"
+Gem::Specification.new do |s|
+  s.name          = "raisin"
+  s.version       = Raisin::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.authors       = ["ccocchi"]
+  s.email         = ["cocchi.c@gmail.com"]
+  s.description   = %q{API versioning via the Accept header}
+  s.summary       = %q{Build API with Accept header versioning on top of Rails}
+  s.homepage      = "https://github.com/ccocchi/raisin"
+  s.license       = 'MIT'
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  s.required_ruby_version     = '>= 2.2.0'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'actionpack', '~> 5.0'
+  s.add_dependency 'activesupport', '~> 5.0'
 end

data/test/helper.rb

@@ -0,0 +1,11 @@
+ENV['RAILS_ENV'] = 'test'
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'minitest/mock'
+require 'minitest/autorun'
+
+require 'active_support/concern'
+require 'action_dispatch'
+require 'raisin'
+
+Raisin.vendor = 'acme'

data/test/test_middleware.rb

@@ -0,0 +1,29 @@
+require 'helper'
+
+class TestMiddleware < Minitest::Test
+  def setup
+    @middleware = Raisin::Middleware.new(->(env) { :ok })
+  end
+
+  def test_not_vendored_header
+    assert_equal :ok, @middleware.call({})
+  end
+
+  def test_wrong_vendor_header
+    env = {}
+
+    assert_equal :ok, @middleware.call(env)
+    assert_empty env
+  end
+
+  def test_vendored_header
+    env = {
+      'action_dispatch.request.parameters' => {},
+      'HTTP_ACCEPT' => 'application/vnd.acme.v1+json'
+    }
+
+    assert_equal :ok, @middleware.call(env)
+    assert_equal 'v1', env['raisin.version']
+    refute_empty env['action_dispatch.request.formats']
+  end
+end

metadata

@@ -1,60 +1,88 @@
 --- !ruby/object:Gem::Specification
 name: raisin
 version: !ruby/object:Gem::Version
-  version: 0.1.2
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - ccocchi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-12 00:00:00.000000000 Z
-dependencies: []
-description: An opiniated micro-framework to easily build elegant API on top of Rails
+date: 2017-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: API versioning via the Accept header
 email:
 - cocchi.c@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
-- LICENSE.txt
+- MIT-LICENSE
 - README.md
 - Rakefile
 - lib/raisin.rb
-- lib/raisin/base.rb
-- lib/raisin/configuration.rb
+- lib/raisin/mapper.rb
 - lib/raisin/middleware.rb
-- lib/raisin/rails/request.rb
-- lib/raisin/rails/routes.rb
 - lib/raisin/railtie.rb
-- lib/raisin/routing.rb
 - lib/raisin/version.rb
+- lib/raisin/version_constraint.rb
 - raisin.gemspec
+- test/helper.rb
+- test/test_middleware.rb
 homepage: https://github.com/ccocchi/raisin
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.6.13
 signing_key: 
-specification_version: 3
-summary: An opiniated micro-framework to easily build elegant API on top of Rails
-test_files: []
+specification_version: 4
+summary: Build API with Accept header versioning on top of Rails
+test_files:
+- test/helper.rb
+- test/test_middleware.rb

data/lib/raisin/base.rb

@@ -1,69 +0,0 @@
-module Raisin
-
-  #
-  # Abstract class for all actions.
-  #
-  class Base < ActionController::Metal
-    abstract!
-
-    module Compatibility
-      def cache_store; end
-      def cache_store=(*); end
-      def assets_dir=(*); end
-      def javascripts_dir=(*); end
-      def stylesheets_dir=(*); end
-      def page_cache_directory=(*); end
-      def asset_path=(*); end
-      def asset_host=(*); end
-      def relative_url_root=(*); end
-      def perform_caching=(*); end
-      def helpers_path=(*); end
-      def allow_forgery_protection=(*); end
-    end
-
-    extend Compatibility
-
-    MODULES = [
-      AbstractController::Helpers,
-      ActionController::UrlFor,
-      ActionController::Rendering,
-      ActionController::Renderers::All,
-
-      ActionController::ConditionalGet,
-
-      ActionController::RackDelegation,
-      ActionController::MimeResponds,
-      ActionController::ImplicitRender,
-      ActionController::DataStreaming,
-
-      AbstractController::Callbacks,
-      ActionController::Rescue,
-
-      ActionController::Instrumentation,
-    ]
-
-    if Rails::VERSION::MAJOR >= 4 && Rails::VERSION::MINOR > 0
-      include AbstractController::Rendering
-      include ActionView::Rendering
-    end
-
-    MODULES.each { |mod|
-      include mod
-    }
-
-    if Rails::VERSION::MAJOR >= 4
-      include ActionController::StrongParameters
-    end
-
-    def _prefixes
-      @_prefixes ||= begin
-        parent_prefixes = self.class.parent_prefixes.dup
-        parent_prefixes.unshift(controller_path)
-        parent_prefixes.unshift("#{env['raisin.version']}/#{controller_name}") if env.key?('raisin.version')
-        parent_prefixes
-      end
-    end
-
-    ActiveSupport.run_load_hooks(:action_controller, self)
-  end
-end

data/lib/raisin/configuration.rb

@@ -1,16 +0,0 @@
-module Raisin
-  class VersionConfig
-    attr_accessor :vendor
-    attr_writer :using
-
-    def using
-      @using || :header
-    end
-  end
-
-  module Configuration
-    def self.version
-      @version_config ||= VersionConfig.new
-    end
-  end
-end

data/lib/raisin/rails/request.rb

@@ -1,20 +0,0 @@
-module Raisin
-  module ApiFormat
-    def formats
-      @env["action_dispatch.request.formats"] ||= 
-        if @env.key?('raisin.format')
-          Array(Mime::Type.lookup(@env['raisin.format']))
-        elsif parameters[:format]
-          Array(Mime[parameters[:format]])
-        elsif use_accept_header && valid_accept_header
-          accepts
-        elsif xhr?
-          [Mime::JS]
-        else
-          [Mime::HTML]
-        end
-    end    
-  end
-end
-
-ActionDispatch::Request.send(:include, Raisin::ApiFormat)

data/lib/raisin/rails/routes.rb

@@ -1,37 +0,0 @@
-require 'raisin/routing'
-
-module ActionDispatch::Routing
-  class Mapper
-
-    def api(options, &block)
-      return unless block_given?
-
-      version = options[:version].to_s
-      is_default = options.fetch(:default, false)
-
-      raise 'Version is missing in constraint' if version.blank?
-
-      @api_resources = true
-
-      send(:constraints, Raisin::Routing::VersionConstraint.new(version, is_default)) do
-        send(:scope, module: version) do
-          yield
-        end
-      end
-    ensure
-      @api_resources = nil
-    end
-
-    def resources(*resources, &block)
-      if @api_resources
-        options = resources.extract_options!
-        options[:except] ||= []
-        options[:except].concat([:new, :edit])
-        super(*resources, options)
-      else
-        super
-      end
-    end
-
-  end
-end

data/lib/raisin/routing.rb

@@ -1,16 +0,0 @@
-module Raisin
-  module Routing
-    ALL_VERSIONS = 'all'
-
-    class VersionConstraint
-      def initialize(version, is_default)
-        @version  = version
-        @bypass   = is_default || version == ALL_VERSIONS
-      end
-
-      def matches?(req)
-        @bypass || @version == req.env['raisin.version']
-      end
-    end
-  end
-end