ecoportal-api 0.5.8 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 168542de09c5a87edcd4952acdf84cdf01944c03339238a27c310e29b71e9c14
-  data.tar.gz: 2f43b32d289f6232eccff32516717ab82cd86cbe0144d6f8f2eac74f30637cd8
+  metadata.gz: f58ff9e368c2607a55aed0c5e62d45e7c51f37baac25d5da83c4ce6dd4224733
+  data.tar.gz: c8bcd11749dfcd0a57650ba25a3d826e209b871c472c2cabbb9e61c01bbaa563
 SHA512:
-  metadata.gz: 1c539315189039d7baed7c48db646969525a47d51cdd88b63a2ac53b651f089aa6e219fa91624943700c1c73144525d9482f4cff8b9e1ca5cbbc9862c0a138e4
-  data.tar.gz: 3c145a2fcea2c476fb39ad914b6b3ec2ff390ffe5378ab9795ddd466238f0af55fbbae59a5e87cadb415a49165cf0e05d6697e45dc74bd6235581c30268d1e45
+  metadata.gz: 0e730eff886dd4f908e1bdd52b468b513c4e0309b7be47e3461bd7ef7f81c91d6d9dd4e61c8bdc681132bb310dd423bc62c3379510701d9c71e3f4847688fd3e
+  data.tar.gz: dba899cde0099074a44549cd05fedcd3a72e57ca81403a9399411f67c6575db40fe170f63fda7ded3e6d4fa626db2dd0dd33df1eaf3b7058d3cb9aec83e53792

data/CHANGELOG.md

@@ -1,13 +1,32 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [0.6.0] - 2020-07-xx
+
+### Added
+  - `Ecoportal::API::Common::BaseModel#initial_doc`: `#consolidate!` modifies `original_doc`
+    - this helper allows to know what was the initial document the object was created with
+  - `Ecoportal::API::Common::BaseModel#as_update`: added parameter (default: `:last` => compare with `original_doc`)
+    - calling it with `:total` will compare the current `doc` with the `initial_doc`
+### Changed
+  - `Ecoportal::API::Internal::Permissions`: **update for new abilities of ecoPortal release `1.5.0`**
+    - added abilities: `person_core`, `person_account`, `person_details`
+    - removed ability: `people`
+  - renamed `print` to `pretty_print` to avoid overriding `$stdout.print`, on:
+    - `Ecoportal::API::Common::BaseModel`
+    - `Ecoportal::API::Common::BatchReponse`
+    - `Ecoportal::API::Common::Response`
+    - `Ecoportal::API::Common::WrappedResponse`
+### Fixed
+  - `Ecoportal::API::Internal::Preferences`: **kiosk** settings should default to `false` (`nil`)
+
 ## [0.5.8] - 2020-06-23
 
 ### Added
 ### Changed
 ### Fixed
-- `Ecoportal::API::V1::Person#filter_tags=`: `original_doc["filter_tags"]` is `nil` when creating a person
-- `Ecoportal::API::Internal::Account#policy_group_ids=`: `original_doc["account"]` is `nil` when creating a person
+  - `Ecoportal::API::V1::Person#filter_tags=`: `original_doc["filter_tags"]` is `nil` when creating a person
+  - `Ecoportal::API::Internal::Account#policy_group_ids=`: `original_doc["account"]` is `nil` when creating a person
 
 
 ## [0.5.7] - 2020-06-22

data/ecoportal-api.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec",     "~> 3",   ">= 3.9"
   spec.add_development_dependency "yard",      "~> 0.9", ">= 0.9.18"
   spec.add_development_dependency "redcarpet", "~> 3.5", ">= 3.5.0"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry"      , "~> 0.13"
 
   spec.add_dependency 'http',          '~> 3'
   spec.add_dependency 'hash-polyfill', '~> 0'

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

@@ -48,6 +48,7 @@ module Ecoportal
           if !_parent || !_key
             @doc          = doc
             @original_doc = JSON.parse(@doc.to_json)
+            @initial_doc  = JSON.parse(@doc.to_json)
           end
         end
 
@@ -63,6 +64,12 @@ module Ecoportal
           _parent.original_doc.dig(*[_key].flatten)
         end
 
+        def initial_doc
+          raise UnlinkedModel.new  unless linked?
+          return @initial_doc if is_root?
+          _parent.initial_doc.dig(*[_key].flatten)
+        end
+
         def as_json
           doc
         end
@@ -71,9 +78,10 @@ module Ecoportal
           doc.to_json(*args)
         end
 
-        def as_update
+        def as_update(ref = :last)
           new_doc = as_json
-          Common::HashDiff.diff(new_doc, original_doc)
+          ref_doc = ref == :total ? initial_doc : original_doc
+          Common::HashDiff.diff(new_doc, ref_doc)
         end
 
         def dirty?
@@ -100,7 +108,7 @@ module Ecoportal
           end
         end
 
-        def print
+        def pretty_print
           puts JSON.pretty_generate(as_json)
           self
         end

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

@@ -20,10 +20,10 @@ module Ecoportal
             yield doc
           end
         end
-        
-        def print
+
+        def pretty_print
           if success?
-            each(&:print)
+            each(&:pretty_print)
           else
             puts "Request failed."
           end

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

@@ -19,8 +19,8 @@ module Ecoportal
         def success?
           @status.success?
         end
-        
-        def print
+
+        def pretty_print
           puts "Status: #{@status.code}"
           puts "Body:"
           puts JSON.pretty_generate(@body)

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

@@ -40,14 +40,14 @@ module Ecoportal
           response.success?
         end
 
-        def print
+        def pretty_print
           if success?
-            each(&:print)
+            each(&:pretty_print)
           else
             puts "Request failed."
           end
         end
-        
+
       end
     end
   end

data/lib/ecoportal/api/internal/permissions.rb

@@ -2,7 +2,9 @@ module Ecoportal
   module API
     class Internal
       class Permissions < Common::BaseModel
-        passthrough :files, :data, :reports, :organization, :people, :pages, :page_editor, :registers
+        passthrough :files, :data, :reports
+        passthrough :organization, :person_core, :person_account, :person_details
+        passthrough :pages, :page_editor, :registers
       end
     end
   end

data/lib/ecoportal/api/internal/preferences.rb

@@ -2,21 +2,17 @@ module Ecoportal
   module API
     class Internal
       class Preferences < Common::BaseModel
+        passthrough  :kiosk_enabled, :kiosk_workflow_message, :kiosk_create_button_label,
+            :kiosk_create_button_help, :kiosk_return_button_label, :kiosk_return_button_help,
+            :kiosk_dashboard_button_label, :kiosk_dashboard_button_help
+
         [
           :show_sidebar,
           :show_shortcuts,
           :show_coming_soon,
           :show_recently_visited_forms,
           :show_tasks,
-          :show_task_bubbles,
-          :kiosk_enabled,
-          :kiosk_workflow_message,
-          :kiosk_create_button_label,
-          :kiosk_create_button_help,
-          :kiosk_return_button_label,
-          :kiosk_return_button_help,
-          :kiosk_dashboard_button_label,
-          :kiosk_dashboard_button_help
+          :show_task_bubbles
         ].map(&:to_s).each do |field|
           define_method(field) do
             if doc.key?(field)

data/lib/ecoportal/api/version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    VERSION = "0.5.8"
+    VERSION = "0.6.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api
 version: !ruby/object:Gem::Version
-  version: 0.5.8
+  version: 0.6.0
 platform: ruby
 authors:
 - Tapio Saarinen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-23 00:00:00.000000000 Z
+date: 2020-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,16 +108,16 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -163,7 +163,6 @@ files:
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile