praxis 2.0.pre.10 → 2.0.pre.15

data/tasks/thor/templates/generator/example_app/spec/helpers/database_helper.rb

@@ -5,8 +5,9 @@ class DatabaseHelper
   # This does the job for an example seeder
   def self.seed!
     user_data = [
-      {id: 11, first_name: 'Peter', last_name: 'Praxis', uuid: 'deadbeef'},
-      {id: 12, first_name: 'Alice', last_name: 'Trellis', uuid: 'beefdead'}
+      {id: 11, first_name: 'Peter', last_name: 'Praxis', uuid: 'deadbeef', email: 'peter@pan.com'},
+      {id: 12, first_name: 'Alice', last_name: 'Trellis', uuid: 'beefdead', email: 'alice@wonderland.com'},
+      {id: 13, first_name: 'Wellington', last_name: 'Lofty', uuid: 'beefbeef', email: 'well@lofty.com'},
     ]
     (100..199).each do |i|
       user_data.push id: i, first_name: "User-#{i}", last_name: "Last-#{i}", uuid: SecureRandom.hex(16).to_s
@@ -14,5 +15,6 @@ class DatabaseHelper
     user_data.each_with_index do |data, i|
       ::User.create(**data)
     end
+    puts "Database seeded."
   end
 end

data/tasks/thor/templates/generator/example_app/spec/spec_helper.rb

@@ -11,10 +11,10 @@ rescue => e
 end
 
 # Migrate and seed the DB (only an empty in-memory DB)
-require_relative 'helpers/database_helper'
+
 ActiveRecord::Migration.verbose = false # ?? does not seem to work like this
 ActiveRecord::Tasks::DatabaseTasks.migrate
-DatabaseHelper.seed!
+require_relative '../db/seeds.rb'
 
 RSpec.configure do |config|
   config.include Rack::Test::Methods

data/tasks/thor/templates/generator/example_app/spec/v1/controllers/users_spec.rb

@@ -13,7 +13,7 @@ describe V1::Controllers::Users do
 
   context 'index' do
     let(:filters_q) { '' }
-    let(:fields_q) { 'uid,uuid' }
+    let(:fields_q) { 'id' }
     let(:query_string) do
       "filters=#{CGI.escape(filters_q)}&fields=#{CGI.escape(fields_q)}"
     end
@@ -30,7 +30,7 @@ describe V1::Controllers::Users do
       it 'returns only peter' do
         expect(parsed_body.size).to eq(1)
         # Peter has id 11 from our seeds
-        expect(parsed_body.map{|u| u[:uid]}).to eq(['11'])
+        expect(parsed_body.map{|u| u[:id]}).to eq([11])
       end
     end
   end

