mynewsletterbuilder 1.19

data/README

@@ -0,0 +1,32 @@
+WWW-MyNewsletterBuilder version 0.021
+===============================
+
+This is the first version of the Ruby interface for the api.mynewsletterbuilder.com
+XML-RPC API.  Contact support@mynewsletterbuilder.com for an API key. 
+
+INSTALLATION
+
+To install this gem (make sure gemforge is present in your gem repo) type the following:
+
+	sudo gem install mynewsletterbuilder
+					or
+	gem install mynewsletterbuilder 
+   
+   
+Require the gem in your application
+	
+	require 'rubygems'
+	require 'mynewsletterbuilder'
+
+
+DEPENDENCIES
+
+This module requires these other modules and libraries:
+
+	xmlrpc/client
+	
+COPYRIGHT AND LICENCE
+
+Copyright (C) 2010 by JBA Network
+
+Author: Devin Eldreth <devin@jbanetwork.com>

data/lib/mynewsletterbuilder.rb

@@ -0,0 +1,522 @@
+require 'xmlrpc/client'
+
+# $Id: mynewsletterbuilder.rb 67532 2011-09-22 15:50:48Z devin $
+# Super awesome magic sauce ruby wrapper
+# Follwing any lack of documentation one should reference the main MNB api calls/structure. 
+# This is simply a wrapper.
+
+class MyNewsletterBuilder	
+	attr_accessor :client, :validation, :api_key, :api_secure
+	
+	API_VERSION = '1.0'
+	BUILD       = '$Revision: 67532 $'
+	
+	# Instance variables for wrappers
+	@@api_host = 'api.mynewsletterbuilder.com'
+	@@timeout  = 300
+	
+	def initialize( api_key, validate = false, secure = true )
+		if !api_key 
+			raise "An api key is required. Contact MyNewsletterBuilder to receive a key"
+		end
+		
+		@api_key    = api_key
+		@validation = validate
+		@api_secure = { 
+						"secure" => secure, 
+						"port"   => ( secure ) ? 443 : 80
+					  }
+		
+		# Initilize the XMLRPC client for this instance
+		@client     = XMLRPC::Client.new3({
+						'host'    => @@api_host,
+						'path'    => '/' + API_VERSION + '/',
+						'use_ssl' => @api_secure["secure"],
+						'port'    => @api_secure["port"],
+					  })
+					  
+		if !@client
+			raise "Unable to connect to xmlrpc server with credentials: #{@@api_host}/#{API_VERSION}/ with ssl = #{@api_secure["secure"]}"
+		end
+		
+		@client.http_header_extra = {"MNB_API" => "MNB_API Ruby #{API_VERSION}/$Revision: 67532 $"}
+		@client.timeout           = @@timeout 
+	end
+	
+	# public getter for checking if instance will use_ssl xmlrpc communication
+	def isSecure?
+		return @api_secure["secure"]
+	end
+	
+	def Campaigns ( filters = [] )
+	end
+	
+	def CampaignDetails ( *args )
+		id = args.shift
+		
+		execute( "CampaignDetails", id )
+	end
+	
+	def CampaignCreate ( *args )
+		name    = args.shift
+		subject = args.shift
+		from    = args.shift
+		reply   = args.shift
+		html    = args.shift
+		text    = args.shift
+		link_tracking = args.shift
+		gat     = args.shift
+		
+		return execute( 
+			"CampaignCreate",
+			name,
+			subject,
+			from,
+			reply,
+			html,
+			text,
+			link_tracking,
+			gat
+		)
+	end
+	
+	def CampaignUpdate ( *args )
+		id      = args.shift
+		details = args.shift
+		
+		signature = {
+			'name'          => { 'value' => 'string' },
+			'subject'       => { 'value' => 'string' },
+			'html'          => { 'value' => 'string' },
+			'text'          => { 'value' => 'string', 'emptyOk' => true },
+			'link_tracking' => { 'value' => 'boolean', 'emptyOk' => true },
+			'gat'           => { 'value' => 'boolean', 'emptyOk' => true }
+		}
+		
+		signature['from'] = {
+			'value' => {
+				'name'  => { 'value' => 'string' },
+				'email' => { 'value' => 'string' }
+			}
+		}
+		
+		signature['reply'] = {
+			'value' => {
+				'name'  => { 'value' => 'string' },
+				'email' => { 'value' => 'string' }
+			},
+			'emptyOk'   => true
+		}
+		
+		return execute( 
+			"CampaignUpdate",
+			id,
+			details
+		)
+	end
+	
+	def CampaignCopy ( id, name )
+		if !name
+			name = ''
+		end
+		
+		return execute(
+			"CampaignCopy",
+			id,
+			name
+		)
+	end
+	
+	def CampaignDelete ( id )
+		id = intify( id )
+		
+		return execute(
+			"CampaignDelete",
+			id
+		)
+	end
+	
+	def CampaignStats ( id )
+		id = intify( id )
+		
+		return execute(
+			"CampaignStats",
+			id
+		)
+	end
+	
+	def CampaignRecipients ( id, page = 0, limit = 1000 )
+		id    = intify( id )
+		page  = intify( page )
+		limit = intify( limit )
+		
+		return execute(
+			"CampaignRecipients",
+			id,
+			page,
+			limit
+		)
+	end
+	
+	def CampaignOpens ( id, page = 0, limit = 1000 )
+		id    = intify( id )
+		page  = intify( page )
+		limit = intify( limit )
+		
+		return execute(
+			"CampaignOpens",
+			id,
+			page,
+			limit
+		)
+	end
+	
+	def CampaignSubscribes ( id, page = 0, limit = 1000 )
+		id    = intify( id )
+		page  = intify( page )
+		limit = intify( limit )
+		
+		return execute(
+			"CampaignSubscribes",
+			id,
+			page,
+			limit
+		)
+	end
+	
+	def CampaignUnsubscribes ( id, page = 0, limit = 1000 )
+		id    = intify( id )
+		page  = intify( page )
+		limit = intify( limit )
+		
+		return execute(
+			"CampaignUnsubscribes",
+			id,
+			page,
+			limit
+		)
+	end
+	
+	def CampaignBounces ( id, page = 0, limit = 1000 )
+		id    = intify( id )
+		page  = intify( page )
+		limit = intify( limit )
+		
+		return execute(
+			"CampaignBounces",
+			id,
+			page,
+			limit
+		)
+	end
+	
+	def CampaignUrls ( id ) 
+		id = intify( id )
+		
+		return execute(
+			"CampaignUrls",
+			id
+		)
+	end
+	
+	def CampaignClicks ( id, page = 0, limit = 1000 )
+		id    = intify( id )
+		page  = intify( page )
+		limit = intify( limit )
+		
+		return execute(
+			"CampaignClicks",
+			id,
+			page,
+			limit
+		)
+	end
+	
+	def CampaignClickDetails ( id, url_id = 0, page = 0, limit = 1000 )
+		id     = intify( id )
+		url_id = intify( url_id )
+		page   = intify( page )
+		limit  = intify( limit )
+		
+		return execute(
+			"CampaignClickDetails",
+			id,
+			url_id,
+			page,
+			limit
+		)
+	end 
+	
+	def Lists
+		return execute("Lists")
+	end
+	
+	def ListDetails ( id )
+		id = intify( id )
+		
+		return execute(
+			"ListDetails",
+			id
+		)
+	end
+	
+	def ListCreate ( name, description = '', visible = false, default = false )
+		name    = stringify( name )
+		desc    = stringify( description )
+		visible = visible
+		default = default
+		
+		return execute(
+			"ListCreate",
+			name,
+			desc,
+			visible,
+			default
+		)
+	end
+	
+	def ListUpdate ( id, name, details )
+		id      = intify( id )
+		name    = stringify( name || '' )
+		details = details
+		
+		signature = {
+			'name'        => { 'value' => 'string', 'emptyOk' => true },
+			'description' => { 'value' => 'string', 'emptyOk' => true },
+			'visible'     => { 'value' => 'boolean', 'emptyOk' => true },
+			'default'     => { 'value' => 'boolean', 'emptyOk' => true }
+		}
+		
+		return execute(
+			"ListUpdate",
+			id,
+			name,
+			details
+		)
+	end
+	
+	def ListDelete ( id, delete_subs = false )
+		id = intify( id )
+		
+		return execute(
+			"ListDelete",
+			id,
+			delete_subs
+		)
+	end
+	
+	def Subscribers ( statuses, lists, page = 0, limit = 1000 )
+		statuses = statuses
+		lists    = lists
+		page     = intify( page )
+		limit    = intify( limit )
+		
+		return execute(
+			"Subscribers",
+			statuses,
+			lists,
+			page,
+			limit
+		)
+	end
+	
+	def SubscriberDetails ( id_or_email )
+		id_or_email = stringify( id_or_email )
+		
+		return execute(
+			"SubscriberDetails",
+			id_or_email
+		)
+	end
+	
+	def Subscribe ( details, lists, skip_opt_in = false, update_existing = true )
+		details = details
+		lists   = lists
+		
+		signature = {
+			'email'        => { 'value' => 'string' },
+			'first_name'   => { 'value' => 'string', 'emptyOk' => true },
+			'middle_name'  => { 'value' => 'string', 'emptyOk' => true },
+			'last_name'    => { 'value' => 'string', 'emptyOk' => true },
+			'full_name'    => { 'value' => 'string', 'emptyOk' => true },
+			'company_name' => { 'value' => 'string', 'emptyOk' => true },
+			'job_title'    => { 'value' => 'string', 'emptyOk' => true },
+			'phone_work'   => { 'value' => 'string', 'emptyOk' => true },
+			'phone_home'   => { 'value' => 'string', 'emptyOk' => true },
+			'address_1'    => { 'value' => 'string', 'emptyOk' => true },
+			'address_2'    => { 'value' => 'string', 'emptyOk' => true },
+			'address_3'    => { 'value' => 'string', 'emptyOk' => true },
+			'city'         => { 'value' => 'string', 'emptyOk' => true },
+			'state'        => { 'value' => 'string', 'emptyOk' => true },
+			'zip'          => { 'value' => 'string', 'emptyOk' => true },
+			'country'      => { 'value' => 'string', 'emptyOk' => true }
+		}
+		
+		return execute(
+			"Subscribe",
+			details,
+			lists,
+			skip_opt_in,
+			update_existing
+		)
+	end
+	
+	def SubscribeBatch ( subscribers, lists, skip_opt_in = false, update_existing = true )
+		signature = {
+			'email'        => { 'value' => 'string' },
+			'first_name'   => { 'value' => 'string', 'emptyOk' => true },
+			'middle_name'  => { 'value' => 'string', 'emptyOk' => true },
+			'last_name'    => { 'value' => 'string', 'emptyOk' => true },
+			'full_name'    => { 'value' => 'string', 'emptyOk' => true },
+			'company_name' => { 'value' => 'string', 'emptyOk' => true },
+			'job_title'    => { 'value' => 'string', 'emptyOk' => true },
+			'phone_work'   => { 'value' => 'string', 'emptyOk' => true },
+			'phone_home'   => { 'value' => 'string', 'emptyOk' => true },
+			'address_1'    => { 'value' => 'string', 'emptyOk' => true },
+			'address_2'    => { 'value' => 'string', 'emptyOk' => true },
+			'address_3'    => { 'value' => 'string', 'emptyOk' => true },
+			'city'         => { 'value' => 'string', 'emptyOk' => true },
+			'state'        => { 'value' => 'string', 'emptyOk' => true },
+			'zip'          => { 'value' => 'string', 'emptyOk' => true },
+			'country'      => { 'value' => 'string', 'emptyOk' => true }
+		}
+		
+		return execute(
+			"SubscribeBatch",
+			subscribers,
+			lists,
+			skip_opt_in,
+			update_existing
+		)
+	end
+	
+	def SubscriberUnsubscribe ( id_or_email )
+		id_or_email = stringify( id_or_email )
+		
+		return execute(
+			"SubscriberUnsubscribe",
+			id_or_email
+		)
+	end
+	
+	def SubscriberUnsubscribeBatch ( ids_or_emails )
+		ids_or_emails = ids_or_emails
+		
+		return execute(
+			"SubscribeUnsubscribeBatch",
+			ids_or_emails
+		)
+	end
+	
+	def SubscriberDelete ( id_or_email )
+		id_or_email = stringify( id_or_email )
+		
+		return execute(
+			"SubscriberDelete",
+			id_or_email
+		)
+	end
+	
+	def SubscribeDeleteBatch ( ids_or_emails )
+		ids_or_emails = ids_or_emails
+		
+		return execute(
+			"SubscribeDeleteBatch",
+			ids_or_emails
+		)
+	end
+	
+	def AccountDetails
+		execute( "AccountDetails", '' )
+	end
+	
+	def AccountKeys ( username, password, disabled = false )
+		
+	end
+	
+	def accountKeyCreate ( username, password )
+	end
+	
+	def accountKeyEnable ( username, password, id_or_key )
+	end
+	
+	def accountKeyDisable ( username, password, id_or_key )
+	end
+	
+	def HelloWorld ( val )
+		execute( "HelloWorld", val )
+	end
+		
+	private
+	# Execute an xmlrpc call with given method name and variable arguments
+	def execute ( method, *args )
+		if !@client 
+			raise "Unable to validate xmlrpc client connection"
+		end
+
+		begin
+			response = @client.call(method, @api_key, *args)
+		rescue XMLRPC::FaultException => fault
+			# The PHP server was returning php NULL for an empty result set... Ruby didn't like this
+			# return nil on the InvalidTypeEncodeException
+			match = fault.faultString.scan(/XML_RPC2_InvalidTypeEncodeException/)
+			
+			if match
+				return nil
+			else
+				retry
+			end
+		else
+			return response
+		end
+	end
+	
+	# Throw an error and die if data validation has been turned on
+	def error ( msg )
+		if @validation
+			raise "Unable to properly validate a parameter"
+		end
+		
+		print msg
+	end
+	
+	# Methods following this will be in private scope
+	def validateHash ( *args )
+		hash      = args.shift
+		signature = args.shift
+		emptyOk   = args.shift || false
+		
+		if !hash and !emptyOk
+			puts 'errrr'
+		end
+		
+		signature.each_pair do |key, value|
+			
+		end
+		
+		return hash
+	end
+	
+	def intify ( value )
+		begin
+			Integer( value )
+		rescue
+			error( "Invalid param passed to: " + caller(1).to_s + ". Expected Integer recieved " + value.class.to_s + ". Alpha characters will be truncated." )
+			value = value.to_i
+			retry 
+		else
+			return value.to_i
+		end
+	end
+	
+	def stringify ( value )
+		begin
+			String( value )
+		rescue
+			error( "Invalid param passed to: " + caller(1).to_s + ". Expected String recieved " + value.class.to_s + "." )
+			return value.to_s
+		else
+			return value.to_s
+		end
+	end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification 
+name: mynewsletterbuilder
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: "1.19"
+platform: ruby
+authors: 
+- Devin Eldreth
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-25 00:00:00 Z
+dependencies: []
+
+description: The MNB API is an easy way to directly manipulate your mailing needs through an xmlrpc interface.
+email: 
+- devin@jbanetwork.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/mynewsletterbuilder.rb
+- README
+homepage: http://api.mynewsletterbuilder.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: mynewsletterbuilder
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Interface with the MyNewsletterBuilder API through Ruby!
+test_files: []
+