mayaml 1.0.0

data/README.md

@@ -0,0 +1,57 @@
+# MAYaml
+
+[![Gem Version](https://badge.fury.io/rb/mayaml.svg)](http://badge.fury.io/rb/mayaml)
+
+This is a base package for mail accounts configuration generators. The ideas is to store mail accounts configuration in one Yaml file and then generates dedicated configs for specific programs (like getmail, mutt, etc...).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mayaml'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mayaml
+
+## Usage
+
+If ruby bin dir is in your PATH, just call `mayaml-check <path_to_the_yaml_file>` to list recognized accounts. 
+On the other hand, In plugins:
+
+```ruby
+require "mayaml"
+
+Mayaml.accounts_from_file(yaml_path).each { |account| ... }
+```
+
+### Mail account format in Yaml file
+
+```yaml
+- name: account_name
+  type: imap
+  server: test.mailserver.com
+  port: 998
+  user: user@mailserver.com
+  pass: sercet_password
+  mailboxes
+    - INBOX 
+```
+
+## Versioning
+
+See [semver.org][semver]
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[semver]: http://semver.org/

data/bin/mayaml-check

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+# Copyright (C) 2016 Szymon Kopciewski
+#
+# This file is part of Mayaml.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+require "mayaml"
+
+def puts_ussage_message
+  puts <<-END_HELP
+    Ussage: mayaml-check <path_to_yaml_file>
+  END_HELP
+end
+
+def main(args)
+  yaml_path = args.shift
+  if yaml_path.nil?
+    puts_ussage_message
+    exit 1
+  elsif File.exist? yaml_path
+    Mayaml.accounts_from_file(yaml_path).each { |acc| puts acc.to_str }
+  else
+    puts "Could not find file: #{yaml_path}"
+    exit 1
+  end
+end
+
+main ARGV if __FILE__ == $PROGRAM_NAME

data/lib/mayaml/error.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+# Copyright (C) 2016 Szymon Kopciewski
+#
+# This file is part of Mayaml.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module Mayaml
+  class Error < StandardError
+  end
+end

data/lib/mayaml/mail_account/builder.rb

@@ -0,0 +1,108 @@
+# encoding: utf-8
+
+# Copyright (C) 2016 Szymon Kopciewski
+#
+# This file is part of Mayaml.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+require "mayaml/mail_account"
+require "mayaml/mail_account/error"
+require "mayaml/mail_account/required_attributes_validator"
+require "mayaml/mail_account/type_validator"
+require "mayaml/mail_account/port_validator"
+require "mayaml/mail_account/mailboxes_validator"
+
+module Mayaml
+  class MailAccount
+    class Builder
+      def self.build
+        builder = new
+        yield(builder)
+        builder.account
+      end
+
+      def initialize
+        @account = ::Mayaml::MailAccount.new
+      end
+
+      def name(name)
+        @account.name = name
+      end
+
+      def type(str)
+        if str.nil? || str == ""
+          @account.set_default_type
+        else
+          validator = TypeValidator.new str
+          unless validator.valid?
+            raise WrongAccountType, validator.errors.join(" ")
+          end
+          @account.type = str.to_sym
+        end
+      end
+
+      def server(str)
+        @account.server = str
+      end
+
+      def port(nr)
+        if nr.nil? || nr == ""
+          @account.set_default_port
+        else
+          validator = PortValidator.new nr
+          unless validator.valid?
+            raise WrongAccountPort, validator.errors.join(" ")
+          end
+          @account.port = nr.to_i
+        end
+      end
+
+      def user(str)
+        @account.user = str
+      end
+
+      def pass(str)
+        @account.pass = str
+      end
+
+      def mailboxes(arr)
+        if arr.nil? || arr.empty?
+          @account.set_default_mailboxes
+        else
+          validator = MailboxesValidator.new arr
+          unless validator.valid?
+            raise WrongAccountMailboxes, validator.errors.join(" ")
+          end
+          @account.mailboxes = arr
+        end
+      end
+
+      def account
+        obj = valid_account
+        @account = ::Mayaml::MailAccount.new
+        obj
+      end
+
+      private
+
+      def valid_account
+        validator = RequiredAttributesValidator.new @account
+        unless validator.valid?
+          raise MissingAttributes, validator.errors.join(" ")
+        end
+        @account.dup
+      end
+    end
+  end
+end

data/lib/mayaml/mail_account/error.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+# Copyright (C) 2016 Szymon Kopciewski
+#
+# This file is part of Mayaml.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+require "mayaml/error"
+
+module Mayaml
+  class MailAccount
+    class Error < ::Mayaml::Error
+    end
+
+    class MissingAttributes < Error
+    end
+
+    class WrongAccountType < Error
+    end
+
+    class WrongAccountPort < Error
+    end
+
+    class WrongAccountMailboxes < Error
+    end
+  end
+end

data/lib/mayaml/mail_account/mailboxes_validator.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+# Copyright (C) 2016 Szymon Kopciewski
+#
+# This file is part of Mayaml.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module Mayaml
+  class MailAccount
+    class MailboxesValidator
+      attr_reader :errors
+
+      def initialize(mailboxes)
+        @errors = []
+        @errors << "Mailboxes should be array." unless mailboxes.instance_of? Array
+        if mailboxes.instance_of?(Array) && mailboxes.empty?
+          @errors << "Mailboxes can not be empty."
+        end
+        if mailboxes.instance_of?(Array) && !mailboxes.all? { |box| box.instance_of? String }
+          @errors << "Mailboxes should all be strings."
+        end
+      end
+
+      def valid?
+        @errors.empty?
+      end
+    end
+  end
+end

data/lib/mayaml/mail_account/port_validator.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+# Copyright (C) 2016 Szymon Kopciewski
+#
+# This file is part of Mayaml.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module Mayaml
+  class MailAccount
+    class PortValidator
+      attr_reader :errors
+
+      def initialize(port)
+        @errors = []
+        port = port.respond_to?(:to_i) ? port.to_i : 0
+        @errors << "Mail account port is invalid." if port == 0
+        @errors << "Mail account port could not be negative." if port < 0
+      end
+
+      def valid?
+        @errors.empty?
+      end
+    end
+  end
+end

data/lib/mayaml/mail_account/required_attributes_validator.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+# Copyright (C) 2016 Szymon Kopciewski
+#
+# This file is part of Mayaml.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module Mayaml
+  class MailAccount
+    class RequiredAttributesValidator
+      attr_reader :errors
+
+      def initialize(mail_account)
+        @errors = []
+        @errors << "Missing name attribute." if mail_account.name.nil?
+        @errors << "Missing server attribute." if mail_account.server.nil?
+        @errors << "Missing user attribute." if mail_account.user.nil?
+        @errors << "Missing pass attribute." if mail_account.pass.nil?
+      end
+
+      def valid?
+        @errors.empty?
+      end
+    end
+  end
+end

data/lib/mayaml/mail_account/type_validator.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+# Copyright (C) 2016 Szymon Kopciewski
+#
+# This file is part of Mayaml.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module Mayaml
+  class MailAccount
+    class TypeValidator
+      attr_reader :errors
+      VALID_TYPES = [:imap, :pop3].freeze
+
+      def initialize(type)
+        @errors = []
+        type = type.to_sym if type.respond_to? :to_sym
+        unless VALID_TYPES.include?(type)
+          @errors << "Mail account type is invalid. Allowed types: #{VALID_TYPES.join(", ")}."
+        end
+      end
+
+      def valid?
+        @errors.empty?
+      end
+    end
+  end
+end

data/lib/mayaml/mail_account.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+# Copyright (C) 2016 Szymon Kopciewski
+#
+# This file is part of Mayaml.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module Mayaml
+  class MailAccount
+    attr_accessor :name, :type, :server, :port, :user, :pass, :mailboxes
+
+    def initialize
+      set_default_type
+      set_default_port
+      set_default_mailboxes
+    end
+
+    def set_default_type
+      @type = :imap
+    end
+
+    def set_default_port
+      @port = 993
+    end
+
+    def set_default_mailboxes
+      @mailboxes = []
+    end
+
+    def to_str
+      <<-DESC
+        Account: #{@name} | user: #{@user}:#{@pass}
+          #{@type} - #{@server}:#{@port} [#{@mailboxes.join(",")}]
+      DESC
+    end
+  end
+end

data/lib/mayaml/parser.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+# Copyright (C) 2016 Szymon Kopciewski
+#
+# This file is part of Mayaml.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+require "yaml"
+
+module Mayaml
+  class Parser
+    def self.get_accounts(json_file)
+      YAML.load_file json_file
+    rescue Errno::ENOENT, Psych::SyntaxError
+      []
+    end
+  end
+end

data/lib/mayaml/version.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+# Copyright (C) 2016 Szymon Kopciewski
+#
+# This file is part of Mayaml.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module Mayaml
+  VERSION = "1.0.0".freeze
+end

data/lib/mayaml.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+# Copyright (C) 2016 Szymon Kopciewski
+#
+# This file is part of Mayaml.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "mayaml/version"
+require "mayaml/mail_account/builder"
+require "mayaml/parser"
+
+module Mayaml
+  def self.accounts_from_file(yaml_accounts)
+    raw_accounts = Parser.get_accounts(yaml_accounts)
+    raw_accounts.map do |raw_account|
+      build_account(raw_account)
+    end
+  end
+
+  def self.build_account(raw_account)
+    MailAccount::Builder.build do |builder|
+      builder.name raw_account.fetch("name")
+      builder.type raw_account.fetch("type")
+      builder.server raw_account.fetch("server")
+      builder.port raw_account.fetch("port")
+      builder.user raw_account.fetch("user")
+      builder.pass raw_account.fetch("pass")
+      builder.mailboxes raw_account.fetch("mailboxes", [])
+    end
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: mayaml
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Szymon Kopciewski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Mail Accounts from Yaml parser - the base classes
+email:
+- s.kopciewski@gmail.com
+executables:
+- mayaml-check
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- bin/mayaml-check
+- lib/mayaml.rb
+- lib/mayaml/error.rb
+- lib/mayaml/mail_account.rb
+- lib/mayaml/mail_account/builder.rb
+- lib/mayaml/mail_account/error.rb
+- lib/mayaml/mail_account/mailboxes_validator.rb
+- lib/mayaml/mail_account/port_validator.rb
+- lib/mayaml/mail_account/required_attributes_validator.rb
+- lib/mayaml/mail_account/type_validator.rb
+- lib/mayaml/parser.rb
+- lib/mayaml/version.rb
+homepage: https://github.com/skopciewski/mayaml
+licenses:
+- GPL-3.0
+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.2.5
+signing_key: 
+specification_version: 4
+summary: Mail Accounts from Yaml parser - the base classes
+test_files: []