navigable-server 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68e55e159229ccccc9d9054c051e9fdcd1edeb0a4919df0349afd1fa6950da7f
-  data.tar.gz: a86086f6f97ec97c1f072cc5538d60a7573ca27e913feb9704c3f25bf9eff4d4
+  metadata.gz: 5938d19f2fef581f5329cb345a2141b9994d13de64a04a364a273095b52f3001
+  data.tar.gz: 8463bc00fa4035f7d4d31212eef94c34c2bad9d21649cec59983e709e19a3651
 SHA512:
-  metadata.gz: ade898aefa8686fe83f748f3493b71b5acc578b99324a5abb1251943dc73ac61d43400c6d8bbe7dbfb454a1a58854f2c69bbdad54d313acc72a17210fee22396
-  data.tar.gz: 0adfc4624b53cb5a3f172f8bf3700a713616469813747479743d01f084ff808ff95ac6be7a8ea3aee9b4bdaaead139078097dcfa868a7afb3c4ba0f7bccba9ea
+  metadata.gz: a79b3ed8a998efde770f54d2352774a2365ca9213ff49520810486e225f2b9a9fa6c8ce07ea5a18575fc580b620834aab1f319f44302ee960bff72bfb8a4665b
+  data.tar.gz: 78299c73d9e5fe6c941dfd3d85e8e1f44f8d932e9b3b969092a1f234fcf67098d3d0ea132ff337420ad36595607044238a7c9f695ca403731aa868e5093dc6e1

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/endpoint.rb

@@ -4,52 +4,76 @@ module Navigable
   module Server
     module Endpoint
       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
+        def executes(command_key)
+          @command_key = command_key
         end
+      end
+
+      module InstanceMethods
+        attr_reader :request
 
-        base.class_eval do
-          attr_reader :request
+        def inject(request: Request.new)
+          @request = request
+        end
 
-          def inject(request: Request.new)
-            @request = request
-          end
+        def execute
+          raise NotImplementedError.new(EXECUTE_NOT_IMPLEMENTED_MESSAGE) unless command_key
 
-          def execute
-            raise NotImplementedError.new(EXECUTE_NOT_IMPLEMENTED_MESSAGE) unless command_key
+          return unauthenticated unless authenticated?
+          return unauthorized unless authorized?
 
-            dispatch
-          end
+          dispatch
+        end
 
-          private
+        private
 
-          def dispatch
-            Navigable::Dispatcher.dispatch(command_key, params: params, resolver: resolver)
-          end
+        def dispatch
+          Navigable::Dispatcher.dispatch(command_key, params: params, resolver: resolver)
+        end
 
-          def command_key
-            self.class.instance_variable_get(:@command_key)
-          end
+        def command_key
+          self.class.instance_variable_get(:@command_key)
+        end
 
-          def params
-            request.params
-          end
+        def params
+          request.params
+        end
 
-          def preferred_media_type
-            request.headers[:preferred_media_type]
-          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 resolver
-            Manufacturable.build_one(Resolver::TYPE, preferred_media_type) || Navigable::NullResolver.new
-          end
+        def authorized?
+          true
         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.5.0"
+    VERSION = "0.6.0"
   end
 end

data/navigable-server.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'json', '~> 2.3'
-  spec.add_dependency 'navigable', '~> 1.3'
+  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'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: navigable-server
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Alan Ridlehoover
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-29 00:00:00.000000000 Z
+date: 2020-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: navigable-router
   requirement: !ruby/object:Gem::Requirement