flon 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d77f8f763e06566ba8fd67310e4bf2eb7cf25cf1a2927685973c8ab8310a673
-  data.tar.gz: f693eedb16f5dbff5505c00408ff728b4dbf8911294dea690d36139b811027db
+  metadata.gz: dadeb3b4469a7ee38098b5e24548f525a32fa08d2577a8f67a64175f34d965e3
+  data.tar.gz: fe9c3d073b64a8bb443f1ce9b87d33889cb3c2750d255df3979b05563b3bfb42
 SHA512:
-  metadata.gz: 1ff850c5ec62797dfba5deda611c90aa941110e824bc39bb3cb577fa04594e2f1b7e5210874a9e910b9d5b136d9c7ecb40b23077b800d1b3f39a3b82549a011f
-  data.tar.gz: 179296c86b0de6ebca2629a1977a78159d1e4f261f03d3b397a834a9f41c89c5cb7cd129825aee22285d1d6ccf7421efa8f1909f834a3aac79a7ff8384d6a3b4
+  metadata.gz: 15663df435d9955f82ddc991955537919007a7e0c220dd380d435f8ba8cfc1593352155a5f7eed8dcb74efa2632ef295bda620dd8fc68e5d1beaa50f17f0c2a8
+  data.tar.gz: f10055e8e158a2a9a7f9c72c51a469d408558c9bec5c46d4ceee7a9c59b8af50dbdd359dc7b5fe008b69e86e86f1e2b58ca8348ada6f93c4ad1b735250b513c8

data/README.md

@@ -1,7 +1,7 @@
 # Flon
 
 Flon, the API maker that uses JSON. It focuses on not doing any magic: it’s
-just a thin and convenient wrapper over Rack, with a hopefully obvious DSL. 
+just a thin and convenient wrapper over Rack, with a hopefully obvious DSL.
 
 ## Installation
 
@@ -13,11 +13,15 @@ gem 'flon'
 
 And then execute:
 
-    $ bundle
+```sh
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install flon
+```sh
+gem install flon
+```
 
 ## Usage
 
@@ -29,7 +33,7 @@ router DSL in your class scope.
 ```ruby
 require 'flon'
 
-class MyApi
+class MyAPI
   extend Flon::DSL
 
   def initialize
@@ -41,35 +45,35 @@ class MyApi
     attr_reader :names
 
     post '/new'
-    def add_name(_params, body)
-      @names << body
+    def add_name(request)
+      @names << request.body
     end
 
     namespace '/:index' do
       get '/'
-      def name_by_index(params)
-        @names[params[:index].to_i]
+      def name_by_index(request)
+        @names[request.params[:index].to_i]
       end
 
       put '/edit'
-      def change_name(params, body)
-        @names[params[:index].to_i] = body
+      def change_name(request)
+        @names[request.params[:index].to_i] = request.body
       end
     end
   end
 end
 ```
 
-You can then create a `Flon::Api` using this:
+You can then create a `Flon::API` using this:
 
 ```ruby
-api = Flon::Api.new(MyApi.new)
+api = Flon::API.new(MyAPI.new)
 ```
 
-Note how you initialise the `MyApi` normally—you can use this for dependency
+Note how you initialise everything normally—you can use this for dependency
 injection without a headache.
 
-`Flon::Api` is a bog-standard Rack app, so you can just use it in `config.ru`,
+`Flon::API` is a bog-standard Rack app, so you can just use it in `config.ru`,
 or whatever method you use.
 
 ### Routing
@@ -114,12 +118,35 @@ pattern is the exact same as [Sinatra’s](https://github.com/sinatra/mustermann
 The bound method is called when an HTTP request matches that route with that
 HTTP method.
 
-The method will receive two arguments, in that order:
+The method will receive one argument, the `Flon::Request` object describing the
+HTTP request:
+
+```ruby
+request.body         # Gets the body; returns a String, or nil if no body
+
+request.headers      # Gets the headers; returns a Hash with String keys and
+                     # String values
+
+request.method       # Gets the HTTP method; returns a Symbol with the name of
+                     # the method lowercased
+
+request.params       # Gets the route and query parameters, merged, giving
+                     # priority to route parameters; returns a Hash with Symbol
+                     # keys
 
-1. A parameters hash, containing the query string parameters and the route
-   parameters;
-2. A body object, containing the HTTP request’s body parsed with `JSON.parse`.
-   For GETs, HEADs, and DELETEs, this will be `nil`.
+request.path         # Gets the path; returns a String
+
+request.query_params # Gets the query parameters, specifically; returns a Hash
+                     # with Symbol keys
+
+request.route_params # Gets the route parameters, specifically; returns a Hash
+                     # with Symbol keys
+
+request.url          # Gets the request’s URL; returns an URI object
+```
+
+Note that the argument will not be passed if the method does not accept at
+least one argument, so you can leave it out if you’re not gonna use it.
 
 #### Namespaces
 
@@ -131,19 +158,19 @@ namespace '/users' do
   attr_reader :users # GET /users
 
   post '/new'
-  def add_user(_params, user) # /users/new
-    @users << user
+  def add_user(request) # /users/new
+    @users << request.body
   end
 
   namespace '/:id' do
     get
-    def user_by_id(params) # GET /users/:id
-      @users[params[:id].to_i]
+    def user_by_id(request) # GET /users/:id
+      @users[request.params[:id].to_i]
     end
 
     put '/edit'
-    def edit_user(params, body) # PUT /users/:id/edit
-      @users[params[:id].to_i] = body
+    def edit_user(request) # PUT /users/:id/edit
+      @users[request.params[:id].to_i] = request.body
     end
   end
 end
@@ -168,7 +195,7 @@ get '/no'
 def no
   'no'
 end
-``` 
+```
 
 Going to `/yes` will give you a 404, but going to `/v1/yes` will give you
 `"yes"`. The same thing happens with the `/no` route.
@@ -178,14 +205,14 @@ In reality, `version` is just an alias for `namespace`.
 ### Responding
 
 Whatever is returned by the route’s method is `#to_json`’d and sent back. If
