dhis2 2.3.8 → 3.0.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dhis2
 version: !ruby/object:Gem::Version
-  version: 2.3.8
+  version: 3.0.0
 platform: ruby
 authors:
 - Martin Van Aken
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-18 00:00:00.000000000 Z
+date: 2018-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -25,33 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: dry-validation
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.12'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
+        version: 0.11.1
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.11.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -132,16 +118,16 @@ dependencies:
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -177,6 +163,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -189,39 +176,170 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- changelog.md
 - design.md
 - dhis2.gemspec
 - lib/dhis2.rb
-- lib/dhis2/api/analytic.rb
-- lib/dhis2/api/attribute.rb
 - lib/dhis2/api/base.rb
-- lib/dhis2/api/category_combo.rb
-- lib/dhis2/api/category_option_combo.rb
-- lib/dhis2/api/data_element.rb
-- lib/dhis2/api/data_element_group.rb
-- lib/dhis2/api/data_set.rb
-- lib/dhis2/api/data_value.rb
-- lib/dhis2/api/data_value_set.rb
-- lib/dhis2/api/event.rb
-- lib/dhis2/api/indicator.rb
-- lib/dhis2/api/indicator_group.rb
-- lib/dhis2/api/organisation_unit.rb
-- lib/dhis2/api/organisation_unit_group.rb
-- lib/dhis2/api/organisation_unit_group_set.rb
-- lib/dhis2/api/organisation_unit_level.rb
-- lib/dhis2/api/program.rb
-- lib/dhis2/api/report.rb
-- lib/dhis2/api/report_table.rb
-- lib/dhis2/api/resource_table.rb
-- lib/dhis2/api/system_info.rb
-- lib/dhis2/api/user.rb
+- lib/dhis2/api/bulk_creatable.rb
+- lib/dhis2/api/constants.rb
+- lib/dhis2/api/creatable.rb
+- lib/dhis2/api/deletable.rb
+- lib/dhis2/api/event_creation_status.rb
+- lib/dhis2/api/findable.rb
+- lib/dhis2/api/import_summary.rb
+- lib/dhis2/api/listable.rb
+- lib/dhis2/api/query_parameters_formatter.rb
+- lib/dhis2/api/shared/analytic.rb
+- lib/dhis2/api/shared/category_combo.rb
+- lib/dhis2/api/shared/category_option_combo.rb
+- lib/dhis2/api/shared/constants.rb
+- lib/dhis2/api/shared/data_element_group.rb
+- lib/dhis2/api/shared/data_set.rb
+- lib/dhis2/api/shared/data_value.rb
+- lib/dhis2/api/shared/data_value_set.rb
+- lib/dhis2/api/shared/event.rb
+- lib/dhis2/api/shared/organisation_unit.rb
+- lib/dhis2/api/shared/organisation_unit_group.rb
+- lib/dhis2/api/shared/report_tables.rb
+- lib/dhis2/api/shared/resource_table.rb
+- lib/dhis2/api/shared/save_validator.rb
+- lib/dhis2/api/shared/system_info.rb
+- lib/dhis2/api/updatable.rb
+- lib/dhis2/api/version224/analytic.rb
+- lib/dhis2/api/version224/attribute.rb
+- lib/dhis2/api/version224/category_combo.rb
+- lib/dhis2/api/version224/category_option_combo.rb
+- lib/dhis2/api/version224/constants.rb
+- lib/dhis2/api/version224/data_element.rb
+- lib/dhis2/api/version224/data_element_group.rb
+- lib/dhis2/api/version224/data_set.rb
+- lib/dhis2/api/version224/data_value.rb
+- lib/dhis2/api/version224/data_value_set.rb
+- lib/dhis2/api/version224/event.rb
+- lib/dhis2/api/version224/index.rb
+- lib/dhis2/api/version224/indicator.rb
+- lib/dhis2/api/version224/indicator_group.rb
+- lib/dhis2/api/version224/indicator_type.rb
+- lib/dhis2/api/version224/organisation_unit.rb
+- lib/dhis2/api/version224/organisation_unit_group.rb
+- lib/dhis2/api/version224/organisation_unit_group_set.rb
+- lib/dhis2/api/version224/organisation_unit_level.rb
+- lib/dhis2/api/version224/program.rb
+- lib/dhis2/api/version224/report.rb
+- lib/dhis2/api/version224/report_table.rb
+- lib/dhis2/api/version224/resource_table.rb
+- lib/dhis2/api/version224/save_validator.rb
+- lib/dhis2/api/version224/system_info.rb
+- lib/dhis2/api/version224/user.rb
+- lib/dhis2/api/version225/analytic.rb
+- lib/dhis2/api/version225/attribute.rb
+- lib/dhis2/api/version225/category_combo.rb
+- lib/dhis2/api/version225/category_option_combo.rb
+- lib/dhis2/api/version225/constants.rb
+- lib/dhis2/api/version225/data_element.rb
+- lib/dhis2/api/version225/data_element_group.rb
+- lib/dhis2/api/version225/data_set.rb
+- lib/dhis2/api/version225/data_value.rb
+- lib/dhis2/api/version225/data_value_set.rb
+- lib/dhis2/api/version225/event.rb
+- lib/dhis2/api/version225/index.rb
+- lib/dhis2/api/version225/indicator.rb
+- lib/dhis2/api/version225/indicator_group.rb
+- lib/dhis2/api/version225/indicator_type.rb
+- lib/dhis2/api/version225/organisation_unit.rb
+- lib/dhis2/api/version225/organisation_unit_group.rb
+- lib/dhis2/api/version225/organisation_unit_group_set.rb
+- lib/dhis2/api/version225/organisation_unit_level.rb
+- lib/dhis2/api/version225/program.rb
+- lib/dhis2/api/version225/report.rb
+- lib/dhis2/api/version225/report_table.rb
+- lib/dhis2/api/version225/resource_table.rb
+- lib/dhis2/api/version225/system_info.rb
+- lib/dhis2/api/version225/user.rb
+- lib/dhis2/api/version226/analytic.rb
+- lib/dhis2/api/version226/attribute.rb
+- lib/dhis2/api/version226/category_combo.rb
+- lib/dhis2/api/version226/category_option_combo.rb
+- lib/dhis2/api/version226/constants.rb
+- lib/dhis2/api/version226/data_element.rb
+- lib/dhis2/api/version226/data_element_group.rb
+- lib/dhis2/api/version226/data_set.rb
+- lib/dhis2/api/version226/data_value.rb
+- lib/dhis2/api/version226/data_value_set.rb
+- lib/dhis2/api/version226/event.rb
+- lib/dhis2/api/version226/index.rb
+- lib/dhis2/api/version226/indicator.rb
+- lib/dhis2/api/version226/indicator_group.rb
+- lib/dhis2/api/version226/indicator_type.rb
+- lib/dhis2/api/version226/organisation_unit.rb
+- lib/dhis2/api/version226/organisation_unit_group.rb
+- lib/dhis2/api/version226/organisation_unit_group_set.rb
+- lib/dhis2/api/version226/organisation_unit_level.rb
+- lib/dhis2/api/version226/program.rb
+- lib/dhis2/api/version226/report.rb
+- lib/dhis2/api/version226/report_table.rb
+- lib/dhis2/api/version226/resource_table.rb
+- lib/dhis2/api/version226/system_info.rb
+- lib/dhis2/api/version226/user.rb
+- lib/dhis2/api/version227/analytic.rb
+- lib/dhis2/api/version227/attribute.rb
+- lib/dhis2/api/version227/category_combo.rb
+- lib/dhis2/api/version227/category_option_combo.rb
+- lib/dhis2/api/version227/constants.rb
+- lib/dhis2/api/version227/data_element.rb
+- lib/dhis2/api/version227/data_element_group.rb
+- lib/dhis2/api/version227/data_set.rb
+- lib/dhis2/api/version227/data_value.rb
+- lib/dhis2/api/version227/data_value_set.rb
+- lib/dhis2/api/version227/event.rb
+- lib/dhis2/api/version227/index.rb
+- lib/dhis2/api/version227/indicator.rb
+- lib/dhis2/api/version227/indicator_group.rb
+- lib/dhis2/api/version227/indicator_type.rb
+- lib/dhis2/api/version227/organisation_unit.rb
+- lib/dhis2/api/version227/organisation_unit_group.rb
+- lib/dhis2/api/version227/organisation_unit_group_set.rb
+- lib/dhis2/api/version227/organisation_unit_level.rb
+- lib/dhis2/api/version227/program.rb
+- lib/dhis2/api/version227/report.rb
+- lib/dhis2/api/version227/report_table.rb
+- lib/dhis2/api/version227/resource_table.rb
+- lib/dhis2/api/version227/system_info.rb
+- lib/dhis2/api/version227/user.rb
+- lib/dhis2/api/version228/analytic.rb
+- lib/dhis2/api/version228/attribute.rb
+- lib/dhis2/api/version228/category_combo.rb
+- lib/dhis2/api/version228/category_option_combo.rb
+- lib/dhis2/api/version228/constants.rb
+- lib/dhis2/api/version228/data_element.rb
+- lib/dhis2/api/version228/data_element_group.rb
+- lib/dhis2/api/version228/data_set.rb
+- lib/dhis2/api/version228/data_value.rb
+- lib/dhis2/api/version228/data_value_set.rb
+- lib/dhis2/api/version228/event.rb
+- lib/dhis2/api/version228/index.rb
+- lib/dhis2/api/version228/indicator.rb
+- lib/dhis2/api/version228/indicator_group.rb
+- lib/dhis2/api/version228/indicator_type.rb
+- lib/dhis2/api/version228/organisation_unit.rb
+- lib/dhis2/api/version228/organisation_unit_group.rb
+- lib/dhis2/api/version228/organisation_unit_group_set.rb
+- lib/dhis2/api/version228/organisation_unit_level.rb
+- lib/dhis2/api/version228/program.rb
+- lib/dhis2/api/version228/report.rb
+- lib/dhis2/api/version228/report_table.rb
+- lib/dhis2/api/version228/resource_table.rb
+- lib/dhis2/api/version228/system_info.rb
+- lib/dhis2/api/version228/user.rb
+- lib/dhis2/case.rb
+- lib/dhis2/classes.rb
 - lib/dhis2/client.rb
 - lib/dhis2/collection_wrapper.rb
 - lib/dhis2/configuration.rb
