ecoportal-api-graphql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8b2c0cedbda4c84748b943f0abb5b6bca595385f79692189aa7bcf6fb5d1f46b
+  data.tar.gz: 7e0582c067c29772bc89257fbd83aab19d6268c5500b054cb62a69285c86e992
+SHA512:
+  metadata.gz: f26eb9930114eac84351856978256e470a8c5a89fef4e54ae7c2424829fbc0970d906865a4a1e3b6e205e72e3e915960c97169bff83af5d6cc286c6cd6703e5d
+  data.tar.gz: 68de94a4e01bb6d7eb97946adff3456920971453665d9a2069511c76def7771a7bb8998b9cf66ee0ff43493ea4e9ba11a6b3883474f19747893a4a11af6f0379

data/.gitignore

@@ -0,0 +1,21 @@
+# it's a gem, ignore the lockfile
+Gemfile.lock
+
+.env
+# build artifacts
+*.gem
+/.bundle/
+/vendor/bundle
+/spec/reports/
+/tmp/
+/pkg/
+
+# docs
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+
+# rspec failure tracking
+.rspec_status
+scratch.rb

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,55 @@
+AllCops:
+  TargetRubyVersion: 2.5.1
+  Exclude:
+    - 'config/routes.rb'
+
+Metrics/LineLength:
+  Enabled: false
+Metrics/BlockLength:
+  ExcludedMethods: [context, describe]
+  Max: 50
+Metrics/MethodLength:
+  Max: 50
+Metrics/ClassLength:
+  Max: 200
+Metrics/AbcSize:
+  Max: 30
+
+ParameterLists:
+  Max: 5
+  CountKeywordArgs: false
+
+Style/StringLiterals:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/CommentedKeyword:
+  Enabled: false
+Style/MultilineBlockChain:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+Style/AndOr:
+  Enabled: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+Layout/SpaceInsideBlockBraces:
+  Enabled: false
+Layout/SpaceAroundOperators:
+  Enabled: false
+Layout/ExtraSpacing:
+  AllowForAlignment: true
+Layout/AccessModifierIndentation:
+  EnforcedStyle: indent
+Layout/DotPosition:
+  EnforcedStyle: trailing
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+Layout/IndentHash:
+  Enabled: false
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/.yardopts

