dhis2 2.3.8 → 3.0.0

data/lib/dhis2/api/shared/organisation_unit_group.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Shared
+      module OrganisationUnitGroup
+        def organisation_unit_ids
+          organisation_units.map do |organisation_unit|
+            organisation_unit["id"]
+          end
+        end
+
+        def group_set_ids
+          [organisation_unit_group_set, group_sets].flatten.compact.map do |group_set|
+            group_set["id"]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dhis2/api/shared/report_tables.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Shared
+      module ReportTable
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        private
+
+        def instance_update_success?(_response)
+          # response is empty so...
+          true
+        end
+
+        module ClassMethods
+          private
+
+          def created_instance_id(_response)
+            nil
+          end
+
+          def instance_creation_success?(response)
+            response["status"] == "OK"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dhis2/api/shared/resource_table.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Shared
+      module ResourceTable
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        module ClassMethods
+          def analytics(client)
+            client.post(path: "resourceTables/analytics")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dhis2/api/shared/save_validator.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Shared
+      module SaveValidator
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        private
+
+        def validate_instance_update(response)
+          unless instance_update_success?(response)
+            raise Dhis2::UpdateError, "Update error. #{response}"
+          end
+        end
+
+        def instance_update_success?(response)
+          self.class.base_response_check(response) &&
+            response["http_status"] == "OK"
+        end
+
+        module ClassMethods
+          def validate_instance_creation(response)
+            unless instance_creation_success?(response)
+              raise Dhis2::CreationError, "Creation error. #{response}"
+            end
+          end
+
+          def instance_creation_success?(response)
+            base_response_check(response) &&
+              response["http_status"] == "Created"
+          end
+
+          def created_instance_id(response)
+            response["response"]["uid"]
+          end
+
+          def base_response_check(response)
+            response["status"] == "OK"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dhis2/api/shared/system_info.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Shared
+      module SystemInfo
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        module ClassMethods
+          def get(client)
+            client.get(path: "/system/info")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dhis2/api/updatable.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Updatable
+      def update_attributes(attributes)
+        client.patch(
+          path: "#{self.class.resource_name}/#{id}",
+          payload: attributes
+        )
+        attributes.each do |key, value|
+          public_send("#{key}=", value)
+        end
+        self
+      end
+
+      def update
+        client.put(
+          path: "#{self.class.resource_name}/#{id}",
+          payload: update_args
+        ).tap do |response|
+          validate_instance_update(response)
+        end
+      end
+
+      private
+
+      def update_args
+        to_h.reject { |k, _| k == :client }
+      end
+    end
+  end
+end

data/lib/dhis2/api/version224/analytic.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Version224
+      class Analytic < ::Dhis2::Api::Shared::Analytic
+      end
+    end
+  end
+end

data/lib/dhis2/api/version224/attribute.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Version224
+      class Attribute < ::Dhis2::Api::Base
+        include ::Dhis2::Api::Listable
+        include ::Dhis2::Api::Findable
+        include ::Dhis2::Api::Creatable
+        include ::Dhis2::Api::Updatable
+        include ::Dhis2::Api::Deletable
+        include ::Dhis2::Api::Version224::SaveValidator
+
+        Schema = Dry::Validation.Schema do
+          required(:name).filled
+          required(:value_type).value(
+            included_in?: ::Dhis2::Api::Version224::Constants.value_types
+          )
+        end
+      end
+    end
+  end
+end

data/lib/dhis2/api/version224/category_combo.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Version224
+      class CategoryCombo < ::Dhis2::Api::Base
+        include ::Dhis2::Api::Listable
+        include ::Dhis2::Api::Findable
+        include ::Dhis2::Api::Creatable
+        include ::Dhis2::Api::BulkCreatable
+        include ::Dhis2::Api::Updatable
+        include ::Dhis2::Api::Deletable
+        include ::Dhis2::Api::Version224::SaveValidator
+        include ::Dhis2::Api::Shared::CategoryCombo
+
+        Schema = Dry::Validation.Schema do
+          required(:name).filled
+          required(:data_dimension_type).value(
+            included_in?: ::Dhis2::Api::Version224::Constants.data_dimension_types
+          )
+        end
+      end
+    end
+  end
+end

