banco_central 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d6e52dcabf6c0b4bef82235c84a15d9ad30c104
-  data.tar.gz: 940519cc51b45ec89d53d92ec958c5ec5e8e14b8
+  metadata.gz: e2b98916ce52a33d03a5c13149d2deb09e58ac3e
+  data.tar.gz: a48f8692c19cd9a406668ada7829bac2797f93b4
 SHA512:
-  metadata.gz: 6052734bae8dfb11a1123fa1db07e6b0f25ca5c6edf87f411622b478981f71b14c1dfa09a9bd3f18371bfd0fb7d043a982a1482716459b2b6e01aa95adfb1575
-  data.tar.gz: 6ad2376752c2e4ef8eebf742f2cf1af51c19542e1f6d8e4bbc000167a37a7d71159038cfe490ed3277b37a798bcfba3772e5184cbdfef85b39e58404beb77e70
+  metadata.gz: 5ed03e3953fd9c391b4c6e01dc8abf9f223b76426d92f2a23aefea0a075db9b550fe51f58ead3ebd2162bbbf14318d8e65c9f54180d5aec334f43c5241358395
+  data.tar.gz: cac607a3e688ab543db38e6d0ce68b771ca6cb2031b5d0d2d7398fd210aa7afa680d67b7d9621a28c35189f98a68615c5b3ec0b4971eebf29427c8876ac60312

data/README.md

@@ -85,14 +85,14 @@ 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.
+To specify the log level set the `log_level` attribute. 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)
+BancoCentral.log_level = :debug
 ```
 
-The default logger is STDOUT. To use a different one just use the `:logger` option.
+The default logger is STDOUT. To use a different one just set the `:logger` attribute.
 ```ruby