data/tasks/thor/templates/generator/scaffold/design/endpoints/collection.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module <%= version_module %>
+  module Endpoints
+    class <%= plural_class %>
+      include Praxis::EndpointDefinition
+
+      media_type MediaTypes::<%= singular_class %>
+      version '<%= version %>'
+
+      description 'Praxis-generated endpoint for managing <%= plural_class %>'
+
+      <%- if action_enabled?(:index) -%>
+      action :index do
+        description 'List <%= plural_class %>'
+        routing { get '' }
+        params do
+          attribute :fields, Praxis::Types::FieldSelector.for(MediaTypes::<%= singular_class %>),
+                    description: 'Fields with which to render the result.'
+<%- if !pagination_enabled? -%>
+=begin
+          # You can use pagination/ordering by enabling the PaginationPlugin, and uncommenting these lines
+<%- end -%>
+          attribute :pagination, Praxis::Types::PaginationParams.for(MediaTypes::<%= singular_class %>)
+          attribute :order, Praxis::Extensions::Pagination::OrderingParams.for(MediaTypes::<%= singular_class %>)
+<%- if !pagination_enabled? -%>
+=end
+<%- end -%>
+          # # Filter by attributes. Add an allowed filter per line, with the allowed operators to use
+          # # Also, remember to add a mapping for each in `filters_mapping` method of Resources::<%= singular_class %> class
+          # attribute :filters, Praxis::Types::FilteringParams.for(MediaTypes::<%= singular_class %>) do
+          #    filter 'first_name', using: ['=', '!='], fuzzy: true
+          # end
+        end
+        response :ok, media_type: Praxis::Collection.of(MediaTypes::<%= singular_class %>)
+      end
+      <%- end -%>
+
+      <%- if action_enabled?(:index) -%>
+      action :show do
+        description 'Retrieve details for a specific <%= singular_class %>'
+        routing { get '/:id' }
+        params do
+          attribute :id, required: true
+          attribute :fields, Praxis::Types::FieldSelector.for(MediaTypes::<%= singular_class %>),
+                    description: 'Fields with which to render the result.'
+        end
+        response :ok
+        response :not_found
+      end
+      <%- end -%>
+
+      <%- if action_enabled?(:create) -%>
+      action :create do
+        description 'Create a new <%= singular_class %>'
+        routing { post '' }
+        payload reference: MediaTypes::<%= singular_class %> do
+          # List the attributes you accept from the one existing in the <%= singular_class %> Mediatype
+          # and/or fully define any other ones you allow at creation time
+          # attribute :name
+        end
+        response :created
+        response :bad_request
+      end
+      <%- end -%>
+
+      <%- if action_enabled?(:update) -%>
+      action :update do
+        description 'Update one or more attributes of an existing <%= singular_class %>'
+        routing { patch '/:id' }
+        params do
+          attribute :id, required: true
+        end
+        payload reference: MediaTypes::<%= singular_class %> do
+          # List the attributes you accept from the one existing in the <%= singular_class %> Mediatype
+          # and/or fully define any other ones you allow to change
+          # attribute :name
+        end
+        response :no_content
+        response :bad_request
+      end
+      <%- end -%>
+
+      <%- if action_enabled?(:update) -%>
+      action :delete do
+        description 'Deletes a <%= singular_class %>'
+        routing { delete '/:id' }
+        params do
+          attribute :id, required: true
+        end
+        response :no_content
+        response :not_found
+      end
+      <%- end -%>
+    end
+  end
+end
+

data/tasks/thor/templates/generator/scaffold/design/media_types/item.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module <%= version_module %>
+  module MediaTypes
+    class <%= singular_class %> < Praxis::MediaType
+      identifier 'application/json'
+
+      domain_model '<%= version_module %>::Resources::<%= singular_class %>'
+      description 'Structural definition of a <%= singular_class %>'
+
+      attributes do
+        attribute :id, Integer, description: '<%= singular_class %> identifier'
+        # <INSERT MORE ATTRIBUTES HERE>
+      end
+    end
+  end
+end
+

