ecoportal-api-graphql 0.4.2 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5cc7a322eed9a692a7a7ec622a38909b66f0653b37f62743ce9edbc89010fc5
-  data.tar.gz: c04a73b90dbec766e8be560880cb997415445da8bb5ae5a97185235951763637
+  metadata.gz: 2e9ec208e89d9a86ad745b0138d3c5ecf3105de642c9fc4ededae17e7a6e278a
+  data.tar.gz: 57d342befa5dd0e2f713bd1a79a9f49ea6367b4fc0da262f0362faaeb21c6195
 SHA512:
-  metadata.gz: 70d02bea3953e7a1aac6691fcda1c85cec8bcbd70e4254761d5dc5f99189712e05efedf7e63e4726cf1ac5732d68c3cc2168f932ca6584fca06304fe052d9a13
-  data.tar.gz: 9c415037ed41fdae532fa3c53fdce546099479c4e70e4ae3ab81bfe5868e5afaa2e778eb57fc059be814f7c2fce18e7940ea7ab72eb7b74ca76cc6f10b091e6c
+  metadata.gz: 5d3ea5e64afc249e874d38e4ed1000056c1663ba1b0edd9304b09cf8d999b6a0dd543e47819160742fcc7d73feb4bc7e389c47feba02bc0501a7cc9ff4da62b8
+  data.tar.gz: 76ac28462d5d3dbcb5239a13865f026cd790d1272feec8d9c223b8808309fee14cf8ca59a4bc1992f9aaf6a64df986dc10af21c1c27eddb1d9b9c939d2ac30f8

data/CHANGELOG.md

@@ -9,7 +9,7 @@ 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.5] - 2025-02-xx
 
 ### Added
 
@@ -17,11 +17,35 @@ All notable changes to this project will be documented in this file.
 
 ### Fixed
 
+## [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
+
+- `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 `ecoportal-api-v2` gem
+- 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.3'
-  spec.add_dependency 'ecoportal-api-v2', '~> 2.0', '>= 2.0.10'
+  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/auth_service.rb

@@ -3,7 +3,7 @@ module Ecoportal
     module Common
       module GraphQL
         module AuthService
-          DEFAULT_SERVER  = "live.ecoportal.com".freeze
+          DEFAULT_SERVER  = 'live.ecoportal.com'.freeze
           TOKEN_AUTORENEW = 90 # minutes
 
           module InstanceMethods
@@ -11,14 +11,14 @@ module Ecoportal
               session_token_data(host: host, version: version).then do |body|
                 next unless body
 
-                if auto_renew && token_renew?(body["expires_in"])
+                if auto_renew && token_renew?(body['expires_in'])
                   session_token_renewed(
                     host:          host,
                     version:       version,
-                    refresh_token: body["refresh_token"]
+                    refresh_token: body['refresh_token']
                   )
                 else
-                  body["access_token"]
+                  body['access_token']
                 end
               end
             end
@@ -26,7 +26,7 @@ module Ecoportal
             def session_token_renewed(host: server, version: nil, refresh_token: nil)
               unless refresh_token
                 return unless (body = session_token_data(host: host, version: version))
-                return unless (refresh_token = body["resfresh_token"])
+                return unless (refresh_token = body['resfresh_token'])
               end
 
               session_refresh_token_data(
@@ -34,7 +34,7 @@ module Ecoportal
                 version:       version,
                 refresh_token: refresh_token
               ).then do |bdy|
-                bdy["access_token"] if bdy
+                bdy['access_token'] if bdy
               end
             end
 
@@ -42,11 +42,11 @@ module Ecoportal
 
             def session_token_data(host: server, version: nil)
               http_client(host: host, version: version).post(
-                "/oauth/token",
+                '/oauth/token',
                 data: {
-                  "grant_type" => "password",
-                  "email"      => user_email,
-                  "password"   => user_pass
+                  'grant_type' => 'password',
+                  'email'      => user_email,
+                  'password'   => user_pass
                 }
               ).then do |response|
                 next response.body if response.success?
@@ -55,10 +55,10 @@ module Ecoportal
 
             def session_refresh_token_data(refresh_token:, host: server, version: nil)
               http_client(host: host, version: version).post(
-                "/oauth/token",
+                '/oauth/token',
                 data: {
-                  "grant_type"    => "refresh_token",
-                  "refresh_token" => refresh_token
+                  'grant_type'    => 'refresh_token',
+                  'refresh_token' => refresh_token
                 }
               ).then do |response|
                 next response.body if response.success?
@@ -77,11 +77,11 @@ module Ecoportal
             end
 
             def user_email
-              @user_email || fetch_env_required("USER_EMAIL")
+              @user_email || fetch_env_required('USER_EMAIL')
             end
 
             def user_pass
-              @user_pass || fetch_env_required("USER_PASS")
+              @user_pass || fetch_env_required('USER_PASS')
             end
 
             def server(default = DEFAULT_SERVER)

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/client.rb

@@ -45,7 +45,7 @@ module Ecoportal
           end
 
           def org_id
-            @org_id || fetch_env_required("ORGANIZATION_ID")
+            @org_id || fetch_env_required('ORGANIZATION_ID')
           end
 
           private

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

@@ -9,26 +9,20 @@ module Ecoportal
             end
 
             def protocol(host)
-              host.match(/^localhost|^127\.0\.0\.1/)? "http" : "https"
+              host.match(/^localhost|^127\.0\.0\.1/)? 'http' : 'https'
             end
           end
 
           attr_reader :host, :version
 
           def initialize(
-            api_key:          nil,
-            version:          "v1",
-            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)
@@ -43,12 +37,12 @@ module Ecoportal
               case @version
               when NilClass
                 HTTP.accept(:json)
-              when "v2"
-                HTTP.headers("X-ECOPORTAL-API-KEY" => key_token).accept(:json)
-              when "graphql"
-                HTTP.headers("Authorization" => "Bearer #{key_token}").accept(:json)
+              when 'v2'
+                HTTP.headers('X-ECOPORTAL-API-KEY' => key_token).accept(:json)
+              when 'graphql'
+                HTTP.headers('Authorization' => "Bearer #{key_token}").accept(:json)
               else
-                HTTP.headers("X-ApiKey" => key_token).accept(:json)
+                HTTP.headers('X-ApiKey' => key_token).accept(:json)
               end
           end
 
@@ -79,10 +73,10 @@ module Ecoportal
 
           def key_token
             if @api_key.nil? || @api_key.match(/\A\W*\z/)
-              if (version == "v0") && (key = ENV['ORG_INT_KEY'])
+              if (version == 'v0') && (key = ENV['ORG_INT_KEY'])
                 key
-              else
-                puts "Api-key missing!"
+              elsif !version.nil?
+                puts 'Api-key missing!'
               end
             else
               @api_key

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,6 +3,8 @@ module Ecoportal
     class GraphQL
       module Base
         class Action < Ecoportal::API::GraphQL::Base::Model
+          root!
+
           passkey :id
           passthrough :altId
           passthrough :name, :description