data/lib/dhis2/api/version224/category_option_combo.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Version224
+      class CategoryOptionCombo < ::Dhis2::Api::Base
+        include ::Dhis2::Api::Listable
+        include ::Dhis2::Api::Findable
+        include ::Dhis2::Api::Creatable
+        include ::Dhis2::Api::Updatable
+        include ::Dhis2::Api::Deletable
+        include ::Dhis2::Api::Version224::SaveValidator
+        include ::Dhis2::Api::Shared::CategoryOptionCombo
+
+        Schema = Dry::Validation.Schema do
+          required(:category_combo).schema do
+            required(:id).filled
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dhis2/api/version224/constants.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Version224
+      module Constants
+        include ::Dhis2::Api::Shared::Constants
+
+        VALUE_TYPES = %w(UNIT_INTERVAL LETTER BOOLEAN NUMBER TEXT DATE LONG_TEXT FILE_RESOURCE USERNAME TRACKER_ASSOCIATE COORDINATE INTEGER_POSITIVE DATETIME EMAIL TRUE_ONLY INTEGER INTEGER_ZERO_OR_POSITIVE TIME INTEGER_NEGATIVE PERCENTAGE PHONE_NUMBER).freeze
+        AGGREGATION_TYPES = %w(DEFAULT MAX AVERAGE_INT_DISAGGREGATION SUM AVERAGE_BOOL AVERAGE_INT COUNT CUSTOM STDDEV AVERAGE_SUM_ORG_UNIT NONE AVERAGE_SUM_INT AVERAGE_SUM_INT_DISAGGREGATION AVERAGE VARIANCE MIN).freeze
+
+        def self.value_types
+          VALUE_TYPES
+        end
+
+        def self.aggregation_types
+          AGGREGATION_TYPES
+        end
+      end
+    end
+  end
+end

data/lib/dhis2/api/version224/data_element.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Version224
+      class DataElement < ::Dhis2::Api::Base
+        include ::Dhis2::Api::Listable
+        include ::Dhis2::Api::Findable
+        include ::Dhis2::Api::Creatable
+        include ::Dhis2::Api::BulkCreatable
+        include ::Dhis2::Api::Updatable
+        include ::Dhis2::Api::Deletable
+        include ::Dhis2::Api::Version224::SaveValidator
+
+        Schema = Dry::Validation.Schema do
+          required(:name).filled
+          required(:short_name).filled
+          required(:aggregation_type).value(
+            included_in?: ::Dhis2::Api::Version224::Constants.aggregation_types
+          )
+          required(:domain_type).value(
+            included_in?: ::Dhis2::Api::Version224::Constants.domain_types
+          )
+          required(:value_type).value(
+            included_in?: ::Dhis2::Api::Version224::Constants.value_types
+          )
+          required(:category_combo).schema do
+            required(:id).filled
+          end
+        end
+
+        def self.creation_defaults(args)
+          {
+            aggregation_type:    "SUM",
+            code:                args[:short_name],
+            domain_type:         "AGGREGATE",
+            type:                "int",
+            value_type:          "NUMBER",
+            zero_is_significant: true
+          }
+        end
+      end
+    end
+  end
+end

data/lib/dhis2/api/version224/data_element_group.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Version224
+      class DataElementGroup < ::Dhis2::Api::Base
+        include ::Dhis2::Api::Listable
+        include ::Dhis2::Api::Findable
+        include ::Dhis2::Api::Creatable
+        include ::Dhis2::Api::BulkCreatable
+        include ::Dhis2::Api::Updatable
+        include ::Dhis2::Api::Deletable
+        include ::Dhis2::Api::Version224::SaveValidator
+        include ::Dhis2::Api::Shared::DataElementGroup
+
+        Schema = Dry::Validation.Schema do
+          required(:name).filled
+        end
+      end
+    end
+  end
+end

