toast 0.9.5 → 1.0.0

data/lib/toast/singular_assoc_request.rb

@@ -0,0 +1,207 @@
+require 'toast/request_helpers'
+require 'link_header'
+
+class Toast::SingularAssocRequest
+  include Toast::RequestHelpers
+  include Toast::Errors
+
+  def initialize  id, config, base_config, auth, request
+    @id          = id
+    @config      = config
+    @base_config = base_config
+    @selected_attributes = request.query_parameters.delete(:toast_select).try(:split,',')
+    @uri_params  = request.query_parameters
+    @base_uri    = base_uri(request)
+    @verb        = request.request_method.downcase
+    @auth        = auth
+    @request     = request
+  end
+
+  def respond
+    if @verb.in? %w(get link unlink)
+      self.send(@verb)
+    else
+      response :method_not_allowed,
+               headers: {'Allow' => allowed_methods(@config)},
+               msg: "#{@verb.upcase} not supported for singular association requests"
+    end
+  end
+
+  private
+
+  def get
+    if @config.via_get.nil?
+      response :method_not_allowed,
+               headers: {'Allow' => allowed_methods(@config)},
+               msg: "GET not configured"
+    else
+      begin
+        source = @base_config.model_class.find(@id)
+        target_config = get_config(@config.target_model_class)
+        model_instance = @config.via_get.handler.call(source, @uri_params)
+        call_allow(@config.via_get.permissions, @auth, source, @uri_params)
+
+        unless model_instance.is_a? @config.target_model_class
+          # wrong class
+          response :internal_server_error,
+                   msg: "singular association returned `#{model_instance.class}', expected `#{@config.target_model_class}'"
+        else
+
+          response :ok,
+                   headers: {"Content-Type" => @config.media_type},
+                   body: represent(model_instance, target_config),
+                   msg: "sent ##{@config.model_class}##{@id}"
+        end
+
+      rescue NotAllowed => error
+        return response :unauthorized, msg: "not authorized by allow block in: #{error.source_location}"
+
+
+      rescue BadRequest => error
+        response :bad_request, msg: "`#{error.message}' in: #{error.source_location}"
+
+      rescue HandlerError => error
+        return response :internal_server_error,
+                        msg: "exception raised in via_get handler: `#{error.orig_error.message}' in #{error.source_location}"
+
+      rescue ActiveRecord::RecordNotFound
+        response :not_found,
+                 msg: "#{@config.model_class.name}##{@config.assoc_name} not found"
+
+      rescue ConfigNotFound => error
+        response :internal_server_error,
+                 msg: "no API configuration found for model `#{@config.target_model_class.name}'"
+
+      rescue => error
+        response :internal_server_error,
+                 msg: "exception from via_get handler: #{error.message}"
+      end
+    end
+  end
+
+  def link
+    if @config.via_link.nil?
+      response :method_not_allowed,
+               headers: {'Allow' => allowed_methods(@config)},
+               msg: "LINK not configured"
+    else
+
+      begin
+        source = @base_config.model_class.find(@id)
+        begin
+
+          call_allow(@config.via_link.permissions, @auth, source, @uri_params)
+
+
+          link = LinkHeader.parse(@request.headers['Link']).find_link(['ref','related'])
+
+          if link.nil?
+            return response :bad_request, msg: "Link header missing or invalid"
+          end
+
+          name, target_id = URI(link.href).path.split('/')[1..-1]
+          target_model_class = name.singularize.classify.constantize
+
+          unless is_active_record? target_model_class
+            return response :not_found, msg: "target class `#{target_model_class.name}' is not an `ActiveRecord'"
+          end
+
+          if  target_model_class != @config.target_model_class
+            return response :bad_request,
+                            msg: "target class `#{target_model_class.name}' invalid, expect: `#{@config.target_model_class}'"
+          end
+
+          @config.via_link.handler.call(source, target_model_class.find(target_id), @uri_params)
+          response :ok,
+                   msg: "linked #{source.class}##{source.id} with #{target_model_class.name}##{@id}"
+
+        rescue NotAllowed => error
+          return response :unauthorized, msg: "not authorized by allow block in: #{error.source_location}"
+
+        rescue BadRequest => error
+          response :bad_request, msg: "`#{error.message}' in: #{error.source_location}"
+
+        rescue HandlerError => error
+          return response :internal_server_error,
+                          msg: "exception raised in via_link handler: `#{error.orig_error.message}' in #{error.source_location}"
+
+        rescue ActiveRecord::RecordNotFound # target not found
+          response :not_found, msg: "#{target_model_class.name}##{target_id} not found"
+
+        rescue => error
+          response :internal_server_error, msg: "exception from via_link handler: #{error.message}"
+        end
+      rescue ActiveRecord::RecordNotFound # source not found
+        response :not_found, msg: "#{@base_config.model_class.name}##{@id} not found"
+      end
+    end
+
+  end
+
+  def unlink
+    if @config.via_unlink.nil?
+      response :method_not_allowed,
+               headers: {'Allow' => allowed_methods(@config)},
+               msg: "UNLINK not configured"
+    else
+      begin
+        source = @base_config.model_class.find(@id)
+        call_allow(@config.via_unlink.permissions, @auth, source, @uri_params)
+
+        link = LinkHeader.parse(@request.headers['Link']).find_link(['ref','related'])
+
+        if link.nil?
+          return response :bad_request, msg: "Link header missing or invalid"
+        end
+
+        name, target_id = URI(link.href).path.split('/')[1..-1]
+        target_model_class = name.singularize.classify.constantize
+
+        unless is_active_record? target_model_class
+          return response :not_found, msg: "target class `#{target_model_class.name}' is not an `ActiveRecord'"
+        end
+
+        if target_model_class != @config.target_model_class
+          return response :bad_request,
+                          msg: "target class `#{target_model_class.name}' invalid, expect: `#{@config.target_model_class}'"
+        end
+
+        target = nil
+        begin
+          target = target_model_class.find(target_id)
+        rescue ActiveRecord::RecordNotFound # target
+          return response :not_found, msg: "#{target_model_class.name}##{target_id} not found"
+        end
+
+        current = source.send(@config.assoc_name)
+
+        if current != target
+          return response :conflict, msg: "target `#{current.class}##{current.id}' is not associated, cannot unlink `#{target.class}##{target.id}'"
+        end
+
+        call_handler(@config.via_unlink.handler, source, target, @uri_params)
+
+        response :ok,
+                 msg: "unlinked #{source.class}##{source.id} from #{target_model_class.name}##{target_id}"
+
+      rescue NotAllowed => error
+        return response :unauthorized,
+                        msg: "not authorized by allow block in: #{error.source_location}"
+
+      rescue BadRequest => error
+        response :bad_request, msg: "`#{error.message}' in: #{error.source_location}"
+
+      rescue HandlerError => error
+        return response :internal_server_error,
+                        msg: "exception raised in via_unlink handler: `#{error.orig_error.message}' in #{error.source_location}"
+
+      rescue AllowError => error
+        return response :internal_server_error,
+                        msg: "exception raised in allow block: `#{error.orig_error.message}' in #{error.source_location}"
+
+      rescue ActiveRecord::RecordNotFound # source
+        return response :not_found, msg: "#{@base_config.model_class.name}##{@id} not found"
+      end
+    end
+  end
+end

