ecoportal-api-graphql 1.3.11 → 1.3.13

data/lib/ecoportal/api/common/graphql/http_client.rb

@@ -1,177 +1,189 @@
-module Ecoportal
-  module API
-    module Common
-      module GraphQL
-        class ResponseError < StandardError; end
-
-        class HttpClient < Common::Client
-          class << self
-            def base_url(host)
-              "#{protocol(host)}://#{host}"
-            end
-
-            def protocol(host)
-              host.match(/^localhost|^127\.0\.0\.1/)? 'http' : 'https'
-            end
-          end
-
-          ENDPOINT_PATH = 'external/graphql'.freeze
-          READ_TIMEOUT  = 90
-          WRITE_TIMEOUT = 90
-
-          attr_reader :host, :version
-
-          include Ecoportal::API::Common::GraphQL::AuthService
-
-          def initialize(
-            email:        nil,
-            pass:         nil,
-            org_id:       nil,
-            api_key:      nil,
-            version:      'graphql',
-            host:         'live.ecoportal.com',
-            logger:       ::Logger.new(IO::NULL),
-            deep_logging: false,
-            no_schema:    true
-          )
-            @org_id      = org_id
-            @user_email  = email
-            @user_pass   = pass
-            @no_schema   = no_schema
-            @version     = version
-
-            super(
-              api_key:      api_key,
-              host:         host,
-              logger:       logger,
-              deep_logging: deep_logging
-            )
-          end
-
-          # Creates a HTTP object adding the `X-ApiKey` or `X-ECOPORTAL-API-KEY` param to the header, depending on the API version.
-          # @note It configures HTTP so it only allows body data in json format.
-          # @return [HTTP] HTTP object.
-          def base_request
-            @base_request ||=
-              case @version
-              when NilClass, 'http'
-                HTTP
-              when 'v1', 'v0'
-                HTTP.headers('X-ApiKey' => key_token)
-              when 'v2', 'v3'
-                HTTP.headers('X-ECOPORTAL-API-KEY' => key_token)
-              when 'graphql'
-                HTTP.headers('Authorization' => "Bearer #{session_token(host: host)}")
-              end.then do |request|
-                request ||= HTTP
-                request.accept(:json).timeout(
-                  read:  READ_TIMEOUT,
-                  write: WRITE_TIMEOUT
-                )
-              end
-          end
-
-          def org_id
-            @org_id || fetch_env_required('ORGANIZATION_ID')
-          end
-
-          # Executes a GraphQL query or mutation over HTTP.
-          # @param query_string [String] full GraphQL query document.
-          # @param variables [Hash] variable values to pass to the operation.
-          # @param operation_name [String, nil] when the document has multiple operations.
-          # @return [Hash] parsed response body (string-keyed, includes 'data' and optionally 'errors').
-          # @raise [Ecoportal::API::Common::Client::Error::UnexpectedServerError] on non-2xx HTTP status.
-          # @raise [Ecoportal::API::Common::GraphQL::ResponseError] when the response body contains GraphQL errors.
-          def execute(query_string, variables: {}, operation_name: nil)
-            body = { query: query_string, variables: variables }
-            body[:operationName] = operation_name if operation_name
-            response = base_request.post(url_for(''), json: body)
-            handle_http_response(response)
-          end
-
-          # Full URl builder of the request
-          # @param path [String] the tail that completes the url of the request.
-          # @return [String] the final url.
-          def url_for(path)
-            "#{api_url}#{path}"
-          end
-
-          private
-
-          def key_token
-            return                           if http?
-            return session_token(host: host) if graphql?
-            return @api_key                  if api_key?
-            return ENV['ORG_INT_KEY']        if v0?
-
-            puts 'Api-key missing!'
-          end
-
-          def api_url
-            base_url.then do |url|
-              next "#{url}/api/#{version}"                 if v1_0? || v2_3?
-              next "#{url}/api/#{org_id}/#{ENDPOINT_PATH}" if graphql?
-
-              url
-            end
-          end
-
-          def base_url
-            @base_url ||= self.class.base_url(host)
-          end
-
-          def protocol
-            @protocol ||= self.class.protocol(host)
-          end
-
-          def http?
-            return true if @version.nil?
-
-            @version == 'http'
-          end
-
-          def api_key?
-            @api_key && !@api_key.match(/\A\W*\z/)
-          end
-
-          def v1_0?
-            v1? || v0?
-          end
-
-          def v1?
-            @version == 'v1'
-          end
-
-          def v0?
-            @version == 'v0'
-          end
-
-          def v2_3?
-            return true if @version == 'v2'
-            return true if @version == 'v3'
-
-            false
-          end
-
-          def graphql?
-            @version == 'graphql'
-          end
-
-          def handle_http_response(response)
-            unless response.status.success?
-              raise Ecoportal::API::Common::Client::Error::UnexpectedServerError.new(
-                response.body.to_s, code: response.status.code
-              )
-            end
-
-            parsed = response.parse(:json)
-            errors = parsed['errors']
-            raise ResponseError, errors.map { |e| e['message'] }.join('; ') if errors&.any?
-
-            parsed
-          end
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    module Common
+      module GraphQL
+        class ResponseError < StandardError; end
+
+        class HttpClient < Common::Client
+          class << self
+            def base_url(host)
+              "#{protocol(host)}://#{host}"
+            end
+
+            def protocol(host)
+              host.match(/^localhost|^127\.0\.0\.1/)? 'http' : 'https'
+            end
+          end
+
+          ENDPOINT_PATH = 'external/graphql'.freeze
+          READ_TIMEOUT  = 90
+          WRITE_TIMEOUT = 90
+
+          attr_reader :host, :version
+
+          include Ecoportal::API::Common::GraphQL::AuthService
+
+          def initialize(
+            email:        nil,
+            pass:         nil,
+            org_id:       nil,
+            api_key:      nil,
+            version:      'graphql',
+            host:         'live.ecoportal.com',
+            logger:       ::Logger.new(IO::NULL),
+            deep_logging: false,
+            no_schema:    true
+          )
+            @org_id      = org_id
+            @user_email  = email
+            @user_pass   = pass
+            @no_schema   = no_schema
+            @version     = version
+
+            super(
+              api_key:      api_key,
+              host:         host,
+              logger:       logger,
+              deep_logging: deep_logging
+            )
+          end
+
+          # Creates a HTTP object adding the `X-ApiKey` or `X-ECOPORTAL-API-KEY` param to the header, depending on the API version.
+          # @note It configures HTTP so it only allows body data in json format.
+          # @return [HTTP] HTTP object.
+          def base_request
+            @base_request ||=
+              case @version
+              when NilClass, 'http'
+                HTTP
+              when 'v1', 'v0'
+                HTTP.headers('X-ApiKey' => key_token)
+              when 'v2', 'v3'
+                HTTP.headers('X-ECOPORTAL-API-KEY' => key_token)
+              when 'graphql'
+                HTTP.headers('Authorization' => "Bearer #{session_token(host: host)}")
+              end.then do |request|
+                request ||= HTTP
+                request.accept(:json).timeout(
+                  read:  READ_TIMEOUT,
+                  write: WRITE_TIMEOUT
+                )
+              end
+          end
+
+          def org_id
+            @org_id || fetch_env_required('ORGANIZATION_ID')
+          end
+
+          # Executes a GraphQL query or mutation over HTTP.
+          # @param query_string [String] full GraphQL query document.
+          # @param variables [Hash] variable values to pass to the operation.
+          # @param operation_name [String, nil] when the document has multiple operations.
+          # @return [Hash] parsed response body (string-keyed, includes 'data' and optionally 'errors').
+          # @raise [Ecoportal::API::Common::Client::Error::UnexpectedServerError] on non-2xx HTTP status.
+          # @raise [Ecoportal::API::Common::GraphQL::ResponseError] when the response body contains GraphQL errors.
+          def execute(query_string, variables: {}, operation_name: nil)
+            body = { query: query_string, variables: variables }
+            body[:operationName] = operation_name if operation_name
+
+            # Route through the inherited `Common::Client` pipeline
+            # (`instrument` -> `with_retry` { `rate_throttling` }) so GraphQL requests
+            # inherit the SAME battle-tested contingencies as the REST clients:
+            # rate-limit backoff (429 / Cloudflare 1015), 5xx + connection-error retries,
+            # timeouts, and instrumentation. Do NOT re-issue the request raw here — that
+            # bypasses all of the above and is what let live runs die on the first 429.
+            response = instrument('POST', ENDPOINT_PATH, body) do
+              request { |http| http.post(url_for(''), json: body) }
+            end
+
+            handle_http_response(response)
+          end
+
+          # Full URl builder of the request
+          # @param path [String] the tail that completes the url of the request.
+          # @return [String] the final url.
+          def url_for(path)
+            "#{api_url}#{path}"
+          end
+
+          private
+
+          def key_token
+            return                           if http?
+            return session_token(host: host) if graphql?
+            return @api_key                  if api_key?
+            return ENV['ORG_INT_KEY']        if v0?
+
+            puts 'Api-key missing!'
+          end
+
+          def api_url
+            base_url.then do |url|
+              next "#{url}/api/#{version}"                 if v1_0? || v2_3?
+              next "#{url}/api/#{org_id}/#{ENDPOINT_PATH}" if graphql?
+
+              url
+            end
+          end
+
+          def base_url
+            @base_url ||= self.class.base_url(host)
+          end
+
+          def protocol
+            @protocol ||= self.class.protocol(host)
+          end
+
+          def http?
+            return true if @version.nil?
+
+            @version == 'http'
+          end
+
+          def api_key?
+            @api_key && !@api_key.match(/\A\W*\z/)
+          end
+
+          def v1_0?
+            v1? || v0?
+          end
+
+          def v1?
+            @version == 'v1'
+          end
+
+          def v0?
+            @version == 'v0'
+          end
+
+          def v2_3?
+            return true if @version == 'v2'
+            return true if @version == 'v3'
+
+            false
+          end
+
+          def graphql?
+            @version == 'graphql'
+          end
+
+          # @param response [Ecoportal::API::Common::Response] the wrapped response
+          #   produced by the inherited pipeline (body already JSON-parsed).
+          def handle_http_response(response)
+            unless response.success?
+              raise Ecoportal::API::Common::Client::Error::UnexpectedServerError.new(
+                response.src_body, code: response.status.code
+              )
+            end
+
+            parsed = response.body
+            errors = parsed && parsed['errors']
+            raise ResponseError, errors.map { |e| e['message'] }.join('; ') if errors&.any?
+
+            parsed
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/common/graphql/model/diffable.rb

