fit_api 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4889af2c91cf113665016ffdc06e0cb664cb454cc8d66472db8eccef0ebb6ba9
-  data.tar.gz: d9a95a850cc8dbbee1d1b69a4a1cecf0b169e9340fa45b13e7c498850117afc3
+  metadata.gz: 9625dc724aa00c2091520f8a00037e2a0deb289ff46a0531c21c45ad0d70a44e
+  data.tar.gz: 2270242c3c7afadaa86162c580c8b1d042e5a64a5a65807205c15b5b78e2ba67
 SHA512:
-  metadata.gz: 28377cd6b2aa1ccc62b06a62bc60f246d2b675baa1924f934e4bcd8b2704026fa880e9068f0701655a5d3f4103141b81f88e524949bc9b2485a7102ecc60332b
-  data.tar.gz: df8cbabaa19b0171b4621db6a5dc7dd73f2fcc19814d0d9689517d841c05243701bebf57d26f1cfc3905723b2e8f2315b32717522ddad1979c36c0ac04ed7965
+  metadata.gz: 3985a5d07c254aef0abd05e8e67d91d49fab2eae6c11d83a5636eca8e610f42d5a2b6b6868ab6b4bdb5f11f7b2e702c49a00509a1ee8f562790d98221752ac8b
+  data.tar.gz: 1a2c24f461c00ae5b78a3bef8c47fa3ded025ed567088f1c16f55ba179277e03078642bfc3ca3afc5287ba9a0285909ea2f774d93bc589db67c5b86bc2f56aca

data/.gitignore

@@ -1,5 +1,6 @@
 .byebug_history
 *.swp
 Gemfile.lock
+/pkg
 /log
 /doc

data/README.md

@@ -4,8 +4,8 @@ Lightweight framework for building JSON API's
 
 ## Introduction
 
-fit-api is a 400 line dependency library based on Rack and inspired by Rails & Sinatra. 
-The goal of this library is to provide simplicity when developing an API with ruby.
+fit-api is a library based on Rack and inspired by Rails & Sinatra.  
+The goal of this gem is to provide simplicity when developing an API with ruby.
 
 ## Installation
 
