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

data/spec/spec_app/config/environment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class SetHeader
   def initialize(app, header, value)
     @app = app
@@ -8,12 +10,25 @@ class SetHeader
   def call(env)
     status, headers, body = @app.call(env)
     headers[@header] = @value
-    [status, headers,body]
+    [status, headers, body]
   end
 end
 
-Praxis::Application.configure do |application|
+class LowBudgetMutex
+  include Singleton
+
+  attr_reader :after_app_controllers
 
+  def initialize
+    @after_app_controllers = nil
+  end
+
+  def after_app_controllers_called
+    @after_app_controllers = :worked
+  end
+end
+
+Praxis::Application.configure do |application|
   application.middleware SetHeader, 'Spec-Middleware', 'used'
 
   application.bootloader.use SimpleAuthenticationPlugin, config_file: 'config/authentication.yml'
@@ -26,13 +41,12 @@ Praxis::Application.configure do |application|
 
   # Silly callback code pieces to test that the deferred callbacks work even for sub-stages
   application.bootloader.after :app, :controllers do
-    $after_app_controllers = :worked
+    LowBudgetMutex.instance.after_app_controllers_called
   end
   application.bootloader.after :app do
-    raise "After sub-stage hooks not working!" unless $after_app_controllers == :worked
+    raise 'After sub-stage hooks not working!' unless LowBudgetMutex.instance.after_app_controllers == :worked
   end
 
-
   application.layout do
     layout do
       map :initializers, 'config/initializers/**/*'
@@ -49,5 +63,4 @@ Praxis::Application.configure do |application|
       end
     end
   end
-
 end

data/spec/spec_app/config.ru

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pp'
 require 'json'
 
@@ -5,13 +7,12 @@ require 'bundler/setup'
 
 require 'pry'
 
-$:.unshift File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
 
 require 'praxis'
 
-
 application = Praxis::Application.instance
 
 application.setup
 
-run application
+run application

data/spec/spec_app/design/api.rb

@@ -1,5 +1,6 @@
-Praxis::ApiDefinition.define do
+# frozen_string_literal: true
 
+Praxis::ApiDefinition.define do
   response_template :other_response do |media_type:|
     status 200
     media_type media_type
@@ -10,33 +11,30 @@ Praxis::ApiDefinition.define do
     media_type 'multipart/form-data'
   end
 
-
-
   trait :authenticated do
     headers do
-      key "Authorization", String, required: false
+      key 'Authorization', String, required: false
     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"
+    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'
 
-    base_path "/api"
+    base_path '/api'
     produces 'json'
-    #version_with :path
-    #base_path "/v:api_version"
+    # version_with :path
+    # base_path "/v:api_version"
 
     # Custom attributes (for OpenApi, for example)
-    termsOfService "http://example.com/tos"
+    termsOfService 'http://example.com/tos'
     contact name: 'Joe', email: 'joe@email.com'
-    license name: "Apache 2.0",
-            url: "https://www.apache.org/licenses/LICENSE-2.0.html"
+    license name: 'Apache 2.0',
+            url: 'https://www.apache.org/licenses/LICENSE-2.0.html'
   end
 
   info '1.0' do # Applies to 1.0 version (and inherits everything else form the global one)
-    description "A simple 1.0 App"
+    description 'A simple 1.0 App'
   end
-
 end

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

@@ -1,19 +1,19 @@
-class Instance < Praxis::MediaType
+# frozen_string_literal: true
 
+class Instance < Praxis::MediaType
   identifier 'application/vnd.acme.instance'
 
   attributes do
     attribute :id, Integer
-    attribute :name, String, 
-      example: /[:first_name:]/,
-      regexp: /^\w+$/
+    attribute :name, String,
+              example: /[:first_name:]/,
+              regexp: /^\w+$/
 
     attribute :href, String
 
-    attribute :root_volume, Volume
+    attribute :root_volume, Volume, null: true
 
     attribute :volumes, Volume::Collection
-    
   end
 
   default_fieldset do

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Volume < Praxis::MediaType
   identifier 'application/vnd.acme.volume'
 
@@ -23,5 +25,4 @@ class Volume < Praxis::MediaType
 
     identifier 'application/vnd.acme.volumes'
   end
-
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class VolumeSnapshot < Praxis::MediaType
   identifier 'application/json'
 
@@ -26,5 +28,4 @@ class VolumeSnapshot < Praxis::MediaType
       attribute :href
     end
   end
-
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ApiResources
   class Instances
     include Praxis::EndpointDefinition
