praxis 0.11.2 → 0.13.0

data/lib/praxis/restful_doc_generator.rb

@@ -8,7 +8,17 @@ module Praxis
     @inspected_types = Set.new
     API_DOCS_DIRNAME = 'api_docs'
 
-    EXCLUDED_TYPES_FROM_TOP_LEVEL = Set.new( [Attributor::Boolean, Attributor::CSV, Attributor::DateTime, Attributor::Float, Attributor::Hash, Attributor::Ids, Attributor::Integer, Attributor::Object,  Attributor::String ] ).freeze
+    EXCLUDED_TYPES_FROM_TOP_LEVEL = Set.new([
+      Attributor::Boolean,
+      Attributor::CSV,
+      Attributor::DateTime,
+      Attributor::Float,
+      Attributor::Hash,
+      Attributor::Ids,
+      Attributor::Integer,
+      Attributor::Object,
+      Attributor::String
+    ]).freeze
 
     def self.inspect_attributes(the_type)
 
@@ -66,6 +76,9 @@ module Praxis
 
         # Collect reachable types from the params and payload definitions
         @controller_config.actions.each do |name, action_config|
+          # skip actions with doc_visibility of :none
+          next if action_config.metadata[:doc_visibility] == :none
+
           add_to_reachable RestfulDocGenerator.inspect_attributes(action_config.params)
           add_to_reachable RestfulDocGenerator.inspect_attributes(action_config.payload)
         end
@@ -111,6 +124,9 @@ module Praxis
 
     def load_resources
       Praxis::Application.instance.resource_definitions.map do |resource|
+        # skip resources with doc_visibility of :none
+        next if resource.metadata[:doc_visibility] == :none
+
         @resources << Resource.new(resource)
       end
 
@@ -129,13 +145,21 @@ module Praxis
 
     def write_resources
       @resources.each do |r|
+
         filename = File.join(@doc_root_dir, r.version, "resources","#{r.id}.json")
         #puts "Dumping #{r.id} to #{filename}"
         base = File.dirname(filename)
         FileUtils.mkdir_p base unless File.exists? base
         resource_description = r.controller_config.describe
+
+        # strip actions with doc_visibility of :none
+        resource_description[:actions].reject! { |a| a[:metadata][:doc_visibility] == :none }
+
         # Go through the params/payload of each action and generate an example for them (then stick it into the description hash)
         r.controller_config.actions.each do |action_name, action|
+          # skip actions with doc_visibility of :none
+          next if action.metadata[:doc_visibility] == :none
+
           generated_examples = {}
           if action.params
             generated_examples[:params] = dump_example_for( r.id, action.params )
@@ -222,7 +246,7 @@ module Praxis
         # Discard any mediatypes that we've already seen and processed as controller related
         reportable_types = types - media_types_seen_from_controllers - EXCLUDED_TYPES_FROM_TOP_LEVEL
         #TODO: think about these special cases, is it needed?
-        reportable_types.reject!{|type| type < Praxis::Links || type < Praxis::MediaTypeCollection } 
+        reportable_types.reject!{|type| type < Praxis::Links || type < Praxis::MediaTypeCollection }
 
         reportable_types.each do |type|
           index[version] ||= Hash.new
@@ -309,4 +333,4 @@ module Praxis
     end
 
   end
-end
+end

data/lib/praxis/router.rb

@@ -64,7 +64,17 @@ module Praxis
       end
 
       verb = request.verb
-      result = @routes[verb].call(request)
+      r = ( @routes.key?(verb) ? @routes[verb] : nil )  # Exact verb match
+      result = r.call(request) if r
+      # If we didn't have an exact verb route, or if we did but the rest or route conditions didn't match
+      if( r == nil || result == :not_found )
+         # Fallback to a wildcard router, if there is one registered
+        result = if @routes.key?('ANY')
+           @routes['ANY'].call(request)
+         else
+           :not_found
+         end
+      end
       
       if result == :not_found
         # no need to try :path as we cannot really know if you've attempted to pass a version through it here
@@ -81,7 +91,11 @@ module Praxis
           pretty_versions = attempted_versions.collect(&:inspect).join(', ')
           body += " Available versions = #{pretty_versions}."
         end
-        result = [404, {"Content-Type" => "text/plain", }, [body]] 
+        headers = {"Content-Type" => "text/plain"}
+        if Praxis::Application.instance.config.praxis.x_cascade
+          headers['X-Cascade'] = 'pass'
+        end
+        result = [404, headers, [body]] 
       end
       result
     end

