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

data/spec/praxis/trait_spec.rb

@@ -1,7 +1,8 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+# frozen_string_literal: true
 
-describe Praxis::Trait do
+require File.expand_path("#{File.dirname(__FILE__)}/../spec_helper")
 
+describe Praxis::Trait do
   subject(:trait) do
     Praxis::Trait.new do
       description 'my awesome trait'
@@ -19,14 +20,13 @@ describe Praxis::Trait do
       end
       params do
         attribute :order, String,
-          description: "Field to sort by."
+                  description: 'Field to sort by.'
       end
 
       headers do
-        header "Authorization"
-        key "Header2", String, required: true
+        header 'Authorization'
+        key 'Header2', String, required: true, null: false
       end
-
     end
   end
 
@@ -35,24 +35,24 @@ describe Praxis::Trait do
 
     its([:description]) { should eq('my awesome trait') }
 
-    its([:responses, :something]) { should eq Hash.new }
-    its([:responses, :nothing]) { should eq Hash.new }
+    its(%i[responses something]) { should eq({}) }
+    its(%i[responses nothing]) { should eq({}) }
 
-    its([:params, :app_name, :type, :name]) { should eq 'String' }
-    its([:params, :order, :type, :name]) { should eq 'String' }
-    its([:routing, :prefix]) { should eq '/:app_name'}
+    its(%i[params app_name type name]) { should eq 'String' }
+    its(%i[params order type name]) { should eq 'String' }
+    its(%i[routing prefix]) { should eq '/:app_name' }
 
-    its([:headers, "Header2"]) { should include({required: true}) }
+    its([:headers, 'Header2']) { should include({ required: true, null: false }) }
     context 'using the special DSL syntax for headers' do
-      subject(:dsl_header) { describe[:headers]["Authorization"] }
-      its([:required]){ should be(true) }
-      its([:type]){ should eq( { :id=>"Attributor-String", :name=>"String", :family=>"string"} )}
+      subject(:dsl_header) { describe[:headers]['Authorization'] }
+      its([:required]) { should be(true) }
+      its([:null]) { should be_nil }
+      its([:type]) { should eq({ id: 'Attributor-String', name: 'String', family: 'string' }) }
     end
-
   end
 
   context 'apply!' do
-    let(:target) { double("Target") }
+    let(:target) { double('Target') }
     it 'does' do
       expect(target).to receive(:routing).once
       expect(target).to receive(:response).twice

data/spec/praxis/types/fuzzy_hash_spec.rb

@@ -1,20 +1,22 @@
-require "spec_helper"
+# frozen_string_literal: true
 
-describe Praxis::Types::FuzzyHash do
+require 'spec_helper'
 
-  let(:initial_value) {{
-    'key' => 'value',
-    /bob/ => 'rob',
-    /\d+/ => 'one'
-  }}
+describe Praxis::Types::FuzzyHash do
+  let(:initial_value) do
+    {
+      'key' => 'value',
+      /bob/ => 'rob',
+      /\d+/ => 'one'
+    }
+  end
 
   subject(:hash) { Praxis::Types::FuzzyHash.new(initial_value) }
 
   its(['key']) { should eq 'value' }
   its([/bob/]) { should eq 'rob' }
   its(['bobby']) { should eq 'rob' }
-  
+
   its([1]) { should eq 'one' }
   its(['1']) { should eq 'one' }
 end
-

data/spec/praxis/types/multipart_array/part_definition_spec.rb

@@ -1,5 +1,6 @@
-require "spec_helper"
+# frozen_string_literal: true
+
+require 'spec_helper'
 
 describe Praxis::Types::MultipartArray::PartDefinition do
 end
-

data/spec/praxis/types/multipart_array_spec.rb

@@ -1,15 +1,16 @@
-require "spec_helper"
+# frozen_string_literal: true
 
-describe Praxis::Types::MultipartArray do
+require 'spec_helper'
 
+describe Praxis::Types::MultipartArray do
   let(:type) do
     Class.new(Praxis::Types::MultipartArray) do
-      self.options[:case_insensitive_load] = true
+      options[:case_insensitive_load] = true
 
       part 'title', String, required: true
       part(/nam/, String, regexp: /Bob/i)
 
-      part /stuff/ do
+      part(/stuff/) do
         payload Hash
       end
 
