praxis 2.0.pre.1 → 2.0.pre.6

data/lib/praxis/media_type.rb

@@ -7,15 +7,12 @@ module Praxis
   # encodings; for example, a controller might respond with an actual Widget object, but a
   # Content-Type header specifying 'application/vnd.acme.widget+json'; Praxis uses the information
   # contained in the media-type definition of Widget to transform the object into an equivalent
-  # JSON representation. If the content type ends with '+xml' instead, and the XML handler is
-  # registered with the framework, Praxis will respond with an XML representation of the
-  # widget. The use of media types allows your application's models to be decoupled from its
+  # JSON representation. The use of media types allows your application's models to be decoupled from its
   # HTTP interface specification.
   #
   # A media type definition consists of:
   #   - a MIME type identifier
   #   - attributes, each of which has a name and a data type
-  #   - named links to other resources
   #   - named views, which expose interesting subsets of attributes
   #
   # @example Declare a widget type that's used by my supply-chain management app
@@ -37,16 +34,6 @@ module Praxis
   #         description: 'The factory in which this widget was produced'
   #     end
   #
-  #     links do
-  #       link :factory,
-  #         description: 'Link to the factory in which this widget was produced'
-  #     end
-  #
-  #     # If widgets can be linked-to by other resources, they should have a link view
-  #     view :link do
-  #       attribute :href
-  #     end
-  #
   #     # All resources should have a default view
   #     view :default do
   #       attribute :id
@@ -58,32 +45,6 @@ module Praxis
 
     include Types::MediaTypeCommon
 
-    class DSLCompiler < Attributor::HashDSLCompiler
-      def links(&block)
-        attribute :links, Praxis::Links.for(options[:reference]), dsl_compiler: Links::DSLCompiler, &block
-      end
-    end
-
-    def self.attributes(opts={}, &block)
-      super(opts.merge(dsl_compiler: MediaType::DSLCompiler), &block)
-    end
-
-    def self._finalize!
-      super
-
-      # Only define our special links accessor if it was setup using the special DSL
-      # (we might have an app defining an attribute called `links` on its own, in which
-      # case we leave it be)
-      if @attribute && self.attributes.key?(:links) && self.attributes[:links].type < Praxis::Links
-        module_eval <<-RUBY, __FILE__, __LINE__ + 1
-        def links
-          self.class::Links.new(@object)
-        end
-        RUBY
-      end
-    end
-
-
     class FieldResolver
       def self.resolve(type,fields)
         self.new.resolve(type,fields)
@@ -118,30 +79,14 @@ module Praxis
 
 
         fields.each do |name, sub_fields|
-          # skip links and do them below
-          next if name == :links && defined?(type::Links)
 
           new_type = type.attributes[name].type
           result[name] = resolve(new_type, sub_fields)
         end
 
-        # now to tackle whatever links there may be
-        if defined?(type::Links) &&(links_fields = fields[:links])
-          resolved_links = resolve_links(type::Links, links_fields)
-          self.deep_merge(result, resolved_links)
-        end
-
         result
       end
 
-      def resolve_links(links_type, links)
-        links.each_with_object({}) do |(name, link_fields), hash|
-          using = links_type.links[name]
-          new_type = links_type.attributes[name].type
-          hash[using] = resolve(new_type, link_fields)
-        end
-      end
-
       # perform a deep recursive *in place* merge
       # form all values in +source+ onto +target+
       #

data/lib/praxis/media_type_identifier.rb

@@ -146,7 +146,8 @@ module Praxis
       if self.parameters.empty?
         self
       else
-        MediaTypeIdentifier.load(type: self.type, subtype: self.subtype, suffix: self.suffix)
+        val = {type: self.type, subtype: self.subtype, suffix: self.suffix}
+        MediaTypeIdentifier.load(val)
       end
     end
 

data/lib/praxis/multipart/part.rb

@@ -28,6 +28,10 @@ module Praxis
       self
     end
 
+    def self.json_schema_type
+      :object
+    end
+
     def self.example(context=nil, options:{})
       if (payload_attribute = options[:payload_attribute])
         payload = payload_attribute.example(context + ['payload'])
