ecoportal-api-graphql 0.4.3 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9179222ef94ebb52697888787734813f4aacf5e8267dea6b54c82862087779e0
-  data.tar.gz: 495f596b1aef1e11c1fb2bd102bfbdd073325c64f81b608d4d53230ac5037d82
+  metadata.gz: a3e3519f253819b10dad7bd065d244dd90a3d7cd3e2ebe224f20bc4ccb83185d
+  data.tar.gz: 2045d67da3b50b55feaab8bce0fbd67935c79e9947878e4d9483df1fd2cad596
 SHA512:
-  metadata.gz: 92e8cbd28c4b3d38fcbecf2284c6a6ff268641417009515cd62964eb7a539b2bbdf75fbcd9423e1616c943f49c1ba722c69bb845a0b8870dfa091f25b429a8e3
-  data.tar.gz: d5812a7922aa767e912ae4385b3b6117d63e9fbafbf2a4cc404ae274982b2fa0ca95ec6e632544a1d16decde89adb4a8503c253ae0a74a8fb599a7f53d0e6b1d
+  metadata.gz: 0f64880b73ca0cc855d1d8cbe179e1dda7f79f73b88b9f9d4e41883ef631ee7fac41ced10dc3c1a56f821afe7d9bb4faa239aae86703ffcf4a55a564145c3788
+  data.tar.gz: 1cb72054839f0aa37d35f86c6ba1a55914c65c721bddc03ea6100d0126a4a42c176fecfb917c35e8b0302db85a726ffa59f12d7dbf0a8e07b3a57f28612fdd3f

data/CHANGELOG.md

@@ -9,24 +9,54 @@ All notable changes to this project will be documented in this file.
   - Analyse how to "DSL" currentOrganization.action.activities
     - review `path` tracking
 
-## [0.4.3] - 2024-10-xx
+## [0.4.6] - 2025-03-xx
 
 ### Added
 
 ### Changed
 
-- upgrade core gem
-- `Ecoportal::API::Common::GraphQL::HttpClient.new` ceased to default `version` to `v1` (now it defaults to `nil`)
+### Fixed
+
+## [0.4.5] - 2025-03-14
+
+### Added
+
+- Query `actionCategories`
+- Mutation **create** `Action`
+
+### Changed
+
+- `Action` model to have `locations` (**RS** upgrade)
+
+## [0.4.4] - 2025-02-23
+
+### Changed
+
+- Upgraded `ecoportal-api` gem (maintanance)
+- Upgraded `ecoportal-api-v2` gem (to provision `root!` class method)
+- Defined some models that hand on their own as `root!`
+- Refactored `Base::Model` by moving its loggic to `Common::GraphQL`
 
 ### Fixed
 
-## [0.4.2] - 2024-10-01
+- `Ecoportal::API::Common::GraphQL::HashHelpers`
+  - Truly make the iterator generic
+
+## [0.4.3] - 2024-11-21
 
 ### Changed
 
 - upgrade gems
   - `ecoportal-api`
   - `ecoportal-api-v2`
+- `Ecoportal::API::Common::GraphQL::HttpClient.new` ceased to default `version` to `v1` (now it defaults to `nil`)
+
+## [0.4.2] - 2024-10-01
+
+### Changed
+
+- upgrade gems
+  - `ecoportal-api-v2`
 - add explicit dependency onto `ecoportal-api` gem (client)
 
 ## [0.4.1] - 2024-08-09

data/Rakefile

@@ -1,36 +1,36 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
-require "yard"
-require "redcarpet"
+require 'yard'
+require 'redcarpet'
 
-desc "run the specs"
+desc 'run the specs'
 RSpec::Core::RakeTask.new(:spec)
 
-desc "run rspec showing backtrace"
+desc 'run rspec showing backtrace'
 RSpec::Core::RakeTask.new(:spec_trace) do |task|
   task.rspec_opts = ['--backtrace']
 end
 task :rspec_trace => :spec_trace
 
-desc "run rspec stopping on first fail, and show backtrace"
+desc 'run rspec stopping on first fail, and show backtrace'
 RSpec::Core::RakeTask.new(:spec_fast) do |task|
   task.rspec_opts = ['--fail-fast', '--backtrace']
 end
 task :rspec_fast  => :spec_fast
 