@@ -28,8 +30,8 @@ module ApiResources
 
       headers do
         # BOTH ARE EQUIVALENT
-        #key "FOO", String, required: true
-        header "FOO", /bar/
+        # key "FOO", String, required: true
+        header 'FOO', /bar/
         key 'Account-Id', Integer, required: false, min: 0
       end
 
@@ -37,7 +39,6 @@ module ApiResources
         attribute :response_content_type, String, default: 'application/vnd.acme.instance;type=collection'
       end
 
-
       response :ok, Praxis::Collection.of(Instance)
     end
 
@@ -57,13 +58,12 @@ module ApiResources
         attribute :create_identity_map, Attributor::Boolean, default: false
       end
 
-      payload required: false do
+      payload required: false, null: true do
         attribute :something, String
-        attribute :optional, String, default: "not given"
+        attribute :optional, String, default: 'not given'
       end
     end
 
-
     action :bulk_create do
       routing do
         post ''
@@ -77,11 +77,11 @@ module ApiResources
       response :multipart_ok, Praxis::Types::MultipartArray do
         name_type Integer
 
-        part /\d+/ do
+        part(/\d+/) do
           header 'Status', '201'
           header 'Content-Type', /^#{Instance.identifier}/
           header 'Location', Attributor::URI,
-            example: proc { |part| ApiResources::Instances.to_href(cloud_id: part[:value].cloud_id, id: part[:value].id) }
+                 example: proc { |part| ApiResources::Instances.to_href(cloud_id: part[:value].cloud_id, id: part[:value].id) }
 
           payload Hash do
             attribute :key, Integer, required: true
@@ -90,16 +90,14 @@ module ApiResources
               attribute :name
             end
           end
-
         end
       end
 
-
       # Using a hash param for parts
-      #response :multipart_ok, parts: {
+      # response :multipart_ok, parts: {
       #  like: :created,
       #  location: /\/instances\//
-      #}
+      # }
 
       # Using a block for parts to defin a sub-request
       #     sub_request = proc do
@@ -140,7 +138,7 @@ module ApiResources
         attribute :id
       end
 
-      payload required: false do
+      payload required: false, null: true do
         attribute :when, DateTime
       end
 
@@ -157,7 +155,6 @@ module ApiResources
         attribute :id
       end
 
-
       response :ok, media_type: 'application/json'
     end
 
@@ -178,7 +175,6 @@ module ApiResources
       response :ok
     end
 
-
     action :exceptional do
       routing do
         prefix '//clouds/:cloud_id/otherinstances'
@@ -229,7 +225,5 @@ module ApiResources
     #     key 'destination', String, required: true
     #     match /file-.+/, FileUpload
     #   end
-
   end
-
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'volumes'
 
 module ApiResources
@@ -7,8 +9,8 @@ module ApiResources
     media_type VolumeSnapshot
 
     version '1.0'
-    
-    parent Volumes, :id => :volume_id
+
+    parent Volumes, id: :volume_id
     prefix '/snapshots'
 
     action :index do
@@ -21,7 +23,6 @@ module ApiResources
       params do
         attribute :volume_id, Integer, description: 'id of parent volume'
       end
-
     end
 
     action :show do
@@ -32,8 +33,6 @@ module ApiResources
       params do
         attribute :id
       end
-      
     end
-
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ApiResources
   class Volumes
     include Praxis::EndpointDefinition
@@ -7,10 +9,10 @@ module ApiResources
     prefix '/clouds/:cloud_id/volumes'
 
     trait :authenticated
-  
+
     action_defaults do
       params do
-        attribute :cloud_id, Integer, description: "id of the cloud"
+        attribute :cloud_id, Integer, description: 'id of the cloud'
       end
     end
 
@@ -35,9 +37,6 @@ module ApiResources
         attribute :junk, String, default: ''
         attribute :some_date, DateTime, default: DateTime.parse('2012-12-21')
       end
-      
     end
-
   end
-
 end

data/spec/spec_helper.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'coveralls'
 Coveralls.wear!
 
-$:.unshift File.expand_path(__dir__)
-$:.unshift File.expand_path('../lib',__dir__)
-$:.unshift File.expand_path('support',__dir__)
+$LOAD_PATH.unshift File.expand_path(__dir__)
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift File.expand_path('support', __dir__)
 
 require 'bundler'
 Bundler.setup :default, :test
@@ -13,9 +15,6 @@ RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
 end
 
-require 'simplecov'
-SimpleCov.start 'praxis'
-
 require 'pry'
 require 'pry-byebug'
 
