haveapi 0.20.0 → 0.21.0

data/lib/haveapi/params.rb

@@ -1,18 +1,13 @@
 module HaveAPI
   module Parameters
-
   end
 
-  class ValidationError < Exception
+  class ValidationError < StandardError
     def initialize(msg, errors = {})
-      @msg = msg
+      super(msg)
       @errors = errors
     end
 
-    def message
-      @msg
-    end
-
     def to_hash
       @errors
     end
@@ -57,7 +52,7 @@ module HaveAPI
     def layout
       return @cache[:layout] if @cache[:layout]
 
-      @cache[:layout] = @layout ? @layout : :object
+      @cache[:layout] = @layout || :object
     end
 
     def layout=(l)
@@ -69,7 +64,7 @@ module HaveAPI
       return @cache[:namespace] = @namespace unless @namespace.nil?
 
       n = @action.resource.resource_name.underscore
-      n = n.pluralize if %i(object_list hash_list).include?(layout)
+      n = n.pluralize if %i[object_list hash_list].include?(layout)
       @cache[:namespace] = n.to_sym
     end
 
@@ -106,8 +101,8 @@ module HaveAPI
       add_param(name, apply(kwargs, type: Integer))
     end
 
-    alias_method :id, :integer
-    alias_method :foreign_key, :integer
+    alias id integer
+    alias foreign_key integer
 
     def float(name, **kwargs)
       add_param(name, apply(kwargs, type: Float))
@@ -127,33 +122,33 @@ module HaveAPI
 
       block = @action.resource.params(name)
 
-      if block
-        @include_back << @include.clone if @include
-        @exclude_back << @exclude.clone if @exclude
+      return unless block
 
-        if include
-          @include ||= []
-          @include.concat(include)
-        end
+      @include_back << @include.clone if @include
+      @exclude_back << @exclude.clone if @exclude
 
-        if exclude
-          @exclude ||= []
-          @exclude.concat(exclude)
-        end
-
-        instance_eval(&block)
+      if include
+        @include ||= []
+        @include.concat(include)
+      end
 
-        @include = @include_back.pop if @include
-        @exclude = @exclude_back.pop if @exclude
+      if exclude
+        @exclude ||= []
+        @exclude.concat(exclude)
       end
+
+      instance_eval(&block)
+
+      @include = @include_back.pop if @include
+      @exclude = @exclude_back.pop if @exclude
     end
 
     def resource(name, **kwargs)
       add_resource(name, kwargs)
     end
 
-    alias_method :references, :resource
-    alias_method :belongs_to, :resource
+    alias references resource
+    alias belongs_to resource
 
     def patch(name, **changes)
       @params.detect { |p| p.name == name }.patch(changes)
@@ -167,7 +162,7 @@ module HaveAPI
     def describe(context)
       context.layout = layout
 
-      ret = {parameters: {}}
+      ret = { parameters: {} }
       ret[:layout] = layout
       ret[:namespace] = namespace
       ret[:format] = @structure if @structure
@@ -176,17 +171,17 @@ module HaveAPI
         ret[:parameters][p.name] = p.describe(context)
       end
 
-      if @direction == :input
-        ret[:parameters] = context.authorization.filter_input(
-          @params,
-          ModelAdapters::Hash.output(context, ret[:parameters])
-        )
-      else
-        ret[:parameters] = context.authorization.filter_output(
-          @params,
-          ModelAdapters::Hash.output(context, ret[:parameters])
-        )
-      end
+      ret[:parameters] = if @direction == :input
+                           context.authorization.filter_input(
+                             @params,
+                             ModelAdapters::Hash.output(context, ret[:parameters])
+                           )
+                         else
+                           context.authorization.filter_output(
+                             @params,
+                             ModelAdapters::Hash.output(context, ret[:parameters])
+                           )
+                         end
 
       ret
     end
@@ -235,7 +230,6 @@ module HaveAPI
 
           begin
             cleaned = p.clean(input[p.name])
-
           rescue ValidationError => e
             errors[p.name] ||= []
             errors[p.name] << e.message
@@ -271,6 +265,7 @@ module HaveAPI
     end
 
     private
+
     def add_param(name, kwargs)
       p = Parameters::Typed.new(name, kwargs)
 
@@ -311,7 +306,7 @@ module HaveAPI
       end
     end
 
-    def layout_aware(params)
+    def layout_aware(params, &)
       ns = namespace
 
       case layout
@@ -319,9 +314,7 @@ module HaveAPI
         yield(ns ? params[namespace] : params)
 
       when :object_list, :hash_list
-        (ns ? params[namespace] : params).each do |object|
-          yield(object)
-        end
+        (ns ? params[namespace] : params).each(&)
 
       else
         false

