eba 1.10.2 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c529de9a64d7728b5c6e203dcc0fd428587866e9
-  data.tar.gz: 569a5cbecb3b8c50503682f247ea090aeb890cdb
+  metadata.gz: 2026c412008409324969c24f09c9fa6b0eaf4f20
+  data.tar.gz: 0a431597ac2a25aff61ecf8ead7b3014671d22a5
 SHA512:
-  metadata.gz: 69211d896f0081ac80c217feb0def3c065ca6555baf3a64cb5feb442976ce1f01d951f9b17718ef5642e85f6baacf0e7a1681f58f569f342ddd7e55e98802054
-  data.tar.gz: 7be34be91dc8372ddbf888ea9121794dc114138d514f3c34cf6a33d59f64af09c8e2d1b7c124470b3553ef647e69020f139918b58063df22f0e751a4dce9d23f
+  metadata.gz: 940c9aae47a31650a110bc12e938256e107a37d5664037395dd893cf5d6bce5e77ec889fd92cd5253b275c8ac7d4223ac9d36e540fad9eb6b5557fd29fa0c485
+  data.tar.gz: 5d4f61453fb3b7ec6efc3cba12f0967d99669adc05093d6007f4c9072f85f59751b056d71ceeed5e9eeffa3623563ef1128a6c6223f60fe2bb097b074d630d5b

data/lib/eba/bcb.rb

@@ -2,11 +2,10 @@ require "savon"
 require "net/https"
 require "nokogiri"
 require "date"
-require_relative "encoder"
-require_relative "data"
 
-class BCB < Encoder
+require_relative "helper"
 
+class BCB < Helper	
 	################################################################################################
 	# 											       																																 #
 	# You MUST supply a valid certificate in order for the connection to work!		       					 #
@@ -27,6 +26,7 @@ class BCB < Encoder
 
 	def initialize(path_to_certificate)
 		@pub_key = path_to_certificate
+
 		connect_to_service()
 	end
 
@@ -44,87 +44,44 @@ class BCB < Encoder
 		return @service.operations
 	end
 
-	# Removes all invalid series from an array.
-	#
-	# An invalid series has last value.
-	def purge_invalid_series(array_of_codes)
-		result = []
-
+	def hash_last_value_with_code(array_of_codes)
+		result = {}
+		
 		array_of_codes.each do |code|
-			if get_last_value(code) != nil
-				result << code
-			end
+			result[code] = get_last_value(code)
 		end
 
-		return result 
+		result
 	end
 
 	def hash_by_periodicity(array_of_codes)
-		purged_array_of_codes = purge_invalid_series(array_of_codes)
+		last_values = hash_last_value_with_code(array_of_codes)
+		purged_array_of_codes = purge_invalid_series(array_of_codes, last_values)
 		result = {}
 
 		purged_array_of_codes.each do |code|
-			dado = get_last_value(code)
-
-			if dado == nil then
-				puts "No valid last value for #{code}."
-			else
-				if not result.key? dado.periodicity then
-					result[dado.periodicity] = []
-				end
+			dado = last_values[code]
 
-				result[dado.periodicity] << dado
+			if not result.key? dado.periodicity then
+				result[dado.periodicity] = []
 			end
-		end
-
-		return result
-	end
 
-	def build_bcb_data(name, code, periodicity, unit, day, month, year, value, is_unseasoned)
-		if is_unseasoned == nil then
-			is_unseasoned = name.include? " - com ajuste sazonal"
-
-			if is_unseasoned then
-				name.slice! " - com ajuste sazonal"
-			end		
+			result[dado.periodicity] << dado
 		end
 
-		encoded_name = encode(name)
-		encoded_periodicity = encode(periodicity)
-		encoded_unit = encode(unit)
-		encoded_day = day
-		encoded_month = month
-		encoded_year = year
-		encoded_value = encode(value)
-		
-		return Data_bcb.new(encoded_name, code, encoded_periodicity,
-				    						encoded_unit, encoded_day, encoded_month,
-				    						encoded_year, encoded_value, is_unseasoned)
+		return result
 	end
 
