dhis2 3.0.3 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca81d93073a9f85779f78fa6102bada9a6bf91cd
-  data.tar.gz: 11ec2fba5f33d5e26d29b312f506034b99edd3f0
+  metadata.gz: 1aa84c5184a6aaccdbde59f8734d44c4cf615c87
+  data.tar.gz: ba4851e6ac597be06e479ab19faf84c87be86480
 SHA512:
-  metadata.gz: 4e383500dd5ee00ed5bc110a5e08631e629c8856f6dbab454afe07261cc772e7e25808bf15887d1ecbb78571a7afae3e72d9b3d0ac9cd4642bea99b973f26637
-  data.tar.gz: b7759bf306930b53143c970e38826511398cdafd8b27ebdb6467ac90b63212f8bce6a6839fdb9cf85eda0a3d8474f9679fd7f49fa2037d5b89b665d3e959c044
+  metadata.gz: e50be53b6a30f28461d949bbafb001ddaafb87bfe37c83c5605ef7978b7af77dbe14f79e36082ea0709a97dda1aced9bc07b9819744ddd6c8f99fe726f063279
+  data.tar.gz: e0468e8ccd80eb67c604d0d9467df4d7e8e6670abdd7e72787da5204b29a0b47fad7c6e8d70d1fad2b1a6a4e8aa8a52299403efbc780396a607a3717289d129d

data/lib/dhis2.rb

@@ -31,6 +31,8 @@ require_relative "dhis2/api/updatable"
 require_relative "dhis2/api/query_parameters_formatter"
 
 require_relative "dhis2/api/shared/analytic"
+require_relative "dhis2/api/shared/category"
+require_relative "dhis2/api/shared/category_option"
 require_relative "dhis2/api/shared/category_combo"
 require_relative "dhis2/api/shared/category_option_combo"
 require_relative "dhis2/api/shared/constants"
@@ -54,8 +56,8 @@ require_relative "dhis2/api/version228/index"
 
 module Dhis2
   class << self
-    def play(debug = false)
-      Dhis2::Client.new(config.play_params(debug))
+    def play(debug = false, version:  "2.28")
+      Dhis2::Client.new(config.play_params(debug, version))
     end
 
     def client

data/lib/dhis2/api/bulk_creatable.rb

@@ -9,12 +9,14 @@ module Dhis2
 
       module ClassMethods
 
-        BulkCreationStatusClass = ::Dhis2::Api::ImportSummary
+        def bulk_creation_status_class
+           ::Dhis2::Api::ImportSummary
+        end
 
         # args is a hash like: { data_element_groups: [{ name: "foo" }, { name: "bar" }] }
         def bulk_create(client, args, raw_input = false)
           response = client.post(path: "metadata", payload: args, raw_input: raw_input)
-          self::BulkCreationStatusClass.new(response).tap do |summary|
+          bulk_creation_status_class.new(response).tap do |summary|
             unless summary.bulk_success?
               exception = Dhis2::BulkCreationError.new("Didnt create bulk of data properly.\n Response: #{response.to_json}")
               exception.import_summary = summary

data/lib/dhis2/api/import_summary.rb

@@ -53,7 +53,7 @@ module Dhis2
 
       def base_success?
         %w(ImportSummary ImportTypeSummary).include?(hash["response_type"]) &&
-          hash["status"] == "SUCCESS" &&
+        %w(OK SUCCESS).include?(hash["status"]) &&
           import_count
       end
     end

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