data/lib/praxis/skeletor/restful_routing_config.rb

@@ -39,6 +39,9 @@ module Praxis
       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)

data/lib/praxis/stage.rb

@@ -12,7 +12,7 @@ module Praxis
       context
     end
 
-    def initialize(name, context,**opts)
+    def initialize(name, context, **opts)
       @name = name
       @context = context
       @before_callbacks = Array.new

data/lib/praxis/tasks/api_docs.rb

@@ -7,7 +7,7 @@ namespace :praxis do
     generator = Praxis::RestfulDocGenerator.new(Dir.pwd)
   end
 
-  desc "API Documentation Browser"
+  desc "Run API Documentation Browser"
   task :doc_browser, [:port] => :api_docs do |t, args|
     args.with_defaults port: 4567
 

data/lib/praxis/tasks/console.rb

@@ -1,11 +1,29 @@
 namespace :praxis do
-  task :console => :environment do
+  desc "Run interactive pry/irb console"
+  task :console do
+    have_pry = false
+
     begin
+      # Use pry if available; require pry _before_ environment to maximize
+      # debuggability.
       require 'pry'
-      pry
+      have_pry = true
     rescue LoadError
+      # Fall back on irb
       require 'irb'
-      IRB.start
+      require 'irb/ext/multi-irb'
+    end
+
+    Rake::Task['praxis:environment'].invoke
+
+    if have_pry
+      Praxis::Application.instance.pry
+    else
+      # Use some special initialization magic to ensure that 'self' in the
+      # IRB session refers to Praxis::Application.instance.
+      IRB.setup nil
+      IRB.conf[:MAIN_CONTEXT] = IRB::Irb.new.context
+      IRB.irb(nil, Praxis::Application.instance)
     end
   end
 end

data/lib/praxis/tasks/routes.rb

@@ -2,11 +2,16 @@ namespace :praxis do
 
   desc 'List routes, format=json or table, default table'
   task :routes, [:format] => [:environment] do |t, args|
-    require 'ruport'
+    require 'terminal-table'
 
-    table = Table(:version, :path, :verb, :resource, 
-      :action, :implementation, :name, :primary)
 
+    table = Terminal::Table.new title: "Routes",
+    headings:  [
+      "Version", "Path", "Verb",
+      "Resource", "Action", "Implementation", "Name", "Primary"
+    ]
+
+    rows = []
     Praxis::Application.instance.resource_definitions.each do |resource_definition|
       resource_definition.actions.each do |name, action|
         method = begin
@@ -14,11 +19,11 @@ namespace :praxis do
         rescue
           nil
         end
-        
+
         method_name = method ? "#{method.owner.name}##{method.name}" : 'n/a'
 
         action.routes.each do |route|
