Module: Dhis2

Defined in:: lib/dhis2.rb,
lib/dhis2/case.rb,
lib/dhis2/error.rb,
lib/dhis2/pager.rb,
lib/dhis2/client.rb,
lib/dhis2/classes.rb,
lib/dhis2/version.rb,
lib/dhis2/api/base.rb,
lib/dhis2/api/findable.rb,
lib/dhis2/api/listable.rb,
lib/dhis2/api/constants.rb,
lib/dhis2/api/creatable.rb,
lib/dhis2/api/deletable.rb,
lib/dhis2/api/updatable.rb,
lib/dhis2/configuration.rb,
lib/dhis2/paginated_array.rb,
lib/dhis2/api/shared/event.rb,
lib/dhis2/api/bulk_creatable.rb,
lib/dhis2/api/import_summary.rb,
lib/dhis2/collection_wrapper.rb,
lib/dhis2/api/shared/analytic.rb,
lib/dhis2/api/shared/category.rb,
lib/dhis2/api/shared/data_set.rb,
lib/dhis2/api/version224/user.rb,
lib/dhis2/api/version225/user.rb,
lib/dhis2/api/version226/user.rb,
lib/dhis2/api/version227/user.rb,
lib/dhis2/api/version228/user.rb,
lib/dhis2/api/shared/constants.rb,
lib/dhis2/api/version224/event.rb,
lib/dhis2/api/version225/event.rb,
lib/dhis2/api/version226/event.rb,
lib/dhis2/api/version227/event.rb,
lib/dhis2/api/version228/event.rb,
lib/dhis2/api/shared/data_value.rb,
lib/dhis2/api/version224/report.rb,
lib/dhis2/api/version225/report.rb,
lib/dhis2/api/version226/report.rb,
lib/dhis2/api/version227/report.rb,
lib/dhis2/api/version228/report.rb,
lib/dhis2/api/shared/system_info.rb,
lib/dhis2/api/version224/program.rb,
lib/dhis2/api/version225/program.rb,
lib/dhis2/api/version226/program.rb,
lib/dhis2/api/version227/program.rb,
lib/dhis2/api/version228/program.rb,
lib/dhis2/api/version224/analytic.rb,
lib/dhis2/api/version224/category.rb,
lib/dhis2/api/version224/data_set.rb,
lib/dhis2/api/version225/analytic.rb,
lib/dhis2/api/version225/category.rb,
lib/dhis2/api/version225/data_set.rb,
lib/dhis2/api/version226/analytic.rb,
lib/dhis2/api/version226/category.rb,
lib/dhis2/api/version226/data_set.rb,
lib/dhis2/api/version227/analytic.rb,
lib/dhis2/api/version227/category.rb,
lib/dhis2/api/version227/data_set.rb,
lib/dhis2/api/version228/analytic.rb,
lib/dhis2/api/version228/category.rb,
lib/dhis2/api/version228/data_set.rb,
lib/dhis2/api/shared/report_tables.rb,
lib/dhis2/api/version224/attribute.rb,
lib/dhis2/api/version224/constants.rb,
lib/dhis2/api/version224/indicator.rb,
lib/dhis2/api/version225/attribute.rb,
lib/dhis2/api/version225/constants.rb,
lib/dhis2/api/version225/indicator.rb,
lib/dhis2/api/version226/attribute.rb,
lib/dhis2/api/version226/constants.rb,
lib/dhis2/api/version226/indicator.rb,
lib/dhis2/api/version227/attribute.rb,
lib/dhis2/api/version227/constants.rb,
lib/dhis2/api/version227/indicator.rb,
lib/dhis2/api/version228/attribute.rb,
lib/dhis2/api/version228/constants.rb,
lib/dhis2/api/version228/indicator.rb,
lib/dhis2/api/event_creation_status.rb,
lib/dhis2/api/shared/category_combo.rb,
lib/dhis2/api/shared/data_value_set.rb,
lib/dhis2/api/shared/resource_table.rb,
lib/dhis2/api/shared/save_validator.rb,
lib/dhis2/api/version224/data_value.rb,
lib/dhis2/api/version225/data_value.rb,
lib/dhis2/api/version226/data_value.rb,
lib/dhis2/api/version226/legend_set.rb,
lib/dhis2/api/version227/data_value.rb,
lib/dhis2/api/version227/legend_set.rb,
lib/dhis2/api/version228/data_value.rb,
lib/dhis2/api/version228/legend_set.rb,
lib/dhis2/api/shared/category_option.rb,
lib/dhis2/api/version224/system_info.rb,
lib/dhis2/api/version225/system_info.rb,
lib/dhis2/api/version226/system_info.rb,
lib/dhis2/api/version227/system_info.rb,
lib/dhis2/api/version228/system_info.rb,
lib/dhis2/api/version224/data_element.rb,
lib/dhis2/api/version224/report_table.rb,
lib/dhis2/api/version225/data_element.rb,
lib/dhis2/api/version225/report_table.rb,
lib/dhis2/api/version226/data_element.rb,
lib/dhis2/api/version226/report_table.rb,
lib/dhis2/api/version227/data_element.rb,
lib/dhis2/api/version227/report_table.rb,
lib/dhis2/api/version228/data_element.rb,
lib/dhis2/api/version228/report_table.rb,
lib/dhis2/api/shared/organisation_unit.rb,
lib/dhis2/api/shared/data_element_group.rb,
lib/dhis2/api/version224/category_combo.rb,
lib/dhis2/api/version224/data_value_set.rb,
lib/dhis2/api/version224/indicator_type.rb,
lib/dhis2/api/version224/resource_table.rb,
lib/dhis2/api/version224/save_validator.rb,
lib/dhis2/api/version225/category_combo.rb,
lib/dhis2/api/version225/data_value_set.rb,
lib/dhis2/api/version225/indicator_type.rb,
lib/dhis2/api/version225/resource_table.rb,
lib/dhis2/api/version226/category_combo.rb,
lib/dhis2/api/version226/data_value_set.rb,
lib/dhis2/api/version226/indicator_type.rb,
lib/dhis2/api/version226/resource_table.rb,
lib/dhis2/api/version227/category_combo.rb,
lib/dhis2/api/version227/data_value_set.rb,
lib/dhis2/api/version227/indicator_type.rb,
lib/dhis2/api/version227/resource_table.rb,
lib/dhis2/api/version228/category_combo.rb,
lib/dhis2/api/version228/data_value_set.rb,
lib/dhis2/api/version228/indicator_type.rb,
lib/dhis2/api/version228/resource_table.rb,
lib/dhis2/api/query_parameters_formatter.rb,
lib/dhis2/api/version224/category_option.rb,
lib/dhis2/api/version224/indicator_group.rb,
lib/dhis2/api/version225/category_option.rb,
lib/dhis2/api/version225/indicator_group.rb,
lib/dhis2/api/version226/category_option.rb,
lib/dhis2/api/version226/indicator_group.rb,
lib/dhis2/api/version227/category_option.rb,
lib/dhis2/api/version227/indicator_group.rb,
lib/dhis2/api/version228/category_option.rb,
lib/dhis2/api/version228/indicator_group.rb,
lib/dhis2/api/shared/category_option_combo.rb,
lib/dhis2/api/version224/organisation_unit.rb,
lib/dhis2/api/version225/organisation_unit.rb,
lib/dhis2/api/version226/organisation_unit.rb,
lib/dhis2/api/version227/organisation_unit.rb,
lib/dhis2/api/version228/organisation_unit.rb,
lib/dhis2/api/version224/data_element_group.rb,
lib/dhis2/api/version225/data_element_group.rb,
lib/dhis2/api/version226/data_element_group.rb,
lib/dhis2/api/version227/data_element_group.rb,
lib/dhis2/api/version228/data_element_group.rb,
lib/dhis2/api/shared/organisation_unit_group.rb,
lib/dhis2/api/version224/category_option_combo.rb,
lib/dhis2/api/version225/category_option_combo.rb,
lib/dhis2/api/version226/category_option_combo.rb,
lib/dhis2/api/version227/category_option_combo.rb,
lib/dhis2/api/version228/category_option_combo.rb,
lib/dhis2/api/version224/organisation_unit_group.rb,
lib/dhis2/api/version224/organisation_unit_level.rb,
lib/dhis2/api/version225/organisation_unit_group.rb,
lib/dhis2/api/version225/organisation_unit_level.rb,
lib/dhis2/api/version226/organisation_unit_group.rb,
lib/dhis2/api/version226/organisation_unit_level.rb,
lib/dhis2/api/version227/organisation_unit_group.rb,
lib/dhis2/api/version227/organisation_unit_level.rb,
lib/dhis2/api/version228/organisation_unit_group.rb,
lib/dhis2/api/version228/organisation_unit_level.rb,
lib/dhis2/api/version224/organisation_unit_group_set.rb,
lib/dhis2/api/version225/organisation_unit_group_set.rb,
lib/dhis2/api/version226/organisation_unit_group_set.rb,
lib/dhis2/api/version227/organisation_unit_group_set.rb,
lib/dhis2/api/version228/organisation_unit_group_set.rb