@@ -0,0 +1,32 @@
+
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Shared
+      module Category
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        Schema = Dry::Validation.Schema do
+          required(:name).filled
+          required(:data_dimension_type).value(
+            included_in?: ::Dhis2::Api::Constants::DATA_DIMENSION_TYPES
+          )
+        end
+
+        module ClassMethods
+          def resource_name
+            "categories"
+          end
+          def creation_defaults(args)
+            {
+              data_dimension_type: "DISAGGREGATION"
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Shared
+      module CategoryOption
+        Schema = Dry::Validation.Schema do
+          required(:name).filled
+        end
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        module ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Version224
+      class Category < ::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::Category
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Version224
+      class CategoryOption < ::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::Shared::SaveValidator
+        include ::Dhis2::Api::Shared::CategoryOption
+
+      end
+    end
+  end
+end

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

@@ -4,6 +4,8 @@ require_relative "save_validator"
 require_relative "constants"
 require_relative "analytic"
 require_relative "attribute"
+require_relative "category"
+require_relative "category_option"
 require_relative "category_combo"
 require_relative "category_option_combo"
 require_relative "data_element"

data/lib/dhis2/api/version225/category.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Version225
+      class Category < ::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::Shared::SaveValidator
+        include ::Dhis2::Api::Shared::Category
+      end
+    end
+  end
+end

data/lib/dhis2/api/version225/category_option.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Version225
+      class CategoryOption < ::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::Shared::SaveValidator
+        include ::Dhis2::Api::Shared::CategoryOption
+      end
+    end
+  end
+end

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

@@ -12,7 +12,9 @@ module Dhis2
         include ::Dhis2::Api::Shared::SaveValidator
         include ::Dhis2::Api::Shared::Event
 
-        BulkCreationStatusClass = ::Dhis2::Api::EventCreationStatus
+        def bulk_creation_status_class
+          ::Dhis2::Api::EventCreationStatus
+        end
 
         # args for a program without registration
         # and a  program with a program_stage

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

@@ -3,6 +3,8 @@
 require_relative "constants"
 require_relative "analytic"
 require_relative "attribute"
+require_relative "category"
+require_relative "category_option"
 require_relative "category_combo"
 require_relative "category_option_combo"
 require_relative "data_element"

data/lib/dhis2/api/version226/category.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Version226
+      class Category < ::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::Shared::SaveValidator
+        include ::Dhis2::Api::Shared::Category
+      end
+    end
+  end
+end

data/lib/dhis2/api/version226/category_option.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Version226
+      class CategoryOption < ::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::Shared::SaveValidator
+        include ::Dhis2::Api::Shared::CategoryOption
+      end
+    end
+  end
+end

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

@@ -12,7 +12,9 @@ module Dhis2
         include ::Dhis2::Api::Shared::SaveValidator
         include ::Dhis2::Api::Shared::Event
 
-        BulkCreationStatusClass = ::Dhis2::Api::EventCreationStatus
+        def bulk_creation_status_class
+          ::Dhis2::Api::EventCreationStatus
+        end
 
         # args for a program without registration
         # and a  program with a program_stage

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

@@ -3,6 +3,8 @@
 require_relative "constants"
 require_relative "analytic"
 require_relative "attribute"
+require_relative "category"
+require_relative "category_option"
 require_relative "category_combo"
 require_relative "category_option_combo"
 require_relative "data_element"

data/lib/dhis2/api/version227/category.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Version227
+      class Category < ::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::Shared::SaveValidator
+        include ::Dhis2::Api::Shared::Category
+      end
+    end
+  end
+end

data/lib/dhis2/api/version227/category_option.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Version227
+      class CategoryOption < ::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::Shared::SaveValidator
+        include ::Dhis2::Api::Shared::CategoryOption
+      end
+    end
+  end
+end

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

@@ -12,7 +12,9 @@ module Dhis2
         include ::Dhis2::Api::Shared::SaveValidator
         include ::Dhis2::Api::Shared::Event
 
-        BulkCreationStatusClass = ::Dhis2::Api::EventCreationStatus
+        def bulk_creation_status_class
+          ::Dhis2::Api::EventCreationStatus
+        end
 
         # args for a program without registration
         # and a  program with a program_stage

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

@@ -3,6 +3,8 @@
 require_relative "constants"
 require_relative "analytic"
 require_relative "attribute"
+require_relative "category"
+require_relative "category_option"
 require_relative "category_combo"
 require_relative "category_option_combo"
 require_relative "data_element"

data/lib/dhis2/api/version228/category.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Version228
+      class Category < ::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::Shared::SaveValidator
+        include ::Dhis2::Api::Shared::Category
+      end
+    end
+  end
+end

data/lib/dhis2/api/version228/category_option.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Dhis2
+  module Api
+    module Version228
+      class CategoryOption < ::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::Shared::SaveValidator
+        include ::Dhis2::Api::Shared::CategoryOption
+      end
+    end
+  end
+end

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

@@ -12,7 +12,9 @@ module Dhis2
         include ::Dhis2::Api::Shared::SaveValidator
         include ::Dhis2::Api::Shared::Event
 
-        BulkCreationStatusClass = ::Dhis2::Api::EventCreationStatus
+        def bulk_creation_status_class
+          ::Dhis2::Api::EventCreationStatus
+        end
 
         # args for a program without registration
         # and a  program with a program_stage

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

@@ -3,6 +3,8 @@
 require_relative "constants"
 require_relative "analytic"
 require_relative "attribute"
+require_relative "category"
+require_relative "category_option"
 require_relative "category_combo"
 require_relative "category_option_combo"
 require_relative "data_element"

data/lib/dhis2/classes.rb

@@ -21,6 +21,8 @@ module Dhis2
 
   class Analytic < Versioned; end
   class Attribute < Versioned; end
+  class Category < Versioned; end
+  class CategoryOption < Versioned; end
   class CategoryCombo < Versioned; end
   class CategoryOptionCombo < Versioned; end
   class DataElement < Versioned; end

data/lib/dhis2/client.rb

@@ -40,6 +40,14 @@ module Dhis2
       @attributes ||= CollectionWrapper.new("Attribute", self)
     end
 
+    def categories
+      @categories ||= CollectionWrapper.new("Category", self)
+    end
+
+    def category_options
+      @category_options ||= CollectionWrapper.new("CategoryOption", self)
+    end
+
     def category_combos
       @category_combos ||= CollectionWrapper.new("CategoryCombo", self)
     end
@@ -144,11 +152,13 @@ module Dhis2
     TAB = "\t"
 
     def execute(method_name:, url:, query_params: {}, payload: nil, raw: false, raw_input: false)
+      computed_payload = compute_payload(payload, raw_input)
+
       raw_response = RestClient::Request.execute(
         method:     method_name,
         url:        url,
         headers:    headers(method_name, query_params),
-        payload:    compute_payload(payload, raw_input),
+        payload:    computed_payload,
         verify_ssl: @verify_ssl,
         timeout:    @timeout
       )
@@ -164,6 +174,7 @@ module Dhis2
       exception.response  = e.response  if e.respond_to?(:response)
       exception.http_code = e.http_code if e.respond_to?(:http_code)
       exception.http_body = e.http_body if e.respond_to?(:http_body)
+      log(exception.response.request, exception.response)
       raise exception
     end
 
@@ -184,7 +195,7 @@ module Dhis2
     end
 
     def log(request, response)
-      puts [request.url, request.args[:payload], response].join(TAB) if @debug
+      puts [request.url, request.args[:payload].to_json, response.to_json].join(TAB) if @debug
     end
   end
 end

data/lib/dhis2/configuration.rb

@@ -16,11 +16,11 @@ module Dhis2
       }
     end
 
