apia 3.2.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9eccaade7623f6fc8ecae88bb8c87da23d4a436a2d76801ac6dbd2d57db9efe
-  data.tar.gz: c77009793790064a1f6219b6a362128359d2e98a0ccc7c8215d184f7afa36b5b
+  metadata.gz: f40c9dba04e5b064ced8833f9edb42f96efd59c9d4e9342a4fa6535a1e76c6ee
+  data.tar.gz: 2506e79260735d3c2029ac7eaa9733e481b975b177506f03fcdeba21760b8781
 SHA512:
-  metadata.gz: 3dc391ac5e8ad44636978220ceeb55bef47b10ba03f5826e371ed4041e428873ed59d351447d3345817e3bbb8b25bfafc6ecd01f4f86745ddc1d0851c2bc19a2
-  data.tar.gz: 2f92e720ce247b4408c21bc5a4096137ef75433b10c8712c4d2d115f8d4a33def15509bd5a7af05fd1bfffed9e465e57dac6cd4f5422e3aa2278e12aa0727664
+  metadata.gz: 7ae74d9f396b7dda8d14513d072f3e7f0902724c5b3e8bd0a430341f8d1e91dd83e4e6aae0b377dc954e3f248c5da7ba3984da354202fa42043c1e5d8d0e5ba7
+  data.tar.gz: 7e735b6a11cfc48325cd60ce0d01a36cb9eb776afeb2b74c3efe8de034b02413df3c8cec149b9ffa0883af4c85d4f631d7cc9f67e63c169e3fbcaeb4d0dbe517

data/lib/apia/api.rb

@@ -79,7 +79,7 @@ module Apia
       # @param endpoint_name [Symbol]
       # @return [Apia::Response]
       def test_endpoint(endpoint, controller: nil)
-        if controller && endpoint.is_a?(Symbol) || endpoint.is_a?(String)
+        if controller && (endpoint.is_a?(Symbol) || endpoint.is_a?(String))
           endpoint_name = endpoint
           endpoint = controller.definition.endpoints[endpoint.to_sym]
           if endpoint.nil?

data/lib/apia/definitions/api.rb

@@ -36,7 +36,7 @@ module Apia
         end
 
         @controllers.each do |name, controller|
-          unless name.to_s =~ /\A[\w\-]+\z/i
+          unless name.to_s =~ /\A[\w-]+\z/i
             errors.add self, 'InvalidControllerName', "The controller name #{name} is invalid. It can only contain letters, numbers, underscores, and hyphens"
           end
 

data/lib/apia/dsls/controller.rb

@@ -18,7 +18,7 @@ module Apia
 
       def endpoint(name, klass = nil, &block)
         if block_given?
-          id = "#{@definition.id}/#{klass || Helpers.camelize(name) + 'Endpoint'}"
+          id = "#{@definition.id}/#{klass || (Helpers.camelize(name) + 'Endpoint')}"
           klass = Apia::Endpoint.create(id, &block)
         end
 

data/lib/apia/dsls/endpoint.rb

@@ -60,7 +60,7 @@ module Apia
 
           argument :per_page, type: Scalars::Integer, default: 30 do
             validation(:greater_than_zero) { |o| o.positive? }
-            validation(:less_than_or_equal_to_100) { |o| o <= (pagination_options[:maximum_per_page]&.to_i || 200) }
+            validation(:less_than_or_equal_to_one_hundred) { |o| o <= (pagination_options[:maximum_per_page]&.to_i || 200) }
           end
 
           field :pagination, type: PaginationObject

data/lib/apia/field_set.rb

@@ -5,6 +5,7 @@ require 'apia/scalar'
 require 'apia/object'
 require 'apia/enum'
 require 'apia/field_spec'
+require 'apia/generated_hash'
 
 module Apia
   class FieldSet < Hash
@@ -35,10 +36,12 @@ module Apia
     #
     # @param source [Object, Hash]
     # @param request [Apia::Request]
+    # @param object [Apia::Object] the object that this fieldset belongs to
     # @param only [Array]
     # @return [Hash]
-    def generate_hash(source, request: nil, path: [])
-      each_with_object({}) do |(_, field), hash|
+    def generate_hash(source, request: nil, path: [], object: nil)
+      new_hash = GeneratedHash.enabled? ? GeneratedHash.new(object, source, path: path) : {}
+      each_with_object(new_hash) do |(_, field), hash|
         next unless field.include?(source, request)
 
         field_path = path + [field]

data/lib/apia/generated_hash.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Apia
+  class GeneratedHash < Hash
+
+    attr_reader :object
+    attr_reader :source
+    attr_reader :path
+
+    def initialize(object, source, path: nil)
+      super()
+      @object = object
+      @source = source
+      @path = path
+    end
+
+    class << self
+
+      def enabled?
+        @enabled == true
+      end
+
+      def enable
+        @enabled = true
+      end
+
+    end
+
+  end
+end

data/lib/apia/notifications.rb

@@ -15,8 +15,9 @@ module Apia
         end
       end
 
-      def add_handler(&block)
-        handlers.push(block)
+      def add_handler(handler = nil, &block)
+        handlers.push(block) if block
+        handlers.push(handler) if handler
       end
 
       def clear_handlers

data/lib/apia/object.rb

