brapi-ruby-sdk 0.1.0

data/lib/brapi/model.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require "time"
+
+module Brapi
+  class Model
+    class << self
+      def attribute(name, type: nil, json_key: nil)
+        attr_reader name
+
+        attribute_specs[name] = { type: type, json_key: json_key&.to_s || camelize(name.to_s) }
+      end
+
+      def attribute_specs
+        @attribute_specs ||= begin
+          parent = superclass.respond_to?(:attribute_specs) ? superclass.attribute_specs : {}
+          parent.dup
+        end
+      end
+
+      def from_h(value)
+        return nil if value.nil?
+        return value if value.is_a?(self)
+
+        new(value)
+      end
+
+      def camelize(snake)
+        head, *rest = snake.split("_")
+        ([head] + rest.map(&:capitalize)).join
+      end
+    end
+
+    def initialize(hash = {})
+      hash ||= {}
+      hash = hash.transform_keys(&:to_s) if hash.respond_to?(:transform_keys)
+      @raw = hash
+      self.class.attribute_specs.each do |name, spec|
+        value = hash[spec[:json_key]]
+        value = hash[name.to_s] if value.nil?
+        instance_variable_set("@#{name}", coerce(value, spec[:type]))
+      end
+    end
+
+    def to_h
+      self.class.attribute_specs.each_with_object({}) do |(name, _), h|
+        value = public_send(name)
+        h[name] = serialize(value)
+      end
+    end
+
+    def [](name)
+      public_send(name) if respond_to?(name)
+    end
+
+    def ==(other)
+      other.is_a?(self.class) && other.to_h == to_h
+    end
+    alias eql? ==
+
+    def hash
+      to_h.hash
+    end
+
+    attr_reader :raw
+
+    private
+
+    def coerce(value, type)
+      return nil if value.nil?
+
+      case type
+      when :string  then value.to_s
+      when :integer then Integer(value)
+      when :float   then Float(value)
+      when :boolean then !!value
+      when :time    then parse_time(value)
+      when :date    then parse_date(value)
+      when Array    then Array(value).map { |v| coerce(v, type.first) }
+      when Class    then type.respond_to?(:from_h) ? type.from_h(value) : value
+      else value
+      end
+    end
+
+    def serialize(value)
+      case value
+      when Brapi::Model     then value.to_h
+      when Array            then value.map { |v| serialize(v) }
+      when Time             then value.iso8601
+      else value
+      end
+    end
+
+    def parse_time(value)
+      return value if value.is_a?(Time)
+
+      Time.parse(value.to_s)
+    rescue ArgumentError, TypeError
+      nil
+    end
+
+    def parse_date(value)
+      return value if value.is_a?(Date)
+
+      Date.parse(value.to_s)
+    rescue ArgumentError, TypeError
+      nil
+    end
+  end
+end

data/lib/brapi/models/available_list_response.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    class AvailableListResponse < Brapi::Model
+      attribute :indexes
+      attribute :stocks
+    end
+  end
+end

data/lib/brapi/models/balance_sheet_entry.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    class BalanceSheetEntry < Brapi::Model
+      attribute :end_date, type: :string
+      attribute :cash
+      attribute :short_term_investments
+      attribute :net_receivables
+      attribute :inventory
+      attribute :other_current_assets
+      attribute :total_current_assets
+      attribute :long_term_investments
+      attribute :property_plant_equipment
+      attribute :goodwill
+      attribute :intangible_assets
+      attribute :other_assets
+      attribute :total_assets
+      attribute :accounts_payable
+      attribute :short_long_term_debt
+      attribute :other_current_liabilities
+      attribute :total_current_liabilities
+      attribute :long_term_debt
+      attribute :other_liabilities
+      attribute :total_liabilities
+      attribute :common_stock
+      attribute :retained_earnings
+      attribute :treasury_stock
+      attribute :other_stockholder_equity
+      attribute :total_stockholder_equity
+      attribute :net_tangible_assets
+    end
+  end
+end

