porteo 0.1.0

data/lib/protocols/mail_protocol.rb

@@ -0,0 +1,64 @@
+# Copyright 2011 NoSoloSoftware
+#
+# This file is part of Porteo.
+# 
+# Porteo is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Porteo is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Porteo. If not, see <http://www.gnu.org/licenses/>.
+
+require 'protocols/protocol'
+
+# Porteo is an integrated message sending service.
+# It allows you to send messages by various protocols (sms, email, twitter)
+# using differents gateways (mensario, pony, twitter API). You can also
+# integrate new protocols and gateways for your favorite messenger 
+# service.
+module Porteo
+
+  # Implementation of email protocol to be used in Porteo system.
+  # It only define specific behavior for this protocol.
+  class Mail_protocol < Protocol
+
+    # Necessary fields to send a valid email
+    MAIL_REQUIRED_FIELDS = [:to, :body]
+    
+    # Implementates the parent method to ensure that email receptor is 
+    # the one set at receiver instance variable not the :to template tag
+    # @return [nil]
+    def override_tags
+      # In mail protocol, the receiver instance variable has precedence over
+      # :to tag in template
+      @message_sections[:to] = @receiver unless @receiver == nil
+    end
+    
+    # Check for all required field to exist and contain valid values.
+    # If any required field is missing or its syntax is not valid 
+    # an ArgumentException is raised.
+    # @return [nil]
+    # @raise [ArgumentError] When no template sections are present
+    #   or no required parameter is given.
+    def check_message_sections
+      raise ArgumentError, "Protocol Error. There are no template sections. Maybe you didn't load a complete template" unless @message_sections != nil
+
+      # Check for required fields
+      MAIL_REQUIRED_FIELDS.each do |field|
+        raise ArgumentError, "Protocol Error. #{field.to_s.capitalize} is a required field for this protocol and it was not defined" unless @message_sections[field] != nil
+      end
+
+      # Check for correct syntax
+      if not @message_sections[:to] =~ /[A-Za-z0-9._%-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,4}/
+        raise ArgumentError, "Protocol Error. Bad syntax in :to section"
+      end
+    end
+  end
+
+end

data/lib/protocols/protocol.rb

@@ -0,0 +1,167 @@
+# Copyright 2011 NoSoloSoftware
+#
+# This file is part of Porteo.
+# 
+# Porteo is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Porteo is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Porteo. If not, see <http://www.gnu.org/licenses/>.
+
+require 'erb'
+
+require 'gateways/twitter_gateway'
+require 'gateways/pony_gateway'
+require 'gateways/mensario_gateway'
+
+# Porteo is an integrated message sending service.
+# It allows you to send messages by various protocols (sms, email, twitter)
+# using differents gateways (mensario, pony, twitter API). You can also
+# integrate new protocols and gateways for your favorite messenger 
+# service.
+module Porteo
+  
+  # Base class to implement common funcionality for all protocols.
+  #
+  # In Porteo system, the protocol creates an appropiate gateway to
+  # send the message through it.
+  class Protocol
+    
+    # Who the message is going to be sent to
+    attr_accessor :receiver
+    # Hash with that contain gateway configuration parameters
+    attr_accessor :gw_config
+
+    # Creates a new instance of a  protocol
+    # @param [Hash] Gateway configuration parameters.
+    def initialize( gw_config )
+      # Initilization
+      @gw_config = gw_config
+
+      @param = {}
+      @template = ""
+      @requires = []
+
+      @message_sections = []
+
+      @receiver = nil
+    end
+
+    # Set the template to be used.
+    # @param [Hash] template The template per se.
+    # @param [Array] requires The requires of the template. Which is the
+    #   required fields for this template. Those required fields has to be
+    #   present in the template parameters or an error will be raised.
+    # @return [nil]
+    def set_template( template, requires )
+      @template = template
+      @requires = requires
+    end
+    
+    # Set the values of template parameters
+    # @param [Hash] param Pairs of required fields for the template and
+    #   the value its take.
+    # @return [nil]
+    def set_template_params( param )
+      @param = param
+    end
+
+    # The raw message sections hash to be sent.
+    # @return [String] Message sections which will be sent. This method
+    #   returns the message as a string containing every section of the message
+    #   already parsed.
+    # @note As sections can be dynamic (because of ERB preprocessing) this method
+    # may not show some sections present in a template, depending on the parameters
+    # passed.
+    def message
+      # Call to expand_template
+      expand_template.to_s
+    end
+
+    # Send the message defined by template and template parameters. It used
+    # the gateway configuration options to send the message through a third-party
+    # ruby gem.
+    # @return [nil]
+    # @raise [ArgumentError] If gateway is not defined.
+    def send_message
+      # Expand the template, here we also check if template is well-formatted
+      @message_sections = expand_template
+
+      # As we can define instance variables with highest priority than template 
+      # tags, we may want to override those tags for a certain protocol
+      override_tags
+
+      # Check if a well-formatted template contains all fields necessaries
+      # to send this kind of message.
+      check_message_sections
+      
+      begin
+        # Create the appropiate gateway, which is defined in gw_config
+        @gateway = Porteo.const_get( "#{@gw_config[:gateway]}_gateway".capitalize.to_sym ).new( @gw_config )
+      rescue NameError
+        raise ArgumentError, "Protocol Error. Undefined gateway. Check if '#{@gw_config[:gateway]}_gateway.rb' is created and is a valid gateway"
+      end
+      # Send the message
+      @gateway.init_send( @message_sections )
+    end
+
+    
+    # Private methods
+    private
+
+    # @abstract
+    # Check for all required sections to be defined.
+    # @return [nil]
+    # @raise [Exception] This method is not meant to be call but to be overwritten.
+    # @note This method has to be overwritten.
+    def check_message_sections
+      raise Exception, "Protocol Error. This method has to be overwritten. You are trying to check for required sections in a generic protocol."
+    end
+
+    # @abstract
+    # Allow programmers to change the order precedence.
+    # @note If you want to change the value of any template tag, you should
+    # do it here.
+    def override_tags
+    end
+
+    # Expand the message from template and variables.
+    # A template is a collection of sections which define the content
+    # of a message, but those sections are dynamic thanks to the use
+    # of ERB code. At the same time, the parameters are filled with
+    # it value.
+    # @return [nil]
+    # @raise [ArgumentError] If a required param is not present or it is nil.
+    def expand_template
+      # Check for existence of required parameters 
+      @requires.each do |required_param|
+        raise ArgumentError, "Protocol Error. Required parameter '#{required_param.to_s}' is not present or it is nil." if @param[required_param] == nil
+      end
+
+      param = @param
+
+      erb_template = ERB.new( @template, 0, "%<>" )
+
+      # Binding get the execution context to allow the use of
+      # param in the template
+      template_filled = erb_template.result( binding ) 
+
+      # We use eval to get a Hash with message sections because
+      # erb return a string
+      # [:body] => "..."
+      # [:attachments] => "..."
+      # ...
+      eval( template_filled )
+    end
+  end
+
+end
+
+