data/lib/toast/version.rb

@@ -1,3 +1,3 @@
 module Toast
-  VERSION = '0.9.5'
-end
+  VERSION = '1.0.0'
+end 

data/lib/toast.rb

@@ -1 +1,100 @@
-require 'toast/engine' if defined?(Rails) && Rails::VERSION::MAJOR == 3
+unless defined?(Rails)
+  puts 'The Toast gem is made for Ruby on Rails 5.'
+  exit 1
+end
+
+unless Rails::VERSION::MAJOR == 5
+  puts 'Toast v1 requires Ruby on Rails 5, try v0.9 for older rails.'
+  exit 1
+end
+
+require 'ostruct'
+require 'toast/engine'
+require 'toast/config_dsl'
+require 'toast/rack_app'
+
+module Toast
+  Sym = "\xF0\x9F\x8D\x9E" # The BREAD
+
+  # config data of all expose blocks
+  @@expositions = []
+
+  # collects all configs of one expose block (DSL methods write to it)
+  @@current_expose = nil
+
+  cattr_accessor :expositions, :settings
+
+  class ConfigError < StandardError
+  end
+
+  # called once on boot via enigne.rb
+  def self.init config_path='config/toast-api/*', settings_path='config/toast-api.rb'
+
+    # clean up
+    Toast.expositions.clear
+    Toast.settings = nil
+
+    settings = ''
+    # read global settings
+    if File.exists? settings_path
+      open settings_path do |f|
+        settings = f.read
+      end
+    else
+      info "No global settings file found: `#{settings_path}', using defaults"
+      settings_path = '[defaults]'
+    end
+
+    Toast::ConfigDSL.get_settings settings, settings_path
+
+    # read configurations
+    config_files = Dir[config_path]
+
+    if config_files.empty?
+      Toast.raise_config_error "No config files found in `#{config_path}`"
+    else
+
+      config_files.each do |fname|
+        open fname do |f|
+          config = f.read
+          Toast::ConfigDSL.get_config(config, fname)
+        end
+      end
+    end
+  end
+
+  def self.info str
+    if Rails.const_defined?('Server') # only on console server
+      puts Toast::Sym+'  Toast: '+str 
+    end
+  end
+
+  def self.disable message=''
+    info "Disabeling resource exposition due to config errors."
+    info message unless message.blank?
+
+    @@expositions.clear
+  end
+
+  def self.raise_config_error message
+    raise ConfigError.new("CONFIG ERROR: #{message}")
+  end
+
+  def self.logger
+    @@logger ||= Logger.new("#{Rails.root}/log/toast.log")
+  end
+
+  # get the  representation (as Hash) by instance (w/o request)
+  # 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
+    obj = Object.new
+    class << obj
+      include Toast::RequestHelpers
+      attr_accessor :base_uri
+    end
+    obj.base_uri = base_uri
+    obj.represent_one(instance, obj.get_config(instance.class) )
+  end
+end

