mailchain_connector_imap 0.1.4

data/lib/connection/imap.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+require 'net/imap'
+require 'pstore'
+require_relative '../connection_configuration/imap'
+
+# Handles the Imap configuration and connection
+class ConnectionImap
+  STORE_PATH = "#{ENV['HOME']}/.mailchain_connector/imap/"
+  STORE_FILE = File.join(STORE_PATH, 'mailchain_connector_imap.pstore')
+
+  # reads the config file and sets `@config`
+  def initialize(config, config_file)
+    get_or_create_pstore
+    @config = config
+    @config_file = config_file
+  end
+
+  # Check for pstore, and create if not exist
+  def get_or_create_pstore
+    (FileUtils.mkdir_p(STORE_PATH) unless File.exist?(STORE_FILE))
+    @pstore = PStore.new(STORE_FILE, true)
+  end
+
+  # Records in pstore with the MD5 hexdigest of message_id as key, with prefix 'append_'  and value as true.
+  # Stored as md5 hash to obfuscate message ids.
+  def store_msg_appended(message_id)
+    message_id_hash = Digest::MD5.hexdigest(message_id)
+    @pstore.transaction { @pstore['append_' + message_id_hash] = true }
+  end
+
+  # Checks if MD5 hexdigest of message_id as key, with prefix 'append_' returns a true value from the database.
+  # Stored as md5 hash to obfuscate message ids.
+  # Returns true or false
+  def msg_appended?(message_id)
+    message_id_hash = Digest::MD5.hexdigest(message_id)
+    @pstore.transaction { @pstore['append_' + message_id_hash] } == true
+  end
+
+  # # Run the IMAP configuration
+  def configuration_wizard
+    connection_configuration = ConnectionConfigurationImap.new(@config)
+    result = connection_configuration.configuration_wizard
+    if result['save']
+      result['config']['imap'].delete('password')
+      new_config_json = JSON.pretty_generate(result['config'])
+      File.write(@config_file, new_config_json)
+    end
+  end
+
+  # Connect to the IMAP server, attempting 'LOGIN' then 'PLAIN'
+  def connect
+    check_password
+    @connection ||= Net::IMAP.new(@config['imap']['server'], @config['imap']['port'], @config['imap']['ssl'])
+    res = true
+    unless connected_and_authenticated?
+      begin
+        @connection.authenticate('LOGIN', @config['imap']['username'], @config['imap']['password'])
+      rescue StandardError
+        begin
+          @connection.authenticate('PLAIN', @config['imap']['username'], @config['imap']['password'])
+        rescue StandardError => e
+          puts "IMAP failed to connect: #{e}"
+          res = false
+        end
+      end
+    end
+    res
+  end
+
+  def check_password
+    unless @config['imap']['password']
+      # Get imap password
+      prompt = TTY::Prompt.new
+      @config['imap']['password'] = prompt.mask(
+        'Enter your imap password', required: true
+      )
+    end
+  end
+
+  # Sets the connection delimiter
+  def delimiter
+    if @delimiter.nil?
+      folders = list_folders
+      @delimiter = folders[0][:delim]
+    end
+    @delimiter
+  end
+
+  # Disconnects from the server
+  def disconnect
+    @connection.disconnect unless @connection.nil? || @connection.disconnected?
+    @connection = nil
+  end
+
+  # Configures the IMAP server settings then tests the connection
+  def configure_and_connect
+    if !configuration_wizard # TODO: - wire up to connection configuration
+      exit
+    else
+      test_connection
+    end
+  end
+
+  # Tests the connection to the IMAP server
+  def test_connection
+    puts 'Testing IMAP connection...'
+    puts 'IMAP connection was successful' if connect
+    disconnect unless @connection.disconnected?
+    true
+  end
+
+  # Returns the target mailbox for the message according to the folder structre and Inbox preferences
+  def get_mailbox(protocol, address, network)
+    p_address = case protocol
+                when 'ethereum'
+                  "0x#{address}"
+                else
+                  address
+                end
+
+    if @config['mailchain']['mainnet_to_inbox'] && network.downcase == 'mainnet'
+      'Inbox'
+    else
+      case @config['mailchain']['folders']
+      when 'by_address'
+        # 'Address>Protocol>Network'
+        "Inbox#{delimiter}#{p_address}#{delimiter}#{protocol}#{delimiter}#{network}"
+      when 'by_network'
+        # 'Protocol>Network>Address'
+        "Inbox#{delimiter}#{protocol}#{delimiter}#{network}#{delimiter}#{p_address}"
+      end
+    end
+  end
+
+  # Create the folder path for the mailbox according to chosen folder format
+  def create_mailbox_path(target_mailbox)
+    return if @connection.list('', target_mailbox)
+
+    folders = target_mailbox.split(delimiter)
+    mbox = []
+    (0...folders.length).each_with_index do |_folder, index|
+      mbox.push(folders[index])
+      mbox_as_str = mbox.join(delimiter)
+      @connection.create(mbox_as_str) unless @connection.list('', mbox_as_str)
+    end
+  end
+
+  # Appends message to mailbox
+  # `date_time`: Time
+  # Connects and disconnects at the beginning and end of the method
+  #  if the connection is not defined/ connected already
+  def append_message(protocol, network, address, message, message_id, flags = nil, date_time = nil)
+    unless msg_appended?(message_id)
+      connect unless connected_and_authenticated?
+
+      target_mailbox = get_mailbox(protocol, address, network)
+      create_mailbox_path(target_mailbox)
+      @connection.examine(target_mailbox)
+
+      if @connection.search(['HEADER', 'MESSAGE-ID', message.message_id]).empty?
+        @connection.append(target_mailbox, message.to_s, flags, date_time)
+      end
+      store_msg_appended(message_id)
+    end
+  end
+
+  # Lists folders
+  def list_folders
+    connect
+    @connection.list('', '*')
+  end
+
+  # Attempts to list mailboxes (folders). If length > 0, then wemust be authenticated
+  def connected_and_authenticated?
+    !@connection.disconnected? && !@connection.list('', '*').empty?
+  rescue StandardError => e
+    false
+  end
+end

