eba 1.0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 71d4d45aff8d5cbe3dd24ff254ac58280b612663
+  data.tar.gz: bd5077be7f5154ec19e85ffc6664c24911636ac5
+SHA512:
+  metadata.gz: 738ce5f25715bfeb82839702b0e758cd7ff5a67a976c5cefba972c6c9cdc7899bea50e1ab29c695ff4e651b619e5630f5771cf79cc83791980b04d6d379762b8
+  data.tar.gz: 3a6204920a4d53b8b5f343b7f10f028b30e1bb903bf0d07367bd15acc98edeaa8944f4933755e57cc16c92244cba511a1b32478e9a51eb4d75f4708723532886

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

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

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 eba.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 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,41 @@
+# Eba
+
+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/eba`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eba'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install eba
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/eba. 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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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 "eba"
+
+# 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

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/eba.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eba/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "eba"
+  spec.version       = Eba::VERSION
+  spec.authors       = ["Rafael Campos Cruz"]
+  spec.email         = ["rcampos@tendencias.com.br"]
+
+  spec.summary       = %q{Class which serves as interface with Brazillian Central Bank databases through the Webservice SGS - Sistema Gerenciador de Séries Temporais - v2.1. eba stands for Easy BCB Access and is also an expression of joy in Brazillian Portuguese.}
+  spec.description   = %q{This class was developed in a partinership with Tendencias - Consultoria Econômica, a economical analysis company from Brazil. The intent is, given that you know one or more primary keys for series inside the BCB database, you can extract updates or the full historical data of said series.\nEba stands for Easy BCB Access and is also an expression of joy in Brazillian Portuguese.}
+  spec.homepage      = "https://github.com/rCamposCruz/eba"
+  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.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "nokogiri", "~> 1.6"
+  spec.add_development_dependency "savon", "~> 2.11"
+  spec.add_development_dependency "net", "~> 0.1"
+end

data/lib/eba/bcb.rb

@@ -0,0 +1,121 @@
+require "savon"
+require "net/https"
+require "nokogiri"
+require "date"
+require_relative "encoder"
+require_relative "data"
+
+class BCB < Encoder
+
+	################################################################################################
+	# 											       #
+	# You MUST supply a valid certificate in order for the connection to work!		       #
+	# The certificate you are looking for is located in this webpage:			       #
+	# 	http://www.bcb.gov.br/?CERTDIG							       #
+	#											       #
+	# It will the most recent one which looks something like:				       #
+	#	Cadeia de CAs de *.bcb.gov.br (yyyy)						       #
+	#											       #
+	# You then have to generate a public key from this crt file,				       #
+	# you can do so by following this StackOverflow post:					       #
+	#	http://stackoverflow.com/questions/5244129/use-rsa-private-key-to-generate-public-key  #
+	#											       #
+	# With all this done, you will be able to access freely this 				       #
+	# service, without much hassle.	Don't forget to upvote such an useful answer.                  #
+	#											       #
+	################################################################################################
+
+	def initialize(path_to_certificate)
+		@pub_key = path_to_certificate
+		connect_to_service()
+	end
+
+	def connect_to_service()
+		@service = Savon.client(wsdl: "https://www3.bcb.gov.br/sgspub/JSP/sgsgeral/FachadaWSSGS.wsdl", 
+					ssl_cert_file: @pub_key)
+	end
+
+	# List of all operations available for the webservice,
+	# useful for expanding the gem
+	def list_operations()
+		puts @service.operations
+	end
+
+	def get_last_value(series_code)
+		response = @service.call(:get_ultimo_valor_xml, message: {in0: "#{series_code}"})
+		xmlResult = Nokogiri::XML(response.to_hash[:get_ultimo_valor_xml_response][:get_ultimo_valor_xml_return], nil, 'UTF-8')
+
+		# As it's a brazillian database it's column identifications are in portuguese,
+		# the translation for the fields, in order, are:
+		# NOME = NAME
+		# PERIODICIDADE = PERIODICITY
+		# UNIDADE = UNIT
+		# DIA = DAY
+		# MES = MONTH
+		# ANO = YEAR
+		# VALOR = VALUE
+		return DataBCB.new(encode(xmlResult.search("NOME").text), 
+				   series_code, 
+				   encode(xmlResult.search("PERIODICIDADE").text), 
+				   encode(xmlResult.search("UNIDADE").text), 
+				   encode(xmlResult.search("DIA").text), 
+				   encode(xmlResult.search("MES").text), 
+				   encode(xmlResult.search("ANO").text), 
+				   encode(xmlResult.search("VALOR").text)) 
+	end
+
+	def get_all_data_for_array(array_of_codes)
+		results = {}
+		codes = Array.new()
+		data_collection = Array.new()
+
+		array_of_codes.each do |code|
+			codes << code.to_s
+
+			# Build the  message from the start of the historical series
+			message = { in0: {long: codes}, 
+				    in1: '01/02/2004', 
+				    in2: Time.now.strftime('%d/%m/%Y').to_s}
+			
+			# try and catch, as some series can be discontinued or a code may be broken
+			begin
+				# This request has a limit of series he can get at a time, thus
+				# it's way simpler to break a composite requests in various smaller
+				# requests. The DataBCB class serves as a way to organize such data
+				# and allow the developer to easily identify which series each data
+				# object pertains.
+				response = @service.call(:get_valores_series_xml, message: message)
+				results[code] = Nokogiri::XML(response.to_hash[:get_valores_series_xml_response] \
+										   [:get_valores_series_xml_return])
+			rescue	
+				puts "Failure trying to extract #{code}"
+			end
+
+			codes.clear	
+		end
+
+		results.each do |code, result|
+			# recover identifying data from the getLastValue method,
+			# as the get_valores_series_xml desn't have identifying data
+			# as series name, periodicity, etc. 
+			base_data = get_last_value(code)				
+	
+
+			# Encode enforces data data is being read as UTF-8, as 
+			# portuguese uses a huge ammount of special characters and
+			# accentuations.
+			result.css("ITEM").each do |item|
+				data_collection << DataBCB.new(encode(base_data.name), 
+				   		     	       code, 
+	 	  				   	       base_data.periodicity, 
+	   					   	       encode(base_data.unit), 
+					             	       "1", 
+					       		       item.css("DATA").text.split("/")[0], 
+					  	       	       item.css("DATA").text.split("/")[1], 
+				   		    	       item.css("VALOR").text)
+			end
+		end
+
+		return data_collection 
+	end
+end

data/lib/eba/data.rb

@@ -0,0 +1,89 @@
+# This class intends to organize the series data in a easy to use way,
+# making it easier to group lots of data in a coese way, without lost of
+# information.
+class DataBCB
+	@name = ""
+	@periodicity = 0
+	@unit = ""
+	@date = ""
+	@value = 0.0	
+	@pk = 0
+
+	# Initialization is expected to express the state of a single row of 
+	# data inside the BCB's Database.
+	def initialize(series_name, series_code, series_periodicity, series_unit, 
+		       series_day, series_month, series_year, series_value)
+
+		@name = series_name
+		@pk = series_code
+		@periodicity = series_periodicity
+		@unit = series_unit
+		@date = standardizes_date(series_day, series_month, series_year)
+
+		# Removes the . which separate every three numbers.
+		# This might be supperfluous, haven't tested it though.
+		@value = series_value.tr(".", "").to_f
+	end	
+	
+	# Return an "identification key" with data which should 
+	# be unique to a series (grouped).
+	def key()
+		return @name + @periodicity.to_s + @unity
+	end
+	
+	# Note that there are no set methods in this class,
+	# I built it in such a way that you are only intended
+	# to access data in the rawest form as possible as it comes
+	# from the BCB Webservice.
+	def pk
+		return @pk
+	end
+
+	def name
+		return @name
+	end
+
+	def periodicity
+		return @periodicity
+	end
+
+	def unit
+		return @unit
+	end
+
+	def date
+		return @date
+	end
+
+	def value
+		return @value
+	end
+
+	# The Webservice will always supply the date in three separate fields,
+	# this methods aim to convert it to a standard dd.mm.YYYY string.
+	def standardizes_date(day, month, year)
+		return "#{standardizes_number(day.to_i)}.#{standardizes_number(month.to_i)}.#{year}"
+	end
+
+	# As we are building a dd.mm.yyyy string, we want to 
+	# standardize the size of the fields.
+	def standardizes_number(number)
+		if (number < 10)
+			return "0#{number}"
+		else
+			return "#{number}"
+		end
+	end
+	
+	def print()
+		return "Name: #{@name}\nBCB Code: #{@pk}\nPeriodicity: #{@periodicity}\nUnit: #{@unit}\nDate: #{@date}   Value: #{@value}\n"
+	end
+
+	# Simple comparission between two DataBCB objects.
+	def compare_to(data_bcb)
+		return (@name == data_bcb.name and @pk == data_bcb.pk \
+		    and @periodicity == data_bcb.periodicity \
+		    and @unit == data_bcb.unit and @date == data_bcb.date \
+		    and @value = data_bcb.value)
+	end
+end

data/lib/eba/encoder.rb

@@ -0,0 +1,6 @@
+# This enforces that a string is encoded in UTF-8
+class Encoder
+	def encode(string)
+		return string.encode("utf-8")
+	end
+end

data/lib/eba/version.rb

@@ -0,0 +1,17 @@
+module Eba
+  # For documentation purposes:
+  # VERSION = mm.dd.ff.hh
+  # mm - commits on master
+  # dd - commits on development
+  # ff - commits on feature
+  # hh - commits on hotfix
+
+  VERSION = "1.0.0.1"
+
+  #Version 1.0.0.1
+  #
+  # Updater gemspec.
+  # Added classes Encoder and DataBCB for user.
+
+
+end

data/lib/eba.rb

@@ -0,0 +1,8 @@
+require "eba/version"
+require "eba/bcb"
+require "eba/data"
+require "eba/encoder"
+
+module Eba
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: eba
+version: !ruby/object:Gem::Version
+  version: 1.0.0.1
+platform: ruby
+authors:
+- Rafael Campos Cruz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: net
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: This class was developed in a partinership with Tendencias - Consultoria
+  Econômica, a economical analysis company from Brazil. The intent is, given that
+  you know one or more primary keys for series inside the BCB database, you can extract
+  updates or the full historical data of said series.\nEba stands for Easy BCB Access
+  and is also an expression of joy in Brazillian Portuguese.
+email:
+- rcampos@tendencias.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- eba.gemspec
+- lib/eba.rb
+- lib/eba/bcb.rb
+- lib/eba/data.rb
+- lib/eba/encoder.rb
+- lib/eba/version.rb
+homepage: https://github.com/rCamposCruz/eba
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Class which serves as interface with Brazillian Central Bank databases through
+  the Webservice SGS - Sistema Gerenciador de Séries Temporais - v2.1. eba stands
+  for Easy BCB Access and is also an expression of joy in Brazillian Portuguese.
+test_files: []