metadata

@@ -1,149 +1,116 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: toast
-version: !ruby/object:Gem::Version 
-  hash: 49
-  prerelease: false
-  segments: 
-  - 0
-  - 9
-  - 5
-  version: 0.9.5
+version: !ruby/object:Gem::Version
+  version: 1.0.0
 platform: ruby
-authors: 
+authors:
 - robokopp (Robert Annies)
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2018-07-19 00:00:00 +00:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2017-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rails
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 3
-        - 1
-        - 0
-        version: 3.1.0
-    - - <
-      - !ruby/object:Gem::Version 
-        hash: 63
-        segments: 
-        - 4
-        - 0
-        - 0
-        version: 4.0.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: blockenspiel
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 0
-        - 4
-        - 2
-        version: 0.4.2
-  type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
   name: rack-accept-media-types
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 25
-        segments: 
-        - 0
-        - 9
-        version: "0.9"
+      - !ruby/object:Gem::Version
+        version: '0.9'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rack-link_headers
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  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
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 2
-        - 2
-        version: 2.2.2
+      - !ruby/object:Gem::Version
+        version: 0.0.8
   type: :runtime
-  version_requirements: *id004
-description: Toast is an extension to Ruby on Rails 3 that lets you expose any ActiveRecord model as a web resource. Operations follow the REST/Hypermedia API principles implemented by a generic hidden controller.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+description: "Toast is a Rack application that hooks into Ruby on Rails. It exposes
+  ActiveRecord models as \na web service (REST API). The main difference from doing
+  that with Ruby on Rails itself is \nit's DSL that covers all aspects of an API in
+  one single configuration.\n"
 email: robokopp@fernwerk.net
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
+- README.md
+files:
 - README.md
-files: 
-- app/controller/toast_controller.rb
 - config/routes.rb
+- lib/generators/toast/USAGE
+- lib/generators/toast/templates/toast-api.rb.erb
+- lib/generators/toast/toast_generator.rb
 - lib/toast.rb
-- lib/toast/version.rb
-- lib/toast/active_record_extensions.rb
-- lib/toast/association.rb
-- lib/toast/collection.rb
+- lib/toast/canonical_request.rb
+- lib/toast/collection_request.rb
 - lib/toast/config_dsl.rb
