toast 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a7b7339a3fd66ef55e9261818f11458c36c7164
-  data.tar.gz: c3e72c819be4ebcc9769d77411bbabb088db2abf
+  metadata.gz: 277d6133963ef4bab7c92dec2cfcf4e57c59f7e3
+  data.tar.gz: f592710bc8498778fd12760cd8439eea36bab6f5
 SHA512:
-  metadata.gz: efbebf7fd608c4cde8666531e5b55531b41cd81b41e1c55e50acf636498d0e031ed822c378bcba2811aad76cafbc700fb0ef4f6057a1a6faf3e1c51e804732db
-  data.tar.gz: 37626365865ea3b1cd05a552b53821ba7d2bc02572c444071fe6acfde7b1940233540d39902d122f284c0400ffb35e6d99876cba014115a5875c87a3155317d7
+  metadata.gz: 95033345cb023b2ffcdf47b2ea000b6c2147a9daab5268de4e4bc565ae811fc6d6e3d5fd06a2d431b16d79c21b00872bc44d44f6913f70b4601d60e23b43a0f4
+  data.tar.gz: 7db559b1ae70778c937c1bb59c4888fb508e29e30f83cfa0c5cf65d7197d010583c479b31ebb8b2aae5194fcff97a8fdd8808012a66c981e89467bedcc71961f

data/README.md

@@ -33,16 +33,6 @@ Works with Rails 5 and 4.2.9+. This version will be tested with upcoming new Rai
 
 Works with Rails 3 and 4. It has a much different and smaller DSL, which is not compatible with v1. This version will not receive any updates or fixes anymore.
 
-Status
-======
-
-Toast v1 for Rails 5 is a complete rewrite of v0.9, which was first published and used in production since 2012. 
-It comes now with secure defaults: Nothing is exposed unless declared, all endpoints have a default authorization hook responding with 401. 
-
-v1 is not compatible with v0.9, and it is not tested with Rails < v5. All configurations must be ported to the new DSL. 
-
-From my point of view it is production ready. I am in the process of porting a large API from v0.9 to v1 that uses all features and it looks very good so far. Of course minor issues will appear, please help to report and fix them. 
-
 Installation
 ============
 

data/lib/toast.rb

@@ -12,7 +12,10 @@ module Toast
   # collects all configs of one expose block (DSL methods write to it)
   @@current_expose = nil
 
-  cattr_accessor :expositions, :settings
+  # path tree to resolve the requested model
+  @@path_tree = {}
+
+  cattr_accessor :expositions, :settings, :path_tree
 
   class ConfigError < StandardError
   end
@@ -23,6 +26,7 @@ module Toast
     # clean up
     Toast.expositions.clear
     Toast.settings = nil
+    Toast.path_tree = {}
 
     settings = ''
     # read global settings

data/lib/toast/config_dsl/base.rb

@@ -20,6 +20,21 @@ class Toast::ConfigDSL::Base
         raise_config_error 'Block expected.'
       end
 
+      # register base path with 'under' prefix
+      to_path_tree = lambda do |path|        
+        if path.empty?
+          { model_class.to_s.underscore.pluralize => model_class }
+        else 
+          { path.first => to_path_tree.call(path[1..-1]) }
+        end
+      end
+
+      path = under.split('/').delete_if(&:blank?)
+      Toast.path_tree.deep_merge!(to_path_tree.call(path)) do |key,v1,v2|
+        raise_config_error "multiple definitions of endpoint URI segment `.../#{key}/...'"
+      end
+
+      # base config object
       config_data = OpenStruct.new
 
       config_data.instance_eval do
@@ -27,8 +42,8 @@ class Toast::ConfigDSL::Base
 
         self.model_class     = model_class
         self.media_type      = as
-        self.url_path_prefix = under.split('/').delete_if(&:blank?)
-
+        self.prefix_path     = path
+ 
         # defaults
         self.readables    = []
         self.writables    = []

data/lib/toast/rack_app.rb

@@ -34,32 +34,20 @@ class Toast::RackApp
     end
 
     path       = request.path_parameters[:toast_path].split('/')
+    
+    # look up requested model
+    model_class = resolve_model(path, Toast.path_tree)
 
-    # strip path prefixes
-    # get  model class
-    begin
-      if path.first.singularize == path.first # not in plural form?
-        raise NameError
-      end
-      model_class = path.first.singularize.classify.constantize
-      raise NameError unless is_active_record?(model_class)
-    rescue NameError
+    if model_class.nil?
       return response :not_found,
-                      msg: "resource at /#{path.join('/')} not found"
+                      msg: "no API configuration found for endpoint /#{path.join('/')}"
     end
 
     # select base configuration
+    base_config = get_config(model_class)
 
-    ## This is unused. Do we need it at all?
-    # preferred_type = Rack::AcceptMediaTypes.new(env['HTTP_ACCEPT']).prefered || "application/json"
-
-    # the base_config is the configuration for the model corresponding to the first part of the URI path
-    begin
-      base_config = get_config(model_class)
-    rescue Toast::Errors::ConfigNotFound => error
-      return response :not_found,
-                      msg: "no API configuration found for model `#{model_class.name}'"
-    end
+    # remove path prefix
+    path = path[(base_config.prefix_path.length)..-1]
 
     toast_request =
       case path.length
@@ -130,4 +118,17 @@ class Toast::RackApp
     toast_request.respond
 
   end
+
+  private
+    # 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) 
+        # dig deeper
+        resolve_model(path[1..-1], path_tree[ path.first ])
+      else
+        path_tree[ path.first ]
+      end
+    end  
 end
+

data/lib/toast/request_helpers.rb

@@ -23,7 +23,8 @@ module Toast::RequestHelpers
       result[attr.to_s] = record.send(attr) if attr_selected?(attr)
     end
 
-    model_uri =  "#{@base_uri}/#{record.class.name.underscore.pluralize}"    
+    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

data/lib/toast/version.rb

@@ -1,3 +1,3 @@
 module Toast
-  VERSION = '1.0.2'
-end 
+  VERSION = '1.0.3'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: toast
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - robokopp (Robert Annies)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-12 00:00:00.000000000 Z
+date: 2017-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,20 +24,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 4.2.9
-- !ruby/object:Gem::Dependency
-  name: rack-accept-media-types
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: link_header
   requirement: !ruby/object:Gem::Requirement