-desc "run rubocop diaplying cop names"
+desc 'run rubocop diaplying cop names'
 RuboCop::RakeTask.new(:rubocop) do |t|
   t.options = ['--display-cop-names']
 end
 
 # default task name is yard
-desc "Yard: generate all the documentation"
+desc 'Yard: generate all the documentation'
 YARD::Rake::YardocTask.new(:doc) do |t|
   #t.files = ['lib/**/*.rb']
 end
 
-desc "default task: runs rubocop and rspec"
+desc 'default task: runs rubocop and rspec'
 task :default do
   Rake::Task[:rubocop].invoke
 ensure

data/ecoportal-api-graphql.gemspec

@@ -1,15 +1,16 @@
+# rubocop:disable Gemspec/DevelopmentDependencies
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "ecoportal/api/graphql_version"
+require 'ecoportal/api/graphql_version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "ecoportal-api-graphql"
+  spec.name          = 'ecoportal-api-graphql'
   spec.version       = Ecoportal::API::GRAPQL_VERSION
-  spec.authors       = ["Oscar Segura"]
-  spec.email         = ["oscar@ecoportal.co.nz"]
+  spec.authors       = ['Oscar Segura']
+  spec.email         = ['oscar@ecoportal.co.nz']
 
-  spec.summary       = "A collection of helpers for interacting with the ecoPortal GraphQL API"
-  spec.homepage      = "https://www.ecoportal.com"
+  spec.summary       = 'A collection of helpers for interacting with the ecoPortal GraphQL API'
+  spec.homepage      = 'https://www.ecoportal.com'
   spec.licenses      = %w[MIT]
 
   spec.metadata['rubygems_mfa_required'] = 'true'
@@ -19,19 +20,21 @@ Gem::Specification.new do |spec|
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "rspec",     ">= 3.12.0", "< 4"
-  spec.add_development_dependency "rake",      ">= 13.0.3", "< 14"
-  spec.add_development_dependency "yard",      ">= 0.9.34", "< 1"
-  spec.add_development_dependency "redcarpet", ">= 3.6.0",  "< 4"
-  spec.add_development_dependency "rubocop",   "~> 1"
-  spec.add_development_dependency "rubocop-rake", "~> 0"
-  spec.add_development_dependency "pry"      , ">= 0.14"
-
-  spec.add_dependency 'ecoportal-api',    '~> 0.10',  '>= 0.10.7'
-  spec.add_dependency 'ecoportal-api-v2', '~> 2.0',   '>= 2.0.12'
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'pry',          '>= 0.14'
+  spec.add_development_dependency 'rake',         '>= 13.0.3', '< 14'
+  spec.add_development_dependency 'redcarpet',    '>= 3.6.0',  '< 4'
+  spec.add_development_dependency 'rspec',        '>= 3.12.0', '< 4'
+  spec.add_development_dependency 'rubocop',      '~> 1'
+  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.8'
+  spec.add_dependency 'ecoportal-api-v2', '~> 2.0',   '>= 2.0.15'
   spec.add_dependency 'graphlient',       '>= 0.8.0', '< 0.9'
 end
+
+# rubocop:enable Gemspec/DevelopmentDependencies

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

@@ -7,7 +7,10 @@ module Ecoportal
             def becomes(klass)
               klass.new.tap do |becoming|
                 instance_variables.each do |var|
-                  becoming.instance_variable_set(var, instance_variable_get(var))
+                  becoming.instance_variable_set(
+                    var,
+                    instance_variable_get(var)
+                  )
                 end
               end
             end
@@ -23,11 +26,11 @@ module Ecoportal
             def const?(value)
               begin
                 const_get(value)
-              rescue NameError => e
+              rescue NameError
                 return false
               end
               true
-            end            
+            end
           end
 
           class << self

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

@@ -4,48 +4,32 @@ module Ecoportal
       module GraphQL
         module HashHelpers
           module InstanceMethods
-            def transform_keys_deep(value, &block)
-              case value
-              when Hash
-                value.dup.each_with_object({}) do |(k, v), out|
-                  k_val = block_given?? yield(k) : k
-                  out[k_val] = keys_to_sym_deep(v)
-                end
-              when Enumerable
-                value.map {|v| keys_to_sym_deep(v)}
-              else
-                value
-              end
-            end
-
             def keys_to_sym_deep(value)