@@ -22,33 +23,31 @@ describe Praxis::Types::MultipartArray do
       file 'thumbnail', Attributor::Tempfile
 
       part 'image', Attributor::Tempfile, filename: true
-
     end
   end
 
-
   let(:form) do
     form_data = MIME::Multipart::FormData.new
     entity = MIME::Text.new('Bob')
-    form_data.add entity,'name'
+    form_data.add entity, 'name'
 
     entity = MIME::Text.new('Captain')
-    form_data.add entity,'title'
+    form_data.add entity, 'title'
 
     entity = MIME::Application.new('file1')
-    form_data.add entity,'files', 'file1'
+    form_data.add entity, 'files', 'file1'
 
     entity = MIME::Application.new('file2')
-    form_data.add entity,'files', 'file2'
+    form_data.add entity, 'files', 'file2'
 
     entity = MIME::Application.new('{"first_name": "Frank"}', 'json')
-    form_data.add entity,'stuff2'
+    form_data.add entity, 'stuff2'
 
     entity = MIME::Application.new('SOMEBINARYDATA', 'jpg')
-    form_data.add entity,'thumbnail', 'thumb.jpg'
+    form_data.add entity, 'thumbnail', 'thumb.jpg'
 
     entity = MIME::Application.new('', 'jpg')
-    form_data.add entity,'image', 'image.jpg'
+    form_data.add entity, 'image', 'image.jpg'
 
     form_data
   end
@@ -59,7 +58,6 @@ describe Praxis::Types::MultipartArray do
   subject(:payload) { type.load(body, content_type: content_type) }
 
   it 'validates' do
-    part = payload.part('files').first
     expect(payload.validate).to be_empty
   end
 
@@ -94,9 +92,9 @@ describe Praxis::Types::MultipartArray do
       end
     end
 
-    let(:json_payload) { {sub_hash: {key:'value'}}.to_json }
+    let(:json_payload) { { sub_hash: { key: 'value' } }.to_json }
     let(:body) { StringIO.new("--boundary\r\nContent-Disposition: form-data; name=blah\r\n\r\n#{json_payload}\r\n--boundary--") }
-    let(:content_type) { "multipart/form-data; boundary=boundary" }
+    let(:content_type) { 'multipart/form-data; boundary=boundary' }
 
     it do
       expect(payload.part('blah').payload['sub_hash']).to eq('key' => 'value')
@@ -117,9 +115,9 @@ describe Praxis::Types::MultipartArray do
       end
     end
 
-    let(:json_payload) { {attr: 'value'}.to_json }
+    let(:json_payload) { { attr: 'value' }.to_json }
     let(:body) { StringIO.new("--boundary\r\nContent-Disposition: form-data; name=blah\r\n\r\n#{json_payload}\r\n--boundary--") }
-    let(:content_type) { "multipart/form-data; boundary=boundary" }
+    let(:content_type) { 'multipart/form-data; boundary=boundary' }
 
     it do
       expect(payload.part('blah').payload.class.ancestors).to include(Attributor::Struct)
@@ -142,7 +140,7 @@ describe Praxis::Types::MultipartArray do
 
     context 'attributes' do
       subject(:attributes) { description[:attributes] }
-      its(:keys) { should match_array ['title', 'files', 'thumbnail', 'image']}
+      its(:keys) { should match_array %w[title files thumbnail image] }
 
       context 'the "title" part' do
         subject(:title_description) { attributes['title'] }
@@ -172,14 +170,12 @@ describe Praxis::Types::MultipartArray do
           expect(filename[:options]).to eq(regexp: /file/)
           expect(filename[:type]).to eq Attributor::String.describe
         end
-
       end
-
     end
 
     context 'pattern attributes' do
       subject(:pattern_attributes) { description[:pattern_attributes] }
-      its(:keys) { should match_array ['nam', 'stuff']}
+      its(:keys) { should match_array %w[nam stuff] }
     end
 
     context 'with no parts defined' do
@@ -226,17 +222,16 @@ describe Praxis::Types::MultipartArray do
     subject(:dumped) { payload.dump }
 
     it 'dumps' do
-      loaded = type.load(dumped, content_type: payload.content_type)
+      type.load(dumped, content_type: payload.content_type)
     end
     context 'an example' do
       let(:payload) { type.example }
 
       it 'dumps' do
