ecoportal-api-graphql 0.1.9 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a149d79e773d8c7a3036e78bd729fbd9630937284517854656738f97acd0022
-  data.tar.gz: 491b8e694b341cdad48467f062243dd7677228083f9fde3765f4249b76c270f4
+  metadata.gz: f2fc73626ffb4955b88d20778e32206ad4b989fc47bcc6abbdaf748c035244a6
+  data.tar.gz: c00e9f570f81de6520ef738c8cd059dbfb6d80fe18613599d2a6f7ad53556416
 SHA512:
-  metadata.gz: df671787213260d751f1f381d4ec0706a98fc68690a32d01fdfe8448ff9cf4ae4d3e9d2154ad1ba0fbce6d900a89fbc2ce32015cdf9df047850fa7b1cfa63771
-  data.tar.gz: 28fe2d48c1ce8417e9803554ae6d6d27b5539129163dee98853f6e4837dd46e78b35f73945ec19e98850505b76932460966a57e3f6812971cc43292d229a1967
+  metadata.gz: 04477f6f4c8014bccd9f1fc93625f031991e0f0bd979af476ec859f1802832726686a06f1dfa665c9d0ec8762d38eb03aa5bb621a51a28112b513b0b80ef7f37
+  data.tar.gz: 249e23c774b1ee031c18d7e53a5be53948c3bf7f5bfffcb2fe4d679a4ab249d81ab59498878a0e2b209720cf6e0b556fef555b0d8dab1bf710be4b2dd243b0d4

data/CHANGELOG.md

@@ -1,19 +1,45 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.1.10] - 2022-09-xx
+## [0.1.13] - 2022-11-xx
 
 ### Added
 ### Changed
 ### Fixed
 
 ### ToDo
-  - Make `GraphQL` default fragments work
-  - Add update/create operations for `ContractorEntity`
+  - Add update operation for `ContractorEntity`
   - Add currentOrganization.action
     - Analyse how to "DSL" currentOrganization.action.activities
       - review `path` tracking
 
+## [0.1.12] - 2022-11-xx
+
+### Added
+  - `Ecoportal::API::GraphQL::Base::Mutation`
+  - Added `createContractorEntity`
+
+### Changed
+  - Slight internal refactor of `Ecoportal::API::GraphQL::Base::Query`
+  - Upgraded `ecoportal-api-v2` **gem** dependency
+
+## [0.1.11] - 2022-11-02
+
+### Added
+### Changed
+  - **upgraded** `graphlient` gem dependency (support for framents)
+    - removed patch in this gem
+
+### Fixed
+
+## [0.1.10] - 2022-09-29
+
+### Changed
+  - **upgraded** `ecoportal-api-v2` gem dependency
+
+### Fixed
+  - Remove debugging message
+
 ## [0.1.9] - 2022-09-26
 
 ### Added
@@ -23,6 +49,7 @@ All notable changes to this project will be documented in this file.
   - **upgraded** `ecoportal-api-v2` gem dependency
   - added `Ecoportal::API::Common::GraphQL::QueryIntegration`
     - restructured `Ecoportal::API::GraphQL::Model::Organization` class
