mailchain_connector_imap 0.1.4

data/lib/mailchain_connector_imap.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+require 'tty-prompt'
+require 'optparse'
+
+require_relative 'connection/imap'
+require_relative 'connection/mailchain'
+require_relative 'connection_configuration/imap'
+require_relative 'connection_configuration/mailchain'
+
+module MailchainConnectorImap
+  class Error < StandardError; end
+
+  class Connector
+    STORE_PATH = "#{ENV['HOME']}/.mailchain_connector/imap/"
+    CONFIG_FILE = File.join(STORE_PATH, 'config.json')
+    LOG_FILE = File.join(STORE_PATH, 'mailchain_connector_imap.log')
+    attr_reader :imap_conn
+    attr_reader :mailchain_conn
+    attr_reader :config
+
+    def initialize
+      parse_config_file
+      @imap_conn = ConnectionImap.new(@config, CONFIG_FILE)
+      @mailchain_conn = ConnectionMailchain.new(@config, CONFIG_FILE)
+      @config_json = {}
+    end
+
+    def start
+      # Run OptionsParser to interpret user input
+      run_options_parse
+    end
+
+    # Handle missing config file error
+    def missing_config_file
+      puts "Invalid or missing config.\n" \
+        'Run `mailchain_connector_imap --configure`'
+    end
+
+    # Run the script and parse input arguments
+    def run_options_parse
+      OptionParser.new do |opts|
+        ARGV << '-r' if ARGV.empty?
+
+        opts.banner = 'Usage: mailchain_connector_imap [options]'
+
+        opts.on('-r', '--run', 'Run and sync messages') do
+          unless valid_config
+            missing_config_file
+            exit
+          end
+          sync_messages
+        end
+
+        opts.on('-c', '--configure', 'Configure connector settings') do
+          op_configure
+          exit
+        end
+
+        opts.on('-t', '--test-connection', 'Test connection to IMAP server and Mailchain API') do
+          op_test_connection
+          exit
+        end
+
+        opts.on('-p', '--print-config', 'Print connector settings to screen') do
+          op_print_configuration
+          exit
+        end
+
+        opts.on_tail('-h', '--help', 'Show this message') do
+          puts opts
+          exit
+        end
+      end.parse!
+    end
+
+    # Runs the configuration wizards and tests connections
+    def op_configure
+      @imap_conn.configure_and_connect
+      @mailchain_conn.configure_and_connect
+      exit
+    end
+
+    # Run connection tests
+    def op_test_connection
+      begin
+        @imap_conn.test_connection
+      rescue StandardError => e
+        puts "IMAP error: #{e}"
+      end
+      begin
+        @mailchain_conn.test_connection
+      rescue StandardError => e
+        puts "API error: #{e}"
+      end
+    end
+
+    # Outputs the configuration to screen
+    def op_print_configuration
+      # TODO: fix this
+      ConnectionConfigurationImap.new(@config).print_settings
+      puts "\n"
+      # TODO: fix this
+      ConnectionConfigurationMailchain.new(@config).print_settings
+    end
+
+    # Parse the config file as JSON
+    def parse_config_file
+      check_or_create_config_file
+      config_json = File.read(CONFIG_FILE)
+      @config = JSON.parse(config_json)
+      true
+    rescue StandardError => e
+      puts "Error parsing configuration: #{e}"
+      missing_config_file
+      exit
+    end
+
+    # Check for an existing config file, otherwise create a new one with minimum requirements to be parsed.
+    def check_or_create_config_file
+      (FileUtils.mkdir_p(STORE_PATH) unless File.exist?(CONFIG_FILE))
+      File.write(CONFIG_FILE, '{"imap": {}, "mailchain": {}}') unless File.exist?(CONFIG_FILE)
+    end
+
+    # sync_messages calls ConnectionMailchain.messages_by_network, before setting a timer to run again.
+    # Minimum timer interval is 60 seconds.
+    # It logs at the beginning and end of each polling interval.
+    def sync_messages
+      if @imap_conn.connect
+        puts 'Connected to IMAP'
+        if @mailchain_conn.test_connection(true)
+          puts 'Connected to Mailchain client'
+          loop do
+            if @imap_conn.connect && @mailchain_conn.test_connection(true)
+              interval = @config['mailchain']['interval'].to_i > 60 ? @config['mailchain']['interval'].to_i : 60
+              log_to_file('Checking messages')
+              @mailchain_conn.addresses_by_network.each do |abn|
+                protocol = abn['protocol']
+                network = abn['network']
+                # TODO: - Simplify this:
+                addr_with_messages = @mailchain_conn.messages_by_network(abn)
+                addr_with_messages.each do |addr_msg|
+                  addr = addr_msg[0]
+                  msg = addr_msg[1]
+                  converted_messages = @mailchain_conn.convert_messages(msg)
+                  converted_messages.each do |cm|
+                    @imap_conn.append_message(protocol, network, addr, cm['message'], cm['message_id'], nil, cm['message_date'])
+                  end
+                end
+              end
+            end
+
+            log_to_file('Done')
+            sleep interval
+          end
+        end
+      end
+    rescue StandardError => e
+      log_to_file("Error: #{e}")
+      puts "Error: #{e}"
+    end
+
+    # Checks values are present for config options
+    # Returns true if valid; false if invalid
+    def valid_config
+      [
+        @config['imap']['server'],
+        @config['imap']['username'],
+        @config['imap']['port'],
+        @config['imap']['ssl'],
+        @config['mailchain']['hostname'],
+        @config['mailchain']['ssl'],
+        @config['mailchain']['port'],
+        @config['mailchain']['folders'],
+        @config['mailchain']['mainnet_to_inbox'],
+        @config['mailchain']['interval']
+      ].none? { |e| e.to_s.empty? }
+    end
+
+    # Output message to the log file, adding the date and time
+    # `message` (String): the message text
+    def log_to_file(message)
+      open(LOG_FILE, 'a') do |f|
+        f << "\n"
+        f << "#{Time.now} #{message}"
+      end
+    end
+  end
+end

data/mailchain_connector_imap.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'lib/mailchain_connector_imap/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mailchain_connector_imap'
+  spec.version       = MailchainConnectorImap::VERSION
+  spec.authors       = ['Tim B']
+  spec.email         = ['team@mailchain.xyz']
+
+  spec.summary       = 'An IMAP connector for the Mailchain API'
+  spec.description   = 'Send your Mailchain messages to your email inbox with the IMAP connector for the Mailchain API'
+  spec.homepage      = 'https://mailchain.xyz/mailchain-connectors/imap'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.license = 'Apache2.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/mailchain/mailchain-connector-imap'
+  spec.metadata['changelog_uri'] = 'https://github.com/mailchain/mailchain-connector-imap/releases'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundle', '~> 2.0'
+  spec.add_development_dependency 'pry', '~> 0.13'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_runtime_dependency 'httparty', '~> 0.18', '>= 0.18.0'
+  spec.add_runtime_dependency 'mail', '~> 2.7', '>= 2.7.1'
+  spec.add_runtime_dependency 'tty-prompt', '~> 0.21', '>= 0.21.0'
+end

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: mailchain_connector_imap
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Tim B
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+description: Send your Mailchain messages to your email inbox with the IMAP connector
+  for the Mailchain API
+email:
+- team@mailchain.xyz
+executables:
+- mailchain_connector_imap
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/mailchain_connector_imap
+- lib/api/mailchain.rb
+- lib/connection/imap.rb
+- lib/connection/mailchain.rb
+- lib/connection_configuration/imap.rb
+- lib/connection_configuration/mailchain.rb
+- lib/mailchain_connector_imap.rb
+- lib/mailchain_connector_imap/version.rb
+- mailchain_connector_imap.gemspec
+homepage: https://mailchain.xyz/mailchain-connectors/imap
+licenses:
+- Apache2.0
+metadata:
+  homepage_uri: https://mailchain.xyz/mailchain-connectors/imap
+  source_code_uri: https://github.com/mailchain/mailchain-connector-imap
+  changelog_uri: https://github.com/mailchain/mailchain-connector-imap/releases
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: An IMAP connector for the Mailchain API
+test_files: []