praxis 2.0.pre.9 → 2.0.pre.10

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

@@ -16,26 +16,8 @@ class Instance < Praxis::MediaType
     
   end
 
-  view :default do
+  default_fieldset do
     attribute :id
     attribute :root_volume
   end
-
-  view :link do
-    attribute :id
-    attribute :href
-  end
-
-  view :create do
-    attribute :id
-    attribute :name
-  end
-
-  view :extended, include_nil: true do
-    attribute :id
-    attribute :name
-    attribute :root_volume
-  end
-
-
 end

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

@@ -11,7 +11,7 @@ class Volume < Praxis::MediaType
     attribute :snapshots_summary, VolumeSnapshot::CollectionSummary
   end
 
-  view :default do
+  default_fieldset do
     attribute :id
     attribute :name
     attribute :source

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

@@ -6,16 +6,11 @@ class VolumeSnapshot < Praxis::MediaType
     attribute :name, String, regexp: /snapshot-(\w+)/
   end
 
-  view :default do
+  default_fieldset do
     attribute :id
     attribute :name
   end
 
-  view :link do
-    attribute :id
-  end
-
-
   class CollectionSummary < Praxis::MediaType
     identifier 'application/json'
 
@@ -25,18 +20,11 @@ class VolumeSnapshot < Praxis::MediaType
       attribute :href, String
     end
 
-    view :default do
-      attribute :name
-      attribute :size
-      attribute :href
-    end
-
-    view :link do
+    default_fieldset do
       attribute :name
       attribute :size
       attribute :href
     end
-
   end
 
 end

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

@@ -1,6 +1,6 @@
 module ApiResources
   class Instances
-    include Praxis::ResourceDefinition
+    include Praxis::EndpointDefinition
 
     media_type Instance
     version '1.0'
@@ -119,13 +119,10 @@ module ApiResources
         attribute :id
       end
 
-      # TODO: move to something else when Multipart is fully deprecated
-      silence_warnings do
-        payload Praxis::Multipart, allow_extra: true do
-          key 'destination_path', String, required: true
-          key 'file', Attributor::FileUpload, required: false
-          extra 'options'
-        end
+      payload Praxis::Types::MultipartArray do
+        part 'destination_path', String, required: true
+        file 'file', Attributor::Tempfile, required: false
+        part(/.*/, String) # Allows extra parts
       end
 
       response :ok, media_type: 'application/json'

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

@@ -2,7 +2,7 @@ require_relative 'volumes'
 
 module ApiResources
   class VolumeSnapshots
-    include Praxis::ResourceDefinition
+    include Praxis::EndpointDefinition
 
     media_type VolumeSnapshot
 

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

@@ -1,6 +1,6 @@
 module ApiResources
   class Volumes
-    include Praxis::ResourceDefinition
+    include Praxis::EndpointDefinition
 
     media_type Volume
     version '1.0'

data/spec/support/spec_authorization_plugin.rb

@@ -68,7 +68,7 @@ module AuthorizationPlugin
     end
   end
 
-  module ResourceDefinition
+  module EndpointDefinition
 
   end
 

data/spec/support/spec_blueprints.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+class PersonBlueprint < Praxis::Blueprint
+  attributes do
+    attribute :name, String, example: /[:first_name:]/
+    attribute :email, String, example: proc { |person| "#{person.name}@example.com" }
+
+    attribute :age, Integer
+
+    attribute :full_name, FullName
+    attribute :aliases, Attributor::Collection.of(FullName)
+
+    attribute :address, AddressBlueprint, example: proc { |person, context| AddressBlueprint.example(context, resident: person) }
+    attribute :work_address, AddressBlueprint
+
+    attribute :prior_addresses, Attributor::Collection.of(AddressBlueprint)
+    attribute :parents do
+      attribute :father, String
+      attribute :mother, String
+    end
+
+    attribute :tags, Attributor::Collection.of(String)
+    attribute :href, String
+    attribute :alive, Attributor::Boolean, default: true
+    attribute :myself, PersonBlueprint
+    attribute :friends, Attributor::Collection.of(PersonBlueprint)
+    attribute :metadata, Attributor::Hash
+  end
+
+  default_fieldset do
+    attribute :name
+    attribute :full_name
+    attribute :address do
+      attribute :name
+      attribute :street
+    end
+    attribute :prior_addresses do
+      attribute :name
+    end
+  end
+end
+
+class AddressBlueprint < Praxis::Blueprint
+  attributes do
+    attribute :id, Integer
+    attribute :name, String
+    attribute :street, String
+    attribute :state, String, values: %w(OR CA)
+
+    attribute :resident, PersonBlueprint, example: proc { |address, context| PersonBlueprint.example(context, address: address) }
+  end
+end
+
+class FullName < Attributor::Model
+  attributes do
+    attribute :first, String, example: /[:first_name:]/
+    attribute :last, String, example: /[:last_name:]/
+  end
+end
+
+class SimpleHash < Attributor::Model
+  attributes do
+    attribute :id, Integer
+    attribute :hash, Hash
+  end
+end
+
+class SimpleHashCollection < Attributor::Model
+  attributes do
+    attribute :id, Integer
+    attribute :hash_collection, Attributor::Collection.of(Hash)
+  end
+end