-you want to return a custom status code, return a `Flon::Response` object,
-which takes the status code as the first argument and the body as the second
-argument of its constructor:
+you want to return a custom response, return a `Flon::Response` object, which
+takes the status code as the first argument, the body as the second argument,
+and the headers as the third argument of its constructor:
 
 ```ruby
 get '/admin'
 def admin
-  Flon::Response.new(403, 'No. Go away.')
+  Flon::Response.new(403, 'No. Go away.', 'X-Loser' => 'Yes')
 end
 ```
 

data/lib/flon/api.rb

@@ -2,25 +2,59 @@
 
 require 'rack'
 require 'json'
+require 'uri'
 
 module Flon
-  # Represents a response, with an integer status and a body that will be
-  # #to_json'd.
+  # Represents a request.
+  class Request
+    attr_reader :body, :headers, :method, :params, :path, :query_params,
+                :route_params, :url
+
+    def initialize(method, rack_request, route_params, body)
+      @body = body
+      @headers = rack_request.env
+      @method = method
+      @query_params = rack_request.params
+      @route_params = route_params
+      @params = coalesce_params(@query_params, @route_params)
+      @path = rack_request.path_info
+      @url = make_url(rack_request)
+    end
+
+    private
+
+    def coalesce_params(query_params, route_params)
+      query_params.transform_keys(&:to_sym).merge(route_params)
+    end
+
+    def make_url(request)
+      URI.parse(request.fullpath)
+    end
+  end
+
+  # Represents a response, with a status, body, and headers.
   #
   # @!attribute [r] status
   #   @return [Integer] the status to use when responding
   #
   # @!attribute [r] body
   #   @return [#to_json] the object to respond with that shall be #to_json'd
-  Response = Struct.new(:status, :body)
+  #
+  # @!attribute [r] headers
+  #   @return [Hash{String => #to_s}] the headers hash; each value will be
+  #     converted with a String with #to_s
+  Response = Struct.new(:status, :body, :headers)
 
   # This class is Flon's Rack application.
-  class Api
-    # Creates a new {Api} object with the given API.
+  class API
+    DEFAULT_RESPONSE_HEADERS = { 'Content-Type' => 'application/json' }.freeze
+    private_constant :DEFAULT_RESPONSE_HEADERS
+
+    # Creates a new {API} object with the given API.
     #
     # @param [Object] api the API to use; its class must respond to #router and
     #   the result must be a {Router}.
-    # @return [Api] the newly constructed object
+    # @return [API] the newly constructed object
     def initialize(api)
       raise ArgumentError, "given API's class does not respond to #routes" unless valid_api?(api)
 
@@ -44,26 +78,21 @@ module Flon
                  else dispatch(method, request, match)
                  end
 
-      [response.status, { 'Content-Type' => 'application/json' }, [response.body]]
+      rack_response(method, response)
     end
 
     private
 
-    def dispatch(method, request, match)
-      params = coalesce_params(request.params, match.params)
-
+    def dispatch(method, rack_request, match)
       if receives_body?(method)
-        body = normalise_body(request)
+        body = normalise_body(rack_request)
         return Response.new(415, '"415 Unsupported Media Type"') if body == :fail
       else
         body = nil
       end
 
-      call_action(match.action, params, body)
-    end
-
-    def coalesce_params(request_params, route_params)
-      request_params.transform_keys(&:to_sym).merge(route_params)
+      request = Request.new(method, rack_request, match.params, body)
+      call_action(match.action, request)
     end
 
     def normalise_body(request)
@@ -83,8 +112,8 @@ module Flon
       http_method != :get && http_method != :delete
     end
 
-    def call_action(action, params, body)
-      responsify(call_respect_arity(action.bind(@api), params, body))
+    def call_action(action, request)
+      responsify(call_respect_arity(action.bind(@api), request))
     end
 
     def responsify(result)
@@ -100,6 +129,18 @@ module Flon
       arity.negative? ? method.call(*args) : method.call(*args[0...arity])
     end
 
+    def rack_response(method, response)
+      [
+        response.status || 200,
+        DEFAULT_RESPONSE_HEADERS.merge(stringify_values(response.headers || {})),
+        method == :head || !response.body ? [] : [response.body]
+      ]
+    end
+
+    def stringify_values(hash)
+      hash.transform_values(&:to_s)
+    end
+
     def http_method_to_symbol(http_method)
       http_method.downcase.to_sym
     end

data/lib/flon/dsl.rb

@@ -6,7 +6,7 @@ module Flon
   # This module holds Flon's DSL. You should extend it in your class.
   #
   # @example
-  #   class BreadApi
+  #   class BreadAPI
   #     extend Flon::DSL
   #
   #     get '/bread'

data/lib/flon/version.rb

@@ -2,5 +2,5 @@
 
 module Flon
   # Flon's version.
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flon
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - unleashy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-07 00:00:00.000000000 Z
+date: 2019-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mustermann