data/lib/connection/mailchain.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+require_relative '../api/mailchain'
+require_relative '../connection/mailchain'
+require 'mail'
+# Handles the Mailchain API configuration and connection
+class ConnectionMailchain
+  # Initialize configs
+  def initialize(config, config_file)
+    @config = config
+    @config_file = config_file
+    @api = MailchainApi.new(@config['mailchain'])
+  end
+
+  # Configures the Mailchain API settings then tests the connection
+  def configure_and_connect
+    if !configuration_wizard # TODO: - wire up to connection configuration
+      exit
+    else
+      test_connection
+    end
+  end
+
+  # # Run the Mailchain API configuration
+  def configuration_wizard
+    connection_configuration = ConnectionConfigurationMailchain.new(@config)
+    result = connection_configuration.configuration_wizard
+    if result['save']
+      result['config']['imap'].delete('password')
+      new_config_json = JSON.pretty_generate(result['config'])
+      File.write(@config_file, new_config_json)
+    end
+  end
+
+  # Tests the connection to the Mailchain API
+  def test_connection(silent = false)
+    puts 'Testing API connection...' unless silent
+    result = true
+    begin
+      res = @api.version
+      res[:status_code] != 200
+      puts "Connection was successful (API version: #{res[:body]['version']})" unless silent
+    rescue StandardError => e
+      puts "Mailchain API failed to connect with the following error: #{e}"
+      puts 'Check the Mailchain client is running and configured correctly'
+      result = false
+    end
+    result
+  end
+
+  # Converts mailchain message to regular email
+  def convert_message(message)
+    footer = 'Delivered by Mailchain IMAP Connector'
+    c_type = get_content_type(message['headers']['content-type'])
+
+    mail = Mail.new do
+      from        message['headers']['from']
+      to          message['headers']['to']
+      date        message['headers']['date']
+      message_id  message['headers']['message-id']
+      subject     message['subject']
+      if c_type == 'html'
+        html_part do
+          content_type message['headers']['content-type']
+          body "#{message['body']} <br/><br/>#{footer}"
+        end
+      end
+      if c_type == 'plain'
+        text_part do
+          content_type message['headers']['content-type']
+          body "#{message['body']} \r\n#{footer}"
+        end
+      end
+    end
+    mail.header['X-Mailchain-Block-Id'] = message['block-id']
+    mail.header['X-Mailchain-Block-Id-Encoding'] = message['block-id-encoding']
+    mail.header['X-Mailchain-Transaction-Hash']  = message['transaction-hash']
+    mail.header['X-Mailchain-Transaction-Hash-Encoding'] = message['transaction-hash-encoding']
+    mail
+  end
+
+  # Returns `text` or `html`
+  def get_content_type(content_type)
+    case content_type
+    when '"text/html; charset=\"UTF-8\""'
+      'html'
+    when '"text/plain; charset=\"UTF-8\""'
+      'plain'
+    else
+      'plain'
+    end
+  end
+
+  # Returns addresses formatted by_network
+  # e.g. [{
+  #         "protocol" => "ethereum",
+  #         "network" => "kovan",
+  #         "addresses"=> ["1234567890...", "d5ab4ce..."]
+  #       }]
+  def addresses_by_network
+    protocol_networks.map do |obj|
+      {
+        'protocol' => obj['protocol'],
+        'network' => obj['network'],
+        'addresses' => @api.addresses(obj['protocol'], obj['network'])[:body]['addresses']
+      }
+    end
+  end
+
+  # Returns messages formatted by_network
+  #  e.g. [ address, res['messages'] ]
+  def messages_by_network(item)
+    protocol = item['protocol']
+    network = item['network']
+    addresses = item['addresses']
+    messages = []
+    addresses.each do |address|
+      res = get_messages(address, protocol, network)
+      messages << [address, res['messages']] unless res['messages'].nil?
+    end
+    messages
+  end
+
+  # Gets messages from api and returns `body` {"messages" => [...]}
+  def get_messages(addr, protocol, network)
+    address = "0x#{addr}"
+    @api.messages(address, protocol, network)[:body]
+  end
+
+  # Convert and call the append_message for each valid message
+  def convert_messages(messages)
+    cmgs = []
+    messages.each do |msg|
+      next unless msg['status'] == 'ok'
+
+      cm = convert_message(msg)
+      cmgs << {
+        'message' => cm,
+        'message_id' => msg['headers']['message-id'],
+        'message_date' => cm.date.to_time
+      }
+    end
+    cmgs
+  end
+
+  # Returns array of each network with parent protocol
+  # e.g. [{'protocol' => 'ethereum', 'network' => 'ropsten'},...]
+  def protocol_networks
+    output = []
+    @api.protocols[:body]['protocols'].each do |proto|
+      output << proto['networks'].map do |n|
+        { 'protocol' => proto['name'], 'network' => n['name'] }
+      end
+    end
+    output.flatten
+  rescue StandardError => e
+    puts "Error: #{e}"
+  end
+end

