praxis 2.0.pre.18 → 2.0.pre.19

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:]/
@@ -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

data/spec/support/spec_endpoint_definitions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'spec_media_types'
 
 Praxis::ApiDefinition.define do
@@ -37,10 +39,8 @@ class PeopleResource
       attribute :id, Integer, required: true
     end
   end
-
 end
 
-
 class AddressResource
   include Praxis::EndpointDefinition
 
@@ -68,5 +68,4 @@ class AddressResource
       attribute :id, Integer, required: true
     end
   end
-
 end

data/spec/support/spec_media_types.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'praxis/extensions/field_selection'
 class Person < Praxis::MediaType
-  identifier "application/vnd.acme.person"
+  identifier 'application/vnd.acme.person'
 
   attributes do
     attribute :id, Integer
@@ -13,7 +15,6 @@ class Person < Praxis::MediaType
     attribute :name
   end
 
-
   class CollectionSummary < Praxis::MediaType
     attributes do
       attribute :href, String
@@ -23,11 +24,9 @@ class Person < Praxis::MediaType
     default_fieldset do
       attribute :href
     end
-
   end
 end
 
-
 class Address < Praxis::MediaType
   identifier 'application/json'
 
@@ -55,26 +54,23 @@ class Address < Praxis::MediaType
   end
 end
 
-
-
-
 class Blog < Praxis::MediaType
   identifier 'application/vnd.bloggy.blog'
-  description "A Bloggy Blog"
+  description 'A Bloggy Blog'
 
   attributes do
     attribute :id, Integer,
-      description: 'Unique identifier'
+              description: 'Unique identifier'
     attribute :name, String,
-      description: 'Short name'
+              description: 'Short name'
     attribute :href, String,
-      example: proc {|o,ctx| "/api/v1.0/blogs/#{o.id}"},
-      description: 'Href for use with this API'
+              example: proc { |o, _ctx| "/api/v1.0/blogs/#{o.id}" },
+              description: 'Href for use with this API'
     attribute :description, String,
-      description: 'Longer description'
+              description: 'Longer description'
     attribute :url, String,
-      example: proc {|o,ctx| "example.com/blogs/#{o.id}"},
-      description: 'URL for a web browser'
+              example: proc { |o, _ctx| "example.com/blogs/#{o.id}" },
+              description: 'URL for a web browser'
 
     attribute :timestamps do
       attribute :created_at, DateTime
@@ -82,17 +78,16 @@ class Blog < Praxis::MediaType
     end
 
     attribute :tags, Attributor::Collection.of(String),
-      description: 'Array of tags'
+              description: 'Array of tags'
 
     attribute :recent_posts, Praxis::Collection.of(Post),
-      description: 'Array of recent related Post resources'
+              description: 'Array of recent related Post resources'
     attribute :owner, User,
-      description: 'Related User resource'
+              description: 'Related User resource'
 
     attribute :posts_summary, Post::CollectionSummary,
-      example: proc { |blog,ctx| Post::CollectionSummary.example(ctx, href: "#{blog.href}/posts") },
-      description: "Summary of information from related Post resources"
-
+              example: proc { |blog, ctx| Post::CollectionSummary.example(ctx, href: "#{blog.href}/posts") },
+              description: 'Summary of information from related Post resources'
   end
 
   default_fieldset do
@@ -107,7 +102,6 @@ class Blog < Praxis::MediaType
   end
 end
 
-
 class Post < Praxis::MediaType
   identifier 'application/vnd.bloggy.post'
 
@@ -115,23 +109,23 @@ class Post < Praxis::MediaType
 
   attributes do
     attribute :id, Integer,
-      description: 'Unique identifier'
+              description: 'Unique identifier'
     attribute :href, String,
-      example: proc {|o,ctx| "/api/v1.0/posts/#{o.id}"},
-      description: 'Href for use with this API'
+              example: proc { |o, _ctx| "/api/v1.0/posts/#{o.id}" },
+              description: 'Href for use with this API'
 
     attribute :title, String,
-      example: /\w+/
+              example: /\w+/
     attribute :content, String,
-      example: /[:sentence:]{4,5}/
+              example: /[:sentence:]{4,5}/
     attribute :url, String,
-      description: 'URL for a web browser',
-      example: proc {|o,ctx| "example.com/posts/#{o.id}"}
+              description: 'URL for a web browser',
+              example: proc { |o, _ctx| "example.com/posts/#{o.id}" }
 
     attribute :author, User,
-      description: 'Related User resource'
+              description: 'Related User resource'
     attribute :blog, Blog,
-      description: 'Related Blog resource'
+              description: 'Related Blog resource'
 
     attribute :followup_posts, Attributor::Collection.of(Post)
 
@@ -161,21 +155,20 @@ class Post < Praxis::MediaType
   end
 end
 
-
 class User < Praxis::MediaType
   identifier 'application/vnd.bloggy.user'
 
   attributes do
     attribute :id, Integer
     attribute :href, String,