data/lib/dhis2/api/version224/data_set.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Version224
+      class DataSet < ::Dhis2::Api::Base
+        include ::Dhis2::Api::Listable
+        include ::Dhis2::Api::Findable
+        include ::Dhis2::Api::Creatable
+        include ::Dhis2::Api::BulkCreatable
+        include ::Dhis2::Api::Updatable
+        include ::Dhis2::Api::Deletable
+        include ::Dhis2::Api::Version224::SaveValidator
+
+        Schema = Dry::Validation.Schema do
+          required(:name).filled
+          required(:period_type).value(
+            included_in?: ::Dhis2::Api::Version224::Constants.period_types
+          )
+        end
+
+        def add_data_elements(new_data_element_ids)
+          (new_data_element_ids - data_element_ids).each do |data_element_id|
+            add_data_element(data_element_id, check: true)
+          end
+        end
+
+        def add_data_element(data_element_id, check: true)
+          # this returns 204 on success and failure...
+          client.post(path: "dataSets/#{id}/dataElements/#{data_element_id}", payload: {})
+          return unless check
+          updated_set = self.class.find(client, id)
+          if updated_set.data_element_ids.include?(data_element_id)
+            self.data_elements = updated_set.data_elements
+          else
+            raise Dhis2::DataElementAdditionError, "Could not add dataElement #{data_element_id}"
+          end
+        end
+
+        def data_element_ids
+          data_elements.map { |de| de["id"] }
+        end
+
+        def self.creation_defaults(args)
+          {
+            code:        args[:short_name],
+            period_type: "Monthly"
+          }
+        end
+      end
+    end
+  end
+end

data/lib/dhis2/api/version224/data_value.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Version224
+      class DataValue < ::Dhis2::Api::Base
+        include ::Dhis2::Api::Shared::DataValue
+      end
+    end
+  end
+end

data/lib/dhis2/api/version224/data_value_set.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Version224
+      class DataValueSet < ::Dhis2::Api::Base
+        include ::Dhis2::Api::Creatable
+        include ::Dhis2::Api::Listable
+        include ::Dhis2::Api::Version224::SaveValidator
+        include ::Dhis2::Api::Shared::DataValueSet
+
+        Schema = Dry::Validation.Schema do
+          required(:data_values).each do
+            schema do
+              required(:value).filled
+              required(:period).filled
+              required(:org_unit).filled
+              required(:data_element).filled
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dhis2/api/version224/event.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Version224
+      class Event < ::Dhis2::Api::Base
+        include ::Dhis2::Api::Listable
+        include ::Dhis2::Api::Findable
+        include ::Dhis2::Api::BulkCreatable
+        include ::Dhis2::Api::Creatable
+        include ::Dhis2::Api::Deletable
+        include ::Dhis2::Api::Version224::SaveValidator
+        include ::Dhis2::Api::Shared::Event
+
+        BulkCreationStatusClass = ::Dhis2::Api::EventCreationStatus
+
+        # args for a program without registration
+        # and a  program with a program_stage
+        Schema = Dry::Validation.Schema do
+          required(:program).filled # program must be linked to the org unit
+          required(:org_unit).filled
+          required(:event_date).filled
+          required(:data_values).each do
+            required(:data_element).filled
+            required(:value).filled
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dhis2/api/version224/index.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "save_validator"
+require_relative "constants"
+require_relative "analytic"
+require_relative "attribute"
+require_relative "category_combo"
+require_relative "category_option_combo"
+require_relative "data_element"
+require_relative "data_element_group"
+require_relative "data_set"
+require_relative "data_value"
+require_relative "data_value_set"
+require_relative "event"
+require_relative "indicator"
+require_relative "indicator_group"
+require_relative "indicator_type"
+require_relative "organisation_unit"
+require_relative "organisation_unit_group"
+require_relative "organisation_unit_group_set"
+require_relative "organisation_unit_level"
+require_relative "program"
+require_relative "report_table"
+require_relative "resource_table"
+require_relative "report"
+require_relative "system_info"
+require_relative "user"