+- lib/toast/config_dsl/association.rb
+- lib/toast/config_dsl/base.rb
+- lib/toast/config_dsl/collection.rb
+- lib/toast/config_dsl/common.rb
+- lib/toast/config_dsl/default_handlers.rb
+- lib/toast/config_dsl/expose.rb
+- lib/toast/config_dsl/settings.rb
+- lib/toast/config_dsl/single.rb
+- lib/toast/config_dsl/via_verb.rb
 - lib/toast/engine.rb
-- lib/toast/record.rb
-- lib/toast/resource.rb
-- lib/toast/single.rb
-- README.md
-has_rdoc: true
+- lib/toast/errors.rb
+- lib/toast/http_range.rb
+- lib/toast/plural_assoc_request.rb
+- lib/toast/rack_app.rb
+- lib/toast/request_helpers.rb
+- lib/toast/single_request.rb
+- lib/toast/singular_assoc_request.rb
+- lib/toast/version.rb
 homepage: https://github.com/robokopp/toast
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 2.4.6
 signing_key: 
-specification_version: 3
-summary: Toast adds a Hypermedia API to ActiveRecord models in Ruby on Rails.
+specification_version: 4
+summary: Toast exposes ActiveRecord models as a web service (REST API).
 test_files: []
-
+has_rdoc: 

data/app/controller/toast_controller.rb

@@ -1,103 +0,0 @@
-require 'rack-link_headers'
-
-class ToastController < ApplicationController
-
-  def catch_all
-
-    begin
-
-      @resource = Toast::Resource.build( params, request )
-
-      unless request.headers["LINK"].nil?
-        # extract "path_info" from link header
-        port = if(request.port != 80 and request.port != 443)
-                 ":#{request.port}"
-               else
-                 ""
-               end
-
-        request.headers["LINK"] =~ /(#{request.protocol + request.host + port + request.script_name})(.*)/
-      end
-
-      toast_response = @resource.apply(request.method, request.body.read, request.content_type, $2)
-
-      # pagination
-      if pi = toast_response[:pagination_info]
-        # URL w/o parameters
-
-        url =  request.url.split('?').first
-        qpar = request.query_parameters.clone
-
-        # change/add page parameter
-        link_header = []
-
-        if pi[:prev]
-          qpar[:page] = pi[:prev]
-          response.link "#{url}?#{qpar.to_query}", :rel => :prev
-        end
-
-        if pi[:next]
-          qpar[:page] = pi[:next]
-          response.link "#{url}?#{qpar.to_query}", :rel => :next
-        end
-
-        qpar[:page] = pi[:last]
-        response.link "#{url}?#{qpar.to_query}", :rel => :last
-
-        qpar[:page] = 1
-        response.link "#{url}?#{qpar.to_query}", :rel => :first
-
-        response.headers["X-Collection-Size"] = pi[:total].to_s
-
-      end
-
-      render toast_response
-
-    rescue Toast::ResourceNotFound => e
-      return head(:not_found)
-
-    rescue Toast::PayloadInvalid => e
-      return render :text => e.message, :status => :forbidden
-
-    rescue Toast::PayloadFormatError => e
-      return head(:bad_request)
-
-    rescue Toast::BadRequest => e
-      return head(:bad_request)
-
-    rescue Toast::MethodNotAllowed => e
-      return head(:method_not_allowed)
-
-    rescue Toast::UnsupportedMediaType => e
-      return head(:unsupported_media_type)
-
-    rescue Toast::ResourceNotAcceptable => e
-      return head(:not_acceptable)
-
-    rescue Toast::Conflict => e
-      return render :text => e.message, :status => :conflict
-
-    rescue Exception => e
-      log_exception e
-      puts e if Rails.env == "test"
-      return head(:internal_server_error)
-    end
-
-  end
-
-  def not_found
-    return head(:not_found)
-  end
-
-
-  if Rails.env == "test"
-    def log_exception e
-      puts "#{e.class}: '#{e.message}'\n\n#{e.backtrace[0..14].join("\n")}\n\n"
-    end
-  else
-    def log_exception e
-      logger.error("#{e.class}: '#{e.message}'\n\n#{e.backtrace.join("\n")}")
-    end
-  end
-
-end