-      example: proc {|o,ctx| "/api/v1.0/users/#{o.id}"}
+              example: proc { |o, _ctx| "/api/v1.0/users/#{o.id}" }
 
     attribute :first, String, example: /[:first_name:]/
     attribute :last, String, example: /[:last_name:]/
     attribute :posts, Attributor::Collection.of(Post)
 
     attribute :post_matrix, Attributor::Collection.of(Attributor::Collection.of(Post)),
-      description: 'matrix of posts with some row and some column axes that make sense'
+              description: 'matrix of posts with some row and some column axes that make sense'
     attribute :daily_posts, Attributor::Collection.of(Attributor::Struct) do
       attribute :day, String
       attribute :posts, Attributor::Collection.of(Post)
@@ -189,7 +182,7 @@ class User < Praxis::MediaType
     end
 
     attribute :posts_summary, Post::CollectionSummary,
-      example: proc { |user,ctx| Post::CollectionSummary.example(ctx, href: "#{user.href}/posts") }
+              example: proc { |user, ctx| Post::CollectionSummary.example(ctx, href: "#{user.href}/posts") }
   end
 
   default_fieldset do

data/spec/support/spec_resources.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ostruct'
 
 require 'praxis/mapper/active_model_compat'
@@ -63,15 +65,15 @@ end
 class YamlArrayModel < OpenStruct
   include Praxis::Mapper::ActiveModelCompat
   def self._praxis_associations