data/lib/dhis2/api/version224/indicator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Version224
+      class Indicator < ::Dhis2::Api::Base
+        include ::Dhis2::Api::Listable
+        include ::Dhis2::Api::Findable
+        include ::Dhis2::Api::Creatable
+        include ::Dhis2::Api::Updatable
+        include ::Dhis2::Api::Deletable
+        include ::Dhis2::Api::Version224::SaveValidator
+
+        Schema = Dry::Validation.Schema do
+          required(:name).filled
+          required(:short_name).filled
+          required(:numerator).filled
+          required(:denominator).filled
+          required(:indicator_type).filled
+        end
+      end
+    end
+  end
+end

data/lib/dhis2/api/version224/indicator_group.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Version224
+      class IndicatorGroup < ::Dhis2::Api::Base
+        include ::Dhis2::Api::Listable
+        include ::Dhis2::Api::Findable
+        include ::Dhis2::Api::Creatable
+        include ::Dhis2::Api::Updatable
+        include ::Dhis2::Api::Deletable
+        include ::Dhis2::Api::Version224::SaveValidator
+
+        Schema = Dry::Validation.Schema do
+          required(:name).filled
+        end
+      end
+    end
+  end
+end

data/lib/dhis2/api/version224/indicator_type.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Version224
+      class IndicatorType < ::Dhis2::Api::Base
+        include ::Dhis2::Api::Listable
+        include ::Dhis2::Api::Findable
+        include ::Dhis2::Api::Creatable
+        include ::Dhis2::Api::Updatable
+        include ::Dhis2::Api::Deletable
+        include ::Dhis2::Api::Version224::SaveValidator
+
+        Schema = Dry::Validation.Schema do
+          required(:name).filled
+        end
+      end
+    end
+  end
+end

data/lib/dhis2/api/version224/organisation_unit.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Version224
+      class OrganisationUnit < ::Dhis2::Api::Base
+        include ::Dhis2::Api::Listable
+        include ::Dhis2::Api::Findable
+        include ::Dhis2::Api::Creatable
+        include ::Dhis2::Api::BulkCreatable
+        include ::Dhis2::Api::Updatable
+        include ::Dhis2::Api::Deletable
+        include ::Dhis2::Api::Version224::SaveValidator
+        include ::Dhis2::Api::Shared::OrganisationUnit
+
+        Schema = Dry::Validation.Schema do
+          required(:name).filled
+          required(:short_name).filled
+          required(:opening_date).filled
+        end
+      end
+    end
+  end
+end

data/lib/dhis2/api/version224/organisation_unit_group.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Version224
+      class OrganisationUnitGroup < ::Dhis2::Api::Base
+        include ::Dhis2::Api::Listable
+        include ::Dhis2::Api::Findable
+        include ::Dhis2::Api::Creatable
+        include ::Dhis2::Api::BulkCreatable
+        include ::Dhis2::Api::Updatable
+        include ::Dhis2::Api::Deletable
+        include ::Dhis2::Api::Version224::SaveValidator
+        include ::Dhis2::Api::Shared::OrganisationUnitGroup
+
+        Schema = Dry::Validation.Schema do
+          required(:name).filled
+        end
+      end
+    end
+  end
+end

data/lib/dhis2/api/version224/organisation_unit_group_set.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Version224
+      class OrganisationUnitGroupSet < ::Dhis2::Api::Base
+        include ::Dhis2::Api::Listable
+        include ::Dhis2::Api::Findable
+        include ::Dhis2::Api::Creatable
+        include ::Dhis2::Api::Updatable
+        include ::Dhis2::Api::Deletable
+        include ::Dhis2::Api::Version224::SaveValidator
+
+        Schema = Dry::Validation.Schema do
+          required(:name).filled
+        end
+      end
+    end
+  end
+end

data/lib/dhis2/api/version224/organisation_unit_level.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Version224
+      class OrganisationUnitLevel < ::Dhis2::Api::Base
+        include ::Dhis2::Api::Listable
+        include ::Dhis2::Api::Findable
+        include ::Dhis2::Api::Creatable
+        include ::Dhis2::Api::Updatable
+        include ::Dhis2::Api::Deletable
+        include ::Dhis2::Api::Version224::SaveValidator
+
+        Schema = Dry::Validation.Schema do
+          required(:name).filled
+          required(:level).filled
+        end
+      end
+    end
+  end
+end