Merge branch 'fix/make-smslib-work' into 'master'

fix: make sms library send the messages and accept correct message format

See merge request !3

.gitignore

+.devcontainer/
+.rspec_status

.rspec_status

-example_id                    | status  | run_time        |
------------------------------ | ------- | --------------- |
-./spec/zoholib_spec.rb[1:1]   | passed  | 0.00168 seconds |
-./spec/zoholib_spec.rb[1:2]   | passed  | 0.04786 seconds |
-./spec/zoholib_spec.rb[1:3:1] | passed  | 0.00112 seconds |
-./spec/zoholib_spec.rb[1:3:2] | passed  | 0.0001 seconds  |
-./spec/zoholib_spec.rb[1:3:3] | pending | 0.00001 seconds |
-./spec/zoholib_spec.rb[1:3:4] | pending | 0 seconds       |
-./spec/zoholib_spec.rb[1:3:5] | pending | 0.00001 seconds |
-./spec/zoholib_spec.rb[1:3:6] | pending | 0 seconds       |
-./spec/zoholib_spec.rb[1:3:7] | pending | 0 seconds       |
-./spec/zoholib_spec.rb[1:4:1] | passed  | 0.00023 seconds |
-./spec/zoholib_spec.rb[1:4:2] | failed  | 0.82752 seconds |

.ruby-version

-2.6.3
+2.7.1
\ No newline at end of file

Dockerfile

 FROM ruby:2.7
 
-
 WORKDIR /app
-ADD Gemfile /app/Gemfile
-#ADD Gemfile.lock /app/Gemfile.lock
-
 ADD . /app
-RUN bundle install --system
-
 
+RUN bundle install --system
 RUN rake spec
-
 RUN gem build masmovil-smsclient.gemspec
 
 #TO-DO: Get automatically the version number
 RUN gem install masmovil-smsclient-$(cat /app/lib/masmovil-smsclient/version.rb|grep VERSION|cut -d '=' -f 2|sed "s/'//g" | sed "s/ //g").gem
\ No newline at end of file
-

Gemfile.lock

@@ -63,4 +63,4 @@ DEPENDENCIES
   savon (~> 2.12.0)
 
 BUNDLED WITH
-   1.17.3
+   2.1.4

README.md

 # Zoho Library
+
+### Development and testing
+
+To run the test you can use `rake spec` command in root folder of this project. 
+
+If you have a proxy and need to set it for testing you need to provide `SMS_PROXY` environment variables.
+The variable must in following format `http://<user>:<passowrd>@<host>:<port>` - any of the parts can be omitted if they are not necessary
\ No newline at end of file

lib/masmovil-smsclient/client.rb

@@ -4,6 +4,12 @@ require 'savon'
 
 module Wedoops
     module MasmovilSmsclient
+        class MsgError < StandardError
+            def initialize(msg="Provided message does not correspond correct format")
+                super(msg)
+            end
+        end
+
         class Client
 
             def initialize(options=Wedoops::MasmovilSmsclient::Configuration.new)
@@ -14,22 +20,13 @@ module Wedoops
                 initialize_client
             end
 
-            def sendSMS
-                @logger.info("Calling thing...")
-                message = {
-                    :user => "APPSimplant19",
-                    :pass => "h6pG0S60",
-                    :src => "+34619766776",
-                    :dst => "+34619766776",
-                    :msg => "Yeep",
-                    :date => DateTime.now,
-                    :name => "pepe"
-                }
+            def sendSMS(msg = {})
+                raise Wedoops::MasmovilSmsclient::MsgError.new("provided messages #{msg} is not valid") unless message_valid?(msg)
+                @logger.info("Sending the message: #{msg}")
+                # prepare the message to send
+                message = msg.merge({:user => "APPSimplant19", :pass => "h6pG0S60"})
                 begin
-                   # pp @client
-                    response = @client.call(:send_sms) do
-                        message(message)
-                    end
+                    response = @client.call(:send_sms, message: message)
                 rescue Exception => e
                     @logger.error("Error sending SMS: #{e.message}")
                     return nil
@@ -39,45 +36,54 @@ module Wedoops
 
             private
 
+            # Message must be a has and has following keys
+            # :src - max 11 characters (letters and numbers only)
+            # :dst - phone number
+            # :msg - text of the SMS message
+            # :date - in format YYYY-mm-dd HH:MM:SS
+            # :name - just string name? TODO: find out what this is for
+            def message_valid?(msg = {})
+               return false unless msg.key?(:src) and msg[:src].length < 11
+               return false unless msg.key?(:dst) and !msg[:dst].empty?
+               return false unless msg.key?(:msg) and !msg[:msg].empty?
+               return false unless date_valid?(msg[:date])
+               return false unless msg.key?(:name) and !msg[:name].empty?
+               return true
+            end
+
+            def date_valid?(d)
+                format_ok = d.match(/\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}/)
+                parseable = Date.strptime(d, '%F %T') rescue false
+                return format_ok && parseable
+            end
+
             def initialize_client
                 @logger.debug("Initlizing savon")
                 unless @proxy.nil?
