ruby_ucp 0.1.0

data/Rakefile.orig

@@ -0,0 +1,45 @@
+# 
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+ 
+
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+spec = Gem::Specification.new do |s|
+  s.name = 'ruby_ucp'
+  s.version = '0.0.2'
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README', 'LICENSE']
+  s.summary = 'EMI/UCP protocol library'
+  s.description = s.summary
+  s.author = 'Sergio Freire'
+  s.email = 'sergio-s-freire@ptinovacao.pt'
+  # s.executables = ['your_executable_here']
+  s.files = %w(LICENSE README Rakefile) + Dir.glob("{bin,lib,spec}/**/*")
+  s.require_path = "lib"
+  s.bindir = "bin"
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+
+Rake::RDocTask.new do |rdoc|
+  files =['README', 'LICENSE', 'lib/**/*.rb']
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README" # page to start on
+  rdoc.title = "ruby_ucp Docs"
+  rdoc.rdoc_dir = 'doc/rdoc' # rdoc output folder
+  rdoc.options << '--line-numbers'
+end
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*.rb']
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/ruby_ucp.rb

@@ -0,0 +1,42 @@
+=begin
+Ruby library implementation of EMI/UCP protocol v4.6 for SMS
+Copyright (C) 2011, Sergio Freire <sergio.freire@gmail.com>
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library 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
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+=end
+
+
+$:.unshift(File.dirname(__FILE__))
+
+require "ucp/base.rb"
+require "ucp/pdu/ucpmessage.rb"
+require "ucp/pdu/ucp01.rb"
+require "ucp/pdu/ucp30.rb"
+require "ucp/pdu/ucp31.rb"
+require "ucp/pdu/ucp5x.rb"
+require "ucp/pdu/ucp60.rb"
+require "ucp/pdu/ucp61.rb"
+require "ucp/util/base.rb"
+
+
+# Load all YCP PDUs
+Dir.glob(File.join(File.dirname(__FILE__), 'ucp', 'pdu', '*.rb')) do |f|
+  require f  unless f.match('ucpmessage.rb$')
+end
+
+# Load all auxiliary classes
+Dir.glob(File.join(File.dirname(__FILE__), 'ucp', 'util', '*.rb')) do |f|
+  require f  unless f.match('base.rb$')
+end

data/lib/samples/main.rb