-- lib/dhis2/import_error.rb
+- lib/dhis2/error.rb
 - lib/dhis2/pager.rb
 - lib/dhis2/paginated_array.rb
-- lib/dhis2/status.rb
 - lib/dhis2/version.rb
 homepage: http://github.com/blsq/dhis2
 licenses:

data/lib/dhis2/api/analytic.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Dhis2
-  module Api
-    class Analytic < Base
-      class << self
-        def list(client, periods:, organisation_units:, data_elements:, filter: nil)
-          params = [
-            [:dimension, "ou:#{organisation_units}"],
-            [:dimension, "dx:#{data_elements}"],
-            [:dimension, "pe:#{periods}"]
-          ]
-          params << [:filter, filter.to_s] if filter
-
-          client.get(resource_name, RestClient::ParamsArray.new(params))
-        end
-      end
-    end
-  end
-end

data/lib/dhis2/api/attribute.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module Dhis2
-  module Api
-    class Attribute < Base
-    end
-  end
-end

data/lib/dhis2/api/category_combo.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module Dhis2
-  module Api
-    class CategoryCombo < Base
-      class << self
-        def defaut
-          find_by(name: "default")
-        end
-
-        def create(client, combos)
-          combos = [combos].flatten
-          category_combo = {
-            categoryCombos: combos.map do |combo|
-              {
-                name:                combo[:name],
-                data_dimension_type: combo[:aggregation_type] || "DISAGGREGATION"
-              }
-            end
-          }
-
-          response = client.post("metadata", category_combo)
-          Dhis2::Status.new(response)
-        end
-      end
-    end
-  end
-end

