praxis 0.15.0 → 0.16.0

data/tasks/thor/example.rb

@@ -4,10 +4,10 @@ module PraxisGen
         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)
@@ -33,12 +33,18 @@ module PraxisGen
           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"
-          puts "  curl -i http://localhost:8888/api/hello/2 -H 'X-Api-Version: 1.0' -X GET  # Show"
-          puts "  curl -i http://localhost:8888/api/hello/2 -H 'X-Api-Version: 2.0' -X GET  # NotFound Error"
+          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      
+private
     # Returns relative path for the new application
     #
     # @return [String]
@@ -51,8 +57,8 @@ private
     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
@@ -65,8 +71,8 @@ private
     def path(*strings)
       app_dir_pathname.join(*strings).to_s
     end
-  
-  
+
+
     # Creates './config/environment.rb' file
     #
     # @return [void]
@@ -100,8 +106,8 @@ RUBY
       end
       nil
     end
-  
-  
+
+
     # Creates './Gemfile' file
     #
     # @return [void]
@@ -122,8 +128,8 @@ RUBY
       end
       nil
     end
-  
-  
+
+
     # Creates './Rakefile' file
     #
     # @return [void]
@@ -137,8 +143,8 @@ RUBY
       end
       nil
     end
-  
-  
+
+
     # Creates './config.ru' file
     #
     # @return [void]
@@ -160,8 +166,8 @@ RUBY
       end
       nil
     end
-  
-  
+
+
     def generate_app_definitions_hello_world
       create_file path('design/api.rb') do
   <<-RUBY
@@ -173,15 +179,16 @@ RUBY
 #     media_type media_type
 #   end
 Praxis::ApiDefinition.define do
-  trait :versionable do
+  # Trait that when included will require a Bearer authorization header to be passed in.
+  trait :authorized do
     headers do
-      key "X-Api-Version", String, values: ['1.0'], required: true
+      key "Authorization", String, regexp: /^.*Bearer\s/, required: true
     end
   end
 end
 RUBY
       end
-  
+
       create_file path('design/resources/hello.rb') do
   <<-RUBY
 module V1
@@ -192,21 +199,23 @@ module V1
       media_type V1::MediaTypes::Hello
       version '1.0'
 
-      routing do
-        prefix '/api/hello'
+      prefix '/api/hello'
+
+      # Will apply to all actions of this resource
+      trait :authorized
+
+      action_defaults do
+        response :ok
       end
 
       action :index do
-        use :versionable
 
         routing do
           get ''
         end
-        response :ok
       end
 
       action :show do
-        use :versionable
 
         routing do
           get '/:id'
@@ -214,7 +223,6 @@ module V1
         params do
           attribute :id, Integer, required: true, min: 0
         end
-        response :ok
         response :not_found
       end
     end
@@ -222,19 +230,19 @@ module V1
 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
@@ -244,8 +252,8 @@ RUBY
   RUBY
       end
     end
-  
-  
+
+
     def generate_app_controllers_hello_world
         create_file path('app/controllers/hello.rb') do
   <<-RUBY
@@ -268,7 +276,7 @@ module V1
       if hello
         response.body = { id: id, data: hello }
       else
-        self.response = Praxis::Responses::NotFound.new
+        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
@@ -278,6 +286,6 @@ end
 RUBY
       end
     end
-  
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: praxis
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Josep M. Blanquer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-16 00:00:00.000000000 Z
+date: 2015-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -73,14 +73,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: praxis-blueprints
   requirement: !ruby/object:Gem::Requirement
@@ -878,8 +878,8 @@ files:
 - lib/praxis/restful_doc_generator.rb
 - lib/praxis/route.rb
 - lib/praxis/router.rb
+- lib/praxis/routing_config.rb
 - lib/praxis/simple_media_type.rb
-- lib/praxis/skeletor/restful_routing_config.rb
 - lib/praxis/stage.rb
 - lib/praxis/stats.rb
 - lib/praxis/tasks.rb
@@ -887,6 +887,7 @@ files:
 - lib/praxis/tasks/console.rb
 - lib/praxis/tasks/environment.rb
 - lib/praxis/tasks/routes.rb
+- lib/praxis/trait.rb
 - lib/praxis/types/media_type_common.rb
 - lib/praxis/types/multipart.rb
 - lib/praxis/version.rb
@@ -924,11 +925,12 @@ files:
 - spec/praxis/response_spec.rb
 - spec/praxis/responses/internal_server_error_spec.rb
 - spec/praxis/responses/validation_error_spec.rb
-- spec/praxis/restful_routing_config_spec.rb
 - spec/praxis/route_spec.rb
 - spec/praxis/router_spec.rb
+- spec/praxis/routing_config_spec.rb
 - spec/praxis/stage_spec.rb
 - spec/praxis/stats_spec.rb
+- spec/praxis/trait_spec.rb
 - spec/praxis/types/collection_spec.rb
 - spec/praxis/types/multipart_spec.rb
 - spec/spec_app/app/concerns/authenticated.rb

data/lib/praxis/skeletor/restful_routing_config.rb