-        loaded = type.load(dumped, content_type: payload.content_type)
+        type.load(dumped, content_type: payload.content_type)
       end
     end
 
-
     context 'with default_format' do
       let(:type) do
         Class.new(Praxis::Types::MultipartArray) do
@@ -267,7 +262,7 @@ describe Praxis::Types::MultipartArray do
 
       let(:output) { example.dump(default_format: default_format) }
 
-      let(:parts) { Praxis::MultipartParser.parse({'Content-Type'=>example.content_type}, output).last }
+      let(:parts) { Praxis::MultipartParser.parse({ 'Content-Type' => example.content_type }, output).last }
 
       it 'dumps the parts with the proper handler' do
         json_handler = Praxis::Application.instance.handlers['json']
@@ -290,9 +285,7 @@ describe Praxis::Types::MultipartArray do
           expect(instance.payload).to eq json_handler.generate(example.part('instances')[i].payload.dump)
         end
       end
-
     end
-
   end
 
   context 'with errors' do
@@ -300,11 +293,10 @@ describe Praxis::Types::MultipartArray do
       form_data = MIME::Multipart::FormData.new
 
       entity = MIME::Text.new('James')
-      form_data.add entity,'name'
-
+      form_data.add entity, 'name'
 
       entity = MIME::Text.new('file1')
-      form_data.add entity,'files', 'file1'
+      form_data.add entity, 'files', 'file1'
 
       form_data
     end
@@ -314,10 +306,10 @@ describe Praxis::Types::MultipartArray do
     it 'validates part headers' do
       expect(errors).to have(3).items
       expect(errors).to match_array([
-                                      %r|\.name\.payload value .* does not match regexp|,
-                                      %r|\.files\.headers.* is not within the allowed values|,
-                                      %r|\.title is required|
-      ])
+                                      /\.name\.payload value .* does not match regexp/,
+                                      /\.files\.headers.* is not within the allowed values/,
+                                      /\.title is required/
+                                    ])
     end
   end
 
@@ -327,14 +319,14 @@ describe Praxis::Types::MultipartArray do
     it 'generates parts' do
       title = payload.part('title')
       expect(title).to_not be_nil
-      expect(title.payload).to match /\w+/
+      expect(title.payload).to match(/\w+/)
 
       files = payload.part('files')
       expect(files).to have(2).items
 
       files.each do |file|
         expect(file.payload).to be_kind_of(Tempfile)
-        expect(file.filename).to match /\w+/
+        expect(file.filename).to match(/\w+/)
 
         expect(file.headers['Content-Type']).to eq 'application/octet-stream'
       end
@@ -343,15 +335,14 @@ describe Praxis::Types::MultipartArray do
     it 'is valid' do
       expect(payload.validate).to have(0).items
     end
-
   end
 
   context 'with a hackish default part definition' do
     let(:type) do
       Class.new(Praxis::Types::MultipartArray) do
-        self.options[:case_insensitive_load] = true
+        options[:case_insensitive_load] = true
 
-        part /\d+/, Instance
+        part(/\d+/, Instance)
       end
     end
 
@@ -362,7 +353,7 @@ describe Praxis::Types::MultipartArray do
         instance = Instance.example("instance-#{i}")
         body = JSON.pretty_generate(instance.render)
         entity = MIME::Text.new(body)
-        form_data.add entity,i.to_s
+        form_data.add entity, i.to_s
       end
 
       form_data
@@ -373,10 +364,8 @@ describe Praxis::Types::MultipartArray do
         expect(part.payload).to be_kind_of(Instance)
       end
     end
-
   end
 
-
   context 'anonymous generation' do
     let(:definition_block) do
       proc do
@@ -396,7 +385,7 @@ describe Praxis::Types::MultipartArray do
         instance = Instance.example("instance-#{i}")
         body = JSON.pretty_generate(instance.render)
         entity = MIME::Text.new(body)
-        form_data.add entity,i.to_s
+        form_data.add entity, i.to_s
       end
 
       form_data
@@ -411,9 +400,5 @@ describe Praxis::Types::MultipartArray do
         expect(part.payload).to be_kind_of(Instance)
       end
     end
-
-
   end
