praxis 2.0.pre.17 → 2.0.pre.21

data/spec/functional_spec.rb

@@ -1,20 +1,21 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe 'Functional specs' do
-
   def app
     Praxis::Application.instance
   end
 
-  let(:session) { double("session", valid?: true)}
+  let(:session) { double('session', valid?: true) }
 
   context 'index' do
-
     context 'with a valid request' do
       it 'is successful' do
         get '/api/clouds/1/instances?api_version=1.0', nil, 'global_session' => session
         expect(last_response.headers['Content-Type']).to(
-        eq("application/vnd.acme.instance;type=collection"))
+          eq('application/vnd.acme.instance;type=collection')
+        )
       end
     end
 
@@ -59,7 +60,6 @@ describe 'Functional specs' do
         expect(response['summary']).to eq 'Error validating request data.'
         expect(response['errors']).to match_array([/.*cloud_id.*is smaller than the allowed min/])
       end
-
     end
 
     context 'with a header that is invalid' do
@@ -87,12 +87,12 @@ describe 'Functional specs' do
       end
 
       it 'fails to validate the response' do
-        get '/api/clouds/1/instances?response_content_type=somejunk&api_version=1.0', nil, 'HTTP_FOO' => "bar", 'global_session' => session
-        expect(last_response.status).to eq(400)
+        get '/api/clouds/1/instances?response_content_type=somejunk&api_version=1.0', nil, 'HTTP_FOO' => 'bar', 'global_session' => session
+        expect(last_response.status).to eq(500)
         response = JSON.parse(last_response.body)
 
         expect(response['name']).to eq('ValidationError')
-        expect(response['summary']).to eq("Error validating response")
+        expect(response['summary']).to eq('Error validating response')
         expect(response['errors'].first).to match(/Bad Content-Type/)
       end
 
@@ -104,31 +104,30 @@ describe 'Functional specs' do
           expect(Praxis::Application.instance.config).to receive(:praxis).and_return(praxis_config)
         end
 
-        it 'fails to validate the response' do
-          expect {
-            get '/api/clouds/1/instances?response_content_type=somejunk&api_version=1.0',nil,  'global_session' => session
-          }.to_not raise_error
+        it 'does not validate the response and succeeds' do
+          expect do
+            get '/api/clouds/1/instances?response_content_type=somejunk&api_version=1.0', nil, 'global_session' => session
+          end.to_not raise_error
         end
-
       end
     end
-
   end
 
   it 'works' do