data/lib/brapi/models/financial_data_entry.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    class FinancialDataEntry < Brapi::Model
+      attribute :end_date, type: :string
+      attribute :total_revenue
+      attribute :revenue_per_share
+      attribute :gross_profits
+      attribute :ebitda
+      attribute :operating_cashflow
+      attribute :free_cashflow
+      attribute :total_cash
+      attribute :total_cash_per_share
+      attribute :total_debt
+      attribute :debt_to_equity
+      attribute :current_ratio
+      attribute :quick_ratio
+      attribute :return_on_assets
+      attribute :return_on_equity
+      attribute :gross_margins
+      attribute :ebitda_margins
+      attribute :operating_margins
+      attribute :profit_margins
+      attribute :earnings_growth
+      attribute :revenue_growth
+      attribute :financial_currency
+    end
+  end
+end

data/lib/brapi/models/quote.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    class Quote < Brapi::Model
+      attribute :symbol, type: :string
+      attribute :short_name, type: :string
+      attribute :long_name, type: :string
+      attribute :currency, type: :string
+      attribute :regular_market_price, type: :float
+      attribute :regular_market_day_high, type: :float
+      attribute :regular_market_day_low, type: :float
+      attribute :regular_market_day_range, type: :string
+      attribute :regular_market_change, type: :float
+      attribute :regular_market_change_percent, type: :float
+      attribute :regular_market_time, type: :time
+      attribute :market_cap, type: :integer
+      attribute :regular_market_volume, type: :integer
+      attribute :regular_market_previous_close, type: :float
+      attribute :regular_market_open, type: :float
+      attribute :average_daily_volume3_month, type: :integer, json_key: "averageDailyVolume3Month"
+      attribute :average_daily_volume10_day, type: :integer, json_key: "averageDailyVolume10Day"
+      attribute :fifty_two_week_low_change, type: :float
+      attribute :fifty_two_week_low_change_percent, type: :float
+      attribute :fifty_two_week_range, type: :string
+      attribute :fifty_two_week_high_change, type: :float
+      attribute :fifty_two_week_high_change_percent, type: :float
+      attribute :fifty_two_week_low, type: :float
+      attribute :fifty_two_week_high, type: :float
+      attribute :two_hundred_day_average, type: :float
+      attribute :two_hundred_day_average_change, type: :float
+      attribute :two_hundred_day_average_change_percent, type: :float
+      attribute :price_earnings, type: :float
+      attribute :earnings_per_share, type: :float
+      attribute :logourl, type: :string
+
+      # Module-only fields — exposed as raw hashes/arrays in v0.1.0.
+      # Dedicated typed models will land in subsequent minor versions.
+      attribute :summary_profile
+      attribute :balance_sheet_history, type: [Brapi::Models::BalanceSheetEntry]
+      attribute :balance_sheet_history_quarterly, type: [Brapi::Models::BalanceSheetEntry]
+      attribute :default_key_statistics
+      attribute :default_key_statistics_history
+      attribute :default_key_statistics_history_quarterly
+      attribute :income_statement_history
+      attribute :income_statement_history_quarterly
+      attribute :financial_data, type: Brapi::Models::FinancialDataEntry
+      attribute :financial_data_history, type: [Brapi::Models::FinancialDataEntry]
+      attribute :financial_data_history_quarterly, type: [Brapi::Models::FinancialDataEntry]
+      attribute :value_added_history
+      attribute :value_added_history_quarterly
+      attribute :cashflow_history
+      attribute :cashflow_history_quarterly
+
+      # Historical price data when `range`/`interval` are passed.
+      attribute :historical_data_price
+      attribute :dividends_data
+    end
+  end
+end

data/lib/brapi/models/quote_list_item.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    class QuoteListItem < Brapi::Model
+      attribute :stock, type: :string
+      attribute :name, type: :string
+      attribute :close, type: :float
+      attribute :change, type: :float
+      attribute :volume, type: :integer
+      attribute :market_cap, type: :integer
+      attribute :logo, type: :string
+      attribute :sector, type: :string
+      attribute :type, type: :string
+    end
+  end
+end

data/lib/brapi/models/quote_list_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    class QuoteListResponse < Brapi::Model
+      attribute :indexes
+      attribute :stocks, type: [Brapi::Models::QuoteListItem]
+      attribute :available_sectors
+      attribute :available_stock_types
+      attribute :current_page, type: :integer
+      attribute :total_pages, type: :integer
+      attribute :item_count, type: :integer
+      attribute :has_next_page, type: :boolean
+    end
+  end
+end

data/lib/brapi/models/quote_retrieve_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    class QuoteRetrieveResponse < Brapi::Model
+      attribute :results, type: [Brapi::Models::Quote]
+      attribute :requested_at, type: :time
+      attribute :took, type: :integer
+    end
+  end
+end