-
-
 end

data/spec/spec_app/app/concerns/authenticated.rb

@@ -1,15 +1,15 @@
+# frozen_string_literal: true
+
 module Concerns
   module Authenticated
     extend ActiveSupport::Concern
     include Praxis::Callbacks
-    
+
     included do
       before :action do |controller|
         auth_data = controller.request.headers['Authorization']
-        if auth_data && auth_data !~ /secret/ 
-          Praxis::Responses::Unauthorized.new(body: 'Authentication info is invalid')
-        end
+        Praxis::Responses::Unauthorized.new(body: 'Authentication info is invalid') if auth_data && auth_data !~ /secret/
       end
     end
   end
-end
+end

data/spec/spec_app/app/concerns/basic_api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'authenticated'
 require_relative 'log_wrapper'
 
@@ -9,4 +11,4 @@ module Concerns
     include Concerns::Authenticated
     include Concerns::LogWrapper
   end
-end
+end

data/spec/spec_app/app/concerns/log_wrapper.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 module Concerns
   module LogWrapper
     extend ActiveSupport::Concern
     include Praxis::Callbacks
-    
+
     included do
-      before :around do |controller, callee|
+      before :around do |_controller, callee|
         # Log something at the beginning
         callee.call
         # Log something at the end
       end
     end
   end
-end
+end

data/spec/spec_app/app/controllers/base_class.rb

@@ -1,14 +1,15 @@
+# frozen_string_literal: true
+
 class BaseClass
   # Do NOT use a controller inherited base class to add concerns!
   # If you do that, you'd be sharing state (i.e. overriding/adding) from  concerns across controllers
   # which will probably lead to sharing issues you didn't expect.
   # For example: any controller adding after/before/around filters will be visible
   # to any other controllers sharing the concern.
-  # Include a concern to all of them instead 
-  
+  # Include a concern to all of them instead
+
   # Inheritance of classes should be independent from the concerns.
   # I.e., you can use class inheritance in cases where it makes sense from an OO point of view
   # but for the most part, you can probably share code through modules/concerns too.
-  def this_is_shared
-  end
-end
+  def this_is_shared; end
+end

data/spec/spec_app/app/controllers/instances.rb

@@ -1,59 +1,57 @@
+# frozen_string_literal: true
+
 class Instances < BaseClass
   include Praxis::Controller
 
   implements ApiResources::Instances
   include Concerns::BasicApi
 
-  before :validate, actions: [:index]  do |controller|
-    #p [:before, :validate, :params_and_headers, controller.request.action.name]
+  before :validate, actions: [:index] do |controller|
+    # p [:before, :validate, :params_and_headers, controller.request.action.name]
   end
 
   before actions: [:show] do |controller|
-    #puts "before action"
-    if controller.request.params.fail_filter
-      Praxis::Responses::Unauthorized.new
-    end
+    # puts "before action"
+    Praxis::Responses::Unauthorized.new if controller.request.params.fail_filter
   end
 
-  around :validate, actions: [:show] do |controller, blk|
-    #puts "Before validate decorator (for show)"
+  around :validate, actions: [:show] do |_controller, blk|
+    # puts "Before validate decorator (for show)"
     blk.call
-    #puts "After validate decorator"
+    # puts "After validate decorator"
   end
 
-  around :action do |controller, blk|
-    #puts "Decorator one (all actions) start"
+  around :action do |_controller, blk|
+    # puts "Decorator one (all actions) start"
     blk.call
-    #puts "Decorator one end"
+    # puts "Decorator one end"
   end
 
-  around :action, actions: [:show] do |controller, blk|
-    #puts "Decorator two (show action) start"
+  around :action, actions: [:show] do |_controller, blk|
+    # puts "Decorator two (show action) start"
     blk.call
-    #puts "Decorator two end"
+    # puts "Decorator two end"
   end
 
-  around :action, actions: [:index] do |controller, blk|
-    #puts "Decorator three (index action) start"
+  around :action, actions: [:index] do |_controller, blk|
+    # puts "Decorator three (index action) start"
     blk.call
-    #puts "Decorator three end"
+    # puts "Decorator three end"
   end
 
-  def index(cloud_id:, response_content_type: 'application/vnd.acme.instance;type=collection', **params)
+  def index(response_content_type: 'application/vnd.acme.instance;type=collection', **_params)
     instances = Instance::Collection.example
