navigable-server 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44a577b55032e77007e967d1468b58f6acec275bcaa20ec03dd4643abf8184b5
-  data.tar.gz: 98bc33d54dc4811f4d16989ff3021b3f06dc3c1e4f641575b394b88c5dfc448b
+  metadata.gz: 126d577099fc83bd854908258e60fb7e66f50bd2c6756d17d43141662a1a9270
+  data.tar.gz: 9cd7e23c64365f991eb4a89d348b8585a66039f63a0ac1719bf3b01fdf4c77a8
 SHA512:
-  metadata.gz: a1824a664888c326e0ecce71c8665a57a4263753008acd98df91992c4e2d7908294fb127c42da5f4d22746b9cc91af1423f5b2ae375bc680e60d70e6a7952214
-  data.tar.gz: c7b463b914a0ed25c67f3158f857767d5d8125b0fcad5dbf32b61362833bd220c65aecbc04ede52f3d180ed3e95f2d65cf2aec6c7d45599804a993869068f8bd
+  metadata.gz: 778df9f366e96e7a609b995d2271200e5371dd30c5c2fabb7f18bdda82463bcd880954ea9cd9a96ee0d9e0a84b17f11ad18bfb13ece8d92b81d069034847a058
+  data.tar.gz: 289bad94b8b4a0bb72cec07a40ad87870b6fc03fb6cbc0a3fe39bc50aae311c584e82c975a80baf8704934c138372a74b70e5418a12489b1833ba21efaebd5f6

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 Alan Ridlehoover
+Copyright (c) 2020 Alan Ridlehoover and Fito von Zastrow
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,6 +1,6 @@
 # Navigable::Server
 
-[![Build Status](https://travis-ci.org/first-try-software/navigable-server.svg?branch=main)](https://travis-ci.org/first-try-software/navigable-server) [![Maintainability](https://api.codeclimate.com/v1/badges/e62e187bb05abe883169/maintainability)](https://codeclimate.com/github/first-try-software/navigable-server/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/e62e187bb05abe883169/test_coverage)](https://codeclimate.com/github/first-try-software/navigable-server/test_coverage)
+[![Gem Version](https://badge.fury.io/rb/navigable-server.svg)](https://badge.fury.io/rb/navigable-server) [![Build Status](https://travis-ci.org/first-try-software/navigable-server.svg?branch=main)](https://travis-ci.org/first-try-software/navigable-server) [![Maintainability](https://api.codeclimate.com/v1/badges/e62e187bb05abe883169/maintainability)](https://codeclimate.com/github/first-try-software/navigable-server/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/e62e187bb05abe883169/test_coverage)](https://codeclimate.com/github/first-try-software/navigable-server/test_coverage)
 
 Navigable is a family of gems that together provide all the tools you need to build fast, testable, and reliable JSON and/or GraphQL based APIs with isolated, composable business logic. The gems include:
 
@@ -72,7 +72,68 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+`Navigable::Server` is a different kind of server. Rather than registering routes in a route file, `Endpoint` classes register themselves at startup using the `responds_to` method. When the route is requested, `Navigable::Server` injects the `Request` into the `Endpoint` and calls the `execute` method.
+
+```ruby
+class AhoyEndpoint
+  extend Navigable::Server::Endpoint
+
+  responds_to :get, '/ahoy'
+
+  def execute
+    { status: 200, html: '<h1>Ahoy! Welcome aboard Navigable!</h1>' }
+  end
+end
+```
+The `execute` method should return a hash containing:
+
+* Some content (either `json`, `html`, `text`, or `body`)
+* An optional status code (default = 200)
+* Optional headers (`Navigable::Server` sets `Content-Type` and `Content-Length` for you if they can be inferred)
+
+Here are three examples:
+
+```ruby
+# returning successful creation of SomeActiveRecordModel
+class CreateSomeActiveRecordModelEndpoint
+  extend Navigable::Server::Endpoint
+
+  responds_to :post, '/models'
+
+  def execute
+    model = SomeActiveRecordModel.create(request.params)
+    { status: 201, json: model }
+  end
+end
+
+# Returning 404 Not Found
+class ShowSomeActiveRecordModelEndpoint
+  extend Navigable::Server::Endpoint
+
+  responds_to :get, '/models/:id'
+
+  def execute
+    model = SomeActiveRecordModel.find_by(id: request.params[:id])
+
+    return { status: 404, text: 'Not Found' } unless model
+
+    { json: model }
+  end
+end
+
+# Returning an image
+class ShowTreasureMapEndpoint
+  extend Navigable::Server::Endpoint
+
+  responds_to :get, '/treasure-map'
+
+  def execute
+    treasure_map = read_file('x_marks_the_spot.png')
+    { headers: { 'Content-Type' => 'image/png' }, body: treasure_map }
+  end
+end
+```
+If you are considering creating a JSON API with `Navigable::Server`, you should know about `Navigable::API` and `Navigable::GraphQL`. Both of these gems extend `Navigable::Server` in ways that bring all of Navigable together from `Commands` and `Observers`, to `Endpoints` and `Resolvers`.
 
 ## Development
 

data/lib/navigable/server/response.rb

@@ -4,6 +4,7 @@ module Navigable
   module Server
     class Response
       CONTENT_TYPE = 'Content-Type'
+      CONTENT_LENGTH = 'Content-Length'
       MIME_TYPE_JSON = 'application/json'
       MIME_TYPE_HTML = 'text/html'
       MIME_TYPE_TEXT = 'text/plain'
@@ -17,14 +18,16 @@ module Navigable
       end
 
       def to_rack_response
-        [status, headers, content]
+        [status, headers, [content]]
       end
 
       private
 
       def headers
-        headers = params[:headers] || {}
+        headers = {}
         headers[CONTENT_TYPE] = content_type if content_type
+        headers[CONTENT_LENGTH] = content_length
+        headers.merge!(params[:headers]) if params[:headers]
         headers
       end
 
@@ -34,8 +37,12 @@ module Navigable
         return MIME_TYPE_TEXT if text
       end
 
+      def content_length
+        content.bytesize
+      end
+
       def content
-        [json || html || text || body || EMPTY_CONTENT]
+        json || html || text || body || EMPTY_CONTENT
       end
 
       def json

data/lib/navigable/server/version.rb

@@ -2,6 +2,6 @@
 
 module Navigable
   module Server
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: navigable-server
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Alan Ridlehoover
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-25 00:00:00.000000000 Z
+date: 2020-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: navigable-router