transparencia_alagoas 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 160e1f34b23f4ba27d13b7478269ad428af042bc
-  data.tar.gz: ce40bb4387130de3817fce8cd709e0ee60ee8c57
+  metadata.gz: e88f96bab7c985930b85972a8f7ce0738f74285e
+  data.tar.gz: 8865c55d27000977f0cc07161e7205af22b34375
 SHA512:
-  metadata.gz: c695aa2414cfb41783288108986bbc82510d22d1abf8cd29dfec66f72c6d52762ca26e7e29d072915e8ceb18596eb2f41df4d2135dc4d2b8290088c45fae2b3b
-  data.tar.gz: a979fef767adaaf94bdcc0b801b84dad71225d737bf0cd0ed7622302e013bae02b310732354667059d25766a965f110a6f48f4971b894ba4691a20d4223753df
+  metadata.gz: 0b132428c115ff9b28af4a7a8f5bce0741740a64ff517f334e0a96334ee9ef9ee34aab6e1cfc72c87aff756c24a845c3d4ce761f902f3d85d1010562e1f72481
+  data.tar.gz: cc568697f9f317822db467c8c51268acc89b6053b9340c1807df637d6f64820143a27acc75e913c8e58749eb312d2903844ed7670f4c94fc29bdcce1cdf95e7b

data/README.md