-               transform_keys_deep(value) {|k| k.to_sym}
+              transform_keys_deep(value, &:to_sym)
             end
 
             def keys_to_s_deep(value)
-              transform_keys_deep(value) {|k| k.to_s}
+              transform_keys_deep(value, &:to_s)
             end
 
-            def remove_nil_keys_deep(value, target: [])
-              target = [target].flatten.compact unless target.is_a?(Array)
-              return value if target.empty?
-              case value
-              when Hash
-                value.dup.each_with_object({}) do |(k, v), out|
-                  next unless v || !target.include?(k)
-                  out[k] = remove_nil_keys_deep(v, target: target)
-                end
-              when Enumerable
-                value.map {|v| remove_nil_keys_deep(v, target: target)}
-              else
-                value
+            def except_keys(value, *keys)
+              return value unless value.is_a?(Hash)
+
+              deep_dup(value).tap do |out|
+                keys.each {|key| out.delete(key)}
               end
             end
 
+            # Targetted removal of keys in `target` that are `nil`
+            def remove_nil_keys_deep(value, target: [])
+              remove_keys_deep_if(value, target: target, &:nil?)
+            end
+
+            # Based on Rails support.
             def deep_dup(data)
               case data
               when Hash
-                data.each_with_object({}) do |(k,v), copy|
+                data.each_with_object({}) do |(k, v), copy|
                   if k.is_a?(::String) || k.is_a?(::Symbol)
                     copy[k] = deep_dup(v)
                   else
@@ -59,6 +43,52 @@ module Ecoportal
                 data.dup
               end
             end
+
+            private
+
+            # Iterator
+            # @param value [Variadic]
+            # @return [value.class]
+            def transform_keys_deep(value, &block)
+              case value
+              when Hash
+                value.dup.each_with_object({}) do |(k, v), out|
+                  k_val      = block_given?? yield(k) : k
+                  out[k_val] = transform_keys_deep(v, &block)
+                end
+              when Enumerable
+                value.map {|v| transform_keys_deep(v, &block)}
+              else
+                value
+              end
+            end
+
+            # Targetted removal of keys in `target` that meet
+            # the `block` condition.
+            # @param value [Variadic]
+            # @param target [Array<String>, Array<Symbol>] the target
+            #   `keys` to yield `block` onto.
+            # @return [value.class]
+            def remove_keys_deep_if(value, target: [], &block)
+              msg = 'Expected block. None given.'
+              raise ArgumentError, msg unless block_given?
+
+              target = [target].flatten.compact
+              return value if target.empty?
+
+              case value
+              when Hash
+                value.dup.each_with_object({}) do |(k, v), out|
+                  next if yield(v) && target.include?(k) # skip
+
+                  out[k] = remove_nil_keys_deep(v, target: target, &block)
+                end
+              when Enumerable
+                value.map {|v| remove_nil_keys_deep(v, target: target, &block)}
+              else
+                value
+              end
+            end
           end
 
           module ClassMethods

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

@@ -16,19 +16,13 @@ module Ecoportal
           attr_reader :host, :version
 
           def initialize(
-            api_key:          nil,
-            version:          nil,
-            host:             'live.ecoportal.com',
-            logger:           ::Logger.new(IO::NULL),
-            deep_logging:     false
+            api_key:      nil,
+            version:      nil,
+            host:         'live.ecoportal.com',
+            logger:       ::Logger.new(IO::NULL),
+            deep_logging: false
           )
-            super(
-              api_key:          api_key,
-              version:          version,
-              host:             host,
-              logger:           logger,
-              deep_logging:     deep_logging
-            )
+            super
           end
 
           def refresh_key(value)

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

