dmail 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5f2d2e3bb5cb137ca9438d21e36fcbfd19b7443
+  data.tar.gz: 6358fb1c7b1b9cf269c90f719ab95cac1c0c4104
+SHA512:
+  metadata.gz: 3a2672eb406365b0edeeb3b0acca1f5075da987ff839c6e7ca51b8ee073a1efe44530eea50c9c894a442d41a7322c196b72922af56a46e9579c73f8cbd9dc8d4
+  data.tar.gz: a53e8a5c963fe80e0614fa9439c04c96d655189d79230c3fcbaef57defd08b6db315b474494f488aa3a5082bef0915e8d28ef60b686579728f00fb04699bde28

data/README.md

@@ -0,0 +1,52 @@
+# dmail
+
+Command-line email client.
+
+## Installation
+
+    $ gem install dmail
+
+## Setup
+
+dmail reads settings firstly from ``.dmailrc.yaml`` and fallbacks to ``~/.dmailrc.yaml``.
+
+Gmail setup:
+
+``` yaml
+dmail:
+  reading:
+    method: imap
+    address: imap.gmail.com
+    port: 993
+    enable_ssl: true
+    user_name: me@gmail.com
+    password: myp4ssw0rd
+```
+
+## Usage
+
+Listing emails:
+
+``` bash
+$ dmail list
+```
+
+Viewing emails:
+
+``` bash
+$ dmail show CAC0GtHcR13bnhLju=DymZm0fr778LALHw3HwWUVXrM81c4Hc+Q@mail.gmail.com
+```
+
+## Contributing
+
+You're encouraged to submit issues, PRs and weigh in your opinion anywhere. If you want to get started,
+feel free to contact the authors either directly or through a new issue. We also love documentation so
+feel free to extend this README.
+
+## License
+
+MIT License. See LICENSE for details.
+
+## Copyright
+
+Copyright (c) 2014 André Dieb Martins

data/Rakefile

@@ -0,0 +1,14 @@
+#!/usr/bin/env rake
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'bundler/gem_tasks'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+task default: :spec

data/bin/dmail

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+unless $LOAD_PATH.include?(File.dirname(__FILE__) + '/../lib/')
+  $LOAD_PATH << File.dirname(__FILE__) + '/../lib'
+end
+
+require 'dmail/cli'
+
+cli = Dmail::CLI.new
+cli.run

data/lib/dmail.rb

@@ -0,0 +1,2 @@
+module Dmail
+end

data/lib/dmail/cli.rb

@@ -0,0 +1,47 @@
+require 'mail'
+require 'yaml'
+
+require File.join(File.dirname(__FILE__), 'impl')
+
+module Dmail
+  class CLI
+    include Impl
+
+    def initialize
+      @action = ARGV.first.gsub('--', '')
+      @coloring = true
+      load_settings
+    end
+
+    def run
+      send(@action)
+    rescue NoMethodError
+      puts "dmail: '#{ARGV[0]}' is not a valid dmail command. See 'dmail help'."
+    end
+
+    private
+
+    def load_settings
+      preferences ||= if File.exists?('.dmailrc.yaml')
+        YAML.load(IO.read('.dmailrc.yaml'))
+      elsif File.exists?('~/.dmailrc.yaml')
+        YAML.load(IO.read('~/.dmailrc.yaml'))
+      else
+        fail('dmail: could not find .dmailrc.yaml here or on your home directory.')
+      end
+
+      retriever_preferences = preferences['dmail']['reading']
+
+      Mail.defaults do
+        retriever_method(
+          retriever_preferences['method'].to_sym,
+          address: retriever_preferences['address'],
+          port: retriever_preferences['port'],
+          user_name: retriever_preferences['user_name'],
+          password: retriever_preferences['password'],
+          enable_ssl: retriever_preferences['enable_ssl']
+        )
+      end
+    end
+  end
+end

data/lib/dmail/impl.rb