@@ -0,0 +1,182 @@
+=begin
+Ruby library implementation of EMI/UCP protocol v4.6 for SMS
+Copyright (C) 2011, Sergio Freire <sergio.freire@gmail.com>
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library 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
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+=end
+
+=begin
+this file actually contais a LOT of garbage... used just to test things while developing
+i left so you can take a look of concrete examples, while I build clean samples along
+with tests
+=end
+
+$KCODE = 'UTF8'
+require 'jcode'
+
+require "rubygems"
+
+require "ruby_ucp"
+include Ucp::Util
+
+def handle_me(smsreq) 
+  puts "handle_me [#{smsreq.source_ip}:#{smsreq.source_port}] (#{smsreq.originator},#{smsreq.recipient})  (#{smsreq.part_nr}/#{smsreq.total_parts}): #{smsreq.text}\n"
+end
+
+#ucp=UCP.parse_str("*00/00113/O/51/961234567/1234/////////////////4/120/B49AED86CBC162B219AD66BBE17230//////////0106050003450202///90#")
+#puts "UCP: #{ucp.to_s}"
+#exit
+
+
+
+
+
+ucp=Ucp31Operation.new
+puts "UCP: #{ucp.to_s}"
+ucp=Ucp30Operation.new
+ucp.basic_submit(1234, 961234567, "ola")
+puts "UCP: #{ucp.to_s}"
+
+
+
+ustr=2.chr+"01/00357/O/51/961234567/1234/////////////////4/1072/0031003200330034003500360037003800390030003100320033003400350036003700380039003000310032003300340035003600370038003900300031003200330034003500360037003800390030003100320033003400350036003700380039003000310032003300340035003600370038003900300031003200330034003500360037//////////0106050003450201020108///01"+3.chr
+ucp=UCP.parse_str(ustr)
+
+ucp.set_fields({:oadc=>"10412614190438AB4D",:otoa=>"5039"})
+text=UCP.decode_ucp_msg(ucp)
+originator=UCP.decode_ucp_oadc(ucp)
+puts "originator: #{originator} ; text: #{text}"
+
+#exit
+
+
+puts UCP.str2ucs2("ola").encoded
+
+s="1234567890"*7 +"1€"
+UCP.make_multi_ucps(1235,961234568,s)
+
+#exit
+
+puts "1€€".length,"1€€".jlength
+puts "1€"[1..1]
+puts "1€".chars #[0..1]
+"1€".each_char{ |c|
+  puts "C: #{c}"
+}
+#exit
+
+
+#exit
+
+ucp=Ucp01Operation.new
+ucp.basic_submit("1234x",961234567,"ola")
+#ucp.set_fields( {:mt=>"4", :oadc=>"x"})
+ucp.trn="02"
+puts ucp.to_s
+
+
+port=12009
+server=UcpServer.new(method(:handle_me),port)
+
+
+cliente=UcpClient.new("localhost",port,{:login=>8006,:password=>"timor"})
+#sent=cliente.send_message(1234,961234567,"1234567890"*17+"ola custa 1€ sabias?")
+
+ans=cliente.send_alert("961234567","0100")
+puts "ans: #{ans}"
+s="1234567890"*8+"1€"
+sent=cliente.send_message(1234,961234567,s)
+puts "sent: #{sent}"
+ucp=Ucp30Operation.new
+ucp.basic_submit(1234, 961234567, "ola 1€éuro Ç!@\'\"#\$%&/()=<>,.-;:*+[]")
+ans=cliente.send_sync(ucp)
+puts "ans: #{ans}"
+cliente.close
+server.stop
+exit
+
+
+
+
+
+ucp=UCP.parse_str("*00/00113/O/51/961234567/1234/////////////////4/120/B49AED86CBC162B219AD66BBE17230//////////0106050003450202///90#")
+puts ucp.to_s
+
+
+puts UCP.pack7bits("€")
+#puts UCP.packucs2("ola")
+puts UCP.decode7bitgsm(UCP.pack7bits("1234567890"*17))
+gsmparts= UCP.pack7bits2("1234567890"*17,134)
+puts "septets: #{gsmparts.required_septets} ;  unenc: #{gsmparts.unencoded}"
+gsmparts= UCP.multi_pack7bits2("1234567890"*17,134)
+gsmparts.each { |gsmpart|
+  puts "part: #{gsmpart.unencoded}"
+}
+
+UCP.make_multi_ucps(1235,961234568,"1234567890"*17)
+
+str= UCP.pack7bits("1234567890"*17)
+smparts=[]
+i=0
+while i*2<str.length
+  tmp= str[i*2,(i+134)*2]
+  puts "tmp.len. #{tmp.length/2} ; TMP: #{tmp}"
+  puts UCP.decode7bitgsm(tmp)
+  smparts << tmp
+  i+=134
+end
+
+puts str.length/2
+puts str.length*8/14
+#exit
+
+#ucp=Ucp51Operation.new("1234x",961234567,"ola")
+#ucp.set_fields( {:mt=>"4", :oadc=>"x"})
+#ucp.add_xser_raw("020101")
+#ucp.add_xser("03","01")
+#ucp.trn="02"
+#puts ucp.to_s
+
+
+
+ucp=Ucp01Result.new
+ucp.ack("ok")
+puts ucp.to_s
+puts ucp.is_nack?
+
+ucp=Ucp01Result.new
+ucp.nack("02","bla")
+ucp.trn="12"
+puts ucp.to_s
+puts ucp.is_nack?
+
+ucp=Ucp60Result.new()
+ucp.ack("ok")
+puts ucp.to_s
+puts ucp.is_nack?
+
+
+
+cliente=UcpClient.new("localhost",12000,{:login=>8006,:password=>"timor"})
+ucp=Ucp51Operation.new(1234,961234567,"ola")
+ans=cliente.send_sync(ucp)
+
+if ans.is_ack?
+  puts "aceite!"
+else
+  puts "rejeitado!"
+end
+
+cliente.close