@@ -52,8 +56,7 @@ module Praxis
                headers_attribute: headers_attribute,
                filename_attribute: filename_attribute)
     end
-
-
+    
     def self.describe(shallow=true, example: nil, options:{})
       hash = super(shallow, example: example)
 

data/lib/praxis/notifications.rb

@@ -21,7 +21,7 @@ module Praxis
     end
 
     def self.instrument(name, payload = {}, &block)
-      ActiveSupport::Notifications.instrument(name, payload, &block)
+      ActiveSupport::Notifications.instrument(name, **payload, &block)
     end
 
     def self.subscribe(*args, &block)

data/lib/praxis/plugins/mapper_plugin.rb

@@ -1,5 +1,5 @@
 require 'singleton'
-require 'praxis/extensions/attribute_filtering/filtering_params'
+require 'praxis/extensions/attribute_filtering'
 
 module Praxis
   module Plugins
@@ -8,6 +8,21 @@ module Praxis
 
       class Plugin < Praxis::Plugin
         include Singleton
+
+        def config_key
+          :mapper
+        end
+
+        def load_config!
+          {} # override the default one, since we don't necessarily want to configure it via a yaml file.
+        end
+
+        def prepare_config!(node)
+          node.attributes do
+            attribute :debug_queries, Attributor::Boolean, default: false,
+              description: 'Weather or not to log debug information about queries executed in the build_query automation module'
+          end
+        end
       end
 
       module Controller
@@ -32,8 +47,7 @@ module Praxis
           filters = request.params.filters if request.params&.respond_to?(:filters)
           base_query = domain_model.craft_filter_query( base_query , filters: filters )
 
-          resolved = Praxis::MediaType::FieldResolver.resolve(self.media_type, self.expanded_fields)
-          base_query = domain_model.craft_field_selection_query(base_query, selectors: selector_generator.selectors, resolved: resolved)
+          base_query = domain_model.craft_field_selection_query(base_query, selectors: selector_generator.selectors)
 
           # TODO: handle pagination and ordering
           base_query

data/lib/praxis/plugins/pagination_plugin.rb

@@ -0,0 +1,71 @@
+require 'singleton'
+require 'praxis/extensions/pagination'
+
+# Simple plugin concept
+# Example configuration for this plugin
+# Praxis::Application.configure do |application|
+#   application.bootloader.use Praxis::Plugins::PaginationPlugin, {
+#     max_items: 500,  # Unlimited by default,
+#     default_page_size: 100,
+#     disallow_paging_by_default: false,
+#     # See all available options below
+#   end
+# end
+#
+# This would be applied to all controllers etc...so if one does not that
+# It can easily add the `include Praxis::Extensions::Pagination` for every controller
+# and use the class `Praxis::Types::PaginationParams.xxx yyy` stanzas to configure defaults
+
+module Praxis
+  module Plugins
+    module PaginationPlugin
+      include Praxis::PluginConcern
+
+      class Plugin < Praxis::Plugin
+        include Singleton
+
+        def config_key
+          :pagination
+        end
+
+        def load_config!
+          @options || {}
+        end
+
+        def prepare_config!(node)
+          node.attributes do
+            attribute :max_items, Integer # Defaults to unlimited
+            attribute :default_page_size, Integer, default: Praxis::Types::PaginationParams.default_page_size
+            attribute :paging_default_mode, Hash, default: Praxis::Types::PaginationParams.paging_default_mode
+            attribute :disallow_paging_by_default, Attributor::Boolean, default: Praxis::Types::PaginationParams.disallow_paging_by_default
+            attribute :disallow_cursor_by_default, Attributor::Boolean, default: Praxis::Types::PaginationParams.disallow_cursor_by_default
+            attribute :disallow_cursor_by_default, Attributor::Boolean, default: Praxis::Types::PaginationParams.disallow_cursor_by_default
+            attribute :sorting do
+              attribute :enforce_all_fields, Attributor::Boolean, default: Praxis::Types::OrderingParams.enforce_all_fields
+            end
+          end
+        end
+
+        def setup!
+          self.config.each do |name, val|
+            if name == :sorting
+              val.each do |ordername, orderval|
+                Praxis::Types::OrderingParams.send(ordername, orderval)
+              end
+            else
+              Praxis::Types::PaginationParams.send(name, val)
+            end
+          end      
+        end
+      end
+
+      module Controller
+        extend ActiveSupport::Concern
+
+        included do
+          include Praxis::Extensions::Pagination
+        end
+      end
+    end
+  end
+end