@@ -0,0 +1,10 @@
+--readme README.md
+--charset utf-8
+--markup-provider=redcarpet
+--markup=markdown
+--no-private
+--output-dir ./doc
+'lib/**/*.rb'
+-
+CHANGELOG.md
+LICENSE

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+## [0.0.2] - 2022-09-xx
+
+### Added
+
+### Changed
+
+### Fixed
+
+### ToDo
+  - Make `GraphQL` default fragments work
+  - Add update/create operations for `ContractorEntity`
+  - Add currentOrganization.action
+    - Analyse how to "DSL" currentOrganization.action.activities
+      - review `path` tracking
+
+## [0.0.1] - 2022-09-15
+
+### Added
+  - First commit with some basic structure

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ecoportal-api.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 ecoPortal
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,20 @@
+# Ecoportal::API::GraphQL
+
+This is a basic collection of helpers that can be used to interact with the
+[ecoPortal](https://www.ecoportal.com) `GraphQL` API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ecoportal-api-graphql', require: %w[ecoportal/api-graphql]
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ecoportal-api-graphql

data/Rakefile

@@ -0,0 +1,27 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "yard"
+require "redcarpet"
+
+desc "run the specs"
+RSpec::Core::RakeTask.new(:spec)
+
+desc "run rspec showing backtrace"
+RSpec::Core::RakeTask.new(:spec_trace) do |task|
+  task.rspec_opts = ['--backtrace']
+end
+
+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
+
+# default task name is yard
+desc "Yard: generate all the documentation"
+YARD::Rake::YardocTask.new(:doc) do |t|
+  #t.files = ['lib/**/*.rb']
+end
+
+task :default     => [:spec]
+task :rspec_trace => :spec_trace
+task :rspec_fast  => :spec_fast

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ecoportal/api-graphql"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "pry"
+Pry.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/setup.ps1

@@ -0,0 +1,6 @@
+
+<# For mor information on Strict-Mode, visit:
+ https://devblogs.microsoft.com/scripting/enforce-better-script-practices-by-using-set-strictmode/ #>
+Set-StrictMode -Version 1.0
+
+bundle install

data/ecoportal-api-graphql.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ecoportal/api/graphql_version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ecoportal-api-graphql"
+  spec.version       = Ecoportal::API::GRAPQL_VERSION
+  spec.authors       = ["Oscar Segura"]
+  spec.email         = ["oscar@ecoportal.co.nz"]
+
+  spec.summary       = %q{A collection of helpers for interacting with the ecoPortal GraphQL API}
+  spec.homepage      = "https://www.ecoportal.com"
+  spec.licenses      = %w[MIT]
+
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  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 "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"
+  spec.add_development_dependency "redcarpet", ">= 3.5.1",  "< 3.6"
+  spec.add_development_dependency "pry"      , ">= 0.14"
+
+  spec.add_dependency 'ecoportal-api-v2', '>= 0.8.31', '< 0.9'
+  spec.add_dependency 'graphlient',       '>= 0.6.0', '< 0.7'
+end

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

@@ -0,0 +1,66 @@
+require 'graphlient'
+module Ecoportal
+  module API
+    module Common
+      module GraphQL
+        module AuthService
+          DEFAULT_SERVER = "live.ecoportal.com"
+
+          module InstanceMethods
+            def session_token(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|
+                if response.success?
+                  response.body["access_token"]
+                end
+              end
+            end
+
+            private
+
+            def http_client(host: server, version: nil)
+              @http_client ||= Ecoportal::API::Common::GraphQL::HttpClient.new(host: host, version: version)
+            end
+
+            def user_email
+              fetch_env_required("USER_EMAIL")
+            end
+
+            def user_pass
+              fetch_env_required("USER_PASS")
+            end
+
+            def server(default = DEFAULT_SERVER)
+              ENV['SERVER'] || default
+            end
+
+            def fetch_env_required(name)
+              abort("Missing ENV '#{name}'") unless ENV.key?(name)
+              ENV[name]
+            end
+
+            def abort(msg)
+              puts msg
+              exit(1)
+            end
+          end
+
+          module ClassMethods
+          end
+
+          class << self
+            include InstanceMethods
+
+            def included(base)
+              base.send(:include, InstanceMethods)
+              base.extend(ClassMethods)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+module Ecoportal
+  module API
+    module Common
+      module GraphQL
+        module ClassHelpers
+          module InstanceMethods
+            def becomes(klass)
+              klass.new.tap do |becoming|
+                instance_variables.each do |var|
+                  becoming.instance_variable_set(var, instance_variable_get(var))
+                end
+              end
+            end
+
+            def becomes_parent_class
+              becomes(self.class.superclass)
+            end
+          end
+
+          module ClassMethods
+            include Ecoportal::API::Common::Content::ClassHelpers
+          end
+
+          class << self
+            def included(base)
+              base.send(:include, InstanceMethods)
+              base.extend(ClassMethods)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+require 'graphlient'
+module Ecoportal
+  module API
+    module Common
+      module GraphQL
+        class Client < ::Graphlient::Client
+          attr_accessor :org_id, :host
+
+          include Ecoportal::API::Common::GraphQL::AuthService
+
+          def initialize(org_id:, host: server, schema_path: host, no_schema: false)
+            @org_id      = org_id
+            @host        = host
+            @no_schema   = no_schema
+
+            puts "Configuring GraphQL Client onto '#{url}'"
+            super(url,
+              headers: {
+                'Authorization' => "Bearer #{session_token}"
+              },
+              http_options: {
+                read_timeout: 20,
+                write_timeout: 30
+              }.tap do |options|
+                options.merge!(schema_path: schema_path) unless @no_schema
+              end
+            )
+          end
+
+          def new(org_id: self.org_id, host: self.host, schema_path: self.schema_path, no_schema: @no_schema)
+            self.class.new(org_id: org_id, host: host, schema_path: schema_path, no_schema: no_schema)
+          end
+
+          private
+
+          def url
+            "#{Ecoportal::API::Common::GraphQL::HttpClient.base_url(host)}/api/#{org_id}/graphql"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module Ecoportal
+  module API
+    module Common
+      module GraphQL
+        module DocHelpers
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+module Ecoportal
+  module API
+    module Common
+      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}
+            end
+
+            def keys_to_s_deep(value)
+              transform_keys_deep(value) {|k| k.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
+              end
+            end
+
+            def deep_dup(data)
+              case data
+              when Hash
+                data.each_with_object({}) do |(k,v), copy|
+                  if k.is_a?(::String) || k.is_a?(::Symbol)
+                    copy[k] = deep_dup(v)
+                  else
+                    copy.delete(k)
+                    copy[deep_dup(k)] = deep_dup(v)
+                  end
+                end
+              when Enumerable
+                data.map {|d| deep_dup(d)}
+              else
+                data.dup
+              end
+            end
+          end
+
+          module ClassMethods
+          end
+
+          class << self
+            include InstanceMethods
+
+            def included(base)
+              base.send(:include, InstanceMethods)
+              base.extend(ClassMethods)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+module Ecoportal
+  module API
+    module Common
+      module GraphQL
+        class HttpClient < Common::Client
+          class << self
+            def base_url(host)
+               "#{protocol(host)}://#{host}"
+            end
+
+            def protocol(host)
+              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), response_logging: false)
+            super(api_key: api_key, version: version, host: host, logger: logger, response_logging: false)
+          end
+
+          def refresh_key(value)
+            @api_key = value
+          end
+
+          # Creates a HTTP object adding the `X-ApiKey` or `X-ECOPORTAL-API-KEY` param to the header, depending on the API version.
+          # @note It configures HTTP so it only allows body data in json format.
+          # @return [HTTP] HTTP object.
+          def base_request
+            @base_request ||= begin
+              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)
+              else
+                HTTP.headers("X-ApiKey" => key_token).accept(:json)
+              end
+            end
+          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}"
+          end
+
+          private
+
+          def version?
+            !!@version
+          end
+
+          def protocol
+            @protocol ||= self.class.protocol(host)
+          end
+
+          def base_url
+            @base_url ||= self.class.base_url(host)
+          end
+
+          def base_url_api
+            @base_uri_api ||= "#{base_url}/api/#{version}"
+          end
+
+          def key_token
+            if @api_key.nil? || @api_key.match(/\A\W*\z/)
+              if (version == "v0") && key = ENV['ORG_INT_KEY']
+                key
+              else
+                puts "Api-key missing!"
+              end
+            else
+              @api_key
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module Ecoportal
+  module API
+    module Common
+      module GraphQL
+      end
+    end
+  end
+end
+
+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'

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