-    def play_params(with_debug)
+    def play_params(with_debug, version)
       {
-        url:     "https://admin:district@play.dhis2.org/2.28/",
+        url:     "https://admin:district@play.dhis2.org/#{version}/",
         debug:   with_debug,
-        version: "2.28"
+        version: version
       }
     end
 

data/lib/dhis2/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dhis2
-  VERSION = "3.0.3"
+  VERSION = "3.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dhis2
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.0.4
 platform: ruby
 authors:
 - Martin Van Aken
@@ -191,7 +191,9 @@ files:
 - lib/dhis2/api/listable.rb
 - lib/dhis2/api/query_parameters_formatter.rb
 - lib/dhis2/api/shared/analytic.rb
+- lib/dhis2/api/shared/category.rb
 - lib/dhis2/api/shared/category_combo.rb
+- lib/dhis2/api/shared/category_option.rb
 - lib/dhis2/api/shared/category_option_combo.rb
 - lib/dhis2/api/shared/constants.rb
 - lib/dhis2/api/shared/data_element_group.rb
@@ -208,7 +210,9 @@ files:
 - lib/dhis2/api/updatable.rb
 - lib/dhis2/api/version224/analytic.rb
 - lib/dhis2/api/version224/attribute.rb
+- lib/dhis2/api/version224/category.rb
 - lib/dhis2/api/version224/category_combo.rb
+- lib/dhis2/api/version224/category_option.rb
 - lib/dhis2/api/version224/category_option_combo.rb
 - lib/dhis2/api/version224/constants.rb
 - lib/dhis2/api/version224/data_element.rb
@@ -234,7 +238,9 @@ files:
 - lib/dhis2/api/version224/user.rb
 - lib/dhis2/api/version225/analytic.rb
 - lib/dhis2/api/version225/attribute.rb
+- lib/dhis2/api/version225/category.rb
 - lib/dhis2/api/version225/category_combo.rb
+- lib/dhis2/api/version225/category_option.rb
 - lib/dhis2/api/version225/category_option_combo.rb
 - lib/dhis2/api/version225/constants.rb
 - lib/dhis2/api/version225/data_element.rb
@@ -259,7 +265,9 @@ files:
 - lib/dhis2/api/version225/user.rb
 - lib/dhis2/api/version226/analytic.rb
 - lib/dhis2/api/version226/attribute.rb
+- lib/dhis2/api/version226/category.rb
 - lib/dhis2/api/version226/category_combo.rb
+- lib/dhis2/api/version226/category_option.rb
 - lib/dhis2/api/version226/category_option_combo.rb
 - lib/dhis2/api/version226/constants.rb
 - lib/dhis2/api/version226/data_element.rb
@@ -284,7 +292,9 @@ files:
 - lib/dhis2/api/version226/user.rb
 - lib/dhis2/api/version227/analytic.rb
 - lib/dhis2/api/version227/attribute.rb
+- lib/dhis2/api/version227/category.rb
 - lib/dhis2/api/version227/category_combo.rb
+- lib/dhis2/api/version227/category_option.rb
 - lib/dhis2/api/version227/category_option_combo.rb
 - lib/dhis2/api/version227/constants.rb
 - lib/dhis2/api/version227/data_element.rb
@@ -309,7 +319,9 @@ files:
 - lib/dhis2/api/version227/user.rb
 - lib/dhis2/api/version228/analytic.rb
 - lib/dhis2/api/version228/attribute.rb
+- lib/dhis2/api/version228/category.rb
 - lib/dhis2/api/version228/category_combo.rb
+- lib/dhis2/api/version228/category_option.rb
 - lib/dhis2/api/version228/category_option_combo.rb
 - lib/dhis2/api/version228/constants.rb
 - lib/dhis2/api/version228/data_element.rb