+  - **Patch** on `Graphlient::Query` for fragments support (**pull request**: https://github.com/ashkan18/graphlient/pull/94)
 
 ## [0.1.8] - 2022-09-23
 

data/ecoportal-api-graphql.gemspec

@@ -29,6 +29,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "redcarpet", ">= 3.5.1",  "< 3.6"
   spec.add_development_dependency "pry"      , ">= 0.14"
 
-  spec.add_dependency 'ecoportal-api-v2', '>= 0.9.1', '< 0.10'
-  spec.add_dependency 'graphlient',       '>= 0.6.0', '< 0.7'
+  spec.add_dependency 'ecoportal-api-v2', '>= 0.9.7', '< 0.10'
+  spec.add_dependency 'graphlient',       '>= 0.7.0', '< 0.8'
 end

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

@@ -1 +1 @@
-require_relative 'patches/query'
+#require_relative 'patches/query'

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

@@ -0,0 +1,98 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Base
+        class Mutation
+          class GenericPayload
+            def initialize(*args, **kargs)
+              raise "Missuse error. You should define a payload_class for a class that inherits from Mutation class."
+            end
+          end
+
+          include Ecoportal::API::Common::GraphQL::ClassHelpers
+
+          class << self
+            # Used to obtain the full `path` in the GraphQL query by using `base_path`
+            # @note it is meant for reusability of queries from different end-points
+            def field_name(str = nil)
+              return @field_name unless str
+              @field_name = nil
+              @field_name = str.to_s if str
+            end
+          end
+
+          class_resolver :payload_class, GenericPayload
+          attr_reader :client
+          attr_reader :base_path
+
+          def initialize(client, path: nil, base_path: [])
+            @path        = path
+            @base_path   = base_path
+            @client = client
+          end
+
+          # Resolves the `path` by using `path` or `base_path` + `class.field_name`.
+          def path(field_name = self.class.field_name)
+            result   = @path
+            result ||= default_path if self.respond_to?(:default_path, true)
+            result ||= (base_path + [field_name]) if base_path && field_name
+            result
+          end
+
+          # Query rely that manages the different blocks.
+          # @return [Class] an object of `response_class` with the results hanving from `path`.
+          def query(input:, path: self.path, &block)
+            request(*path) do
+              client.query(input: as_input(input), &basic_block(&block))
+            end
+          rescue Faraday::ParsingError => e
+            puts "Internal Error with these input ('#{input.class}'):"
+            pp input
+            raise
+          end
+
+          def response_class
+            payload_class
+          end
+
+          def access_point(path = [])
+            path.last
+          end
+
+          private
+
+          def basic_block(&block)
+            raise "This method should be implemented in the child class #{self.class}"
+          end
+
+          def as_input(value)
+            case value
+            when Hash
+              value
+            when Ecoportal::API::GraphQL::Base::Model
+              value.as_input
+            when Hash
+              value = Helpers::Model::HashKeys.keys_to_sym_deep(value)
+              Ecoportal::API::Base::Model.as_input(value)
+            when Enumerable
+              value.map {|v| as_input(v)}
+            else
+              raise ArgumentError.new("Expecting Hash, GraphQL::Base::Model or Enumerable. Unsupported type '#{value.class}'.")
+            end
+          end
+
+          def request(*path)
+            response = yield
+            wrap_response(response, path)
+          end
+
+          def wrap_response(response, path = [])
+            raise "Complete failure on request. Path: #{path}" unless res = response.to_h.dig(*path.dup.unshift("data"))
+            data = Ecoportal::API::Common::GraphQL::HashHelpers.deep_dup(res)
+            response_class.new(data)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -39,7 +39,6 @@ module Ecoportal
 
           class_resolver :item_class, GenericItem
           attr_reader :client
-
           attr_reader :base_path
 
           def initialize(client, path: nil, base_path: nil)
@@ -57,7 +56,7 @@ module Ecoportal
           end
 
           # Query rely that manages the different blocks.
-          # @return [Class] an object of `response_class` with the results hanving from `path`.
+          # @return [Class] an object of `response_class` with the results hanging from `path`.
           def query(path: self.path, **kargs, &block)
             graphql_query(path: path, **kargs, &basic_block(&block))
           end
@@ -72,6 +71,10 @@ module Ecoportal
 
           private
 
+          def basic_block
+            raise "This method should be implemented in the child class #{self.class}"
+          end
+
           def graphql_query(path: self.path, **kargs, &block)
             query_params = self.class.slice_params(kargs)
             request(*path) do
@@ -89,7 +92,7 @@ module Ecoportal
           end
 
           def wrap_response(response, path = [])
-            raise "Complete failure on request. Path: #{path}" unless res = response.to_h.dig("data", *path)
+            raise "Complete failure on request. Path: #{path}" unless res = response.to_h.dig(*path.dup.unshift("data"))
             data = Ecoportal::API::Common::GraphQL::HashHelpers.deep_dup(res)
             response_class.new(data)
           end

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

@@ -18,7 +18,6 @@ module Ecoportal
               item_class,
               inherits: Ecoportal::API::Common::Content::CollectionModel
             ) do |klass|