data/lib/brapi/models/v2/crypto.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    module V2
+      class Crypto < Brapi::Model
+        attribute :currency, type: :string
+        attribute :currency_rate_from_usd, type: :float
+        attribute :coin_name, type: :string
+        attribute :coin, type: :string
+        attribute :regular_market_change, type: :float
+        attribute :regular_market_change_percent, type: :float
+        attribute :regular_market_time, type: :time
+        attribute :regular_market_price, type: :float
+        attribute :regular_market_day_low, type: :float
+        attribute :regular_market_day_high, type: :float
+        attribute :regular_market_day_range, type: :string
+        attribute :regular_market_volume, type: :float
+        attribute :market_cap, type: :float
+        attribute :coin_image_url, type: :string
+        attribute :historical_data_price
+      end
+    end
+  end
+end

data/lib/brapi/models/v2/crypto_list_available_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    module V2
+      class CryptoListAvailableResponse < Brapi::Model
+        attribute :coins
+      end
+    end
+  end
+end

data/lib/brapi/models/v2/crypto_retrieve_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    module V2
+      class CryptoRetrieveResponse < Brapi::Model
+        attribute :coins, type: [Brapi::Models::V2::Crypto]
+        attribute :requested_at, type: :time
+        attribute :took, type: :string
+      end
+    end
+  end
+end

data/lib/brapi/models/v2/currency.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    module V2
+      class Currency < Brapi::Model
+        attribute :from_currency, type: :string
+        attribute :to_currency, type: :string
+        attribute :name, type: :string
+        attribute :high, type: :string
+        attribute :low, type: :string
+        attribute :bid_variation, type: :string
+        attribute :percentage_change, type: :string
+        attribute :bid_price, type: :string
+        attribute :ask_price, type: :string
+        attribute :updated_at_timestamp, type: :string
+        attribute :updated_at_date, type: :string
+      end
+    end
+  end
+end

data/lib/brapi/models/v2/currency_list_available_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    module V2
+      class CurrencyListAvailableResponse < Brapi::Model
+        attribute :currencies
+      end
+    end
+  end
+end

data/lib/brapi/models/v2/currency_retrieve_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    module V2
+      class CurrencyRetrieveResponse < Brapi::Model
+        attribute :currency, type: [Brapi::Models::V2::Currency]
+        attribute :requested_at, type: :time
+        attribute :took, type: :string
+      end
+    end
+  end
+end

data/lib/brapi/models/v2/inflation_entry.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    module V2
+      class InflationEntry < Brapi::Model
+        attribute :date, type: :string
+        attribute :value, type: :string
+        attribute :epoch_date, type: :integer
+      end
+    end
+  end
+end

data/lib/brapi/models/v2/inflation_list_available_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    module V2
+      class InflationListAvailableResponse < Brapi::Model
+        attribute :countries
+      end
+    end
+  end
+end

data/lib/brapi/models/v2/inflation_retrieve_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    module V2
+      class InflationRetrieveResponse < Brapi::Model
+        attribute :inflation, type: [Brapi::Models::V2::InflationEntry]
+        attribute :requested_at, type: :time
+        attribute :took, type: :string
+      end
+    end
+  end
+end

data/lib/brapi/models/v2/prime_rate_entry.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    module V2
+      class PrimeRateEntry < Brapi::Model
+        attribute :date, type: :string
+        attribute :value, type: :string
+        attribute :epoch_date, type: :integer
+      end
+    end
+  end
+end

data/lib/brapi/models/v2/prime_rate_list_available_response.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    module V2
+      class PrimeRateListAvailableResponse < Brapi::Model
+        attribute :countries
+      end
+    end
+  end
+end

data/lib/brapi/models/v2/prime_rate_retrieve_response.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Models
+    module V2
+      class PrimeRateRetrieveResponse < Brapi::Model
+        attribute :prime_rate, type: [Brapi::Models::V2::PrimeRateEntry]
+        attribute :requested_at, type: :time
+        attribute :took, type: :string
+      end
+    end
+  end
+end

