reviewing against franton code (#19)

* reviewing against franton code

* reducing credo issues

Author: Bodhert

apps/binance_mock/lib/binance_mock.ex

@@ -7,6 +7,29 @@ defmodule BinanceMock do
 
   alias Decimal
   alias Core.Struct.TradeEvent
+  alias Binance.Order
+  alias Binance.OrderResponse
+  alias Core.Struct.TradeEvent
+
+  @type symbol :: binary
+  @type quantity :: binary
+  @type price :: binary
+  @type time_in_force :: binary
+  @type timestamp :: non_neg_integer
+  @type order_id :: non_neg_integer
+  @type orig_client_order_id :: binary
+  @type recv_window :: binary
+
+  @callback order_limit_buy(symbol, quantity, price, time_in_force) ::
+              {:ok, %OrderResponse{}} | {:error, term}
+
+  @callback order_limit_sell(symbol, quantity, price, time_in_force) ::
+              {:ok, %OrderResponse{}} | {:error, term}
+
+  @callback get_order(symbol, timestamp, order_id) ::
+              {:ok, %Order{}} | {:error, term}
+
+  @callback get_exchange_info() :: {:ok, Binance.ExchangeInfo} | {:error, term}
 
   require Logger
 
@@ -51,6 +74,42 @@ defmodule BinanceMock do
     GenServer.call(__MODULE__, {:get_order, symbol, time, order_id})
   end
 
+  def generate_fake_order(order_id, symbol, quantity, price, side)
+      when is_binary(symbol) and is_binary(quantity) and is_binary(price) and
+             (side == "BUY" or side == "SELL") do
+    current_timestamp = :os.system_time(:millisecond)
+    client_order_id = :crypto.hash(:md5, "#{order_id}") |> Base.encode16()
+
+    Binance.Order.new(%{
+      symbol: symbol,
+      order_id: order_id,
+      client_order_id: client_order_id,
+      price: price,
+      orig_qty: quantity,
+      executed_qty: "0.00000000",
+      cummulative_quote_qty: "0.00000000",
+      status: "NEW",
+      time_in_force: "GTC",
+      type: "LIMIT",
+      side: side,
+      stop_price: "0.00000000",
+      iceberg_qty: "0.00000000",
+      time: current_timestamp,
+      update_time: current_timestamp,
+      is_working: true
+    })
+  end
+
+  def convert_order_to_order_response(%Binance.Order{} = order) do
+    %{
+      struct(
+        Binance.OrderResponse,
+        order |> Map.to_list()
+      )
+      | transact_time: order.time
+    }
+  end
+
   def handle_cast(
         {:add_order, %Binance.Order{symbol: symbol} = order},
         %State{order_books: order_books, subscriptions: subscriptions} = state
@@ -104,7 +163,7 @@ defmodule BinanceMock do
       |> Enum.drop(length(filled_sell_orders))
 
     order_books =
-      Map.replace(order_books, :"#{trade_event.symbol}", %{
+      Map.replace!(order_books, :"#{trade_event.symbol}", %{
         buy_side: remaining_buy_orders,
         sell_side: remaining_sell_orders,
         historical: filled_buy_orders ++ filled_sell_orders ++ order_book.historical
@@ -114,7 +173,10 @@ defmodule BinanceMock do
   end
 
   defp order_limit(symbol, quantity, price, side) do
-    %Binance.Order{} = fake_order = generate_fake_order(symbol, quantity, price, side)
+    %Binance.Order{} =
+      fake_order =
+      generate_fake_order(GenServer.call(__MODULE__, :generate_id), symbol, quantity, price, side)
+
     GenServer.cast(__MODULE__, {:add_order, fake_order})
     {:ok, convert_order_to_order_response(fake_order)}
   end
@@ -159,43 +221,6 @@ defmodule BinanceMock do
     Map.put(order_books, :"#{symbol}", order_book)
   end
 
-  defp generate_fake_order(symbol, quantity, price, side)
-       when is_binary(symbol) and is_binary(quantity) and is_binary(price) and
-              (side == "BUY" or side == "SELL") do
-    current_timestamp = :os.system_time(:millisecond)
-    order_id = GenServer.call(__MODULE__, :generate_id)
-    client_order_id = :crypto.hash(:md5, "#{order_id}") |> Base.encode16()
-
-    Binance.Order.new(%{
-      symbol: symbol,
-      order_id: order_id,
-      client_order_id: client_order_id,
-      price: price,
-      orig_qty: quantity,
-      executed_qty: "0.00000000",
-      cummulative_quote_qty: "0.00000000",
-      status: "NEW",
-      time_in_force: "GTC",
-      type: "LIMIT",
-      side: side,
-      stop_price: "0.00000000",
-      iceberg_qty: "0.00000000",
-      time: current_timestamp,
-      update_time: current_timestamp,
-      is_working: true
-    })
-  end
-
-  defp convert_order_to_order_response(%Binance.Order{} = order) do
-    %{
-      struct(
-        Binance.OrderResponse,
-        order |> Map.to_list()
-      )
-      | transact_time: order.time
-    }
-  end
-
   defp convert_order_to_event(%Binance.Order{} = order, time) do
     %TradeEvent{
       event_type: order.type,

apps/binance_mock/mix.exs

@@ -27,10 +27,10 @@ defmodule BinanceMock.MixProject do
   defp deps do
     [
       {:binance, "~> 1.0"},
-      {:decimal, "~> 2.0"},
-      {:phoenix_pubsub, "~> 2.0"},
       {:core, in_umbrella: true},
-      {:jason, "~> 1.2"}
+      {:decimal, "~> 2.0"},
+      {:jason, "~> 1.2"},
+      {:phoenix_pubsub, "~> 2.0"}
     ]
   end
 end

apps/core/lib/core/test.ex

@@ -0,0 +1,29 @@
+defmodule Core.Test do
+  @moduledoc """
+  Module for mocking external dependies in which we do not have
+  control of.
+  """
+
+  defmodule PubSub do
+    @moduledoc """
+    Pub sub mock
+    """
+
+    @type t :: atom
+    @type topic :: binary
+    @type message :: term
+
+    @callback subscribe(t, topic) :: :ok | {:error, term}
+    @callback broadcast(t, topic, message) :: :ok | {:error, term}
+  end
+
+  defmodule Logger do
+    @moduledoc """
+    Logger mock
+    """
+
+    @type message :: binary
+
+    @callback info(message) :: :ok
+  end
+end

apps/data_warehouse/mix.exs

@@ -27,11 +27,11 @@ defmodule DataWarehouse.MixProject do
   defp deps do
     [
       {:binance, "~> 1.0"},
+      {:core, in_umbrella: true},
       {:ecto_sql, "~> 3.0"},
       {:ecto_enum, "~> 1.4"},
       {:phoenix_pubsub, "~> 2.0"},
-      {:postgrex, ">= 0.0.0"},
-      {:core, in_umbrella: true}
+      {:postgrex, ">= 0.0.0"}
     ]
   end
 end

apps/naive/lib/naive/leader.ex

@@ -7,9 +7,11 @@ defmodule Naive.Leader do
   alias Naive.Repo
   alias Naive.Schema.Settings
   alias Naive.Trader
-
   require Logger
 
+  @type event_type :: atom
+  @callback notify(event_type, %Trader.State{}) :: :ok
+
   @binance_client Application.compile_env(:naive, :binance_client)
 
   defmodule State do

apps/naive/lib/naive/trader.ex

@@ -5,11 +5,13 @@ defmodule Naive.Trader do
 
   use GenServer, restart: :temporary
 
-  require Logger
-
   alias Core.Struct.TradeEvent
+  require Logger
 
   @binance_client Application.compile_env(:naive, :binance_client)
+  @leader Application.compile_env(:naive, :leader)
+  @logger Application.compile_env(:core, :logger)
+  @pubsub_client Application.compile_env(:core, :pubsub_client)
   defmodule State do
     @moduledoc """
     Trader State
@@ -47,9 +49,9 @@ defmodule Naive.Trader do
   def init(%State{id: id, symbol: symbol} = state) do
     symbol = String.upcase(symbol)
 
-    Logger.info("Initializing new trader(#{id}) for #{symbol}")
+    @logger.info("Initializing new trader(#{id}) for #{symbol}")
 
-    Phoenix.PubSub.subscribe(Core.PubSub, "TRADE_EVENTS:#{symbol}")
+    @pubsub_client.subscribe(Core.PubSub, "TRADE_EVENTS:#{symbol}")
 
     {:ok, state}
   end
@@ -69,7 +71,7 @@ defmodule Naive.Trader do
     price = calculate_buy_price(price, buy_down_interval, tick_size)
     quantity = calculate_quantity(budget, price, step_size)
 
-    Logger.info(
+    @logger.info(
       "The trader(#{id}) is placing a BUY order " <>
         "for #{symbol} @ #{price}, quantity: #{quantity}"
     )
@@ -80,7 +82,7 @@ defmodule Naive.Trader do
     :ok = broadcast_order(order)
 
     new_state = %{state | buy_order: order}
-    Naive.Leader.notify(:trader_state_updated, new_state)
+    @leader.notify(:trader_state_updated, new_state)
 
     {:noreply, new_state}
   end
@@ -125,7 +127,7 @@ defmodule Naive.Trader do
       if buy_order.status == "FILLED" do
         sell_price = calculate_sell_price(buy_price, profit_interval, tick_size)
 
-        Logger.info(
+        @logger.info(
           "The trader(#{id}) is placing a SELL order for " <>
             "#{symbol} @ #{sell_price}, quantity: #{quantity}."
         )
@@ -137,12 +139,12 @@ defmodule Naive.Trader do
 
         {:ok, %{state | buy_order: buy_order, sell_order: order}}
       else
-        Logger.info("Trader's(#{id} #{symbol} buy order got partially filled")
+        @logger.info("Trader's(#{id} #{symbol} buy order got partially filled")
 
         {:ok, %{state | buy_order: buy_order}}
       end
 
-    Naive.Leader.notify(:trader_state_updated, new_state)
+    @leader.notify(:trader_state_updated, new_state)
 
     {:noreply, new_state}
   end
@@ -169,12 +171,12 @@ defmodule Naive.Trader do
     sell_order = %{sell_order | status: current_sell_order.status}
 
     if sell_order.status == "FILLED" do
-      Logger.info("Trader(#{id}) finished trade cycle for #{symbol}")
+      @logger.info("Trader(#{id}) finished trade cycle for #{symbol}")
       {:stop, :normal, state}
     else
-      Logger.info("Trader's(#{id} #{symbol} SELL order got partially filled")
+      @logger.info("Trader's(#{id} #{symbol} SELL order got partially filled")
       new_state = %{state | sell_order: sell_order}
-      Naive.Leader.notify(:trader_state_updated, new_state)
+      @leader.notify(:trader_state_updated, new_state)
       {:noreply, new_state}
     end
   end
@@ -190,9 +192,9 @@ defmodule Naive.Trader do
         } = state
       ) do
     if trigger_rebuy?(buy_price, current_price, rebuy_interval) do
-      Logger.info("Rebuy triggered for #{symbol} by the trader(#{id})")
+      @logger.info("Rebuy triggered for #{symbol} by the trader(#{id})")
       new_state = %{state | rebuy_notified: true}
-      Naive.Leader.notify(:rebuy_triggered, new_state)
+      @leader.notify(:rebuy_triggered, new_state)
       {:noreply, new_state}
     else
       {:noreply, state}
@@ -252,7 +254,7 @@ defmodule Naive.Trader do
   end
 
   defp broadcast_order(%Binance.Order{} = order) do
-    Phoenix.PubSub.broadcast(Core.PubSub, "ORDERS:#{order.symbol}", order)
+    @pubsub_client.broadcast(Core.PubSub, "ORDERS:#{order.symbol}", order)
   end
 
   defp convert_to_order(%Binance.OrderResponse{} = response) do

apps/naive/mix.exs

@@ -15,7 +15,14 @@ defmodule Naive.MixProject do
       elixirc_options: [
         warnings_as_errors: true
       ],
-      aliases: aliases()
+      aliases: aliases(),
+      elixirc_paths: elixirc_paths(Mix.env())
+    ]
+  end
+
+  defp aliases() do
+    [
+      seed: ["run priv/seed_settings.exs"]
     ]
   end
 
@@ -39,13 +46,11 @@ defmodule Naive.MixProject do
       {:ecto_enum, "~> 1.4"},
       {:phoenix_pubsub, "~> 2.0"},
       {:postgrex, ">= 0.0.0"},
-      {:sobelow, "~> 0.13", only: [:dev, :test], runtime: false}
+      {:sobelow, "~> 0.13", only: [:dev, :test], runtime: false},
+      {:mox, "~> 1.0", only: [:test, :integration]}
     ]
   end
 
-  defp aliases() do
-    [
-      seed: ["run priv/seed_settings.exs"]
-    ]
-  end
+  defp elixirc_paths(:test), do: ["test/support", "lib"]
+  defp elixirc_paths(_), do: ["lib"]
 end