toast 1.0.8 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50d88f29268283ea8b037037c3b0bf95df8b639b
-  data.tar.gz: 8fce6e446f54b375c90ef90cbccc00f746142d2b
+  metadata.gz: 013c0b6f57e6509f8555a3bb9a4886e1abaf3f33
+  data.tar.gz: 317ecb00aeaff9b9c7e3faf0271119e956d96075
 SHA512:
-  metadata.gz: 4966d74e26040d21f39286c65e1ed2211557ea094eddbd3a0e85f9439cf6e4ed96e5417ca108c9dbeec7af0245c14c31aff82ca448e91f6353906e80ab121aae
-  data.tar.gz: d7039b45831ffd6e25dd35ee76b1219461495c74707040811660deb4062bc79b926af42df66e87fe8954176116e36c34b2dec5d5e4c021828f941f54ed58a776
+  metadata.gz: f14236d4f0d9d5bb2f4959c36e759bf2d51b1509dbd31b1b4c2560fa31c2a8cbe90c335e73b533fecc7c95bf8588cedcef1681f858ff4694b9ce1f6e45a9b3ee
+  data.tar.gz: 8cdb9770f943e081eb7e9d099de3214cb7ab167dc25558162ae0300beb05cfabd29b0508c891cdd3a8d0aa3a9a94b827bf0769b05a4392256d586d477aad16fa

data/README.md

@@ -20,7 +20,7 @@ Other features are:
   * attribute selection per request
   * processing of URI parameters
 
