navigable-server 0.4.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 126d577099fc83bd854908258e60fb7e66f50bd2c6756d17d43141662a1a9270
-  data.tar.gz: 9cd7e23c64365f991eb4a89d348b8585a66039f63a0ac1719bf3b01fdf4c77a8
+  metadata.gz: 9290813f3f31d905b2d7dc3a39700b23da833d04ea3397ef09a08af3fa78e3cd
+  data.tar.gz: a067219239e0d23bb0fde60c641fa5dbe19fe24cf9d8a52f07ef0c59d87c576d
 SHA512:
-  metadata.gz: 778df9f366e96e7a609b995d2271200e5371dd30c5c2fabb7f18bdda82463bcd880954ea9cd9a96ee0d9e0a84b17f11ad18bfb13ece8d92b81d069034847a058
-  data.tar.gz: 289bad94b8b4a0bb72cec07a40ad87870b6fc03fb6cbc0a3fe39bc50aae311c584e82c975a80baf8704934c138372a74b70e5418a12489b1833ba21efaebd5f6
+  metadata.gz: dd4f369eab8a65a32dbef752cb3d315584d3390981ba3784050876382f6cf1974fb2652500b61a865e33c2f577f33ea5a7d35bf5878a6714fb38f1303c5144d1
+  data.tar.gz: a17f8c2565b80ae4ea06809b057a2dc7227ce1dd6a55e50edd1babbdaa39857b6dc4a410b5a97a233ae3b06949c92997fc4c53b4ab00b1fa85e63e6dcd183557

data/.rspec

@@ -1,3 +1,2 @@
---format documentation
 --color
 --require spec_helper

data/README.md

@@ -30,29 +30,20 @@ A simple, highly-performant, Rack-based router.
 **[Navigable Server][server]** *(coming soon)*<br>
 A Rack-based server for building Ruby and Navigable web applications.
 
-</td>
-</tr>
-<tr height="140">
-<td width="130"><img alt="Telescope" src="https://raw.githubusercontent.com/first-try-software/navigable/main/assets/telescope.png"></td>
-<td>
-
-**Navigable API** *(coming soon)*<br>
-An extension of Navigable Server for building restful JSON APIs.
-
 </td>
 </tr>
 <tr height="140">
 <td width="130"><img alt="Map" src="https://raw.githubusercontent.com/first-try-software/navigable/main/assets/map.png"></td>
 <td>
 
-**Navigable GraphQL** *(coming soon)*<br>
+**[Navigable GraphQL][graphql]** *(coming soon)*<br>
 An extension of Navigable Server for building GraphQL APIs.
 
 </td>
 </tr>
 </table>
 
-<br><br>
+<br>
 
 ## Installation
 
@@ -133,19 +124,81 @@ class ShowTreasureMapEndpoint
   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`.
+Alternatively, you can declare that your endpoint executes a specific Navigable command by calling the `executes` method, like this:
 
-## Development
+```ruby
+class RecruitSwabbieEndpoint
+  extend Navigable::Server::Endpoint
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+  responds_to :get, '/ahoy'
+  executes :recruit_swabbie
+end
+```
+This tells the server to automatically execute the command associated with the key `:recruit_swabbie`. The command might look something like this:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+class RecruitSwabbie
+  extend Navigable::Command
+
+  corresponds_to :recruit_swabbie
+
+  def execute
+    return failed(recruit) unless swabbie_material?
+
+    successfully recruited_swabbie
+  end
+
+  private
+
+  def recruit
+    Swabbie.new(params)
+  end
+
+  def swabbie_material?
+    !recruit.drunk? && !recruit.pirate? && !recruit.seasick?
+  end
+
+  def recruited_swabbie
+    SwabbieRepository.create(recruit)
+  end
+end
+```
+Finally, you can use a Resolver class to handle requests for specific MIME types. Here's a `JSONResolver` class that prepares the data from the command to be returned as JSON:
+
+```ruby
+class JSONResolver
+  extend Navigable::Resolver
+
+  resolves 'application/json'
+
+  def resolve
+    @response
+  end
+
+  def on_success(recruit)
+    @response = { json: recruit }
+  end
+
+  def on_failure(recruit)
+    @response = { json: { errors: errors(recruit) } }
+  end
+
+  private
+
+  def errors(recruit)
+    errors = []
+    errors << 'They are a drunken mess!' if recruit.drunk?
+    errors << 'They are wanted for piracy on three continents!' if recruit.pirate?
+    errors << 'One step aboard and they turned blue and tossed!' if recruit.seasick?
+  end
+end
+```
+Visit the Navigable Wiki for more information on [Resolvers][resolvers].
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/first-try-software/navigable-server. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/first-try-software/navigable-server/blob/master/CODE_OF_CONDUCT.md).
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
@@ -157,3 +210,5 @@ Everyone interacting in the Navigable::Server project's codebases, issue tracker
 [navigable]: https://github.com/first-try-software/navigable
 [router]: https://github.com/first-try-software/navigable-router
 [server]: https://github.com/first-try-software/navigable-server
