ecoportal-api-graphql 1.3.3 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e148fcd6c75c8724f75b4797859146f245d9809a7e0c14330e70b0f0eeaecbbe
-  data.tar.gz: 819b4b7a1c61ad24a186688d45dc1a094dc7e09ea5b13b520837fa8fd0913b2e
+  metadata.gz: a601be8bd2712d265a92f530ea2737d1df427b73066daf3a7dd5eb4befdfb14d
+  data.tar.gz: 68152b23448092ec5da50a052c600ff5f768eb1ff5ae20db37de174af785ef3a
 SHA512:
-  metadata.gz: d51e9a2180bab176ec59881c3a4f0096254c668d81cf7e728ae3cba97b6c6eab0804a94947894f1eb0f5d00b4e4aeefa51feb9fa486a02a1694891d67819c5c7
-  data.tar.gz: 6ffde82c2a3bd6434dd93e3ed305fa9d0c36af846aa4b4556ab47409fe032a56a27d4d7e8632c61772bd271e7c956a7712660ae5719c4c65341132ce25c482b7
+  metadata.gz: 11ab235ee54f4a3c42986a5c1f5a066b4ed235c530ff7011bbf7d02cd30afe403d8d82c158aa1bd974a0b320f3bcbf52d19cfb45cfc5012b4c1cc1afb7ba30c4
+  data.tar.gz: 03c9e3ca74579879996c8a3edf44f03e240dcd79c6418a599fd4ff6eb05a2084d506037139207dcc8713f785fd23cf0f7486e829c8d87511127036235b7875f5

data/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [1.3.4] - 2025-08-xx
+## [1.3.6] - 2026-05-26
 
 ### Added
 
@@ -10,6 +10,34 @@ All notable changes to this project will be documented in this file.
 
 ### Fixed
 
