fusebox 0.2.2 → 0.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 128f27fc4b727108ba232f8f664b58677cd5b64e
+  data.tar.gz: 13512c5ab86ed410c0f1909d79782245af33d4f0
+SHA512:
+  metadata.gz: abb499636f81ebdcbce3f4b3f7d6197cbd70f392456a9455475f18dde250ce3abe6142de6c7cc6a0e3b768a2b0fed9c09f16b72bfbb38465a46308d9f5be33c4
+  data.tar.gz: b21be721f34de55eb62ce10b7e947d0b59071c32f7829f8d55289669b975a10e362bec5792aa91d92730c795688d79efac5739f02c69560cc1809b6951220864

data/.gitignore

@@ -0,0 +1,5 @@
+._*
+.yardoc/
+doc/
+pkg/
+tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fusebox.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    fusebox (0.2.3)
+      activesupport (>= 2.0)
+      thor (~> 0.14)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.0.2)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.14)
+    diff-lcs (1.2.5)
+    i18n (0.6.9)
+    minitest (4.7.5)
+    multi_json (1.8.4)
+    rake (10.1.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.38)
+    yard (0.8.7.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  fusebox!
+  rake
+  rspec
+  yard

data/README.md

@@ -4,7 +4,7 @@
 
 [FuseMail](http://fusemail.com) is a business email hosting provider offering outsourced email hosting to businesses and resellers.
 
-**fusebox** is a ruby gem that provides a 1:1 native ruby interface for every command of [FuseMail Platform Programming Interface v2.6](http://www.fusemail.com/support/administration-api), which allows you to manage your accounts, domains, forwards, and aliases via an underlying HTTP interface.
+**fusebox** is a ruby gem that provides a 1:1 native ruby interface for every command of [FuseMail Platform Programming Interface v2.6](https://www.fusemail.com/support/api-documentation/), which allows you to manage your accounts, domains, forwards, and aliases via an underlying HTTP interface.
 
 ## Installation
     $ gem install fusebox
@@ -45,13 +45,9 @@ See the [Fusebox::Request](http://rubydoc.info/github/mudbugmedia/fusebox/master
 * [Project Documentation](http://rubydoc.info/github/mudbugmedia/fusebox/master/frames)
 * [Command Documentation](http://rubydoc.info/github/mudbugmedia/fusebox/master/Fusebox/Request)
 
-## TODO
-* Logging hook
-* Leverage ActiveModel to create Account, Domain, Alias, etc, classes.
-
 ## Authors
 The fusebox gem is independently developed and maintained by [Mudbug Media](http://mudbugmedia.com/) and [Gabe Martin-Dempesy](http://mudbugmedia.com/team/gabe).
 
 FuseMail LLC, and its parent company j2 Global Communications, do not provide support or maintenance for this software.
 
-Copyright © 2010
+Copyright © 2010 - 2014

data/Rakefile

@@ -0,0 +1,27 @@
+require "bundler/gem_tasks"
+
+task :default => :spec
+task :test => :spec
+
+namespace :cacert do
+  desc "Update cacert.pem from curl.haxx.se"
+  task :update do
+    exec "curl http://curl.haxx.se/ca/cacert.pem > vendor/curl-cacert.pem"
+  end
+end
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+  warn "warn: RSpec tests not available. `gem install rspec` to enable them."
+end
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.options = ['--verbose']
+  end
+rescue LoadError
+  warn "warn: YARD not available. `gem install yard` to enable."
+end

data/examples/fusemail.yaml

@@ -0,0 +1,2 @@
+username: my_username
+password: my_password

data/fusebox.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fusebox/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fusebox"
+  spec.version       = Fusebox::VERSION
+  spec.authors       = ["Gabe Martin-Dempesy"]
+  spec.email         = ["gabe@mudbugmedia.com"]
+  spec.description   = "FuseMail API client library and CLI"
+  spec.summary       = "FuseMail API client library and CLI"
+  spec.homepage      = "http://github.com/mudbugmedia/fusebox"
+  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_dependency "activesupport", ">= 2.0"
+  spec.add_dependency "thor", "~> 0.14"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "yard"
+end

data/lib/fusebox/cli.rb

@@ -23,7 +23,7 @@ module Fusebox
       response = Fusebox::Request.new.modify(:user => username, :alias => aliases)
       say response.detail
     end
-    
+
     desc "alias-ls user@example.com", "List aliases for a user"
     def alias_ls (username)
       response = Fusebox::Request.new.reportmail(:user => username, :report_type => 'alias')
@@ -33,20 +33,20 @@ module Fusebox
         warn response.detail
       end
     end
-    
+
     desc "alias-rm user@example.com alias1@example.com", "Remove an alias from a maccount"
     def alias_rm (username, alias_address)
       response = Fusebox::Request.new.removealias(:user => username, :alias => alias_address)
       say response.detail
     end
-    
+
     desc "domain-add [postmaster@]example.com new.example.com", "Add a domain a group account"
     def domain_add (username, domain)
       username = "postmaster@#{username}" unless username =~ /@/
       response = Fusebox::Request.new.adddomain(:user => username, :domain => domain)
       say response.detail
     end
-    
+
     desc "domain-rm secondary.example.com", "Remove a domain"
     method_options [:force, '-f'] => false
     def domain_rm (domain)
@@ -55,13 +55,13 @@ module Fusebox
         say response.detail
       end
     end
-    
+
     desc "enable user@example.com", "Enable a suspended user account"
     def enable (username)
       response = Fusebox::Request.new.enable(:user => username)
       say response.detail
     end
-    
+
     desc "get [user@]example.com", "Get aliases, forwarders, and mailing lists for an account"
     # @todo Display account metadata from `report`
     def get (username)
@@ -73,7 +73,7 @@ module Fusebox
         warn response.detail
       end
     end
-    
+
     desc "group-add [postmaster@]example.com [password]", "Create a group account"
     def group_add (username, password = nil)
       username = "postmaster@#{username}" unless username =~ /@/
@@ -82,7 +82,7 @@ module Fusebox
       response = Fusebox::Request.new.order(:account_type => 'standard', :user => username, :password => password, :first_name => first, :last_name => last)
       say response.detail
     end
-    
+
     desc "ls [[postmaster@]example.com]", "List accounts. This will list all group accounts if argument is blank"
     method_options [:recursive, '-r'] => :boolean
     # @todo add flag for ignoring terminated accounts
@@ -96,14 +96,14 @@ module Fusebox
         warn response.detail
       end
     end
-    
+
     desc "passwd user@example.com [newpassword]", "Change a user's password (will prompt if password left blank)"
     def passwd (username, password = nil)
       password = ask "New Password:" unless password
       response = Fusebox::Request.new.modify(:user => username, :password => password)
       say response.detail
     end
-    
+
     desc "rename old@example.com new@example.com", "Rename an account's username"
     def rename (old_username, new_username)
       response = Fusebox::Request.new.changeusername(:user => old_username, :newuser => new_username)
@@ -121,7 +121,7 @@ module Fusebox
         say "No action taken."
       end
     end
-    
+
     desc "suspend user@example.com", "Suspend a user account"
     def suspend (username)
       response = Fusebox::Request.new.suspend(:user => username)

data/lib/fusebox/core_ext/array.rb

@@ -1,47 +1,47 @@
 class Array
-  
+
   # Return an ASCII table for an array of hashes
   # @example
   #     [{:a => "Uno", :b => "Dos"}, {:a => "Ichi", :b => "Ni"}].to_ascii_table([:a, :b], %w(One Two))
   # @param [Array<Symbol>] keys Which keys to display, in order
   # @param [Array<Symbol>] labels Column headings for the keys
   # @return [String]
-  def to_ascii_table (keys, labels)    
+  def to_ascii_table (keys, labels)
     raise ArgumentError, "`labels` length does not match `keys` length" if keys.length != labels.length
     return '' if self.length == 0
     raise ArgumentError, "expected elements to be Hash instances; instead received: #{first.inspect}" unless first.is_a?(Hash)
-    
+
     widths = keys.map do |key|
       ([Hash[keys.zip(labels)]] + self).map { |row| row[key].to_s.length }.max
     end
-    
+
     text = ''
-    
+
     text += to_ascii_table_hr(widths)
-    
+
     labels.each_with_index do |key, i|
       text += "| " + labels[i].ljust(widths[i] + 1)
     end
     text += "|\n"
-    
+
     text += to_ascii_table_hr(widths)
-    
+
     each do |row|
       keys.each_with_index do |key, i|
         text +=  "| " + row[key].ljust(widths[i] + 1)
       end
       text +=  "|\n"
     end
-    
+
     text += to_ascii_table_hr(widths)
     text
   end
-  
+
 protected
   # Print a horizonal divider calc
   # @param [Array<Fixnum>] widths List of column widths
   def to_ascii_table_hr(widths)
     '+' + '-' * (widths.inject(&:+) + widths.length * 3 - 1 ) + "+\n"
   end
-  
+
 end

data/lib/fusebox/core_ext/net_http.rb

@@ -16,7 +16,7 @@ module Net
       http.ca_file = File.expand_path('../../../../vendor/curl-cacert.pem', __FILE__)
       http.start {|http|
         http.request(req)
-      }      
+      }
     end
   end
 end

data/lib/fusebox/request.rb

@@ -3,27 +3,27 @@ require 'yaml'
 module Fusebox
   # @see http://www.fusemail.com/support/administration-api
   class Request
-    
+
     class << self
       # @return [Array<String>] Paths to search for API platform authentication information
       attr_accessor :auth_yaml_paths
-    
+
       # @return [String] API URL to POST requests to
       attr_accessor :url
     end
-    
+
     # @return [String] Platform API username
     attr_accessor :username
 
     # @return [String] Platform API password
     attr_accessor :password
-    
+
     self.auth_yaml_paths = %w(~/.fusemail.yaml)
     self.url = 'https://www.fusemail.com/api/request.html'
-    
+
     # @return [Array<String>] List of available API commands
     COMMANDS = %w(adddomain addforward changeusername checkalias checkdomain suspend enable getforward modify order terminate removealias removedomain removeforward report reportmail)
-  
+
     # @param [String] username API username.  If not provided, auth_yaml_paths will be searched for authentication information instead.
     # @param [String] password API password
     def initialize (username = nil, password = nil)
@@ -34,9 +34,9 @@ module Fusebox
         load_auth_from_yaml
       end
     end
-  
+
     # This request will add a domain to the specified account. The must be under your platform
-    # @see http://www.fusemail.com/support/administration-api/requests/adddomain adddomain API documentation
+    # @see https://www.fusemail.com/support/api-documentation/requests#adddomain adddomain API documentation
     # @param [Array] opts
     # @option opts [String] :domain The domain to add
     # @option opts [String] :user The account to add the domain to
@@ -46,13 +46,13 @@ module Fusebox
         :domain => '',
         :user => ''
       }
-      
+
       opts.reverse_merge! default_options
       post 'adddomain', opts
     end
 
     # This request will add an email forwarder.
-    # @see http://www.fusemail.com/support/administration-api/requests/addforward addforward API documentation
+    # @see https://www.fusemail.com/support/api-documentation/requests#addforward addforward API documentation
     # @param [Array] opts
     # @option opts [String] :user Username of FuseMail account to add forwarder to
     # @option opts [String] :forward_what Email address of forwarder
@@ -64,14 +64,14 @@ module Fusebox
         :forward_what => '',
         :forward_to => ''
       }
-      
+
       opts.reverse_merge! default_options
       post 'addforward', opts
     end
 
-    
+
     # This request will check the availability of an alias against the whole system. Remember to add an alias, the domain must belong to the platform or to that account.
-    # @see http://www.fusemail.com/support/administration-api/requests/checkalias checkalias API documentation
+    # @see https://www.fusemail.com/support/api-documentation/requests#checkalias checkalias API documentation
     # @param [Array] opts
     # @option opts [String] :alias The alias to check the availability of (e.g. user@example.com)
     # @return [Response]
@@ -79,13 +79,13 @@ module Fusebox
       default_options = {
         :alias => ''
       }
-      
+
       opts.reverse_merge! default_options
       post 'checkalias', opts
     end
-    
+
     # This request is used to change the an account's username
-    # @see http://www.fusemail.com/support/administration-api/requests/changeusername changeusername API documentation
+    # @see https://www.fusemail.com/support/api-documentation/requests#changeusername changeusername API documentation
     # @param [Array] opts
     # @param opts [String] :user Username of FuseMail account to modify
     # @param opts [String] :newuser New username of the account
@@ -95,13 +95,13 @@ module Fusebox
         :user => '',
         :newuser => ''
       }
-      
+
       opts.reverse_merge! default_options
       post 'changeusername', opts
     end
-    
+
     # This request will check the availability of a domain name. This only checks if the domain name is available on our system, it does not reflect registrar status.
-    # @see http://www.fusemail.com/support/administration-api/requests/checkdomain checkdomain API documentation
+    # @see https://www.fusemail.com/support/api-documentation/requests#checkdomain checkdomain API documentation
     # @param [Array] opts
     # @option opts [String] :domain The domain to check the availability of
     # @return [Response]
@@ -109,13 +109,13 @@ module Fusebox
       default_options = {
         :domain => ''
       }
-      
+
       opts.reverse_merge! default_options
       post 'checkdomain', opts
     end
-    
+
     # This request is used to change the an account's username
-    # @see http://www.fusemail.com/support/administration-api/requests/suspend suspend API documentation
+    # @see https://www.fusemail.com/support/api-documentation/requests#suspend suspend API documentation
     # @param [Array] opts
     # @option opts [String] :user Username of FuseMail account to modify
     # @return [Response]
@@ -123,13 +123,13 @@ module Fusebox
       default_options = {
         :user => '',
       }
-      
+
       opts.reverse_merge! default_options
       post 'suspend', opts
     end
 
     # The enable request allow you to activate an account under your platform or temporarily start access to the account. Below are the variables that are specific to this request.
-    # @see http://www.fusemail.com/support/administration-api/requests/enable enable API documentation
+    # @see https://www.fusemail.com/support/api-documentation/requests#enable enable API documentation
     # @param [Array] opts
     # @option opts [String] :user Username of FuseMail account to enable
     # @return [Response]
@@ -137,13 +137,13 @@ module Fusebox
       default_options = {
         :user => ''
       }
-      
+
       opts.reverse_merge! default_options
       post 'enable', opts
     end
-  
+
     # This request will return the forward currently set on an alias in the {Response#detail} attribute
-    # @see http://www.fusemail.com/support/administration-api/requests/getforward getforward API documentation
+    # @see https://www.fusemail.com/support/api-documentation/requests#getforward getforward API documentation
     # @param [Array] opts
     # @option opts [String] :user Username of FuseMail account where the forwarding alias resides
     # @option opts [String] :forward_what Alias for the forwarder
@@ -153,25 +153,25 @@ module Fusebox
         :user => '',
         :forward_what => ''
       }
-      
+
       opts.reverse_merge! default_options
       post 'getforward', opts
     end
-  
+
     # This request is used to modify personal information, password, and the account plan of the account. Only send the variables you wish to modify. If a NULL variable is detected, no change will be made to the account.
-    # @see http://www.fusemail.com/support/administration-api/requests/modify modify API documentation
+    # @see https://www.fusemail.com/support/api-documentation/requests#modify modify API documentation
     # @param opts (see Fusemail::Request#order)
     # @return [Response]
     def modify (opts)
       default_options = {
       }
-      
+
       opts.reverse_merge! default_options
       post 'modify', opts
     end
-  
+
     # This is a request to submit a new order and create a new account under your Fused Platform account. Orders are processed within 5 minutes of request submission. Below are the variables that are specific to this type of request.
-    # @see http://www.fusemail.com/support/administration-api/requests/order order API documentation
+    # @see https://www.fusemail.com/support/api-documentation/requests#order order API documentation
     # @param [Array] opts
     # @option opts [String] :user Username of FuseMail account to create
     # @option opts [String] :password Password of FuseMail account to create
@@ -195,13 +195,13 @@ module Fusebox
         :last_name => '',
         :maxdisk => 1000
       }
-      
+
       opts.reverse_merge! default_options
       post 'order', opts
     end
-    
+
     # The terminate request is used to permanently remove an account and all of the account data associated with it. This operation cannot be reversed and therefore should be used with caution.
-    # @see http://www.fusemail.com/support/administration-api/requests/terminate terminate API documentation
+    # @see https://www.fusemail.com/support/api-documentation/requests#terminate terminate API documentation
     # @param [Array] opts
     # @option opts [String] :user Username of FuseMail account to terminate
     # @option opts [Boolean] :purge (false) Will purge all data (such as removing the username) from our system. This process might take a few hours to complete.
@@ -211,13 +211,13 @@ module Fusebox
         :user => '',
         :purge => false
       }
-      
+
       opts.reverse_merge! default_options
       post 'terminate', opts
     end
-    
+
     # This request will remove a single alias from a fusemail account
-    # @see http://www.fusemail.com/support/administration-api/requests/removealias removealias API documentation
+    # @see https://www.fusemail.com/support/api-documentation/requests#removealias removealias API documentation
     # @param [Array] opts
     # @option opts [String] :user FuseMail user to delete alias from
     # @option opts [String] :alias alias to delete (e.g. user@example.com )
@@ -227,13 +227,13 @@ module Fusebox
         :user => '',
         :alias => ''
       }