data/lib/dhis2/api/category_option_combo.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module Dhis2
-  module Api
-    class CategoryOptionCombo < Base
-    end
-  end
-end

data/lib/dhis2/api/data_element.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module Dhis2
-  module Api
-    class DataElement < Base
-      class << self
-        def create(client, elements, query_params = { preheat_cache: false })
-          elements = [elements].flatten
-          category_combo = client.category_combos.find_by(name: "default")
-
-          data_element = {
-            data_elements: elements.map do |element|
-              {
-                name:                 element[:name],
-                short_name:           element[:short_name],
-                code:                 element[:code] || element[:short_name],
-                domain_type:          element[:domain_type] || "AGGREGATE",
-                value_type:           element[:value_type] || "NUMBER",
-                aggregation_type:     element[:aggregation_type] || "SUM",
-                type:                 element[:type] || "int", # for backward compatbility
-                aggregation_operator: element[:aggregation_type] || "SUM", # for backward compatbility
-                zero_is_significant:  element[:zero_is_significant] || true,
-                category_combo:       { id: category_combo.id, name: category_combo.name }
-              }
-            end
-          }
-
-          response = client.post("metadata", data_element, client.class.deep_change_case(query_params, :camelize))
-          Dhis2::Status.new(response)
-        end
-      end
-    end
-  end
-end

