praxis 2.0.pre.4 → 2.0.pre.9

data/spec/praxis/types/multipart_array_spec.rb

@@ -41,14 +41,6 @@ describe Praxis::Types::MultipartArray do
     entity = MIME::Application.new('file2')
     form_data.add entity,'files', 'file2'
 
-    entity = MIME::Application.new('
-      <?xml version="1.0" encoding="UTF-8"?>
-      <hash>
-        <first_name>James</first_name>
-      </hash>
-      ', 'xml')
-    form_data.add entity,'stuff1'
-
     entity = MIME::Application.new('{"first_name": "Frank"}', 'json')
     form_data.add entity,'stuff2'
 
@@ -81,9 +73,6 @@ describe Praxis::Types::MultipartArray do
     files = payload.part('files')
     expect(files).to have(2).items
 
-    stuff1 = payload.part('stuff1')
-    expect(stuff1.payload['first_name']).to eq 'James'
-
     stuff2 = payload.part('stuff2')
     expect(stuff2.payload['first_name']).to eq 'Frank'
 
@@ -274,7 +263,7 @@ describe Praxis::Types::MultipartArray do
 
       let(:example) { type.example }
 
-      let(:default_format) { 'xml' }
+      let(:default_format) { 'json' }
 
       let(:output) { example.dump(default_format: default_format) }
 
@@ -282,29 +271,23 @@ describe Praxis::Types::MultipartArray do
 
       it 'dumps the parts with the proper handler' do
         json_handler = Praxis::Application.instance.handlers['json']
-        xml_handler = Praxis::Application.instance.handlers['xml']
 
         # title is simple string, so should keep text/plain
         title = parts.find { |part| part.name == 'title' }
         expect(title.content_type.to_s).to eq 'text/plain'
         expect(title.payload).to eq example.part('title').payload
 
-        # things are structs with no content-type header defined
-        thing = parts.find { |part| part.name == 'thing' }
-        expect(thing.content_type.to_s).to eq 'application/xml'
-        expect(thing.payload).to eq xml_handler.generate(example.part('thing').payload.dump)
-
         # stuff has hardcoded 'application/json' content-type, and should remain such
         stuff = parts.find { |part| part.name == 'stuff' }
         expect(stuff.content_type.to_s).to eq 'application/json'
         expect(stuff.payload).to eq json_handler.generate(example.part('stuff').payload.dump)
 
         # instances just specify 'application/vnd.acme.instance', and should
-        # have xml suffix appended
+        # have json suffix appended
         instances = parts.select { |part| part.name == 'instances' }
         instances.each_with_index do |instance, i|
-          expect(instance.content_type.to_s).to eq 'application/vnd.acme.instance+xml'
-          expect(instance.payload).to eq xml_handler.generate(example.part('instances')[i].payload.dump)
+          expect(instance.content_type.to_s).to eq 'application/vnd.acme.instance+json'
+          expect(instance.payload).to eq json_handler.generate(example.part('instances')[i].payload.dump)
         end
       end
 

data/spec/spec_app/config/environment.rb

@@ -14,8 +14,6 @@ end
 
 Praxis::Application.configure do |application|
 
-  application.handler 'xml', Praxis::Handlers::XML
-
   application.middleware SetHeader, 'Spec-Middleware', 'used'
 
   application.bootloader.use SimpleAuthenticationPlugin, config_file: 'config/authentication.yml'

data/spec/spec_app/design/api.rb

@@ -24,9 +24,15 @@ Praxis::ApiDefinition.define do
     description "This example API should really be replaced by a set of more full-fledged example apps in the future"
 
     base_path "/api"
-    produces 'json','xml'
+    produces 'json'
     #version_with :path
     #base_path "/v:api_version"
+
+    # Custom attributes (for OpenApi, for example)
+    termsOfService "http://example.com/tos"
+    contact name: 'Joe', email: 'joe@email.com'
+    license name: "Apache 2.0",
+            url: "https://www.apache.org/licenses/LICENSE-2.0.html"
   end
 
   info '1.0' do # Applies to 1.0 version (and inherits everything else form the global one)

data/spec/spec_app/design/media_types/instance.rb

@@ -14,16 +14,11 @@ class Instance < Praxis::MediaType
 
     attribute :volumes, Volume::Collection
     
-    links do
-      link :root_volume
-      link :other_volume, Volume, using: :data_volume
-    end
   end
 
   view :default do
     attribute :id
     attribute :root_volume
-    attribute :links
   end
 
   view :link do
@@ -40,9 +35,6 @@ class Instance < Praxis::MediaType
     attribute :id
     attribute :name
     attribute :root_volume
-    attribute :links do
-      attribute :root_volume
-    end
   end
 
 

data/spec/spec_app/design/media_types/volume.rb

@@ -9,12 +9,6 @@ class Volume < Praxis::MediaType
 
     attribute :snapshots, Praxis::Collection.of(VolumeSnapshot)
     attribute :snapshots_summary, VolumeSnapshot::CollectionSummary
-
-    links do
-      link :source
-      link :snapshots, VolumeSnapshot::CollectionSummary, using: :snapshots_summary
-    end
-
   end
 
   view :default do
@@ -22,12 +16,6 @@ class Volume < Praxis::MediaType
     attribute :name
     attribute :source
     attribute :snapshots
-
-    attribute :links
-  end
-
-  view :link do
-    attribute :id
   end
 
   class Collection < Praxis::Collection

data/spec/spec_app/design/resources/instances.rb

@@ -44,7 +44,6 @@ module ApiResources
     action :show do
       routing do
         get '/:id'
-        get '/something/:id', name: :alternate
       end
 
       response :ok, media_type: 'application/json'
@@ -144,7 +143,7 @@ module ApiResources
         attribute :id
       end
 
-      payload do
+      payload required: false do
         attribute :when, DateTime
       end
 

data/spec/spec_helper.rb

@@ -7,6 +7,12 @@ $:.unshift File.expand_path('support',__dir__)
 
 require 'bundler'
 Bundler.setup :default, :test
+
+RSpec.configure do |config|
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+end
+
 require 'simplecov'
 SimpleCov.start 'praxis'
 

data/spec/support/spec_media_types.rb

@@ -6,22 +6,13 @@ class Person < Praxis::MediaType
     attribute :id, Integer
     attribute :name, String, example: /[:name:]/
     attribute :href, String, example: proc { |person| "/people/#{person.id}" }
-    attribute :links, Attributor::Collection.of(String),
-      description: 'Here to ensure an explicit links attribute works'
-
   end
 
   view :default do
     attribute :id
     attribute :name
-    attribute :links
   end
 
-  view :link do
-    attribute :id
-    attribute :name
-    attribute :href
-  end
 
   class CollectionSummary < Praxis::MediaType
     attributes do
@@ -29,11 +20,6 @@ class Person < Praxis::MediaType
       attribute :size, Integer
     end
 
-    view :link do
-      attribute :href
-      attribute :size
-    end
-
     view :default do
       attribute :href
     end
@@ -59,14 +45,6 @@ class Address < Praxis::MediaType
     attribute :residents_summary, Person::CollectionSummary
 
     attribute :fields, Praxis::Types::FieldSelector.for(Person)
-
-    links do
-      link :owner
-      link :super, Person, using: :manager
-      link :caretaker, using: :custodian
-      link :residents, using: :residents_summary
-    end
-
   end
 
   view :default do
@@ -74,15 +52,7 @@ class Address < Praxis::MediaType
     attribute :name
     attribute :owner
     attribute :fields
-
-    attribute :links
-  end
-
-  view :link do
-    attribute :id
-    attribute :name
   end
-
 end
 
 
@@ -123,10 +93,6 @@ class Blog < Praxis::MediaType
       example: proc { |blog,ctx| Post::CollectionSummary.example(ctx, href: "#{blog.href}/posts") },
       description: "Summary of information from related Post resources"
 
-    links do
-      link :posts, using: :posts_summary
-      link :owner
-    end
   end
 
   view :default do
@@ -138,7 +104,6 @@ class Blog < Praxis::MediaType
     attribute :timestamps
 
     attribute :owner
-    attribute :links
   end
 
   view :overview do
@@ -146,11 +111,6 @@ class Blog < Praxis::MediaType
     attribute :name
     attribute :description
   end
-
-  view :link do
-    attribute :href
-  end
-
 end
 
 
@@ -185,11 +145,6 @@ class Post < Praxis::MediaType
       attribute :created_at, DateTime
       attribute :updated_at, DateTime
     end
-
-    links do
-      link :author
-      link :blog
-    end
   end
 
   view :default do
@@ -202,23 +157,13 @@ class Post < Praxis::MediaType
     attribute :author
 
     attribute :timestamps
-    attribute :links
-  end
-
-  view :link do
-    attribute :href
   end
 
-
   class CollectionSummary < Praxis::MediaType
     attributes do
       attribute :href, String
       attribute :count, Integer
     end
-
-    view :link do
-      attribute :href
-    end
   end
 end
 
@@ -251,12 +196,6 @@ class User < Praxis::MediaType
 
     attribute :posts_summary, Post::CollectionSummary,
       example: proc { |user,ctx| Post::CollectionSummary.example(ctx, href: "#{user.href}/posts") }
-
-    links do
-      link :posts, using: :posts_summary
-      link :primary_blog
-    end
-
   end
 
   view :default do
@@ -265,8 +204,6 @@ class User < Praxis::MediaType
 
     attribute :first
     attribute :last
-
-    attribute :links
   end
 
   view :extended do
@@ -276,20 +213,10 @@ class User < Praxis::MediaType
     attribute :first
     attribute :last
     attribute :primary_blog, view: :overview
-
-    attribute :links
   end
 
   view :with_post_links do
     attribute :id
     attribute :posts, view: :link
   end
-
-  view :link do
-    attribute :href
-  end
-
-  view :summary do
-    attribute :links
-  end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: praxis
 version: !ruby/object:Gem::Version
-  version: 2.0.pre.4
+  version: 2.0.pre.9
 platform: ruby
 authors:
 - Josep M. Blanquer
 - Dane Jensen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-05 00:00:00.000000000 Z
+date: 2020-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -79,28 +79,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: attributor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '5.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '5.5'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -147,30 +147,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: rake-notes
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -353,20 +339,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.20
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.20
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -409,7 +381,7 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '4'
-description: 
+description:
 email:
 - blanquer@gmail.com
 - dane.jensen@gmail.com
@@ -420,6 +392,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".simplecov"
 - ".travis.yml"
 - CHANGELOG.md
@@ -431,6 +404,7 @@ files:
 - MAINTAINERS.md
 - README.md
 - Rakefile
+- TODO.md
 - bin/praxis
 - lib/api_browser/.bowerrc
 - lib/api_browser/.editorconfig
@@ -516,6 +490,7 @@ files:
 - lib/api_browser/app/views/types/standalone/default.html
 - lib/api_browser/app/views/types/standalone/struct.html
 - lib/api_browser/bower_template.json
+- lib/api_browser/package-lock.json
 - lib/api_browser/package.json
 - lib/praxis.rb
 - lib/praxis/action_definition.rb
@@ -540,6 +515,18 @@ files:
 - lib/praxis/dispatcher.rb
 - lib/praxis/docs/generator.rb
 - lib/praxis/docs/link_builder.rb
+- lib/praxis/docs/open_api_generator.rb
+- lib/praxis/docs/openapi/info_object.rb
+- lib/praxis/docs/openapi/media_type_object.rb
+- lib/praxis/docs/openapi/operation_object.rb
+- lib/praxis/docs/openapi/parameter_object.rb
+- lib/praxis/docs/openapi/paths_object.rb
+- lib/praxis/docs/openapi/request_body_object.rb
+- lib/praxis/docs/openapi/response_object.rb
+- lib/praxis/docs/openapi/responses_object.rb
+- lib/praxis/docs/openapi/schema_object.rb
+- lib/praxis/docs/openapi/server_object.rb
+- lib/praxis/docs/openapi/tag_object.rb
 - lib/praxis/error_handler.rb
 - lib/praxis/exception.rb
 - lib/praxis/exceptions/config.rb
@@ -550,7 +537,13 @@ files:
 - lib/praxis/exceptions/invalid_trait.rb
 - lib/praxis/exceptions/stage_not_found.rb
 - lib/praxis/exceptions/validation.rb
+- lib/praxis/extensions/attribute_filtering.rb
 - lib/praxis/extensions/attribute_filtering/active_record_filter_query_builder.rb
+- lib/praxis/extensions/attribute_filtering/active_record_patches.rb
+- lib/praxis/extensions/attribute_filtering/active_record_patches/5x.rb
+- lib/praxis/extensions/attribute_filtering/active_record_patches/6_0.rb
+- 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/sequel_filter_query_builder.rb
 - lib/praxis/extensions/field_expansion.rb
@@ -558,6 +551,13 @@ files:
 - lib/praxis/extensions/field_selection/active_record_query_selector.rb
 - lib/praxis/extensions/field_selection/field_selector.rb
 - lib/praxis/extensions/field_selection/sequel_query_selector.rb
+- lib/praxis/extensions/pagination.rb
+- lib/praxis/extensions/pagination/active_record_pagination_handler.rb
+- lib/praxis/extensions/pagination/header_generator.rb
+- lib/praxis/extensions/pagination/ordering_params.rb
+- lib/praxis/extensions/pagination/pagination_handler.rb
+- lib/praxis/extensions/pagination/pagination_params.rb
+- lib/praxis/extensions/pagination/sequel_pagination_handler.rb
 - lib/praxis/extensions/rails_compat.rb
 - lib/praxis/extensions/rails_compat/request_methods.rb
 - lib/praxis/extensions/rendering.rb
@@ -565,7 +565,7 @@ files:
 - lib/praxis/handlers/json.rb
 - lib/praxis/handlers/plain.rb
 - lib/praxis/handlers/www_form.rb
-- lib/praxis/handlers/xml.rb
+- lib/praxis/handlers/xml-sample.rb
 - lib/praxis/links.rb
 - lib/praxis/mapper/active_model_compat.rb
 - lib/praxis/mapper/resource.rb
@@ -580,6 +580,7 @@ files:
 - lib/praxis/plugin.rb
 - lib/praxis/plugin_concern.rb
 - lib/praxis/plugins/mapper_plugin.rb
+- lib/praxis/plugins/pagination_plugin.rb
 - lib/praxis/plugins/rails_plugin.rb
 - lib/praxis/request.rb
 - lib/praxis/request_stages/action.rb
@@ -637,17 +638,19 @@ files:
 - spec/praxis/config_spec.rb
 - spec/praxis/controller_spec.rb
 - spec/praxis/dispatcher_spec.rb
+- 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/field_expansion_spec.rb
 - spec/praxis/extensions/field_selection/active_record_query_selector_spec.rb
 - spec/praxis/extensions/field_selection/field_selector_spec.rb
 - spec/praxis/extensions/field_selection/sequel_query_selector_spec.rb
-- spec/praxis/extensions/field_selection/support/spec_resources_active_model.rb
-- spec/praxis/extensions/field_selection/support/spec_resources_sequel.rb
+- spec/praxis/extensions/pagination/active_record_pagination_handler_spec.rb
 - spec/praxis/extensions/rendering_spec.rb
+- spec/praxis/extensions/support/spec_resources_active_model.rb
+- spec/praxis/extensions/support/spec_resources_sequel.rb
 - spec/praxis/file_group_spec.rb
 - spec/praxis/handlers/json_spec.rb
-- spec/praxis/handlers/xml_spec.rb
-- spec/praxis/links_spec.rb
 - spec/praxis/mapper/resource_spec.rb
 - spec/praxis/mapper/selector_generator_spec.rb
 - spec/praxis/media_type_identifier_spec.rb
@@ -740,7 +743,7 @@ homepage: https://github.com/praxis/praxis
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -755,9 +758,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Building APIs the way you want it.
 test_files: []