mailroute 0.0.4 → 0.0.5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mailroute (0.0.4)
+    mailroute (0.0.5)
       activeresource
       json_pure
       rest-client

data/README.md

@@ -24,74 +24,81 @@ Or install it by yourself as:
 
 # Configuration
 
-    Mailroute.configure(
-      :username => '<username here>',
-      :apikey => '0d1a...a33'
-    )
-
+```ruby
+Mailroute.configure(
+  :username => '<username here>',
+  :apikey => '0d1a...a33'
+)
+```
 
 # Reseller
 
-    # A list of resellers
-    Mailroute::Reseller.list #=> [...]
+```ruby
+# A list of resellers
+Mailroute::Reseller.list #=> [...]
 
-    # You can specify limit and offset
-    Mailroute::Reseller.list.offset(20).limit(30) #=> [...]
+# You can specify limit and offset
+Mailroute::Reseller.list.offset(20).limit(30) #=> [...]
 
-    reseller = Mailroute::Reseller.get(12) #=> Reseller<...>
-    reseller.name #=> "John Doe"
-    reseller.name = 'Jane Doe'
-    reseller.save
+reseller = Mailroute::Reseller.get(12) #=> Reseller<...>
+reseller.name #=> "John Doe"
+reseller.name = 'Jane Doe'
+reseller.save
 
-    Mailroute::Reseller.get(12).name #=> 'Jane Doe'
+Mailroute::Reseller.get(12).name #=> 'Jane Doe'
 
-    reseller.delete
+reseller.delete
 
-    Mailroute::Reseller.get(12) #=> ActiveResource::ResourceNotFound
+Mailroute::Reseller.get(12) #=> ActiveResource::ResourceNotFound
 
-    reseller = Mailroute::Reseller.get(name: 'John Smith') #=> Reseller<...>
+reseller = Mailroute::Reseller.get(name: 'John Smith') #=> Reseller<...>
 
-    resellers = Mailroute::Reseller.search('Smith') #=> [Reseller<...>, ...]
-    resellers.include?(reseller) #=> true
+resellers = Mailroute::Reseller.search('Smith') #=> [Reseller<...>, ...]
+resellers.include?(reseller) #=> true
 
-    Mailroute::Reseller.filter(name: 'Smith') #=> [...]
-    Mailroute::Reseller.filter(name__exact: 'John Smith') #=> [...]
-    Mailroute::Reseller.filter(name__starts_with: 'Jo') #=> [...]
+Mailroute::Reseller.filter(name: 'Smith') #=> [...]
+Mailroute::Reseller.filter(name__exact: 'John Smith') #=> [...]
+Mailroute::Reseller.filter(name__starts_with: 'Jo') #=> [...]
 
-    Mailroute::Reseller.list.order_by('-name')
-    Mailroute::Reseller.list.order_by('name')
-    Mailroute::Reseller.list.order_by('created_at')
+Mailroute::Reseller.list.order_by('-name')
+Mailroute::Reseller.list.order_by('name')
+Mailroute::Reseller.list.order_by('created_at')
 
-    new_reseller = Mailroute::Reseller.create(name: 'New Guy') #=> Reseller<...>
-    new_reseller.id #=> 11111
+new_reseller = Mailroute::Reseller.create(name: 'New Guy') #=> Reseller<...>
+new_reseller.id #=> 11111
 
-    new_resellers = Mailroute::Reseller.bulk_create(
-        { name: 'R2D2' },
-        { name: '3PO' },
-        { name: 'Luke Skywalker' }
-    )
-    new_resellers.count #=> 3
+new_resellers = Mailroute::Reseller.bulk_create(
+    { name: 'R2D2' },
+    { name: '3PO' },
+    { name: 'Luke Skywalker' }
+)
+new_resellers.count #=> 3
 
-    # mass deletion
-    #   by ids:
-    Mailroute::Reseller.delete([10, 12, 13])
-    #   by instances:
-    Mailroute::Reseller.delete(new_resellers)
+# mass deletion
+#   by ids:
+Mailroute::Reseller.delete([10, 12, 13])
+#   by instances:
+Mailroute::Reseller.delete(new_resellers)
 
-    # Associations:
-    reseller.customers #=> [Customer<...>, ...]
-    reseller.admins #=> [Admin<...>, ...]
-    reseller.contacts #=> [ResellerContact<...>, ...]
-    reseller.branding_info #=> BrandingInfo<...>
+# Associations:
+reseller.customers #=> [Customer<...>, ...]
+reseller.admins #=> [Admin<...>, ...]
+reseller.contacts #=> [ResellerContact<...>, ...]
+reseller.branding_info #=> BrandingInfo<...>
 
-    send_welcome = true
-    reseller.create_admin('admin@example.com', send_welcome) #=> Admin<...>
-    reseller.delete_admin('admin@example.com')
-    reseller.create_contact(params) #=> ResellerContact<...>
-    reseller.create_customer(params) #=> Customer<...>
+send_welcome = true
+reseller.create_admin('admin@example.com', send_welcome) #=> Admin<...>
+reseller.delete_admin('admin@example.com')
+reseller.create_contact(params) #=> ResellerContact<...>
+reseller.create_customer(params) #=> Customer<...>
 
-    # All list operations allow chaining
-    Mailroute::Reseller.limit(10).offset(30).filter(name: 'Fox').order('created_at') #=> [Reseller<...>, ...]
+# All list operations allow chaining
+Mailroute::Reseller.
+  limit(10).
+  offset(30).
+  filter(name: 'Fox').
+  order('created_at') #=> [Reseller<...>, ...]
+```
 
 ## Contributing
 

