messagebird-rest 1.4.0 → 3.0.0

data/lib/messagebird/contact.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'messagebird/base'
 require 'messagebird/custom_details'
 require 'messagebird/group_reference'
@@ -5,11 +7,11 @@ 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, :first_name, :last_name
+    attr_reader :custom_details, :groups, :messages, :created_datetime, :updated_datetime
 
-    def customDetails=(value)
-      @customDetails = MessageBird::CustomDetails.new(value)
+    def custom_details=(value)
+      @custom_details = MessageBird::CustomDetails.new(value)
     end
 
     def groups=(value)
@@ -20,12 +22,12 @@ module MessageBird
       @messages = MessageBird::MessageReference.new(value)
     end
 
-    def createdDatetime=(value)
-      @createdDatetime = value_to_time(value)
+    def created_datetime=(value)
+      @created_datetime = value_to_time(value)
     end
 
-    def updatedDatetime=(value)
-      @updatedDatetime = value_to_time(value)
+    def updated_datetime=(value)
+      @updated_datetime = value_to_time(value)
     end
   end
-end
+end

data/lib/messagebird/contact_reference.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'messagebird/base'
 
 module MessageBird
   class ContactReference < MessageBird::Base
-    attr_accessor :href, :totalCount
+    attr_accessor :href, :total_count
   end
 end

data/lib/messagebird/conversation.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'messagebird/base'
+require 'messagebird/contact'
+require 'messagebird/conversation_channel'
+
+module MessageBird
+  class Conversation < MessageBird::Base
+    attr_accessor :id, :status, :last_used_channel_id, :contact_id
+    attr_reader :contact, :channels, :messages, :created_datetime,
+                :updated_datetime, :last_received_datetime
+
+    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 created_datetime=(value)
+      @created_datetime = value_to_time(value)
+    end
+
+    def updated_datetime=(value)
+      @updated_datetime = value_to_time(value)
+    end
+
+    def last_received_datetime=(value)
+      @last_received_datetime = value_to_time(value)
+    end
+  end
+end

data/lib/messagebird/conversation_channel.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'messagebird/base'
+
+module MessageBird
+  class ConversationChannel < MessageBird::Base
+    attr_accessor :id, :name, :platform_id, :status
+    attr_reader :created_datetime, :updated_datetime
+
+    def created_datetime=(value)
+      @created_datetime = value_to_time(value)
+    end
+
+    def updated_datetime=(value)
+      @updated_datetime = value_to_time(value)
+    end
+  end
+end

data/lib/messagebird/conversation_client.rb

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

data/lib/messagebird/conversation_message.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'messagebird/base'
+
+module MessageBird
+  class ConversationMessage < MessageBird::Base
+    attr_accessor :id, :conversation_id, :channel_id, :direction, :status,
+                  :type, :content, :created_datetime, :updated_datetime, :fallback
+  end
+end

data/lib/messagebird/conversation_webhook.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'messagebird/base'
+
+module MessageBird
+  class ConversationWebhook < MessageBird::Base
+    attr_accessor :id, :events, :channel_id, :url, :status, :created_datetime, :updated_datetime
+  end
+end

data/lib/messagebird/custom_details.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'messagebird/base'
 
 module MessageBird

data/lib/messagebird/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'messagebird/base'
 
 module MessageBird

data/lib/messagebird/group.rb

@@ -1,21 +1,23 @@
+# frozen_string_literal: true
+
 require 'messagebird/base'
 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, :created_datetime, :updated_datetime
 
     def contacts=(value)
       @contacts = MessageBird::ContactReference.new(value)
     end
 
-    def createdDatetime=(value)
-      @createdDatetime = value_to_time(value)
+    def created_datetime=(value)
+      @created_datetime = value_to_time(value)
     end
 
-    def updatedDatetime=(value)
-      @updatedDatetime = value_to_time(value)
+    def updated_datetime=(value)
+      @updated_datetime = value_to_time(value)
     end
   end
-end
+end

data/lib/messagebird/group_reference.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'messagebird/base'
 
 module MessageBird
   class GroupReference < MessageBird::Base
-    attr_accessor :href, :totalCount
+    attr_accessor :href, :total_count
   end
 end

data/lib/messagebird/hlr.rb

@@ -1,18 +1,20 @@
+# frozen_string_literal: true
+
 require 'time'
 
 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 :created_datetime, :status_datetime
 
-    def createdDatetime=(value)
-      @createdDatetime = value_to_time(value)
+    def created_datetime=(value)
+      @created_datetime = value_to_time(value)
     end
 
-    def statusDatetime=(value)
-      @statusDatetime = value_to_time(value)
+    def status_datetime=(value)
+      @status_datetime = value_to_time(value)
     end
   end
 end

data/lib/messagebird/http_client.rb

@@ -1,28 +1,42 @@
+# frozen_string_literal: true
+
 require 'net/https'
 require 'uri'
 
 module MessageBird
-
-  class InvalidPhoneNumberException < TypeError; end
+  class ServerException < StandardError; end
   class InvalidResponseException < StandardError; end
   class MethodNotAllowedException < ArgumentError; end
 
   class HttpClient
-
     attr_reader :access_key
 