data/lib/ucp/base.rb

@@ -0,0 +1,24 @@
+=begin
+Ruby library implementation of EMI/UCP protocol v4.6 for SMS
+Copyright (C) 2011, Sergio Freire <sergio.freire@gmail.com>
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library 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
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+=end
+
+
+
+module Ucp
+    
+end

data/lib/ucp/pdu/base.rb

@@ -0,0 +1,22 @@
+=begin
+Ruby library implementation of EMI/UCP protocol v4.6 for SMS
+Copyright (C) 2011, Sergio Freire <sergio.freire@gmail.com>
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library 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
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+=end
+
+module Ucp::Pdu
+    
+end

data/lib/ucp/pdu/ucp01.rb

@@ -0,0 +1,37 @@
+=begin
+Ruby library implementation of EMI/UCP protocol v4.6 for SMS
+Copyright (C) 2011, Sergio Freire <sergio.freire@gmail.com>
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library 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
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+=end
+
+class Ucp::Pdu::UCP01 < Ucp::Pdu::UCPMessage
+
+  def initialize()
+    super()
+    @operation="01"
+  end
+
+  def set_fields(ucpfields={})
+    @h=@h.merge ucpfields
+  end
+
+  def initialize_message(ucpfields={})
+    super()
+    @h=@h.merge ucpfields
+  end
+
+end
+

data/lib/ucp/pdu/ucp01_operation.rb

@@ -0,0 +1,61 @@
+=begin
+Ruby library implementation of EMI/UCP protocol v4.6 for SMS
+Copyright (C) 2011, Sergio Freire <sergio.freire@gmail.com>
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library 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
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+=end
+
+class Ucp::Pdu::Ucp01Operation  < Ucp::Pdu::UCP01
+
+  def initialize(fields=nil)
+    super()
+    @operation_type="O"
+    @fields=[:adc,:oadc,:ac,:mt,:msg]
+
+    if fields.nil?
+      return
+    end
+
+    @trn=fields[0]
+    @operation_type=fields[2]
+    @operation=fields[3]
+
+    # *02/00050/O/01/961234567/0931D98C8607//3/6F7618/72#
+
+     for i in 4..(fields.length-1)
+       field=@fields[i-4]
+       @h[field]=fields[i]
+     end
+
+
+  end
+
+ def basic_submit(originator,recipient,message,ucpfields={})
+    #super()
+    #@operation_type="O"
+    #@fields=[:adc,:oadc,:ac,:mt,:msg]
+
+    # UCP01 only supports IRA encoded SMS (7bit GSM alphabet chars, encoded in 8bits)
+    msg=UCP.ascii2ira(message).encoded
+
+    # UCP01 does NOT support alphanumeric oadc
+    oadc=originator
+
+    @h={:oadc=>oadc, :adc=>recipient, :msg=>msg,:mt=>3}
+    
+    @h=@h.merge ucpfields
+  end
+
+end

data/lib/ucp/pdu/ucp01_result.rb

@@ -0,0 +1,60 @@
+=begin
+Ruby library implementation of EMI/UCP protocol v4.6 for SMS
+Copyright (C) 2011, Sergio Freire <sergio.freire@gmail.com>
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library 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
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+=end
+
+class Ucp::Pdu::Ucp01Result < Ucp::Pdu::UCP01
+
+  def initialize(fields=nil)
+    super()
+    @operation_type="R"
+    if fields.nil?
+      return
+    end
+
+    @trn=fields[0]
+    if fields[4].eql?("A")
+      # 06/00043/R/01/A/01234567890:090196103258/4E
+      ack(fields[5])
+    elsif fields[4].eql?("N")
+      # 12/00022/R/01/N/02//03
+      nack(fields[5],fields[6])
+    else
+      raise "invalid result in UCP01"
+    end
+
+    # TODO: verificar len e checksum
+
+  end
+
+
+  def ack(sm="")
+    @fields=[:ack,:sm]
+    @h[:ack]="A"
+    @h[:sm]=sm
+  end
+
+  def nack(ec,sm="")
+    @fields=[:nack,:ec,:sm]
+    @h[:nack]="N"
+    @h[:ec]=ec
+    @h[:sm]=sm
+  end
+
+
+
+end