data/lib/mailroute.rb

@@ -19,10 +19,13 @@ require 'mailroute/models/admin'
 require 'mailroute/models/reseller'
 require 'mailroute/models/branding_info'
 require 'mailroute/models/domain_alias'
+require 'mailroute/models/anti_spam_modes'
+require 'mailroute/models/policy_filter'
 require 'mailroute/models/policy_user'
 require 'mailroute/models/notification_account_task'
 require 'mailroute/models/email_account_contact'
 require 'mailroute/models/wblist'
+require 'mailroute/models/localpart_alias'
 require 'mailroute/models/email_account'
 require 'mailroute/models/mail_server'
 require 'mailroute/models/outbound_server'

data/lib/mailroute/models/anti_spam_modes.rb

@@ -0,0 +1,11 @@
+module Mailroute
+  module AntiSpamModes
+    LENIENT = 'lenient'
+    STANDARD = 'standard'
+    AGGRESSIVE = 'aggressive'
+
+    def self.valid?(mode)
+      [LENIENT, STANDARD, AGGRESSIVE].include?(mode)
+    end
+  end
+end

data/lib/mailroute/models/email_account.rb

@@ -6,6 +6,7 @@ module Mailroute
     has_one :notification_task, :class => NotificationAccountTask
     has_one :contact, :class => EmailAccountContact
     has_many :wblist, :class => WBList
+    has_many :aliases, :class => LocalpartAlias
 
     def blacklist
       WBList.filter(:email_account => id, :wb => 'b').map(&:email)
@@ -34,6 +35,15 @@ module Mailroute
       self.class.format.decode(response.body)['api_key']
     end
 
+    def add_alias(localpart)
+      LocalpartAlias.create(:email_account => self, :localpart => localpart)
+    end
+
+    def bulk_add_aliases(localparts)
+      request_body = self.class.format.encode(:aliases => localparts)
+      connection.post(element_path(prefix_options) + 'mass_add_aliases/', request_body, self.class.headers)
+    end
+
     class << self
       alias_method :get_by_id, :get
       def get(*args)

data/lib/mailroute/models/localpart_alias.rb

@@ -0,0 +1,7 @@
+module Mailroute
+  class LocalpartAlias < Base
+    self.collection_name = 'localpart_alias'
+    has_one :email_account
+    has_one :domain
+  end
+end

data/lib/mailroute/models/policy_domain.rb

@@ -2,5 +2,7 @@ module Mailroute
   class PolicyDomain < Base
     self.collection_name = 'policy_domain'
     has_one :domain
+
+    include PolicyFilter
   end
 end

data/lib/mailroute/models/policy_filter.rb

@@ -0,0 +1,21 @@
+module Mailroute
+  module PolicyFilter
+    %w(spam virus header banned).each do |type|
+      define_method("disable_#{type}_filter") do
+        attributes["bypass_#{type}_checks"] = 'Y'
+        save!
+      end
+
+      define_method("enable_#{type}_filter") do
+        attributes["bypass_#{type}_checks"] = 'N'
+        save!
+      end
+    end
+
+    def set_anti_spam_mode(mode)
+      raise ArgumentError, "Invalid mode #{mode}" unless AntiSpamModes.valid?(mode)
+      attributes['anti_spam_preset'] = mode
+      save!
+    end
+  end
+end