data/lib/protocols/sms_protocol.rb

@@ -0,0 +1,68 @@
+# encoding: UTF-8  
+
+# Copyright 2011 NoSoloSoftware
+#
+# This file is part of Porteo.
+# 
+# Porteo is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Porteo is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Porteo. If not, see <http://www.gnu.org/licenses/>.
+
+require 'protocols/protocol'
+
+# Porteo is an integrated message sending service.
+# It allows you to send messages by various protocols (sms, email, twitter)
+# using differents gateways (mensario, pony, twitter API). You can also
+# integrate new protocols and gateways for your favorite messenger 
+# service.
+module Porteo
+
+  # Implementation of SMS protocol to be used in Porteo system.
+  # It only define specific behavior for this protocol.
+  class Sms_protocol < Protocol
+
+    # Check for the required fields to exists.
+    # @return [nil]
+    # @raise [ArgumentError] if message cannot be sent.
+    def check_message_sections
+      raise ArgumentError, "Protocol Error. There are not text section" if @message_sections[:text] == nil
+      # The sms must match GSM alphabet, double counting these chars
+      # [ , ], <FF>, ^, \, {, }, ~, | and €
+      count = 0
+
+      @message_sections[:text].each_char do | c |
+        count = count + 1 if c =~ /[\[\]\^\\\{\}\~\|€]/
+       
+        count = count + 1
+      end
+
+      raise ArgumentError, "Protocol Error. The message is too long" if count > 160
+
+      raise ArgumentError, "Protocol Error. The phone number is invalid" unless @message_sections[:phone] =~ /^\d{9}$/
+      
+      raise ArgumentError, "Protocol Error. The country phone code is invalid" unless @message_sections[:code] =~ /^\d{2,4}$/
+
+      raise ArgumentError, "Protocol Error. The sender is invalid" unless @message_sections[:sender] =~ /^[A-Za-z0-9]{1,11}$/
+
+    end
+
+    # Implementates the parent method to ensure that sms receptor is 
+    # the one set at receiver instance variable not the :phone template tag
+    # @return [nil]
+    def override_tags
+      # In sms protocol, the receiver instance variable has precedence over
+      # :phone tag in template
+      @message_sections[:phone] = @receiver unless @receiver == nil
+    end
+  end
+
+end

data/lib/protocols/twitter_protocol.rb