@@ -28,41 +28,28 @@ $ gem install fit_api
         * [404](#customize-error-404-message)
     * [Controllers](#controllers)
         * [Request](#request)
+        * [Halt](#halt)
         * [Params](#params)
         * [Headers](#request-headers)
         * [Callbacks](#callbacks)
-    * [Rack Middlewares](#rack-middlewares)
 
 
 ## Usage
 
 This is a basic example showing how it works... you can check the demo app from this repository:
-[fit-api-demo](/bermanya/fit-api-demo)
+[fit-api-demo](http://github.com/bermanya/fit-api-demo)
 
-**my_app.rb**
+**api.rb**
 
 ```ruby
 require 'fit_api'
 
-require_relative 'routes'
-require_relative 'app_controller'
-
-Rack::Handler::WEBrick.run FitApi::App.new
-```
-
-**routes.rb**
-
-```ruby
 FitApi::Router.define do
   get '/:name', to: 'app#show'
 
   root to: 'app#index'
 end
-```
 
-**app_controller.rb**
-
-```ruby
 class AppController < FitApi::Controller
   def index
     json({ message: 'Hello world' })
@@ -72,15 +59,21 @@ class AppController < FitApi::Controller
     json({ message: "Welcome #{params.name}" })
   end
 end
+
+# You can setup any Rack Middleware
+
+FitApi.use Rack::CommonLogger, Logger.new('log/app.log')
+
+Rack::Handler::WEBrick.run FitApi.app
 ```
 
 ```bash
-ruby my_app.rb
+ruby api.rb
 ```
 
 ## Router
 
-It recognizes URLs and invoke the controller's action... the DSL is pretty similar to Rails (obviously not to so powerful):
+It recognizes URLs and invoke the controller's action... the DSL is pretty similar to Rails (obviously not so powerful):
 
 ### HTTP methods:
 
@@ -91,6 +84,8 @@ put '/test',        to: 'app#test_put'
 delete '/test/:id', to: 'app#test_delete'
 ```
 
+----
+
 ### Resources
 
 **Nested:**
@@ -208,12 +203,12 @@ root to: 'app#index'
 ### Customize error 404 message
 
 ```ruby
-not_found 'app#error_404'
+not_found to: 'app#error_404'
 ```
 
 ## Controllers
 
-The library provides one father class `FitApi::Controller` that should be inherited from your controllers.  
+The library provides one class `FitApi::Controller` which should be inherited from your controllers.  
 One limitation is the class name of your controller must end with "Controller", i.e: AppController, UsersController...
 
 ```ruby
@@ -228,82 +223,108 @@ class AppController < FitApi::Controller
 end 
 ```
 
-You have the method `#json` available, basically, it sets the Response body.
+You have the method `#json` available, which basically sets the response body.
+
+----
 
 ### Request
 
-You can access the Request object like this: `request`
+You can access the Request object like this:
 
-### Params
+`request`
 
-Assuming the following requests:
+----
 
-**GET /users/:id?name=Berna&age=28&height=180**
+### Halt
+
+You can exit the current action throwing an exception... the default status code is 400
 
 ```ruby
-params.id           # 1
-params.name         # "Berna"
-params[:age]        # 28
-params['height']    # 180
+halt
+halt 500
+halt 404, 'Not found'
+halt 'Error message'
 ```
 
-**POST /test** 
+----
+
+### Params
 
-With Params:
+#### GET /users
 
 ```bash
-curl -i -X POST  -d 'user[name]=Berna&user[age]=28' http://server:1337/test
+curl -i http://localhost:1337/users/:id?name=Berna&age=28&height=180
 ```
 
-With JSON:
+```ruby
+params.id         # 1
+params.name       # "Berna"
+params[:age]      # 28
+params['height']  # 180
+```
+
+#### POST with params:
 
 ```bash
-curl -i -X POST -H "Content-Type: application/json" -d '{ "user": { "name": "Berna", "age": 28 } }' http://server:1337/test
+curl -i -X POST  -d 'user[name]=Berna&user[age]=28' http://localhost:1337/users
 ```
 
-Then we have the following data in our `params` object:
+#### POST with JSON:
 
-```ruby
-params.user             # > Params
-params.user.name        # "Berna"
-params[:user][:age]     # 28
+```bash
+curl -i -X POST -H "Content-Type: application/json" -d '{ "user": { "name": "Berna", "age": 28 } }' http://localhost:1337/users
 ```
 
-### Request Headers
+Result:
 
 ```ruby
-request.headers['Authorization']
+params.user.name     # "Berna"
+params[:user][:age]  # "28"
 ```
 
-### Response Headers
+----
+
+#### #permit
 
 ```ruby
-headers['Header-Key'] = 'Header Value'
+params.user.permit(:name, :age)
 ```
 
-### Callbacks
+----
+
+#### #except
 
 ```ruby
-before_action *actions
-after_action *actions, only: %i(index show)
+params.user.except(:height)
 ```
 
-## Rack Middlewares
+----
+
+### Request Headers
+
+```ruby
+request.headers['Authorization']
+```
 
-You can set up any rack middleware you want, i.e:
+----
 
-**config.ru**
+### Response Headers
 
 ```ruby
-require 'fit_api'
+headers['Header-Name'] = 'Header Value'
+```
 
-use Rack::CommonLogger, Logger.new('log/app.log')
+----
 
-run FitApi::App.new
+### Callbacks
+
+```ruby
+before_action *actions
+after_action *actions, only: %i(index show)
 ```
 
 ## TODO:
 - [ ] Implement tests
 - [ ] Allow websockets -> `FitApi::Controller#stream`
 
-Any contribution would be appreciated =)  
+Any contribution would be appreciated =)

data/lib/fit_api/controller.rb

@@ -29,8 +29,8 @@ module FitApi
     end
 
     def set_response_headers
-      response.add_header 'Content-Type', 'application/json'
-      response.add_header 'Date', Rack::Utils.rfc2822(Time.now)
+      headers['Date'] = Rack::Utils.rfc2822(Time.now)
+      headers['Content-Type'] = 'application/json'
 
       headers.each &response.method(:add_header)
     end
@@ -38,11 +38,13 @@ module FitApi
     private
 
     def json(hash, status: 200)
-      self.response = 
-        Rack::Response.new(hash.to_json, status)
+      self.response = Rack::Response.new(hash.to_json, status)
     end
 
-    def halt(status = 400, error)
+    def halt(*args)
+      is_integer = args.first.is_a?(Integer)
+      status = is_integer ? args.first : 400
+      error = is_integer ? (args.count > 1 ? args.last : '') : args.first 
       json(error, status: status)
       raise Halt
     end

data/lib/fit_api/router/mapper.rb

@@ -28,7 +28,7 @@ module FitApi
         get '', to: to
       end
 
-      def not_found(to)
+      def not_found(to:)
         get '/404', to: to
       end
 
@@ -60,10 +60,12 @@ module FitApi
 
       def set_resource(type, resource, options, &block)
         options[:only] ||= %i(index show create update destroy)
+        options[:controller] ||= resource
+
         path = get_path(type, resource)
 
         @parent = [ type, resource ]
-        @controller = options[:controller] || resource
+        @controller = options[:controller] 
 
         namespace path, options do
           set_actions type, resource, options[:only]
@@ -97,7 +99,7 @@ module FitApi
       def get_path(type, resource)
         return "/:#{s(@parent.last)}_id/#{resource}"    if type == :resources && parent_is?(:resources)
         return "/:#{s(@parent.last)}_id/#{s(resource)}" if type == :resource  && parent_is?(:resources)
-        return "/#{s(resource)}"                       if type == :resource  && parent_is?(:resource)
+        return "/#{s(resource)}"                        if type == :resource  && parent_is?(:resource)
         return "/#{resource}"
       end
 
@@ -110,11 +112,9 @@ module FitApi
       end
 
       def fix_path(path)
-        if path.is_a?(Symbol) || path[0] != '/' && path != ''
-          "/#{path}"
-        else
-          path
-        end
+        fix = path.is_a?(Symbol) || path[0] != '/' && path != ''
+        path = fix ? "/#{path}" : path
+        path.gsub(/\/$/, '')
       end
 
       def s(word)

data/lib/fit_api/router/route.rb

@@ -18,7 +18,7 @@ module FitApi
         route_params = parse(request.path).params
         json_params  = JSON.parse(request.body.read) rescue {}
         params       = Params.new(request.params.merge(route_params).merge(json_params))
-        controller   = Object.const_get("#{@controller.capitalize}Controller").new(request, params)
+        controller   = Object.const_get("#{@controller.to_s.capitalize}Controller").new(request, params)
 
         run! controller
       rescue Halt

data/lib/fit_api/router.rb

@@ -4,22 +4,25 @@ module FitApi
   module Router
     def self.call(env)
       method, path = env['REQUEST_METHOD'], env['PATH_INFO']
-      route = find method, path, path != '/'
+      is_root = path == '/'
 
-      return route.invoke(env) if route
+      if route = Router.find(method, path, !is_root)
+        route.invoke(env)
+      else
+        status = is_root ? 200 : 404
+        res    = is_root ? 'fit-api is working!' : 'Action not found'
 
-      res = path == '/' ? { message: 'fit-api is working!' } : { error: 'action not found' }
-
-      [ res[:error] ? 404 : 200, { 'Content-Type' => 'application/json'}, [ res.to_json ] ]
+        [ status, { 'Content-Type' => 'application/json'}, [ res.to_json ] ]
+      end
     end
 
-    def self.find(method, path, find_error = true)
+    def self.find(method, path, find_not_found_action = true)
       routes = mapper.routes[method.downcase]
       route = routes.find { |route| route.match? path }
 
       return route if route
 
-      if find_error 
+      if find_not_found_action
         not_found = find('get', '/404', false)
         return not_found if not_found
       end

data/lib/fit_api/version.rb

@@ -1,3 +1,5 @@
 module FitApi
-  def self.version; '1.0.1' end
+  def self.version
+    '1.1.0'
+  end
 end

data/lib/fit_api.rb

@@ -2,10 +2,24 @@ require 'rack'
 require 'json/ext'
 require 'dry/inflector'
 
-require 'fit_api/app'
+require 'fit_api/version'
+require 'fit_api/router'
 require 'fit_api/controller'
 
 module FitApi
+  def self.builder
+    @builder ||= Rack::Builder.new
+  end
+
+  def self.use(middleware, *args, &block)
+    builder.use(middleware, *args, &block)
+  end
+
+  def self.app
+    builder.run Router.method(:call)
+    builder.to_app
+  end
+
   def self.inflector
     @inflector ||= Dry::Inflector.new
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fit_api
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Bernardo Castro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-23 00:00:00.000000000 Z
+date: 2019-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -51,7 +51,6 @@ files:
 - Rakefile
 - fit_api.gemspec
 - lib/fit_api.rb
-- lib/fit_api/app.rb
 - lib/fit_api/controller.rb
 - lib/fit_api/router.rb
 - lib/fit_api/router/mapper.rb

data/lib/fit_api/app.rb

@@ -1,9 +0,0 @@
-require 'fit_api/router'
-
-module FitApi
-  class App
-    def call(env)
-      Router.call(env)
-    end
-  end
-end