@@ -1,54 +1,54 @@
-module Ecoportal
-  module API
-    module Common
-      module GraphQL
-        class Model
-          module Diffable
-            require_relative 'diffable/hash_diff_nesting'
-            require_relative 'diffable/classic_diff_service'
-            require_relative 'diffable/diff_service'
-
-            DIFF_CLASS = DiffService
-
-            # INSTANCE METHODS
-
-            # @note **cascaded callbacks**
-            #   1. Can **skip** rooted objects (where `root?` is `true`).
-            #     This is because nested rooted objects are usually look-ups
-            #     (not really part of the target model).
-            #   2. Allow to redefine `as_update` on each model.
-            # @param flat [Boolean] whether it should NOT perform a cascaded callback
-            #   througout all the instance objects of the model hierarchy (nested).
-            # @param ignored [Array<String>] the keys that should be ignored, not part
-            #   of the result of `as_update`
-            # @return [nil, Hash] the patch `Hash` model including only
-            #   the changes between `original_doc` and `doc`.
-            def as_update(**kargs)
-              diff_class.new(
-                self,
-                **kargs
-              ).diff
-            end
-
-            # @note `cascaded` will be more accurate in a `GraphQL` scenario.
-            # @return [Boolean] stating if there are changes.
-            def dirty?(...)
-              au = as_update(...)
-
-              return false if au.nil?
-              return false if au == {}
-
-              true
-            end
-
-            private
-
-            def diff_class
-              self.class::DIFF_CLASS
-            end
-          end
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    module Common
+      module GraphQL
+        class Model
+          module Diffable
+            require_relative 'diffable/hash_diff_nesting'
+            require_relative 'diffable/classic_diff_service'
+            require_relative 'diffable/diff_service'
+
+            DIFF_CLASS = DiffService
+
+            # INSTANCE METHODS
+
+            # @note **cascaded callbacks**
+            #   1. Can **skip** rooted objects (where `root?` is `true`).
+            #     This is because nested rooted objects are usually look-ups
+            #     (not really part of the target model).
+            #   2. Allow to redefine `as_update` on each model.
+            # @param flat [Boolean] whether it should NOT perform a cascaded callback
+            #   througout all the instance objects of the model hierarchy (nested).
+            # @param ignored [Array<String>] the keys that should be ignored, not part
+            #   of the result of `as_update`
+            # @return [nil, Hash] the patch `Hash` model including only
+            #   the changes between `original_doc` and `doc`.
+            def as_update(**kargs)
+              diff_class.new(
+                self,
+                **kargs
+              ).diff
+            end
+
+            # @note `cascaded` will be more accurate in a `GraphQL` scenario.
+            # @return [Boolean] stating if there are changes.
+            def dirty?(...)
+              au = as_update(...)
+
+              return false if au.nil?
+              return false if au == {}
+
+              true
+            end
+
+            private
+
+            def diff_class
+              self.class::DIFF_CLASS
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base/action.rb