-    the_body = StringIO.new("{}") # This is a funny, GET request expecting a body
-    get '/api/clouds/1/instances/2?junk=foo&api_version=1.0', nil,'rack.input' => the_body,'CONTENT_TYPE' => "application/json", 'global_session' => session
+    the_body = StringIO.new('{}') # This is a funny, GET request expecting a body
+    get '/api/clouds/1/instances/2?junk=foo&api_version=1.0', nil, 'rack.input' => the_body, 'CONTENT_TYPE' => 'application/json', 'global_session' => session
     expect(last_response.status).to eq(200)
     expected = {
-      "cloud_id" => 1,
-      "id"=>2,
-      "junk"=>"foo",
-      "other_params"=>{
-        "some_date"=>"2012-12-21T00:00:00+00:00",
-        "fail_filter"=>false
+      'cloud_id' => 1,
+      'id' => 2,
+      'junk' => 'foo',
+      'other_params' => {
+        'some_date' => '2012-12-21T00:00:00+00:00',
+        'fail_filter' => false
       },
-      "payload"=>{
-      "optional"=>"not given"}
+      'payload' => {
+        'optional' => 'not given'
+      }
     }
 
     expect(JSON.parse(last_response.body)).to eq(expected)
@@ -144,9 +143,8 @@ describe 'Functional specs' do
   end
 
   context 'bulk_create multipart' do
-
     let(:instance) { Instance.example }
-    let(:instance_json) { JSON.pretty_generate(instance.render(fields: {id: true, name: true})) }
+    let(:instance_json) { JSON.pretty_generate(instance.render(fields: { id: true, name: true })) }
 
     let(:form) do
       form_data = MIME::Multipart::FormData.new
@@ -170,15 +168,14 @@ describe 'Functional specs' do
 
       instance_headers = instance_part.headers
       expect(instance_headers['Status']).to eq('201')
-      expect(instance_headers['Location']).to match(%r|/clouds/.*/instances/.*|)
+      expect(instance_headers['Location']).to match(%r{/clouds/.*/instances/.*})
 
       response_instance = JSON.parse(instance_part.body)
-      expect(response_instance["key"]).to eq(instance.id)
-      expect(response_instance["value"].values).to eq(instance.render(fields: {id: true, name: true}).values)
+      expect(response_instance['key']).to eq(instance.id)
+      expect(response_instance['value'].values).to eq(instance.render(fields: { id: true, name: true }).values)
     end
   end
 
-
   context 'attach_file' do
     let(:form) do
       form_data = MIME::Multipart::FormData.new
@@ -229,9 +226,8 @@ describe 'Functional specs' do
         response = JSON.parse(last_response.body)
 
         expect(response['name']).to eq('ValidationError')
-        expect(response['errors']).to eq(["Attribute $.payload.destination_path is required"])
+        expect(response['errors']).to eq(['Attribute $.payload.destination_path is required'])
       end
-
     end
 
     context 'with an extra key in the form' do
@@ -257,28 +253,26 @@ describe 'Functional specs' do
       before do
         post '/api/clouds/1/instances/2/files?api_version=1.0', body, 'CONTENT_TYPE' => content_type, 'global_session' => session
       end
-      its(:keys){ should eq(['destination_path','name','filename','type','contents','options'])}
-      its(['options']){ should eq({"extra_thing"=>"I am extra"})}
+      its(:keys) { should eq(%w[destination_path name filename type contents options]) }
+      its(['options']) { should eq({ 'extra_thing' => 'I am extra' }) }
     end
-
   end
 
-
   context 'not found and API versions' do
     context 'when no version is specified' do
       it 'it tells you which available api versions would match' do
-        get '/api/clouds/1/instances/2?junk=foo',nil, 'global_session' => session
+        get '/api/clouds/1/instances/2?junk=foo', nil, 'global_session' => session
 
         expect(last_response.status).to eq(404)
-        expect(last_response.headers["Content-Type"]).to eq("text/plain")
-        expect(last_response.body).to eq("NotFound. Your request did not specify an API version. Available versions = \"1.0\".")
+        expect(last_response.headers['Content-Type']).to eq('text/plain')
+        expect(last_response.body).to eq('NotFound. Your request did not specify an API version. Available versions = "1.0".')
       end
       it 'it just gives you a simple not found when nothing would have matched' do
         get '/foobar?junk=foo', nil, 'global_session' => session
 
         expect(last_response.status).to eq(404)
-        expect(last_response.headers["Content-Type"]).to eq("text/plain")
-        expect(last_response.body).to eq("NotFound")
+        expect(last_response.headers['Content-Type']).to eq('text/plain')
+        expect(last_response.body).to eq('NotFound')
       end
     end
 
@@ -287,11 +281,10 @@ describe 'Functional specs' do
         get '/api/clouds/1/instances/2?junk=foo&api_version=50.0', nil, 'global_session' => session
 
         expect(last_response.status).to eq(404)
-        expect(last_response.headers["Content-Type"]).to eq("text/plain")
-        expect(last_response.body).to eq("NotFound. Your request specified API version = \"50.0\". Available versions = \"1.0\".")
+        expect(last_response.headers['Content-Type']).to eq('text/plain')
+        expect(last_response.body).to eq('NotFound. Your request specified API version = "50.0". Available versions = "1.0".')
       end
     end
-
   end
 
   context 'volumes' do
@@ -304,7 +297,7 @@ describe 'Functional specs' do
         get '/api/clouds/1/volumes/123?junk=stuff', nil, 'global_session' => session
         expect(last_response.status).to eq(200)
         expect(Volume.load(last_response.body).validate).to be_empty
-        expect(last_response.headers["Content-Type"]).to eq("application/vnd.acme.volume")
+        expect(last_response.headers['Content-Type']).to eq('application/vnd.acme.volume')
       end
     end
     context 'when an authorization header is passed' do
@@ -317,7 +310,6 @@ describe 'Functional specs' do
         get '/api/clouds/1/volumes/123?junk=stuff', nil, 'HTTP_AUTHORIZATION' => 'the secret', 'global_session' => session
         expect(last_response.status).to eq(200)
       end
-
     end
 
     context 'index action with no args defined' do
@@ -329,7 +321,7 @@ describe 'Functional specs' do
   end
 
   context 'wildcard verb routing' do
-    let(:content_type){ 'application/json' }
+    let(:content_type) { 'application/json' }
     it 'can terminate instances with POST' do
       post '/api/clouds/23/instances/1/terminate?api_version=1.0', nil, 'CONTENT_TYPE' => content_type, 'global_session' => session
       expect(last_response.status).to eq(200)
@@ -338,7 +330,6 @@ describe 'Functional specs' do
       post '/api/clouds/23/instances/1/terminate?api_version=1.0', nil, 'CONTENT_TYPE' => content_type, 'global_session' => session
       expect(last_response.status).to eq(200)
     end
-
   end
 
   context 'route options' do
@@ -381,7 +372,6 @@ describe 'Functional specs' do
   end
 
   context 'update' do
-
     let(:body) { JSON.pretty_generate(request_payload) }
     let(:content_type) { 'application/json' }
 
@@ -399,29 +389,27 @@ describe 'Functional specs' do
     end
 
     context 'with a provided name' do
-      let(:request_payload) { {name: 'MyInstance'} }
+      let(:request_payload) { { name: 'MyInstance' } }
       its(['name']) { should eq('MyInstance') }
       it { should_not have_key('root_volume') }
     end
 
     context 'with an explicitly-nil root_volme' do
-      let(:request_payload) { {name: 'MyInstance', root_volume: nil} }
+      let(:request_payload) { { name: 'MyInstance', root_volume: nil } }
       its(['name']) { should eq('MyInstance') }
       its(['root_volume']) { should be(nil) }
     end
 
-    context 'with an invalid name' do
-      let(:request_payload) { {name: 'Invalid Name'} }
+    context 'returning an invalid name' do
+      let(:request_payload) { { name: 'Invalid Name' } }
 
       its(['name']) { should eq 'ValidationError' }
       its(['summary']) { should eq 'Error validating response' }
       its(['errors']) { should match_array [/\$\.name value \(Invalid Name\) does not match regexp/] }
 
       it 'returns a validation error' do
-        expect(last_response.status).to eq(400)
+        expect(last_response.status).to eq(500)
       end
     end
-
   end
-
 end

data/spec/praxis/action_definition_spec.rb

@@ -1,18 +1,20 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
-describe Praxis::ActionDefinition do
-  class SpecMediaType < Praxis::MediaType
-    identifier 'application/json'
+class SpecMediaType < Praxis::MediaType
+  identifier 'application/json'
 
-    attributes do
-      attribute :one, String
-      attribute :two, Integer
-    end
-    default_fieldset do
-      attribute :one
-    end
+  attributes do
+    attribute :one, String
+    attribute :two, Integer
+  end
+  default_fieldset do
+    attribute :one
   end
+end
 
+describe Praxis::ActionDefinition do
   let(:endpoint_definition) do
     Class.new do
       include Praxis::EndpointDefinition
@@ -26,20 +28,20 @@ describe Praxis::ActionDefinition do
       prefix '/foobars/hello_world'
       action_defaults do
         payload { attribute :inherited, String }
-        headers { header "Inherited", String }
+        headers { header 'Inherited', String }
         params  { attribute :inherited, String }
       end
     end
   end
 
   subject(:action) do
-
     Praxis::ApiDefinition.define do |api|
-      api.response_template :ok do |media_type: , location: nil, headers: nil, description: nil |
+      api.response_template :ok do |media_type:, location: nil, headers: nil, description: nil|
         status 200
 
         media_type media_type
         location location
+        description description
         headers&.each do |(name, value)|
           header(name, value)
         end
@@ -48,9 +50,9 @@ describe Praxis::ActionDefinition do
     Praxis::ActionDefinition.new(:foo, endpoint_definition) do
       routing { get '/:one' }
       payload { attribute :two, String }
-      headers { header "X_REQUESTED_WITH", 'XMLHttpRequest' }
+      headers { header 'X_REQUESTED_WITH', 'XMLHttpRequest' }
       params  { attribute :one, String }
-      response :ok, headers: { "Foo" => "Bar"}, location: %r{/some/thing}
+      response :ok, headers: { 'Foo' => 'Bar' }, location: %r{/some/thing}
     end
   end
 
@@ -61,8 +63,8 @@ describe Praxis::ActionDefinition do
     its('params.attributes')   { should have_key :inherited }
     its('payload.attributes')  { should have_key :two }
     its('payload.attributes')  { should have_key :inherited }
-    its('headers.attributes')  { should have_key "X_REQUESTED_WITH" }
-    its('headers.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
 
@@ -99,23 +101,21 @@ describe Praxis::ActionDefinition do
           attribute :app_name, String
           attribute :name, String
         end
-
       end
     end
-    let(:traits) { {test: trait} }
+    let(:traits) { { test: trait } }
 
     before do
       allow(Praxis::ApiDefinition.instance).to receive(:traits).and_return(traits)
     end
 
-    its('params.attributes.keys') { should eq [:inherited, :app_name, :name, :one]}
+    its('params.attributes.keys') { should eq %i[inherited app_name name one] }
     its('route.path.to_s') { should eq '/api/foobars/hello_world/test_trait/:app_name/:one' }
     its(:traits) { should eq [:test] }
 
     it 'is reflected in the describe output' do
       expect(action.describe[:traits]).to eq [:test]
     end
-
   end
 
   describe '#params' do
@@ -129,7 +129,7 @@ describe Praxis::ActionDefinition do
       end
 
       attributes = subject.params.attributes.keys
-      expect(attributes).to match_array([:one, :inherited, :more])
+      expect(attributes).to match_array(%i[one inherited more])
     end
 
     it 'merges options (which allows overriding)' do
@@ -144,35 +144,34 @@ describe Praxis::ActionDefinition do
       before do
         action.params do
           attribute :two
-          #requires.at_most(1).of :one, :two
+          # requires.at_most(1).of :one, :two
           requires :one
         end
       end
 
-      let(:value) { {two: 2} }
+      let(:value) { { two: 2 } }
       it 'includes the requirements in the param struct type' do
         errors = action.params.load(value).validate
         expect(errors).to have(1).item
-        expect(errors.first).to match(/Key one is required/)
+        expect(errors.first).to match('Attribute $.key(:one) is required.')
       end
     end
-
   end
 
   describe '#payload' do
-    it 'defaults to being required if omitted' do
+    it 'defaults to being required and non nullable if omitted' do
       expect(subject.payload.options[:required]).to be(true)
+      expect(subject.payload.options[:null]).to be(false)
     end
 
-
     it 'merges in more payload' do
       subject.payload do
         attribute :more, Attributor::Integer
       end
 
-      expect(subject.payload.attributes.keys).to match_array([
-                                                               :two, :inherited, :more
-      ])
+      expect(subject.payload.attributes.keys).to match_array(%i[
+                                                               two inherited more
+                                                             ])
     end
 
     it 'merges options (which allows overriding)' do
@@ -199,10 +198,10 @@ describe Praxis::ActionDefinition do
 
     it 'merges in more headers' do
       subject.headers do
-        header "more"
+        header 'more'
       end
 
-      expected_array = ["X_REQUESTED_WITH", "Inherited", "more"]
+      expected_array = %w[X_REQUESTED_WITH Inherited more]
       expect(subject.headers.attributes.keys).to match_array(expected_array)
     end
 
@@ -210,7 +209,7 @@ describe Praxis::ActionDefinition do
       expect(subject.headers.options[:required]).to be(true)
 
       subject.headers required: false do
-        header "even_more"
+        header 'even_more'
       end
 
       expect(subject.headers.options[:required]).to be(false)
@@ -228,7 +227,7 @@ describe Praxis::ActionDefinition do
         expect(action.route.path.to_s).to eq '/api/clouds/:cloud_id/volumes/:volume_id/snapshots/:id'
       end
 
-      its('params.attributes'){ should have_key(:cloud_id) }
+      its('params.attributes') { should have_key(:cloud_id) }
 
       context 'with pre-existing parent param' do
         let(:action) { resource.actions[:index] }
@@ -241,7 +240,6 @@ describe Praxis::ActionDefinition do
         it { should_not be nil }
         its(:options) { should eq parent_param.options }
       end
-
     end
   end
 
@@ -276,9 +274,8 @@ describe Praxis::ActionDefinition do
 
     it 'works' do
       expansion = action.route.path.expand(cloud_id: '232', id: '2')
-      expect(expansion).to eq "/api/clouds/232/instances/2"
+      expect(expansion).to eq '/api/clouds/232/instances/2'
     end
-
   end
 
   context 'with nodoc!' do
@@ -293,16 +290,14 @@ describe Praxis::ActionDefinition do
     it 'is exposed by describe' do
       expect(action.describe[:metadata][:doc_visibility]).to be(:none)
     end
-
   end
 
   context 'with a base_path and base_params on ApiDefinition' do
     # Without getting a fresh new ApiDefinition it is very difficult to test stuff using the Singleton
     # So for some tests we're gonna create a new instance and work with it to avoid the singleton issues
     let(:non_singleton_api) do
-      api_def=Praxis::ApiDefinition.__send__(:new)
+      api_def = Praxis::ApiDefinition.__send__(:new)
       api_def.instance_eval do |api|
-
         api.info do
           base_path '/apps/:app_name'
         end
@@ -312,7 +307,6 @@ describe Praxis::ActionDefinition do
             attribute :app_name, String
           end
         end
-
       end
       api_def
     end
@@ -322,10 +316,9 @@ describe Praxis::ActionDefinition do
     end
 
     its('route.path.to_s') { should eq '/apps/:app_name/foobars/hello_world/:one' }
-    its('params.attributes.keys') { should match_array [:inherited, :app_name, :one]}
+    its('params.attributes.keys') { should match_array %i[inherited app_name one] }
 
     context 'where the action overrides a base_param' do
-
       let(:endpoint_definition) do
         Class.new do
           include Praxis::EndpointDefinition
@@ -337,7 +330,7 @@ describe Praxis::ActionDefinition do
           prefix '/foobars/hello_world'
           action_defaults do
             payload { attribute :inherited, String }
-            headers { header "Inherited", String }
+            headers { header 'Inherited', String }
           end
         end
       end
@@ -351,13 +344,11 @@ describe Praxis::ActionDefinition do
 
       subject(:attributes) { action.params.attributes }
 
-      its(:keys)  { should eq [:app_name]}
+      its(:keys) { should eq [:app_name] }
 
       it 'overrides the base param' do
         expect(attributes[:app_name].type).to eq(Attributor::Integer)
       end
-
     end
-
   end
 end