messagebird-rest 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 206da8f9eaa52678002b0aab12ebb8f7be356157
-  data.tar.gz: 9d7edf4b0e0c2008bac7d5fa5553efddbbce8a56
+  metadata.gz: d8af99a7a5eb2bb8576cfe1e880ed6443a13a962
+  data.tar.gz: c86b5b379a2e012af6494de574619ac0b0af5cc6
 SHA512:
-  metadata.gz: a2c069495f203d33f17104158b10f205c97e54b94ef7abf5a60b1b8e84c53388f5adb11ef814ceed65b63fce2754b9a2616f913a778bf75e2a2bfb7e9680608e
-  data.tar.gz: a9894ef70649c9b0d933470c2447757f87170f0852b573256cb484710092ed76575237d46d80dcf8f2167a759c1256657d7ef41becbd346a7ec866d52b4e21bd
+  metadata.gz: a223e47afb796eb24c1cba0ff1cb8d50d3a695f1586f2805703050692631076fd98392a024b30c701ff246c8184a5ad2f19a6c747cffcd3f2d6a1d9ac74fd85d
+  data.tar.gz: 879e546638600315f1dcb2bf3dbc45cd82f08d4f8ae7fa7949be49d26a50abe956571c711bb696adfc5a0a15ff8ae708350e5c5b5e85a25964aed9242aa8da24

data/lib/messagebird.rb

@@ -2,8 +2,7 @@ libdir = File.dirname(__FILE__)
 $:.unshift(libdir) unless $:.include?(libdir)
 
 module MessageBird
-  CLIENT_VERSION = '1.4.1'
-  ENDPOINT       = 'https://rest.messagebird.com'
+  CLIENT_VERSION          = '1.4.2'
 end
 
 require 'messagebird/balance'
@@ -14,6 +13,7 @@ require 'messagebird/group_reference'
 require 'messagebird/hlr'
 require 'messagebird/http_client'
 require 'messagebird/message_reference'
+require 'messagebird/signed_request'
 require 'messagebird/verify'
 require 'messagebird/message'
 require 'messagebird/voicemessage'

data/lib/messagebird/client.rb

@@ -4,6 +4,10 @@ require 'uri'
 
 require 'messagebird/balance'
 require 'messagebird/contact'
+require 'messagebird/conversation'
+require 'messagebird/conversation_client'
+require 'messagebird/conversation_message'
+require 'messagebird/conversation_webhook'
 require 'messagebird/error'
 require 'messagebird/group'
 require 'messagebird/hlr'
@@ -24,20 +28,28 @@ module MessageBird
   end
 
   class Client
-
-    attr_reader :access_key
-    attr_reader :http_client
+    attr_reader :access_key, :http_client, :conversation_client
 
     def initialize(access_key = nil, http_client = nil)
       @access_key = access_key || ENV['MESSAGEBIRD_ACCESS_KEY']
       @http_client = http_client || HttpClient.new(@access_key)
+      @conversation_client = http_client || ConversationClient.new(@access_key)
+    end
+
+    def conversation_request(method, path, params={})
+      response_body = @conversation_client.request(method, path, params)
+      return if response_body.nil? || response_body.empty?
+      parse_body(response_body)
     end
 
     def request(method, path, params={})
       response_body = @http_client.request(method, path, params)
       return if response_body.empty?
+      parse_body(response_body)
+    end
 
-      json = JSON.parse(response_body)
+    def parse_body(body)
+      json = JSON.parse(body)
 
       # If the request returned errors, create Error objects and raise.
       if json.has_key?('errors')
@@ -47,6 +59,79 @@ module MessageBird
       json
     end
 
