alphamail 1.0.4.pre2 → 1.0.4

data/README.rdoc

@@ -24,7 +24,7 @@ First you need to require alphamail:
   require 'alphamail'
 
 Create the payload:
-  myPayload = AlphaMailEmailMessagePayload.new
+  myPayload = AlphaMail::MessagePayload.new
   
 Now, set the fields:
   # Set payload fields
@@ -39,7 +39,7 @@ Now, set the fields:
 Where myPayload.body is the object that will be insertet into the email template. Make sure that the class has implemented the to_json method.
 
 Setup the service:
-  myService = AlphaMailEmailService.new 'http://api.am1.comfirm.se/v1', 'YOUR-TOKEN-HERE'
+  myService = AlphaMail::EmailService.new 'http://api.am1.comfirm.se/v1', 'YOUR-TOKEN-HERE'
   
 Replace YOUR-TOKEN-HERE with a valid token. You can crate new tokens at the dashboard under settings.
 
@@ -48,6 +48,40 @@ Now it's time for magic:
   
 Send the payload by calling queue. The respond object will be stored in am_res as showed above.
 
+Shorthand example:
+
+require 'rubygems'
+require 'alphamail'
+
+class NewMember
+	attr_accessor :name
+	attr_accessor :password
+	
+	def initialize(name = 'Unknown', password = 'unset1')
+		@name = name
+		@password = password
+	end
+	
+	def to_json(*a)
+		{
+			'name'		=>	name,
+			'password'	=>	password
+			
+		}.to_json(*a)
+	end
+end
+
+myService = AlphaMail::EmailService.new 'http://api.am1.comfirm.se/v1', 'YOUR-TOKEN-HERE'
+
+am_res = myService.queue(AlphaMail::MessagePayload.new(
+	139,								# Project ID
+	2,								# Sender ID
+	AlphaMail::Contact.new('Jack Sender', 'jack@example.com'),	# Sender
+	AlphaMail::Contact.new('John Doe', 'john.doe@example.com'),	# Receiver
+	NewMember.new('John Doe', 'wh4tswhAt')				# Body object
+))
+puts "#{am_res.error_code} #{am_res.message}"
+
 == Error codes
 
 The respond will be returned as an AplhaMailError object.

data/lib/alphamail.rb

@@ -4,92 +4,93 @@ require 'uri'
 require 'net/http'
 require 'json'
 
-# Email contact class
-class AlphaMailEmailContact
-	attr_accessor :name
-	attr_accessor :email
+module AlphaMail
+	# Email contact class
+	class Contact
+		attr_accessor :name
+		attr_accessor :email
 
-	def initialize(name = "Undefined", email = "")
-		@name = name
-	        @email = email
+		def initialize(name = "Undefined", email = "")
+			@name = name
+			@email = email
+		end
 	end
-end
 
-# Message payload class
-class AlphaMailEmailMessagePayload
-	attr_accessor :project_id
-	attr_accessor :receiver_id
-	attr_accessor :sender
-	attr_accessor :receiver
-	attr_accessor :body
-
-	def initialize(project_id = 0, receiver_id = 0, sender = AlphaMailEmailContact.new('', ''), receiver = AlphaMailEmailContact.new('', ''), body = '')
-		@project_id = project_id
-		@receiver_id = receiver_id
-		@sender = sender
-		@receiver = receiver
-		@body = body
-		@body_json = ''
-	end
+	# Message payload class
+	class MessagePayload
+		attr_accessor :project_id
+		attr_accessor :receiver_id
+		attr_accessor :sender
+		attr_accessor :receiver
+		attr_accessor :body
 
-	def to_json(*a)
-		if @body.respond_to?('to_json')
-			@body_json  = @body.to_json
+		def initialize(project_id = 0, receiver_id = 0, sender = Contact.new('', ''), receiver = Contact.new('', ''), body = '')
+			@project_id = project_id
+			@receiver_id = receiver_id
+			@sender = sender
+			@receiver = receiver
+			@body = body
+			@body_json = ''
 		end
+
+		def to_json(*a)
+			if @body.respond_to?('to_json')
+				@body_json  = @body.to_json
+			end
 		
-		{
-			'project_id'		=>	project_id,
-			'receiver_id'		=>	receiver_id,
-			'sender_name'		=>	sender.name,
-			'sender_email'		=>	sender.email,
-			'receiver_name'		=>	receiver.name,
-			'receiver_email'	=>	receiver.email,
-			'body'			=>	@body_json
+			{
+				'project_id'		=>	project_id,
+				'receiver_id'		=>	receiver_id,
+				'sender_name'		=>	sender.name,
+				'sender_email'		=>	sender.email,
+				'receiver_name'		=>	receiver.name,
+				'receiver_email'	=>	receiver.email,
+				'body'			=>	@body_json
 		
-		}.to_json(*a)
+			}.to_json(*a)
+		end
 	end