-    response.body = JSON.pretty_generate(instances.collect { |i| i.render })
-    response.headers['Content-Type'] = response_content_type #'application/vnd.acme.instance;type=collection'
+    response.body = JSON.pretty_generate(instances.collect(&:render))
+    response.headers['Content-Type'] = response_content_type # 'application/vnd.acme.instance;type=collection'
     response
   end
 
   def show(cloud_id:, id:, junk:, create_identity_map:, **other_params)
-    if create_identity_map
-      request.identity_map
-    end
+    request.identity_map if create_identity_map
 
     payload = request.payload
 
-    response.body = {cloud_id: cloud_id, id: id, junk: junk, other_params: other_params, payload: payload && payload.dump}
+    response.body = { cloud_id: cloud_id, id: id, junk: junk, other_params: other_params, payload: payload && payload.dump }
     response.headers['Content-Type'] = 'application/json'
     response
   end
@@ -68,12 +66,12 @@ class Instances < BaseClass
 
       part_body = {
         key: instance_id,
-        value: instance.render(fields: {id: true, name: true})
+        value: instance.render(fields: { id: true, name: true })
       }
 
       headers = {
         'Status' => '201',
-        'Content-Type' => (Instance.identifier + '+json').to_s,
+        'Content-Type' => "#{Instance.identifier}+json".to_s,
         'Location' => definition.to_href(cloud_id: cloud_id, id: instance.id)
       }
 
@@ -84,14 +82,13 @@ class Instances < BaseClass
     response
   end
 
-
-  def attach_file(id:, cloud_id:)
+  def attach_file(*)
     response.headers['Content-Type'] = 'application/json'
 
     destination_path = request.payload.part('destination_path').payload
     file = request.payload.part('file')
     file.payload.rewind # Ensure contents is at the beggining.
-    extra_part_names = request.payload.map(&:name) - ['destination_path', 'file']
+    extra_part_names = request.payload.map(&:name) - %w[destination_path file]
     extra_parts = extra_part_names.each_with_object({}) do |pname, hash|
       hash[pname] = request.payload.part(pname).body
     end
@@ -109,23 +106,23 @@ class Instances < BaseClass
     response
   end
 
-  def terminate(id:, cloud_id:)
+  def terminate(*)
     response.headers['Content-Type'] = 'application/json'
     response
   end
 
-  def stop(id:, cloud_id:)
+  def stop(*)
     response.headers['Content-Type'] = 'application/json'
     response
   end
 
-  def update(id:, cloud_id:)
+  def update(*)
     response.body = JSON.pretty_generate(request.payload.dump)
     response.headers['Content-Type'] = 'application/vnd.acme.instance'
     response
   end
 
-  def exceptional(cloud_id:, splat:)
+  def exceptional(*)
     response.headers['Content-Type'] = 'application/json'
     response
   end

data/spec/spec_app/app/controllers/volumes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Volumes < BaseClass
   include Praxis::Controller
 
@@ -5,22 +7,20 @@ class Volumes < BaseClass
   include Concerns::BasicApi
 
   before actions: [:show] do |controller|
-    #puts "before action for volumes"
+    # puts "before action for volumes"
   end
 
   def index
     volumes = Volume::Collection.example
-    
-    response.body = volumes.collect { |v| v.render }
+
+    response.body = volumes.collect(&:render)
     response.headers['Content-Type'] = 'application/vnd.acme.volumes'
     response
   end
 
-  def show(id:, **other_params)
+  def show(*)
     response.body = JSON.pretty_generate(Volume.example.render)
     response.headers['Content-Type'] = 'application/vnd.acme.volume'
     response
   end
-
-
 end

data/spec/spec_app/app/responses/multipart.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 class MultipartResponse < Praxis::Response
   self.response_name = :multipart
@@ -5,6 +6,4 @@ class MultipartResponse < Praxis::Response
   def handle
     @status = 200
   end
-
 end
-

data/spec/spec_app/app/responses/other_response.rb

@@ -1,6 +1,6 @@
+# frozen_string_literal: true
+
 class OtherResponse < Praxis::Response
   self.response_name = :other_response
   self.status = 200
-
 end
-