+    ## Conversations
+    # Send a conversation message
+    def send_conversation_message(from, to, params={})
+      ConversationMessage.new(conversation_request(
+        :post,
+        'send', 
+        params.merge({
+          :from => from,
+          :to => to,
+        })))
+    end
+
+    # Start a conversation
+    def start_conversation(to, channelId, params={})
+      Conversation.new(conversation_request(
+        :post,
+        'conversations/start',
+        params.merge({
+          :to => to,
+          :channelId => channelId,
+        })))
+    end
+
+    def conversation_list(limit = 0, offset = 0)
+      List.new(Conversation, conversation_request(:get, "conversations?limit=#{limit}&offset=#{offset}"))
+    end
+
+    def conversation(id)
+      Conversation.new(conversation_request(:get, "conversations/#{id}"))
+    end
+
+    def conversation_update(id, status)
+      Conversation.new(conversation_request(:patch, "conversations/#{id}", :status => status))
+    end
+    
+    def conversation_reply(id, params={})
+      ConversationMessage.new(conversation_request(:post, "conversations/#{id}/messages", params))
+    end
+    
+    def conversation_messages_list(id, limit=0, offset=0)
+      List.new(ConversationMessage, conversation_request(:get, "conversations/#{id}/messages?limit=#{limit}&offset=#{offset}"))
+    end
+    
+    def conversation_message(id)
+      ConversationMessage.new(conversation_request(:get, "messages/#{id}"))
+    end
+    
+    def conversation_webhook_create(channelId, url, events=[])
+      ConversationWebhook.new(conversation_request(
+        :post,
+        "webhooks",
+        :channelId => channelId,
+        :url => url,
+        :events => events
+      ))
+    end
+
+    def conversation_webhooks_list(limit=0, offset=0)
+      List.new(ConversationWebhook, conversation_request(:get,"webhooks?limit=#{limit}&offset=#{offset}"))
+    end
+
+    def conversation_webhook_update(id, params={})
+      ConversationWebhook.new(conversation_request(:patch,"webhooks/#{id}",params))
+    end
+
+    def conversation_webhook(id)
+      ConversationWebhook.new(conversation_request(:get,"webhooks/#{id}"))
+    end
+
+    def conversation_webhook_delete(id)
+      conversation_request(:delete,"webhooks/#{id}")
+    end
+
     # Retrieve your balance.
     def balance
       Balance.new(request(:get, 'balance'))

data/lib/messagebird/contact.rb

@@ -5,8 +5,8 @@ require 'messagebird/message_reference'
 
 module MessageBird
   class Contact < MessageBird::Base
-    attr_accessor :id, :href, :msisdn, :firstName, :lastName, :customDetails,
-                  :groups, :messages, :createdDatetime, :updatedDatetime
+    attr_accessor :id, :href, :msisdn, :firstName, :lastName
+    attr_reader :customDetails, :groups, :messages, :createdDatetime, :updatedDatetime
 
     def customDetails=(value)
       @customDetails = MessageBird::CustomDetails.new(value)
@@ -28,4 +28,4 @@ module MessageBird
       @updatedDatetime = value_to_time(value)
     end
   end
-end
+end

data/lib/messagebird/conversation.rb

@@ -0,0 +1,42 @@
+require 'messagebird/base'
+require 'messagebird/contact'
+require 'messagebird/conversation_channel'
+
+module MessageBird 
+  class Conversation < MessageBird::Base
+    attr_accessor :id, :status, :lastUsedChannelId, :contactId
+    attr_reader :contact, :channels, :messages, :createdDatetime,
+                :updatedDatetime, :lastReceivedDatetime
+
+    CONVERSATION_STATUS_ACTIVE = 'active'
+    CONVERSATION_STATUS_ARCHIVED = 'archived'
+    WEBHOOK_EVENT_CONVERSATION_CREATED = 'conversation.created'
+    WEBHOOK_EVENT_CONVERSATION_UPDATED = 'conversation.updated'
+    WEBHOOK_EVENT_MESSAGE_CREATED = 'message.created'
+    WEBHOOK_EVENT_MESSAGE_UPDATED = 'message.updated'
+
+    def contact=(value)
+      @contact = Contact.new(value)
+    end
+
+    def channels=(json)
+      @channels = json.map { |c| MessageBird::ConversationChannel.new(c) }
+    end
+
+    def messages=(value)
+      @messages = MessageBird::MessageReference.new(value) 
+    end
+   
+    def createdDatetime=(value)
+      @createdDatetime = value_to_time(value)
+    end
+
+    def updatedDatetime=(value)
+      @updatedDatetime = value_to_time(value)
+    end
+
+    def lastReceivedDatetime=(value)
+      @lastReceivedDatetime = value_to_time(value)
+    end
+  end 
+end 

data/lib/messagebird/conversation_channel.rb

@@ -0,0 +1,17 @@
+require 'messagebird/base'
+
+module MessageBird
+  class ConversationChannel < MessageBird::Base
+    attr_accessor :id, :name, :platformId, :status
+    attr_reader :createdDatetime, :updatedDatetime
+
+    def createdDatetime=(value)
+      @createdDatetime = value_to_time(value)
+    end
+
+    def updatedDatetime=(value)
+      @updatedDatetime = value_to_time(value)
+    end
+
+  end
+end

data/lib/messagebird/conversation_client.rb

@@ -0,0 +1,19 @@
+require 'net/https'
+require 'uri'
+require 'json'
+require 'messagebird/http_client'
+
+module MessageBird
+  class ConversationClient < HttpClient
+    ENDPOINT  = 'https://conversations.messagebird.com/v1/'
+
+    def endpoint() 
+      ENDPOINT
+    end
+
+    def prepare_request(request, params={})
+      request.body = params.to_json
+      request
+    end
+  end
+end

data/lib/messagebird/conversation_message.rb

