ruby_ucp 0.1.0

data/lib/ucp/pdu/ucp57_result.rb

@@ -0,0 +1,31 @@
+=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
+
+
+require "ucp/pdu/ucp51_result.rb"
+
+class Ucp::Pdu::Ucp57Result < Ucp::Pdu::Ucp51Result
+
+  def initialize(fields=nil)
+    super(fields)
+    @operation="57"
+  end
+
+end
+

data/lib/ucp/pdu/ucp58_operation.rb

@@ -0,0 +1,31 @@
+=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
+
+
+require "ucp/pdu/ucp51_operation.rb"
+
+class Ucp::Pdu::Ucp58Operation < Ucp::Pdu::Ucp51Operation
+
+  def initialize(fields=nil)
+    super(fields)
+    @operation="58"
+  end
+
+end
+

data/lib/ucp/pdu/ucp58_result.rb

@@ -0,0 +1,31 @@
+=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
+
+
+require "ucp/pdu/ucp51_result.rb"
+
+class Ucp::Pdu::Ucp58Result < Ucp::Pdu::Ucp51Result
+
+  def initialize(fields=nil)
+    super(fields)
+    @operation="58"
+  end
+
+end
+

data/lib/ucp/pdu/ucp5x.rb

@@ -0,0 +1,40 @@
+=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::UCP5x < Ucp::Pdu::UCPMessage
+
+  @xservices=[]
+  
+  def initialize()
+    super()
+    @xservices=Array.new
+    @fields=[:adc,:oadc,:ac,:nrq,:nadc,:nt,:npid,:lrq,:lrad,:lpid,:dd,:ddt,:vp,:rpid,:scts,:dst,:rsn,:dscts,:mt,:nb,:msg,:mms,:pr,:dcs,:mcls,:rpi,:cpg,:rply,:otoa,:hplmn,:xser,:res4,:res5]
+  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/ucp60.rb

@@ -0,0 +1,30 @@
+=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::UCP61 < Ucp::Pdu::UCPMessage
+
+  def initialize()
+    super()
+    @operation="61"
+  end
+
+  
+end
+

data/lib/ucp/pdu/ucp60_operation.rb

@@ -0,0 +1,58 @@
+=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::Ucp60Operation < Ucp::Pdu::UCP60
+
+   def initialize(fields=nil)
+    super()
+    #@operation="60"
+    @operation_type="O"
+    @fields=[:oadc,:oton,:onpi,:styp,:pwd,:npwd,:vers,:ladc,:lton,:lnpi,:opid,:res1]
+
+    if fields.nil?
+      return
+    end
+
+
+    @trn=fields[0]
+    @operation_type=fields[2]
+    @operation=fields[3]
+
+     # *00/00050/O/60/8006/6/5/1/F474FB2D07//0100//////15#
+
+     for i in 4..(fields.length-1)
+       field=@fields[i-4]
+       @h[field]=fields[i]
+     end
+
+  end
+
+
+
+
+ def basic_auth(originator,password,ucpfields={})
+    #super()
+    #@operation_type="O"
+    
+    @h={:oadc=>originator, :pwd=>UCP.ascii2ira(password), :vers=>"0100", :styp=>"1", :oton=>"6",:onpi=>"5"}
+    @h=@h.merge ucpfields
+  end
+
+end

data/lib/ucp/pdu/ucp60_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::Ucp60Result < Ucp::Pdu::UCP60
+  
+  def initialize(fields=nil)
+    super()
+    @operation_type="R"
+    if fields.nil?
+      return
+    end
+
+    @trn=fields[0]
+    if fields[4].eql?("A")
+      # 00/00019/R/60/A//6D
+      ack(fields[5])
+    elsif fields[4].eql?("N")
+      # 00/00022/R/60/N/01//04
+      nack(fields[5],fields[6])
+    else
+      raise "invalid result in UCP60"
+    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/ucp61.rb

@@ -0,0 +1,31 @@
+=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::UCP60 < Ucp::Pdu::UCPMessage
+
+  def initialize()
+    super()
+    @operation="60"
+  end
+
+  
+end
+

data/lib/ucp/pdu/ucp61_operation.rb

@@ -0,0 +1,49 @@
+=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::Ucp61Operation < Ucp::Pdu::UCP61
+
+   def initialize(fields=nil)
+    super()
+    @operation_type="O"
+    @fields=[:oadc,:oton,:onpi,:styp,:pwd,:npwd,:vers,:ladc,:lton,:lnpi,:res1,:res2]
+
+    if fields.nil?
+      return
+    end
+
+
+    @trn=fields[0]
+    @operation_type=fields[2]
+    @operation=fields[3]
+
+    # 00/00058/O/61/04568768///2///0100/1920870340094000//5///06
+
+
+     for i in 4..(fields.length-1)
+       field=@fields[i-4]
+       @h[field]=fields[i]
+     end
+
+  end
+
+
+
+end