data/lib/ucp/pdu/ucp30.rb

@@ -0,0 +1,28 @@
+=begin
+Ruby library implementation of EMI/UCP protocol v4.6 for SMS
+Copyright (C) 2011, Sergio Freire <sergio.freire@gmail.com>
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library 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
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+=end
+
+class Ucp::Pdu::UCP30 < Ucp::Pdu::UCPMessage
+
+  def initialize()
+    super()
+    @operation="30"
+  end
+
+end
+

data/lib/ucp/pdu/ucp30_operation.rb

@@ -0,0 +1,59 @@
+=begin
+Ruby library implementation of EMI/UCP protocol v4.6 for SMS
+Copyright (C) 2011, Sergio Freire <sergio.freire@gmail.com>
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library 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
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+=end
+
+
+class Ucp::Pdu::Ucp30Operation  < Ucp::Pdu::UCP30
+
+  def initialize(fields=nil)
+    super()
+    @operation_type="O"
+    @fields=[:adc,:oadc,:ac,:nrq,:nad,:npid,:dd,:ddt,:vp,:amsg]
+
+    if fields.nil?
+      return
+    end
+
+    @trn=fields[0]
+    @operation_type=fields[2]
+    @operation=fields[3]
+
+    # 44/00077/O/30/0673845336//////1/1003961344/1203961200/4D657373616765204F4B/27
+
+     for i in 4..(fields.length-1)
+       field=@fields[i-4]
+       @h[field]=fields[i]
+     end
+
+
+  end
+
+ def basic_submit(originator,recipient,message,ucpfields={})
+
+    # UCP30 only supports IRA encoded SMS (7bit GSM alphabet chars, encoded in 8bits)
+    msg=UCP.ascii2ira(message).encoded
+
+    # UCP30 does NOT support alphanumeric oadc
+    oadc=originator
+
+    @h={:oadc=>oadc, :adc=>recipient, :amsg=>msg}
+    
+    @h=@h.merge ucpfields
+  end
+
+end

data/lib/ucp/pdu/ucp30_result.rb

@@ -0,0 +1,63 @@
+=begin
+Ruby library implementation of EMI/UCP protocol v4.6 for SMS
+Copyright (C) 2011, Sergio Freire <sergio.freire@gmail.com>
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library 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
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+=end
+
+class Ucp::Pdu::Ucp30Result < Ucp::Pdu::UCP30
+
+  def initialize(fields=nil)
+    super()
+    @operation="30"
+    @operation_type="R"
+    if fields.nil?
+      return
+    end
+
+    @trn=fields[0]
+    if fields[4].eql?("A")
+      # 10/00039/R/30/A//067345:070295121212/6F
+      ack(fields[5],fields[6])
+    elsif fields[4].eql?("N")
+      # 11/00022/R/30/N/24//08
+      nack(fields[5],fields[6])
+    else
+      raise "invalid result in UCP51"
+    end
+
+    # TODO: verificar len e checksum
+
+  end
+
+
+  def ack(mvp="",sm="")
+    @fields=[:ack,:sm]
+    @h[:ack]="A"
+    @h[:mvp]=mvp
+    @h[:sm]=sm
+  end
+
+  def nack(ec,sm="")
+    @fields=[:nack,:ec,:sm]
+    @h[:nack]="N"
+    @h[:ec]=ec
+    @h[:sm]=sm
+  end
+
+
+
+end
+

data/lib/ucp/pdu/ucp31.rb

@@ -0,0 +1,29 @@
+=begin
+Ruby library implementation of EMI/UCP protocol v4.6 for SMS
+Copyright (C) 2011, Sergio Freire <sergio.freire@gmail.com>
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library 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
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+=end
+
+
+class Ucp::Pdu::UCP31 < Ucp::Pdu::UCPMessage
+
+  def initialize()
+    super()
+    @operation="31"
+  end
+
+end
+