moceansdk 0.1.7 → 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/LICENSE.txt +21 -21
- data/README.md +30 -13
- data/lib/moceansdk.rb +28 -6
- data/lib/moceansdk/auth/abstract_auth.rb +15 -0
- data/lib/moceansdk/auth/basic.rb +29 -0
- data/lib/moceansdk/client.rb +58 -10
- data/lib/moceansdk/exceptions/mocean_error.rb +18 -0
- data/lib/moceansdk/exceptions/required_field_exception.rb +8 -0
- data/lib/moceansdk/modules/abstact_client.rb +54 -0
- data/lib/moceansdk/modules/account/balance.rb +24 -20
- data/lib/moceansdk/modules/account/pricing.rb +35 -35
- data/lib/moceansdk/modules/message/channel.rb +12 -0
- data/lib/moceansdk/modules/message/message_status.rb +27 -22
- data/lib/moceansdk/modules/message/sms.rb +71 -93
- data/lib/moceansdk/modules/message/verify_request.rb +79 -56
- data/lib/moceansdk/modules/message/verify_validate.rb +31 -35
- data/lib/moceansdk/modules/number_lookup/number_lookup.rb +34 -0
- data/lib/moceansdk/modules/response_factory.rb +50 -0
- data/lib/moceansdk/modules/transmitter.rb +92 -0
- data/lib/moceansdk/utils.rb +9 -0
- data/lib/moceansdk/version.rb +3 -3
- data/moceansdk.gemspec +25 -19
- metadata +56 -19
- data/lib/moceansdk/init.rb +0 -4
- data/lib/moceansdk/mocean.rb +0 -52
- data/lib/moceansdk/modules/abstract.rb +0 -142
@@ -1,25 +1,30 @@
|
|
1
|
-
|
1
|
+
module Moceansdk
|
2
|
+
module Modules
|
3
|
+
module Message
|
4
|
+
|
5
|
+
class MessageStatus < Moceansdk::Modules::AbstractClient
|
6
|
+
def initialize(obj_auth, transmitter)
|
7
|
+
super(obj_auth, transmitter)
|
8
|
+
@required_fields = ['mocean-api-key', 'mocean-api-secret', 'mocean-msgid']
|
9
|
+
end
|
10
|
+
|
11
|
+
def msgid=(param)
|
12
|
+
@params['mocean-msgid'] = param
|
13
|
+
end
|
14
|
+
|
15
|
+
def resp_format=(param)
|
16
|
+
@params['mocean-resp-format'] = param
|
17
|
+
end
|
18
|
+
|
19
|
+
def inquiry(params = {})
|
20
|
+
create(params)
|
21
|
+
create_final_params
|
22
|
+
required_field_set?
|
23
|
+
|
24
|
+
@transmitter.get('/report/message', @params)
|
25
|
+
end
|
26
|
+
end
|
2
27
|
|
3
|
-
class Message_status < MoceanFactory
|
4
|
-
def initialize client
|
5
|
-
super(client)
|
6
|
-
@required_fields = ['mocean-api-key','mocean-api-secret','mocean-msgid']
|
7
|
-
end
|
8
|
-
|
9
|
-
def setMsgid param
|
10
|
-
@params['mocean-msgid'] = param
|
11
|
-
end
|
12
|
-
|
13
|
-
def setRespFormat param
|
14
|
-
@params['mocean-resp-format'] = param
|
15
|
-
end
|
16
|
-
|
17
|
-
def inquiry params
|
18
|
-
create(params)
|
19
|
-
createFinalParams
|
20
|
-
isRequiredFieldsSet
|
21
|
-
response = Transmitter.new('/rest/1/report/message','get',@params)
|
22
|
-
reset
|
23
|
-
return response.getResponse()
|
24
28
|
end
|
29
|
+
end
|
25
30
|
end
|
@@ -1,96 +1,74 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
end
|
42
|
-
|
43
|
-
def setDlrUrl param
|
44
|
-
@params['mocean-dlr-url'] = param
|
45
|
-
return self
|
46
|
-
end
|
47
|
-
|
48
|
-
def setSchedule param
|
49
|
-
@params['mocean-schedule'] = param
|
50
|
-
return self
|
51
|
-
end
|
52
|
-
|
53
|
-
def setMclass param
|
54
|
-
@params['mocean-mclass'] = param
|
55
|
-
return self
|
56
|
-
end
|
57
|
-
|
58
|
-
def setAltDcs param
|
59
|
-
@params['mocean-alt-dcs'] = param
|
60
|
-
return self
|
61
|
-
end
|
62
|
-
|
63
|
-
def setCharset param
|
64
|
-
@params['mocean-charset'] = param
|
65
|
-
return self
|
66
|
-
end
|
67
|
-
|
68
|
-
def setValidity param
|
69
|
-
@params['mocean-validity'] = param
|
70
|
-
return self
|
71
|
-
end
|
72
|
-
|
73
|
-
def setRespFormat param
|
74
|
-
@params['mocean-resp-format'] = param
|
75
|
-
return self
|
76
|
-
end
|
77
|
-
|
78
|
-
def create params = {}
|
79
|
-
reset
|
80
|
-
super(params)
|
81
|
-
return self
|
82
|
-
end
|
83
|
-
|
84
|
-
def send
|
85
|
-
if @flashSms == true
|
86
|
-
setMclass(1)
|
87
|
-
setAltDcs(1)
|
1
|
+
module Moceansdk
|
2
|
+
module Modules
|
3
|
+
module Message
|
4
|
+
|
5
|
+
class Sms < AbstractClient
|
6
|
+
def initialize(obj_auth, transmitter)
|
7
|
+
super(obj_auth, transmitter)
|
8
|
+
@required_fields = ['mocean-api-key', 'mocean-api-secret', 'mocean-from', 'mocean-to', 'mocean-text']
|
9
|
+
end
|
10
|
+
|
11
|
+
def from=(param)
|
12
|
+
@params['mocean-from'] = param
|
13
|
+
end
|
14
|
+
|
15
|
+
def to=(param)
|
16
|
+
@params['mocean-to'] = param
|
17
|
+
end
|
18
|
+
|
19
|
+
def text=(param)
|
20
|
+
@params['mocean-text'] = param
|
21
|
+
end
|
22
|
+
|
23
|
+
def udh=(param)
|
24
|
+
@params['mocean-udh'] = param
|
25
|
+
end
|
26
|
+
|
27
|
+
def coding=(param)
|
28
|
+
@params['mocean-coding'] = param
|
29
|
+
end
|
30
|
+
|
31
|
+
def dlr_mask=(param)
|
32
|
+
@params['mocean-dlr-mask'] = param
|
33
|
+
end
|
34
|
+
|
35
|
+
def dlr_url=(param)
|
36
|
+
@params['mocean-dlr-url'] = param
|
37
|
+
end
|
38
|
+
|
39
|
+
def schedule=(param)
|
40
|
+
@params['mocean-schedule'] = param
|
88
41
|
end
|
89
|
-
|
90
|
-
|
91
|
-
|
92
|
-
|
42
|
+
|
43
|
+
def mclass=(param)
|
44
|
+
@params['mocean-mclass'] = param
|
45
|
+
end
|
46
|
+
|
47
|
+
def alt_dcs=(param)
|
48
|
+
@params['mocean-alt-dcs'] = param
|
49
|
+
end
|
50
|
+
|
51
|
+
def charset=(param)
|
52
|
+
@params['mocean-charset'] = param
|
53
|
+
end
|
54
|
+
|
55
|
+
def validity=(param)
|
56
|
+
@params['mocean-validity'] = param
|
57
|
+
end
|
58
|
+
|
59
|
+
def resp_format=(param)
|
60
|
+
@params['mocean-resp-format'] = param
|
61
|
+
end
|
62
|
+
|
63
|
+
def send(params = {})
|
64
|
+
create(params)
|
65
|
+
create_final_params
|
66
|
+
required_field_set?
|
67
|
+
|
68
|
+
@transmitter.post('/sms', @params)
|
69
|
+
end
|
70
|
+
end
|
71
|
+
|
93
72
|
end
|
94
|
-
|
95
|
-
|
73
|
+
end
|
96
74
|
end
|
@@ -1,59 +1,82 @@
|
|
1
|
-
|
1
|
+
module Moceansdk
|
2
|
+
module Modules
|
3
|
+
module Message
|
4
|
+
|
5
|
+
class VerifyRequest < Moceansdk::Modules::AbstractClient
|
6
|
+
attr_reader :channel, :is_resend
|
7
|
+
|
8
|
+
def initialize(obj_auth, transmitter)
|
9
|
+
super(obj_auth, transmitter)
|
10
|
+
@required_fields = ['mocean-api-key', 'mocean-api-secret', 'mocean-to', 'mocean-brand']
|
11
|
+
@channel = Channel::AUTO
|
12
|
+
@is_resend = false
|
13
|
+
end
|
14
|
+
|
15
|
+
def to=(param)
|
16
|
+
@params['mocean-to'] = param
|
17
|
+
end
|
18
|
+
|
19
|
+
def brand=(param)
|
20
|
+
@params['mocean-brand'] = param
|
21
|
+
end
|
22
|
+
|
23
|
+
def from=(param)
|
24
|
+
@params['mocean-from'] = param
|
25
|
+
end
|
26
|
+
|
27
|
+
def code_length=(param)
|
28
|
+
@params['mocean-code-length'] = param
|
29
|
+
end
|
30
|
+
|
31
|
+
def template=(param)
|
32
|
+
@params['mocean-template'] = param
|
33
|
+
end
|
34
|
+
|
35
|
+
def pin_validity=(param)
|
36
|
+
@params['mocean-pin-validity'] = param
|
37
|
+
end
|
38
|
+
|
39
|
+
def next_event_wait=(param)
|
40
|
+
@params['mocean-next-event-wait'] = param
|
41
|
+
end
|
42
|
+
|
43
|
+
def resp_format=(param)
|
44
|
+
@params['mocean-resp-format'] = param
|
45
|
+
end
|
46
|
+
|
47
|
+
def send_as(channel)
|
48
|
+
@channel = channel
|
49
|
+
self
|
50
|
+
end
|
51
|
+
|
52
|
+
def send(params = {})
|
53
|
+
create(params)
|
54
|
+
create_final_params
|
55
|
+
required_field_set?
|
56
|
+
|
57
|
+
verify_request_url = '/verify'
|
58
|
+
verify_request_url += if @is_resend
|
59
|
+
'/resend'
|
60
|
+
else
|
61
|
+
'/req'
|
62
|
+
end
|
63
|
+
|
64
|
+
if @channel == Channel::SMS
|
65
|
+
verify_request_url += '/sms'
|
66
|
+
end
|
67
|
+
|
68
|
+
@transmitter.post(verify_request_url, @params)
|
69
|
+
end
|
70
|
+
|
71
|
+
def resend(params = {})
|
72
|
+
send_as Channel::SMS
|
73
|
+
@is_resend = true
|
74
|
+
@required_fields = ['mocean-api-key', 'mocean-api-secret', 'mocean-reqid']
|
75
|
+
|
76
|
+
send(params)
|
77
|
+
end
|
78
|
+
end
|
2
79
|
|
3
|
-
class Verify_request < MoceanFactory
|
4
|
-
|
5
|
-
def __init__ client
|
6
|
-
super(client)
|
7
|
-
@required_fields = ['mocean-api-key','mocean-api-secret','mocean-to','mocean-brand']
|
8
|
-
end
|
9
|
-
|
10
|
-
def setTo param
|
11
|
-
@params['mocean-to'] = param
|
12
|
-
return self
|
13
|
-
end
|
14
|
-
|
15
|
-
def setBrand
|
16
|
-
@params['mocean-brand'] = param
|
17
|
-
return self;
|
18
|
-
end
|
19
|
-
|
20
|
-
def setFrom param
|
21
|
-
@params['mocean-from'] = param
|
22
|
-
return self;
|
23
|
-
end
|
24
|
-
|
25
|
-
def setTemplate param
|
26
|
-
@params['mocean-template'] = param
|
27
|
-
return self;
|
28
|
-
end
|
29
|
-
|
30
|
-
def setPinValidate param
|
31
|
-
@params['mocean-pin-validate'] = param
|
32
|
-
return self
|
33
|
-
end
|
34
|
-
|
35
|
-
def setNextEventWait param
|
36
|
-
@params['mocean-next-event-wait'] = param
|
37
|
-
return self
|
38
|
-
end
|
39
|
-
|
40
|
-
def setRespFormat param
|
41
|
-
@params['mocean-resp-format'] = param
|
42
|
-
return self
|
43
|
-
end
|
44
|
-
|
45
|
-
def create params = {}
|
46
|
-
reset
|
47
|
-
super(params)
|
48
|
-
return self
|
49
|
-
end
|
50
|
-
|
51
|
-
def send
|
52
|
-
createFinalParams
|
53
|
-
isRequiredFieldsSet
|
54
|
-
response = Transmitter.new('/rest/1/verify/req','post',@params)
|
55
|
-
return response.getResponse()
|
56
80
|
end
|
57
|
-
|
58
|
-
|
81
|
+
end
|
59
82
|
end
|
@@ -1,38 +1,34 @@
|
|
1
|
-
|
1
|
+
module Moceansdk
|
2
|
+
module Modules
|
3
|
+
module Message
|
4
|
+
|
5
|
+
class VerifyValidate < Moceansdk::Modules::AbstractClient
|
6
|
+
def initialize(obj_auth, transmitter)
|
7
|
+
super(obj_auth, transmitter)
|
8
|
+
@required_fields = ['mocean-api-key', 'mocean-api-secret', 'mocean-reqid', 'mocean-code']
|
9
|
+
end
|
10
|
+
|
11
|
+
def reqid=(param)
|
12
|
+
@params['mocean-reqid'] = param
|
13
|
+
end
|
14
|
+
|
15
|
+
def code=(param)
|
16
|
+
@params['mocean-code'] = param
|
17
|
+
end
|
18
|
+
|
19
|
+
def resp_format=(param)
|
20
|
+
@params['mocean-resp-format'] = param
|
21
|
+
end
|
22
|
+
|
23
|
+
def send(params = {})
|
24
|
+
create(params)
|
25
|
+
create_final_params
|
26
|
+
required_field_set?
|
27
|
+
|
28
|
+
@transmitter.post('/verify/check', @params)
|
29
|
+
end
|
30
|
+
end
|
2
31
|
|
3
|
-
class Verify_validate < MoceanFactory
|
4
|
-
|
5
|
-
def __init__ client
|
6
|
-
super(client)
|
7
|
-
@required_fields = ['mocean-api-key','mocean-api-secret','mocean-reqid','mocean-code']
|
8
|
-
end
|
9
|
-
|
10
|
-
def setReqid param
|
11
|
-
@params['mocean-reqid'] = param
|
12
|
-
return self
|
13
|
-
end
|
14
|
-
|
15
|
-
def setCode param
|
16
|
-
@params['mocean-code'] = param
|
17
|
-
return self
|
18
|
-
end
|
19
|
-
|
20
|
-
def setRespFormat param
|
21
|
-
@params['mocean-resp-format'] = param
|
22
|
-
return self
|
23
|
-
end
|
24
|
-
|
25
|
-
def create params = {}
|
26
|
-
reset
|
27
|
-
super(params)
|
28
|
-
return self
|
29
|
-
end
|
30
|
-
|
31
|
-
def send
|
32
|
-
createFinalParams
|
33
|
-
isRequiredFieldsSet
|
34
|
-
response = Transmitter.new('/rest/1/verify/check','post',@params)
|
35
|
-
return response.getResponse()
|
36
32
|
end
|
37
|
-
|
33
|
+
end
|
38
34
|
end
|
@@ -0,0 +1,34 @@
|
|
1
|
+
module Moceansdk
|
2
|
+
module Modules
|
3
|
+
module NumberLookup
|
4
|
+
|
5
|
+
class NumberLookup < Moceansdk::Modules::AbstractClient
|
6
|
+
def initialize(obj_auth, transmitter)
|
7
|
+
super(obj_auth, transmitter)
|
8
|
+
@required_fields = ['mocean-api-key', 'mocean-api-secret', 'mocean-to']
|
9
|
+
end
|
10
|
+
|
11
|
+
def to=(param)
|
12
|
+
@params['mocean-to'] = param
|
13
|
+
end
|
14
|
+
|
15
|
+
def nl_url=(param)
|
16
|
+
@params['mocean-nl-url'] = param
|
17
|
+
end
|
18
|
+
|
19
|
+
def resp_format=(param)
|
20
|
+
@params['mocean-resp-format'] = param
|
21
|
+
end
|
22
|
+
|
23
|
+
def inquiry(params = {})
|
24
|
+
create(params)
|
25
|
+
create_final_params
|
26
|
+
required_field_set?
|
27
|
+
|
28
|
+
@transmitter.post('/nl', @params)
|
29
|
+
end
|
30
|
+
end
|
31
|
+
|
32
|
+
end
|
33
|
+
end
|
34
|
+
end
|