data/spec/support/{spec_resource_definitions.rb → spec_endpoint_definitions.rb}

@@ -7,7 +7,7 @@ Praxis::ApiDefinition.define do
 end
 
 class PeopleResource
-  include Praxis::ResourceDefinition
+  include Praxis::EndpointDefinition
 
   description 'People resource'
 
@@ -42,7 +42,7 @@ end
 
 
 class AddressResource
-  include Praxis::ResourceDefinition
+  include Praxis::EndpointDefinition
 
   description 'Address resource'
 

data/spec/support/spec_media_types.rb

@@ -8,7 +8,7 @@ class Person < Praxis::MediaType
     attribute :href, String, example: proc { |person| "/people/#{person.id}" }
   end
 
-  view :default do
+  default_fieldset do
     attribute :id
     attribute :name
   end
@@ -20,7 +20,7 @@ class Person < Praxis::MediaType
       attribute :size, Integer
     end
 
-    view :default do
+    default_fieldset do
       attribute :href
     end
 
@@ -47,7 +47,7 @@ class Address < Praxis::MediaType
     attribute :fields, Praxis::Types::FieldSelector.for(Person)
   end
 
-  view :default do
+  default_fieldset do
     attribute :id
     attribute :name
     attribute :owner
@@ -95,7 +95,7 @@ class Blog < Praxis::MediaType
 
   end
 
-  view :default do
+  default_fieldset do
     attribute :id
     attribute :href
     attribute :name
@@ -105,12 +105,6 @@ class Blog < Praxis::MediaType
 
     attribute :owner
   end
-
-  view :overview do
-    attribute :id
-    attribute :name
-    attribute :description
-  end
 end
 
 
@@ -147,7 +141,7 @@ class Post < Praxis::MediaType
     end
   end
 
-  view :default do
+  default_fieldset do
     attribute :id
     attribute :href
 
@@ -198,25 +192,11 @@ class User < Praxis::MediaType
       example: proc { |user,ctx| Post::CollectionSummary.example(ctx, href: "#{user.href}/posts") }
   end
 
-  view :default do
+  default_fieldset do
     attribute :id
     attribute :href
 
     attribute :first
     attribute :last
   end
-
-  view :extended do
-    attribute :id
-    attribute :href
-
-    attribute :first
-    attribute :last
-    attribute :primary_blog, view: :overview
-  end
-
-  view :with_post_links do
-    attribute :id
-    attribute :posts, view: :link
-  end
 end

data/tasks/thor/app.rb

@@ -13,41 +13,15 @@ module PraxisGen
     # Generator for a blank new app (with a full skeleton ready to get you going)
     def new
       puts "Creating new blank Praxis app under #{app_name}"
-      create_root_files
-      create_config
-      create_app
-      create_design
-      create_spec
-      create_docs
-    end
-
-    private
-    def create_root_files
-      ['config.ru','Gemfile','Guardfile','Rakefile','README.md'].each do |file|
-        copy_file file, "#{app_name}/#{file}"
+      # Copy example files
+      ['config.ru','Gemfile','Rakefile','README.md'].each do |file|
+        copy_file file, verbose: true
+      end
+      # Copy example directories
+      root_dirs = ['config','app','design','spec','docs']
+      root_dirs.each do |dir|
+        directory dir, recursive: true
       end
     end
-
-    def create_config
-      copy_file "config/environment.rb", "#{app_name}/config/environment.rb"
-      copy_file "config/rainbows.rb", "#{app_name}/config/rainbows.rb"
-    end
-
-    def create_app
-      directory "app", "#{app_name}/app", :recursive => true
-    end
-
-    def create_design
-      directory "design", "#{app_name}/design", :recursive => true
-    end
-
-    def create_spec
-      directory "spec", "#{app_name}/spec", :recursive => true
-    end
-
-    def create_docs
-      directory "docs", "#{app_name}/docs", :recursive => true
-    end
-
   end
 end

data/tasks/thor/example.rb

@@ -1,291 +1,51 @@
 
 module PraxisGen