@@ -0,0 +1,9 @@
+require 'messagebird/base'
+
+module MessageBird 
+  class ConversationMessage < MessageBird::Base
+    attr_accessor :id, :conversationId, :channelId, :direction, :status,
+                  :type, :content, :createdDatetime, :updatedDatetime, :fallback
+
+  end
+end 

data/lib/messagebird/conversation_webhook.rb

@@ -0,0 +1,7 @@
+require 'messagebird/base'
+
+module MessageBird 
+  class ConversationWebhook < MessageBird::Base
+    attr_accessor :id, :events, :channelId, :url, :status, :createdDatetime, :updatedDatetime
+  end
+end

data/lib/messagebird/group.rb

@@ -3,8 +3,8 @@ require 'messagebird/contact_reference'
 
 module MessageBird
   class Group < MessageBird::Base
-    attr_accessor :id, :href, :name, :contacts, :createdDatetime,
-                  :updatedDatetime
+    attr_accessor :id, :href, :name
+    attr_reader :contacts, :createdDatetime, :updatedDatetime
 
     def contacts=(value)
       @contacts = MessageBird::ContactReference.new(value)
@@ -18,4 +18,4 @@ module MessageBird
       @updatedDatetime = value_to_time(value)
     end
   end
-end
+end

data/lib/messagebird/hlr.rb

@@ -4,8 +4,8 @@ require 'messagebird/base'
 
 module MessageBird
   class HLR < MessageBird::Base
-    attr_accessor :id, :href, :msisdn, :network, :reference, :status, 
-                  :details, :createdDatetime, :statusDatetime
+    attr_accessor :id, :href, :msisdn, :network, :reference, :status, :details
+    attr_reader :createdDatetime, :statusDatetime
 
     def createdDatetime=(value)
       @createdDatetime = value_to_time(value)

data/lib/messagebird/http_client.rb

@@ -8,21 +8,30 @@ module MessageBird
   class MethodNotAllowedException < ArgumentError; end
 
   class HttpClient
-
     attr_reader :access_key
 
+    ENDPOINT = 'https://rest.messagebird.com/'
+
     def initialize(access_key)
       @access_key = access_key
     end
 
+    def endpoint()
+      ENDPOINT
+    end
+
     def request(method, path, params={}, check_json=true)
-      uri = URI.join(ENDPOINT, '/', path)
+      uri = URI.join(endpoint, path)
 
       # Set up the HTTP object.
       http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl     = true
+      http.use_ssl = true
+
+      unless ENV['DEBUG_MB_HTTP_CLIENT'].nil?
+        http.set_debug_output($stdout)
+      end 
 
-      request = prepare_request(method, uri, params)
+      request = build_request(method, uri, params)
 
       # Execute the request and fetch the response.
       response = http.request(request)
@@ -33,7 +42,12 @@ module MessageBird
       response.body
     end
 
-    def prepare_request(method, uri, params={})
+    def prepare_request(request, params={})
+      request.set_form_data(params) 
+      request
+    end
+
+    def build_request(method, uri, params={})
       # Construct the HTTP request.
       case method
       when :delete
@@ -52,8 +66,9 @@ module MessageBird
       request['Authorization'] = "AccessKey #{@access_key}"
       request['User-Agent']    = "MessageBird/ApiClient/#{CLIENT_VERSION} Ruby/#{RUBY_VERSION}"
 
-      request.set_form_data(params) if [:patch, :post].include?(method) && !params.empty?
-
+      if [:patch, :post].include?(method) && !params.empty?
+        prepare_request(request, params)
+      end
       request
     end
 
@@ -63,7 +78,7 @@ module MessageBird
       # InvalidPhoneNumberException does not make a lot of sense here, but it's
       # needed to maintain backwards compatibility. See issue:
       # https://github.com/messagebird/ruby-rest-api/issues/17
-      expected_codes = [200, 201, 204, 401, 404, 405, 422]
+      expected_codes = [200, 201, 202, 204, 401, 404, 405, 422]
       raise InvalidPhoneNumberException, 'Unknown response from server' unless expected_codes.include? code
     end
 
@@ -77,4 +92,4 @@ module MessageBird
 
   end
 
-end
+end

data/lib/messagebird/list.rb

@@ -1,7 +1,6 @@
 require 'messagebird/base'
 
 class List < MessageBird::Base
-
   attr_accessor :offset, :limit, :count, :totalCount, :links, :items
 
   # type will be used to create objects for the items, e.g.
@@ -20,4 +19,4 @@ class List < MessageBird::Base
     @items[index]
   end
 
-end
+end

data/lib/messagebird/message.rb

@@ -3,9 +3,9 @@ require 'messagebird/recipient'
 
 module MessageBird
   class Message < MessageBird::Base
