locasms 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b416a1dbc0a2828144adc3cad4f46f648febe3eb
-  data.tar.gz: 91c5669394594303a92d79ada598e96e2075198b
+  metadata.gz: f3206ae592ae0a88e7f3622634cfc9eb3bfa1f61
+  data.tar.gz: c183953bd011a3b8515fee13e4d35e59219d3f43
 SHA512:
-  metadata.gz: c5d7e98110b2a257ec038716bbef0923fb49a9afc40edc84cbbe6a5ccd0bfebeaf5e9574219cf66ce329a36a7ad2083e786bf513d27c1212f31d031d7cc87327
-  data.tar.gz: 6e83d47e413f43a918f507e73b8130d8f0998c4b5caf3cdd43d86b1f67fe5964b68aba4baa9a75f6d0965199cd030487235ee167b43382a6d9605502a67732be
+  metadata.gz: 3aa9723d090e9549008084b59217db867dd5584ead9e2b6b54f137c4f0b17af73d010236bbe6ea480828c42b1e818280e410fdeaace6e0fe4be821f04004cd36
+  data.tar.gz: 4d46ad710feacdf3eae061b1c3a69cdf48754ea50c4c48150b66b75a67cf1ded264988d1f100a81d9a180b0b14b61653cae3752c5cfc27d866ca3b74db1503af

data/README.md