data/tasks/thor/templates/generator/scaffold/implementation/controllers/collection.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module <%= version_module %>
+  module Controllers
+    class <%= plural_class %>
+      include Praxis::Controller
+
+      implements Endpoints::<%= plural_class %>
+
+      <%- if action_enabled?(:index) -%>
+      # Retrieve all <%= plural_class %> with the right necessary associations
+      # and render them appropriately with the requested field selection
+      def index
+        objects = build_query(model_class).all
+        display(objects)
+      end
+      <%- end -%>
+
+      <%- if action_enabled?(:show) -%>
+      # Retrieve a single <%= singular_class %> with the right necessary associations
+      # and render them appropriately with the requested field selection
+      def show(id:, **_args)
+        model = build_query(model_class.where(id: id)).first
+        return Praxis::Responses::NotFound.new if model.nil?
+
+        display(model)
+      end
+      <%- end -%>
+
+      <%- if action_enabled?(:create) -%>
+      # Creates a new <%= singular_class %>
+      def create
+        # A good pattern is to call the same name method on the corresponding resource, 
+        # passing the incoming payload, or massaging it first
+        created_resource = Resources::<%= singular_class%>.create(request.payload)
+
+        # Respond with a created if it successfully finished
+        Praxis::Responses::Created.new(location: created_resource.href)
+      end
+      <%- end -%>
+
+      <%- if action_enabled?(:update) -%>
+      # Updates some of the information of a <%= singular_class %>
+      def update(id:)
+        # A good pattern is to call the same name method on the corresponding resource, 
+        # passing the incoming id and payload (or massaging it first)
+        updated_resource = Resources::<%= singular_class %>.update(
+          id: id,
+          payload: request.payload,
+        )
+        return Praxis::Responses::NotFound.new unless updated_resource
+
+        Praxis::Responses::NoContent.new
+      end
+      <%- end -%>
+
+      <%- if action_enabled?(:delete) -%>
+      # Deletes an existing <%= singular_class %>
+      def delete(id:)
+        # A good pattern is to call the same name method on the corresponding resource,
+        # maybe passing the already loaded model
+        deleted_resource = Resources::<%= singular_class %>.delete(
+          id: id
+        )
+        return Praxis::Responses::NotFound.new unless deleted_resource
+
+        Praxis::Responses::NoContent.new
+      end
+      <%- end -%>
+
+      # Use the model class as the base query but you might want to change that
+      def model_class
+        ::<%= singular_class %> #Change it to the appropriate DB model class
+      end
+    end
+  end
+end

data/tasks/thor/templates/generator/scaffold/implementation/resources/base.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module <%= version_module %>
+  module Resources
+    class Base < Praxis::Mapper::Resource
+      # Base for all <%= version_module %> resources.
+      # Resources withing a single version should have resource mappings separate from other versions
+      # and the Mapper::Resource will appropriately maintain different model_maps for each Base classes
+    end
+  end
+end

data/tasks/thor/templates/generator/scaffold/implementation/resources/item.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module <%= version_module %>
+  module Resources
+    class <%= singular_class %> < Base
+      model ::<%= singular_class %> # Change it if it maps to a different DB model class
+
+      # Define the name mapping from API filter params, to model attribute/associations
+      # when they aren't 1:1
+      # filters_mapping(
+      #   'name': 'name',
+      #   'label': 'association.label_name'
+      # )
+
+      # Add dependencies for resource attributes to other attributes and/or model associations
+      # property :href, dependencies: %i[id]
+
+      <%- if action_enabled?(:create) -%>
+      def self.create(payload)
+        # Assuming the API field names directly map the the model attributes. Massage if appropriate.
+        self.new(model.create(**payload.to_h))
+      end
+      <%- end -%>
+
+      <%- if action_enabled?(:update) -%>
+      def self.update(id:, payload:)
+        record = model.find_by(id: id)
+        return nil unless record
+        # Assuming the API field names directly map the the model attributes. Massage if appropriate.
+        record.update(**payload.to_h)
+        self.new(record)
+      end
+      <%- end -%>
+
+      <%- if action_enabled?(:delete) -%>
+      def self.delete(id:)
+        record = model.find_by(id: id)
+        return nil unless record
+        record.destroy
+        self.new(record)
+      end
+      <%- end -%>  
+    end
+  end
+end

data/tasks/thor/templates/generator/scaffold/models/active_record.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class <%= model_class %> < ActiveRecord::Base
+  include Praxis::Mapper::ActiveModelCompat
+  
+end

data/tasks/thor/templates/generator/scaffold/models/sequel.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class <%= model_class %> < Sequel::Model
+  include Praxis::Mapper::SequelCompat
+  
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: praxis
 version: !ruby/object:Gem::Version
-  version: 2.0.pre.10
+  version: 2.0.pre.15
 platform: ruby
 authors:
 - Josep M. Blanquer
 - Dane Jensen
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-10 00:00:00.000000000 Z
+date: 2021-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -367,7 +367,7 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '4'
-description:
+description: 
 email:
 - blanquer@gmail.com
 - dane.jensen@gmail.com
