messagebird-rest 1.4.0 → 3.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (44) hide show
  1. checksums.yaml +5 -5
  2. data/README.md +56 -8
  3. data/lib/messagebird.rb +11 -6
  4. data/lib/messagebird/balance.rb +2 -0
  5. data/lib/messagebird/base.rb +12 -7
  6. data/lib/messagebird/call_flow.rb +22 -0
  7. data/lib/messagebird/call_flow/step.rb +9 -0
  8. data/lib/messagebird/callflow.rb +60 -0
  9. data/lib/messagebird/client.rb +342 -52
  10. data/lib/messagebird/contact.rb +11 -9
  11. data/lib/messagebird/contact_reference.rb +3 -1
  12. data/lib/messagebird/conversation.rb +44 -0
  13. data/lib/messagebird/conversation_channel.rb +18 -0
  14. data/lib/messagebird/conversation_client.rb +22 -0
  15. data/lib/messagebird/conversation_message.rb +10 -0
  16. data/lib/messagebird/conversation_webhook.rb +9 -0
  17. data/lib/messagebird/custom_details.rb +2 -0
  18. data/lib/messagebird/error.rb +2 -0
  19. data/lib/messagebird/group.rb +9 -7
  20. data/lib/messagebird/group_reference.rb +3 -1
  21. data/lib/messagebird/hlr.rb +8 -6
  22. data/lib/messagebird/http_client.rb +46 -29
  23. data/lib/messagebird/list.rb +5 -4
  24. data/lib/messagebird/lookup.rb +7 -5
  25. data/lib/messagebird/message.rb +9 -7
  26. data/lib/messagebird/message_reference.rb +3 -1
  27. data/lib/messagebird/number.rb +18 -0
  28. data/lib/messagebird/number_client.rb +22 -0
  29. data/lib/messagebird/recipient.rb +6 -3
  30. data/lib/messagebird/signed_request.rb +50 -0
  31. data/lib/messagebird/verify.rb +14 -7
  32. data/lib/messagebird/verify_email_message.rb +9 -0
  33. data/lib/messagebird/version.rb +7 -0
  34. data/lib/messagebird/voice/base.rb +16 -0
  35. data/lib/messagebird/voice/call.rb +22 -0
  36. data/lib/messagebird/voice/call_leg.rb +11 -0
  37. data/lib/messagebird/voice/call_leg_recording.rb +20 -0
  38. data/lib/messagebird/voice/client.rb +22 -0
  39. data/lib/messagebird/voice/list.rb +24 -0
  40. data/lib/messagebird/voice/transcription.rb +15 -0
  41. data/lib/messagebird/voice/webhook.rb +11 -0
  42. data/lib/messagebird/voice_client.rb +25 -0
  43. data/lib/messagebird/voicemessage.rb +8 -7
  44. metadata +59 -10
@@ -1,7 +1,9 @@
1
+ # frozen_string_literal: true
2
+
1
3
  require 'messagebird/base'
2
4
 
3
5
  module MessageBird
4
6
  class MessageReference < MessageBird::Base
5
- attr_accessor :href, :totalCount
7
+ attr_accessor :href, :total_count
6
8
  end
7
9
  end
@@ -0,0 +1,18 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'messagebird/base'
4
+
5
+ module MessageBird
6
+ class Number < MessageBird::Base
7
+ attr_accessor :number, :country, :region, :locality, :features, :tags, :type, :status
8
+ attr_reader :created_at, :renewal_at
9
+
10
+ def created_at=(value)
11
+ @created_at = Time.parse(value)
12
+ end
13
+
14
+ def renewal_at=(value)
15
+ @renewal_at = Time.parse(value)
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'net/https'
4
+ require 'uri'
5
+ require 'pp'
6
+ require 'json'
7
+ require 'messagebird/http_client'
8
+
9
+ module MessageBird
10
+ class NumberClient < HttpClient
11
+ ENDPOINT = 'https://numbers.messagebird.com/v1/'
12
+
13
+ def endpoint
14
+ ENDPOINT
15
+ end
16
+
17
+ def prepare_request(request, params = {})
18
+ request.body = params.to_json
19
+ request
20
+ end
21
+ end
22
+ end
@@ -1,11 +1,14 @@
1
+ # frozen_string_literal: true
2
+
1
3
  require 'messagebird/base'
2
4
 
3
5
  module MessageBird
4
6
  class Recipient < MessageBird::Base