-              puts "created class #{klass}: item_class: #{item_class}"
               klass.klass = item_class
             end
           end

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

@@ -12,6 +12,7 @@ require 'ecoportal/api/graphql/base/date_time'
 require 'ecoportal/api/graphql/base/id_diff_input'
 require 'ecoportal/api/graphql/base/page_info'
 require 'ecoportal/api/graphql/base/query'
+require 'ecoportal/api/graphql/base/mutation'
 require 'ecoportal/api/graphql/base/connection'
 require 'ecoportal/api/graphql/base/query_array'
 require 'ecoportal/api/graphql/base/query_connection'

data/lib/ecoportal/api/graphql/mutation/create_contractor_entity.rb

@@ -0,0 +1,38 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Mutation
+        class CreateContractorEntity < Ecoportal::API::GraphQL::Base::Mutation
+          field_name :createContractorEntity
+
+          #class_resolver :item_class, Ecoportal::API::GraphQL::Model::ContractorEntity
+          class_resolver :payload_class, Ecoportal::API::GraphQL::Payload::CreateContractorEntity
+
+          private
+
+          def basic_block(&block)
+            payload_block = block || default_payload_block
+            Proc.new {
+              mutation(input: :CreateContractorEntityInput!) {
+                createContractorEntity(input: :input, &payload_block)
+              }
+            }
+          end
+
+          def default_payload_block
+            Proc.new {
+              clientMutationId
+              errors {
+                details
+                fullMessages
+              }
+              item {
+                ___Fragment__ContractorEntity
+              }
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Mutation
+      end
+    end
+  end
+end
+
+require 'ecoportal/api/graphql/mutation/create_contractor_entity'

data/lib/ecoportal/api/graphql.rb

@@ -25,6 +25,17 @@ module Ecoportal
       def currentOrganization
         currentOrganizationClass
       end
+
+      def createContractorEntity(input:, &block)
+        createContractorEntityMutation.query(input: input, &block)
+      end
+
+      private
+
+      def createContractorEntityMutation
+        Ecoportal::API::GraphQL::Mutation::CreateContractorEntity.new(client)
+      end
+
     end
   end
 end
@@ -37,3 +48,4 @@ require 'ecoportal/api/graphql/payload'
 require 'ecoportal/api/graphql/input'
 require 'ecoportal/api/graphql/fragment'
 require 'ecoportal/api/graphql/query'
+require 'ecoportal/api/graphql/mutation'

data/lib/ecoportal/api/graphql_version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    GRAPQL_VERSION = "0.1.9"
+    GRAPQL_VERSION = "0.1.11"
   end
 end

data/tests/create_contractor_entity.rb

@@ -0,0 +1,19 @@
+require_relative 'local_libs'
+
+api = Ecoportal::API::GraphQL.new
+response = api.createContractorEntity(input: {
+  name: "Caras Galathon",
+  active: true,
+  approved: true,
+  associatedPeopleIds: [
+    "5adfbef76fb80400047535b3"
+  ],
+  leadContractorIds: [
+    "5adfbef76fb80400047535b3"
+  ],
+  clientMutationId: ""
+})
+
+if response.success? && entity = response.item
+  puts "Created contractor entity '#{entity.name}' (approved? #{entity.approved})"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api-graphql
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.11
 platform: ruby
 authors:
 - Oscar Segura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-26 00:00:00.000000000 Z
+date: 2022-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,7 +130,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.9.7
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.10'
@@ -140,7 +140,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.9.7
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.10'
@@ -150,20 +150,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
 description: 
 email:
 - oscar@ecoportal.co.nz
@@ -195,7 +195,6 @@ files:
 - lib/ecoportal/api/common/graphql/hash_helpers.rb
 - lib/ecoportal/api/common/graphql/http_client.rb
 - lib/ecoportal/api/common/graphql/patches.rb
-- lib/ecoportal/api/common/graphql/patches/query.rb
 - lib/ecoportal/api/common/graphql/query_integration.rb
 - lib/ecoportal/api/graphql.rb
 - lib/ecoportal/api/graphql/base.rb
@@ -209,6 +208,7 @@ files:
 - lib/ecoportal/api/graphql/base/file_container.rb
 - lib/ecoportal/api/graphql/base/id_diff_input.rb
 - lib/ecoportal/api/graphql/base/model.rb
+- lib/ecoportal/api/graphql/base/mutation.rb
 - lib/ecoportal/api/graphql/base/organization.rb
 - lib/ecoportal/api/graphql/base/page.rb
 - lib/ecoportal/api/graphql/base/page_info.rb
@@ -253,6 +253,8 @@ files:
 - lib/ecoportal/api/graphql/model/tag_tree.rb
 - lib/ecoportal/api/graphql/model/tag_tree_node.rb
 - lib/ecoportal/api/graphql/model/user.rb
+- lib/ecoportal/api/graphql/mutation.rb
+- lib/ecoportal/api/graphql/mutation/create_contractor_entity.rb
 - lib/ecoportal/api/graphql/payload.rb
 - lib/ecoportal/api/graphql/payload/create_contractor_entity.rb
 - lib/ecoportal/api/graphql/payload/destroy_contractor_entity.rb
@@ -265,6 +267,7 @@ files:
 - lib/ecoportal/api/graphql_version.rb
 - tests/actions_get.rb
 - tests/contractor_entities_get.rb
+- tests/create_contractor_entity.rb
 - tests/local_libs.rb
 - tests/tagtree_get.rb
 - tests/tagtrees_get.rb

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

@@ -1,49 +0,0 @@
-module Graphlient
-  class Query
-    FRAGMENT_DEFITION = /___(?<const>[A-Z][a-zA-Z0-9_]*(__[A-Z][a-zA-Z0-9_]*)*)/
-
-    def initialize(&block)
-      @indents = 0
-      @query_str = ''
-      @variables = []
-      evaluate(&block)
-    end
-
-    private
-
-    def evaluate(&block)
-      @last_block = block || self
-      (@context ||= {})[@last_block] ||= @last_block.binding
-      instance_eval(&block)
-    end
-
-    def resolve_fragment_constant(value)
-      return nil unless (match = value.to_s.match(FRAGMENT_DEFITION))
-      raw_const = match[:const].gsub('__', '::')
-      @context[@last_block].eval(raw_const).tap do |const|
-        msg = "Expected constant #{raw_const} to be GraphQL::Client::FragmentDefinition. Given #{const.class}"
-        raise Graphlient::Errors::Error, msg unless const.is_a? GraphQL::Client::FragmentDefinition
-      end
-    end
-
-    def append_node(node, args, arg_processor: nil, &block)
-      node = "...#{resolve_fragment_constant(node)}".to_sym if node.to_s.start_with?('___')
-
-      # add field
-      @query_str << "\n#{indent}#{node}"
-      # add filter
-      hash_arguments = hash_arg(args)
-      @query_str << "(#{args_str(hash_arguments, arg_processor: arg_processor)})" if hash_arguments
-
-      if block_given?
-        @indents += 1
-        @query_str << '{'
-        evaluate(&block)
-        @query_str << '}'
-        @indents -= 1
-      end
-
-      @query_str << "\n#{indent}"
-    end
-  end
-end