ecoportal-api-graphql 0.3.1 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec2eecf9dcdb825a7a8f0a640d52bd891863ef29b3b64f07f6874a2617a9c49f
-  data.tar.gz: b10190f2520def342c03fad24675b41f8ab69cbcbfc6a42e9159c39839c04018
+  metadata.gz: 0d37cda00c6ee7d64fb29829b592c73838b384726cb328b57cd228969f0e6103
+  data.tar.gz: 5d18a917e0e338e46f65d9132b96b4b032979856da5524426d2d92e43cbf5aee
 SHA512:
-  metadata.gz: f18bcf0b7eaa538d6e34d90f6cdbf3e31403ff0f63538d2c62c2ebcb2d1ef44d406f356ef8ae48ec79a19ea23bd1446020b91a08e77534cecb281e061fa3fd72
-  data.tar.gz: ed7da790ac05299f381d64af371df666d1578e017079e58a97278f6e8ff4eecf487a580cad511feb7b13490b4d646d59bfb99e4d7d63fa27de28a3bbff6f5ca4
+  metadata.gz: 11d595232646fe8fc8b3096e77bcedd1d6ee635b74cdc25c6c6743607727c9e8e4a98f0538fb60226d6337407105cb6b8c347ebad4d3cf6dcbacf3329baf0ea9
+  data.tar.gz: '0926f7ce7f600ca7b8d1badabe4a7f9c6733daa5d5ebb535e5ced1835e1bc52015138409034cb5229c32534d3f0e4f2799bf58d15f4f5b94eafda33fd713059d'

data/CHANGELOG.md

@@ -1,7 +1,7 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.3.2] - 2023-03-xx
+## [0.3.6] - 2023-04-xx
 
 ### Added
 ### Changed
@@ -11,8 +11,35 @@ All notable changes to this project will be documented in this file.
   - Add update operation for `ContractorEntity`
   - Add currentOrganization.action
     - Analyse how to "DSL" currentOrganization.action.activities
+
       - review `path` tracking
 
+## [0.3.5] - 2023-04-03
+
+### Fixed
+ - `Ecoportal::API::GraphQL::Helpers::LocationsTree#treeify`
+   - Make it real id-case-insensitive (parents in lower case were being missed due to this)
+
+## [0.3.4] - 2023-04-03
+
+### Added
+  - `Ecoportal::API::Common::GraphQL::AuthService`
+    - `#session_token` added **token auto-renew** functionality (when token expires in less than 90 minutes)
+    - `#session_token_renewed`
+
+### Fixed
+  - Enabled to specify `host` (other than `live.ecoportal.com`) by the user
+
+## [0.3.3] - 2023-04-02
+
+### Fixed
+  - `Ecoportal::API::GraphQL::Base::LocationNode` **added** attribute `archivedToken`
+
+## [0.3.2] - 2023-04-02
+
+### Changed
+  - `Ecoportal::API::GraphQL::Helpers::LocationsTree#treeify` added support for `archived_token`
+
 ## [0.3.1] - 2023-03-09
 
 ### Added

data/ecoportal-api-graphql.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler",   ">= 2.2.17", "< 2.3"
+  spec.add_development_dependency "bundler",   ">= 2.4.9",  "< 2.5"
   spec.add_development_dependency "rspec",     ">= 3.10.0", "< 3.11"
   spec.add_development_dependency "rake",      ">= 13.0.3", "< 13.1"
   spec.add_development_dependency "yard",      ">= 0.9.26", "< 0.10"

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

@@ -3,20 +3,64 @@ module Ecoportal
     module Common
       module GraphQL
         module AuthService
-          DEFAULT_SERVER = "live.ecoportal.com"
+          DEFAULT_SERVER  = "live.ecoportal.com"
+          TOKEN_AUTORENEW = 90 # minutes
 
           module InstanceMethods
-            def session_token(host: server, version: nil)
+            def session_token(host: server, version: nil, auto_renew: true)
+              session_token_data(host: host, version: version).yield_self do |body|
+                return nil unless body
+                if auto_renew && token_renew?(body["expires_in"])
+                  session_token_renewed(host: host, version: version, refresh_token: body["refresh_token"])
+                else
+                  body["access_token"]
+                end
+              end
+            end
+
+            def session_token_renewed(host: server, version: nil, refresh_token: nil)
+              unless refresh_token
+                return nil unless body = session_token_data(host: host, version: version)
+                return nil unless refresh_token = body["resfresh_token"]
+              end
+              session_refresh_token_data(host: host, version: version, refresh_token: refresh_token).yield_self do |body|
+                return nil unless body
+                body["access_token"] if body
+              end
+            end
+
+            private
+
+            def session_token_data(host: server, version: nil)
               http_client(host: host, version: version).post("/oauth/token", data: {
                 "grant_type" => "password",
                 "email"      => user_email,
                 "password"   => user_pass
               }).yield_self do |response|