Defined Under Namespace

Modules: Api, Case Classes: Analytic, Attribute, BulkCreationError, CaseError, Category, CategoryCombo, CategoryOption, CategoryOptionCombo, Client, CollectionWrapper, Configuration, CreationError, DataElement, DataElementAdditionError, DataElementGroup, DataSet, DataValueSet, Error, Event, Indicator, IndicatorGroup, IndicatorType, InvalidMethodError, InvalidRequestError, InvalidVersionError, LegendSet, OrganisationUnit, OrganisationUnitGroup, OrganisationUnitGroupSet, OrganisationUnitLevel, Pager, PaginatedArray, PrimaryKeyMissingError, Program, QueryParametersFormatter, Report, ReportTable, RequestError, ResourceTable, SystemInfo, UpdateError, User, Versioned

Constant Summary collapse

VERSION =

"3.0.7"

Class Method Summary collapse

.client ⇒ Object
.config ⇒ Object
.configure {|config| ... } ⇒ Object
.get_version(params) ⇒ Object

params: { user: , password:, url: }.
.play(debug = false, version: "2.28") ⇒ Object

Class Method Details

.client ⇒ `Object`



63
64
65

# File 'lib/dhis2.rb', line 63

def client
  @client ||= Dhis2::Client.new(config.client_params)