data/lib/mailroute/models/policy_user.rb

@@ -2,5 +2,7 @@ module Mailroute
   class PolicyUser < Base
     self.collection_name = 'policy_user'
     has_one :email_account
+
+    include PolicyFilter
   end
 end

data/lib/mailroute/version.rb

@@ -1,3 +1,3 @@
 module Mailroute
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/requirements.txt

@@ -0,0 +1,223 @@
+                                                                     
+                                                                     
+                                                                     
+                                             
+import mailroute
+
+mailroute.configure(username="blabla", apikey="blabla")
+
+Reseller resource and common actions/interface.
+
+reseller_list = mailroute.Reseller.list()                               # list
+reseller_list = mailroute.Reseller.list().limit(20)                     # list
+reseller_list = mailroute.Reseller.list().offset(20)                    # list
+reseller = mailroute.Reseller.get(id=12)                                # 1 instance
+reseller.name = "newname"
+reseller.save()
+reseller = mailroute.Reseller.get(name="test")                          # 1 instance
+reseller.name      # test
+reseller.delete()
+reseller_list = mailroute.Reseller.search("searchstr")                  # list
+reseller_list = mailroute.Reseller.filter(name__startswith="begin")     # list
+reseller_list = mailroute.Reseller.filter(name__exact="begin")          # list
+reseller_list = mailroute.Reseller.filter(name="begin")                 # list
+
+# all list field allow ordering
+
+reseller_list = mailroute.Reseller.filter(name="begin").order_by("-name")         # list
+reseller_list = mailroute.Reseller.filter(name="begin").order_by("name")          # list
+reseller_list = mailroute.Reseller.filter(name="begin").order_by("created_at")    # list
+
+new_reseller  =  mailroute.Reseller.create(name="newresl")
+mailroute.Reseller.bulk_create([{'name':"r1"},{"name":"r2"}])                     # mass create
+mailroute.Reseller.delete([reseller1,reseller2])                                  # mass delete of resellers  by instance of list of pk
+
+reseller.customers                                       # list of customers - additional api call , cached
+reseller.admins                                          # list of admins - additional api call , cached
+reseller.contacts                                        # list of contacts - additional api call , cached
+reseller.branding_info                                   # branding info instance for this reseller, api call, cached
+
+reseller.create_admin(email, send_welcome)
+reseller.delete_admin(email)
+reseller.create_contact(params)
+reseller.create_customer(params)
+
+
+
+CUSTOMER RESORUCE
+# crud same as reseller.
+
+customer =  mailroute.Customer.get(id=12)
+
+# create
+customer_new  =  mailroute.Customer.create({'name':"newresl", "customer":mailroute.Customer.get(id=12)})
+customer_new  =  mailroute.Customer.create({'name':"newresl", "customer":"customername"})                 # reference via name
+customer_new  =  mailroute.Customer.create({'name':"newresl", "customer":3})                              # reference via id
+
+# When create references can be object or their key fields
+
+get fields = id, name
+create fields required =  name, reseller
+filter = name , reseller
+ordering = ['name', 'created_at']
+relation fields list = reseller, domains, contacts, admins
+relation fields one = branding_info
+
+
+customer.create_domain(params)
+customer.create_contact(params)
+customer.create_admin(email, send_welcome)
+customer.delete_admin(email)
+
+
+DOMAIN RESORUCE
+
+get fields = id, name
+filter = name , customer
+create fields required =  name, customer
+create fields optional =  hold_email, active, deliveryport, userlist_complete, outbound_enabled
+ordering = ['name', 'created_at', 'active', 'hold_email' ]
+relation fields list = customer (R), domain_aliases , email_accounts, mail_servers, outbound_servers, contacts, blacklist, whitelist , outbound_servers
+relation fields one =  policy (RU), notification_task (RU)
+
+domain.get_quarantine()                       # return quarantine list
+domain.move_to_customer(customer_instance)    # move domain
+domain.create_contact(params)
+domain.create_mailserver(params)
+domain.create_outbound_server(params)
+domain.create_email_account(params)
+domain.bulk_create_email_account([{},{}])
+domain.create_alias(params)
+domain.create_outbound_server("1.2.1.1")
+domain.add_to_blacklist("spam@spam.com")
+domain.add_to_whitelist("nospam@nospam.com")
+
+
+
+DOMAINALIASRESOURCE
+get fields = id,name
+filter = domain
+ordering = ['name', 'created_at']
+create fields required =  name, domain
+create fields optional = active
+relation fields one =  domain
+
+
+MAILSERVERRESOURCE
+get fields = id
+filter = domain
+ordering = ['server', 'priority', ]
+create fields required =  server, domain
+create fields optional = active
+relation fields one =  domain
+
+
+POLICYDOMAINRESOURCE - ONLY RU
+get fields = id
+
+mailroute.Policy.get_default_policy()           # return global default policy
+
+relation fields one =  domain
+
+POLICYUSERRESOURCE - ONLY RU
+get fields = id
+relation fields one =  email_account
+
+notification_account_task.use_domain_policy()
+notification_account_task.use_self_policy()
+notification_account_task.is_active()
+
+
+
+EMAILACCOUNTRESOURCE
+
+get fields = id, localpart+domain
+filter = domain, localpart
+ordering = ['localpart', 'priority', 'domain', 'created_at']
+create fields required =  name, domain, localpart, create_opt ( choice of "generate_pwd","set_pwd")
+create fields opt = password, send_welcome
+relation fields one =  domain , policy, notification_task  , contact
+relation fields list = aliases, blacklist, whitelist, quarantine
+
+
+email_account.set_password("newpsswwd")
+email_account.create_user(password=None, send_welcome=True)
+mailroute.EmailAccount.create("localpart@domain.com")
+email_account.create_user(password=None, send_welcome=True)
+mailroute.EmailAccount.create("localpart@domain.com")
+email_account.convert_to_alias()
+email_account.bulk_add_alias(["alias1","alias2"])
+email_account.add_alias("alias")
+email_account.add_to_blacklist("spam@spam.com")
+email_account.add_to_whitelist("nospam@nospam.com")
+
+
+LOCALPARTALIASRESOURCE
+get fields = id
+filter = email_account
+ordering = ['localpart', 'created_at', 'updated_at', ]
+create fields required =  email_account,  localpart
+relation fields one =  email_account, domain
+
+
+RESELLERCONTACTRESOURCE,CUSTOMERCONTACTRESOURCE,DOMAINCONTACTRESOURCE
+get fields = id
+filter = email, ( customer,reseller,domain)
+ordering = ['first_name', 'last_name', 'email', 'is_technical', 'is_billing', 'is_emergency']
+create fields required =  email
+create fields opt =  first_name ,last_name,email, city,state, zipcode ,country, phone, address , address2 , is_technical, is_billing , is_emergency
+relation fields one = ( customer,reseller,domain)
+
+EMAILACCOUNTCONTACTRESOURCE
+get fields = id
+filter = email_account, email
+ordering = ['first_name', 'last_name', 'email', 'is_technical', 'is_billing', 'is_emergency']
+create fields required =  email
+create fields opt =  first_name ,last_name,email, city,state, zipcode ,country, phone, address , address2 , is_technical ,   is_billing , is_emergency
+relation fields one = email_account
+
+OUTBOUNDSERVERRESOURCE
+get fields = id
+filter = domain
+create fields required =  server
+relation fields one = domain
+
+NOTIFICATIONDOMAINTASKRESOURCE
+get fields = id
+filter = domain
+relation fields one = domain
+
+NOTIFICATIONACCOUNTTASKRESOURCE
+get fields = id
+filter = email_account
+relation fields one = email_account
+
+notification_account_task.use_domain_notification()
+notification_account_task.use_self_notification()
+notification_account_task.is_active()
+
+
+WBLISTRESOURCE
+get fields = id
+filter = domain, email_account, wb
+create fields required =  email, (email_account or domain), wb ( b for blacklist, w for whitelist)
+relation fields one = domain, email_account
+
+
+ADMINRESOURCE
+get fields = id
+filter = domain, email_account, wb
+create fields required =  email, (email_account or domain), wb ( b for blacklist, w for whitelist)
+relation fields one = domain, email_account
+
+
+QUARANTINERESOURCE
+filter = domain, email_account , content ,rs,rid,email
+ordering_dict = recipient,from_addr,spam_level,time_num,size,subject
+
+message.whitelist_sender()
+message.recover()
+qlist = mailroute.Quarantine.filter(email_account=email_account_inst)
+qlist.delete()
+qlist.recover()
+qlist.whitelist_sender(what='email',for='domain')                             # values for what email, domain for - domain,emailaccount.