-                    # TO-DO: Fix the authentication as needed
-                    #secret = Base64.strict_encode64("#{@proxy[:user]}:#{@proxy[:password]}")
-                    #@logger.debug(@proxy)
-                    
-                    #header={ "Proxy-Authorization" => "Basic #{secret}","Authorization" => "Basic"}
-                    #@logger.debug(header)
                     @client = Savon.client(
                         wsdl: 'https://websms.xtratelecom.es/api_php/server.wsdl',
                         pretty_print_xml: true,
-                        #convert_request_keys_to :camelcase
                         log: true,
                         log_level: :info,
                         logger: @logger,
-                       # basic_auth: [@proxy[:user],@proxy[:password]] ,
-                        filters: [:password],
-                        proxy: "#{@proxy[:address]}",
-                        #headers: header
+                        filters: [:proxy, :proxy, :user, :pass, :password],
+                        proxy: @proxy,
                     )
                 else
                     @client = Savon.client(
                         wsdl: 'https://websms.xtratelecom.es/api_php/server.wsdl',
                         pretty_print_xml: true,
-                        #convert_request_keys_to :camelcase
                         log: true,
                         log_level: :debug,
                     )
                 end
  
-               # end
             end
 
             def setup_proxy
                 @proxy = @config.option[:proxy]
             end
 
-
         end
     end
 end

lib/masmovil-smsclient/configuration.rb

+require 'uri'
+
 # frozen_string_literal: true
 module Wedoops
   module MasmovilSmsclient
@@ -8,8 +10,8 @@ module Wedoops
     class Configuration
       attr_accessor :option
 
-      def initialize  
-        @option = Hash.new   
+      def initialize(opts = {})
+        @option = opts
       end
 
       def uses_proxy?
@@ -23,11 +25,9 @@ module Wedoops
 
       private
 
-      def validate_proxy_options(options)
-        return false unless options[:user].kind_of?String
-        return false unless options[:password].kind_of?String
-        # TO-DO : control if the address is an address object. Maybe need initialization?
-        return false unless options[:address].kind_of?String
+      # check if the proxy is a valid URI
+      def validate_proxy_options(proxy)
+        return false unless proxy =~ URI::regexp
       end
 
     end

spec/spec_helper.rb

@@ -7,7 +7,7 @@ RSpec.configure do |conf|
   conf.before(:all) do
     Wedoops::MasmovilSmsclient.configure do |config|
       puts "Trying to config"
-      config.option = {proxy: {user: "masmovil",password: "0ckpsirlY2i9W5tzAk6j", address: "http://masmovil:0ckpsirlY2i9W5tzAk6j@prx.wedoops.io:443"}}
+      config.option = {proxy: ENV["SMS_PROXY"]}
     end
   end
 

spec/zoholib_spec.rb

@@ -6,10 +6,6 @@ RSpec.describe Wedoops::MasmovilSmsclient do
       expect(Wedoops::MasmovilSmsclient::VERSION).not_to be nil
     end
   
-    it 'does something useful' do
-      expect(true).to eq(true)
-    end
-  
     describe 'Configuration' do
       it 'The configuration shuld be a MasmovilSmsclient::Configuration' do
         expect(Wedoops::MasmovilSmsclient.configuration).to be_a_kind_of(Wedoops::MasmovilSmsclient::Configuration)
@@ -19,21 +15,10 @@ RSpec.describe Wedoops::MasmovilSmsclient do
         expect(Wedoops::MasmovilSmsclient.configuration.option).to be_an(Hash)
       end
 
-      xit 'The option proxy works' do
-      end
-
-      xit 'I an Query if I have a proxy' do
+      it 'The proxy can be set' do
+        config = Wedoops::MasmovilSmsclient::Configuration.new(proxy: "http://user:password@fake.proxy.com:1234/")
+        expect(config.valid_proxy?)
       end
-
-      xit 'I can validate user' do 
-      end
-
-      xit 'I can validate a password' do
-      end
-
-      xit 'The address is a valid URL' do 
-      end
-  
     end
 
     describe 'SOAP Client' do
@@ -41,11 +26,18 @@ RSpec.describe Wedoops::MasmovilSmsclient do
         expect(Wedoops::MasmovilSmsclient::Client.new).to be_an(Wedoops::MasmovilSmsclient::Client)
       end
 
-      it 'Can Send a SMS' do
+      it 'Cannot send an empty message' do
         client=Wedoops::MasmovilSmsclient::Client.new(Wedoops::MasmovilSmsclient.configuration)
-        response= client.sendSMS
-        pp response
-        expect(response).to be_an(String)
+        expect { client.sendSMS }.to raise_error(Wedoops::MasmovilSmsclient::MsgError)
+      end
+
+      it 'Can send a correct message' do
+        client=Wedoops::MasmovilSmsclient::Client.new(Wedoops::MasmovilSmsclient.configuration)
+        future_date = DateTime.now + (5/1440.0)
+        msg = {:src => "TESTER", :dst => "+34619766776", :msg => "This is the tester text #{DateTime.now.to_s}", :name => "Testing", :date => future_date.strftime("%F %TZ")}
+
+        response =  client.sendSMS(msg)
+        expect(response).to be_an(Savon::Response)
       end
     end
 end
\ No newline at end of file