data/lib/praxis/resource_definition.rb

@@ -49,7 +49,7 @@ module Praxis
         unless base_attributes.empty?
           params do
             base_attributes.each do |base_name, base_attribute|
-              attribute base_name, base_attribute.type, base_attribute.options
+              attribute base_name, base_attribute.type, **base_attribute.options
             end
           end
         end
@@ -87,22 +87,14 @@ module Praxis
         @display_name = string
       end
 
-      def on_finalize
+      def on_finalize(&block)
         if block_given?
-          @on_finalize << Proc.new
+          @on_finalize << proc(&block)
         end
 
         @on_finalize
       end
 
-      # FIXME: this is inconsistent with the rest of the magic DSL convention.
-      def routing(&block)
-        warn "DEPRECATED: ResourceDefinition.routing is deprecated use prefix directly instead."
-
-        # eval this assuming it will only call #prefix
-        self.instance_eval(&block)
-      end
-
       def prefix(prefix=nil)
         return @prefix if prefix.nil?
         @routing_prefix = nil # reset routing_prefix
@@ -125,7 +117,7 @@ module Praxis
         @routing_prefix = nil # reset routing_prefix
 
         parent_action = parent.canonical_path
-        parent_route = parent_action.primary_route.path
+        parent_route = parent_action.route.path
 
         # if a mapping is passed, it *must* resolve any param name conflicts
         unless mapping.any?
@@ -146,7 +138,7 @@ module Praxis
           if mapping.key?(name)
             param = mapping[name]
             # FIXME: this won't handle URI Template type paths, ie '/{parent_id}'