@@ -0,0 +1,8 @@
+module Ecoportal
+  module API
+    module Common
+    end
+  end
+end
+
+require 'ecoportal/api/common/graphql'

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

@@ -0,0 +1,36 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Base
+        class Action < Ecoportal::API::GraphQL::Base::Model
+          passkey :id
+          passthrough :altId
+          passthrough :name, :description
+          passthrough :age
+
+          passarray :tags, :location
+
+          passthrough :status, :relativeStatus
+          passboolean :archived, :attached, :standaloneAction
+          passthrough :actionCategoryId
+
+          passarray :fileContainerIds
+
+          passarray :assignedPersonMemberIds
+          passthrough :creatorId, :creatorUserId
+          passthrough :updaterId, :updaterUserId
+          passthrough :completerId
+
+          passthrough :timeZone
+          embeds_one :dueDate, klass: GraphQL::Base::DateTime
+          embeds_one :reminderDate, klass: GraphQL::Base::DateTime
+          embeds_one :createdAt, klass: GraphQL::Base::DateTime
+          embeds_one :updatedAt, klass: GraphQL::Base::DateTime
+          embeds_one :completedAt, klass: GraphQL::Base::DateTime
+          embeds_one :openededAt, klass: GraphQL::Base::DateTime
+          embeds_one :closedAt, klass: GraphQL::Base::DateTime
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    class GraphQL
+      module Base
+        class ActionCategory < Ecoportal::API::GraphQL::Base::Model
+          passkey :id
+          passthrough :name, :value
+          passboolean :archived
+        end
+      end
+    end
+  end
+end