-BancoCentral.all(:ipca, log_level: :debug, logger: @logger)
+BancoCentral.logger = @logger
 ```
 
 

data/lib/banco_central.rb

@@ -1,132 +1,177 @@
-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
-# BancoCentral.exp(1)
-module BancoCentral
+# frozen_string_literal: true
 
-  CONFIG    = YAML.load_file(File.join File.dirname(__dir__), "config/labels.yml")
+require 'banco_central/version'
+require 'savon'
+require 'yaml'
 
-  WSDL_URI  = CONFIG["wsdl_uri"]
+# Fetch social and economic indicators from the Central Bank of Brazil
+# (Banco Central do Brasil) WebService. It fires a SOAP request behind
+# the scenes and parse the result for easy use.
+module BancoCentral
 
-  LABELS    = CONFIG["labels"]
+  CONFIG   = YAML.load_file(File.join(File.dirname(__dir__), 'config/labels.yml'))
+  WSDL_URI = CONFIG['wsdl_uri']
+  LABELS   = CONFIG['labels']
 
   class << self
 
-    def exp(id, log_level: nil, logger: nil)
-      client(log_level, logger).call(
-        :get_ultimo_valor_vo,
-        message: {
-          in0: get_id(id)
-        }
-      )
-    end
+    attr_accessor :log_level
+    attr_accessor :logger
 
-    def find(id, date, log_level: nil, logger: nil)
-      client(log_level, logger).call(
+    # Get the indicator's value for a specific date. It calls +GetValor+ method
+    # from the WebService and returns only a float number.
+    #
+    #   BancoCentral.find(:dolar, "3/7/2014")
+    #   => 0.75
+    def find(id, date)
+      client.call(
         :get_valor,
         message: {
-          in0: get_id(id),
+          in0: label_to_int(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]
+    # Get the last value of the an indicator, and also the name, unit, date and
+    # periodicity. This method calls +GetUltimoValorXml+ method from the
+    # WebService.
+    #
+    #   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
+    #   }
+    def last(id)
+      indicator_xml = sanitize(last_as_xml(id))
+      indicator = Nori.new.parse(indicator_xml)['resposta']['SERIE']
+      {
+        id: label_to_int(id),
+        name: indicator['NOME'],
+        unit: indicator['UNIDADE'],
+        date: parse_date(indicator['DATA']),
+        value: parse_value(indicator['VALOR']),
+        periodicity: parse_periodicity(indicator['PERIODICIDADE'])
+      }
+    end
 
-      # Prevent exception when parsing if indicator's name has the & character
-      xml.gsub!(/&(?!(?:amp|lt|gt|quot|apos);)/, '&amp;')
+    # Get all the values of the indicator. This method calls
+    # +GetValoresSeriesXMLResponse+ method from the WebService.
+    #
+    # This method accepts a string, symbol or an array of string or
+    # symbols as indicator names. In case an array is given, it will
+    # return a hash of hashes.
+    #
+    #   BancoCentral.all(:ipca)
+    #   => {"1/1980"=>"6.62", "2/1980"=>"4.62", ... }
+    #
+    #   BancoCentral.all(:ipca, start: "1/7/2014", finish: "1/8/2014")
+    #   => {"7/2014"=>"0.01", "8/2014"=>"0.25"}
+    #
+    #   BancoCentral.all([:importacoes, :exportacoes])
+    #   => {
+    #        2946 => {"1/1954"=>"122603000", "2/1954"=>"125851000", ...},
+    #        3034 => {"1/1973"=>"370706000", "2/1973"=>"390279000", ...}
+    #      }
+    #
+    def all(id, start: nil, finish: nil)
+      indicators_xml = all_as_xml(id, start, finish)
+      indicators_doc = Nokogiri::XML(indicators_xml, &:noblanks)
+
+      # Convert response XML to a hash (for one id) or a hash of
+      # hashes (for more than one id)
+      indicators = {}
+      indicators_doc.css('SERIE').each do |serie|
+        array = serie.css('DATA, VALOR').map(&:text)
+        indicators[serie['ID'].to_i] = Hash[array.each_slice(2).to_a]
+      end
 
-      hash = Nori.new.parse(xml)["resposta"]["SERIE"]
+      id.is_a?(Array) ? indicators : indicators[label_to_int(id)]
+    end
 
-      {
-        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"])
+    private
+
+    # Prevent exception when parsing if indicator's name has the & character
+    def sanitize(indicator_name)
+      indicator_name.gsub(/&(?!(?:amp|lt|gt|quot|apos);)/, '&amp;')
+    end
+
+    def client
+      options = {
+        encoding: 'UTF-8',
+        ssl_verify_mode: :none,
+        wsdl: WSDL_URI
       }
+      if @log_level
+        options[:log] = true
+        options[:log_level] = @log_level
+        options[:logger] = @logger if @logger
+      end
+      Savon.client(options)
     end
 
-    # BancoCentral.all([:ipca], start: "1/7/2014")
-    def all(id, start: nil, finish: nil, log_level: nil, logger: nil)
+    def last_as_xml(id)
+      client
+        .call(
+          :get_ultimo_valor_xml,
+          message: {
+            in0: label_to_int(id)
+          }
+        )
+        .to_hash[:get_ultimo_valor_xml_response][:get_ultimo_valor_xml_return]
+        .gsub("<?xml version='1.0' encoding='ISO-8859-1'?>\n", '')
+    end
 
-      # Build request arguments
+    def all_as_xml(id, start, finish)
       ids = id.is_a?(Array) ? id : [id]
+
+      # Build SOAP request arguments
       args = {}
-      ids.each_with_index do |_id, i|
-        args["ins#{i}:int"] = get_id(_id)
+      ids.each_with_index do |indicator_id, i|
+        args["ins#{i}:int"] = label_to_int(indicator_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)]
+      client
+        .call(
+          :get_valores_series_xml,
+          message: {
+            in0: args,
+            in1: start,
+            in2: finish
+          }
+        )
+        .to_hash[:get_valores_series_xml_response][:get_valores_series_xml_return]
+        .gsub("<?xml version='1.0' encoding='ISO-8859-1'?>\n", '')
     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
+    def label_to_int(id)
+      if id.is_a? Integer
+        id
+      else
         LABELS[id.to_s] || raise(ArgumentError, 'Label not found')
       end
+    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_periodicity(periodicity)
+      {
+        'D' => :daily,
+        'M' => :monthly,
+        'T' => :quarterly,
+        'A' => :yearly
+      }[periodicity]
+    end
 
-      def parse_value(value)
-        value.gsub(",", ".").to_f
-      end
+    def parse_date(date)
+      Time.new(date['ANO'], date['MES'], date['DIA'])
+    end
 
+    def parse_value(value)
+      value.tr(',', '.').to_f
+    end
   end
-
 end

data/lib/banco_central/version.rb

@@ -1,3 +1,3 @@
 module BancoCentral
-  VERSION = "0.1.2"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: banco_central
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Henrique G. Testa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-19 00:00:00.000000000 Z
+date: 2017-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon