dhis2 2.2.1 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae7f039a0975be7f51396cf5726370c122e5c419
-  data.tar.gz: 1030e34afba383313497c392823f840e1d7a2194
+  metadata.gz: 367a235ae4138cbe459be2b16a1c5766a74795b7
+  data.tar.gz: ead76712bed0f67df5c4896820defe3f94f5e5da
 SHA512:
-  metadata.gz: 13524e283c71c7470a4a866e10aa9ef9e4dcc7c88480d9b6796f81354582c30807f00f75f65e285306e86dc04527106b5eae80ffd42e4bb53953c057bcb977d7
-  data.tar.gz: e1b1875faae92a86f3a901801988a818ec81f0dec74cecb5611d41f986199f6ff38e0e4405608a718d0c0a35289e76f291ee0239fde39f98fd1c32b7d0b97e7c
+  metadata.gz: 9466e838c544703902d2e2ed95de69618a1c648e88deb899dcacc22abb4f20cc094b0404fc16f9044bad58522e1db7826d896d8287e565496012ba752a15931e
+  data.tar.gz: 69cb9a93ccf9a28b7f99919ce93d183d6a98875f2643374e487a4be0e3de75a24fed52832a3fe6e37912715c0d2910424e60b78e4961a78d9630617961c2f1b2

data/README.md

@@ -29,7 +29,7 @@ The functionalities are available as a module. First thing you need to do is to
 
 * Global configuration (to call a single Dhis2 instance):
 
-  ```ruby 
+  ```ruby
   Dhis2.configure do |config|
     config.url      = "https://play.dhis2.org/demo"
     config.user     = "admin"
@@ -45,8 +45,8 @@ The functionalities are available as a module. First thing you need to do is to
   ```
 
 * Local configuration: (in case you need to access different Dhis2 instances inside a single project):
-  
-  ```ruby 
+
+  ```ruby
   client = Dhis2::Client.new(url: "https://play.dhis2.org/demo", user: "admin", password: "district")
   client.data_elements.list # => Array[<DataElement>,..]
 
@@ -57,7 +57,7 @@ The functionalities are available as a module. First thing you need to do is to
 
 Regarding SSL, there is an option to disregard SSL error messages (such as bad certificates). USE THIS AT YOUR OWN RISK - it may allow you to access a server that would return in error without it... but you cannot trust the response.
 
-```ruby 
+```ruby
   dangerous_client = Dhis2::Client.new(url: "https://play.dhis2.org/demo", user: "admin", password: "district", no_ssl_verification: true);
 ```
 
@@ -83,7 +83,7 @@ Following the DHIS2 API, all calls are paginated - you can access the page info
 
     org_units = Dhis2.client.organisation_units.list(filter: "level:eq:2", fields: %w(id level displayName parent))
     org_units.pager.page       # current page
-    org_units.pager.page_count # number of pages 
+    org_units.pager.page_count # number of pages
     org_units.pager.total      # number of records
 
 ### Retreive a single element
@@ -112,7 +112,7 @@ You can retreive data values this way:
     organisation_unit = Dhis2.client.organisation_units.find_by(name: "Baoma")
     period            = "201512"
     value_sets        = Dhis2.client.data_value_sets.list(
-      data_sets: [ds.id], 
+      data_sets: [ds.id],
       organisation_unit: organisation_unit.id, periods: [period]
     )
 
@@ -125,6 +125,8 @@ The API is currently limited to **read** actions on the following elements/class
 * `DataElement`
 * `DataSet`
 * `CategoryCombo`
+* `SystemInfos`
+* `Attribute`
 
 A very basic **write** use case exists for `DataElement` and `DataSet`:
 
@@ -144,6 +146,28 @@ DHIS2 API does not return the ids of the created elements, but you can retreive
     status = Dhis2.client.data_elements.create(elements)
     element = Dhis2.client.data_elements.find_by(name: "TesTesT2")
 