-      
+
       opts.reverse_merge! default_options
       post 'removealias', opts
     end
-    
+
     # This request will remove a domain name and all its mail aliases, auto-responders, mailing lists & forwarders associated with it. Please see below for the specific requirements for this request.
-    # @see http://www.fusemail.com/support/administration-api/requests/removedomain removedomain API documentation
+    # @see https://www.fusemail.com/support/api-documentation/requests#removedomain removedomain API documentation
     # @param [Array] opts
     # @option opts [String]  :domain The domain to delete
     # @option opts [Boolean] :confirm (true) This must be set to true to confirm that you understand all aliases, auto-responders, mailing lists & forwarders with this domain will be permanently deleted.
@@ -243,14 +243,14 @@ module Fusebox
         :domain => '',
         :confirm => true
       }
-      
+
       opts.reverse_merge! default_options
       post 'removedomain', opts
     end
-    
-    
+
+
     # This request will remove an existing email forwarder
-    # @see http://www.fusemail.com/support/administration-api/requests/removeforward removeforward API documentation
+    # @see https://www.fusemail.com/support/api-documentation/requests#removeforward removeforward API documentation
     # @param [Array] opts
     # @option opts [String] :user Username of FuseMail account to remove forwarder to
     # @option opts [String] :forward_what Email address of forwarder