+	
 	def get_last_value(series_code)
 		begin
 			response = @service.call(:get_ultimo_valor_xml, message: {in0: "#{series_code}"})
-
 		rescue Exception => e
-			if e.message.to_s["No such operation 'getUltimoValorXML'"] != nil || 
-				 e.message.to_s["Server.userException"] != nil then
-				#This error is expetected, it only means that the code is invalid.
-
-			elsif e.message.to_s["nil:NilClass"] != nil || 
-						e.message.to_s["Connection reset by peer"] != nil || 
-						e.message.to_s["Failed to open TCP connection"] != nil || 
-						e.message.to_s["Socket closed"] != nil then
-				puts "Will have to try last value again for #{series_code}, webservice dropped the ball.\nError: #{e.message}"
-
-			else
-				puts "Error requesting last value.\nMessage: #{e.message}\nTrace: #{e.backtrace}"
-			end
-
-			return nil
+			return Data_bcb.invalid_data()
 		end
 
-		response = response.to_hash[:get_ultimo_valor_xml_response][:get_ultimo_valor_xml_return].sub("&", "-_1532_-")
+		response = response.to_hash[:get_ultimo_valor_xml_response][:get_ultimo_valor_xml_return].sub("&", 
+																																																"-_1532_-")
 
 		xmlResult = Nokogiri::XML(response)
 
@@ -139,13 +96,13 @@ class BCB < Encoder
 		# VALOR = VALUe
 
 		return build_bcb_data(xmlResult.search("NOME").text.sub("-_1532_-", "&"), 
-				      						series_code, 
-													xmlResult.search("PERIODICIDADE").text, 
-													xmlResult.search("UNIDADE").text.sub("-_1532_-", "&"), 
-													xmlResult.search("DIA").text, 
-													xmlResult.search("MES").text, 
-													xmlResult.search("ANO").text, 
-													xmlResult.search("VALOR").text, nil) 
+				      										series_code, 
+																	xmlResult.search("PERIODICIDADE").text, 
+																	xmlResult.search("UNIDADE").text.sub("-_1532_-", "&"), 
+																	xmlResult.search("DIA").text, 
+																	xmlResult.search("MES").text, 
+																	xmlResult.search("ANO").text, 
+																	xmlResult.search("VALOR").text, false) 
 	end
 
 	# Ensure that date is in the format dd/MM/YYY
@@ -177,7 +134,7 @@ class BCB < Encoder
 
 				result = send_message(message)
 	
-				if result != [] then
+				if result != nil then
 					i = 0	
 
 					result.css("SERIE").each do |serie|
@@ -191,55 +148,17 @@ class BCB < Encoder
 		return data_collection 
 	end
 
-	def extract_an_item(serie, code, base_data, data_collection)
-		# recover identifying data from the getLastValue method,
-		# as the get_valores_series_xml desn't have identifying data
-		# as series name, periodicity, etc. 
-	 
-		if serie.inspect["name=\"ID\" value=\"#{code}\""] != nil then
-			serie.css("ITEM").each do |item|
-				dia = "01"
-				mes = "1"
-				ano = "1"
-				data = item.css("DATA").text.split("/")
-
-				if base_data.periodicity == 'D' then
-					dia = data[0]
-					mes = data[1]
-					ano = data[2]
-				else
-					mes = data[0]
-					ano = data[1]
-				end 
-
-				data_collection << build_bcb_data(base_data.name, code, 
-																					base_data.periodicity, 
-																					base_data.unit, 
-																					dia, mes, ano, 
-																					item.css("VALOR").text,
-																					base_data.seasonally_adjusted)
-			end
-		end
-	end
-
 	def send_message(message)
+		result = nil
+
 		# try and catch, as some series can be discontinued or a code may be broken
 		begin
 			response = @service.call(:get_valores_series_xml, message: message)	
 			result = Nokogiri::XML(response.to_hash[:get_valores_series_xml_response][:get_valores_series_xml_return])
 		rescue Exception => erro
