praxis 0.13.0 → 0.14.0

data/spec/spec_app/design/api.rb

@@ -24,4 +24,15 @@ Praxis::ApiDefinition.define do
     end
   end
 
+  info do # applies to all API infos
+    name "Spec App"
+    title "A simple App to do some simple integration testing"
+    description "This example API should really be replaced by a set of more full-fledged example apps in the future"
+  end
+  
+  info("1.0") do # Applies to 1.0 version (and inherits everything else form the global one)
+    description "A simple 1.0 App"
+    base_path "/"
+  end
+  
 end

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

@@ -10,6 +10,8 @@ class Instance < Praxis::MediaType
 
     attribute :root_volume, Volume
 
+    attribute :volumes, Volume::Collection
+    
     links do
       link :root_volume
       link :other_volume, Volume, using: :data_volume
@@ -32,4 +34,14 @@ class Instance < Praxis::MediaType
     attribute :name
   end
 
+  view :extended, include_nil: true do
+    attribute :id
+    attribute :name
+    attribute :root_volume
+    attribute :links do
+      attribute :root_volume
+    end
+  end
+
+
 end

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

@@ -7,12 +7,12 @@ class Volume < Praxis::MediaType
 
     attribute :source, VolumeSnapshot
 
-    # returns VolumeSnapshot::Collection if exists
     attribute :snapshots, Praxis::Collection.of(VolumeSnapshot)
+    attribute :snapshots_summary, VolumeSnapshot::CollectionSummary
 
     links do
       link :source
-      link :snapshots
+      link :snapshots, VolumeSnapshot::CollectionSummary, using: :snapshots_summary
     end
 
   end
@@ -22,6 +22,7 @@ class Volume < Praxis::MediaType
     attribute :name
     attribute :source
     attribute :snapshots
+    
     attribute :links
   end
 
@@ -29,6 +30,12 @@ class Volume < Praxis::MediaType
     attribute :id
   end
 
+  class Collection < Praxis::Collection
+    member_type Volume
+
+    identifier 'application/vnd.acme.volumes'
+  end
+
 end
 
 

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

@@ -16,24 +16,27 @@ class VolumeSnapshot < Praxis::MediaType
   end
 
 
-  class Collection < Praxis::MediaTypeCollection
-    identifier 'application/json+collection'
-
-    member_type VolumeSnapshot
+  class CollectionSummary < Praxis::MediaType
+    identifier 'application/json'
 
     attributes do
       attribute :name, String, regexp: /snapshots-(\w+)/
-      attribute :size, Integer, example: proc { |collection| collection.to_a.count }
+      attribute :size, Integer
       attribute :href, String
     end
 
+    view :default do
+      attribute :name
+      attribute :size
+      attribute :href
+    end
+
     view :link do
       attribute :name
       attribute :size
       attribute :href
     end
 
-    member_view :default, using: :default
   end
 
 end

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

@@ -4,13 +4,11 @@ module ApiResources
 
     media_type Instance
     version '1.0'
-
-    #responses :instance_limit_reached
-    #responses :pay_us_money
-    #response :create, location: /instances/
-
     
-
+    # :show action is the canonical path for this resource.
+    # Note that the following is redundant, since :show is the default canonical path if none is defined.
+    canonical_path :show
+    
     routing do
       prefix '/clouds/:cloud_id/instances'
     end
@@ -30,17 +28,17 @@ module ApiResources
         get ''
       end
 
-      response_content_type = self.resource_definition.media_type.identifier + ";type=collection"
       params do
-        attribute :response_content_type, String, default: response_content_type
+        attribute :response_content_type, String, default: 'application/vnd.acme.instance;type=collection'
       end
+      
       headers do
         # BOTH ARE EQUIVALENT
         #key "FOO", String, required: true
         header "FOO", /bar/
       end
 
-      response :ok, media_type: response_content_type
+      response :ok, media_type: Praxis::Collection.of(Instance)
     end
 
     action :show do
@@ -53,7 +51,7 @@ module ApiResources
       response :unauthorized
 
       params do
-        attribute :id
+        attribute :id, required: true
         attribute :junk, String, default: ''
         attribute :some_date, DateTime, default: DateTime.parse('2012-12-21')
         attribute :fail_filter, Attributor::Boolean, default: false
@@ -160,6 +158,23 @@ module ApiResources
       response :ok, media_type: 'application/json'
     end
 
+    action :update do
+      routing do
+        patch '/:id'
+      end
+
+      params do
+        attribute :id, required: true
+      end
+
+      payload do
+        attribute :name
+        attribute :root_volume
+      end
+
+      response :ok
+    end
+
     # OTHER USAGES:
     #   note: these are all hypothetical, pending, brainstorming usages.
 

data/spec/support/spec_media_types.rb