end

.config ⇒ `Object`



71
72
73

# File 'lib/dhis2.rb', line 71

def config
  @configuration ||= Dhis2::Configuration.new
end

.configure {|config| ... } ⇒ `Object`

Yields:

(config)



67
68
69

# File 'lib/dhis2.rb', line 67

def configure
  yield config
end

.get_version(params) ⇒ `Object`

params: { user: , password:, url: }

# File 'lib/dhis2.rb', line 76

def get_version(params)
  check_config = Dhis2::Configuration.new.tap do |conf|
    conf.url      = params.fetch(:url)
    conf.password = params.fetch(:password)
    conf.user     = params.fetch(:user)
  end
  response = RestClient.get(
    Dhis2::Client.uri(check_config.client_params[:url], "/system/info")
  )
  JSON.parse(response.body)["version"]
end

.play(debug = false, version: "2.28") ⇒ `Object`



59
60
61

# File 'lib/dhis2.rb', line 59

def play(debug = false, version:  "2.28")
  Dhis2::Client.new(config.play_params(debug, version))
end

Module: Dhis2

Defined Under Namespace

Constant Summary collapse

Class Method Summary collapse

Class Method Details

.client ⇒ Object

.config ⇒ Object

.configure {|config| ... } ⇒ Object

.get_version(params) ⇒ Object

.play(debug = false, version: "2.28") ⇒ Object

.client ⇒ `Object`

.config ⇒ `Object`

.configure {|config| ... } ⇒ `Object`

.get_version(params) ⇒ `Object`

.play(debug = false, version: "2.28") ⇒ `Object`