-      class Example < Thor
-        include Thor::Actions
-
-        namespace "praxis:example"
-
-        argument :app_name, required: true
-        desc "new", "Generates a new 'hello world' example application under an <app_name> directory"
-
-        def new
-          puts "GENERATION COMMENCED!! (for #{app_name})"
-          # Fix weird symbols in the app name (if they are)
-          @app_name = app_name.downcase.gsub(/[^a-z0-9_\/.]/, '')
-          # Generate a new app
-          empty_directory path('app')
-          empty_directory path('design')
-          empty_directory path('lib')
-          empty_directory path('spec')
-          generate_config_environment_rb
-          generate_gemfile
-          generate_rakefile
-          generate_config_ru
-          generate_app_definitions_hello_world
-          generate_app_controllers_hello_world
-          #
-          puts
-          puts "To run the example application:"
-          puts
-          puts "  # terminal 1:"
-          puts "  cd #{app_name}"
-          puts "  bundle"
-          puts "  bundle exec rackup"
-          puts
-          puts "  # terminal 2:"
-          puts "  # Index: list the hello words (especifying api version through the query string) "
-          puts "  curl -i 'http://localhost:8888/api/hello?api_version=1.0' -H 'Authorization: Bearer XYZ' "
-          puts ""
-          puts "  # Show: list one of the hello words (especifying api version through a header) "
-          puts "  curl -i 'http://localhost:8888/api/hello/1' -H 'X-Api-Version: 1.0' -H 'Authorization: Bearer XYZ'"
-          puts ""
-          puts "  # NotFound: Hello word will not be found under API 2.0"
-          puts "  curl -i 'http://localhost:8888/api/hello/1' -H 'X-Api-Version: 2.0' -H 'Authorization: Bearer XYZ'"
-          puts "  #Note: The Authorization header is made required in the application to emulate OAuth2 (but not used)"
-          nil
-        end
-private
-    # Returns relative path for the new application
-    #
-    # @return [String]
-    #
-    # @example
-    #  # > /praxis generate My-test_praxisApp
-    #  app_dir_pathname #=> 'mytest_praxisapp'
-    #
-    #
-    def app_dir_pathname
-      @app_dir_pathname ||= Pathname.new(app_name)
-    end
-
-
-    # Returns path string built from the set of the given strings
-    #
-    # @param [String,Array] strings
-    #
-    # @return [String]
-    #
-    # @example
-    #   path('a', 'b', 'c') #=> 'my_test_app/a/b/c'
-    #
-    def path(*strings)
-      app_dir_pathname.join(*strings).to_s
-    end
-
-
-    # Creates './config/environment.rb' file
-    #
-    # @return [void]
-    #
-    def generate_config_environment_rb
-      create_file path('config/environment.rb') do
-  <<-RUBY
-# Main entry point - DO NOT MODIFY THIS FILE
-ENV['RACK_ENV'] ||= 'development'
-
-Bundler.require(:default, ENV['RACK_ENV'])
-
-# Default application layout.
-# NOTE: This layout need NOT be specified explicitly.
-# It is provided just for illustration.
-Praxis::Application.instance.layout do
-  map :initializers, 'config/initializers/**/*'
-  map :lib, 'lib/**/*'
-  map :design, 'design/' do
-    map :api, 'api.rb'
-    map :media_types, '**/media_types/**/*'
-    map :resources, '**/resources/**/*'
-  end
-  map :app, 'app/' do
-    map :models, 'models/**/*'
-    map :controllers, '**/controllers/**/*'
-    map :responses, '**/responses/**/*'
-  end
-end
-RUBY
-      end
-      nil
-    end
-
-
-    # Creates './Gemfile' file
-    #
-    # @return [void]
-    #
-    def generate_gemfile
-      create_file path('Gemfile') do
-  <<-RUBY
-source 'https://rubygems.org'
-
-gem 'praxis'
-gem 'rack', '~> 1.0'
-gem 'rake'
-
-group :development, :test do
-  gem 'rspec'
-end
-RUBY
-      end
-      nil
-    end
-
-
-    # Creates './Rakefile' file
-    #
-    # @return [void]
-    #
-    def generate_rakefile
-      create_file path('Rakefile') do
-  <<-RUBY
-require 'praxis'
-require 'praxis/tasks'
-RUBY
-      end
-      nil
-    end
-
-
-    # Creates './config.ru' file
-    #
-    # @return [void]
-    #
-    def generate_config_ru
-      create_file path('config.ru') do
-  <<-RUBY
-#\\ -p 8888
-
-require 'bundler/setup'
-require 'praxis'
-
-application = Praxis::Application.instance
-application.logger = Logger.new(STDOUT)
-application.setup
-
-run application
-RUBY
-      end
+  class Example < Thor
+    include Thor::Actions
+
+    namespace "praxis:example"
+
+    def self.source_root
+      File.dirname(__FILE__) + "/templates/generator/example_app"
+    end
+
+    argument :app_name, required: true
+    desc "example", "Generates a new example application under an <app_name> directory to showcase some features"
+
+    def example
+      sanitized = app_name.downcase.gsub(/[^a-z0-9_\-.]/, '')
+      puts "APP_NAME: #{app_name}"
+      raise "Please use only letters, numbers, underscores, dashes or periods for the app name" unless sanitized == app_name
+
+      # Copy example files
+      root_files = ['Gemfile','config.ru','Rakefile']
+      root_files.each do |file|
+        copy_file file, verbose: true
+      end
+      # Copy example directories
+      root_dirs = ['app','config','design','db','spec']
+      root_dirs.each do |dir|
+        directory dir, recursive: true
+      end
+
+      puts
+      puts "To run the example application:"
+      puts
+      puts "  cd #{app_name}"
+      puts "  bundle"
+      puts "  bundle exec rake db:create db:migrate db:seed  # To create/migrate/seed the dev DB"
+      puts "  bundle exec rackup                             # To start the web server"
+      puts  
+      puts "From another terminal/app, use curl (or your favorite HTTP client) to retrieve data from the API"
+      puts "  For example: "
+      puts "  Get all users without filters or limit, and display only uid, and last_name fields"
+      puts "  curl -H 'X-Api-Version: 1' http://localhost:9292/users?fields=uid,last_name"
+      puts
+      puts "  Get the last 5 users, ordered by last_name (descending),  and display only uid, and last_name fields"
+      puts "  curl -H 'X-Api-Version: 1' 'http://localhost:9292/users?fields=uid,last_name&order=-last_name&pagination=by%3Dlast_name,items%3D5' "
+      puts "  (Note: To list all routes use: bundle exec rake praxis:routes)"
+      puts
       nil
     end