data/lib/ucp/pdu/ucp61_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::Ucp61Result < Ucp::Pdu::UCP61
+  
+  def initialize(fields=nil)
+    super()
+    @operation_type="R"
+    if fields.nil?
+      return
+    end
+
+    @trn=fields[0]
+    if fields[4].eql?("A")
+      # 00/00019/R/61/A//6E
+      ack(fields[5])
+    elsif fields[4].eql?("N")
+      # 00/00022/R/61/N/02//06
+      nack(fields[5],fields[6])
+    else
+      raise "invalid result in UCP61"
+    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/ucp_operation.rb

@@ -0,0 +1,27 @@
+=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::UcpOperation < Ucp::Pdu::UCPMessage
+
+  def initialize
+    @operation_type="O"
+  end
+
+
+end

data/lib/ucp/pdu/ucp_result.rb

@@ -0,0 +1,26 @@
+=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::UcpResult < Ucp::Pdu::UCPMessage
+  
+  def initialize
+   @operation_type="R"
+  end
+end

data/lib/ucp/pdu/ucpmessage.rb

@@ -0,0 +1,125 @@
+=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
+
+
+class UCPMessage 
+  DELIMITER="/"
+  STX=2.chr
+  ETX=3.chr
+
+
+  @fields=[]
+  @h={}
+
+#  @@trn="00"
+  attr_reader :operation
+  attr_reader :operation_type
+  attr_accessor :trn
+  attr_reader :dcs
+  attr_reader :message_ref, :part_nr, :total_parts
+
+  # usado pelas classes que o extendem
+  def initialize()
+    @dcs="01"
+
+    @trn="00"
+    @fields=[]
+    @h=Hash.new
+
+    @message_ref=0
+    @part_nr=1
+    @total_parts=1
+  end
+
+  def get_field(field)
+    return @h[field]
+  end
+
+  def set_field(field,value)
+    @h[field]=value
+  end
+
+  def set_fields(ucpfields={})
+    @h=@h.merge ucpfields
+  end
+
+
+  def is_operation?
+    return @operation_type=="O"
+  end
+
+  def is_result?
+    return @operation_type=="R"
+  end
+
+    def is_ack?
+    return @h.has_key?(:ack)
+  end
+
+  def is_nack?
+    return @h.has_key?(:nack)
+  end
+  
+  def checksum(s)
+    # The <checksum> is derived by the addition of all bytes of the header, data field separators
+    # and data fields (i.e. all characters after the stx-character, up to and including the last “/”
+    # before the checksum field). The 8 Least Significant Bits (LSB) of the result is then
+    # represented as two printable characters.
+
+    sum=0
+    s.each_byte { |byte|
+      sum+=byte
+    }
+    #return sprintf("%02x",sum)[-2,2]
+    return sum.to_s(16)[-2,2].upcase
+  end
+
+  def length(s)
+    return sprintf("%05d",s.length+16)
+  end
+
+  def to_s
+
+    s=""
+    @fields.each{ |key|
+      value=@h[key]
+      if value.nil?
+        s+=DELIMITER
+      else
+        s+=value.to_s+DELIMITER
+      end
+    }
+
+
+    pdu=@trn+DELIMITER
+    pdu+=length(s)+DELIMITER
+    pdu+=@operation_type+DELIMITER
+    pdu+=@operation+DELIMITER
+    pdu+=s
+    pdu+=checksum(pdu)
+    pdu=STX+pdu+ETX
+    return pdu
+  end
+
+end # class
+
+
+end # module

data/lib/ucp/util/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::Util
+    
+end

data/lib/ucp/util/gsm_packed_msg.rb

@@ -0,0 +1,50 @@
+=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::Util::GsmPackedMsg < Ucp::Util::PackedMsg
+
+
+#  attr_reader :encoded,:unencoded,:chars,:required_septets,:part_nr,:total_parts,:message_ref
+  
+  @encoded=""
+  @unencoded=""
+  @required_septets=0
+  @chars=0
+
+  # ??
+  #@dcs=nil
+
+#  @part_nr=nil
+#  @total_parts=nil
+#  @message_ref=nil
+
+  def initialize(encoded,unencoded,chars,required_septets,tainted=false)
+    @encoded=encoded
+    @unencoded=unencoded
+    @chars=chars
+    @required_septets=required_septets
+    @tainted=tainted
+
+#    @part_nr=1
+#    @total_parts=1
+#    @message_ref=0
+  end
+
+
+end