-See the [User Manual](https://robokopp.github.io/toast) for a detailed description.
+See the [User Manual](https://robert-annies.github.io/toast) for a detailed description.
 
 Releases
 ========

data/lib/toast.rb

@@ -15,7 +15,7 @@ module Toast
   # path tree to resolve the requested model
   @@path_tree = {}
 
-  cattr_accessor :expositions, :settings, :path_tree
+  cattr_accessor :expositions, :settings, :path_tree, :request
 
   class ConfigError < StandardError
   end
@@ -59,7 +59,7 @@ module Toast
 
   def self.info str
     if Rails.const_defined?('Server') # only on console server
-      puts Toast::Sym+'  Toast: '+str 
+      puts Toast::Sym+'  Toast: '+str
     end
   end
 
@@ -82,7 +82,7 @@ module Toast
   # base_uri must be passed to be prepended in URIs
   def self.represent instance, base_uri = ''
 
-    # using RequestHelper#represent_one method with a mocked up object
+    # using RequestHelper#represent_one method with a mocked up object :-/
     obj = Object.new
     class << obj
       include Toast::RequestHelpers
@@ -91,4 +91,13 @@ module Toast
     obj.base_uri = base_uri
     obj.represent_one(instance, obj.get_config(instance.class) )
   end
+
+  def self.base_uri
+    raise Toast::NotInRequestContext unless request
+
+    port  = ":#{request.port}" unless request.port.in?([80,443])
+    # remove recource path part form full path (namespace remains)
+    path  = request.path.sub(request.path_parameters[:toast_path],'')
+    (request.protocol + request.host + port.to_s + path).chomp('/')
+  end
 end

data/lib/toast/config_dsl/base.rb

@@ -20,11 +20,14 @@ class Toast::ConfigDSL::Base
         raise_config_error 'Block expected.'
       end
 
+
+
+
       # register base path with 'under' prefix
-      to_path_tree = lambda do |path|        
+      to_path_tree = lambda do |path|
         if path.empty?
           { model_class.to_s.underscore.pluralize => model_class }
-        else 
+        else
           { path.first => to_path_tree.call(path[1..-1]) }
         end
       end
@@ -34,6 +37,15 @@ class Toast::ConfigDSL::Base
         raise_config_error "multiple definitions of endpoint URI segment `.../#{key}/...'"
       end
 
+      # externd model_class with toast_uri accessor
+      model_class.send(:define_method, :toast_full_uri) do
+        Toast.base_uri + '/' + self.toast_local_uri
+      end
+
+      model_class.send(:define_method, :toast_local_uri) do
+        [path, self.class.name.underscore.pluralize, self.id].delete_if(&:blank?).join('/')
+      end
+
       # base config object
       config_data = OpenStruct.new
 
@@ -43,7 +55,7 @@ class Toast::ConfigDSL::Base
         self.model_class     = model_class
         self.media_type      = as
         self.prefix_path     = path
- 
+
         # defaults
         self.readables    = []
         self.writables    = []

data/lib/toast/errors.rb

@@ -38,4 +38,7 @@ module Toast::Errors
       @response_data = response_data
     end
   end
+
+  class Toast::NotInRequestContext < StandardError; end
+
 end

data/lib/toast/rack_app.rb

@@ -6,7 +6,7 @@ require 'toast/plural_assoc_request'
 require 'toast/errors'
 
 class Toast::RackApp
-  # NOTE: the RackApp object is shared in threads of concurrent requests 
+  # NOTE: the RackApp object is shared in threads of concurrent requests
   #       (e.g. when using Puma server, but not in Passenger (single-threded, multi-process)).
   #       Anyays, don't use any instance vars (@ variables in #call).
   #       It causes chaos
@@ -16,17 +16,18 @@ class Toast::RackApp
   def call(env)
 
     request = ActionDispatch::Request.new(env)
-    
+    Toast.request = request
+
     Toast.logger.info "[#{Thread.current.object_id}] processing: <#{URI.decode(request.fullpath)}>"
 
-    # Authentication: respond with 401 on exception or falsy return value: 
+    # Authentication: respond with 401 on exception or falsy return value:
     begin
       unless (auth = Toast::ConfigDSL::Settings::AuthenticateContext.new.
                       instance_exec(request, &Toast.settings.authenticate))
          return response :unauthorized, msg: "authentication failed"
       end
-    rescue Toast::Errors::CustomAuthFailure => caf   
-      return response(caf.response_data[:status] || :unauthorized, 
+    rescue Toast::Errors::CustomAuthFailure => caf
+      return response(caf.response_data[:status] || :unauthorized,
                msg: caf.response_data[:body],
                headers: caf.response_data[:headers])
     rescue => error
@@ -34,7 +35,7 @@ class Toast::RackApp
     end
 
     path       = request.path_parameters[:toast_path].split('/')
-    
+
     # look up requested model
     model_class = resolve_model(path, Toast.path_tree)
 
@@ -120,15 +121,15 @@ class Toast::RackApp
   end
 
   private
-    # gets the model class from the 
+    # gets the model class from the
     # it's similar to Hash#dig but stops at a non string
     def resolve_model path, path_tree
-      if path_tree[ path.first ].is_a?(Hash) 
+      if path_tree[ path.first ].is_a?(Hash)
         # dig deeper
         resolve_model(path[1..-1], path_tree[ path.first ])
       else
         path_tree[ path.first ]
       end
-    end  
+    end
 end
 

data/lib/toast/request_helpers.rb

@@ -8,13 +8,8 @@ module Toast::RequestHelpers
     end || raise(Toast::Errors::ConfigNotFound)
   end
 
-  # this is hard when behind a proxy
-  # relies on HTTP_X_FORWARDED* headers
   def base_uri request
-    port  = ":#{request.port}" unless request.port.in?([80,443])
-    # remove recource path part form full path (namespace remains)
-    path  = request.path.sub(request.path_parameters[:toast_path],'')
-    (request.protocol + request.host + port.to_s + path).chomp('/')
+    Toast.base_uri
   end
 
   # split the name and id of the resource from a LinkHeader
@@ -25,12 +20,21 @@ module Toast::RequestHelpers
   def represent_one record, config
     result = {}
 
+    model_uri = [@base_uri, config.prefix_path, record.class.name.underscore.pluralize].delete_if(&:blank?).join('/')
+
+    # can we inject model_uri  into the recortd, so that virtual attribute methods can use it in their result?
+
+    # - setting a special property on the record :-/, OK Toast could extend all exposed classes by a special accessor,
+    #   maybe only if configured.
+    # - calling somehow this method in different/extended context (how?)
+    # - passing this as parameter, while not requiring all the attribute methods to accept a 2. arg (possible?)
+    # - If the result is a String it can return a templated String like "{{ toast_uri }}", OK for single
+    #   strings, but for mebedded Hashes with Strings no, too expensive.
+
     (config.readables + config.writables).each do |attr|
       result[attr.to_s] = record.send(attr) if attr_selected?(attr)
     end
 
-    model_uri = [@base_uri, config.prefix_path, record.class.name.underscore.pluralize].delete_if(&:blank?).join('/')
-
     result['self'] = "#{model_uri}/#{record.id}" if attr_selected?('self')
 
     # add associations, collections and singles
@@ -127,7 +131,7 @@ module Toast::RequestHelpers
     rescue Toast::Errors::BadRequest
       raise # re-raise
     rescue => error
-      raise Toast::Errors::HandlerError.new(error, error.backtrace.first.sub(/:in.*/,''))
+      raise Toast::Errors::HandlerError.new(error, error.backtrace.first.try(:sub,/:in.*/,''))
     end
     result
   end

data/lib/toast/version.rb

@@ -1,3 +1,3 @@
 module Toast
-  VERSION = '1.0.8'
+  VERSION = '1.0.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: toast
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
 platform: ruby
 authors:
 - robokopp (Robert Annies)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-21 00:00:00.000000000 Z
+date: 2019-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails