banco_central 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5a36e500aeff4984b6185cecd696a15f8e9e69a2
+  data.tar.gz: e270fb5b16fdc440b703ff937f22a9eeee160242
+SHA512:
+  metadata.gz: 3fedc03f32483bcc6b1cc7e3a6f6da7d479e52f746f85ce79e52f6554b6692de2ee390bce218f6536323ff1abb411b6b4028a4167dbcbfe0cde32c873b303d24
+  data.tar.gz: 1b5df7a09c2aca72b224a97412267bed3a87b0d7d5b7417ef9e10f321e6429337e38848a0af900e8cd8acbb429dbbb4deb9abe44e38e1ae331d50ebbe937e425

data/.gitignore

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at hgtesta@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Henrique G. Testa
+
+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,96 @@
+# BancoCentral
+
+A handy Ruby library to consume Central Bank of Brazil (Banco Central do Brasil) WebService. The WebService provided by the BC has lots of updated economic indicators, but it fails short in documentation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'banco_central'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install banco_central
+
+## Usage
+
+### last
+
+Get the last value of the an indicator, and also the name, unit, date and periodicity. This method calls `GetUltimoValorXml` method from the WebService.
+
+```ruby
+BancoCentral.last(:dolar)
+# => {:id=>1, :name=>"Taxa de câmbio - Livre - Dólar americano (venda) - diário", :unit=>"u.m.c./US$", :date=>2016-10-18 00:00:00 -0200, :value=>3.1874, :periodicity=>:daily}
+```
+
+Note that `:dolar` is a convenient label that is translated to a number before the WebService call. There are thousands of indicators, some deprecated, but just a few dozen labels. The code below is the equivalent of the above one.
+
+```ruby
+BancoCentral.last(1)
+```
+
+Check `BancoCentral::Labels` for a list of available labels, or take a look at the config/labels.yml file.
+
+### find
+
+Get the indicator's value for a specific date. It calls `GetValor` method from the WebService and returns only a float number.
+
+```ruby
+BancoCentral.find(:ipca, "1/1/2010")
+# => 0.75
+```
+
+### all
+
+Get all the values of the indicator. This method calls `GetValoresSeriesXMLResponse` method from the WebService.
+
+```ruby
+BancoCentral.all(:ipca)
+# => {"1/1980"=>"6.62", "2/1980"=>"4.62", "3/1980"=>"6.04", ...
+```
+
+You can also specify an initial or final date:
+
+```ruby
+BancoCentral.all(:ipca, start: "1/1/2010")
+BancoCentral.all(:ipca, finish: "1/5/2015")
+BancoCentral.all(:ipca, start: "1/1/2013", finish: "1/12/2013")
+```
+
+It is also possible to ask for multiple indicators in the same request. In that case, the result hash will contain a hash for each indicator.
+```ruby
+BancoCentral.all([:importacoes, :exportacoes])
+# => {2946=>{"1/2000"=>"3453879475", "2/2000"=>"4124889858", ...},
+#     3034=>{"1/2000"=>"3568862639", "2/2000"=>"4046750398", ...}}
+```
+
+The indicators must have the same periodicity.
+
+### Logging
+
+To specify the log level use the `:log_level` option. Valid values are `:fatal`, `:error`, `:warn`, `:info`, `:debug`. In practice, it will affect the output of Savon calls.
+```ruby
+BancoCentral.all(:ipca, log_level: :debug)
+```
+
+The default logger is STDOUT. To use a different one just use the `:logger` option.
+```ruby
+BancoCentral.all(:ipca, log_level: :debug, logger: @logger)
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hgtesta/banco_central. 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/banco_central.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'banco_central/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "banco_central"
+  spec.version       = BancoCentral::VERSION
+  spec.authors       = ["Henrique G. Testa"]
+  spec.email         = ["hgtesta@gmail.com"]
+
+  spec.summary       = %q{Fetch social and economic indicators from Central Bank of Brazil (Banco Central do Brasil).}
+  spec.description   = %q{Fetch social and economic indicators from Central Bank of Brazil (Banco Central do Brasil).}
+  spec.homepage      = "http://github.com/hgtesta/banco_central"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "savon", "~> 2.11"
+
+  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 "activesupport", "~> 5.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "banco_central"
+
+# 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/config/labels.yml

@@ -0,0 +1,48 @@
+
+wsdl_uri: "https://www3.bcb.gov.br/sgspub/JSP/sgsgeral/FachadaWSSGS.wsdl"
+
+labels:
+
+  # Miscellany
+  bovespa:           7
+  poupanca:         25
+  pib:            4380
+  inpc:            188
+  igpm:            189
+  ipca:            433
+  selic:          4189
+  selic_diaria:     11
+  meta_selic:      432
+  importacoes:    3034
+  exportacoes:    2946
+  salario_minimo: 1619
+  ouro:              4
+
+  # Currency
+  dolar:                         1
+  dolar_venda:                   1
+  dolar_compra:              10813
+  euro:                      21619
+  euro_venda:                21619
+  euro_compra:               21620
+  iene:                      21621
+  iene_venda:                21621
+  iene_compra:               21622
+  libra:                     21623
+  libra_venda:               21623
+  libra_compra:              21624
+  franco_suico:              21625
+  franco_suico_venda:        21625
+  franco_suico_compra:       21626
+  coroa_dinamarquesa:        21627
+  coroa_dinamarquesa_venda:  21627
+  coroa_dinamarquesa_compra: 21628
+  coroa_norueguesa:          21629
+  coroa_norueguesa_venda:    21629
+  coroa_norueguesa_compra:   21630
+  dolar_australiano:         21633
+  dolar_australiano_venda:   21633
+  dolar_australiano_compra:  21634
+  dolar_canadense:           21635
+  dolar_canadense_venda:     21635
+  dolar_canadense_compra:    21636

data/lib/banco_central/version.rb

@@ -0,0 +1,3 @@
+module BancoCentral
+  VERSION = "0.1.1"
+end

data/lib/banco_central.rb

@@ -0,0 +1,122 @@
+require "banco_central/version"
+require "savon"
+require "yaml"
+
+# BancoCentral.last(:ipca)
+# BancoCentral.all(:ipca)
+# BancoCentral.all(:ipca, start: "1/7/2014")
+# BancoCentral.all(:ipca, finish: "1/8/2014")
+# BancoCentral.all(:ipca, start: "1/7/2014", finish: "1/8/2014")
+# BancoCentral.all([:importacoes, :exportacoes])
+# BancoCentral.find(:dolar, date: "3/7/2014")
+# BancoCentral::LABELS
+module BancoCentral
+
+  CONFIG    = YAML.load_file(File.join File.dirname(__dir__), "config/labels.yml")
+
+  WSDL_URI  = CONFIG["wsdl_uri"]
+
+  LABELS    = CONFIG["labels"]
+
+  class << self
+
+    def find(id, date, log_level: nil, logger: nil)
+      client(log_level, logger).call(
+        :get_valor,
+        message: {
+          in0: get_id(id),
+          in1: date
+        }
+      ).to_hash[:multi_ref].to_f
+    end
+
+    def last(id, log_level: nil, logger: nil)
+      xml = client(log_level, logger).call(
+        :get_ultimo_valor_xml,
+        message: {
+          in0: get_id(id)
+        }
+      ).to_hash[:get_ultimo_valor_xml_response][:get_ultimo_valor_xml_return]
+
+      # Prevent exception when parsing if indicator's name has the & character
+      xml.gsub!(/&(?!(?:amp|lt|gt|quot|apos);)/, '&amp;')
+
+      hash = Nori.new.parse(xml)["resposta"]["SERIE"]
+
+      {
+        id: get_id(id),
+        name: hash["NOME"],
+        unit: hash["UNIDADE"],
+        date: parse_date(hash["DATA"]),
+        value: parse_value(hash["VALOR"]),
+        periodicity: parse_periodicity(hash["PERIODICIDADE"])
+      }
+    end
+
+    # BancoCentral.all([:ipca], start: "1/7/2014")
+    def all(id, start: nil, finish: nil, log_level: nil, logger: nil)
+
+      # Build request arguments
+      ids = id.is_a?(Array) ? id : [id]
+      args = {}
+      ids.each_with_index do |_id, i|
+        args["ins#{i}:int"] = get_id(_id)
+      end
+
+      # Request the WebService
+      xml = client(log_level, logger).call(
+        :get_valores_series_xml,
+        message: {
+          in0: args,
+          in1: start,
+          in2: finish
+        }
+      ).to_hash[:get_valores_series_xml_response][:get_valores_series_xml_return]
+
+      # Convert response XML to a hash (for one id) or a hash of hashes (more than one id)
+      doc = Nokogiri::XML(xml) { |config| config.noblanks }
+      data = {}
+      doc.css("SERIE").each do |serie|
+        array = serie.css("DATA, VALOR").map(&:text)
+        data[serie["ID"].to_i] = Hash[array.each_slice(2).to_a]
+      end
+
+      id.is_a?(Array) ? data : data[get_id(id)]
+    end
+
+    private
+
+      def client(log_level = nil, logger = nil)
+        options = {
+          encoding: "UTF-8",
+          ssl_verify_mode: :none,
+          wsdl: WSDL_URI
+        }
+        if log_level
+          options[:log] = true
+          options[:log_level] = log_level # one of [:debug, :info, :warn, :error, :fatal]
+          options[:logger] = logger if logger
+        end
+        Savon.client(options)
+      end
+
+      def get_id(id)
+        return id if id.is_a? Integer
+        LABELS[id.to_s] || raise(ArgumentError, 'Label not found')
+      end
+
+      def parse_periodicity(periodicity)
+        {"D" => :daily, "M" => :monthly, "T" => :quarterly, "A" => :yearly}[periodicity]
+      end
+
+      def parse_date(date)
+        Time.new(date["ANO"], date["MES"], date["DIA"])
+      end
+
+      def parse_value(value)
+        value.gsub(",", ".").to_f
+      end
+
+  end
+
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: banco_central
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Henrique G. Testa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Fetch social and economic indicators from Central Bank of Brazil (Banco
+  Central do Brasil).
+email:
+- hgtesta@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- banco_central.gemspec
+- bin/console
+- bin/setup
+- config/labels.yml
+- lib/banco_central.rb
+- lib/banco_central/version.rb
+homepage: http://github.com/hgtesta/banco_central
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: Fetch social and economic indicators from Central Bank of Brazil (Banco Central
+  do Brasil).
+test_files: []