@@ -26,17 +25,17 @@ require 'rack/test'
 require 'rspec/its'
 require 'rspec/collection_matchers'
 
-Dir["#{File.dirname(__FILE__)}/../lib/praxis/plugins/*.rb"].each do |file|
+Dir["#{File.dirname(__FILE__)}/../lib/praxis/plugins/*.rb"].sort.each do |file|
   require file
 end
 
-
-Dir["#{File.dirname(__FILE__)}/support/*.rb"].each do |file|
+Dir["#{File.dirname(__FILE__)}/support/*.rb"].sort.each do |file|
   require file
 end
 
 def suppress_output
-  original_stdout, original_stderr = $stdout.clone, $stderr.clone
+  original_stdout = $stdout.clone
+  original_stderr = $stderr.clone
   $stderr.reopen File.new('/dev/null', 'w')
   $stdout.reopen File.new('/dev/null', 'w')
   yield
@@ -51,12 +50,12 @@ RSpec.configure do |config|
   config.before(:suite) do
     Praxis::Mapper::Resource.finalize!
     Praxis::Blueprint.caching_enabled = true
-    Praxis::Application.instance.setup(root:'spec/spec_app')
+    Praxis::Application.instance.setup(root: 'spec/spec_app')
   end
 
   config.before(:each) do
     Praxis::Blueprint.cache = Hash.new do |hash, key|
-      hash[key] = Hash.new
+      hash[key] = {}
     end
   end
 
@@ -65,4 +64,3 @@ RSpec.configure do |config|
     Praxis::Application.instance.logger.level = 2 # warn
   end
 end
-

data/spec/support/be_deep_equal_matcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copied verbatim from: https://github.com/amogil/rspec-deep-ignore-order-matcher
 
 RSpec::Matchers.define :be_deep_equal do |expected|
@@ -18,6 +20,7 @@ RSpec::Matchers.define :be_deep_equal do |expected|
   def match?(actual, expected)
     return arrays_match?(actual, expected) if expected.is_a?(Array) && actual.is_a?(Array)
     return hashes_match?(actual, expected) if expected.is_a?(Hash) && actual.is_a?(Hash)
+
     expected == actual
   end
 
@@ -26,6 +29,7 @@ RSpec::Matchers.define :be_deep_equal do |expected|
     actual.each do |a|
       index = exp.find_index { |e| match? a, e }
       return false if index.nil?
+
       exp.delete_at(index)
     end
     exp.empty?
@@ -33,6 +37,7 @@ RSpec::Matchers.define :be_deep_equal do |expected|
 
   def hashes_match?(actual, expected)
     return false unless actual.keys.sort == expected.keys.sort
+
     actual.each { |key, value| return false unless match? value, expected[key] }
     true
   end

data/spec/support/spec_authorization_plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'singleton'
 
 module AuthorizationPlugin
@@ -11,7 +13,8 @@ module AuthorizationPlugin
     end
 
     def initialize
-      @options = {config_file: 'config/authorization.yml'}
+      super
+      @options = { config_file: 'config/authorization.yml' }
     end
 
     def prepare_config!(node)
@@ -30,7 +33,6 @@ module AuthorizationPlugin
 
       (request.action.required_abilities - abilities).empty?
     end
-
   end
 
   module Request
@@ -43,33 +45,27 @@ module AuthorizationPlugin
     extend ActiveSupport::Concern
 
     included do
-
       before :action do |controller|
         verify_abilities(controller.request)
       end
-
     end
 
-
     module ClassMethods
       def verify_abilities(request)
         return true unless request.action.required_abilities
 
         authorized = AuthorizationPlugin::Plugin.instance.authorized?(request)
 
-        unless authorized
-          return Praxis::Responses::Forbidden.new
-        end
+        return Praxis::Responses::Forbidden.new unless authorized
       end
     end
 
     def subject
-      #p [self, :subject]
+      # p [self, :subject]
     end
   end
 
   module EndpointDefinition
-
   end
 
   module ActionDefinition
@@ -77,6 +73,7 @@ module AuthorizationPlugin
 
     included do
       attr_accessor :required_abilities
+
       decorate_docs do |action, docs|
         docs[:required_abilities] = action.required_abilities
       end
@@ -90,6 +87,4 @@ module AuthorizationPlugin
       requires_authentication true
     end
   end
-
-
 end

data/spec/support/spec_blueprints.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class PersonBlueprint < Praxis::Blueprint
   attributes do
     attribute :name, String, example: /[:first_name:]/
@@ -9,8 +10,8 @@ class PersonBlueprint < Praxis::Blueprint
     attribute :full_name, FullName
     attribute :aliases, Attributor::Collection.of(FullName)
 