data/lib/dhis2/api/data_element_group.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module Dhis2
-  module Api
-    class DataElementGroup < Base
-      class << self
-        def create(client, groups)
-          groups = [groups].flatten
-          de_groups = {
-            data_element_groups: groups.map do |group|
-              mapped_group = {
-                name:       group[:name],
-                short_name: group[:short_name],
-                code:       group[:code] || group[:short_name]
-              }
-
-              if group[:data_elements]
-                data_elements = group[:data_elements].map do |element|
-                  { id: element[:id] }
-                end
-                mapped_group[:data_elements] = data_elements
-              end
-              mapped_group
-            end
-          }
-          response = client.post("metadata", de_groups)
-          Dhis2::Status.new(response)
-        end
-      end
-    end
-  end
-end

data/lib/dhis2/api/data_set.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-module Dhis2
-  module Api
-    class DataSet < Base
-      class << self
-        def create(client, sets)
-          sets = [sets].flatten
-
-          category_combo = client.category_combos.find_by(name: "default")
-
-          data_set = {
-            data_sets: sets.map do |set|
-              dataset = {
-                name:               set[:name],
-                short_name:         set[:short_name],
-                code:               set[:code],
-                period_type:        "Monthly",
-                data_elements:      set[:data_element_ids] ? set[:data_element_ids].map { |id| { id: id } } : [],
-                organisation_units: set[:organisation_unit_ids] ? set[:organisation_unit_ids].map { |id| { id: id } } : [],
-                category_combo:     { id: category_combo.id, name: category_combo.name }
-              }
-
-              dataset
-            end
-          }
-          response = client.post("metadata", data_set)
-          Dhis2::Status.new(response)
-        end
-      end
-    end
-  end
-end

data/lib/dhis2/api/data_value.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Dhis2
-  module Api
-    class DataValue < Base
-      class << self
-        def find(client, period:, organisation_unit:, data_element:)
-          params = { pe: period, ou: organisation_unit, de: data_element }
-
-          client.get(resource_name, params).first
-        end
-      end
-    end
-  end
-end

data/lib/dhis2/api/data_value_set.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-module Dhis2
-  module Api
-    class DataValueSet < Base
-      def values
-        data_values.map do |data_value|
-          OpenStruct.new(data_value)
-        end
-      end
-
-      class << self
-        def create(client, tuples)
-          body = { dataValues: tuples }
-          response = client.post(resource_name, body)
-          Dhis2::Status.new(response)
-        end
-
-        def list(client, options)
-          new(client, client.get(build_list_url(client, options)))
-        end
-
-        def build_list_url(_client, options)
-          params = [build_what_url(options), build_when_url(options), build_where_url(options)].join("&")
-          resource_name + "?" + params
-        end
-
-        def build_what_url(options)
-          data_set_ids = options[:data_sets]
-          if data_set_ids
-            data_sets_url = data_set_ids.map { |ds| "dataSet=#{ds}" }.join("&")
-          else
-            data_element_groups = options[:data_element_groups]
-            data_sets_url = data_element_groups.map { |deg| "dataElementGroup=#{deg}" }.join("&") if data_element_groups
-          end
-        end
-
-        def build_when_url(options)
-          periods = options[:periods]
-          if periods
-            periods = periods.map { |period| "period=#{period}" }.join("&")
-          else
-            start_date = options[:start_date]
-            end_date = options[:end_date]
-            date_args = []
-            date_args.push "startDate=#{start_date}" if start_date
-            date_args.push "endDate=#{end_date}" if end_date
-            periods = date_args.join("&")
-          end
-          periods
-        end
-
-        def build_where_url(options)
-          children = options[:children].nil? ? true : options[:children]
-          organisation_unit_id = options[:organisation_unit]
-          organisation_unit_group = options[:organisation_unit_group]
-          if organisation_unit_id
-            if organisation_unit_id.class == Array
-              ou_url = organisation_unit_id.map { |ou_id| "orgUnit=#{ou_id}" }.join("&") + "&children=#{children}"
-            else
-              ou_url = "orgUnit=#{organisation_unit_id}&children=#{children}"
-            end
-          else
-            ou_url = "orgUnitGroup=#{organisation_unit_group}"
-          end
-          ou_url
-        end
-      end
-    end
-  end
-end