data/lib/haveapi/resource.rb

@@ -11,6 +11,7 @@ module HaveAPI
     has_attr :singular, false
 
     def self.inherited(subclass)
+      super
       subclass.instance_variable_set(:@obj_type, obj_type)
     end
 
@@ -28,8 +29,8 @@ module HaveAPI
       end
     end
 
-    def self.actions(&block)
-      (@actions || []).each(&block)
+    def self.actions(&)
+      (@actions || []).each(&)
     end
 
     def self.resources
@@ -40,7 +41,6 @@ module HaveAPI
           if obj.obj_type == :resource
             yield obj
           end
-
         rescue NoMethodError
           next
         end
@@ -51,15 +51,15 @@ module HaveAPI
       (@resource_name ? @resource_name.to_s : to_s).demodulize
     end
 
-    def self.resource_name=(name)
-      @resource_name = name
+    class << self
+      attr_writer :resource_name
     end
 
     def self.rest_name
       singular ? resource_name.singularize.underscore : resource_name.tableize
     end
 
-    def self.routes(prefix='/', resource_path: [])
+    def self.routes(prefix = '/', resource_path: [])
       ret = []
       prefix = "#{prefix}#{@route || rest_name}/"
       new_resource_path = resource_path + [resource_name.underscore]
@@ -73,14 +73,14 @@ module HaveAPI
       end
 
       resources do |r|
-        ret << {r => r.routes(prefix, resource_path: new_resource_path)}
+        ret << { r => r.routes(prefix, resource_path: new_resource_path) }
       end
 
       ret
     end
 
     def self.describe(hash, context)
-      ret = {description: self.desc, actions: {}, resources: {}}
+      ret = { description: desc, actions: {}, resources: {} }
 
       context.resource = self
 

data/lib/haveapi/resources/action_state.rb

@@ -11,16 +11,16 @@ module HaveAPI::Resources
       string :label, label: 'Label'
       bool :finished, label: 'Finished'
       bool :status, label: 'Status',
-          desc: 'Determines whether the action is proceeding or failing'
+                    desc: 'Determines whether the action is proceeding or failing'
       integer :current, label: 'Current progress'
       integer :total, label: 'Total',
-          desc: 'The action is finished when current equals to total'
+                      desc: 'The action is finished when current equals to total'
       string :unit, label: 'Unit', desc: 'Unit of current and total'
       bool :can_cancel, label: 'Can cancel',
-          desc: 'When true, execution of this action can be cancelled'
+                        desc: 'When true, execution of this action can be cancelled'
       datetime :created_at, label: 'Created at'
       datetime :updated_at, label: 'Updated at',
-          desc: 'When was the progress last updated'
+                            desc: 'When was the progress last updated'
     end
 
     module Mixin
@@ -31,15 +31,10 @@ module HaveAPI::Resources
           status: state.status,
           created_at: state.created_at,
           updated_at: state.updated_at,
-          can_cancel: state.can_cancel?,
+          can_cancel: state.can_cancel?
         }
 
-        if state.finished?
-          hash[:finished] = true
-
-        else
-          hash[:finished] = false
-        end
+        hash[:finished] = state.finished?
 
         progress = state.progress
         hash[:current] = progress[:current] || 0
@@ -56,7 +51,7 @@ module HaveAPI::Resources
       desc 'List states of pending actions'
 
       input(:hash) do
-        string :order, choices: %w(newest oldest), default: 'newest', fill: true
+        string :order, choices: %w[newest oldest], default: 'newest', fill: true
       end
 
       output(:hash_list) do
@@ -92,8 +87,8 @@ module HaveAPI::Resources
       input(:hash) do
         float :timeout, label: 'Timeout', desc: 'in seconds', default: 15, fill: true
         float :update_in, label: 'Progress',
-            desc: 'number of seconds after which the state is returned if the progress '+
-                  'has changed'
+                          desc: 'number of seconds after which the state is returned if the progress ' \
+                                'has changed'
         bool :status, desc: 'status to check with if update_in is set'
         integer :current, desc: 'progress to check with if update_in is set'
         integer :total, desc: 'progress to check with if update_in is set'
@@ -122,7 +117,7 @@ module HaveAPI::Resources
           elsif input[:update_in]
             new_state = state_to_hash(state)
 
-            %i(status current total).each do |v|
+            %i[status current total].each do |v|
               return new_state if input[v] != new_state[v]
             end
           end
@@ -185,14 +180,11 @@ module HaveAPI::Resources
         else
           error('cancellation failed')
         end
-
       rescue RuntimeError, NotImplementedError => e
         error(e.message)
       end
 
-      def state_id
-        @state_id
-      end
+      attr_reader :state_id
     end
   end
 end