-			#The interval is empty, therefore an empty array should be returned.
-			if erro.to_s.include? "Value(s) not found" then
-				puts "Some of the codes might be invalid. Requested: #{message[:in0][:long]}."
-				return []
-
-			elsif erro.message.to_s["Socket closed"] != nil then
-				puts "\n\nSocket closed for message #{message[:in0][:long]}, try again."
-
-			else
-				puts "\n\nError requesting all data for the range [#{min_date}, #{max_date}] for codes #{message[:in0][:long]}! #{erro}\nTrace: #{erro.backtrace}\nMessage: #{erro.message}\n"				
-				return []
-			end
+			result = nil
 		end
+		
+		result
 	end
 end

data/lib/eba/data.rb

@@ -30,6 +30,10 @@ class Data_bcb
 		return @name + @periodicity.to_s + @unit
 	end
 
+	def self.invalid_data()
+		Data_bcb.new(nil, nil, nil, nil, 1, 1, 1900, 0, false)
+	end
+
 	def is_valid?
 	
 		if @name == nil or @name == '' then

data/lib/eba/helper.rb

@@ -0,0 +1,75 @@
+require_relative "data"
+require_relative "encoder"
+
+class Helper < Encoder
+	def initialize()
+	end
+
+	def build_bcb_data(name, code, periodicity, unit, day, month, year, value, is_unseasoned)
+		if name[" - com ajuste sazonal"] != nil then
+			is_unseasoned = true
+
+			if is_unseasoned then
+				name.slice!(" - com ajuste sazonal")
+			end		
+		end
+
+		encoded_name = encode(name)
+		encoded_periodicity = encode(periodicity)
+		encoded_unit = encode(unit)
+		encoded_day = day
+		encoded_month = month
+		encoded_year = year
+		encoded_value = encode(value)
+		
+		return Data_bcb.new(encoded_name, code, encoded_periodicity,
+				    						encoded_unit, encoded_day, encoded_month,
+				    						encoded_year, encoded_value, is_unseasoned)
+	end
+
+	# Removes all invalid series from an array.
+	#
+	# An invalid series has last value.
+	def purge_invalid_series(array_of_codes, hash_last_values)
+		result = []
+
+		array_of_codes.each do |code|
+			if hash_last_values[code] != nil then
+				result << code
+			end
+		end
+
+		return result 
+	end
+
+	def extract_an_item(serie, code, base_data, data_collection)
+		# recover identifying data from the getLastValue method,
+		# as the get_valores_series_xml desn't have identifying data
+		# as series name, periodicity, etc. 
+	 
+		if serie.inspect["name=\"ID\" value=\"#{code}\""] != nil then
+			serie.css("ITEM").each do |item|
+				dia = "01"
+				mes = "1"
+				ano = "1"
+				data = item.css("DATA").text.split("/")
+
+				if base_data.periodicity == 'D' then
+					dia = data[0]
+					mes = data[1]
+					ano = data[2]
+				else
+					mes = data[0]
+					ano = data[1]
+				end 
+
+				data_collection << build_bcb_data(base_data.name, code, 
+																									base_data.periodicity, 
+																									base_data.unit, 
+																									dia, mes, ano, 
+																									item.css("VALOR").text,
+																									base_data.seasonally_adjusted)
+			end
+		end
+	end
+end

data/lib/eba/version.rb

@@ -5,7 +5,7 @@ module Eba
   # ff - commits on feature
   # hh - commits on hotfix
 
-  VERSION = "1.10.2"
+  VERSION = "1.11.0"
 
   #Version 1.0.1
   #
@@ -79,4 +79,8 @@ module Eba
 	
 	#Version 1.10.2
 	# Adds "Socket closed" error to last value expcetion handling.
+
+	#Versuib 1.11.0
+	# Refactors and simplifies interactions with target webservice. Methods no longer return nil,
+	#		but an invalid Data_bcb object.
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eba
 version: !ruby/object:Gem::Version
-  version: 1.10.2
+  version: 1.11.0
 platform: ruby
 authors:
 - Rafael Campos Cruz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-08-23 00:00:00.000000000 Z
+date: 2018-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +116,7 @@ files:
 - lib/eba/bcb.rb
 - lib/eba/data.rb
 - lib/eba/encoder.rb
+- lib/eba/helper.rb
 - lib/eba/version.rb
 homepage: https://github.com/rCamposCruz/eba
 licenses: