hg-finance 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b8c3c29ec2ee03c3d9fe913e153681e16b44dae0
+  data.tar.gz: 53eac99f9645eef8b4ada3fdd5237de6412be636
+SHA512:
+  metadata.gz: 0966553e351939fa13826ab5ac29ce2e4cb50e6d334fe9d27c167058af15fab9e7e46ca65a13ee8c005bc7a88248f12be490d569e50609914a18edebb8891e24
+  data.tar.gz: 8c7005b4e5b3ad0ea79fa510541adcdbbb2e76797aef3bc26cfb4bc7989fe959362076f7fea12f96767d6b1044466e5e64a91b36f945a5151fcb7031f1bd2a6a

data/lib/hg/finance/currency.rb

@@ -0,0 +1,54 @@
+require 'hg/finance/locale'
+
+module HG
+  module Finance
+
+    class Currency
+      # Public: Name
+      attr_accessor :name
+
+      # Public: ISO code
+      attr_accessor :iso_code
+
+      # Public: Source currency
+      attr_accessor :source
+
+      # Public: Price to buy
+      attr_accessor :buy
+
+      # Public: Price to seel
+      attr_accessor :sell
+
+      # Public: Last day variation
+      attr_accessor :variation
+
+      def initialize(options = {})
+        if options.count != 0
+          @name      = options[:name] if options[:name]
+          @iso_code  = options[:iso_code] if options[:iso_code]
+          @source    = options[:source] if options[:source]
+          @buy       = options[:buy].to_f if options[:buy]
+          @sell      = options[:sell].to_f if options[:sell]
+          @variation = options[:variation].to_f if options[:variation]
+        end
+      end
+
+      def to_s separator = ' - '
+        to_return = []
+
+        to_return << self.name.to_s + ' (' + self.iso_code.to_s + ')'
+
+        to_return << "#{Locale.get_format(:buy).to_s.capitalize}: " + "#{self.source} #{self.buy}" if self.buy
+        to_return << "#{Locale.get_format(:sell).to_s.capitalize}: " + "#{self.source} #{self.sell}" if self.sell
+        to_return << "#{Locale.get_format(:variation).to_s.capitalize}: " + self.variation.to_s if self.variation
+
+        return to_return.join(separator)
+      end
+
+      def inspect
+        self.to_s
+      end
+    end
+
+  end
+end

data/lib/hg/finance/data.rb

@@ -0,0 +1,73 @@
+require 'hg/finance/currency'
+require 'hg/finance/taxes'
+require 'hg/finance/stock'
+
+module HG
+  module Finance
+
+    class Data
+
+      attr_accessor :request, :requested_at, :key_status
+      attr_accessor :taxes, :currencies, :stocks
+
+      def initialize params, host_name, use_ssl = true
+        query_params = params.map{|k,v| "#{k.to_s}=#{v.to_s}"}.join('&')
+        @request = (use_ssl ? 'https' : 'http') + host_name + '?' + query_params
+        @requested_at = Time.now
+
+        request_data = JSON.parse(open(self.request).read)
+
+        if request_data['results']
+          results = request_data['results']
+
+          @key_status = (params[:key] ? (request_data['valid_key'] ? :valid : :invalid) : :empty)
+
+          @taxes = Taxes.new(to_taxes(results['taxes'].first)) if @key_status == :valid
+
+          @currencies = {}
+          results['currencies'].each do |iso, currency|
+            next if iso == 'source'
+            @currencies[iso] = Currency.new(to_currency(currency, iso, results['currencies']['source']))
+          end
+
+          @stocks = {}
+          results['stocks'].each do |code, stock|
+            @stocks[code] = Stock.new(to_stock(stock))
+          end
+        end
+
+        return self
+      end
+
+      def to_taxes r
+        {
+          date: r['date'],
+          cdi: r['cdi'],
+          selic: r['selic'],
+          daily_factor: r['daily_factor']
+        }
+      end
+
+      def to_currency r, iso_code, source
+        {
+          source: source,
+          iso_code: iso_code,
+          name: r['name'],
+          buy: r['buy'],
+          sell: r['sell'],
+          variation: r['variation']
+        }
+      end
+
+      def to_stock r
+        {
+          name: r['name'],
+          location: r['location'],
+          variation: r['variation']
+        }
+      end
+
+    end
+
+  end
+end

data/lib/hg/finance/locale.rb

@@ -0,0 +1,36 @@
+module HG
+  module Finance
+
+    class Locale
+
+      @formats = {
+        en: {
+          date: '%Y-%m-%d',
+          short_date: '%m-%d',
+          datetime: '%Y-%m-%d %H:%M',
+          buy: :buy,
+          sell: :sell,
+          variation: :variation,
+          daily_factor: 'daily factor'
+        },
+        :'pt-br' => {
+          date: '%d/%m/%Y',
+          short_date: '%d/%m',
+          datetime: '%d/%m/%Y %H:%M',
+          buy: :compra,
+          sell: :venda,
+          variation: 'variação',
+          daily_factor: 'fator diário'
+        }
+      }
+
+      def self.get_format item
+        Finance.locale = :en unless @formats.has_key?(Finance.locale.to_sym)
+
+        return @formats[Finance.locale.to_sym][item]
+      end
+
+    end
+
+  end
+end

data/lib/hg/finance/stock.rb

@@ -0,0 +1,43 @@
+require 'hg/finance/locale'
+
+module HG
+  module Finance
+
+    class Stock
+      # Public: Name
+      attr_accessor :name
+
+      # Public: Market Identifier Code
+      # attr_accessor :mic
+
+      # Public: Location
+      attr_accessor :location
+
+      # Public: Last util day variation
+      attr_accessor :variation
+
+      def initialize(options = {})
+        if options.count != 0
+          @name      = options[:name] if options[:name]
+          # @mic       = options[:mic] if options[:mic]
+          @location  = options[:location] if options[:location]
+          @variation = options[:variation] if options[:variation]
+        end
+      end
+
+      def to_s separator = ' - '
+        to_return = []
+
+        to_return << "#{self.name} - #{self.location}" if self.name && self.location
+        to_return << "#{Locale.get_format(:variation).to_s.capitalize}: " + self.variation.to_s if self.variation
+
+        return to_return.join(separator)
+      end
+
+      def inspect
+        self.to_s
+      end
+    end
+
+  end
+end

data/lib/hg/finance/taxes.rb

@@ -0,0 +1,53 @@
+require 'hg/finance/locale'
+
+module HG
+  module Finance
+
+    class Taxes
+      # Public: Date
+      attr_accessor :date
+
+      # Public: ISO code
+      attr_accessor :cdi
+
+      # Public: Source currency
+      attr_accessor :selic
+
+      # Public: Price to buy
+      attr_accessor :daily_factor
+
+      def initialize(options = {})
+        if options.count != 0
+          @date         = process_datetime(options[:date]) if options[:date]
+          @cdi          = options[:cdi] if options[:cdi]
+          @selic        = options[:selic] if options[:selic]
+          @daily_factor = options[:daily_factor] if options[:daily_factor]
+        end
+      end
+
+      def to_s separator = ' - '
+        to_return = []
+
+        to_return << self.date.strftime(Locale.get_format(:short_date)) if self.date && self.date.kind_of?(Time)
+
+        to_return << 'CDI: ' + self.cdi.to_s if self.cdi
+        to_return << 'SELIC: ' + self.selic.to_s if self.selic
+        to_return << "#{Locale.get_format(:daily_factor).to_s.capitalize}: " + self.daily_factor.to_s if self.daily_factor
+
+        return to_return.join(separator)
+      end
+
+      def inspect
+        self.to_s
+      end
+
+      protected
+      def process_datetime date, time = nil
+        return Time.now if date.nil?
+
+        return Time.strptime((date + ' ' + (time ? time : '00:00')), Locale.get_format(:datetime))
+      end
+    end
+
+  end
+end

data/lib/hg/finance/version.rb

@@ -0,0 +1,5 @@
+module HG
+  module Finance
+    VERSION = "1.0.0"
+  end
+end

data/lib/hg/finance.rb

@@ -0,0 +1,60 @@
+require 'open-uri'
+require 'json'
+
+require 'hg/finance/version'
+require 'hg/finance/data'
+
+module HG
+  module Finance
+    HOST_NAME = '://api.hgbrasil.com/finance'
+
+    class << self
+      # API Key
+      attr_accessor :api_key
+
+      # Locale
+      attr_accessor :locale
+
+      # API Key status
+      attr_reader :api_key_status
+
+      # Use SSL to access the API
+      attr_accessor :use_ssl
+
+      # Use Rails cache for recieved data (realy recommended)
+      attr_accessor :use_rails_cache
+    end
+
+    def self.locale
+      @locale || :en
+    end
+
+    def self.use_ssl
+      @use_ssl || true
+    end
+
+    def self.setup(&block)
+      yield self
+    end
+
+    def self.get(options = {})
+      process({})
+    end
+
+    def self.process params
+      params = defaults.merge(params).delete_if{|k,v| v.nil?}
+
+      return HG::Finance::Data.new(params, HOST_NAME, self.use_ssl)
+    end
+
+    def self.defaults
+      {
+        key: self.api_key,
+        locale: self.locale,
+        format: :json,
+        sdk_version: "ruby_f#{HG::Finance::VERSION}"
+      }
+    end
+
+  end
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: hg-finance
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Hugo Demiglio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-20 00:00:00.000000000 Z
+dependencies: []
+description: Get brazilian finance data using HG Finance API.
+email:
+- hugodemiglio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/hg/finance.rb
+- lib/hg/finance/currency.rb
+- lib/hg/finance/data.rb
+- lib/hg/finance/locale.rb
+- lib/hg/finance/stock.rb
+- lib/hg/finance/taxes.rb
+- lib/hg/finance/version.rb
+homepage: http://hgbrasil.com/finance
+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: Simple gem to get finance data from HG Finance.
+test_files: []