@@ -0,0 +1,40 @@
+module Ecoportal
+  module API
+    module Common
+      module GraphQL
+        class Model
+          module AsInput
+            class << self
+              def included(base)
+                super
+                base.send(:include, Model::Diffable)
+                base.extend ClassMethods
+              end
+            end
+
+            module ClassMethods
+              def as_input(hash, clientMutationId: '')
+                hash_input = Ecoportal::API::Common::GraphQL::HashHelpers.
+                  keys_to_sym_deep(hash)
+
+                hash_input.merge!(clientMutationId: clientMutationId)
+
+                Ecoportal::API::Common::GraphQL::HashHelpers.
+                  remove_nil_keys_deep(hash_input, target: :id)
+              end
+            end
+
+            # INSTANCE METHODS
+
+            def as_input(clientMutationId: '')
+              self.class.as_input(
+                as_update,
+                clientMutationId: clientMutationId
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# rubocop:disable Naming/MethodParameterName
+
+module Ecoportal
+  module API
+    module Common
+      module GraphQL
+        class Model
+          module Diffable
+            module HashDiff
+              class << self
+                def included(base)
+                  super
+                  base.extend ClassMethods
+                end
+              end
+
+              module ClassMethods
+                # @todo: refactor to only reach the current level
+                # @note the aim is to delegate `hash_diff` to the specific classes
+                #   of the model... bulding the payload/input_base in a cascaded
+                #   way (rather than in a one-off way from the top alone).
+                def hash_diff(a, b, ignore: [])
+                  case a
+                  when Hash
+                    {}.tap do |diffed|
+                      a.each do |key, a_value|
+                        b_value    = b && b[key]
+                        no_changes = (a_value == b_value) || ignore.include?(key)
+                        next if !ID_KEYS.include?(key) && no_changes
+
+                        diffed[key] = diff(a_value, b_value, ignore: ignore)
+                        diffed.delete(key) if diffed[key] == {}
+                      end
+
+                      # All keys are IDs, so it's actually blank
+                      return {} if (diffed.keys - ID_KEYS).empty?
+                    end
+                  when Array
+                    return a unless b.is_a?(Array) && a.length == b.length
+
+                    a.map.with_index do |a_value, idx|
+                      b_value = b[idx]
+                      diff(a_value, b_value, ignore: ignore)
+                    end.reject do |el|
+                      el == {}
+                    end
+                  else
+                    a
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+# rubocop:enable Naming/MethodParameterName

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

@@ -0,0 +1,32 @@
+require 'ecoportal/api/common/graphql/model/diffable/hash_diff'
+module Ecoportal
+  module API
+    module Common
+      module GraphQL
+        class Model
+          module Diffable
+            class << self
+              def included(base)
+                super
+                base.send(:include, HashDiff)
+              end
+            end
+
+            # INSTANCE METHODS
+
+            def as_update(ref = :last, ignore: [])
+              new_doc = as_json
+              ref_doc = ref == :total ? initial_doc : original_doc
+
+              self.class.hash_diff(
+                new_doc,
+                ref_doc,
+                ignore: ignore
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Ecoportal
+  module API
+    module Common
+      module GraphQL
+        class Model < Ecoportal::API::Common::Content::DoubleModel
+          require 'ecoportal/api/common/graphql/model/diffable'
+          require 'ecoportal/api/common/graphql/model/as_input'
+
+          include Ecoportal::API::Common::GraphQL::ClassHelpers
+
+          include Diffable
+          include AsInput
+        end
+      end
+    end
+  end
+end

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

@@ -15,7 +15,7 @@ module Ecoportal
           #   @return [Connection::$1, $1]
           def query(method, query_klass:, subpath: [])
             method = method.to_sym
-            class_method = "#{method}_query_class".to_sym
+            class_method = :"#{method}_query_class"
 
             define_method(method) do |**kargs, &block|
               if kargs.empty? && !block_given?
@@ -27,9 +27,12 @@ module Ecoportal
 
             define_method(class_method) do
               final_path = path + [subpath].flatten.compact
+
               resolve_class(query_klass).tap do |klass|
                 unless klass <= Ecoportal::API::GraphQL::Logic::BaseQuery
-                  raise "Expected query_klass to be of type Ecoportal::API::GraphQL::Logic::BaseQuery. Given: #{klass}"
+                  msg  = "Expected query_klass to be of type Ecoportal::API::GraphQL::Logic::BaseQuery. "
+                  msg << "Given: #{klass}"
+                  raise msg
                 end
               end.new(client, base_path: final_path)
             end

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

@@ -11,7 +11,6 @@ require 'ecoportal/api/common/graphql/http_client'
 require 'ecoportal/api/common/graphql/auth_service'
 require 'ecoportal/api/common/graphql/client'
 require 'ecoportal/api/common/graphql/class_helpers'
-require 'ecoportal/api/common/graphql/doc_helpers'
 require 'ecoportal/api/common/graphql/hash_helpers'
-require 'ecoportal/api/common/graphql/patches'
+require 'ecoportal/api/common/graphql/model'
 require 'ecoportal/api/common/graphql/query_integration'

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

@@ -3,12 +3,14 @@ module Ecoportal
     class GraphQL
       module Base
         class Action < Ecoportal::API::GraphQL::Base::Model
+          root!
+
           passkey :id
           passthrough :altId
           passthrough :name, :description
           passthrough :age
 
-          passarray :tags, :location
+          passarray :locationIds
 
           passthrough :status, :relativeStatus
           passboolean :archived, :attached, :standaloneAction

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

@@ -3,8 +3,10 @@ module Ecoportal
     class GraphQL
       module Base
         class ActionCategory < Ecoportal::API::GraphQL::Base::Model
+          root!
+
           passkey :id
-          passthrough :name, :value
+          passthrough :name, :value, :weight
           passboolean :archived
         end
       end

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

@@ -3,6 +3,8 @@ module Ecoportal
     class GraphQL
       module Base
         class ContractorEntity < Ecoportal::API::GraphQL::Base::Model
+          root!
+
           passkey :id
           passthrough :externalId
           passthrough :name

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

@@ -3,7 +3,7 @@ module Ecoportal
     class GraphQL
       module Base
         class LocationClassificationType < Ecoportal::API::GraphQL::Base::Model
-          read_only!
+          root!
 
           passkey :id
           passthrough :name

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

@@ -3,6 +3,8 @@ module Ecoportal
     class GraphQL
       module Base
         class LocationNode < Ecoportal::API::GraphQL::Base::Model
+          root!
+
           passkey :id
           passthrough :name
           passthrough :weight

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

@@ -4,6 +4,7 @@ module Ecoportal
       module Base
         class LocationStructure < Ecoportal::API::GraphQL::Base::Model
           read_only!
+
           extend Ecoportal::API::GraphQL::Helpers::LocationsTree
 
           passkey :id

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

@@ -2,29 +2,9 @@ module Ecoportal
   module API
     class GraphQL
       module Base
-        class Model < Ecoportal::API::Common::Content::DoubleModel
-          include Ecoportal::API::Common::GraphQL::ClassHelpers
-          #include GraphModel::HashKeys
+        class Model < Ecoportal::API::Common::GraphQL::Model
           class << self
             attr_accessor :client
-            
-            def as_input(hash, clientMutationId: "")
-              hash_input = hash.merge(clientMutationId: clientMutationId)
-              Ecoportal::API::Common::GraphQL::HashHelpers.remove_nil_keys_deep(hash_input, target: :id)
-            end
-          end
-
-          def as_update(ref = :last, ignore: [], sym_keys: false)
-            new_doc = as_json
-            ref_doc = ref == :total ? initial_doc : original_doc
-            Ecoportal::API::Common::HashDiff.diff(new_doc, ref_doc, ignore: ignore).yield_self do |out|
-              next out unless sym_keys
-              Ecoportal::API::Common::GraphQL::HashHelpers.keys_to_sym_deep(out)
-            end
-          end
-
-          def as_input(clientMutationId: "")
-            self.class.as_input(as_update(sym_keys: true), clientMutationId: clientMutationId)
           end
         end
       end

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

@@ -3,6 +3,8 @@ module Ecoportal
     class GraphQL
       module Base
         class Organization < Ecoportal::API::GraphQL::Base::Model
+          root!
+
           passkey :id
           passthrough :name, :companyName
           passthrough :logoUrl, read_only: true

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

@@ -3,6 +3,8 @@ module Ecoportal
     class GraphQL
       module Base
         class Page < Ecoportal::API::GraphQL::Base::Model
+          root!
+
           passkey :id
           passthrough :mouldCounter, :name
         end

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

@@ -3,6 +3,8 @@ module Ecoportal
     class GraphQL
       module Base
         class PersonMember < Ecoportal::API::GraphQL::Base::Model
+          root!
+
           passkey :id
           passthrough :name, :email
           passarray :tagRestrict, :userGroupIds