ecoportal-api-v2 0.8.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 63d37cfa2d9b609207eb06ce65d9b2c5184296ce33b4fab2b9a38ca91fa94a90
+  data.tar.gz: 8e5db3051d415f7e70a27a5f4c93bf87c03febb6660c7da7a323e84dfb539b83
+SHA512:
+  metadata.gz: de42e53ed858e09838f63e8dad3735b276bcea93d076530f7b899779d36293568c26f1e1ce7e236d5d182f7c548ac887d209161bd8ee959bebd652b5519c16a0
+  data.tar.gz: 8991b881e1cbeec44def7408184c8cd6e8170d2bbaaa8ef0f1483497338b80461f14a7a34b281186a976f7116579def4a70ebf7a2b4bedf5fdde95765bd7c5b2

data/.gitignore

@@ -0,0 +1,20 @@
+# it's a gem, ignore the lockfile
+Gemfile.lock
+
+# 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,171 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+## [0.8.4] - 2021-02-xx
+
+### Added
+### Changed
+  - roll back `ecoportal-api` dependency
+  
+### Fixed
+
+## [0.8.3] - 2021-02-22
+
+### Added
+### Changed
+  - updated `rspec` for expected patch data on `delete` operation.
+
+### Fixed
+  - More specific namespace path for `Internal::People` namespace
+
+## [0.8.2] - 2021-02-21
+
+### Added
+### Changed
+  - some necessary changes for the new gem to be active
+
+### Fixed
+
+## [0.8.1] - 2021-02-21
+
+### Added
+### Changed
+  - renamed parameters (backwards incompatible change):
+    - `Ecoportal::API::V2::Pages::Stages` methods `#get` and `#update`
+      - updated `Ecoportal::API::V2::Pages#` accordingly
+
+### Fixed
+
+
+## MOVED TO GEM `ecoportal-api-v2` ##
+
+## [0.7.5] - 2021-02-21
+
+### Added
+  - `Ecoportal::API::Common::ClassHelpers` added inheritable attribute values
+  - `Ecoportal::API::V2::Pages::PageStage` added missing properties
+  - `Ecoportal::API::V2::Page::Stages#ordered_stages` method to obtain stages in order
+  - `Ecoportal::API::V2::Registers#search` method search pages in the register, which includes new classes:
+    - `Ecoportal::API::V2::Registers::PageResult`
+    - `Ecoportal::API::V2::Registers::StagesResult`
+    - `Ecoportal::API::V2::Registers::StageResult`
+  - `Ecoportal::API::V2::Pages#get` added parameter `stage_id:` to be able to directly obtain the stage
+
+### Changed
+  - Moved some classes to the new namespace `Ecoportal::API::V2::Registers`
+    - `Ecoportal::API::V2::Registers::Register`
+    - `Ecoportal::API::V2::Registers::Template`
+
+### Fixed
+  - `Ecoportal::API::Common::Content::HashDiffPatch`: `deleted` operation wording and `data.patch_ver`
+  - `Ecoportal::API::V2::Page::Component.new_doc` should delegate to child classes that have their own implementation
+    - `Ecoportal::API::V2::Page::Component::ImagesField.new_doc` should include `layout`
+    - `Ecoportal::API::V2::Page::Component::SignatureField.new_doc` should include `color`
+
+## [0.7.4] - 2021-02-12
+
+### Added
+  - `Ecoportal::API::V2::Page::Component::GaugeStop#color=` enabled setting colours using a `symbol`
+    - `:blue`, `:blue_greyed`, `:blue_light`
+    - `:turquoise`, `:jade`, `:green`, `:pistachio`, `:avocado`
+    - `:yellow`, `:orange`, `:pumpkin`, `:red`, `:magenta`, `:fuchsia`, `:purple`, `:violet`
+  - `Ecoportal::API::V2::Page::Component::GaugeStop#color_sym` to get the color as `symbol` name
+  - added support for chart fields:
+    - `Ecoportal::API::V2::Page::Component::ChartField` with the different `mode` types
+    - `Ecoportal::API::V2::Page::Component::ChartFrField` (LTIFR)
+
+### Changed
+  - `Ecoportal::API::Page::Component::DateField` Date objects + Timezones
+    - `#value` should be shown in local time
+    - `#value=` should be set by local time
+  - `Ecoportal::API::Common::Content::DoubleModel.embeds_multiple` renamed to `embeds_many`
+  - `Ecoportal::API::Common::Content::DoubleModel.embeds_one` removed parameter `:multiple`
+  - Fields under `Ecoportal::API::Page::Component` that `embeds_many` should generate new elements in a standard way
+    - added `Ecoportal::API::Common::Content::CollectionModel#items_class` method
+
+### Fixed
+  - solved `pretty_print` name collision renaming to `Ecoportal::API::Common::Content::DoubleModel#print_pretty`
+
+## [0.7.3] - 2021-02-01
+
+### Added
+  - `Ecoportal::API::Common::Content::CollectionModel#delete!` finally scoped how delete should work :)
+  - `Ecoportal::API::V2.new` better feedback on key error.
+  - `Ecoportal::API::V2::Page::Component::SignatureField` added property `signed_by_name`
+  - `Ecoportal::API::V2::Page::Component#required` this field property is currently supported
+  - `Ecoportal::API::V2::Page::Component::DateField` more supported properties:
+    * `show_time`, `today_button`, `past_only`, `create_event`, `remind_me_in`, `renews`, `renews_every`, `renews_unit`, `renews_until`
+  - `Ecoportal::API::V2::Page::Component::ChecklistField`
+    * added more methods: `add_item`, `ordered_items`
+  - `Ecoportal::API::V2::Page::Component::GaugeField`
+    * more supported properties: `max`, `active_color` and `stops`
+      - for `stops` added class `Ecoportal::API::V2::Page::Component::GaugeStop`
+    * added more methods: `add_stop`, `ordered_stops`
+  - `Ecoportal::API::V2::Page::Component::ReferenceField` more supported properties:
+    * `register_id`, `hide_create`, `hide_attach`, `hide_metadata`, `hide_dashboards`, `display_fields`, `display_fields_in_lookup`
+  - `Ecoportal::API::V2::Page::Component::ActionField`
+    * more supported properties:`create_actions`, `required_number_of_completed_actions`, `permits_and_rules_integration`, `add_subscribed`, `add_subscribed_to_tasks`
+    * added more methods: `add_task`, `ordered_tasks`
+    - `Ecoportal::API::V2::Page::Component::Action` modified, provided that some properties are `read_only`
+  - `Ecoportal::API::V2::Page::Component::PeopleField` more supported properties:
+    * `is_me_button`, `attach_mode`, `person_schema_id`, `viewable_fields`, `singular`, `requires_number`, `cached_people`, `attached_people_permissions_enabled`, `apply_attached_people_permissions_to`, `attached_people_permissions_editable`, `attached_people_permissions_flags`
+  - `Ecoportal::API::V2::Page::Component::PlainTextField` more supported properties:
+    * `multiline`, `max_length`, `exact_index`
+  - `Ecoportal::API::V2::Page::Component::SelectionField` more supported properties:
+    * `flat`
+  - `Ecoportal::API::V2::Page::Component::TagField` more supported properties:
+    * `single_select`, `use_defaults`, `tag_tree_id`, `button_text`
+  - `Ecoportal::API::V2::Page::Section` more supported properties:
+    * `minimized`
+
+### Changed
+  - upgraded `ecoportal-api` dependency
+
+### Fixed
+  - `Ecoportal::API::Common::Content::CollectionModel#upsert!` was not actually moving the element to the new position when it already existed
+
+## [0.7.2] - 2020-10-07
+
+### Added
+  - automatic key builder
+    - helper: `Ecoportal::API::V2::v2key` method
+    - `user_key:` and `org_key:` as constructor methods for `Ecoportal::API::V2`
+### Changed
+### Fixed
+
+## [0.7.1] - 2020-10-07
+
+### Added
+### Changed
+  - updated dependencies
+### Fixed
+
+
+## [0.7.0] - 2020-09-10
+
+### Added
+### Changed
+  - updated dependencies
+### Fixed
+
+## [0.6.1] - 2020-07-11
+
+### Added
+  - `Ecoportal::API::Common::Content::DoubleModel#pretty_print`
+### Changed
+### Fixed
+
+## [0.6.0] - 2020-07-11
+
+### Added
+### Changed
+  - upgraded `ecoportal-api` gem
+### Fixed
+
+## [0.5.9] - 2020-07-02
+
+### Added
+  - helper `Ecoportal::API::Common::Content::StringDigest#indexable_label`: to see the part of a label that gets indexed
+  - this `CHANGELOG.md` file
+### Changed
+### Fixed

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) 2018 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,22 @@
+**Originally ---> 'ecoportal-api-oozes'**
+
+# Ecoportal::API::V2
+
+This is a basic collection of helpers that can be used to interact with the
+[ecoPortal](https://www.ecoportal.com) `APIv2`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ecoportal-api-v2', require: %w[ecoportal/api-v2]
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ecoportal-api-v2

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"
+
+# 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/ecoportal-api-v2.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ecoportal/api/v2/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ecoportal-api-v2"
+  spec.version       = Ecoportal::API::V2::GEM_VERSION
+  spec.authors       = ["Oscar Segura"]
+  spec.email         = ["rien@ecoportal.co.nz", "oscar@ecoportal.co.nz", "bozydar@ecoportal.co.nz"]
+
+  spec.summary       = %q{A collection of helpers for interacting with the ecoPortal MS's V2 API}
+  spec.homepage      = "https://www.ecoportal.com"
+  spec.licenses      = %w[MIT]
+
+  spec.required_ruby_version = '>= 2.4.4'
+
+  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.11",  "< 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', '>= 0.8.1', '< 0.9'
+  spec.add_dependency 'ecoportal-api', '>= 0.7.5', '< 0.8'
+end

data/lib/ecoportal/api-v2.rb

@@ -0,0 +1,10 @@
+require "ecoportal/api"
+require "ecoportal/api/v2/version"
+
+module Ecoportal
+  module API
+  end
+end
+
+require_relative "api/common"
+require_relative "api/v2"

data/lib/ecoportal/api/common.rb

@@ -0,0 +1,18 @@
+module Ecoportal
+  module API
+    module Common
+    end
+  end
+end
+
+require 'ecoportal/api/common/base_class'
+require 'ecoportal/api/common/hash_diff'
+require 'ecoportal/api/common/base_model'
+require 'ecoportal/api/common/doc_helpers'
+require 'ecoportal/api/common/logging'
+require 'ecoportal/api/common/client'
+require 'ecoportal/api/common/response'
+require 'ecoportal/api/common/wrapped_response'
+require 'ecoportal/api/common/batch_response'
+require 'ecoportal/api/common/batch_operation'
+require 'ecoportal/api/common/content'