+## Update
+
+### Full update
+
+You can update a given item by retreiving it using it's id, making any modification on it then calling "update":
+
+    org_unit = Dhis2.client.organisation_units.find(id)
+    org_unit.short_name = "New Short Name"
+    org_unit.update
+
+This uses DHIS2 "full update" ('PUT') and not the "partial update" feature (see below), so it requires a fully formed object to work (get it either with `find` which takes all the fields or with the `fields: :all´ option).
+
+### Partial update
+
+You can update a single or more attributes via the "update_attributes" method:
+
+    org_unit         = Dhis2.client.organisation_units.list(fields: :all, filter: "name:eq:#{org_unit_name}").first
+    new_attributes   = { name: "New name" }
+    org_unit.update_attributes(new_attributes)
+
+Note that partial updates will no work with custom attributes at this time (while the full update will)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. Note that the tests are using the DHIS2 demo server, which is reset every day but can be updated by anyone - so if someone change the password of the default user, the tests are going to fail.

data/dhis2.gemspec

@@ -24,4 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "faker", "~> 1.6", ">= 1.6.3"
 end

data/lib/dhis2/api/attribute.rb

@@ -0,0 +1,6 @@
+module Dhis2
+  module Api
+    class Attribute < Base
+    end
+  end
+end

data/lib/dhis2/api/base.rb

@@ -79,6 +79,7 @@ module Dhis2
       end
 
       def initialize(client, raw_data)
+        raw_data["display_name"] ||= raw_data["name"]  # for backward compatbility with v2.19
         super(raw_data)
         self.client = client
       end
@@ -99,6 +100,10 @@ module Dhis2
       def ==(other)
         self.class == other.class && id == other.id
       end
+
+      def update
+        client.put("#{self.class.resource_name}/#{id}", self.to_h)
+      end
     end
   end
 end

data/lib/dhis2/api/data_element.rb

@@ -3,21 +3,21 @@ module Dhis2
     class DataElement < Base
       class << self
         def create(client, elements)
-          elements          = [elements].flatten
-          category_combo_id = client.category_combos.find_by(name: "default").id
+          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
+                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
-                category_combo:   { id: category_combo_id }
+                category_combo:       { id: category_combo.id, name: category_combo.name }
               }
             end
           }

data/lib/dhis2/api/data_element_group.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Dhis2
   module Api
     class DataElementGroup < Base
@@ -6,11 +7,19 @@ module Dhis2
           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)

data/lib/dhis2/api/data_set.rb

@@ -1,9 +1,13 @@
+# frozen_string_literal: true
 module Dhis2
   module Api
     class DataSet < Base
       class << self
         def create(client, sets)
-          sets     = [sets].flatten
+          sets = [sets].flatten
+
+          category_combo_id = client.category_combos.find_by(name: "default").id
+
           data_set = {
             data_sets: sets.map do |set|
               {
@@ -12,7 +16,8 @@ module Dhis2
                 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 } } : []
+                organisation_units: set[:organisation_unit_ids] ? set[:organisation_unit_ids].map { |id| { id: id } } : [],
+                category_combo:     { id: category_combo_id }
               }
             end
           }

data/lib/dhis2/api/data_value_set.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Dhis2
   module Api
     class DataValueSet < Base
@@ -10,28 +11,58 @@ module Dhis2
       class << self
         def create(client, tuples)
           body = { dataValues: tuples }
-          response = client.post(self.resource_name, body)
+          response = client.post(resource_name, body)
           Dhis2::Status.new(response)
         end
 
         def list(client, options)
-          data_set_ids         = options[:data_sets]
-          periods              = options[:periods]
+          new(client, client.get(build_list_url(client, options)))
+        end
 
-          organisation_unit_id = options[:organisation_unit]
-          children             = options[:children] || true
+        def build_list_url(_client, options)
+          params = [build_what_url(options),  build_when_url(options), build_where_url(options)].join("&")
+          resource_name + "?" + params
+        end
 
-          if organisation_unit_id.class == Array
-            ou_url = organisation_unit_id.map { |ou_id| "orgUnit=#{ou_id}" }.join("&") + "&children=#{children}"
+        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
-            ou_url = "orgUnit=#{organisation_unit_id}&children=#{children}"
+            data_element_groups = options[:data_element_groups]
+            data_sets_url = data_element_groups.map { |deg| "dataElementGroup=#{deg}" }.join("&") if data_element_groups
           end
+        end
 
-          data_sets_url = data_set_ids.map { |ds| "dataSet=#{ds}" }.join("&")
-          periods       = periods.map { |period| "period=#{period}" }.join("&")
+        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
 
-          params = [data_sets_url, periods, ou_url].join("&")
-          new(client, client.get(self.resource_name + "?" + params))
+        def build_where_url(options)
+          children  = options[:children] || true
+          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

data/lib/dhis2/api/organisation_unit.rb

@@ -41,6 +41,7 @@ module Dhis2
           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
           }

data/lib/dhis2/api/organisation_unit_group.rb

@@ -6,6 +6,25 @@ module Dhis2
           organisation_unit["id"]
         end
       end
+
+      class << self
+        def create(client, orgunit_groups)
+          orgunit_groups = [orgunit_groups].flatten
+          ou_groups = {
+            organisation_unit_groups: orgunit_groups.map do |orgunit_group|
+              mapped_orgunit_group = {
+                name:       orgunit_group[:name],
+                short_name: orgunit_group[:short_name],
+                code:       orgunit_group[:code] || orgunit_group[:short_name]
+              }
+              mapped_orgunit_group[:id] = orgunit_group[:id] if orgunit_group[:id]
+              mapped_orgunit_group
+            end
+          }
+          response = client.post("metadata", ou_groups)
+          Dhis2::Status.new(response)
+        end
+      end
     end
   end
 end

data/lib/dhis2/api/system_info.rb

@@ -0,0 +1,11 @@
+module Dhis2
+  module Api
+    class SystemInfo < Base
+      class << self
+        def get(client)
+          client.get("/system/info")
+        end
+      end
+    end
+  end
+end

data/lib/dhis2/pager.rb

@@ -1,10 +1,13 @@
-class Pager
-  attr_reader :page, :page_count, :total, :next_page
+# frozen_string_literal: true
+module Dhis2
+  class Pager
+    attr_reader :page, :page_count, :total, :next_page
 
-  def initialize(hash)
-    @page       = hash["page"]
-    @page_count = hash["page_count"]
-    @total      = hash["total"]
-    @next_page  = hash["next_page"]
+    def initialize(hash)
+      @page       = hash["page"]
+      @page_count = hash["page_count"]
+      @total      = hash["total"]
+      @next_page  = hash["next_page"]
+    end
   end
 end

data/lib/dhis2/version.rb

@@ -1,3 +1,3 @@
 module Dhis2
-  VERSION = "2.2.1"
+  VERSION = "2.3.1"
 end

data/lib/dhis2.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "rest-client"
 require "json"
 require "ostruct"
@@ -26,6 +27,8 @@ require_relative "dhis2/api/organisation_unit_level"
 require_relative "dhis2/api/indicator"
 require_relative "dhis2/api/analytic"
 require_relative "dhis2/api/organisation_unit_group"
+require_relative "dhis2/api/system_info"
+require_relative "dhis2/api/attribute"
 
 module Dhis2
   class << self
@@ -34,18 +37,16 @@ module Dhis2
         if config.user.nil? && config.password.nil?
           @client ||= Dhis2::Client.new(config.url)
         else
-          @client ||= Dhis2::Client.new({
-            url:      config.url,
-            user:     config.user,
-            password: config.password
-          })
+          @client ||= Dhis2::Client.new(url:      config.url,
+                                        user:     config.user,
+                                        password: config.password)
         end
       else
         @client
       end
     end
 
-    def configure(&block)
+    def configure
       yield config
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dhis2
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.1
 platform: ruby
 authors:
 - Martin Van Aken
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-07 00:00:00.000000000 Z
+date: 2017-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -66,6 +66,40 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.3
 description: Allows to retreive items from a DHIS2 server in a more "Ruby way".
 email:
 - mvanaken@bluesquare.org
@@ -86,6 +120,7 @@ files:
 - 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/data_element.rb
@@ -97,6 +132,7 @@ files:
 - lib/dhis2/api/organisation_unit.rb
 - lib/dhis2/api/organisation_unit_group.rb
 - lib/dhis2/api/organisation_unit_level.rb
+- lib/dhis2/api/system_info.rb
 - lib/dhis2/client.rb
 - lib/dhis2/collection_wrapper.rb
 - lib/dhis2/configuration.rb