-end
 
-class AlphaMailResult
-	attr_accessor :error_code
-	attr_accessor :message
+	class Result
+		attr_accessor :error_code
+		attr_accessor :message
 	
-	def initialize(error_code = 0, message = '')
-		@error_code = error_code
-		@message = message
+		def initialize(error_code = 0, message = '')
+			@error_code = error_code
+			@message = message
+		end
 	end
-end
 
-# Alpha-mail email service
-class AlphaMailEmailService
-	def initialize(service_url, api_token)
-		@service_url = service_url + '/email/queue'
-		@api_token = api_token
-	end
+	# Alpha-mail email service
+	class EmailService
+		def initialize(service_url, api_token)
+			@service_url = service_url + '/email/queue'
+			@api_token = api_token
+		end
 
-	def queue(payload = '')
-		# Queue the message
-		uri = URI.parse(@service_url)
-		req = Net::HTTP::Post.new(uri.path)
-		req.basic_auth '', @api_token
-		req.body = payload.to_json
-		req.content_type = 'application/json'
-		res = Net::HTTP.start(uri.host, uri.port) {|http|
-			http.request(req)
-		}
+		def queue(payload = '')
+			# Queue the message
+			uri = URI.parse(@service_url)
+			req = Net::HTTP::Post.new(uri.path)
+			req.basic_auth '', @api_token
+			req.body = payload.to_json
+			req.content_type = 'application/json'
+			res = Net::HTTP.start(uri.host, uri.port) {|http|
+				http.request(req)
+			}
 		
-		# Check response
-		case res.code
-			when '200' then
-				am_res = JSON.parse(res.body)
-				return AlphaMailResult.new(am_res['error_code'], am_res['message'])
-			else
-				am_res = JSON.parse(res.body)
-				return AlphaMailResult.new(am_res['error_code'], am_res['message'])
-		end 
-		return AlphaMailResult.new(-1, 'Unknown error')
+			# Check response
+			case res.code
+				when '200' then
+					am_res = JSON.parse(res.body)
+					return Result.new(am_res['error_code'], am_res['message'])
+				else
+					am_res = JSON.parse(res.body)
+					return Result.new(am_res['error_code'], am_res['message'])
+			end 
+			return Result.new(-1, 'Unknown error')
+		end
 	end
 end
 
 
-

data/spec/alphamail_test.rb

@@ -25,7 +25,7 @@ end
 myMember = NewMember.new('Ruby Diamond Ruben', 'my3Passw0rd89')
 
 # The payload
-myPayload = AlphaMailEmailMessagePayload.new
+myPayload = AlphaMail::MessagePayload.new
 
 # Set payload fields
 myPayload.project_id = 139
@@ -36,7 +36,7 @@ myPayload.receiver.name = 'John Doe'
 myPayload.receiver.email = 'john.doe@example.com'
 myPayload.body = myMember
 
-myService = AlphaMailEmailService.new 'http://api.am1.comfirm.se/v1', 'YOUR-TOKEN-HERE'
+myService = AlphaMail::EmailService.new 'http://api.am1.comfirm.se/v1', 'YOUR-TOKEN-HERE'
 am_res = myService.queue(myPayload)
 puts "#{am_res.error_code} #{am_res.message}"
 
@@ -44,11 +44,11 @@ puts "#{am_res.error_code} #{am_res.message}"
 # Demo 2 ---------------------
 
 # The payload
-am_res = myService.queue(AlphaMailEmailMessagePayload.new(
+am_res = myService.queue(AlphaMail::MessagePayload.new(
 	139,								# Project ID
 	2,								# Sender ID
-	AlphaMailEmailContact.new('Jack Sender', 'jack@example.com'),	# Sender
-	AlphaMailEmailContact.new('John Doe', 'john.doe@example.com'),	# Receiver
+	AlphaMail::Contact.new('Jack Sender', 'jack@example.com'),	# Sender
+	AlphaMail::Contact.new('John Doe', 'john.doe@example.com'),	# Receiver
 	NewMember.new('John Doe', 'wh4tswhAt')				# Body object
 ))
 puts "#{am_res.error_code} #{am_res.message}"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: alphamail
 version: !ruby/object:Gem::Version 
-  hash: -1876988191
-  prerelease: true
+  hash: 31
+  prerelease: false
   segments: 
   - 1
   - 0
   - 4
-  - pre2
-  version: 1.0.4.pre2
+  version: 1.0.4
 platform: ruby
 authors: 
 - Jack Engqvist Johansson