data/lib/dhis2/api/event.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module Dhis2
-  module Api
-    class Event < Base
-      def id
-        event
-      end
-      class << self
-        def format_query_parameters(options)
-
-          params = []
-          params.push([:page, options[:page]])                    if options[:page]
-          params.push([:pageSize, options[:page_size]])           if options[:page_size]
-          params.push([:fields, format_fields(options[:fields])]) if options[:fields]
-          params.concat(format_filter(options[:filter]))          if options[:filter]
-          params.push([:program, options[:program]])               if options[:program]
-          params.push([:orgUnit, options[:org_unit]])             if options[:org_unit]
-          params.push([:trackedEntityInstance, options[:tracked_entity_instance]]) if options[:tracked_entity_instance]
-
-          RestClient::ParamsArray.new(params)
-        end
-
-        def create(client, tuples)
-          begin
-            body = { resource_name.to_sym => tuples }
-            response = client.post(resource_name, body)
-          rescue RestClient::Conflict => e
-            response = Dhis2::Client.deep_change_case(JSON.parse(e.response.body), :underscore)
-          end
-          Dhis2::Status.new(response)
-        end
-      end
-    end
-  end
-end

data/lib/dhis2/api/indicator.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module Dhis2
-  module Api
-    class Indicator < Base
-    end
-  end
-end

data/lib/dhis2/api/indicator_group.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module Dhis2
-  module Api
-    class IndicatorGroup < Base
-    end
-  end
-end

data/lib/dhis2/api/organisation_unit.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-module Dhis2
-  module Api
-    class OrganisationUnit < Base
-      def initialize(client, params)
-        super
-        self.parent_id    = params["parent"]["id"] if params["parent"]
-        self.children_ids = params["children"] ? params["children"].map { |raw| raw["id"] } : []
-      end
-
-      class << self
-        def find(client, id, options = {})
-          raise "Missing id" if id.nil?
-          if id.class == Array
-            list(client, filter: "id:in:[#{id.join(',')}]", fields: :all, page_size: id.size)
-          elsif options.any?
-            params = []
-            options.each do |name, value|
-              params << [client.class.camelize(name.to_s, false), value]
-            end
-            params        = client.class.deep_change_case(params, :camelize)
-            json_response = client.get("#{resource_name}/#{id}", RestClient::ParamsArray.new(params))
-            if options[:include_descendants] || options[:include_children]
-              json_response = client.get(resource_name, format_query_parameters(options))
-              resource_key  = client.class.underscore(resource_name)
-              PaginatedArray.new(
-                json_response[resource_key].map { |raw_resource| new(client, raw_resource) },
-                json_response["pager"]
-              )
-            else
-              new(client, json_response)
-            end
-          else
-            response = client.get("#{resource_name}/#{id}")
-            new(client, response)
-          end
-        end
-
-        def create(client, orgunits)
-          orgunits = [orgunits].flatten
-
-          payload = {
-            organisationUnits: orgunits.map do |orgunit|
-              orgunit[:parent] = { id: orgunit[:parent_id] } if orgunit[:parent_id]
-              orgunit[:id] = orgunit[:id] if orgunit[:id]
-              orgunit
-            end
-          }
-
-          response = client.post("metadata", payload)
-          Dhis2::Status.new(response)
-        end
-
-        def last_level_descendants(client, id)
-          levels     = client.organisation_unit_levels.list(fields: :all)
-          last_level = levels.map(&:level).sort.last
-
-          client.organisation_units.find(id, include_descendants: true).select do |ou|
-            ou.level == last_level
-          end
-        end
-      end
-    end
-  end
-end