@@ -262,13 +262,13 @@ module Fusebox
         :forward_what => '',
         :forward_to => ''
       }
-      
+
       opts.reverse_merge! default_options
       post 'removeforward', opts
     end
-    
+
     # This request will provide information about one or more accounts under your platform in CSV format
-    # @see http://www.fusemail.com/support/administration-api/requests/report report API documentation
+    # @see https://www.fusemail.com/support/api-documentation/requests#report report API documentation
     # @param [Array] opts
     # @option opts [String] :user ('all') The username you wish to query for information; you may also enter the username "all" to get information about all users under your platform
     # @option opts [Boolean] :group_subaccount (true) Provide information not only for the Group Administration account but also for the group sub-accounts under the Group Administration account
@@ -280,13 +280,13 @@ module Fusebox
         :group_subaccount => true,
         :report_type => 'basic'
       }
-      
+
       opts.reverse_merge! default_options
       post 'report', opts, "report_#{opts[:report_type]}".to_sym
     end
-    
+
     # This request will provide information about mail aliases, forwarders, autoresponders, or mailing lists on one or more accounts under your platform in CSV format.
-    # @see http://www.fusemail.com/support/administration-api/requests/reportmail reportmail API documentation
+    # @see https://www.fusemail.com/support/api-documentation/requests#reportmail reportmail API documentation
     # @param [Array] opts
     # @option opts [String] :user ('all') The username you wish to query for information; you may also enter the username "all" to get information about all users under your platform
     # @option opts [Boolean] :group_subaccount (true) Provide information not only for the Group Administration account but also for the group sub-accounts under the Group Administration account