5
- attr_accessor :recipient, :status, :statusDatetime
7
+ attr_accessor :recipient, :status
8
+ attr_reader :status_date_time
6
9
 
7
- def statusDatetime=(value)
8
- @statusDatetime = value_to_time(value)
10
+ def status_date_time=(value)
11
+ @status_date_time = value_to_time(value)
9
12
  end
10
13
  end
11
14
  end
@@ -0,0 +1,50 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'base64'
4
+ require 'digest'
5
+ require 'time'
6
+
7
+ module MessageBird
8
+ class ValidationException < TypeError
9
+ end
10
+
11
+ class SignedRequest
12
+ def initialize(query_parameters, signature, request_timestamp, body)
13
+ unless query_parameters.is_a? Hash
14
+ raise ValidationException, 'The "query_parameters" value is invalid.'
15
+ end
16
+ unless signature.is_a? String
17
+ raise ValidationException, 'The "signature" value is invalid.'
18
+ end
19
+ unless request_timestamp.is_a? Integer
20
+ raise ValidationException, 'The "request_timestamp" value is invalid.'
21
+ end
22
+ unless body.is_a? String
23
+ raise ValidationException, 'The "body" value is invalid.'
24
+ end
25
+
26
+ @query_parameters = query_parameters
27
+ @signature = signature
28
+ @request_timestamp = request_timestamp
29
+ @body = body
30
+ end
31
+
32
+ def verify(signing_key)
33
+ calculated_signature = OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'), signing_key, build_payload)
34
+ expected_signature = Base64.decode64(@signature)
35
+ calculated_signature.bytes == expected_signature.bytes
36
+ end
37
+
38
+ def build_payload
39
+ parts = []
40
+ parts.push(@request_timestamp)
41
+ parts.push(URI.encode_www_form(@query_parameters.sort))
42
+ parts.push(Digest::SHA256.new.digest(@body))
43
+ parts.join("\n")
44
+ end
45
+
46
+ def recent?(offset = 10)
47
+ (Time.now.getutc.to_i - @request_timestamp) < offset
48
+ end
49
+ end
50
+ end
@@ -1,18 +1,25 @@
1
- require 'time'
1
+ # frozen_string_literal: true
2
2
 
3
+ require 'time'
3
4
  require 'messagebird/base'
4
5
 
5
6
  module MessageBird
6
7
  class Verify < MessageBird::Base
7
- attr_accessor :id, :recipient, :reference, :status, :href,
8
- :createdDatetime, :validUntilDatetime
8
+ attr_accessor :id,
9
+ :href,
10
+ :recipient,
11
+ :reference,
12
+ :messages,
13
+ :status
14
+ attr_reader :created_datetime,
15
+ :valid_until_datetime
9
16
 
10
- def createdDatetime=(value)
11
- @createdDatetime = value_to_time(value)
17
+ def created_datetime=(value)
18
+ @created_datetime = value_to_time(value)
12
19
  end
13
20
 
14
- def validUntilDatetime=(value)
15
- @validUntilDatetime = value_to_time(value)
21
+ def valid_until_datetime=(value)
22
+ @valid_until_datetime = value_to_time(value)
16
23
  end
17
24
  end
18
25
  end