@@ -1,8 +1,6 @@
 # TransparenciaAlagoas
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/transparencia_alagoas`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem aims to facilitating access to the "Portal da Transparência (http://transparencia.al.gov.br)" of the state of Alagoas. It abstracts the access to this portal data that is provided through a REST API.
 
 ## Installation
 
@@ -22,7 +20,164 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+This Gem are not covering the whole API yet. For while we provide the resources of servants, biddings and patrimony. There a class responsible for each one of this resources.
+
+Take a look at some examples:
+
+```ruby
+# encoding: utf-8
+
+require 'transparencia_alagoas'
+
+# Get active servant that received some money on month 8 of year 2016
+# If month and/or year are not provided we'll use the current month and/or year
+active_servants = TransparenciaAlagoas::Servant.active_servants(month:8, year:2016)
+puts active_servants
+```
+
+We can pass any of the options available in the REST API, for example:
+
+```ruby
+# encoding: utf-8
+
+require 'transparencia_alagoas'
+
+# We can get a list of materials from state patrimony filtered by material name
+materials = TransparenciaAlagoas::Patrimony.material_detail(ug_code: 250505, material: "WINDOWS 7 OEM STARTER 32 B MICROSOFT")
+puts materials
+```
+
+Is also possible to access data from Biddings:
+
+```ruby
+# encoding: utf-8
+
+require 'transparencia_alagoas'
+
+biddings = TransparenciaAlagoas::Bidding.get(qty:10, offset:10, options: {"start_date": "2016-11-01", :orgao_licitante => "ITEC"})
+puts biddings
+```
+
+To have more details about Portal da Transparência API please take a look on this [documentation](http://transparencia.al.gov.br/portal/api).
+
+## Classes and Methods Available
+
+### Class Bidding
+
+#### Method: get(qty: 10, offset: 0, options: {})
+
+*Available Options:*
+
+PARAM | TYPE | DESCRIPTION
+------|------|-------------
+data_realizacao_dti_ | Date | Seta a data inicial que será realizada a consulta. (dd/mm/yyyy)
+data_realizacao_dtf_ | Date | Seta a data final que será realizada a consulta. (dd/mm/yyyy)
+modalidade | text | Filtra pela modalidade entre os retornados na consulta.
+orgao_licitante | text | Filtra pelo órgão licitante entre os retornados na consulta.
+status (situação) | text | Filtra pela situação entre os retornados na consulta. Valores: Aberta / Encerrada
+sort | text | Define o campo o qual será ordenada a consulta.
+order | text | Define a ordem que será ordenada a consulta. Valores: asc / desc
+
+### Class Patrimony
+
+#### Method: property_list(qty: 10, offset: 0, options: {})
+
+*Available Options*
+
+PARAM | TYPE | DESCRIPTION
+------|------|-------------
+municipio | text | Filtra pelo nome do município entre os retornados na consulta.
+denominacao | text | Filtra pelo nome do imóvel (ao que é atribuído) entre os retornados na consulta.
+situacao_ocupacao | text | Filtra pela situação do imóvel entre os retornados na consulta.
+sort | text | Define o campo o qual será ordenada a consulta.
+order | text | Define a ordem que será ordenada a consulta. Valores: asc / desc
+
+#### Method: ug_list(qty: 10, offset: 0, options: {})
+
+*Available Options*
+
+PARAM | TYPE | DESCRIPTION
+------|------|-------------
+descricao_ug | text | Filtra pelo nome da unidade gestora entre os retornados na consulta.
+sort | text | Define o campo o qual será ordenada a consulta.
+order | text | Define a ordem que será ordenada a consulta. Valores: asc / desc
+
+#### Method: materials_list(qty: 10, offset: 0, ug_code: nil, options: {})
+
+*Available Options*
+
+PARAM | TYPE | DESCRIPTION
+------|------|-------------
+codigo_ug | integer | Define por qual unidade gestora será filtrada a consulta de materiais.
+descricao_conta | text | Filtra pelo subelemento entre os retornados na consulta.
+material | text | Filtra pelo nome do material entre os retornados na consulta.
+sort | text | Define o campo o qual será ordenada a consulta.
+order | text | Define a ordem que será ordenada a consulta. Valores: asc / desc
+
+#### Method: material_detail(qty: 10, offset: 0, ug_code: nil, material: nil, options: {})
+
+*Available Options*
+
+PARAM | TYPE | DESCRIPTION
+------|------|-------------
+codigo_ug | integer | Define por qual unidade gestora será filtrada a consulta de materiais.
+material | text | Define qual material será detalhado. (nome do material)
+patrimonio | text | Filtra pelo número do patrimônio entre os retornados na consulta.
+codigo_antigo | text | Filtra pelo código antigo entre os retornados na consulta.
+sort | text | Define o campo o qual será ordenada a consulta.
+order | text | Define a ordem que será ordenada a consulta. Valores: asc / desc
+
+
+### Class Servant
+
+#### Method: active_servants(qty: 10, offset: 0, month: nil, year: nil, options: {})
+
+*Available Options*
+
+PARAM | TYPE | DESCRIPTION
+------|------|-------------
+month | integer | Seta o mês que será realizado a consulta. (mm)
+year | integer | Seta o ano que será realizado a consulta. (aaaa)
+nome | text | Filtra pelo nome do servidor entre os retornados na consulta.
+codigo_orgao | integer | Filtra pelo código do órgão entre os retornados na consulta.
+sort | text | Define o campo o qual será ordenada a consulta.
+order | text | Define a ordem que será ordenada a consulta. Valores: asc / desc
+
+#### Method: detail_active_servant(qty: 10, offset: 0, servant_id: nil, options: {})
+
+*Available Options*
+
+PARAM | TYPE | DESCRIPTION
+------|------|-------------
+servant_id | integer | Decide por qual servidor será detalhada a consulta.
+ano | integer | Filtra pelo ano entre os retornados na consulta.
+sort | text | Define o campo o qual será ordenada a consulta.
+order | text | Define a ordem que será ordenada a consulta. Valores: asc / desc
+
+
+#### Method: inactive_servants(qty: 10, offset: 0, month: nil, year: nil, options: {})
+
+*Available Options*
+
+PARAM | TYPE | DESCRIPTION
+------|------|-------------
+month | integer | Seta o mês que será realizado a consulta. (mm)
+year | integer | Seta o ano que será realizado a consulta. (aaaa)
+nome | text | Filtra pelo nome do servidor entre os retornados na consulta.
+vinculo | integer | Filtra pelo vínculo entre os retornados na consulta. (Valores: Aposentado / Pensionista)
+sort | text | Define o campo o qual será ordenada a consulta.
+order | text | Define a ordem que será ordenada a consulta. (Valores: asc / desc)
+
+#### Method: detail_inactive_servant(qty: 10, offset: 0, servant_id: nil, options: {})
+
+*Available Options*
+
+PARAM | TYPE | DESCRIPTION
+------|------|-------------
+servant_id | integer | Define por qual servidor inativo será filtrada a consulta.
+ano | integer | Filtra pelo ano entre os retornados na consulta.
+sort | text | Define o campo o qual será ordenada a consulta.
+order | text | Define a ordem que será ordenada a consulta. (Valores: asc / desc)
 
 ## Development
 
@@ -32,5 +187,5 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/transparencia_alagoas. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/nandooliveira/transparencia_alagoas. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 

data/lib/transparencia_alagoas/version.rb

@@ -1,3 +1,3 @@
 module TransparenciaAlagoas
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: transparencia_alagoas
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Fernando Oliveira