@@ -0,0 +1,42 @@
+# Copyright 2011 NoSoloSoftware
+#
+# This file is part of Porteo.
+# 
+# Porteo is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Porteo is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Porteo. If not, see <http://www.gnu.org/licenses/>.
+
+require 'protocols/protocol'
+
+# Porteo is an integrated message sending service.
+# It allows you to send messages by various protocols (sms, email, twitter)
+# using differents gateways (mensario, pony, twitter API). You can also
+# integrate new protocols and gateways for your favorite messenger 
+# service.
+module Porteo
+
+  # Implementation of Twitter protocol to be used in Porteo system.
+  # It only define specific behavior for this protocol.
+  class Twitter_protocol < Protocol
+    # Check for the required fields to exists.
+    # @return [nil]
+    # @raise [ArgumentError] if message cannot be sent.
+    def check_message_sections
+      raise ArgumentError, "Protocol Error. There are no body section" if @message_sections[:body] == nil
+      # the twitt must be shorter than 140 chars.
+      raise ArgumentError, "Protocol Error. The message is too long" if @message_sections[:body].length > 140
+    end
+  end
+
+end
+
+

data/porteo.gemspec

@@ -0,0 +1,76 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{porteo}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Rafael Garcia}, %q{Luis Ciudad}]
+  s.date = %q{2011-06-08}
+  s.description = %q{Send all messages that you want in any protocol, its ready to send mail messages, twitts and sms with the apropiate gateway}
+  s.email = [%q{rgarcia@nosolosoftware.biz}, %q{lciudad@nosolosoftware.biz}]
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    "COPYING",
+    "README.markdown",
+    "VERSION",
+    "lib/gateways/gateway.rb",
+    "lib/gateways/mensario_gateway.rb",
+    "lib/gateways/pony_gateway.rb",
+    "lib/gateways/twitter_gateway.rb",
+    "lib/message/message.rb",
+    "lib/porteo.rb",
+    "lib/protocols/mail_protocol.rb",
+    "lib/protocols/protocol.rb",
+    "lib/protocols/sms_protocol.rb",
+    "lib/protocols/twitter_protocol.rb",
+    "porteo.gemspec"
+  ]
+  s.homepage = %q{http://github.com/nosolosoftware/porteo}
+  s.licenses = [%q{GPL-3}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.5}
+  s.summary = %q{A Ruby gem for sending all kind of messages}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<twitter>, ["~> 1.5.0"])
+      s.add_runtime_dependency(%q<pony>, ["~> 1.2"])
+      s.add_runtime_dependency(%q<mensario>, ["~> 0.2.0"])
+      s.add_development_dependency(%q<rake>, ["~> 0.9.2"])
+      s.add_development_dependency(%q<yard>, ["~> 0.7.1"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.6.0"])
+      s.add_development_dependency(%q<cucumber>, ["~> 0.10.5"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_development_dependency(%q<bluecloth>, ["~> 2.1.0"])
+    else
+      s.add_dependency(%q<twitter>, ["~> 1.5.0"])
+      s.add_dependency(%q<pony>, ["~> 1.2"])
+      s.add_dependency(%q<mensario>, ["~> 0.2.0"])
+      s.add_dependency(%q<rake>, ["~> 0.9.2"])
+      s.add_dependency(%q<yard>, ["~> 0.7.1"])
+      s.add_dependency(%q<rspec>, ["~> 2.6.0"])
+      s.add_dependency(%q<cucumber>, ["~> 0.10.5"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+      s.add_dependency(%q<bluecloth>, ["~> 2.1.0"])
+    end
+  else
+    s.add_dependency(%q<twitter>, ["~> 1.5.0"])
+    s.add_dependency(%q<pony>, ["~> 1.2"])
+    s.add_dependency(%q<mensario>, ["~> 0.2.0"])
+    s.add_dependency(%q<rake>, ["~> 0.9.2"])
+    s.add_dependency(%q<yard>, ["~> 0.7.1"])
+    s.add_dependency(%q<rspec>, ["~> 2.6.0"])
+    s.add_dependency(%q<cucumber>, ["~> 0.10.5"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.0"])
+    s.add_dependency(%q<bluecloth>, ["~> 2.1.0"])
+  end
+end
+

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification 
+name: porteo
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Rafael Garcia
+- Luis Ciudad
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-08 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: twitter
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: pony
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.2"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mensario
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: yard
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.10.5
+  type: :development
+  prerelease: false
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: bluecloth
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *id009
+description: Send all messages that you want in any protocol, its ready to send mail messages, twitts and sms with the apropiate gateway
+email: 
+- rgarcia@nosolosoftware.biz
+- lciudad@nosolosoftware.biz
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- COPYING
+- README.markdown
+- VERSION
+- lib/gateways/gateway.rb
+- lib/gateways/mensario_gateway.rb
+- lib/gateways/pony_gateway.rb
+- lib/gateways/twitter_gateway.rb
+- lib/message/message.rb
+- lib/porteo.rb
+- lib/protocols/mail_protocol.rb
+- lib/protocols/protocol.rb
+- lib/protocols/sms_protocol.rb
+- lib/protocols/twitter_protocol.rb
+- porteo.gemspec
+homepage: http://github.com/nosolosoftware/porteo
+licenses: 
+- GPL-3
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -587049560380440763
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: A Ruby gem for sending all kind of messages
+test_files: []
+