data/lib/connection_configuration/imap.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+class ConnectionConfigurationImap
+  attr_reader :config
+  attr_reader :print_settings
+  def initialize(config)
+    @config = config
+  end
+
+  # Run the IMAP configuration wizard
+  # Returns hash or either: { "save" => true, "config" => "{ #config }" }
+  # - or -
+  # { "save" => false }
+  def configuration_wizard
+    @prompt = TTY::Prompt.new
+
+    prompt_server
+    prompt_username
+    prompt_port
+    prompt_ssl
+
+    result = prompt_confirm_save_settings
+    @prompt = nil
+    result
+  end
+
+  # Prints the IMAP server settings as output in a nice format
+  def print_settings
+    puts "IMAP Settings:\n" \
+    "--------------\n" \
+    "Server:\t\t#{@config['imap']['server']}\n" \
+    "Port:\t\t#{@config['imap']['port']}\n" \
+    "SSL:\t\t#{@config['imap']['ssl']}\n" \
+    "Username:\t#{@config['imap']['username']}"
+  end
+
+  # Get imap server config
+  def prompt_server
+    @config['imap']['server'] = @prompt.ask(
+      'Enter your imap server (e.g. imap.example.com)',
+      default: @config['imap']['server']
+    )
+  end
+
+  # Get imap username
+  def prompt_username
+    @config['imap']['username'] = @prompt.ask(
+      'Enter your imap username/ email address (e.g. tim@example.com)',
+      default: @config['imap']['username']
+    )
+  end
+
+  # Get imap port
+  def prompt_port
+    @config['imap']['port'] = @config['imap']['port'] || '993'
+    @config['imap']['port'] = @prompt.ask(
+      'Enter the imap port to connect to (e.g. IMAP = 143; IMAP SSL = 993)',
+      default: @config['imap']['port']
+    )
+  end
+
+  # Get imap ssl status
+  def prompt_ssl
+    @config['imap']['ssl'] = @config['imap']['ssl'] != false
+    imap_ssl_val = @config['imap']['ssl'] ? 1 : 2
+    imap_ssl_val = @prompt.select('Use SSL?', cycle: true) do |menu|
+      menu.default imap_ssl_val
+      menu.choice 'Yes', 1
+      menu.choice 'No', 2
+    end
+    @config['imap']['ssl'] = imap_ssl_val == 1
+  end
+
+  # Confirm settings with user
+  def prompt_confirm_save_settings
+    server_settings = print_settings
+    imap_confirm_val = @prompt.select(
+      "Would you like to save the following settings?\n" \
+      "NOTE: Any existing configuration will be overwritten\n\n" \
+      "#{server_settings}",
+      cycle: true
+    ) do |menu|
+      menu.choice 'Save', true
+      menu.choice 'Cancel', false
+    end
+
+    imap_confirm_val ? { 'save' => true, 'config' => @config } : { 'save' => false }
+  end
+end