-                response.body["access_token"] if response.success?
+                if response.success?
+                  response.body
+                else
+                  nil
+                end
               end
             end
 
-            private
+            def session_refresh_token_data(host: server, version: nil, refresh_token:)
+              http_client(host: host, version: version).post("/oauth/token", data: {
+                "grant_type"    => "refresh_token",
+                "refresh_token" => refresh_token
+              }).yield_self do |response|
+                if response.success?
+                  response.body
+                else
+                  nil
+                end
+              end
+            end
+
+            def token_renew?(seconds)
+              (TOKEN_AUTORENEW * 60) > seconds
+            end
 
             def http_client(host: server, version: nil)
               @http_client ||= Ecoportal::API::Common::GraphQL::HttpClient.new(host: host, version: version)

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

@@ -19,7 +19,7 @@ module Ecoportal
             puts "Configuring GraphQL Client onto '#{url}'"
             super(url,
               headers: {
-                'Authorization' => "Bearer #{session_token}"
+                'Authorization' => "Bearer #{session_token(host: host)}"
               },
               http_options: {
                 read_timeout: 20,

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

@@ -8,6 +8,7 @@ module Ecoportal
           passthrough :weight
           embeds_one :parent, klass: Base::LocationNode, nullable: true
           passboolean :archived
+          passthrough :archivedToken
         end
       end
     end

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

@@ -8,6 +8,7 @@ module Ecoportal
             name
             weight
             archived
+            archivedToken
             parent {
               id
               name

data/lib/ecoportal/api/graphql/helpers/locations_tree.rb

@@ -6,8 +6,6 @@ module Ecoportal
           def treeify(nodes)
             parents = nodes.each_with_object({}) do |node, parents|
               parent   = node.parent
-              # puts "Node '#{node.name}' with ID: '#{node.id}'. "
-              # puts "  • Parent '#{parent.name}' with ID: '#{parent.id}'." if parent
               parentId = parent && parent.id.upcase
               (parents[parentId] ||= []).push(node)
             end
@@ -17,13 +15,14 @@ module Ecoportal
           private
 
           def get_children(node_id, parents)
-            (parents[node_id] ||= []).each_with_object([]) do |child, results|
+            (parents[node_id&.upcase] ||= []).each_with_object([]) do |child, results|
               results << {
-                "id"    => child.id,
-                "name"  => child.name,
-                "weight" => child.weight,
+                "id"       => child.id,
+                "name"     => child.name,
+                "weight"   => child.weight,
                 "archived" => child.archived,
-                "nodes" => get_children(child.id, parents).compact
+                "archived_token" => child.archivedToken,
+                "nodes"    => get_children(child.id, parents).compact
               }
             end
           end

data/lib/ecoportal/api/graphql.rb

@@ -11,8 +11,9 @@ module Ecoportal
       # @param org_id [String] the id of the target organization.
       #    It defaults to the environmental variable `ORGANIZATION_ID`, if defined
       # @param logger [Logger] an object with `Logger` interface to generate logs.
-      def initialize(email: nil, pass: nil, org_id: nil)
-        @client = Ecoportal::API::Common::GraphQL::Client.new(email: email, pass: pass, org_id: org_id, no_schema: true)
+      def initialize(email: nil, pass: nil, org_id: nil, host: "live.ecoportal.com")
+        kargs = {email: email, pass: pass, host: host, org_id: org_id, no_schema: true}
+        @client = Ecoportal::API::Common::GraphQL::Client.new(**kargs)
         @fragments = Ecoportal::API::GraphQL::Fragment.new(client)
       end
 

data/lib/ecoportal/api/graphql_version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    GRAPQL_VERSION = "0.3.1"
+    GRAPQL_VERSION = "0.3.5"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api-graphql
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.5
 platform: ruby
 authors:
 - Oscar Segura
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-09 00:00:00.000000000 Z
+date: 2023-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.17
+        version: 2.4.9
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.17
+        version: 2.4.9
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -164,7 +164,7 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.8'
-description: 
+description:
 email:
 - oscar@ecoportal.co.nz
 executables: []
@@ -301,7 +301,7 @@ homepage: https://www.ecoportal.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -316,8 +316,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: A collection of helpers for interacting with the ecoPortal GraphQL API
 test_files: []