data/lib/brapi/resource.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Brapi
+  class Resource
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    private
+
+    def get(path, params: {})
+      client.request(:get, path, params: camelize_keys(params))
+    end
+
+    def camelize_keys(params)
+      return params if params.nil? || params.empty?
+
+      params.each_with_object({}) do |(key, value), out|
+        out[camelize(key.to_s)] = format_value(value)
+      end
+    end
+
+    def camelize(snake)
+      head, *rest = snake.split("_")
+      ([head] + rest.map(&:capitalize)).join
+    end
+
+    def format_value(value)
+      case value
+      when Array then value.join(",")
+      when true  then "true"
+      when false then "false"
+      else value
+      end
+    end
+  end
+end

data/lib/brapi/resources/available.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Resources
+    class Available < Brapi::Resource
+      # GET /api/available
+      def list(**params)
+        raw = get("/api/available", params: params)
+        Brapi::Models::AvailableListResponse.from_h(raw)
+      end
+    end
+  end
+end

data/lib/brapi/resources/quote.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "cgi"
+
+module Brapi
+  module Resources
+    class Quote < Brapi::Resource
+      # GET /api/quote/{tickers}
+      def retrieve(tickers, **params)
+        tickers_str = Array(tickers).join(",")
+        raw = get("/api/quote/#{CGI.escape(tickers_str)}", params: params)
+        Brapi::Models::QuoteRetrieveResponse.from_h(raw)
+      end
+
+      # GET /api/quote/list
+      def list(**params)
+        raw = get("/api/quote/list", params: params)
+        Brapi::Models::QuoteListResponse.from_h(raw)
+      end
+    end
+  end
+end

data/lib/brapi/resources/v2/crypto.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Resources
+    class V2
+      class Crypto < Brapi::Resource
+        # GET /api/v2/crypto
+        def retrieve(**params)
+          raw = get("/api/v2/crypto", params: params)
+          Brapi::Models::V2::CryptoRetrieveResponse.from_h(raw)
+        end
+
+        # GET /api/v2/crypto/available
+        def list_available(**params)
+          raw = get("/api/v2/crypto/available", params: params)
+          Brapi::Models::V2::CryptoListAvailableResponse.from_h(raw)
+        end
+      end
+    end
+  end
+end

data/lib/brapi/resources/v2/currency.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Resources
+    class V2
+      class Currency < Brapi::Resource
+        # GET /api/v2/currency
+        def retrieve(**params)
+          raw = get("/api/v2/currency", params: params)
+          Brapi::Models::V2::CurrencyRetrieveResponse.from_h(raw)
+        end
+
+        # GET /api/v2/currency/available
+        def list_available(**params)
+          raw = get("/api/v2/currency/available", params: params)
+          Brapi::Models::V2::CurrencyListAvailableResponse.from_h(raw)
+        end
+      end
+    end
+  end
+end

data/lib/brapi/resources/v2/inflation.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Resources
+    class V2
+      class Inflation < Brapi::Resource
+        # GET /api/v2/inflation
+        def retrieve(**params)
+          raw = get("/api/v2/inflation", params: params)
+          Brapi::Models::V2::InflationRetrieveResponse.from_h(raw)
+        end
+
+        # GET /api/v2/inflation/available
+        def list_available
+          raw = get("/api/v2/inflation/available")
+          Brapi::Models::V2::InflationListAvailableResponse.from_h(raw)
+        end
+      end
+    end
+  end
+end

data/lib/brapi/resources/v2/prime_rate.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Resources
+    class V2
+      class PrimeRate < Brapi::Resource
+        # GET /api/v2/prime-rate
+        def retrieve(**params)
+          raw = get("/api/v2/prime-rate", params: params)
+          Brapi::Models::V2::PrimeRateRetrieveResponse.from_h(raw)
+        end
+
+        # GET /api/v2/prime-rate/available
+        def list_available
+          raw = get("/api/v2/prime-rate/available")
+          Brapi::Models::V2::PrimeRateListAvailableResponse.from_h(raw)
+        end
+      end
+    end
+  end
+end

data/lib/brapi/resources/v2.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Brapi
+  module Resources
+    class V2
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      def crypto
+        @crypto ||= Brapi::Resources::V2::Crypto.new(client)
+      end
+
+      def currency
+        @currency ||= Brapi::Resources::V2::Currency.new(client)
+      end
+
+      def inflation
+        @inflation ||= Brapi::Resources::V2::Inflation.new(client)
+      end
+
+      def prime_rate
+        @prime_rate ||= Brapi::Resources::V2::PrimeRate.new(client)
+      end
+    end
+  end
+end