@@ -0,0 +1,9 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'messagebird/base'
4
+
5
+ module MessageBird
6
+ class VerifyEmailMessage < MessageBird::Base
7
+ attr_accessor :id, :status
8
+ end
9
+ end
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ module MessageBird
4
+ module Version
5
+ STRING = '3.0.0'
6
+ end
7
+ end
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+
3
+ module MessageBird
4
+ module Voice
5
+ class Base < MessageBird::Base
6
+ def initialize(json)
7
+ params = json.include?('data') ? json['data'].first : json
8
+ super(params)
9
+ handle_links(json['_links'])
10
+ end
11
+
12
+ # intentional empty method, objects may not want to deal with _links
13
+ def handle_links(json) end
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'messagebird/voice/base'
4
+ require 'messagebird/voice/webhook'
5
+
6
+ module MessageBird
7
+ module Voice
8
+ class Call < MessageBird::Base
9
+ attr_accessor :id, :status, :source, :destination, :created_at, :updated_at, :ended_at, :call_flow
10
+ attr_reader :webhook
11
+
12
+ def initialize(json)
13
+ params = json.include?('data') ? json['data'].first : json
14
+ super(params)
15
+ end
16
+
17
+ def webhook=(webhook)
18
+ @webhook = Voice::Webhook.new(webhook)
19
+ end
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'messagebird/voice/base'
4
+
5
+ module MessageBird
6
+ module Voice
7
+ class CallLeg < MessageBird::Voice::Base
8
+ attr_accessor :id, :call_id, :source, :destination, :status, :direction, :cost, :currency, :duration, :created_at, :updated_at, :answered_at, :ended_at
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'messagebird/voice/base'
4
+
5
+ module MessageBird
6
+ module Voice
7
+ class CallLegRecording < MessageBird::Voice::Base
8
+ # default attributes from the API
9
+ attr_accessor :id, :format, :type, :leg_id, :status, :duration
10
+ attr_accessor :created_at, :updated_at
11
+
12
+ # further processed attributes for convenience
13
+ attr_accessor :_links, :uri
14
+ # Grab the URI to the downloadable file and provide it as a direct attribute
15
+ def handle_links(links_object)
16
+ @uri = links_object['file']
17
+ end
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'net/https'
4
+ require 'uri'
5
+ require 'json'
6
+ require 'messagebird/http_client'
7
+
8
+ module MessageBird
9
+ class VoiceClient < HttpClient
10
+ ENDPOINT = 'https://voice.messagebird.com/'
11
+
12
+ def endpoint
13
+ ENDPOINT
14
+ end
15
+
16
+ def prepare_request(request, params = {})
17
+ request['Content-Type'] = 'application/json'
18
+ request.body = params.to_json
19
+ request
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,24 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'messagebird/list'
4
+
5
+ module MessageBird
6
+ module Voice
7
+ class List < List
8
+ attr_accessor :per_page, :current_page, :page_count, :total_count
9
+ PER_PAGE = 20
10
+ CURRENT_PAGE = 1
11
+ def data=(value)
12
+ # Call List API retruns data object instead of items
13
+ # to make it consistence with the rest of the SDK we shall
14
+ # propagate it to items= method
15
+ self.items = value.nil? ? [] : value
16
+ end
17
+
18
+ # map the pagination data to root level properties
19
+ def pagination=(value)
20
+ map_hash_elements_to_self(value)
21
+ end
22
+ end
23
+ end
24
+ end
@@ -0,0 +1,15 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'messagebird/base'
4
+
5
+ module MessageBird
6
+ module Voice
7
+ class Transcription < MessageBird::Voice::Base
8
+ attr_accessor :id, :recording_id, :error, :created_at, :updated_at, :_links, :uri
9
+
10
+ def handle_links(links_object)
11
+ @uri = links_object['file']
12
+ end
13
+ end
14
+ end
15
+ end
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'messagebird/voice/base'
4
+
5
+ module MessageBird
6
+ module Voice
7
+ class Webhook < MessageBird::Voice::Base
8
+ attr_accessor :id, :url, :token, :created_at, :updated_at
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,25 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'net/https'
4
+ require 'uri'
5
+ require 'json'
6
+ require 'messagebird/http_client'
7
+
8
+ module MessageBird
9
+ class VoiceClient < HttpClient
10
+ attr_reader :endpoint
11
+
12
+ BASE_ENDPOINT = 'https://voice.messagebird.com/'
13
+
14
+ def initialize(access_key)
15
+ super(access_key)
16
+ @endpoint = BASE_ENDPOINT
17
+ end
18
+
19
+ def prepare_request(request, params = {})
20
+ request['Content-Type'] = 'application/json'
21
+ request.body = params.to_json
22
+ request
23
+ end
24
+ end
25
+ end
@@ -1,18 +1,19 @@
1
+ # frozen_string_literal: true
2
+
1
3
  require 'messagebird/base'
2
4
  require 'messagebird/recipient'
3
5
 
4
6
  module MessageBird
5
7
  class VoiceMessage < MessageBird::Base
6
- attr_accessor :id, :href, :originator, :body, :reference, :language, :voice, :repeat,
7
- :ifMachine, :scheduledDatetime, :createdDatetime, :recipients
8
-
8
+ attr_accessor :id, :href, :originator, :body, :reference, :language, :voice, :repeat, :if_machine
9
+ attr_reader :scheduled_date_time, :created_datetime, :recipients
9
10
 
10
- def scheduledDatetime=(value)
11
- @scheduledDatetime = value_to_time(value)
11
+ def scheduled_date_time=(value)
12
+ @scheduled_date_time = value_to_time(value)
12
13
  end