-    attribute :address, AddressBlueprint, example: proc { |person, context| AddressBlueprint.example(context, resident: person) }
-    attribute :work_address, AddressBlueprint
+    attribute :address, AddressBlueprint, null: true, example: proc { |person, context| AddressBlueprint.example(context, resident: person) }
+    attribute :work_address, AddressBlueprint, null: true
 
     attribute :prior_addresses, Attributor::Collection.of(AddressBlueprint)
     attribute :parents do
@@ -21,7 +22,7 @@ class PersonBlueprint < Praxis::Blueprint
     attribute :tags, Attributor::Collection.of(String)
     attribute :href, String
     attribute :alive, Attributor::Boolean, default: true
-    attribute :myself, PersonBlueprint
+    attribute :myself, PersonBlueprint, null: true
     attribute :friends, Attributor::Collection.of(PersonBlueprint)
     attribute :metadata, Attributor::Hash
   end
@@ -44,7 +45,7 @@ class AddressBlueprint < Praxis::Blueprint
     attribute :id, Integer
     attribute :name, String
     attribute :street, String
-    attribute :state, String, values: %w(OR CA)
+    attribute :state, String, values: %w[OR CA]
 
     attribute :resident, PersonBlueprint, example: proc { |address, context| PersonBlueprint.example(context, address: address) }
   end

data/spec/support/spec_complex_authentication_plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'singleton'
 
 class Authenticator
@@ -7,7 +9,7 @@ class Authenticator
     Class
   end
 
-  def self.load(value,context=Attributor::DEFAULT_ROOT_CONTEXT, **options)
+  def self.load(value, _context = Attributor::DEFAULT_ROOT_CONTEXT, **_options)
     case value
     when Hash
       type = value.delete(:type) || value.delete('type')
@@ -15,43 +17,32 @@ class Authenticator
     when self
       value
     else
-      raise "#{self.naem} can not load values of type #{value.class}"
+      raise "#{naem} can not load values of type #{value.class}"
     end
   end
 
-  def self.validate(*args)
-  end
+  def self.validate(*args); end
 
-  def self.describe
-  end
-
-  def initialize(**options)
-  end
+  def self.describe; end
 
-  def authenticate(request)
-    raise "sublcass must implement authenticate"
+  def authenticate(_request)
+    raise 'sublcass must implement authenticate'
   end
-
 end
 
-
 class GlobalSessionAuthenticator < Authenticator
-
-  def self.load(value,context=Attributor::DEFAULT_ROOT_CONTEXT, **options)
-    self.new(**value)
-  end
-
-  def self.describe
+  def self.load(value, _context = Attributor::DEFAULT_ROOT_CONTEXT, **_options)
+    new(**value)
   end
 
-  def initialize(**options)
-  end
+  def self.describe; end
 
   def authenticate(request)
-    body = {name: 'Unauthorized'}
+    body = { name: 'Unauthorized' }
 
     if (session = request.env['global_session'])
       return true if session.valid?
+
       body[:message] = 'Invalid session.'
     else
       body[:message] = 'Missing session.'
@@ -59,10 +50,8 @@ class GlobalSessionAuthenticator < Authenticator
 
     Praxis::Responses::Unauthorized.new(body: body)
   end
-
 end
 
-
 module ComplexAuthenticationPlugin
   include Praxis::PluginConcern
 
@@ -70,24 +59,23 @@ module ComplexAuthenticationPlugin
     include Singleton
 
     def initialize
-      @options = {config_file: 'config/authentication.yml'}
+      @options = { config_file: 'config/authentication.yml' }
+      super
     end
 
     def config_key
       :authentication
     end
 
-    def prepare_config!(node)
+    def prepare_config!(_node)
       self.config_attribute = Attributor::Attribute.new(Authenticator, required: true)
     end
 
     def self.authenticate(request)
       instance.config.authenticate(request)
     end
-
   end
 
-
   module Request
   end
 
@@ -96,15 +84,11 @@ module ComplexAuthenticationPlugin
 
     included do
       before :action do |controller|
-        if controller.request.action.authentication_required
-          Plugin.authenticate(controller.request)
-        end
+        Plugin.authenticate(controller.request) if controller.request.action.authentication_required
       end
     end
-
   end
 
-
   module ActionDefinition
     extend ActiveSupport::Concern
 
@@ -121,6 +105,5 @@ module ComplexAuthenticationPlugin
     def authentication_required
       @authentication_required ||= false
     end
-
   end
 end