-
-
-    def generate_app_definitions_hello_world
-      create_file path('design/api.rb') do
-  <<-RUBY
-# Use this file to define your response templates and traits.
-#
-# For example, to define a response template:
-#   response_template :custom do |media_type:|
-#     status 200
-#     media_type media_type
-#   end
-Praxis::ApiDefinition.define do
-  # Trait that when included will require a Bearer authorization header to be passed in.
-  trait :authorized do
-    headers do
-      key "Authorization", String, regexp: /^.*Bearer\s/, required: true
-    end
-  end
-end
-RUBY
-      end
-
-      create_file path('design/resources/hello.rb') do
-  <<-RUBY
-module V1
-  module ApiResources
-    class Hello
-      include Praxis::ResourceDefinition
-
-      media_type V1::MediaTypes::Hello
-      version '1.0'
-
-      prefix '/api/hello'
-
-      # Will apply to all actions of this resource
-      trait :authorized
-
-      action_defaults do
-        response :ok
-      end
-
-      action :index do
-
-        routing do
-          get ''
-        end
-      end
-
-      action :show do
-
-        routing do
-          get '/:id'
-        end
-        params do
-          attribute :id, Integer, required: true, min: 0
-        end
-        response :not_found
-      end
-    end
-  end
-end
-RUBY
-      end
-
-      create_file path('design/media_types/hello.rb') do
-  <<-RUBY
-  module V1
-    module MediaTypes
-      class Hello < Praxis::MediaType
-
-        identifier 'application/json'
-
-        attributes do
-          attribute :string, String
-        end
-
-        view :default do
-          attribute :string
-        end
-      end
-    end
-  end
-  RUBY
-      end
-    end
-
-
-    def generate_app_controllers_hello_world
-        create_file path('app/controllers/hello.rb') do
-  <<-RUBY
-module V1
-  class Hello
-    include Praxis::Controller
-
-    implements V1::ApiResources::Hello
-
-    HELLO_WORLD = [ 'Hello world!', 'Привет мир!', 'Hola mundo!', '你好世界!', 'こんにちは世界！' ]
-
-    def index(**params)
-      response.headers['Content-Type'] = 'application/json'
-      response.body = HELLO_WORLD.to_json
-      response
-    end
-
-    def show(id:, **other_params)
-      hello = HELLO_WORLD[id]
-      if hello
-        response.body = { id: id, data: hello }
-      else
-        self.response = Praxis::Responses::NotFound.new(body: "Hello word with index \#{id} not found in our DB")
-      end
-      response.headers['Content-Type'] = 'application/json'
-      response
-    end
   end
 end
-RUBY
-      end
-    end
-
-  end
-end