@@ -1,55 +0,0 @@
-module Praxis
-  module Skeletor
-    class RestfulRoutingConfig
-
-      attr_reader :name, :resource_definition, :routes
-
-      def initialize(name, resource_definition, &block)
-        @name = name
-        @resource_definition = resource_definition
-        @routes = []
-
-        @version_prefix = ""
-        if resource_definition.version_options
-          version_using = Array(resource_definition.version_options[:using])
-          if version_using.include?(:path)  
-            @version_prefix = "#{Praxis::Request::path_version_prefix}#{resource_definition.version}"
-          end
-        end
-        prefix( "/" + resource_definition.name.split("::").last.underscore )
-        
-        if resource_definition.routing_config
-          instance_eval(&resource_definition.routing_config)
-        end
-
-        instance_eval(&block)
-      end
-
-      def prefix(prefix=nil)
-        @path_prefix = prefix if prefix
-        @version_prefix + @path_prefix 
-      end
-
-      def options(path, opts={}) add_route 'OPTIONS', path, opts end
-      def get(path, opts={})     add_route 'GET',     path, opts end
-      def head(path, opts={})    add_route 'HEAD',    path, opts end
-      def post(path, opts={})    add_route 'POST',    path, opts end
-      def put(path, opts={})     add_route 'PUT',     path, opts end
-      def delete(path, opts={})  add_route 'DELETE',  path, opts end
-      def trace(path, opts={})   add_route 'TRACE',   path, opts end
-      def connect(path, opts={}) add_route 'CONNECT', path, opts end
-      def patch(path, opts={})   add_route 'PATCH',   path, opts end
-      def any(path, opts={})     add_route 'ANY',       path, opts end
-
-        
-
-      def add_route(verb, path, options={})
-        path = Mustermann.new(prefix + path)
-
-        @routes << Route.new(verb, path, resource_definition.version, **options)
-      end
-
-    end
-
-  end
-end

data/spec/praxis/restful_routing_config_spec.rb

@@ -1,101 +0,0 @@
-require 'spec_helper'
-
-describe Praxis::Skeletor::RestfulRoutingConfig do
-
-  let(:resource_definition) do
-    Class.new do
-      include Praxis::ResourceDefinition
-      def self.name; 'MyResource'; end
-    end
-  end
-
-  let(:action_name) { :index }
-  let(:routing_block) { Proc.new{} }
-  let(:default_route_prefix) { "/" + resource_definition.name.split("::").last.underscore }
-
-  subject(:routing_config){ Praxis::Skeletor::RestfulRoutingConfig.new(action_name, resource_definition, &routing_block) }
-
-  context "#initialize" do
-    it "name" do
-      expect(subject.name).to eq(:index)
-    end
-
-    it "resource_definition" do
-      expect(subject.resource_definition).to eq(resource_definition)
-    end
-
-    it "routes" do
-      expect(subject.routes.empty?).to eq(true)
-    end
-
-    it "prefix without path version" do
-      expect(subject.prefix).to eq(default_route_prefix)
-    end
-
-    context 'prefix using path version' do
-      let(:resource_definition) do
-        Class.new do
-          include Praxis::ResourceDefinition
-          version "1.0", using: :path
-          def self.name; 'MyVersionedResource'; end
-        end
-      end
-      it "prefix" do
-        expect(subject.prefix).to eq("/v1.0#{default_route_prefix}")
-      end
-    end
-  end
-
-  context "#add_route" do
-    let(:route_verb){ 'GET' }
-    let(:route_path){ '/path' }
-    let(:route_opts){ {option: 1} }
-
-    before(:each) do
-      routing_config.add_route(route_verb, route_path, route_opts)
-    end
-
-    it "routes" do
-      expect(subject.routes.length).to eq(1)
-    end
-
-    it "saves the verb and options into the route" do
-      route = subject.routes.first
-
-      expect(route.verb).to eq(route_verb)
-      expect(route.options).to eq(route_opts)
-    end
-
-    context "with a resource definition that does not have a route prefix" do
-      it 'saves the path with the default path prefix' do
-        path = subject.routes.first.path.to_s
-        expect(path).to eq(default_route_prefix + route_path)
-      end
-    end
-
-    context "with a resource definition that has a route prefix" do
-      let(:routing_block) { Proc.new{ prefix "/my_custom_route" } }
-      subject(:routing_config){ Praxis::Skeletor::RestfulRoutingConfig.new(action_name, resource_definition, &routing_block) }
-      it 'appends the prefix to the path' do
-        path = subject.routes.first.path.to_s
-        expect(path).to eq("/my_custom_route" + route_path)
-      end
-
-    end
-  end
-
-  context 'route helpers' do
-    let(:route_prefix) { nil }
-
-    it 'call the add_route with the correct parameters' do
-      helper_verbs = [:get, :put, :post, :delete, :head, :options, :patch, :any]
-      helper_verbs.each do |verb|
-        path = "/path_for_#{verb}"
-        options = {option: verb}
-        expect(subject).to receive(:add_route).with(verb.to_s.upcase,path,options)
-        subject.__send__(verb, path, options)
-      end
-    end
-  end
-
-end