+[resolvers]: https://github.com/first-try-software/navigable/wiki/Resolvers
+[graphql]: https://github.com/first-try-software/navigable-graphql

data/lib/navigable/server.rb

@@ -6,15 +6,19 @@ require 'navigable'
 require 'rack'
 require 'rack/accept_media_types'
 require 'rack/abstract_format'
-require 'rack/bodyparser'
 
 require 'navigable/server'
 require 'navigable/server/version'
+require 'navigable/server/parsers/json'
+require 'navigable/server/parsers/null'
+require 'navigable/server/parsers/factory'
 require 'navigable/server/request'
 require 'navigable/server/response'
 require 'navigable/server/rack_adapter'
 require 'navigable/server/router'
 require 'navigable/server/endpoint'
+require 'navigable/server/endpoint_command'
+require 'navigable/server/cors'
 
 module Navigable
   module Server
@@ -24,7 +28,7 @@ module Navigable
 
     def self.rack_app
       @server ||= Rack::Builder.new(Server.router) do
-        use Rack::BodyParser, :parsers => BODY_PARSERS
+        use Navigable::Server::CORS::Middleware
         use Rack::AbstractFormat
       end
     end

data/lib/navigable/server/cors.rb

@@ -0,0 +1,54 @@
+module Navigable
+  module Server
+    class CORS
+      class << self
+        def config
+          yield(self)
+        end
+
+        def headers
+          @headers ||= {}
+        end
+
+        def headers=(headers)
+          raise ArgumentError.new("Expected headers to be a Hash, received a #{headers.class} instead") unless headers.is_a?(Hash)
+
+          @headers = headers
+        end
+      end
+
+      class Middleware
+        def initialize(app)
+          @app = app
+        end
+
+        def call(env)
+          return @app.call(env) unless cors_configured? && cors_request?(env)
+
+          cors_response
+        end
+
+        private
+
+        def cors_configured?
+          !Navigable::Server::CORS.headers.empty?
+        end
+
+        def cors_request?(env)
+          env['REQUEST_METHOD'] == 'OPTIONS'
+        end
+
+        def cors_response
+          [200, default_headers.merge(Navigable::Server::CORS.headers), []]
+        end
+
+        def default_headers
+          {
+            'Content-Type' => 'text/plain',
+            'Content-Length' => '0'
+          }
+        end
+      end
+    end
+  end
+end

data/lib/navigable/server/endpoint.rb

@@ -3,27 +3,79 @@
 module Navigable
   module Server
     module Endpoint
-      EXECUTE_NOT_IMPLEMENTED_MESSAGE = 'Class must implement `execute` method.'
+      EXECUTE_NOT_IMPLEMENTED_MESSAGE = 'Endpoint classes must either call `executes` or implement an `execute` method.'
+      UNAUTHENTICATED = { status: 401, text: 'Unauthorized' }.freeze
+      UNAUTHORIZED = { status: 403, text: 'Forbidden' }.freeze
 
       def self.extended(base)
-        base.instance_eval do
-          def responds_to(verb, path)
-            Navigable::Server.add_endpoint(verb: verb, path: path, endpoint_class: self)
-          end
+        base.extend(ClassMethods)
+        base.include(InstanceMethods)
+      end
+
+      module ClassMethods
+        def responds_to(verb, path)
+          Navigable::Server.add_endpoint(verb: verb, path: path, endpoint_class: self)
+        end
+
+        def executes(command_key)
+          @command_key = command_key
+        end
+      end
+
+      module InstanceMethods
+        attr_reader :request
+
+        def inject(request: Request.new)
+          @request = request
         end
 
-        base.class_eval do
-          attr_reader :request
+        def execute
+          raise NotImplementedError.new(EXECUTE_NOT_IMPLEMENTED_MESSAGE) unless command_key
+
+          return unauthenticated unless authenticated?
+          return unauthorized unless authorized?
+
+          dispatch
+        end
+
+        private
+
+        def dispatch
+          Navigable::Dispatcher.dispatch(command_key, params: params, resolver: resolver)
+        end
 
