ig_markets 0.19 → 0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e6fa29281db18808e948435c5dd1dcb5da3b003
-  data.tar.gz: ef3c666877d55b0c85236e1982b6d6d55713ad90
+  metadata.gz: e0873a06d085af3287d3497f41a7157710216995
+  data.tar.gz: 4606f5cc0084f0092ab1f53361ae3c2ff11f4804
 SHA512:
-  metadata.gz: 01471a39066771f1bbbb4df8faff8c500072af4bd93eef58a246c2669f495a3307d136b190b67c45e27bb4774515aada15d40099caf388ee4459e2c9ec76fab9
-  data.tar.gz: 314ec4b9d9005ae4dd5117dd2ec5380f5338a6a53a4be1d32f0a3592327dc331fa5153f97e5197565badec61dfd6c54863b7449c45f9559670ca0ccb32687179
+  metadata.gz: db11c11960641e5f468b5765e3e790bce4540c3e2f6e468e29ba0b80fda70e7bd3aab20cdcae5e37f3c86fd2a26a59afc39dde7d22ece0ab8abf9524c254acea
+  data.tar.gz: 6d27114ba6ba7811f767a022643f176bc77ad69d669c8e81b2637c82b321a611cb355bcf4b91bd3e8b0ca30fc4899705b4bb5d8902807b58e4bac96c654b9632

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # IG Markets Changelog
 
+### 0.20 — August 20, 2016
+
+- Added `IGMarkets::DealingPlatform#streaming` which along with new classes in the `IGMarkets::Streaming` module
+  provides a simple interface to the IG Markets streaming API
+- Added `ig_markets stream` command that shows a live display of account balances, positions and working orders, the
+  previous behavior of showing raw streaming output is still available using `ig_markets stream raw`
+- Added new `IGMarkets::Position#deal_reference` attribute
+- The `ig_markets self-test` command now runs self-tests on the streaming functionality as well
+- Removed `IGMarkets::DealingPlatform#lightstreamer_session`
+
 ### 0.19 — August 5, 2016
 
 - Added `ig_markets stream` command that displays live streaming data for accounts, markets and trading activity

data/README.md

@@ -22,6 +22,7 @@ Includes support for:
 - Watchlists
 - Client sentiment
 - Authentication profiles
+- Live streaming of account, trade and market updates
 
 An IG Markets live or demo trading account is needed in order to use this gem.
 
@@ -100,7 +101,8 @@ commands and their subcommands is:
 - `ig_markets sentiment MARKET`
 - `ig_markets sprints [list]`
 - `ig_markets sprints create ...`
-- `ig_markets stream ...`
+- `ig_markets stream [dashboard] [...]`
+- `ig_markets stream raw ...`
 - `ig_markets transactions --days N [...]`
 - `ig_markets watchlists [list]`
 - `ig_markets watchlists create NAME [EPIC ...]`
@@ -152,8 +154,11 @@ ig_markets prices --epic CS.D.EURUSD.CFD.IP --resolution day --number 14
 # Print account dealing performance from the last 90 days, broken down by the EPICs that were traded
 ig_markets performance --days 90
 
-# Print streaming details of account balances, trading actions, and the live price of the EURUSD pair
-ig_markets stream --accounts --trades --markets CS.D.EURUSD.CFD.IP
+# Print an updating live display of account balances, positions and working orders
+ig_markets stream
+
+# Print raw streaming details of account balances, trading actions, and the price of the EURUSD pair
+ig_markets stream raw --accounts --trades --markets CS.D.EURUSD.CFD.IP
 
 # Log in and open a Ruby console which can be used to query the IG API, printing all REST requests
 ig_markets console --verbose
@@ -235,6 +240,23 @@ client_sentiment.reload
 
 # Miscellaneous
 ig.applications