@@ -303,13 +303,13 @@ module Fusebox
         :group_subaccount => true,
         :report_type => 'all'
       }
-      
+
       opts.reverse_merge! default_options
       post 'reportmail', opts, :reportmail
     end
-    
+
     # The suspend request allow you to suspend an account under your platform or temporarily stop access to the account without deleting any of the accounts data. Below are the variables that are specific to this request.
-    # @see http://www.fusemail.com/support/administration-api/requests/suspend suspend API documentation
+    # @see https://www.fusemail.com/support/api-documentation/requests#suspend suspend API documentation
     # @param [Array] opts
     # @option opts [String] :user Username of FuseMail account to suspend
     # @return [Response]
@@ -317,13 +317,13 @@ module Fusebox
       default_options = {
         :user => ''
       }
-      
+
       opts.reverse_merge! default_options
       post 'suspend', opts
     end
-  
+
 protected
-  
+
     # Load the platform authentication informaiton from a YAML file
     # @see Request.auth_yaml_paths
     def load_auth_from_yaml
@@ -333,10 +333,10 @@ protected
         @password = auth['password']
         return if @username && @password
       end
-      
+
       raise "Could not locate a fusemail authentication file in locations: #{self.class.auth_yaml_paths.inspect}"
     end
-  
+
     # @param [String] command
     # @param [Hash] post_vars
     # @param [Fusebox::Request::CSV_MAPS.keys, nil] result_map_type (nil) For commands that return CSV data, which column map to use
@@ -344,11 +344,11 @@ protected
     def post (command, post_vars, result_map_type = nil)
       post_vars.reverse_merge!(:PlatformUser => @username, :PlatformPassword => @password, :request => command)
       post_vars = self.class.convert_post_vars(post_vars)
-      
+
       result = Net::HTTP.post_form_with_ssl(URI.parse(self.class.url), post_vars)
       Response.new(result, result_map_type)
     end
-    
+
     # Convert non-string values in post vars to Fusemail's expected formatting
     # * Boolean => 'yes' or 'no'
     # * Array   => Remove 'foo' and create 'foo[0]', 'foo[1]'
@@ -360,7 +360,7 @@ protected
         # Convert booleans to 'yes', 'no' strings
         if [TrueClass, FalseClass].include?(value.class)
           ret[key] = (value ? 'yes' : 'no')
-        
+
         # Convert arrays into 'key[0]', 'key[1]', ...
         elsif value.class == Array
           value.each_with_index do |value, index|
@@ -370,9 +370,9 @@ protected
           ret[key] = value
         end
       end
-      
+
       ret
     end
-    
+
   end
-end
+end