-          def inject(request: Request.new)
-            @request = request
-          end
+        def command_key
+          self.class.instance_variable_get(:@command_key)
+        end
+
+        def params
+          request.params
+        end
+
+        def preferred_media_type
+          request.headers[:preferred_media_type]
+        end
+
+        def resolver
+          Manufacturable.build_one(Resolver::TYPE, preferred_media_type) || Navigable::NullResolver.new
+        end
+
+        def unauthenticated
+          UNAUTHENTICATED
+        end
+
+        def unauthorized
+          UNAUTHORIZED
+        end
+
+        def authenticated?
+          true
+        end
 
-          def execute
-            raise NotImplementedError.new(EXECUTE_NOT_IMPLEMENTED_MESSAGE)
-          end
+        def authorized?
+          true
         end
       end
     end
   end
-end
+end

data/lib/navigable/server/endpoint_command.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Navigable
+  module Server
+    module EndpointCommand
+      def self.extended(base)
+        base.extend(Navigable::Command)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def responds_to(verb, path)
+          @responds_to_proc ||= Proc.new do |endpoint_klass|
+            endpoint_klass.responds_to(verb, path)
+          end
+
+          setup_endpoint_command if ready_for_setup?
+        end
+
+        def corresponds_to(command_key)
+          @corresponds_to_proc ||= Proc.new do |endpoint_klass, command_klass|
+            endpoint_klass.executes(command_key)
+            super(command_key)
+          end
+
+          setup_endpoint_command if ready_for_setup?
+        end
+
+        def setup_endpoint_command
+          endpoint_klass = Class.new { extend Navigable::Server::Endpoint }
+          @responds_to_proc.call(endpoint_klass)
+          @corresponds_to_proc.call(endpoint_klass, self)
+        end
+
+        def ready_for_setup?
+          @responds_to_proc && @corresponds_to_proc
+        end
+      end
+    end
+  end
+end

data/lib/navigable/server/parsers/factory.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Navigable
+  module Server
+    module Parsers
+      class Factory
+        def self.build(media_type:)
+          case media_type
+          when /application\/json/
+            Parsers::JSON
+          else
+            Parsers::Null
+          end
+        end
+      end
+    end
+  end
+end

data/lib/navigable/server/parsers/json.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Navigable
+  module Server
+    module Parsers
+      class JSON
+        def self.parse(text)
+          text ? ::JSON.parse(text) : {}
+        rescue ::JSON::ParserError
+          {}
+        end
+      end
+    end
+  end
+end

data/lib/navigable/server/parsers/null.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Navigable
+  module Server
+    module Parsers
+      class Null
+        def self.parse(*args); end
+      end
+    end
+  end
+end

data/lib/navigable/server/request.rb

@@ -38,7 +38,19 @@ module Navigable
       end
 
       def body_params
-        symbolize_keys(env[PARSED_BODY] || {})
+        symbolize_keys(parsed_body || {})
+      end
+
+      def parsed_body
+        Parsers::Factory.build(media_type: media_type).parse(body)
+      end
+
+      def body
+        @body ||= rack_request.body.read.tap { rack_request.body.rewind }
+      end
+
+      def media_type
+        rack_request.media_type
       end
 
       def url_params
@@ -54,4 +66,4 @@ module Navigable
       end
     end
   end
-end
+end

data/lib/navigable/server/response.rb

@@ -38,7 +38,7 @@ module Navigable
       end
 
       def content_length
-        content.bytesize
+        content.bytesize.to_s
       end
 
       def content

data/lib/navigable/server/version.rb

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

data/navigable-server.gemspec

@@ -23,13 +23,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'navigable-router'
   spec.add_dependency 'json', '~> 2.3'
-  spec.add_dependency 'navigable', '~> 1.0'
+  spec.add_dependency 'navigable', '~> 1.5'
+  spec.add_dependency 'navigable-router', '~>0.2'
   spec.add_dependency 'rack', '~> 2.2'
   spec.add_dependency 'rack-abstract-format', '~> 0.9.9'
   spec.add_dependency 'rack-accept-media-types', '~> 0.9'
-  spec.add_dependency 'rack-bodyparser', '~> 1.0'
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 12.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: navigable-server
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Alan Ridlehoover
@@ -9,50 +9,50 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-27 00:00:00.000000000 Z
+date: 2021-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: navigable-router
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: navigable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: navigable
+  name: navigable-router
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -95,20 +95,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: rack-bodyparser
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -197,7 +183,12 @@ files:
 - bin/console
 - bin/setup
 - lib/navigable/server.rb
+- lib/navigable/server/cors.rb
 - lib/navigable/server/endpoint.rb
+- lib/navigable/server/endpoint_command.rb
+- lib/navigable/server/parsers/factory.rb
+- lib/navigable/server/parsers/json.rb
+- lib/navigable/server/parsers/null.rb
 - lib/navigable/server/rack_adapter.rb
 - lib/navigable/server/request.rb
 - lib/navigable/server/response.rb