@@ -49,7 +49,7 @@ module Apia
     # @param request [Apia::Request] the associated request
     # @return [Hash]
     def hash(request: nil, path: [])
-      self.class.definition.fields.generate_hash(@value, request: request, path: path)
+      self.class.definition.fields.generate_hash(@value, object: self, request: request, path: path)
     end
 
     # Should this type be included in any output?

data/lib/apia/rack.rb

@@ -73,15 +73,22 @@ module Apia
     private
 
     def handle_request(env, api_path)
-      if env['REQUEST_METHOD'].upcase == 'OPTIONS'
+      request = nil
+      request_method = env['REQUEST_METHOD'].upcase
+      notify_hash = { api: api, env: env, path: api_path, method: request_method }
+
+      if request_method.upcase == 'OPTIONS'
         return [204, {}, ['']]
       end
 
+      Apia::Notifications.notify(:request_start, notify_hash)
+
       validate_api if development?
 
-      route = find_route(env['REQUEST_METHOD'], api_path)
+      route = find_route(request_method, api_path)
       if route.nil?
-        raise RackError.new(404, 'route_not_found', "No route matches '#{api_path}' for #{env['REQUEST_METHOD']}")
+        Apia::Notifications.notify(:request_route_not_found, notify_hash)
+        raise RackError.new(404, 'route_not_found', "No route matches '#{api_path}' for #{request_method}")
       end
 
       request = Apia::Request.new(env)
@@ -92,30 +99,40 @@ module Apia
       request.endpoint = route.endpoint
       request.route = route
 
+      Apia::Notifications.notify(:request_before_execution, notify_hash.merge(request: request))
+
       start_time = Time.now
       response = request.endpoint.execute(request)
       end_time = Time.now
+      time = end_time - start_time
 
-      Apia::Notifications.notify(:request, { request: request, response: response, time: (end_time - start_time).to_f })
+      Apia::Notifications.notify(:request, notify_hash.merge(request: request, response: response, time: time))
 
       response.rack_triplet
     rescue ::StandardError => e
-      if e.is_a?(RackError) || e.is_a?(Apia::ManifestError)
-        return e.triplet
-      end
+      handle_error(e, env, request, request_method)
+    ensure
+      Apia::Notifications.notify(:request_end, notify_hash)
+    end
+
+    def handle_error(exception, env, request, request_method)
+      notify_hash = { api: api, env: env, path: request&.api_path, request: request, method: request_method, exception: exception }
 
-      request_or_nil = defined?(request) ? request : nil
+      if exception.is_a?(RackError) || exception.is_a?(Apia::ManifestError)
+        Apia::Notifications.notify(:request_manifest_error, notify_hash)
+        return exception.triplet
+      end
 
-      api.definition.exception_handlers.call(e, {
+      api.definition.exception_handlers.call(exception, {
         env: env,
         api: api,
-        request: request_or_nil
+        request: request
       })
 
-      Apia::Notifications.notify(:request_error, { exception: e, request: request_or_nil, api: api, env: env })
+      Apia::Notifications.notify(:request_error, notify_hash)
 
       if development?
-        return triplet_for_exception(e)
+        return triplet_for_exception(exception)
       end
 
       self.class.error_triplet('unhandled_exception', status: 500)

data/lib/apia/request_headers.rb

@@ -26,7 +26,7 @@ module Apia
       end
 
       def create_from_request(request)
-        hash = request.each_header.each_with_object({}) do |(key, value), inner_hash|
+        hash = request.each_header.with_object({}) do |(key, value), inner_hash|
           next unless key =~ /\AHTTP_(\w+)\z/
 
           name = Regexp.last_match[1]

data/lib/apia/route.rb

@@ -49,7 +49,7 @@ module Apia
     # @return [Hash]
     def extract_arguments(given_path)
       given_path_parts = RouteSet.split_path(given_path)
-      path_parts.each_with_index.each_with_object({}) do |(part, index), hash|
+      path_parts.each_with_index.with_object({}) do |(part, index), hash|
         next unless part =~ /\A:(\w+)/
 
         value = given_path_parts[index]

data/lib/apia/version.rb

@@ -2,11 +2,6 @@
 
 module Apia
 
-  VERSION_FILE_ROOT = File.expand_path('../../VERSION', __dir__)
-  if File.file?(VERSION_FILE_ROOT)
-    VERSION = File.read(VERSION_FILE_ROOT).strip.sub(/\Av/, '')
-  else
-    VERSION = '0.0.0.dev'
-  end
+  VERSION = '3.4.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apia
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Adam Cooke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-26 00:00:00.000000000 Z
+date: 2023-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -45,7 +45,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- VERSION
 - lib/apia.rb
 - lib/apia/api.rb
 - lib/apia/argument_set.rb
@@ -110,6 +109,7 @@ files:
 - lib/apia/errors/standard_error.rb
 - lib/apia/field_set.rb
 - lib/apia/field_spec.rb
+- lib/apia/generated_hash.rb
 - lib/apia/helpers.rb
 - lib/apia/hook_set.rb
 - lib/apia/lookup_argument_set.rb
@@ -184,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: This gem provides a friendly DSL for constructing HTTP APIs.

data/VERSION

@@ -1 +0,0 @@
-3.2.0