-          table << {
+          rows << {
             resource: resource_definition.name,
             version: route.version,
             verb: route.verb,
@@ -32,11 +37,18 @@ namespace :praxis do
       end
     end
 
+
+
+
     case args[:format] || "table"
     when "json"
-      puts JSON.pretty_generate(table.collect { |r| r.to_hash })
+      puts JSON.pretty_generate(rows)
     when "table"
-      puts table.to_s
+      rows.each do |row|
+        table.add_row(row.values_at(:version, :path, :verb, :resource,
+                                    :action, :implementation, :name, :primary))
+      end
+      puts table
     else
       raise "unknown output format: #{args[:format]}"
     end

data/lib/praxis/version.rb

@@ -1,3 +1,3 @@
 module Praxis
-  VERSION = '0.11.2'
+  VERSION = '0.13.0'
 end

data/praxis.gemspec

@@ -7,7 +7,6 @@ Gem::Specification.new do |spec|
   spec.name          = "praxis"
   spec.version       = Praxis::VERSION
   spec.authors = ["Josep M. Blanquer","Dane Jensen"]
-  spec.date = "2014-08-19"
   spec.summary = 'Building APIs the way you want it.'
 
   spec.email = ["blanquer@gmail.com","dane.jensen@gmail.com"]
@@ -24,11 +23,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rack', '~> 1'
   spec.add_dependency 'mustermann', '~> 0'
   spec.add_dependency 'activesupport', '>= 3'
-  spec.add_dependency 'ruport', '~> 1'
   spec.add_dependency 'mime', '~> 0'
-  spec.add_dependency 'praxis-mapper', '~> 3.1'
-  spec.add_dependency 'praxis-blueprints', '~> 1.1'
-  spec.add_dependency 'attributor', '~> 2.4.0'
+  spec.add_dependency 'praxis-mapper', '~> 3.3'
+  spec.add_dependency 'praxis-blueprints', '~> 1.2'
+  spec.add_dependency 'attributor', '~> 2.5.0'
   spec.add_dependency 'thor', '~> 0.18'
   spec.add_dependency 'terminal-table', '~> 1.4'
   spec.add_dependency 'harness', '~> 2'

data/spec/functional_spec.rb

@@ -256,6 +256,18 @@ describe 'Functional specs' do
     end
   end
 
+  context 'wildcard routing' do
+    it 'can terminate instances with POST' do
+      post '/clouds/23/instances/1/terminate?api_version=1.0', nil, 'global_session' => session
+      expect(last_response.status).to eq(200)
+    end
+    it 'can terminate instances with DELETE' do
+      post '/clouds/23/instances/1/terminate?api_version=1.0', nil, 'global_session' => session
+      expect(last_response.status).to eq(200)
+    end
+
+  end
+  
   context 'auth_plugin' do
     it 'can terminate' do
       post '/clouds/23/instances/1/terminate?api_version=1.0', nil, 'global_session' => session

data/spec/praxis/action_definition_spec.rb

@@ -38,6 +38,7 @@ describe Praxis::ActionDefinition do
     its('payload.attributes')  { should have_key :inherited }
     its('headers.attributes')  { should have_key "X_REQUESTED_WITH" }
     its('headers.attributes')  { should have_key "Inherited" }
+    its('metadata') { should_not have_key :doc_visibility }
   end
 
   context '#responses' do
@@ -140,4 +141,20 @@ describe Praxis::ActionDefinition do
     end
 
   end
+
+  context 'with nodoc!' do
+    before do
+      action.nodoc!      
+    end
+
+    it 'has :doc_visibility set in metadata' do
+      expect(action.metadata[:doc_visibility]).to be(:none)
+    end
+
+    it 'is exposed by describe' do
+      expect(action.describe[:metadata][:doc_visibility]).to be(:none)
+    end
+
+  end
+
 end

data/spec/praxis/media_type_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
 describe Praxis::MediaType do
-  let(:owner_resource) { double('owner', id: 100, name: /[:name:]/.gen, href: '/') }
-  let(:manager_resource) { double('manager', id: 101, name: /[:name:]/.gen, href: '/') }
+  let(:owner_resource) { instance_double(Person, id: 100, name: /[:name:]/.gen, href: '/', links: ['one','two']) }
+  let(:manager_resource) { instance_double(Person, id: 101, name: /[:name:]/.gen, href: '/', links: []) }
 
   let(:resource) do
     double('address', id: 1, name: 'Home',owner: owner_resource, manager: manager_resource)
@@ -10,6 +10,7 @@ describe Praxis::MediaType do
 
   subject(:address) { Address.new(resource) }
 
+
   context 'attributes' do
     its(:id)    { should eq(1) }
     its(:name)  { should eq('Home') }
@@ -23,11 +24,28 @@ describe Praxis::MediaType do
     end
   end
 
+
+  
   context 'accessor methods' do
     subject(:address_klass) { address.class }
 
     its(:identifier)  { should be_kind_of(String) }
     its(:description) { should be_kind_of(String) }
+    
+    context 'links' do
+      context 'with an custom links attribute' do
+        subject(:person) { Person.new(owner_resource) }
+
+        its(:links)  { should be_kind_of(Array) }
+        its(:links)  { should eq(owner_resource.links) }
+      end
+  
+      context 'using the links DSL' do
+        subject(:address) { Address.new(resource) }
+        its(:links)  { should be_kind_of(Address::Links) }
+      end
+      
+    end
   end
 
   context "rendering" do
@@ -74,7 +92,9 @@ describe Praxis::MediaType do
     end
   end
 
+
   context 'using blueprint caching' do
     it 'has specs'
   end
+
 end

data/spec/praxis/plugins/praxis_mapper_plugin_spec.rb

@@ -9,7 +9,7 @@ describe Praxis::Plugins::PraxisMapperPlugin do
     context 'configuration' do
       subject { config }
       its(:log_stats) { should eq 'skip' }
-
+      its(:stats_log_level) { should eq :info }
       its(:repositories) { should have_key("default") }
 
       context 'default repository' do
@@ -23,6 +23,17 @@ describe Praxis::Plugins::PraxisMapperPlugin do
     end
   end
 
+  context 'Request' do
+    
+    it 'should have identity_map accessors' do
+      expect(Praxis::Plugins::PraxisMapperPlugin::Request.instance_methods).to include(:identity_map,:identity_map=)
+    end
+    
+    it 'should have silence_mapper_stats accessors' do
+      expect(Praxis::Plugins::PraxisMapperPlugin::Request.instance_methods)
+            .to include(:silence_mapper_stats,:silence_mapper_stats=)
+    end
+  end
   context 'functional test' do
 
     def app
@@ -42,7 +53,7 @@ describe Praxis::Plugins::PraxisMapperPlugin do
 
     it 'logs stats' do
       expect(Praxis::Plugins::PraxisMapperPlugin::Statistics).to receive(:log).
-        with(kind_of(Praxis::Mapper::IdentityMap), 'detailed').
+        with(kind_of(Praxis::Request),kind_of(Praxis::Mapper::IdentityMap), 'detailed').
         and_call_original
 
       get '/clouds/1/instances/2?junk=foo&api_version=1.0', nil, 'global_session' => session
@@ -54,24 +65,60 @@ describe Praxis::Plugins::PraxisMapperPlugin do
 
   context 'Statistics' do
     context '.log' do
-      let(:identity_map) { double('identity_map') }
+      let(:queries){ { some: :queries } }
+      let(:identity_map) { double('identity_map', queries: queries) }
+      let(:log_stats){ 'detailed' }
+      let(:request){ double('request', silence_mapper_stats: false ) }
 
-      it 'when log_stats = detailed' do
-        expect(Praxis::Plugins::PraxisMapperPlugin::Statistics).to receive(:detailed).with(identity_map)
-        Praxis::Plugins::PraxisMapperPlugin::Statistics.log(identity_map, 'detailed')
+      after do
+        Praxis::Plugins::PraxisMapperPlugin::Statistics.log(request, identity_map, log_stats)
       end
 
-      it 'when log_stats = short' do
-        expect(Praxis::Plugins::PraxisMapperPlugin::Statistics).to receive(:short).with(identity_map)
-        Praxis::Plugins::PraxisMapperPlugin::Statistics.log(identity_map, 'short')
+      context 'when the request silences mapper stats' do
+        let(:request){ double('request', silence_mapper_stats: true ) }
+        it 'should not log anything' do
+          expect(Praxis::Plugins::PraxisMapperPlugin::Statistics).to_not receive(:to_logger) 
+        end
       end
-
-      it 'when log_stats = skip' do
-        expect(Praxis::Plugins::PraxisMapperPlugin::Statistics).to_not receive(:short)
-        expect(Praxis::Plugins::PraxisMapperPlugin::Statistics).to_not receive(:detailed)
-        Praxis::Plugins::PraxisMapperPlugin::Statistics.log(identity_map, 'skip')
+      
+      context 'without the request silencing mapper stats' do
+        context 'when log_stats = detailed' do
+          it 'should call the detailed method' do
+             expect(Praxis::Plugins::PraxisMapperPlugin::Statistics).to receive(:detailed).with(identity_map) 
+           end
+        end
+      
+        context 'when log_stats = short' do
+          let(:log_stats){ 'short' }
+          it 'should call the short method' do
+             expect(Praxis::Plugins::PraxisMapperPlugin::Statistics).to receive(:short).with(identity_map) 
+           end
+        end
+      
+        context 'when log_stats = skip' do
+          let(:log_stats){ 'skip' }
+          
+          it 'should not log anything' do
+            expect(Praxis::Plugins::PraxisMapperPlugin::Statistics).to_not receive(:to_logger) 
+          end
+        end
+      
+        context 'when there is no identity map' do
+          let(:identity_map) { nil }
+          it 'should not log anything' do
+            expect(Praxis::Plugins::PraxisMapperPlugin::Statistics).to_not receive(:to_logger)
+          end        
+        end
+      
+        context 'when no queries are logged in the identity map' do
+          let(:queries){ {} }
+          it 'should log a special message' do
+            expect(Praxis::Plugins::PraxisMapperPlugin::Statistics).to receive(:to_logger)
+                                                                   .with("No database interactions observed.")
+          end
+        end
+        
       end
-
     end
 
     it 'has specs for testing the detailed log output'