+
+# Streaming
+queue = Queue.new
+
+ig.streaming.connect
+ig.streaming.on_error { |error| queue.push error }
+
+subscription = ig.streaming.build_accounts_subscription
+subscription.on_data { |data, _merged_data| queue.push data }
+ig.streaming.start_subscriptions subscription, snapshot: true
+
+loop do
+  data = queue.pop
+  raise data if data.is_a? Lightstreamer::LightstreamerError
+
+  puts data.inspect
+end
 ```
 
 ## Contributors

data/lib/ig_markets.rb

@@ -30,6 +30,7 @@ require 'ig_markets/dealing_platform/client_sentiment_methods'
 require 'ig_markets/dealing_platform/market_methods'
 require 'ig_markets/dealing_platform/position_methods'
 require 'ig_markets/dealing_platform/sprint_market_position_methods'
+require 'ig_markets/dealing_platform/streaming_methods'
 require 'ig_markets/dealing_platform/watchlist_methods'
 require 'ig_markets/dealing_platform/working_order_methods'
 require 'ig_markets/errors'
@@ -46,6 +47,15 @@ require 'ig_markets/request_printer'
 require 'ig_markets/response_parser'
 require 'ig_markets/session'
 require 'ig_markets/sprint_market_position'
+require 'ig_markets/streaming/account_state'
+require 'ig_markets/streaming/account_update'
+require 'ig_markets/streaming/chart_tick_update'
+require 'ig_markets/streaming/consolidated_chart_data_update'
+require 'ig_markets/streaming/market_subscription_manager'
+require 'ig_markets/streaming/market_update'
+require 'ig_markets/streaming/position_update'
+require 'ig_markets/streaming/subscription'
+require 'ig_markets/streaming/working_order_update'
 require 'ig_markets/transaction'
 require 'ig_markets/version'
 require 'ig_markets/watchlist'
@@ -54,9 +64,11 @@ require 'ig_markets/working_order'
 require 'ig_markets/cli/commands/orders_command'
 require 'ig_markets/cli/commands/positions_command'
 require 'ig_markets/cli/commands/sprints_command'
+require 'ig_markets/cli/commands/stream_command'
 require 'ig_markets/cli/commands/watchlists_command'
 require 'ig_markets/cli/main'
 require 'ig_markets/cli/config_file'
+require 'ig_markets/cli/curses_window'
 require 'ig_markets/cli/commands/account_command'
 require 'ig_markets/cli/commands/activities_command'
 require 'ig_markets/cli/commands/confirmation_command'
@@ -67,7 +79,6 @@ require 'ig_markets/cli/commands/prices_command'
 require 'ig_markets/cli/commands/search_command'
 require 'ig_markets/cli/commands/self_test_command'
 require 'ig_markets/cli/commands/sentiment_command'
-require 'ig_markets/cli/commands/stream_command'
 require 'ig_markets/cli/commands/transactions_command'
 require 'ig_markets/cli/tables/table'
 require 'ig_markets/cli/tables/accounts_table'
@@ -85,4 +96,8 @@ require 'ig_markets/cli/tables/working_orders_table'
 # This module contains all the code for the IG Markets gem. See `README.md` and the {DealingPlatform} class to get
 # started with using this gem.
 module IGMarkets
+  # This module contains classes used when streaming live data from the IG Markets API. See
+  # {DealingPlatform::StreamingMethods} for details.
+  module Streaming
+  end
 end

data/lib/ig_markets/cli/commands/self_test_command.rb

@@ -8,7 +8,8 @@ module IGMarkets
         self.class.begin_session(options) do |dealing_platform|
           raise 'Error: self-tests must be run on a demo account' unless dealing_platform.session.platform == :demo
 
-          run_self_test dealing_platform
+          @dealing_platform = dealing_platform
+          run_self_test
 
           dealing_platform.sign_out
         end
@@ -16,36 +17,38 @@ module IGMarkets
 
       private
 
-      def run_self_test(dealing_platform)
-        test_markets dealing_platform
-        test_positions dealing_platform
-        test_sprint_market_positions dealing_platform
-        test_working_orders dealing_platform
-        test_watchlists dealing_platform
-        test_client_sentiment dealing_platform
-        test_account_methods dealing_platform
-        test_applications dealing_platform
-      end
-
-      def test_markets(dealing_platform)
-        dealing_platform.markets.hierarchy '264134' # ID of the main 'Forex' node
-        dealing_platform.markets.search 'EURUSD'
-        @eur_usd = dealing_platform.markets['CS.D.EURUSD.CFD.IP']
-        @eur_usd_sprint = dealing_platform.markets['FM.D.EURUSD24.EURUSD24.IP']
+      def run_self_test
+        test_markets
+        test_positions
+        test_sprint_market_positions
+        test_working_orders
+        test_watchlists
+        test_client_sentiment
+        test_account_methods
+        test_applications
+        test_streaming
+      end
+
+      def test_markets
+        @dealing_platform.markets.hierarchy '264134' # ID of the main 'Forex' node
+        @dealing_platform.markets.search 'EURUSD'
+        @eur_usd = @dealing_platform.markets['CS.D.EURUSD.CFD.IP']
+        @eur_usd_sprint = @dealing_platform.markets['FM.D.EURUSD24.EURUSD24.IP']
         @eur_usd.historical_prices resolution: :hour, number: 1
       end
 
-      def test_positions(dealing_platform)
-        test_position_create dealing_platform
+      def test_positions
+        test_position_create
         test_position_update
-        test_position_close dealing_platform
+        test_position_close
       end
 
-      def test_position_create(dealing_platform)
-        deal_reference = dealing_platform.positions.create currency_code: 'USD', direction: :buy,
-                                                           epic: 'CS.D.EURUSD.CFD.IP', size: 2
+      def test_position_create
+        deal_reference = @dealing_platform.positions.create currency_code: 'USD', direction: :buy,
+                                                            epic: 'CS.D.EURUSD.CFD.IP', size: 2
 
-        @position = dealing_platform.positions[dealing_platform.deal_confirmation(deal_reference).deal_id]
+        deal_confirmation = @dealing_platform.deal_confirmation deal_reference
+        @position = @dealing_platform.positions[deal_confirmation.deal_id]
 
         raise 'Error: failed creating position' unless @position
       end
@@ -61,81 +64,97 @@ module IGMarkets
         raise 'Error: failed updating position' unless update_worked
       end
 
-      def test_position_close(dealing_platform)
+      def test_position_close
         @position.close
 
-        raise 'Error: failed closing position' if dealing_platform.positions[@position.deal_id]
+        raise 'Error: failed closing position' if @dealing_platform.positions[@position.deal_id]
       end
 
-      def test_sprint_market_positions(dealing_platform)
-        deal_reference = dealing_platform.sprint_market_positions.create direction: :buy,
-                                                                         epic: 'FM.D.EURUSD24.EURUSD24.IP',
-                                                                         expiry_period: :twenty_minutes, size: 100
+      def test_sprint_market_positions
+        create_options = { direction: :buy, expiry_period: :sixty_minutes, epic: 'FM.D.EURUSD24.EURUSD24.IP',
+                           size: 100 }
 
-        deal_confirmation = dealing_platform.deal_confirmation deal_reference
-
-        sprint_market_position = dealing_platform.sprint_market_positions[deal_confirmation.deal_id]
+        deal_reference = @dealing_platform.sprint_market_positions.create create_options
+        deal_confirmation = @dealing_platform.deal_confirmation deal_reference
+        sprint_market_position = @dealing_platform.sprint_market_positions[deal_confirmation.deal_id]
 
         raise 'Error: failed creating sprint market position' unless sprint_market_position
       end
 
-      def test_working_orders(dealing_platform)
-        test_working_order_create dealing_platform
-        test_working_order_update dealing_platform
-        test_working_order_delete dealing_platform
+      def test_working_orders
+        test_working_order_create
+        test_working_order_update
+        test_working_order_delete
       end
 
-      def test_working_order_create(dealing_platform)
-        deal_reference = dealing_platform.working_orders.create currency_code: 'USD', direction: :buy,
-                                                                epic: 'CS.D.EURUSD.CFD.IP', type: :limit,
-                                                                level: @eur_usd.snapshot.bid - 0.1, size: 1
+      def test_working_order_create
+        deal_reference = @dealing_platform.working_orders.create currency_code: 'USD', direction: :buy,
+                                                                 epic: 'CS.D.EURUSD.CFD.IP', type: :limit,
+                                                                 level: @eur_usd.snapshot.bid - 0.1, size: 1
 
-        @working_order = dealing_platform.working_orders[dealing_platform.deal_confirmation(deal_reference).deal_id]
+        @working_order = @dealing_platform.working_orders[@dealing_platform.deal_confirmation(deal_reference).deal_id]
 
         raise 'Error: failed creating working order' unless @working_order
       end
 
-      def test_working_order_update(dealing_platform)
+      def test_working_order_update
         new_level = @eur_usd.snapshot.bid - 1
 
         @working_order.update level: new_level
         @working_order.reload
 
-        update_worked = (new_level - dealing_platform.working_orders[@working_order.deal_id].order_level).abs < 0.01
+        update_worked = (new_level - @dealing_platform.working_orders[@working_order.deal_id].order_level).abs < 0.01
 
         raise 'Error: failed updating working order' unless update_worked
       end
 
-      def test_working_order_delete(dealing_platform)
+      def test_working_order_delete
         @working_order.delete
 
-        raise 'Error: failed deleting working order' if dealing_platform.working_orders[@working_order.deal_id]
+        raise 'Error: failed deleting working order' if @dealing_platform.working_orders[@working_order.deal_id]
       end
 
-      def test_watchlists(dealing_platform)
-        watchlist = dealing_platform.watchlists.create SecureRandom.hex, 'UA.D.AAPL.CASH.IP'
-        watchlist = dealing_platform.watchlists[watchlist.id]
+      def test_watchlists
+        watchlist = @dealing_platform.watchlists.create SecureRandom.hex, 'UA.D.AAPL.CASH.IP'
+        watchlist = @dealing_platform.watchlists[watchlist.id]
         watchlist.markets
         watchlist.add_market 'CS.D.EURUSD.CFD.IP'
         watchlist.remove_market 'CS.D.EURUSD.CFD.IP'
         watchlist.delete
 
-        raise 'Error: failed deleting watchlist' if dealing_platform.watchlists[watchlist.id]
+        raise 'Error: failed deleting watchlist' if @dealing_platform.watchlists[watchlist.id]
+      end
+
+      def test_account_methods
+        @dealing_platform.account.all
+        @dealing_platform.account.activities from: Date.today - 14
+        @dealing_platform.account.transactions from: Date.today - 14
       end
 
-      def test_account_methods(dealing_platform)
-        dealing_platform.account.all
-        dealing_platform.account.activities from: Date.today - 14
-        dealing_platform.account.transactions from: Date.today - 14
+      def test_client_sentiment
+        @dealing_platform.client_sentiment['EURUSD'].related_sentiments
       end
 
-      def test_client_sentiment(dealing_platform)
-        client_sentiment = dealing_platform.client_sentiment['EURUSD']
-        client_sentiment.related_sentiments
+      def test_applications
+        @dealing_platform.applications
       end
 
-      def test_applications(dealing_platform)
-        dealing_platform.applications
+      def test_streaming
+        streaming = @dealing_platform.streaming
+
+        streaming.connect
+
+        subscriptions = [streaming.build_accounts_subscription,
+                         streaming.build_markets_subscription(['CS.D.EURUSD.CFD.IP']),
+                         streaming.build_trades_subscription]
+
+        streaming.start_subscriptions subscriptions, snapshot: true
+
+        queue = Queue.new
+        subscriptions.each { |subscription| subscription.on_data { |data| queue.push data } }
+        10.times { queue.pop }
+
+        streaming.disconnect
       end
     end
   end

data/lib/ig_markets/cli/commands/stream_command.rb

@@ -1,170 +1,118 @@
 module IGMarkets
   module CLI
     # Implements the `ig_markets stream` command.
-    class Main < Thor
-      desc 'stream', 'Displays live streaming updates of account balances, markets and trading activity'
+    class Stream < Thor
+      desc 'dashboard', 'Displays an updating live display of account balances, positions and working orders'
 
-      option :accounts, type: :boolean, desc: 'Whether to stream changes to account balances'
-      option :markets, type: :array, desc: 'The EPICs of the markets to stream live prices for'
-      option :trades, type: :boolean, desc: 'Whether to stream details of any trades and position or order updates'
+      option :aggregate, type: :boolean, desc: 'Whether to aggregate separate positions in the same market'
 
-      def stream
-        self.class.begin_session(options) do |dealing_platform|
-          @dealing_platform = dealing_platform
+      def dashboard
+        Main.begin_session(options) do |dealing_platform|
+          dealing_platform.streaming.connect
+          dealing_platform.streaming.on_error { |error| @error = error }
+
+          window = CursesWindow.new
 
-          prepare_stream
+          account_state = Streaming::AccountState.new dealing_platform
+          account_state.start
 
-          loop { process_new_data @queue.pop }
+          redraw_account_state account_state, window until @error
+
+          raise @error
         end
       end
 
-      private
+      default_task :dashboard
 
-      def process_new_data(data)
-        raise data if data.is_a? Lightstreamer::LightstreamerError
+      desc 'raw', 'Displays raw live streaming updates of account balances, markets and trading activity'
 
-        puts data
-      end
+      option :accounts, type: :boolean, desc: 'Whether to stream changes to account balances'
+      option :markets, type: :array, desc: 'The EPICs of the markets to stream live prices for'
+      option :trades, type: :boolean, desc: 'Whether to stream details of any trades and position or order updates'
+      option :chart_ticks, type: :array, desc: 'The EPICs of the markets to stream live chart tick data for'
 
-      def prepare_stream
-        @queue = Queue.new
+      def raw
+        Main.begin_session(options) do |dealing_platform|
+          @dealing_platform = dealing_platform
+          @queue = Queue.new
 
-        @lightstreamer = @dealing_platform.lightstreamer_session
-        @lightstreamer.on_error { |error| @queue.push error }
-        @lightstreamer.connect
+          @dealing_platform.streaming.on_error(&method(:on_error))
+          @dealing_platform.streaming.connect
+          start_raw_subscriptions
 
-        subscriptions = [account_subscription, market_subscription, trade_subscription].compact
-        @lightstreamer.bulk_subscription_start subscriptions, snapshot: true
+          main_loop
+        end
       end
 
-      def account_subscription
-        return unless options[:accounts]
-
-        items = @dealing_platform.client_account_summary.accounts.map { |account| "ACCOUNT:#{account.account_id}" }
-        fields = [:pnl, :deposit, :available_cash, :funds, :margin, :available_to_deal, :equity]
+      private
 
-        subscription = @lightstreamer.build_subscription items: items, fields: fields, mode: :merge
+      def start_raw_subscriptions
+        subscriptions = [accounts_subscription, markets_subscription, trades_subscription,
+                         chart_ticks_subscription].compact
 
-        subscription.on_data do |_subscription, item_name, item_data, _new_data|
-          @queue.push "#{item_name} - #{item_data.map { |key, value| "#{key}: #{value}" }.join ', '}"
+        subscriptions.each do |subscription|
+          subscription.on_data(&method(:on_data))
         end
 
-        subscription
+        @dealing_platform.streaming.start_subscriptions subscriptions, snapshot: true
       end
 
-      def market_subscription
-        items = Array(options[:markets]).map { |market| "MARKET:#{market}" }
-        fields = [:bid, :offer, :high, :low, :mid_open, :strike_price, :odds]
+      def accounts_subscription
+        return unless options[:accounts]
 
-        subscription = @lightstreamer.build_subscription items: items, fields: fields, mode: :merge
+        @dealing_platform.streaming.build_accounts_subscription
+      end
 
-        subscription.on_data do |_subscription, item_name, item_data, _new_data|
-          @queue.push "#{item_name} - #{item_data.map { |key, value| "#{key}: #{value}" }.join ', '}"
-        end
+      def markets_subscription
+        return unless options[:markets]
 
-        subscription
+        @dealing_platform.streaming.build_markets_subscription options[:markets]
       end
 
-      def trade_subscription
+      def trades_subscription
         return unless options[:trades]
 
-        items = @dealing_platform.client_account_summary.accounts.map { |account| "TRADE:#{account.account_id}" }
-        fields = [:confirms, :opu, :wou]
-
-        subscription = @lightstreamer.build_subscription items: items, fields: fields, mode: :distinct
-
-        subscription.on_data do |_subscription, item_name, item_data, _new_data|
-          process_confirmation item_name, item_data[:confirms]
-          process_position_update item_name, item_data[:opu]
-          process_working_order_update item_name, item_data[:wou]
-        end
-
-        subscription
+        @dealing_platform.streaming.build_trades_subscription
       end
 
-      def process_confirmation(item_name, json)
-        return unless json
-
-        model = DealConfirmation.new ResponseParser.parse(JSON.parse(json)).merge(affected_deals: nil)
+      def chart_ticks_subscription
+        return unless options[:chart_ticks]
 
-        queue_item = "#{item_name} - Confirmation - id: #{model.deal_id}"
+        @dealing_platform.streaming.build_chart_ticks_subscription options[:chart_ticks]
+      end
 
-        [:status, :deal_status, :epic, :direction, :size, :level, :stop_distance, :stop_level, :limit_distance,
-         :limit_level].each do |attribute|
-          value = model.send attribute
-          queue_item << ", #{attribute}: #{value}" if value
+      def on_data(data, _merged_data)
+        if data.is_a? DealConfirmation
+          data.affected_deals = nil
+          data.date = nil
         end
 
-        queue_item << ", profit: #{Format.currency(model.profit, model.profit_currency)}" if model.profit
+        summary = data.attributes.keys.sort.map { |key| "#{key}: #{data.send key}" if data.send key }
 
-        @queue.push queue_item
+        @queue.push "#{data.class.name.split('::').last} - #{summary.compact.join ', '}"
       end
 
-      def process_position_update(item_name, json)
-        return unless json
-
-        model = OpenPositionUpdate.new ResponseParser.parse(JSON.parse(json))
-
-        queue_item = "#{item_name} - Position update - id: #{model.deal_id}"
-
-        [:status, :deal_status, :epic, :direction, :size, :level, :stop_level, :limit_level].each do |attribute|
-          value = model.send attribute
-          queue_item << ", #{attribute}: #{value}" if value
-        end
-
-        @queue.push queue_item
+      def on_error(error)
+        @queue.push error
       end
 
-      def process_working_order_update(item_name, json)
-        return unless json
+      def main_loop
+        loop do
+          data = @queue.pop
+          raise data if data.is_a? Lightstreamer::LightstreamerError
 
-        model = WorkingOrderUpdate.new ResponseParser.parse(JSON.parse(json))
-
-        queue_item = "#{item_name} - Order update - id: #{model.deal_id}"
-
-        [:status, :deal_status, :epic, :direction, :size, :level, :stop_distance, :limit_distance].each do |attribute|
-          value = model.send attribute
-          queue_item << ", #{attribute}: #{value}" if value
+          puts data
         end
-
-        @queue.push queue_item
       end
 
-      # Internal model used to parse streaming open position updates.
-      class OpenPositionUpdate < Model
-        attribute :channel
-        attribute :deal_id
-        attribute :deal_id_origin
-        attribute :deal_reference
-        attribute :deal_status, Symbol, allowed_values: [:accepted, :rejected]
-        attribute :direction, Symbol, allowed_values: [:buy, :sell]
-        attribute :epic, String, regex: Regex::EPIC
-        attribute :expiry, Date, nil_if: %w(- DFB), format: ['%d-%b-%y', '%b-%y']
-        attribute :guaranteed_stop, Boolean
-        attribute :level, Float
-        attribute :limit_level, Float
-        attribute :size, Float
-        attribute :status, Symbol, allowed_values: [:deleted, :open, :updated]
-        attribute :stop_level, Float
-        attribute :timestamp, Time, format: '%FT%T.%L'
-      end
+      def redraw_account_state(account_state, window)
+        account_state.process_queued_data
 
-      # Internal model used to parse streaming working order updates.
-      class WorkingOrderUpdate < Model
-        attribute :channel
-        attribute :deal_id
-        attribute :deal_reference
-        attribute :deal_status, Symbol, allowed_values: [:accepted, :rejected]
-        attribute :direction, Symbol, allowed_values: [:buy, :sell]
-        attribute :epic, String, regex: Regex::EPIC
-        attribute :expiry, Date, nil_if: %w(- DFB), format: ['%d-%b-%y', '%b-%y']
-        attribute :guaranteed_stop, Boolean
-        attribute :level, Float
-        attribute :limit_distance, Fixnum
-        attribute :size, Float
-        attribute :status, Symbol, allowed_values: [:deleted, :open, :updated]
-        attribute :stop_distance, Fixnum
-        attribute :timestamp, Time, format: '%FT%T.%L'
+        window.clear
+        window.print_lines AccountsTable.new(account_state.accounts).lines, '',
+                           PositionsTable.new(account_state.positions, aggregate: options[:aggregate]).lines, '',
+                           WorkingOrdersTable.new(account_state.working_orders).lines, ''
+        window.refresh
       end
     end
   end