-   {
-    parents: {
-      model: ParentModel,
-      primary_key: :id,
-      type: :one_to_many,
-      local_key_columns: [:id],
-      remote_key_columns: [:parent_id]
+    {
+      parents: {
+        model: ParentModel,
+        primary_key: :id,
+        type: :one_to_many,
+        local_key_columns: [:id],
+        remote_key_columns: [:parent_id]
+      }
     }
-  }
   end
 end
 
@@ -79,7 +81,7 @@ end
 class BaseResource < Praxis::Mapper::Resource
   def href
     base_href = '' # "/api"
-    base_href + "/#{self.class.collection_name}/#{self.id}"
+    base_href + "/#{self.class.collection_name}/#{id}"
   end
 
   property :href, dependencies: [:id]
@@ -94,33 +96,33 @@ end
 class ParentResource < BaseResource
   model ParentModel
 
-  property :display_name, dependencies: [:simple_name, :id, :other_attribute]
+  property :display_name, dependencies: %i[simple_name id other_attribute]
 end
 
 class SimpleResource < BaseResource
   model SimpleModel
 
-  resource_delegate :other_model => [:other_attribute]
+  resource_delegate other_model: [:other_attribute]
 
   def other_resource
-    self.other_model
+    other_model
   end
 
-  property :aliased_method, dependencies: [:column1, :other_model]
+  property :aliased_method, dependencies: %i[column1 other_model]
   property :other_resource, dependencies: [:other_model]
 
-  property :parent, dependencies: [:parent, :added_column]
+  property :parent, dependencies: %i[parent added_column]
 
   property :name, dependencies: [:simple_name]
-  property :direct_other_name, dependencies: [ 'other_model.name' ]
-  property :aliased_other_name, dependencies: [ 'other_model.display_name' ]
+  property :direct_other_name, dependencies: ['other_model.name']
+  property :aliased_other_name, dependencies: ['other_model.display_name']
 
   property :everything, dependencies: [:*]
   property :everything_from_parent, dependencies: ['parent.*']
-  property :circular_dep, dependencies: [ :circular_dep, :column1 ]
+  property :circular_dep, dependencies: %i[circular_dep column1]
   property :no_deps, dependencies: []
 
-  property :deep_nested_deps, dependencies: [ 'parent.simple_children.other_model.parent.display_name']
+  property :deep_nested_deps, dependencies: ['parent.simple_children.other_model.parent.display_name']
 end
 
 class YamlArrayResource < BaseResource

data/spec/support/spec_simple_authentication_plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'singleton'
 
 module SimpleAuthenticationPlugin
@@ -7,7 +9,8 @@ module SimpleAuthenticationPlugin
     include Singleton
 
     def initialize
-      @options = {config_file: 'config/authentication.yml'}
+      @options = { config_file: 'config/authentication.yml' }
+      super
     end
 
     def config_key
@@ -23,10 +26,8 @@ module SimpleAuthenticationPlugin
     def self.authenticate(request)
       request.current_user == 'guest'
     end
-
   end
 
-
   module Request
     def current_user
       'guest'
@@ -39,15 +40,11 @@ module SimpleAuthenticationPlugin
     included do
       before :action do |controller|
         action = controller.request.action
-        if action.authentication_required
-          Plugin.authenticate(controller.request)
-        end
+        Plugin.authenticate(controller.request) if action.authentication_required
       end
     end
-
   end
 
-
   module ActionDefinition
     extend ActiveSupport::Concern
 
@@ -64,6 +61,5 @@ module SimpleAuthenticationPlugin
     def authentication_required
       @authentication_required ||= false
     end
-
   end
 end

data/tasks/loader.thor

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'thor'
 
-files = Dir[File.join(File.dirname(__FILE__), "thor/*.rb")]
+files = Dir[File.join(File.dirname(__FILE__), 'thor/*.rb')]
 files.each do |f|
- require File.expand_path(f)
+  require File.expand_path(f)
 end

data/tasks/thor/app.rb

@@ -1,24 +1,26 @@
+# frozen_string_literal: true
+
 module PraxisGen
   class App < Thor
     include Thor::Actions
 
-    namespace "praxis:app"
+    namespace 'praxis:app'
     def self.source_root
-      File.dirname(__FILE__) + "/templates/generator/empty_app"
+      "#{File.dirname(__FILE__)}/templates/generator/empty_app"
     end
 
     argument :app_name, required: true
-    desc "new", "Generates a blank new app under <app_name> (with a full skeleton ready to start coding)"
+    desc 'new', 'Generates a blank new app under <app_name> (with a full skeleton ready to start coding)'
 
     # Generator for a blank new app (with a full skeleton ready to get you going)
     def new
       puts "Creating new blank Praxis app under #{app_name}"
       # Copy example files
-      ['config.ru','Gemfile','Rakefile','README.md'].each do |file|
+      ['config.ru', 'Gemfile', 'Rakefile', 'README.md'].each do |file|
         copy_file file, verbose: true
       end
       # Copy example directories
-      root_dirs = ['config','app','design','spec','docs']
+      root_dirs = %w[config app design spec docs]
       root_dirs.each do |dir|
         directory dir, recursive: true
       end

data/tasks/thor/example.rb

@@ -1,55 +1,56 @@
+# frozen_string_literal: true
 
 module PraxisGen
   class Example < Thor
     include Thor::Actions
 
-    namespace "praxis:example"
+    namespace 'praxis:example'
 
     def self.source_root
-      File.dirname(__FILE__) + "/templates/generator/example_app"
+      "#{File.dirname(__FILE__)}/templates/generator/example_app"
     end
 
     argument :app_name, required: true
-    desc "example", "Generates a new example application under an <app_name> directory to showcase some features"
+    desc 'example', 'Generates a new example application under an <app_name> directory to showcase some features'
 
     def example
       sanitized = app_name.downcase.gsub(/[^a-z0-9_\-.]/, '')
       puts "APP_NAME: #{app_name}"
-      raise "Please use only letters, numbers, underscores, dashes or periods for the app name" unless sanitized == app_name
+      raise 'Please use only letters, numbers, underscores, dashes or periods for the app name' unless sanitized == app_name
 
       # Copy example files
-      root_files = ['Gemfile','config.ru','Rakefile']
+      root_files = ['Gemfile', 'config.ru', 'Rakefile']
       root_files.each do |file|
         copy_file file, verbose: true
       end
       # Copy example directories
-      root_dirs = ['app','config','design','db','spec']
+      root_dirs = %w[app config design db spec]
       root_dirs.each do |dir|
         directory dir, recursive: true
       end
 
       puts
-      puts "To run the example application:"
+      puts 'To run the example application:'
       puts
       puts "  cd #{app_name}"
-      puts "  bundle"
-      puts "  bundle exec rake db:recreate   # To create/migrate/seed the dev DB"
-      puts "  bundle exec rackup             # To start the web server"
-      puts  
-      puts "From another terminal/app, use curl (or your favorite HTTP client) to retrieve data from the API"
-      puts "  For example: "
-      puts "  Get all users without filters or limit, and display only id, and first_name fields"
+      puts '  bundle'
+      puts '  bundle exec rake db:recreate   # To create/migrate/seed the dev DB'
+      puts '  bundle exec rackup             # To start the web server'
+      puts
+      puts 'From another terminal/app, use curl (or your favorite HTTP client) to retrieve data from the API'
+      puts '  For example: '
+      puts '  Get all users without filters or limit, and display only id, and first_name fields'
       puts "  curl -G -H 'X-Api-Version: 1' http://localhost:9292/users \\"
-      puts "    --data-urlencode \"fields=id,first_name\""
+      puts '    --data-urlencode "fields=id,first_name"'
       puts
-      puts "  Get the last 5 users, with last_names starting with \"L\" ordered by first_name (descending)"
-      puts "  and display only id, first_name, last_name, and email fields"
+      puts '  Get the last 5 users, with last_names starting with "L" ordered by first_name (descending)'
+      puts '  and display only id, first_name, last_name, and email fields'
       puts "  curl -G -H 'X-Api-Version: 1' http://localhost:9292/users \\"
-      puts "    --data-urlencode \"filters=last_name=L*\" \\"
-      puts "    --data-urlencode \"pagination=by=first_name,items=5\" \\"
-      puts "    --data-urlencode \"order=-first_name\" \\"      
-      puts "    --data-urlencode \"fields=id,first_name,last_name,email\""
-      puts "  (Note: To list all routes use: bundle exec rake praxis:routes)"
+      puts '    --data-urlencode "filters=last_name=L*" \\'
+      puts '    --data-urlencode "pagination=by=first_name,items=5" \\'
+      puts '    --data-urlencode "order=-first_name" \\'
+      puts '    --data-urlencode "fields=id,first_name,last_name,email"'
+      puts '  (Note: To list all routes use: bundle exec rake praxis:routes)'
       puts
       nil
     end