@@ -3,7 +3,7 @@ class Person < Praxis::MediaType
     attribute :id, Integer
     attribute :name, String, example: /[:name:]/
     attribute :href, String, example: proc { |person| "/people/#{person.id}" }
-    attribute :links, Praxis::Collection.of(String)
+    attribute :links, silence_warnings { Praxis::Collection.of(String) } 
   end
 
   view :default do

data/spec/support/spec_resource_definitions.rb

@@ -9,6 +9,8 @@ class PeopleResource
 
   version '1.0'
 
+  canonical_path :show
+
   routing do
     prefix "/people"
   end

data/tasks/thor/app.rb

@@ -1,15 +1,15 @@
 module PraxisGen
   class App < Thor
     include Thor::Actions
-  
+
     namespace "praxis:app"
     def self.source_root
       File.dirname(__FILE__) + "/templates/generator/empty_app"
     end
-  
+
     argument :app_name, required: true
     desc "new", "Generates a blank new app under <app_name> (with a full skeleton ready to start coding)"
-  
+
     # 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}"
@@ -18,31 +18,36 @@ module PraxisGen
       create_app
       create_design
       create_spec
+      create_docs
     end
-  
-    private    
+
+    private
     def create_root_files
       ['config.ru','Gemfile','Guardfile','Rakefile','README.md'].each do |file|
         copy_file file, "#{app_name}/#{file}"
       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

@@ -9,7 +9,7 @@ module PraxisGen
         desc "new", "Generates a new 'hello world' example application under an <app_name> directory"
   
         def new
-          puts "GENERATION COMMENTED!! (for #{app_name})"
+          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
@@ -30,7 +30,7 @@ module PraxisGen
           puts "  # terminal 1:"
           puts "  cd #{app_name}"
           puts "  bundle"
-          puts "  rackup -p 8888"
+          puts "  bundle exec rackup"
           puts
           puts "  # terminal 2:"
           puts "  curl -i http://localhost:8888/api/hello   -H 'X-Api-Version: 1.0' -X GET  # Index"
@@ -74,29 +74,29 @@ private
     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
+# 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
-  RUBY
+  map :app, 'app/' do
+    map :models, 'models/**/*'
+    map :controllers, '**/controllers/**/*'
+    map :responses, '**/responses/**/*'
+  end
+end
+RUBY
       end
       nil
     end
@@ -109,16 +109,16 @@ private
     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
+source 'https://rubygems.org'
+
+gem 'praxis'
+gem 'rack', '~> 1.0'
+gem 'rake'
+
+group :development, :test do
+  gem 'rspec'
+end
+RUBY
       end
       nil
     end
@@ -131,9 +131,9 @@ private
     def generate_rakefile
       create_file path('Rakefile') do
   <<-RUBY
-  require 'praxis'
-  require 'praxis/tasks'
-  RUBY
+require 'praxis'
+require 'praxis/tasks'
+RUBY
       end
       nil
     end
@@ -146,17 +146,17 @@ private
     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
+#\\ -p 8888
+
+require 'bundler/setup'
+require 'praxis'
+
+application = Praxis::Application.instance
+application.logger = Logger.new(STDOUT)
+application.setup
+
+run application
+RUBY
       end
       nil
     end
@@ -165,62 +165,62 @@ private
     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 :versionable do
-      headers do
-        key "X-Api-Version", String, values: ['1.0'], required: true
-      end
+# 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 :versionable do
+    headers do
+      key "X-Api-Version", String, values: ['1.0'], required: true
     end
   end
-  RUBY
+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'
-  
+module V1
+  module ApiResources
+    class Hello
+      include Praxis::ResourceDefinition
+
+      media_type V1::MediaTypes::Hello
+      version '1.0'
+
+      routing do
+        prefix '/api/hello'
+      end
+
+      action :index do
+        use :versionable
+
         routing do
-          prefix '/api/hello'
+          get ''
         end
-  
-        action :index do
-          use :versionable
-  
-          routing do
-            get ''
-          end
-          response :ok
+        response :ok
+      end
+
+      action :show do
+        use :versionable
+
+        routing do
+          get '/:id'
         end
-  
-        action :show do
-          use :versionable
-  
-          routing do
-            get '/:id'
-          end
-          params do
-            attribute :id, Integer, required: true, min: 0
-          end
-          response :ok
-          response :not_found
+        params do
+          attribute :id, Integer, required: true, min: 0
         end
+        response :ok
+        response :not_found
       end
     end
   end
-  RUBY
+end
+RUBY
       end
   
       create_file path('design/media_types/hello.rb') do
@@ -249,33 +249,33 @@ private
     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
-        end
-        response.headers['Content-Type'] = 'application/json'
-        response
+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
       end
+      response.headers['Content-Type'] = 'application/json'
+      response
     end
   end
-  RUBY
+end
+RUBY
       end
     end