@@ -1,43 +1,43 @@
-module Ecoportal
-  module API
-    class GraphQL
-      module Base
-        class Action < Logic::BaseModel
-          root!
-
-          passkey :id
-          passthrough :altId
-          passthrough :name, :description
-          passthrough :age
-
-          passarray :locationIds
-
-          passthrough :status, :relativeStatus
-          passboolean :archived, :attached, :standaloneAction
-          passthrough :actionCategoryId
-
-          passarray :fileContainerIds
-
-          passarray :assignedPersonMemberIds
-          passthrough :creatorId, :creatorUserId
-          passthrough :updaterId, :updaterUserId
-          passthrough :completerId
-
-          passthrough :timeZone
-          embeds_one :dueDate, klass: Base::DateTime
-          embeds_one :reminderDate, klass: Base::DateTime
-          embeds_one :createdAt, klass: Base::DateTime
-          embeds_one :updatedAt, klass: Base::DateTime
-          embeds_one :completedAt, klass: Base::DateTime
-          embeds_one :openededAt, klass: Base::DateTime
-          embeds_one :closedAt, klass: Base::DateTime
-          embeds_one :dueOrClosedDate, klass: Base::DateTime
-
-          passboolean :completed
-          passthrough :closeDetail
-          #passthrough :dueIn # only for templates
-        end
-      end
-    end
-  end
-end
+module Ecoportal
+  module API
+    class GraphQL
+      module Base
+        class Action < Logic::BaseModel
+          root!
+
+          passkey :id
+          passthrough :altId
+          passthrough :name, :description
+          passthrough :age
+
+          passarray :locationIds
+
+          passthrough :status, :relativeStatus
+          passboolean :archived, :attached, :standaloneAction
+          passthrough :actionCategoryId
+
+          passarray :fileContainerIds
+
+          passarray :assignedPersonMemberIds
+          passthrough :creatorId, :creatorUserId
+          passthrough :updaterId, :updaterUserId
+          passthrough :completerId
+
+          passthrough :timeZone
+          embeds_one :dueDate, klass: Base::DateTime
+          embeds_one :reminderDate, klass: Base::DateTime
+          embeds_one :createdAt, klass: Base::DateTime
+          embeds_one :updatedAt, klass: Base::DateTime
+          embeds_one :completedAt, klass: Base::DateTime
+          embeds_one :openededAt, klass: Base::DateTime
+          embeds_one :closedAt, klass: Base::DateTime
+          embeds_one :dueOrClosedDate, klass: Base::DateTime
+
+          passboolean :completed
+          passthrough :closeDetail
+          #passthrough :dueIn # only for templates
+        end
+      end
+    end
+  end
+end