opensrs-email 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MWJmMjU4NDA2N2UzOThiNmJjNWJjY2MyMjAwMDQ3YzAyMTA3NWY5OA==
+  data.tar.gz: !binary |-
+    MmJjYzFjODk1Y2QxZTQ0YjIwYWMyYjljMmY0NDBmMmU4YjFiYjI0ZA==
+SHA512:
+  metadata.gz: !binary |-
+    NGEzNzEyZTIyZjIyMWFkZDdmOGQ2MGU2OGZjNDA3NDU3ZGNkMDcxOTJmODRk
+    YTQyYTFjN2Q3NmI5YWMxOTcyNTRmNmM2ZjZkYTBjNzQwODM4NjgyZTcyNGFh
+    MjAwMTg5MzM4MTcxM2FiMjA4ZTJjMTk0NjdhOTZiYTA1ZGMzZTE=
+  data.tar.gz: !binary |-
+    OTFiMzViM2IwYWE0ZDRiMGRiYWUzMjVkOThhZjc3MGM5N2ZlMDFmYTJjNWJm
+    YTI4NmQ0ZDdhZjcyZDRhZDJiMmZiZTExYzUyMjFlZmU5MmYwMGFhODMyN2Q0
+    YmJkZjA4MjRkNGY1OTkyZTA5NzE0YTA0NjM5ZDQ0YTllYzhmMjc=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+cache: bundler
+rvm:
+  - 1.9.3
+  - 2.0.0
+

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in opensrs-email.gemspec
+gemspec
+
+gem "rspec", "~> 2.0"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Striking.ly Inc
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# Opensrs::Email
+
+[![Build Status](https://travis-ci.org/strikingly/opensrs-email.png?branch=master)](https://travis-ci.org/strikingly/opensrs-email)
+
+API to manage opensrs domain emails through APP (OpenSRS Email Service Account Provisioning Protocol)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'opensrs-email'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install opensrs-email
+
+## Usage
+
+    gateway = Opensrs::Email::Gateway.new(OPENSRS_EMAIL_SERVER, OPENSRS_EMAIL_PORT, OPENSRS_EMAIL_USERNAME, OPENSRS_EMAIL_DOMAIN, OPENSRS_EMAIL_PASSWORD)
+
+    gateway.delete_mailbox_forward_only(mailbox, domain)
+    
+## 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

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/opensrs/email.rb

@@ -0,0 +1,154 @@
+require "opensrs/email/version"
+
+require 'opensrs/email/domain'
+require 'opensrs/email/workgroup'
+require 'opensrs/email/mailbox'
+
+require 'socket'
+require 'openssl'
+require 'logger'
+
+LOGGER = Logger.new(STDOUT)
+LOGGER.level = Logger::INFO
+
+module Opensrs
+  module Email
+    class Gateway
+
+      include Opensrs::Email::Domain
+      include Opensrs::Email::Mailbox
+      include Opensrs::Email::Workgroup
+      
+      def initialize(server, port, user, domain, password, version = '3.4', logger = LOGGER)
+        @server = server
+        @port = port
+        @user = user
+        @domain = domain
+        @password = password
+        @version = version
+        @logger = logger
+        @loggedin = false
+
+        open_connection
+
+        response = receive_response
+        @logger.info("Initial response:\n#{response}")
+        
+        response = send_version
+        @logger.info("Version response:\n#{response}")
+        
+        response = login
+        @logger.info("Login response:\n#{response}")
+
+        if response[:status] == 'OK'
+          @loggedin = true
+        else
+          @loggedin = false
+        end
+      end
+
+      def loggedin?
+        @loggedin
+      end
+
+      def open_connection
+        @connection = TCPSocket.new(@server, @port)
+        @socket = OpenSSL::SSL::SSLSocket.new(@connection) if @connection
+
+        @socket.sync_close = true # synchronise connection close of ssl layer and underlying tcp socket
+        @socket.connect
+      end
+
+      def send_version
+        command = "VER VER=\"#{@version}\"\r\n.\r\n"
+        send_command(command)
+        receive_response
+      end
+
+      def login
+        command = "LOGIN USER=\"#{@user}\" DOMAIN=\"#{@domain}\" PASSWORD=\"#{@password}\"\r\n.\r\n"
+        send_command(command)
+        receive_response
+      end
+
+      def quit
+        command = "QUIT\r\n.\r\n"
+        send_command(command)
+      end
+      
+      def close_connection
+        @socket.close if @socket and not @socket.closed?
+        @connection.close if @connection and not @connection.closed?
+
+        @socket = @connection = nil
+      end
+
+      def make_command_string(command, attributes)
+        cmd = command.to_s
+        attr = attributes.map {|k, v|
+          "#{k.to_s}=\"#{v.to_s}\""
+        } .join(' ')
+        cmd << " #{attr}\r\n.\r\n"
+      end
+      
+      def call(command, attributes = {})
+        if not (MAIL_COMMANDS.include?(command) or
+                DOMAIN_COMMANDS.include?(command) or
+                WORKGROUP_COMMAND.include?(command))
+          raise "Command #{command.to_s} invalid"
+        else
+          cmd = make_command_string(command, attributes)
+          send_command(cmd)
+          receive_response
+        end
+      end
+
+      def send_command(command)
+        if @socket and not @socket.closed?
+          @logger.info("Sending command:\n#{command}")
+          @socket.write(command)
+        end
+      end
+
+      def receive_response
+        response = build_response
+        parse_response(response)
+      end
+
+      def parse_response(response)
+        match_data = /^(OK|ER) (\d+).*/.match(response)
+        
+        status = if match_data and match_data.length > 2 then
+                   match_data[1]
+                 else
+                   nil
+                 end
+        
+        status_code = if match_data and match_data.length > 2 then
+                        match_data[2].to_i
+                      else
+                        nil
+                      end
+        
+        return {
+          :status => status,
+          :status_code => status_code,
+          :response_body => response
+        }
+      end
+
+      def build_response(partial="")
+        line = receive_line
+        if line == ".\r\n"
+          partial
+        else
+          build_response(partial + line)
+        end
+      end
+
+      def receive_line
+        @socket.gets
+      end
+    end
+  end
+end

data/lib/opensrs/email/domain.rb

@@ -0,0 +1,34 @@
+module Opensrs
+  module Email
+    module Domain
+      DOMAIN_COMMANDS = [
+                         :create_domain,
+                         :create_domain_alias,
+                         :delete_domain,
+                         :delete_domain_alias,
+                         :create_domain_welcome_email,
+                         :get_company_domains,
+                         :delete_domain_welcome_email,
+                         :get_domain,
+                         :get_domain_brand,
+                         :change_domain,
+                         :set_domain_admin,
+                         :set_domain_brand,
+                         :set_domain_catch_all_mailbox,
+                         :set_domain_disabled_status,
+                         :get_num_domain_mailboxes,
+                         :get_domain_mailboxes,
+                         :get_domain_mailbox_limits,
+                         :set_domain_mailbox_limits,
+                         :set_domain_allow_list,
+                         :set_domain_block_list,
+                         :get_domain_allow_list,
+                         :get_domain_block_list
+                        ]
+      def create_domain(domain)
+        call(:create_domain, {:domain => domain})
+      end
+    end
+  end
+end
+

data/lib/opensrs/email/mailbox.rb

@@ -0,0 +1,59 @@
+module Opensrs
+  module Email
+    module Mailbox
+      MAIL_COMMANDS = [
+                       :get_mailbox_availability,
+                       :get_alternate_mailbox_names,
+                       :create_mailbox,
+                       :set_mail_admin,
+                       :set_mail_admin,
+                       :change_mailbox,
+                       :create_alias_mailbox,
+                       :rename_mailbox,
+                       :set_mailbox_allow_list,
+                       :set_mailbox_block_list,
+                       :get_mailbox_allow_list,
+                       :get_mailbox_block_list,
+                       :verify_password,
+                       :get_admin,
+                       :get_mailbox,
+                       :get_mailbox_any,
+                       :get_mailbox_services,
+                       :set_mailbox_services,
+                       :get_mailbox_quota,
+                       :set_mailbox_quota,
+                       :delete_mailbox,
+                       :delete_mailbox_any,
+                       :set_mailbox_autorespond,
+                       :get_mailbox_autorespond,
+                       :set_mailbox_forward,
+                       :get_mailbox_forward,
+                       :show_available_offerings,
+                       :show_enabled_offerings,
+                       :disable_offering,
+                       :enable_offering,
+                       :set_mailbox_suspension,
+                       :get_mailbox_suspension,
+                       :set_mailbox_status,
+                       :get_mailbox_status,
+                       :create_group_alias_mailbox,
+                       :get_group_alias_mailbox,
+                       :get_group_alias_mailbox,
+                       :change_group_alias_mailbox,
+                       :delete_group_alias_mailbox,
+                       :create_mailbox_forward_only,
+                       :get_mailbox_forward_only,
+                       :change_mailbox_forward_only,
+                       :delete_mailbox_forward_only,
+                      ]
+      
+      def create_mailbox_forward_only(mailbox, domain, forward_email, workgroup)
+        call(:create_mailbox_forward_only, {:mailbox => mailbox, :domain => domain, :forward_email => forward_email, :workgroup => workgroup})
+      end
+
+      def delete_mailbox_forward_only(mailbox, domain)
+        call(:delete_mailbox_forward_only, {:mailbox => mailbox, :domain => domain})
+      end
+    end
+  end
+end

data/lib/opensrs/email/version.rb

@@ -0,0 +1,5 @@
+module Opensrs
+  module Email
+    VERSION = "0.0.1"
+  end
+end

data/lib/opensrs/email/workgroup.rb

@@ -0,0 +1,12 @@
+module Opensrs
+  module Email
+    module Workgroup
+      WORKGROUP_COMMAND = [
+                           :create_workgroup,
+                           :get_domain_workgroups,
+                           :delete_workgroup,
+                           :set_workgroup_admin
+                          ]
+    end
+  end
+end

data/opensrs-email.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'opensrs/email/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "opensrs-email"
+  spec.version       = Opensrs::Email::VERSION
+  spec.authors       = ["Li Zhenchao"]
+  spec.email         = ["zhenchao@strikingly.com"]
+  spec.description   = %q{opensrs-email}
+  spec.summary       = %q{API to manage opensrs domain emails through APP (OpenSRS Email Service Account Provisioning Protocol)}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/spec/email_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe Opensrs::Email::Gateway do
+  let! (:gateway) { Opensrs::Email::Gateway.new('admin.test.hostedemail.com', 4449, 'admin', 'domain.com', 'password') }
+
+  describe "Gateway" do
+    it "responds to create_domain" do
+      expect(gateway).to respond_to(:create_domain)
+    end
+
+    it "responds to create_mailbox_forward_only" do
+      expect(gateway).to respond_to(:create_mailbox_forward_only)
+    end
+
+    it "responds to delete_mailbox_forward_only" do
+      expect(gateway).to respond_to(:delete_mailbox_forward_only)
+    end
+
+    it "parses successful response" do
+      response_body = "OK 0 Mailbox created\r\n.\r\n"
+      response = gateway.parse_response(response_body)
+      expect(response[:status]).to eq("OK")
+      expect(response[:status_code]).to eq(0)
+    end
+
+    it "parses error response" do
+      response_body = "ER 16 Mailbox already existed\r\n.\r\n"
+      response = gateway.parse_response(response_body)
+      expect(response[:status]).to eq("ER")
+      expect(response[:status_code]).to eq(16)
+    end
+
+    it "does not parse status code other than OK and ER" do
+      response_body = "BL 33 Invalid status code\r\n.\r\n"
+      response = gateway.parse_response(response_body)
+      expect(response[:status]).to eq(nil)
+      expect(response[:status_code]).to eq(nil)
+    end
+
+    it "builds command string correctly" do
+      command = :create_mailbox_forward_only
+      attributes = {:mailbox => "test", :domain => "testdomain.com", :forward_email => "john@mail.com", :workgroup => "staff"}
+
+      cmd = gateway.make_command_string(command, attributes)
+
+      expect(cmd).to match(/create_mailbox_forward_only/)
+      
+      expect(cmd).to match(/mailbox=\"test\"/)
+
+      expect(cmd).to match(/domain=\"testdomain[.]com\"/)
+
+      expect(cmd).to match(/forward_email=\"john@mail.com\"/)
+
+      expect(cmd).to match(/workgroup=\"staff\"/)
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'opensrs/email.rb'
+

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: opensrs-email
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Li Zhenchao
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: opensrs-email
+email:
+- zhenchao@strikingly.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/opensrs/email.rb
+- lib/opensrs/email/domain.rb
+- lib/opensrs/email/mailbox.rb
+- lib/opensrs/email/version.rb
+- lib/opensrs/email/workgroup.rb
+- opensrs-email.gemspec
+- spec/email_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2.1
+signing_key: 
+specification_version: 4
+summary: API to manage opensrs domain emails through APP (OpenSRS Email Service Account
+  Provisioning Protocol)
+test_files:
+- spec/email_spec.rb
+- spec/spec_helper.rb