-    attr_accessor :id, :href, :direction, :type, :originator, :body,
-                  :reference, :validity, :gateway, :typeDetails, :datacoding,
-                  :mclass, :scheduledDatetime, :createdDatetime, :recipients
+    attr_accessor :id, :href, :direction, :type, :originator, :body, :reference,
+                  :validity, :gateway, :typeDetails, :datacoding, :mclass
+    attr_reader :scheduledDatetime, :createdDatetime, :recipients
 
     def scheduledDatetime=(value)
       @scheduledDatetime = value_to_time(value)

data/lib/messagebird/recipient.rb

@@ -2,7 +2,8 @@ require 'messagebird/base'
 
 module MessageBird
   class Recipient < MessageBird::Base
-    attr_accessor :recipient, :status, :statusDatetime
+    attr_accessor :recipient, :status
+    attr_reader :statusDatetime
 
     def statusDatetime=(value)
       @statusDatetime = value_to_time(value)

data/lib/messagebird/signed_request.rb

@@ -0,0 +1,47 @@
+require 'base64'
+require 'digest'
+require 'time'
+
+module MessageBird
+  class ValidationException < TypeError;
+  end
+
+  class SignedRequest
+    def initialize(queryParameters, signature, requestTimestamp, body)
+
+      if !queryParameters.is_a? Hash
+        raise ValidationException, 'The "queryParameters" value is invalid.'
+      end
+      if !signature.is_a? String
+        raise ValidationException, 'The "signature" value is invalid.'
+      end
+      if !requestTimestamp.is_a? Integer
+        raise ValidationException, 'The "requestTimestamp" value is invalid.'
+      end
+      if !body.is_a? String
+        raise ValidationException, 'The "body" value is invalid.'
+      end
+
+      @queryParameters, @signature, @requestTimestamp, @body = queryParameters, signature, requestTimestamp, body
+    end
+
+    def verify(signingKey)
+      calculatedSignature = OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'), signingKey, buildPayload)
+      expectedSignature = Base64.decode64(@signature)
+      calculatedSignature.bytes == expectedSignature.bytes
+    end
+
+    def buildPayload
+      parts = []
+      parts.push(@requestTimestamp)
+      parts.push(URI.encode_www_form(@queryParameters.sort))
+      parts.push(Digest::SHA256.new.digest @body)
+      parts.join("\n")
+    end
+
+    def isRecent(offset = 10)
+      (Time.now.getutc.to_i - @requestTimestamp) < offset;
+    end
+
+  end
+end

data/lib/messagebird/verify.rb

@@ -4,8 +4,8 @@ require 'messagebird/base'
 
 module MessageBird
   class Verify < MessageBird::Base
-    attr_accessor :id, :recipient, :reference, :status, :href,
-                  :createdDatetime, :validUntilDatetime
+    attr_accessor :id, :recipient, :reference, :status, :href
+    attr_reader :createdDatetime, :validUntilDatetime
 
     def createdDatetime=(value)
       @createdDatetime = value_to_time(value)

data/lib/messagebird/voicemessage.rb

@@ -3,9 +3,8 @@ require 'messagebird/recipient'
 
 module MessageBird
   class VoiceMessage < MessageBird::Base
-    attr_accessor :id, :href, :originator, :body, :reference, :language, :voice, :repeat,
-                  :ifMachine, :scheduledDatetime, :createdDatetime, :recipients
-
+    attr_accessor :id, :href, :originator, :body, :reference, :language, :voice, :repeat, :ifMachine
+    attr_reader :scheduledDatetime, :createdDatetime, :recipients
 
     def scheduledDatetime=(value)
       @scheduledDatetime = value_to_time(value)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: messagebird-rest
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.2
 platform: ruby
 authors:
 - Maurice Nonnekes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-16 00:00:00.000000000 Z
+date: 2019-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -38,6 +38,11 @@ files:
 - lib/messagebird/client.rb
 - lib/messagebird/contact.rb
 - lib/messagebird/contact_reference.rb
+- lib/messagebird/conversation.rb
+- lib/messagebird/conversation_channel.rb
+- lib/messagebird/conversation_client.rb
+- lib/messagebird/conversation_message.rb
+- lib/messagebird/conversation_webhook.rb
 - lib/messagebird/custom_details.rb
 - lib/messagebird/error.rb
 - lib/messagebird/group.rb
@@ -49,6 +54,7 @@ files:
 - lib/messagebird/message.rb
 - lib/messagebird/message_reference.rb
 - lib/messagebird/recipient.rb
+- lib/messagebird/signed_request.rb
 - lib/messagebird/verify.rb
 - lib/messagebird/voicemessage.rb
 homepage: https://github.com/messagebird/ruby-rest-api