data/lib/connection_configuration/mailchain.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+class ConnectionConfigurationMailchain
+  FOLDER_STRUCTURE = { 'by_network' => 'Protocol>Network>Address', 'by_address' => 'Address>Protocol>Network' }.freeze
+
+  attr_reader :config
+  def initialize(config)
+    @config = config
+  end
+
+  # Runs the Mailchain API configuration wizard
+  # Returns hash or either: { "save" => true, "config" => "{ #config }" }
+  # - or -
+  # { "save" => false }
+  def configuration_wizard
+    @prompt = TTY::Prompt.new
+    prompt_hostname
+    prompt_ssl
+    prompt_port
+    prompt_folder_format
+    prompt_mainnet_to_inbox
+    prompt_polling_interval
+    result = prompt_confirm_save_settings
+    @prompt = nil
+    result
+  end
+
+  # Prints the Mailchain API settings as output in a nice format
+  def print_settings
+    ssl =       @config['mailchain']['ssl'] ? 'https' : 'http'
+    hostname =  @config['mailchain']['hostname']
+    port =      @config['mailchain']['port']
+    folders = @config['mailchain']['folders']
+    mainnet_inbox = @config['mailchain']['mainnet_to_inbox'] ? 'To Inbox' : 'To Mainnet Folder'
+    interval = @config['mailchain']['interval'].to_i > 60 ? @config['mailchain']['interval'].to_i : 60
+
+    puts "Mailchain Settings:\n" \
+    "-------------------\n" \
+    "http/https:\t#{ssl}\n" \
+    "Hostname:\t#{hostname}\n" \
+    "Port:\t\t#{port}\n" \
+    "API URL:\t#{ssl}://#{hostname}:#{port}/api\n" \
+    "Mainnet messages: #{mainnet_inbox}\n" \
+    "Store messages: #{FOLDER_STRUCTURE[folders]}\n" \
+    "Polling interval: #{interval} seconds #{'(' + (interval / 60).to_s + ' minutes)' if interval > 60}"
+  end
+
+  # Get Mailchain server config
+  def prompt_hostname
+    @config['mailchain']['hostname'] = @prompt.ask(
+      'Enter your Mailchain client hostname (e.g. 127.0.0.1 or mailchain.example.com)',
+      default: @config['mailchain']['hostname'] || '127.0.0.1'
+    )
+  end
+
+  # Get Mailchain ssl status
+  def prompt_ssl
+    @config['mailchain']['ssl'] = @config['mailchain']['ssl'] != false
+    ssl_val = @config['mailchain']['ssl'] ? 1 : 2
+    ssl_val = @prompt.select('Use https (SSL)?', cycle: true) do |menu|
+      menu.default ssl_val
+      menu.choice 'https (SSL)', 1
+      menu.choice 'http', 2
+    end
+    @config['mailchain']['ssl'] = ssl_val == 1
+  end
+
+  # Get Mailchain port
+  def prompt_port
+    custom_port = @prompt.yes?('Connect to a custom port?')
+    case custom_port
+    when false && @config['mailchain']['ssl']
+      @config['mailchain']['port'] = 443
+    when false && !@config['mailchain']['ssl']
+      @config['mailchain']['port'] = 80
+    when true
+      @config['mailchain']['port'] = @config['mailchain']['port'] || '8080'
+      @config['mailchain']['port'] = @prompt.ask(
+        'Enter the port to connect to the Mailchain client (e.g. 8080)',
+        default: @config['mailchain']['port']
+      )
+    end
+  end
+
+  # Folder format
+  def prompt_folder_format
+    choices = {
+      1 => 'by_network',
+      'by_network' => 1,
+
+      2 => 'by_address',
+      'by_address' => 2
+    }
+    folder_choice = @prompt.select(
+      'How would you like to structure your folders in IMAP?',
+      cycle: true
+    ) do |menu|
+      menu.default choices[@config['mailchain']['folders']] || 1
+      menu.choice FOLDER_STRUCTURE['by_network'], 1
+      menu.choice FOLDER_STRUCTURE['by_address'], 2
+    end
+    @config['mailchain']['folders'] = choices[folder_choice]
+  end
+
+  # Mainnet to Inbox
+  def prompt_mainnet_to_inbox
+    @config['mailchain']['mainnet_to_inbox'] = @prompt.select(
+      "Most email clients don't alert you when messages are delivered to your folders. Would you like 'Mainnet' messages delivered to your Inbox folder so you get new message alerts?",
+      cycle: true
+    ) do |menu|
+      menu.choice 'Yes', true
+      menu.choice 'No', false
+    end
+  end
+
+  # Polling Interval
+  def prompt_polling_interval
+    @config['mailchain']['interval'] = @config['mailchain']['interval'] || '300'
+    @config['mailchain']['interval'] = @prompt.ask(
+      'How often would you like to check for messages (in seconds)? (e.g. 300 = 5 minutes; Minimum interval is 1 minute)',
+      default: @config['mailchain']['interval']
+    )
+  end
+
+  # Confirm settings with user
+  def prompt_confirm_save_settings
+    settings = print_settings
+    mailchain_confirm_val = @prompt.select(
+      "Would you like to save the following settings?\n" \
+      "NOTE: Any existing configuration will be overwritten\n\n" \
+      "#{settings}",
+      cycle: true
+    ) do |menu|
+      menu.choice 'Save', true
+      menu.choice 'Cancel', false
+    end
+    mailchain_confirm_val ? { 'save' => true, 'config' => @config } : { 'save' => false }
+  end
+end

data/lib/mailchain_connector_imap/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MailchainConnectorImap
+  VERSION = '0.1.4'
+end