13
14
 
14
- def createdDatetime=(value)
15
- @createdDatetime = value_to_time(value)
15
+ def created_datetime=(value)
16
+ @created_datetime = value_to_time(value)
16
17
  end
17
18
 
18
19
  def recipients=(json)
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: messagebird-rest
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.4.0
4
+ version: 3.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Maurice Nonnekes
8
- autorequire:
8
+ autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2018-09-15 00:00:00.000000000 Z
11
+ date: 2021-06-25 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rspec
@@ -16,14 +16,42 @@ dependencies:
16
16
  requirements:
17
17
  - - "~>"
18
18
  - !ruby/object:Gem::Version
19
- version: '3.8'
19
+ version: 3.10.0
20
20
  type: :development
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - "~>"
25
25
  - !ruby/object:Gem::Version
26
- version: '3.8'
26
+ version: 3.10.0
27
+ - !ruby/object:Gem::Dependency
28
+ name: rubocop
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: 0.77.0
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: 0.77.0
41
+ - !ruby/object:Gem::Dependency
42
+ name: webmock
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: 3.7.5
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: 3.7.5
27
55
  description: A simple REST API for MessageBird in Ruby
28
56
  email: maurice@messagebird.com
29
57
  executables: []
@@ -35,9 +63,17 @@ files:
35
63
  - lib/messagebird.rb
36
64
  - lib/messagebird/balance.rb
37
65
  - lib/messagebird/base.rb
66
+ - lib/messagebird/call_flow.rb
67
+ - lib/messagebird/call_flow/step.rb
68
+ - lib/messagebird/callflow.rb
38
69
  - lib/messagebird/client.rb
39
70
  - lib/messagebird/contact.rb
40
71
  - lib/messagebird/contact_reference.rb
72
+ - lib/messagebird/conversation.rb
73
+ - lib/messagebird/conversation_channel.rb
74
+ - lib/messagebird/conversation_client.rb
75
+ - lib/messagebird/conversation_message.rb
76
+ - lib/messagebird/conversation_webhook.rb
41
77
  - lib/messagebird/custom_details.rb
42
78
  - lib/messagebird/error.rb
43
79
  - lib/messagebird/group.rb
@@ -48,14 +84,28 @@ files:
48
84
  - lib/messagebird/lookup.rb
49
85
  - lib/messagebird/message.rb
50
86
  - lib/messagebird/message_reference.rb
87
+ - lib/messagebird/number.rb
88
+ - lib/messagebird/number_client.rb
51
89
  - lib/messagebird/recipient.rb
90
+ - lib/messagebird/signed_request.rb
52
91
  - lib/messagebird/verify.rb
92
+ - lib/messagebird/verify_email_message.rb
93
+ - lib/messagebird/version.rb
94
+ - lib/messagebird/voice/base.rb
95
+ - lib/messagebird/voice/call.rb
96
+ - lib/messagebird/voice/call_leg.rb
97
+ - lib/messagebird/voice/call_leg_recording.rb
98
+ - lib/messagebird/voice/client.rb
99
+ - lib/messagebird/voice/list.rb
100
+ - lib/messagebird/voice/transcription.rb
101
+ - lib/messagebird/voice/webhook.rb
102
+ - lib/messagebird/voice_client.rb
53
103
  - lib/messagebird/voicemessage.rb
54
104
  homepage: https://github.com/messagebird/ruby-rest-api
55
105
  licenses:
56
106
  - BSD-2-Clause
57
107
  metadata: {}
58
- post_install_message:
108
+ post_install_message:
59
109
  rdoc_options: []
60
110
  require_paths:
61
111
  - lib
@@ -63,16 +113,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
63
113
  requirements:
64
114
  - - ">="
65
115
  - !ruby/object:Gem::Version
66
- version: '0'
116
+ version: '2.0'
67
117
  required_rubygems_version: !ruby/object:Gem::Requirement
68
118
  requirements:
69
119
  - - ">="
70
120
  - !ruby/object:Gem::Version
71
121
  version: '0'
72
122
  requirements: []
73
- rubyforge_project:
74
- rubygems_version: 2.5.2.3
75
- signing_key:
123
+ rubygems_version: 3.2.15
124
+ signing_key:
76
125
  specification_version: 4
77
126
  summary: MessageBird's REST API
78
127
  test_files: []