@@ -0,0 +1,79 @@
+require 'mail'
+
+require File.join(File.dirname(__FILE__), 'utils')
+
+module Dmail
+  module Impl
+    include Utils
+    include Term::ANSIColor
+
+    DOCS_PATH = File.join(File.dirname(__FILE__), '..', '..', 'doc')
+
+    def help
+      doc = ARGV[1].nil? ? 'main.txt' : "dmail-#{ARGV[1]}.txt"
+      puts IO.read(File.join(DOCS_PATH, doc))
+    end
+
+    def list
+      params = get_params(
+        :mailbox,
+        count:  %w(-c --count),
+        unread: %w(-u --unread)
+      )
+      query = { read_only: true, order: :asc, what: :first }
+      query[:mailbox] = params[:mailbox] || 'INBOX'
+      query[:count] = params[:count].nil? ? 10 : params[:count].to_i
+      query[:keys] = 'UNSEEN' if params[:unread]
+
+      setup_pager!
+      Mail.find(query).each { |email| print_email_header(email) }
+    end
+
+    def show
+      params = get_params(
+        :mailbox,
+        leave_unread: %w(-m --leave-unread)
+      )
+      query = {}
+      query[:mailbox] = params[:mailbox] || 'INBOX'
+      query[:read_only] = true if params[:leave_unread]
+
+      message_id = ARGV[1]
+      if message_id then
+        query[:keys] = "HEADER Message-id #{message_id}"
+      else
+        query[:what] = :last
+        query[:count] = 1
+      end
+
+      setup_pager!
+      [Mail.find(query)].flatten.each do |email|
+        print_email_header(email)
+        puts
+        puts email.text_part.decoded.strip
+        puts
+      end
+    end
+
+    def status
+      params = get_params(:mailbox)
+      query = { keys: 'UNSEEN', read_only: true }
+      query[:mailbox] = params[:mailbox] || 'INBOX'
+      query[:count] = 1000 # Hack to read all unreads and not only 10
+      unseen = Mail.find(query).count
+      puts "Unread: #{unseen}"
+    end
+
+    private
+
+    def print_email_header(email)
+      puts yellow { "id #{email.message_id}" }
+      puts "From: #{email.from.first}"
+      puts "Date: #{email.date.rfc2822}"
+      puts "Message ID: #{email.message_id}" if @all
+      puts
+      puts "    #{email.subject}"
+      puts
+    end
+  end
+end

data/lib/dmail/utils.rb

@@ -0,0 +1,61 @@
+require 'pager'
+require 'term/ansicolor'
+
+module Dmail
+  module Utils
+    include Pager
+
+    # I like this naming better :)
+    def setup_pager!
+      page
+    end
+
+    # Converts arguments() to a pretty-named hash. Considers naming
+    # substitutes when doing so.
+    def get_params(keys, mappings)
+      params = {}
+      [keys].flatten.each do |key|
+        value = arguments[key.to_s]
+        params[key] = value if value
+      end
+      mappings.each do |final_name, substitutes|
+        value = substitutes.map { |s| arguments[s] }.find { |el| el }
+        params[final_name] = value if value
+      end
+      params
+    end
+
+    # Parsing command-line arguments. Understands things like '-d',
+    # '-c', '-c 5', '--count=5', '--count 5'.
+    # Non-valued args like '-d' get mapped to true to indicate presence.
+    def arguments
+      @args ||= {}
+      unless @args.size > 0
+        ARGV.each_with_index do |arg, index|
+          if arg.start_with?('-')
+            if index + 1 < ARGV.size
+              next_arg = ARGV[index + 1]
+              if next_arg.start_with?('-') then
+                @args.update(argument_present_or_direct(arg))
+              else
+                @args.update(arg => next_arg)
+              end
+            else
+              @args.update(argument_present_or_direct(arg))
+            end
+          end
+        end
+      end
+      @args
+    end
+
+    def argument_present_or_direct(arg)
+      arg, value = if arg.include?('=') then
+        arg.split('=')
+      else
+        [arg, true]
+      end
+      { arg => value }
+    end
+  end
+end

data/lib/dmail/version.rb

@@ -0,0 +1,4 @@
+module Dmail
+  VERSION = '0.0.1'
+end
+

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: dmail
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andre Dieb Martins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !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: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: term-ansicolor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pager
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Command-line email client
+email:
+- andre.dieb@gmail.com
+executables:
+- dmail
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- bin/dmail
+- lib/dmail.rb
+- lib/dmail/cli.rb
+- lib/dmail/impl.rb
+- lib/dmail/utils.rb
+- lib/dmail/version.rb
+homepage: https://github.com/dieb/dmail
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Command-line email client
+test_files: []