@@ -446,6 +446,7 @@ files:
 - lib/praxis/extensions/attribute_filtering/active_record_patches/6_1_plus.rb
 - lib/praxis/extensions/attribute_filtering/filter_tree_node.rb
 - lib/praxis/extensions/attribute_filtering/filtering_params.rb
+- lib/praxis/extensions/attribute_filtering/filters_parser.rb
 - lib/praxis/extensions/attribute_filtering/sequel_filter_query_builder.rb
 - lib/praxis/extensions/field_expansion.rb
 - lib/praxis/extensions/field_selection.rb
@@ -540,6 +541,7 @@ files:
 - spec/praxis/extensions/attribute_filtering/active_record_filter_query_builder_spec.rb
 - spec/praxis/extensions/attribute_filtering/filter_tree_node_spec.rb
 - spec/praxis/extensions/attribute_filtering/filtering_params_spec.rb
+- spec/praxis/extensions/attribute_filtering/filters_parser_spec.rb
 - spec/praxis/extensions/field_expansion_spec.rb
 - spec/praxis/extensions/field_selection/active_record_query_selector_spec.rb
 - spec/praxis/extensions/field_selection/field_selector_spec.rb
@@ -614,6 +616,8 @@ files:
 - tasks/loader.thor
 - tasks/thor/app.rb
 - tasks/thor/example.rb
+- tasks/thor/model.rb
+- tasks/thor/scaffold.rb
 - tasks/thor/templates/generator/empty_app/.gitignore
 - tasks/thor/templates/generator/empty_app/Gemfile
 - tasks/thor/templates/generator/empty_app/README.md
@@ -642,22 +646,33 @@ files:
 - tasks/thor/templates/generator/example_app/Gemfile
 - tasks/thor/templates/generator/example_app/Rakefile
 - tasks/thor/templates/generator/example_app/app/models/user.rb
+- tasks/thor/templates/generator/example_app/app/v1/concerns/controller_base.rb
+- tasks/thor/templates/generator/example_app/app/v1/concerns/href.rb
 - tasks/thor/templates/generator/example_app/app/v1/controllers/users.rb
+- tasks/thor/templates/generator/example_app/app/v1/resources/base.rb
 - tasks/thor/templates/generator/example_app/app/v1/resources/user.rb
 - tasks/thor/templates/generator/example_app/config.ru
 - tasks/thor/templates/generator/example_app/config/environment.rb
 - tasks/thor/templates/generator/example_app/db/migrate/20201010101010_create_users_table.rb
+- tasks/thor/templates/generator/example_app/db/seeds.rb
 - tasks/thor/templates/generator/example_app/design/api.rb
 - tasks/thor/templates/generator/example_app/design/v1/endpoints/users.rb
 - tasks/thor/templates/generator/example_app/design/v1/media_types/user.rb
 - tasks/thor/templates/generator/example_app/spec/helpers/database_helper.rb
 - tasks/thor/templates/generator/example_app/spec/spec_helper.rb
 - tasks/thor/templates/generator/example_app/spec/v1/controllers/users_spec.rb
+- tasks/thor/templates/generator/scaffold/design/endpoints/collection.rb
+- tasks/thor/templates/generator/scaffold/design/media_types/item.rb
+- tasks/thor/templates/generator/scaffold/implementation/controllers/collection.rb
+- tasks/thor/templates/generator/scaffold/implementation/resources/base.rb
+- tasks/thor/templates/generator/scaffold/implementation/resources/item.rb
+- tasks/thor/templates/generator/scaffold/models/active_record.rb
+- tasks/thor/templates/generator/scaffold/models/sequel.rb
 homepage: https://github.com/praxis/praxis
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -673,7 +688,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubygems_version: 3.1.2
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Building APIs the way you want it.
 test_files: []