+    VALID_RESPONSE_CODES = [200, 201, 202, 204, 401, 404, 405, 422].freeze
+    ENDPOINT = 'https://rest.messagebird.com/'
+    SUBMIT_METHODS = [:patch, :post, :put].freeze
+    ALLOWED_METHODS = SUBMIT_METHODS.dup + [:get, :delete].freeze
+
     def initialize(access_key)
       @access_key = access_key
     end
 
-    def request(method, path, params={}, check_json=true)
-      uri = URI.join(ENDPOINT, '/', path)
+    def endpoint
+      ENDPOINT
+    end
 
-      # Set up the HTTP object.
+    def build_http_client(uri)
       http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl     = true
+      http.use_ssl = true
 
-      request = prepare_request(method, uri, params)
+      http.set_debug_output($stdout) unless ENV['DEBUG_MB_HTTP_CLIENT'].nil?
+
+      http
+    end
+
+    def request(method, path, params = {}, check_json = true)
+      uri     = URI.join(endpoint, path)
+      http    = build_http_client(uri)
+      request = build_request(method, uri, params)
 
       # Execute the request and fetch the response.
       response = http.request(request)
@@ -33,24 +47,33 @@ module MessageBird
       response.body
     end
 
-    def prepare_request(method, uri, params={})
+    def request_block(method, path, params = {}, &block)
+      uri     = URI.join(endpoint, path)
+      http    = build_http_client(uri)
+      request = build_request(method, uri, params)
+
+      http.request(request, block)
+    end
+
+    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
-        request = Net::HTTP::Delete.new(uri.request_uri)
-      when :get
-        request = Net::HTTP::Get.new(uri.request_uri)
-      when :post
-        request = Net::HTTP::Post.new(uri.request_uri)
-      else
-        raise MethodNotAllowedException
-      end
+      raise MethodNotAllowedException unless ALLOWED_METHODS.include?(method)
+
+      request = Class.const_get("Net::HTTP::#{method.to_s.capitalize}").new(uri.request_uri)
 
       request['Accept']        = 'application/json'
       request['Authorization'] = "AccessKey #{@access_key}"
-      request['User-Agent']    = "MessageBird/ApiClient/#{CLIENT_VERSION} Ruby/#{RUBY_VERSION}"
+      request['User-Agent']    = "MessageBird/ApiClient/#{Version::STRING} Ruby/#{RUBY_VERSION}"
 
-      request.set_form_data(params) if method == :post && !params.empty?
+      if SUBMIT_METHODS.include?(method) && !params.empty?
+        prepare_request(request, params)
+      end
 
       request
     end
@@ -58,11 +81,7 @@ module MessageBird
     # Throw an exception if the response code is not one we expect from the
     # MessageBird API.
     def assert_valid_response_code(code)
-      # 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]
-      raise InvalidPhoneNumberException, 'Unknown response from server' unless expected_codes.include? code
+      raise ServerException, 'Unknown response from server' unless VALID_RESPONSE_CODES.include? code
     end
 
     # Throw an exception if the response's content type is not JSON. This only
@@ -72,7 +91,5 @@ module MessageBird
       # for equality: some API's may append the charset to this header.
       raise InvalidResponseException, 'Response is not JSON' unless content_type.start_with? 'application/json'
     end
-
   end
-
-end
+end

data/lib/messagebird/list.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'messagebird/base'
 
 class List < MessageBird::Base
-
-  attr_accessor :offset, :limit, :count, :totalCount, :links, :items
+  attr_accessor :offset, :limit, :count, :total_count, :links
+  attr_reader :items
 
   # type will be used to create objects for the items, e.g.
   # List.new(Contact, {}).
@@ -19,5 +21,4 @@ class List < MessageBird::Base
   def [](index)
     @items[index]
   end
-
-end
+end

data/lib/messagebird/lookup.rb

@@ -1,18 +1,20 @@
+# frozen_string_literal: true
+
 require 'time'
 
 require 'messagebird/base'
 
 module MessageBird
   class Lookup < MessageBird::Base
-    attr_accessor :href, :countryCode, :countryPrefix, :phoneNumber, :type
+    attr_accessor :href, :country_code, :country_prefix, :phone_number, :type
     attr_reader :formats, :hlr
 
-    def formats=(newFormats)
-      @formats = Formats.new(newFormats)
+    def formats=(new_formats)
+      @formats = Formats.new(new_formats)
     end
 
-    def hlr=(newHLR)
-      @hlr = HLR.new(newHLR)
+    def hlr=(new_hlr)
+      @hlr = HLR.new(new_hlr)
     end
   end
 

data/lib/messagebird/message.rb

@@ -1,18 +1,20 @@
+# frozen_string_literal: true
+
 require 'messagebird/base'
 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 :scheduled_date_time, :created_datetime, :recipients
 
-    def scheduledDatetime=(value)
-      @scheduledDatetime = value_to_time(value)
+    def scheduled_date_time=(value)
+      @scheduled_date_time = value_to_time(value)
     end
 
-    def createdDatetime=(value)
-      @createdDatetime = value_to_time(value)
+    def created_datetime=(value)
+      @created_datetime = value_to_time(value)
     end
 
     def recipients=(json)