apia 3.1.0 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5db442aede360ce867a790d610a1fd52ca99149fae66d7122d18061cb2ac389
-  data.tar.gz: 30d3c64645a15f11b6e2d96326e987f31b0623e500a56c49194e80589e7303d1
+  metadata.gz: b329db4c1e00be2afbb4160dff2feb3e3be2dfb0feab05b2b6f591045fe953b4
+  data.tar.gz: 3eff127300b99d73b3a15d86c0edba9bdb30f404500e35890aec1498a5f73337
 SHA512:
-  metadata.gz: 70b9295d1b016210832c30b2d233683efa045797c5113e80bd959dfa6a6888c414f3a60e01ded946f63d50d51cd79cdae58514c2d8b483bfec29be71a89b83bd
-  data.tar.gz: af2fa9e9322ed357a2074336a2e536d8ebb3c955692bd1b6a85812fe788fc4d5f19b0b1ecc57ce99c82b118fb7b5024a276d54edbb3560ab594b718c80e88ccd
+  metadata.gz: 1d2af39e3de24f4ee4f3dbefa8206dde25648274793bcecfdca183faedfd7d6622bb60552ae7134b9abda3ccb667f285884957cc542f045ecc71b6f2da4b6138
+  data.tar.gz: ad96bf7677bf7d8c1d8b438f79f9c3d743f4184c9351c82eceeea5e5bc7d7dd97d039cba51eca4e0c8bd013bc6be96c8558aa61de41d87de2faacb008d3fe31e

data/VERSION

@@ -1 +1 @@
-3.1.0
+3.3.1

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/definitions/endpoint.rb

@@ -36,6 +36,19 @@ module Apia
         @potential_errors ||= Apia::ErrorSet.new
       end
 
+      def fields=(fieldset)
+        unless @fields.empty?
+          raise Apia::StandardError, 'Cannot set the fieldset on an endpoint that already has fields defined'
+        end
+
+        @fields = fieldset
+        @fields_overriden = true
+      end
+
+      def fields_overriden?
+        @fields_overriden == true
+      end
+
       def dsl
         @dsl ||= DSLs::Endpoint.new(self)
       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

@@ -41,6 +41,10 @@ module Apia
       end
 
       def field(name, *args, type: nil, **options, &block)
+        if @definition.fields_overriden?
+          raise Apia::StandardError, 'Cannot add fields to an endpoint that has a separate fieldset'
+        end
+
         if pagination_options = options.delete(:paginate)
 
           unless @definition.paginated_field.nil?
@@ -56,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
@@ -64,6 +68,10 @@ module Apia
         super(name, *args, type: type, **options, &block)
       end
 
+      def fields(fieldset)
+        @definition.fields = fieldset
+      end
+
       def scopes(*names)
         names.each { |name| scope(name) }
       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/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]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apia
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.3.1
 platform: ruby
 authors:
 - Adam Cooke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-20 00:00:00.000000000 Z
+date: 2023-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -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.