-            prefixed_path = parent_action.primary_route.prefixed_path
+            prefixed_path = parent_action.route.prefixed_path
             @parent_prefix = prefixed_path.gsub(/(:)(#{name})(\W+|$)/, "\\1#{param.to_s}\\3")
           else
             mapping[name] = name
@@ -168,7 +160,7 @@ module Praxis
 
               parent_attribute = parent_action.params.attributes[parent_name]
 
-              attribute name, parent_attribute.type, parent_attribute.options
+              attribute name, parent_attribute.type, **parent_attribute.options
             end
           end
         end
@@ -221,14 +213,14 @@ module Praxis
       end
 
       def to_href( params )
-        canonical_path.primary_route.path.expand(params)
+        canonical_path.route.path.expand(params)
       end
 
       def parse_href(path)
         if path.kind_of?(::URI::Generic)
           path = path.path
         end
-        param_values = canonical_path.primary_route.path.params(path)
+        param_values = canonical_path.route.path.params(path)
         attrs = canonical_path.params.attributes
         param_values.each_with_object({}) do |(key,value),hash|
           hash[key.to_sym] = attrs[key.to_sym].load(value,[key])

data/lib/praxis/response_definition.rb

@@ -163,7 +163,7 @@ module Praxis
           end
         end
 
-        content[:payload] = payload
+        content[:payload] = {type: payload}
       end
 
       unless parts == nil

data/lib/praxis/route.rb

@@ -1,13 +1,12 @@
 module Praxis
 
   class Route
-    attr_accessor :verb, :path, :version, :name, :prefixed_path, :options
+    attr_accessor :verb, :path, :version, :prefixed_path, :options
 
-    def initialize(verb, path, version='n/a', name:nil, prefixed_path:nil, **options)
+    def initialize(verb, path, version='n/a', prefixed_path:nil, **options)
       @verb = verb
       @path = path
       @version = version
-      @name = name
       @options = options
       @prefixed_path = prefixed_path
     end
@@ -24,7 +23,7 @@ module Praxis
       path_params = example_hash.select{|k,v| path_param_keys.include? k }
       # Let's generate the example only using required params, to avoid mixing incompatible parameters
       query_params = example_hash.select{|k,v| required_query_param_keys.include? k }
-      example = { verb: self.verb, url: self.path.expand(path_params), query_params: query_params }
+      example = { verb: self.verb, url: self.path.expand(path_params.transform_values(&:to_s)), query_params: query_params }
 
     end
 
@@ -34,7 +33,6 @@ module Praxis
         path: path.to_s,
         version: version
       }
-      result[:name] = name unless name.nil?
       result[:options] = options if options.any?
       result
     end

data/lib/praxis/routing_config.rb

@@ -1,7 +1,7 @@
 module Praxis
   class RoutingConfig
 
-    attr_reader :routes
+    attr_reader :route
     attr_reader :version
     attr_reader :base
 
@@ -10,7 +10,7 @@ module Praxis
       @base = base
       @prefix_segments = Array(prefix)
 
-      @routes = []
+      @route = nil
 
       if block_given?
         instance_eval(&block)
@@ -53,12 +53,8 @@ module Praxis
       end
       prefixed_path = path.gsub('//','/')
       path = (base + path).gsub('//','/')
-      # Reject our own options
-      route_name = options.delete(:name);
       pattern = Mustermann.new(path, {ignore_unknown_options: true}.merge( options ))
-      route = Route.new(verb, pattern, version, name: route_name, prefixed_path: prefixed_path, **options)
-      @routes << route
-      route
+      @route = Route.new(verb, pattern, version, prefixed_path: prefixed_path, **options)
     end
 
   end

data/lib/praxis/tasks/api_docs.rb

@@ -62,5 +62,28 @@ namespace :praxis do
       generator.save!
     end
 
+    desc "Generate OpenAPI 3 docs for a Praxis App"
+    task :openapi => [:environment] do |t, args|
+      require 'fileutils'
+
+      Praxis::Blueprint.caching_enabled = false
+      generator = Praxis::Docs::OpenApiGenerator.new(Dir.pwd)
+      generator.save!
+    end
+
+    desc "Preview (and Generate) OpenAPI 3 docs for a Praxis App"
+    task :openapipreview => [:openapi] do |t, args|
+      require 'webrick' 
+      docs_port = 9090
+      root = Dir.pwd + '/docs/openapi/'
+      wb = Thread.new do
+        s = WEBrick::HTTPServer.new(:Port => docs_port, :DocumentRoot => root)
+        trap('INT') { s.shutdown }
+        s.start
+      end
+      `open http://localhost:#{docs_port}/`
+      wb.join
+    end
+
   end
 end

data/lib/praxis/tasks/routes.rb

@@ -7,7 +7,7 @@ namespace :praxis do
     table = Terminal::Table.new title: "Routes",
     headings:  [
       "Version", "Path", "Verb",
-      "Resource", "Action", "Implementation", "Name", "Primary", "Options"
+      "Resource", "Action", "Implementation", "Options"
     ]
 
     rows = []
@@ -31,20 +31,16 @@ namespace :praxis do
           warn "Warning: No routes defined for #{resource_definition.name}##{name}."
           rows << row
         else
-          action.routes.each do |route|
-            rows << row.merge({
-              version: route.version,
-              verb: route.verb,
-              path: route.path,
-              name: route.name,
-              primary: (action.primary_route == route ? 'yes' : ''),
-              options: route.options
-            })
+          route = action.route
+          rows << row.merge({
+            version: route.version,
+            verb: route.verb,
+            path: route.path,
+            options: route.options
+          })
         end
       end
     end
-  end
-
     case args[:format] || "table"
     when "json"
       puts JSON.pretty_generate(rows)
@@ -52,7 +48,7 @@ namespace :praxis do
       rows.each do |row|
         formatted_options = row[:options].map{|(k,v)| "#{k}:#{v.to_s}"}.join("\n")
         row_data = row.values_at(:version, :path, :verb, :resource,
-                                    :action, :implementation, :name, :primary)
+                                    :action, :implementation)
         row_data << formatted_options
         table.add_row(row_data)
       end
@@ -60,6 +56,5 @@ namespace :praxis do
     else
       raise "unknown output format: #{args[:format]}"
     end
-
   end
 end