+## [1.3.5] - 2026-05-26
+
+### Changed
+
+- Moved `graphql` endpoint to `external/graphql`
+- Missing env var (i.e. `ORG_ID`) will **raise** now an error (instead of just a print)
+
+## [1.3.4] - 2025-09-04
+
+### Added
+
+- Command execution result: **added** command doc when there's a `results` error.
+- Payload improvements:
+  - On `LocationsError.validationErrors`: fetch `property` property.
+  - On **results**, `Command` always fetch `__typename` and the other properties.
+
+### Changed
+
+- Changed base `error_doc`: **consistent property name**
+
+### Fixed
+
+- Correct fetch on `ok` (sometimes it is `null`: that doesn't mean failed).
+- **Consistent order** on `error?` and `error_doc`.
+- `Draft`
+  - **Overlapping** name `ConflictingIds` (vs `LocationsError.conflictingIds`)
+  - **Wrong** include on `FetchNested`
+
 ## [1.3.3] - 2025-08-29
 
 ### Added

data/ecoportal-api-graphql.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop-rake', '~> 0'
   spec.add_development_dependency 'yard',         '>= 0.9.34', '< 1'
 
-  spec.add_dependency 'ecoportal-api',    '~> 0.10',  '>= 0.10.14'
+  spec.add_dependency 'ecoportal-api',    '~> 0.10',  '>= 0.10.15'
   spec.add_dependency 'ecoportal-api-v2', '~> 3.3',   '>= 3.3.1'
   spec.add_dependency 'graphlient',       '>= 0.8.0', '< 0.9'
 end

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

@@ -7,14 +7,13 @@ module Ecoportal
           TOKEN_AUTORENEW = 90 # minutes
 
           module InstanceMethods
-            def session_token(host: server, version: nil, auto_renew: true)
-              session_token_data(host: host, version: version).then do |body|
+            def session_token(host: server, auto_renew: true)
+              session_token_data(host: host).then do |body|
                 next unless body
 
                 if auto_renew && token_renew?(body['expires_in'])
                   session_token_renewed(
                     host:          host,
-                    version:       version,
                     refresh_token: body['refresh_token']
                   )
                 else
@@ -23,15 +22,14 @@ module Ecoportal
               end
             end
 
-            def session_token_renewed(host: server, version: nil, refresh_token: nil)
+            def session_token_renewed(host: server, refresh_token: nil)
               unless refresh_token
-                return unless (body = session_token_data(host: host, version: version))
+                return unless (body = session_token_data(host: host))
                 return unless (refresh_token = body['resfresh_token'])
               end
 
               session_refresh_token_data(
                 host:          host,
-                version:       version,
                 refresh_token: refresh_token
               ).then do |bdy|
                 bdy['access_token'] if bdy
@@ -40,8 +38,8 @@ module Ecoportal
 
             private
 
-            def session_token_data(host: server, version: nil)
-              http_client(host: host, version: version).post(
+            def session_token_data(host: server)
+              auth_http_client(host: host).post(
                 '/oauth/token',
                 data: {
                   'grant_type' => 'password',
@@ -53,8 +51,8 @@ module Ecoportal
               end
             end
 
-            def session_refresh_token_data(refresh_token:, host: server, version: nil)
-              http_client(host: host, version: version).post(
+            def session_refresh_token_data(refresh_token:, host: server)
+              auth_http_client(host: host).post(
                 '/oauth/token',
                 data: {
                   'grant_type'    => 'refresh_token',
@@ -69,10 +67,10 @@ module Ecoportal
               (TOKEN_AUTORENEW * 60) > seconds
             end
 
-            def http_client(host: server, version: nil)
-              @http_client ||= Ecoportal::API::Common::GraphQL::HttpClient.new(
+            def auth_http_client(host: server)
+              @auth_http_client ||= Ecoportal::API::Common::GraphQL::HttpClient.new(
                 host:    host,
-                version: version
+                version: 'http'
               )
             end
 
@@ -89,7 +87,7 @@ module Ecoportal
             end
 
             def fetch_env_required(name)
-              abort("Missing ENV '#{name}'") unless ENV.key?(name)
+              raise "Missing ENV '#{name}'" unless ENV.key?(name)
               ENV[name]
             end
 

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

@@ -4,6 +4,8 @@ module Ecoportal
     module Common
       module GraphQL
         class Client < ::Graphlient::Client
+          ENDPOINT_PATH = 'external/graphql'.freeze
+
           attr_accessor :host
 
           READ_TIMEOUT  = 90
@@ -42,7 +44,12 @@ module Ecoportal
           end
 
           def new(org_id: self.org_id, host: self.host, schema_path: host, no_schema: @no_schema)
-            self.class.new(org_id: org_id, host: host, schema_path: schema_path, no_schema: no_schema)
+            self.class.new(
+              org_id:      org_id,
+              host:        host,
+              schema_path: schema_path,
+              no_schema:   no_schema
+            )
           end
 
           def org_id
@@ -52,7 +59,8 @@ module Ecoportal
           private
 
           def url
-            "#{Ecoportal::API::Common::GraphQL::HttpClient.base_url(host)}/api/#{org_id}/graphql"
+            base_url = Ecoportal::API::Common::GraphQL::HttpClient.base_url(host)
+            "#{base_url}/api/#{org_id}/#{ENDPOINT_PATH}"
           end
         end
       end

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

@@ -13,20 +13,36 @@ module Ecoportal
             end
           end
 
+          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:      nil,
+            version:      'graphql',
             host:         'live.ecoportal.com',
             logger:       ::Logger.new(IO::NULL),
-            deep_logging: false
+            deep_logging: false,
+            no_schema:    true
           )
-            super
-          end
+            @org_id      = org_id
+            @user_email  = email
+            @user_pass   = pass
+            @no_schema   = no_schema
+            @version     = version
 
-          def refresh_key(value)
-            @api_key = value
+            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.
@@ -35,52 +51,92 @@ module Ecoportal
           def base_request
             @base_request ||=
               case @version
-              when NilClass
-                HTTP.accept(:json)
-              when 'v2'
-                HTTP.headers('X-ECOPORTAL-API-KEY' => key_token).accept(:json)
+              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 #{key_token}").accept(:json)
-              else
-                HTTP.headers('X-ApiKey' => key_token).accept(:json)
+                HTTP.headers('Authorization' => "Bearer #{key_token}")
+              end.then do |request|
+                request.accept(:json).timeout(
+                  read:  READ_TIMEOUT,
+                  write: WRITE_TIMEOUT
+                )
               end
           end
 
+          def org_id
+            @org_id || fetch_env_required('ORGANIZATION_ID')
+          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)
-            version? ? "#{base_url_api}#{path}" : "#{base_url}#{path}"
+            "#{api_url}#{path}"
           end
 
           private
 
-          def version?
-            !!@version
+          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 protocol
-            @protocol ||= self.class.protocol(host)
+          def api_url
+            base_url.then do |url|
+              next "#{url}/api/#{version}"        if v1_0? || v2_3?
+              next "#{url}/api/#{org_id}/graphql" if graphql?
+
+              url
+            end
           end
 
           def base_url
             @base_url ||= self.class.base_url(host)
           end
 
-          def base_url_api
-            @base_url_api ||= "#{base_url}/api/#{version}"
+          def protocol
+            @protocol ||= self.class.protocol(host)
           end
 
-          def key_token
-            if @api_key.nil? || @api_key.match(/\A\W*\z/)
-              if (version == 'v0') && (key = ENV['ORG_INT_KEY'])
-                key
-              elsif !version.nil?
-                puts 'Api-key missing!'
-              end
-            else
-              @api_key
-            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
         end
       end

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

@@ -7,8 +7,8 @@ module Ecoportal
   end
 end
 
-require 'ecoportal/api/common/graphql/http_client'
 require 'ecoportal/api/common/graphql/auth_service'
+require 'ecoportal/api/common/graphql/http_client'
 require 'ecoportal/api/common/graphql/client'
 require 'ecoportal/api/common/graphql/class_helpers'
 require 'ecoportal/api/common/graphql/hash_helpers'

data/lib/ecoportal/api/graphql/base/location_structure/draft.rb

@@ -11,46 +11,50 @@ module Ecoportal
             passkey :id
 
             passthrough :name, :notes
-            passboolean :commited, :ok
+
+            passboolean :commited
             alias_method :commited?, :commited
-            alias_method :ok?, :ok
 
             embeds_one :createdAt, klass: Base::DateTime
 
+            embeds_one :structure, klass: :structure_class
+
             passarray :conflictingIds
             embeds_many :commands, klass: Interface::LocationStructure::Command
             embeds_many :results, read_only: true, klass: "Ecoportal::API::GraphQL::Payload::LocationStructure::CommandExecutionResult"
 
-            embeds_one :structure, klass: :structure_class
+            passboolean :ok
 
-            include Error::LocationsError::FetchNested
+            def ok?
+              ok != false
+            end
+
+            def success?
+              !error?
+            end
 
             def error?
-              !ok?               ||
+              conflictingIds?    ||
                 result_errors?   ||
-                conflictingIds?
+                !ok?
             end
 
             def error_doc
-              if result_errors?
+              if conflictingIds?
                 {
-                  results: [result_errors.first&.error_doc]
+                  conflictingIds: conflictingIds.doc
                 }
-              elsif conflictingIds?
+              elsif result_errors?
                 {
-                  conflictingIds: conflictingIds.doc
+                  results: [result_errors.first&.error_doc]
                 }
               elsif !ok?
                 {
-                  ok: false
+                  ok: ok
                 }
               end
             end
 
-            def success?
-              !error?
-            end
-
             def structure_id
               parent_structure&.id
             end
@@ -68,6 +72,10 @@ module Ecoportal
               _parent._parent
             end
 
+            def conflictingIds?
+              (conflictingIds || []).any?
+            end
+
             def result_errors?
               result_errors.any?
             end
@@ -75,10 +83,6 @@ module Ecoportal
             def result_errors
               results.select(&:error?)
             end
-
-            def conflictingIds?
-              (conflictingIds || []).any?
-            end
           end
         end
       end # GraphQL

data/lib/ecoportal/api/graphql/base/page/data_field.rb

@@ -0,0 +1,12 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Base
+        module Page
+          class DataField < Logic::BaseModel
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base/page/phased/stage.rb

@@ -0,0 +1,14 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Base
+        module Page
+          class Phased
+            class Stage < Logic::BaseModel
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base/page/phased.rb

@@ -0,0 +1,14 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Base
+        module Page
+          class Phased < Interface::BasePage
+            require_relative 'phased/stage'
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/base/page/section.rb

@@ -0,0 +1,12 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Base
+        module Page
+          class Section < Logic::BaseModel
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -2,9 +2,13 @@ module Ecoportal
   module API
     class GraphQL
       module Base
-        class Page < Interface::BasePage
+        module Page
         end
       end
     end
   end
 end
+
+require_relative 'page/data_field'
+require_relative 'page/section'
+require_relative 'page/phased'

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

@@ -7,18 +7,18 @@ module Ecoportal
   end
 end
 
-require 'ecoportal/api/graphql/base/date_time'
-require 'ecoportal/api/graphql/base/page_info'
-require 'ecoportal/api/graphql/base/location_classification_type'
-require 'ecoportal/api/graphql/base/location_node'
-require 'ecoportal/api/graphql/base/location_structure'
-require 'ecoportal/api/graphql/base/person_member'
-require 'ecoportal/api/graphql/base/file_attachment'
-require 'ecoportal/api/graphql/base/file_container'
-require 'ecoportal/api/graphql/base/field'
-require 'ecoportal/api/graphql/base/page'
-require 'ecoportal/api/graphql/base/resource'
-require 'ecoportal/api/graphql/base/action_category'
-require 'ecoportal/api/graphql/base/action'
-require 'ecoportal/api/graphql/base/contractor_entity'
-require 'ecoportal/api/graphql/base/organization'
+require_relative 'base/date_time'
+require_relative 'base/page_info'
+require_relative 'base/location_classification_type'
+require_relative 'base/location_node'
+require_relative 'base/location_structure'
+require_relative 'base/person_member'
+require_relative 'base/file_attachment'
+require_relative 'base/file_container'
+require_relative 'base/field'
+require_relative 'base/page'
+require_relative 'base/resource'
+require_relative 'base/action_category'
+require_relative 'base/action'
+require_relative 'base/contractor_entity'
+require_relative 'base/organization'

data/lib/ecoportal/api/graphql/builder/page.rb

@@ -0,0 +1,41 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Builder
+        class Page
+          attr_reader :client
+
+          def initialize(client)
+            @client = client
+          end
+
+          # def archive(**kargs, &block)
+          #   archiveMutation.query(**kargs, &block)
+          # end
+
+          # def update(**kargs, &block)
+          #   updateMutation.query(**kargs, &block)
+          # end
+
+          # def create(**kargs, &block)
+          #   createMutation.query(**kargs, &block)
+          # end
+
+          private
+
+          # def archiveMutation
+          #   Mutation::Page::Archive.new(client)
+          # end
+
+          # def updateMutation
+          #   Mutation::Page::Update.new(client)
+          # end
+
+          # def createMutation
+          #   Mutation::Page::Create.new(client)
+          # end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/builder/register.rb

@@ -0,0 +1,41 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Builder
+        class Register
+          attr_reader :client
+
+          def initialize(client)
+            @client = client
+          end
+
+          # def archive(**kargs, &block)
+          #   archiveMutation.query(**kargs, &block)
+          # end
+
+          # def update(**kargs, &block)
+          #   updateMutation.query(**kargs, &block)
+          # end
+
+          # def create(**kargs, &block)
+          #   createMutation.query(**kargs, &block)
+          # end
+
+          private
+
+          # def archiveMutation
+          #   Mutation::Register::Archive.new(client)
+          # end
+
+          # def updateMutation
+          #   Mutation::Register::Update.new(client)
+          # end
+
+          # def createMutation
+          #   Mutation::Register::Create.new(client)
+          # end
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/graphql/builder.rb

@@ -7,6 +7,8 @@ module Ecoportal
   end
 end
 
-require 'ecoportal/api/graphql/builder/location_structure'
-require 'ecoportal/api/graphql/builder/action'
-require 'ecoportal/api/graphql/builder/contractor_entity'
+require_relative 'builder/location_structure'
+require_relative 'builder/action'
+require_relative 'builder/contractor_entity'
+require_relative 'builder/register'
+require_relative 'builder/page'