ecoportal-api-v2 0.8.10 → 0.8.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8961e37170e3ffe06d26c17daa6672a15d595ff91c5e8fb38253549b166057a
-  data.tar.gz: c9b25eb42cfa9cb45cee3d830067eddc7d4191fa87f0fd4e35620e346ca27922
+  metadata.gz: 3d906a6021cc5fab91f2b2d8f32084d61449eab23b8162ade9e01308bdce3584
+  data.tar.gz: fe195a200860d2696acfc465accb16ee8758f5dfc00d9cbeffed836d654c1f8c
 SHA512:
-  metadata.gz: a68c58f62600b78745caff84d7e0dbda83e2f79cba8d41ca08ffbcf361060bd614fc6957f38878bb09d41dc6db1fcff3e307dd0072d21d960073683e6881fdbc
-  data.tar.gz: 998e1409fd0674bc409ab2ff1dcfb68f42a0dd37bca8eab040750cc8cc10ca2651fb98dc61adf3d44b0b0dbdc0bccfe384786cdd79ad1fd9ed96d12a00f3a4b4
+  metadata.gz: 74b45e1025b675e5675a0d6822fcefee7c464ae0759deb0da1004913793cef32bd2ad14f3656ab5b2177ae80bd5ac79fe9451e74ff9faefac24179f8ba9b621c
+  data.tar.gz: 8cab8147deaa80f9d3cd6dd5b31a42d0ba018001ca825e76a9a388999daef2ff686240c546255e6b8ac1785b1b7236ff4c124761b66d7cc414fef3c018480019

data/CHANGELOG.md

@@ -1,7 +1,22 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.8.10] - 2021-08-xx
+## [0.8.11] - 2021-08-27
+
+### Added
+  - `Ecoportal::API::V2::Page#stages?`
+  - `Ecoportal::API::V2::Pages::PageStage#current_stage_id`
+  - `Ecoportal::API::V2::Registers#search` added option keyed parameter `:only_first`
+    - which will make the method return the first `Ecoportal::API::V2::Registers::SearchResults`
+    - This has been **added** with the aim of knowing how many results out of how many entries.
+
+### Changed
+  - `Ecoportal::API::V2::Pages::PageStage#update` won't update unless there's something to update.
+
+### Fixed
+
+
+## [0.8.10] - 2021-08-22
 
 ### Added
   - `Ecoportal::API::Common::Content::CollectionModel#[]` now supports position as well

data/lib/ecoportal/api/v2/page.rb

@@ -40,6 +40,10 @@ module Ecoportal
           end
         end
 
+        def stages?
+          self.stages.count > 0
+        end
+
       end
     end
   end

data/lib/ecoportal/api/v2/pages/page_stage.rb

@@ -9,6 +9,12 @@ module Ecoportal
 
           embeds_many :permits, klass: "Ecoportal::API::V2::Page::Permit"
           passarray   :force_errors, :subtags, order_matters: false
+
+          # `id` of the stage we got the data of.
+          def current_stage_id
+            doc.dig("active_stage", "id") || doc["current_stage_id"]
+          end
+
         end
       end
     end

data/lib/ecoportal/api/v2/pages.rb

@@ -47,12 +47,16 @@ module Ecoportal
         end
 
         # Requests to update an existing page via api.
+        # @note It won't launch the update unless there are changes
         # @param doc [Hash, Page] data that at least contains an `id` (internal or external) of the target page.
         # @return [Response] an object with the api response.
         def update(doc)
           body = get_body(doc) # , level: "page"
-          id   = get_id(doc)
-          client.patch("/pages/#{CGI.escape(id)}", data: body)
+          # Launch only if there are changes
+          if body && body["page"]
+            id   = get_id(doc)
+            client.patch("/pages/#{CGI.escape(id)}", data: body)
+          end
         end
 
         # Gets a `new` non-existing page via api with all the ids initialized.

data/lib/ecoportal/api/v2/registers/search_results.rb

@@ -0,0 +1,13 @@
+module Ecoportal
+  module API
+    class V2
+      class Registers
+        class SearchResults < Common::Content::DoubleModel
+          passthrough :total, :total_before_filtering
+          passarray   :tags, order_matters: false
+          embeds_many :results, klass: "Ecoportal::API::V2::Registers::PageResult"
+        end
+      end
+    end
+  end
+end

data/lib/ecoportal/api/v2/registers.rb

@@ -9,6 +9,7 @@ module Ecoportal
 
         class_resolver :register_class,  "Ecoportal::API::V2::Registers::Register"
         class_resolver :register_search_result_class, "Ecoportal::API::V2::Registers::PageResult"
+        class_resolver :register_search_results, "Ecoportal::API::V2::Registers::SearchResults"
 
         attr_reader :client
 
@@ -35,7 +36,12 @@ module Ecoportal
         # @param options [Hash] the search options
         # @option options [Hash<Symbol, String>] :query plain search (like the search box in register).
         # @option options [Hash<Symbol, Array<Object>>] :filters the set of filters.
+        # @option options [Boolean] if `true`, it only performs the first search and results `Ecoportal::API::V2::Registers::SearchResults`.
+        # @yield [result]  something to do with search page-result.
+        # @yieldparam result [Ecoportal::V2::Registers::PageResult] a page result.
+        # @return [Ecoportal::API::V2::Registers, Ecoportal::API::V2::Registers::SearchResults]
         def search(register_id, options = {})
+          only_first = options.delete(:only_first)
           # supply a query string
           # or a filter array (copy/paste from dev tools in the browser)
           options = {query: nil, filters: []}.update(options)
@@ -49,6 +55,12 @@ module Ecoportal
             end
           end
 
+          if only_first
+            response = client.get("/registers/#{register_id}/search", params: options)
+            raise "Request failed - Status #{response.status}: #{response.body}" unless response.success?
+            return register_search_results.new(response.body["data"])
+          end
+
           cursor_id = nil
           results = 0
           loop do
@@ -87,3 +99,4 @@ require 'ecoportal/api/v2/registers/register'
 require 'ecoportal/api/v2/registers/stage_result'
 require 'ecoportal/api/v2/registers/stages_result'
 require 'ecoportal/api/v2/registers/page_result'
+require 'ecoportal/api/v2/registers/search_results'

data/lib/ecoportal/api/v2_version.rb

@@ -1,5 +1,5 @@
 module Ecoportal
   module API
-    GEM2_VERSION = "0.8.10"
+    GEM2_VERSION = "0.8.11"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecoportal-api-v2
 version: !ruby/object:Gem::Version
-  version: 0.8.10
+  version: 0.8.11
 platform: ruby
 authors:
 - Oscar Segura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-22 00:00:00.000000000 Z
+date: 2021-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -231,6 +231,7 @@ files:
 - lib/ecoportal/api/v2/registers.rb
 - lib/ecoportal/api/v2/registers/page_result.rb
 - lib/ecoportal/api/v2/registers/register.rb
+- lib/ecoportal/api/v2/registers/search_results.rb
 - lib/ecoportal/api/v2/registers/stage_result.rb
 - lib/ecoportal/api/v2/registers/stages_result.rb
 - lib/ecoportal/api/v2/registers/template.rb