@@ -23,7 +23,7 @@ Simple example:
 ```ruby
 require 'locasms'
 
-cli = LocaSMS::Client.new login: 'LOGIN', password: 'PASSWORD'
+cli = LocaSMS::Client.new 'LOGIN', 'PASSWORD'
 
 # delivering message to one mobile
 cli.deliver 'my message', '1155559999'

data/lib/locasms/client.rb

@@ -24,7 +24,7 @@ module LocaSMS
     # @return [String] campaign id on success
     # @raise [LocaSMS::Exception] if bad numbers were given
     def deliver(message, *mobiles)
-      rest.get :sendsms, msg: message, numbers: numbers(mobiles)
+      rest.get(:sendsms, msg: message, numbers: numbers(mobiles))['data']
     end
 
     # Schedule the send of a message to one or more mobiles
@@ -35,34 +35,60 @@ module LocaSMS
     # @raise [LocaSMS::Exception] if bad numbers were given
     def deliver_at(message, datetime, *mobiles)
       date, time = Helpers::DateTimeHelper.split datetime
-      rest.get :sendsms, msg: message, numbers: numbers(mobiles), jobdate: date, jobtime: time
+      rest.get(:sendsms, msg: message, numbers: numbers(mobiles), jobdate: date, jobtime: time)['data']
     end
 
     # Get de current amount of sending credits
     # @return [Fixnum] returns the balance on success
     def balance
-      rest.get :getbalance
+      rest.get(:getbalance)['data']
     end
 
     # Gets the current status of the given campaign
     # @param [String] id campaign id
-    # @return UNDEF
+    # @return [Array<Hash>] {campaign_id: id, delivery_id: delivery_id, enqueue_time: enqueue_time, delivery_time: delivery_time, status: status, carrier: carrier, mobile_number: mobile_number, message: message }
     def campaign_status(id)
-      rest.get :getstatus, id: id
+      response = rest.get(:getstatus, id: id)
+      begin
+        CSV.new(response['data'] || '', col_sep: ';', quote_char: '"').map do |delivery_id, _, enqueue_time, _, delivery_time, _, status, _, _, carrier, mobile_number, _, message|
+          status = if status =~ /aguardando envio/i
+            :waiting
+          elsif status =~ /sucesso/i
+            :success
+          elsif status =~ /numero invalido|nao cadastrado/i
+            :invalid
+          else
+            :unknown
+          end
+
+          {
+            campaign_id: id,
+            delivery_id: delivery_id,
+            enqueue_time: enqueue_time,
+            delivery_time: delivery_time,
+            status: status,
+            carrier: carrier,
+            mobile_number: mobile_number,
+            message: message
+          }
+        end
+      rescue
+        raise Exception.new 'Invalid delivery response data'
+      end
     end
 
     # Holds the given campaign to fire
     # @param [String] id campaign id
     # @return [TrueClass,FalseClass] returns true on success
     def campaign_hold(id)
-      rest.get :holdsms, id: id
+      rest.get(:holdsms, id: id)['data']
     end
 
     # Restart firing the given campaign
     # @param [String] id campaign id
     # @return [TrueClass,FalseClass] returns true on success
     def campaign_release(id)
-      rest.get :releasesms, id: id
+      rest.get(:releasesms, id: id)['data']
     end
 
   private

data/lib/locasms/exception.rb

@@ -1,6 +1,36 @@
 module LocaSMS
 
+  # Common base exception
   class Exception < ::Exception
+    attr_reader :raw, :action
+
+    def initialize(data = {})
+      @raw    = data[:raw]
+      @action = data[:data]
+
+      super data[:message] || default_message
+    end
+
+  private
+
+    def default_message
+      nil
+    end
+  end
+
+  # Raised when asked for an invalid operation
+  # @see https://github.com/mcorp/locasms/wiki/A-API-de-envio#lista-das-a%C3%A7%C3%B5es-dispon%C3%ADveis
+  class InvalidOperation < Exception
+    def default_message
+      'Invalid Operation'
+    end
+  end
+
+  # Raised when the given credentials are invalid
+  class InvalidLogin < Exception
+    def default_message
+      'Invalid Login'
+    end
   end
 
 end

data/lib/locasms/rest_client.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 module LocaSMS
 
   # Class that handle http calls to LocaSMS api
@@ -16,25 +18,29 @@ module LocaSMS
     # Performs a GET call for an action
     # @param [String, Symbol] action the given action to perform
     # @param [Hash] params given parameters to send
-    # @return [String]
+    # @return [Hash] json parsed response
     #
     # @example Calling with no extra parameters
     #
     #     client = LocaSMS::RestClient('http://localhost:3000', lgn: 'LOGIN', pwd: 'PASSWORD')
     #     # => GET http://localhost:3000?lgn=LOGIN&pws=PASSWORD&action=getballance
     #     client.get :getballance
+    #     # => {"status"=>1,"data"=>341,"msg"=>nil}
     #
     # @example Calling with extra parameters
     #
     #     client = LocaSMS::RestClient('http://localhost:3000', lgn: 'LOGIN', pwd: 'PASSWORD')
     #     # => GET http://localhost:3000?lgn=LOGIN&pws=PASSWORD&action=holdsms&id=345678
     #     client.get :holdsms, id: 345678
+    #     # => {"status"=>1,"data"=>nil,"msg"=>"SUCESSO"}
     #
     # @see https://github.com/mcorp/locasms/wiki/A-API-de-envio#lista-das-a%C3%A7%C3%B5es-dispon%C3%ADveis List of avaiable actions
+    # @raise [LocaSMS::InvalidOperation] when asked for an invalid operation
+    # @raise [LocaSMS::InvalidLogin] when the given credentials are invalid
     def get(action, params={})
       params   = params_for action, params
       response = ::RestClient.get base_url, params: params
-      JSON.parse(response) rescue response
+      parse_response(action, response)
     end
 
     # Composes the parameters hash
@@ -52,6 +58,23 @@ module LocaSMS
     def params_for(action, params={})
       {action: action}.merge(base_params).merge(params)
     end
+
+    # Parses a result trying to get it in json
+    # @param [String, Symbol] action the given action to perform
+    # @param [String] response body
+    # @return [Hash] json parsed response
+    # @raise [LocaSMS::InvalidOperation] when asked for an invalid operation
+    # @raise [LocaSMS::InvalidLogin] when the given credentials are invalid
+    def parse_response(action, response)
+      raise InvalidOperation.new(action: action) if response =~ /^0:OPERACAO INVALIDA$/i
+
+      j = JSON.parse(response) rescue { 'status' => 1, 'data' => response, 'msg' => nil }
+
+      return j if j['status'] == 1 or action == :getstatus
+
+      raise InvalidLogin.new(action: action) if j['msg'] =~ /^falha ao realizar login$/i
+      raise Exception.new(message: j['msg'], raw: response, action: action)
+    end
   end
 
 end

data/lib/locasms/version.rb

@@ -1,3 +1,3 @@
 module LocaSMS
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 end

data/lib/locasms.rb

@@ -1,5 +1,6 @@
 require 'locasms/version'
 
+autoload :CSV,        'csv'
 autoload :JSON,       'json'
 autoload :RestClient, 'rest_client'
 autoload :Logger,     'logger'

data/spec/lib/locasms/client_spec.rb

@@ -19,6 +19,7 @@ describe LocaSMS::Client do
       rest_client.should_receive(:get)
         .once
         .with(:sendsms, msg: 'given message', numbers:'XXX')
+        .and_return({})
 
       subject.deliver 'given message', :a, :b, :c
     end
@@ -50,6 +51,7 @@ describe LocaSMS::Client do
       rest_client.should_receive(:get)
         .once
         .with(:sendsms, msg: 'given message', numbers:'XXX', jobdate: 'date', jobtime: 'time')
+        .and_return({})
 
       subject.deliver_at 'given message', :datetime, :a, :b, :c
     end
@@ -76,6 +78,7 @@ describe LocaSMS::Client do
       rest_client.should_receive(:get)
         .once
         .with(:getbalance)
+        .and_return({})
 
       subject.balance
     end
@@ -92,6 +95,7 @@ describe LocaSMS::Client do
       rest_client.should_receive(:get)
         .once
         .with(rest_method, id: '12345')
+        .and_return({})
 
       subject.send method, '12345'
     end
@@ -99,6 +103,8 @@ describe LocaSMS::Client do
     it{ check_for :campaign_status  }
     it{ check_for :campaign_hold    }
     it{ check_for :campaign_release }
+
+    it 'Should have tests to cover campaign_status csv result'
   end
 
 end

data/spec/lib/locasms/rest_client_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe LocaSMS::RestClient do
-
   describe '.initialize' do
     context 'When giving proper initialization parameters' do
       subject { LocaSMS::RestClient.new :url, :params }
@@ -21,4 +20,28 @@ describe LocaSMS::RestClient do
     it{ subject.params_for(:action, p1: 10).should == {action: :action, b1: 'X', p1: 10} }
   end
 
+  describe '#parse_response' do
+    subject { LocaSMS::RestClient.new :url, :params }
+
+    it 'Should raise exception on invalid operation' do
+      lambda{ subject.parse_response(:action, '0:OPERACAO INVALIDA') }.should raise_error(LocaSMS::InvalidOperation)
+    end
+
+    it 'Should raise exception on a failed response' do
+      lambda{ subject.parse_response(:action, '{"status":0,"data":null,"msg":"FALHA EPICA"}') }.should raise_error(LocaSMS::Exception, 'FALHA EPICA')
+    end
+
+    it 'Should raise exception on a failed login attempt' do
+      lambda{ subject.parse_response(:action, '{"status":0,"data":null,"msg":"FALHA AO REALIZAR LOGIN"}') }.should raise_error(LocaSMS::InvalidLogin)
+    end
+
+    it 'Should return the non-json value as a json' do
+      subject.parse_response(:action, 'non-json return').should == {'status' => 1, 'data' => 'non-json return', "msg" => nil}
+    end
+
+    it 'Should return a parsed json return' do
+      subject.parse_response(:action, '{"status":1,"data":28,"msg":null}').should == {'status' => 1, 'data' => 28, "msg" => nil}
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: locasms
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Adilson Carvalho
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-14 00:00:00.000000000 Z
+date: 2013-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler