eia 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed927fcb4b162ddc30273c63406d12164aeaa70e
+  data.tar.gz: 5282fbdedfb933c36dbd9cca95a2ca8aecf3ba6b
+SHA512:
+  metadata.gz: 006b197bce6cebb3e49a03055fa5849b436a530308efd4cfc2b16b0ac17c905b2542f86216e62d3e523ff3e20eb9469dd7d30ce4d51187adc6b3cd91da81e7b8
+  data.tar.gz: 5a65e19e64c8fd35ba9d99b1111cf220fc449a4e8b2a280e810e4a25153bec031a6c5aad4dacfd0dfe93e53f22a45ffc1a3dd50e290ba6c4714ef48a413bd0b9

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.14.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at rcampos@tendencias.com.br. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in eia.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 rCamposCruz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 rCamposCruz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1 @@
+# eia

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "eia"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/eia.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eia/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "eia"
+  spec.version       = Eia::VERSION
+  spec.authors       = ["rCamposCruz"]
+  spec.email         = ["rcampos@tendencias.com.br"]
+
+  spec.summary       = %q{A gem tham aims to facilitate interactions with Brazil's IBGE WebService.}
+  spec.description   = %q{This gem is supposed to supply a simple and intuitive interface between IBGE's SIDRA API, standardizing the output objects as a standard class. Also makes seamlessly to interact with the API, transforming the inputs for the webservice in intuitive function entries. Eia stands for Easy IBGE Acess and was developed in a partnership with Tendencias - Consultoria Econômica.}
+  spec.homepage      = "https://github.com/rCamposCruz/eia"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "net", "~> 0.3"
+  spec.add_development_dependency "json", "~> 2.0"
+end

data/lib/eia.rb

@@ -0,0 +1,6 @@
+require "eia/version"
+require "eia/ibge"
+
+module Eia
+  # Your code goes here...
+end

data/lib/eia/data.rb

@@ -0,0 +1,83 @@
+class DataIBGE
+	def initialize(date, variable, location, product, unit, value, periodicity)
+		@date = standardize_date(date, periodicity)
+		@variable = variable
+		@location = location
+		@product = product
+		@unit = unit
+		@value = value
+
+		#The standard is:
+		# 5 : "Trimestral Móvel"
+		# 6 : "Ano"
+		@periodicity = periodicity 
+	end
+
+	def standardize_date(date, periodicity)
+		#date is a four digit number
+		if periodicity == 6 then
+			return "01/01/#{date}"
+		elsif periodicity == 5 then
+			y = date[0..3]
+			m = date[4..5]
+
+			return "01/#{m}/#{y}"
+		else
+			puts "\nError parsing date for DataIBGE. Attempted to parse #{date}.\n"
+			return "ERROR"
+		end
+	end
+
+	def date
+		return @date
+	end
+
+	def variable
+		return @variable
+	end
+
+	def location
+		return @location
+	end
+	
+	def product
+		return @product
+	end
+
+	def unit
+		return @unit
+	end
+	
+	def value
+		return @value.to_f
+	end
+
+	def is_valid?
+		if @date == '' or @date == "ERROR" or @date == nil then
+			puts "Date found is invalid. Value is '#{@date}'."
+			return false
+		end
+		
+		if @variable == '' or @variable == nil then
+			puts "Variable found is invalid. Value is '#{@variable}'."
+			return false
+		end
+	
+		if @location == '' or @location == nil then
+			puts "Location found is invalid. Value is '#{@location}'."
+			return false
+		end
+
+		if @unit == '' or @unit == nil then
+			puts "Unit found is invalid. Value is '#{@unit}'."
+			return false
+		end
+
+		if @value == '' or @value == nil then
+			puts "Value found is invalid. Value is '#{@value}'."
+			return false
+		end
+
+		return true 
+	end
+end

data/lib/eia/ibge.rb

@@ -0,0 +1,123 @@
+require 'net/http'
+require 'json'
+require_relative 'data'
+
+class IBGE
+	def initialize()
+			@webservice_url = 'http://api.sidra.ibge.gov.br' 
+	end
+
+	def connected?()
+	  response = Net::HTTP.get(URI(@webservice_url + '/values/t/1612/n1/1'))
+
+	  if response.to_s == '' then
+	    return false
+	  else
+	    return true
+	  end
+	end
+
+	# What is expected:
+	# code : a single primary key which corresponds to category of series in IBGE's system;
+	# period : a string with any acceptable set of parameters
+	# variables : a list of acceptable variables the the series
+	# territorial_leve : a string in the form n_lvl+0|territories_0;n_lvl_1|territories_1;...
+  #										 where n_lvl_k is a number from 1 to 6 and territories_i is a valid
+	#										 string form specifying terriories
+	# classification : a string in the form c_lvl_k | list_of_products
+	def get_series(code, period, variables, territorial_level, classification)
+		url = @webservice_url + "/values"
+
+		if code != '' and code != nil then
+			url += "/t/#{code}"
+		end
+
+		if period != '' and period != nil then
+			url += "/p/#{period}"
+		else
+			url += "/p/all"
+		end
+
+		if variables != '' and variables != nil then
+			url += "/v/#{variables}"
+		else
+			url += "/v/all"
+		end
+
+		if territorial_level != '' and territorial_level != nil then
+			territorial_level.split(';').each do |word|
+				ws = word.split('|')
+				url += "/n#{ws[0]}/#{ws[1]}"	
+			end
+		else
+			url += "/n1/all"
+		end
+		
+		if classification != '' and classification != nil then
+			ws = classification.split('|')
+			url += "/c#{ws[0]}/#{ws[1]}"
+		end
+	
+		return consume_json(Net::HTTP.get(URI(url)))
+	end
+
+	def consume_json(json_string)
+		begin
+			output = JSON.parse(json_string)
+			heading = output.delete_at(0)
+			identifier = heading["D1C"]
+
+			if identifier.include? "Trimestre Móvel" then
+				periodicity = 5
+			elsif identifier.include? "Ano" then
+				periodicity = 6
+			else
+				puts "Error! Unexpected case! Found is: #{identifier}. Report to the dev team."
+				return Array.new
+			end
+
+			data_array = Array.new
+
+			output.each do |hash|
+				data = nil
+				date = nil
+				variable = nil
+				product = nil
+				location = nil
+				unit = nil
+				val = nil
+
+				hash.each do |key, value|
+					case key
+						when "D1N" #date
+							date = value
+						when "D2N" #variable
+							variable = value
+						when "D3N" #location
+							location = value
+						when "D4N" #product
+							product = value
+						when "MN" #unit
+							unit = value
+						when "V" #value
+							val = value.to_f
+						else
+							#This information is discarded
+					end
+				end
+
+				data_array << DataIBGE.new(date, variable, location, product, unit, val, periodicity)
+			end	
+			
+			return data_array	
+	
+		rescue Exception => e
+			if e.to_s.include? "incompatível com a tabela" then
+				return Array.new
+			else
+				puts "Error parsing the JSON response: #{e}"
+				return nil
+			end
+		end
+	end
+end

data/lib/eia/version.rb

@@ -0,0 +1,25 @@
+module Eia
+  VERSION = "1.0.0"
+
+#Standard for version: xx.yy.zz
+# xx - release
+# yy - feature
+# zz - hotfix
+
+# Version 0.1.1
+# Fixes gemspec refference to net.
+# Adds refference to ibge.rb in lib/eba.rb
+# Fixes implementation of get in test_connection
+
+# Version 0.2.1
+# Adds rspec test for connection with the webservice
+
+# Version 0.3.1
+# Adds data standardization
+
+# Version 1.0.0
+# First release.
+# Fully supports most data points from IBGE.
+# Tests cover all features.
+# Appropriate error treatment.
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: eia
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- rCamposCruz
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2017-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  name: bundler
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  name: rspec
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  name: net
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  name: json
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: This gem is supposed to supply a simple and intuitive interface between IBGE's SIDRA API, standardizing the output objects as a standard class. Also makes seamlessly to interact with the API, transforming the inputs for the webservice in intuitive function entries. Eia stands for Easy IBGE Acess and was developed in a partnership with Tendencias - Consultoria Econômica.
+email:
+- rcampos@tendencias.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- eia.gemspec
+- lib/eia.rb
+- lib/eia/data.rb
+- lib/eia/ibge.rb
+- lib/eia/version.rb
+homepage: https://github.com/rCamposCruz/eia
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.6.8
+signing_key:
+specification_version: 4
+summary: A gem tham aims to facilitate interactions with Brazil's IBGE WebService.
+test_files: []