nexmo 5.9.0 → 6.0.0

data/lib/nexmo/conversations.rb

@@ -28,7 +28,7 @@ module Nexmo
     # @option params [Hash] :properties
     #   - **:ttl** (Integer) After how many seconds an empty conversation is deleted
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/conversation#createConversation
     #
@@ -58,7 +58,7 @@ module Nexmo
     #
     # @param [Hash, nil] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/conversation#replaceConversation
     #
@@ -73,7 +73,7 @@ module Nexmo
     #
     # @param [String] id
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/conversation#retrieveConversation
     #
@@ -105,7 +105,7 @@ module Nexmo
     # @param [String] id
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/conversation#replaceConversation
     #
@@ -120,7 +120,7 @@ module Nexmo
     #
     # @param [String] id
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/conversation#deleteConversation
     #
@@ -128,28 +128,59 @@ module Nexmo
       request('/beta/conversations/' + id, type: Delete)
     end
 
-    # @return [ConversationEvents]
+    # Record a conversation.
+    #
+    # @example
+    #   response = client.conversations.record(id, action: 'start')
+    #
+    # @option params [String] :action
+    #   Recording action. Must be one of `start` or `stop`.
+    #
+    # @option params [String] :event_url
+    #   The webhook endpoint where recording progress events are sent to.
+    #
+    # @option params [String] :event_method
+    #   The HTTP method used to send event information to **:event_url**.
+    #
+    # @option params [String] :split
+    #   Record the sent and received audio in separate channels of a stereo recording.
+    #
+    # @option params [String] :format
+    #   Record the conversation in a specific format.
+    #
+    # @param [String] id
+    # @param [Hash] params
+    #
+    # @return [Response]
+    #
+    # @see https://developer.nexmo.com/api/conversation#recordConversation
+    #
+    def record(id, params)
+      request('/beta/conversations/' + id + '/record', params: params, type: Put)
+    end
+
+    # @return [Events]
     #
     def events
-      @events ||= ConversationEvents.new(@client)
+      @events ||= Events.new(@config)
     end
 
-    # @return [ConversationLegs]
+    # @return [Legs]
     #
     def legs
-      @legs ||= ConversationLegs.new(@client)
+      @legs ||= Legs.new(@config)
     end
 
-    # @return [ConversationMembers]
+    # @return [Members]
     #
     def members
-      @members ||= ConversationMembers.new(@client)
+      @members ||= Members.new(@config)
     end
 
-    # @return [ConversationUsers]
+    # @return [Users]
     #
     def users
-      @users ||= ConversationUsers.new(@client)
+      @users ||= Users.new(@config)
     end
   end
 end

data/lib/nexmo/{conversation_events.rb → conversations/events.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Nexmo
-  class ConversationEvents < Namespace
+  class Conversations::Events < Namespace
     self.authentication = BearerToken
 
     self.request_body = JSON
@@ -23,7 +23,7 @@ module Nexmo
     # @param [String] conversation_id
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/conversation#createEvent
     #
@@ -35,7 +35,7 @@ module Nexmo
     #
     # @param [String] conversation_id
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/conversation#getEvents
     #
@@ -48,7 +48,7 @@ module Nexmo
     # @param [String] conversation_id
     # @param [String] event_id
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/conversation#getEvent
     #
@@ -61,7 +61,7 @@ module Nexmo
     # @param [String] conversation_id
     # @param [String] event_id
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/conversation#deleteEvent
     #

data/lib/nexmo/{conversation_legs.rb → conversations/legs.rb}

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 module Nexmo
-  class ConversationLegs < Namespace
+  class Conversations::Legs < Namespace
     self.authentication = BearerToken
 
     # List legs.
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/conversation#listLegs
     #
@@ -18,7 +18,7 @@ module Nexmo
     #
     # @param [String] leg_id
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/conversation#deleteLeg
     #

data/lib/nexmo/{conversation_members.rb → conversations/members.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Nexmo
-  class ConversationMembers < Namespace
+  class Conversations::Members < Namespace
     self.authentication = BearerToken
 
     self.request_body = JSON
@@ -34,7 +34,7 @@ module Nexmo
     # @param [String] conversation_id
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/conversation#createMember
     #
@@ -46,7 +46,7 @@ module Nexmo
     #
     # @param [String] conversation_id
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/conversation#getMembers
     #
@@ -59,7 +59,7 @@ module Nexmo
     # @param [String] conversation_id
     # @param [String] member_id
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/conversation#getMember
     #
@@ -79,7 +79,7 @@ module Nexmo
     # @param [String] member_id
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/conversation#updateMember
     #
@@ -92,7 +92,7 @@ module Nexmo
     # @param [String] conversation_id
     # @param [String] member_id
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/conversation#deleteMember
     #

data/lib/nexmo/{conversation_users.rb → conversations/users.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Nexmo
-  class ConversationUsers < Namespace
+  class Conversations::Users < Namespace
     self.authentication = BearerToken
 
     self.request_body = JSON
@@ -20,7 +20,7 @@ module Nexmo
     #
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/conversation#createUser
     #
@@ -30,7 +30,7 @@ module Nexmo
 
     # List users.
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/conversation#getUsers
     #
@@ -42,7 +42,7 @@ module Nexmo
     #
     # @param [String] id
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/conversation#getUser
     #
@@ -69,7 +69,7 @@ module Nexmo
     # @param [String] id
     # @param [Hash] params
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/conversation#updateUser
     #
@@ -81,7 +81,7 @@ module Nexmo
     #
     # @param [String] id
     #
-    # @return [Entity]
+    # @return [Response]
     #
     # @see https://developer.nexmo.com/api/conversation#deleteUser
     #

data/lib/nexmo/entity.rb

@@ -6,6 +6,10 @@ module Nexmo
       @attributes = kwargs
     end
 
+    def [](key)
+      @attributes[attribute_key(key)]
+    end
+
     def []=(key, value)
       @attributes[attribute_key(key)] = value
     end
@@ -31,5 +35,15 @@ module Nexmo
     attr_reader :attributes
 
     protected :attributes
+
+    def each_pair(&block)
+      return to_enum(:each_pair) unless block
+
+      @attributes.each_pair(&block)
+    end
+
+    alias_method :each, :each_pair
+
+    include Enumerable
   end
 end

data/lib/nexmo/files.rb

@@ -5,8 +5,7 @@ module Nexmo
     self.authentication = BearerToken
 
     def get(id)
-      response = request('/v1/files/' + id.split('/').last)
-      response.body
+      request('/v1/files/' + id.split('/').last)
     end
 
     def save(id, filename)

data/lib/nexmo/gsm7.rb

@@ -0,0 +1,13 @@
+module Nexmo
+  module GSM7
+    CHARACTERS = "\n\f\r !\"\#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_abcdefghijklmnopqrstuvwxyz{|}~ ¡£¤¥§¿ÄÅÆÉÑÖØÜßàäåæçèéìñòöøùüΓΔΘΛΞΠΣΦΨΩ€"
+
+    REGEXP = /\A[#{Regexp.escape(CHARACTERS)}]*\z/
+
+    def self.encoded?(string)
+      REGEXP =~ string
+    end
+  end
+
+  private_constant :GSM7
+end

data/lib/nexmo/{authentication/key_secret_params.rb → key_secret_params.rb}

@@ -3,8 +3,8 @@ module Nexmo
     def update(object)
       return unless object.is_a?(Hash)
 
-      object[:api_key] = @client.api_key
-      object[:api_secret] = @client.api_secret
+      object[:api_key] = @config.api_key
+      object[:api_secret] = @config.api_secret
     end
   end
 

data/lib/nexmo/{authentication/key_secret_query.rb → key_secret_query.rb}

@@ -10,8 +10,8 @@ module Nexmo
 
     def params
       {
-        api_key: @client.api_key,
-        api_secret: @client.api_secret
+        api_key: @config.api_key,
+        api_secret: @config.api_secret
       }
     end
   end

data/lib/nexmo/keys.rb

@@ -2,30 +2,12 @@
 
 module Nexmo
   module Keys
-    if {}.respond_to?(:transform_keys)
-      def hyphenate(hash)
-        hash.transform_keys { |k| hyphenate_key(k) }
-      end
-
-      def camelcase(hash)
-        hash.transform_keys { |k| camelcase_key(k) }
-      end
-    else
-      def hyphenate(hash)
-        hash.each_with_object({}) { |(k, v), h| h[hyphenate_key(k)] = v }
-      end
-
-      def camelcase(hash)
-        hash.each_with_object({}) { |(k, v), h| h[camelcase_key(k)] = v }
-      end
+    def hyphenate(hash)
+      hash.transform_keys { |k| k.to_s.tr('_', '-') }
     end
 
-    def hyphenate_key(k)
-      k.to_s.tr('_', '-')
-    end
-
-    def camelcase_key(k)
-      k.to_s.gsub(/_(\w)/) { $1.upcase }
+    def camelcase(hash)
+      hash.transform_keys { |k| k.to_s.gsub(/_(\w)/) { $1.upcase } }
     end
 
     ATTRIBUTE_KEYS = Hash.new { |h, k| h[k] = k.split(PATTERN).join('_').downcase.to_sym }

data/lib/nexmo/namespace.rb

@@ -4,17 +4,17 @@ require 'json'
 
 module Nexmo
   class Namespace
-    def initialize(client)
-      @client = client
+    def initialize(config)
+      @config = config
 
-      @logger = client.logger
+      @logger = config.logger
 
       @host = self.class.host
 
       @http = Net::HTTP.new(@host, Net::HTTP.https_default_port, p_addr = nil)
       @http.use_ssl = true
 
-      @client.http_options.set(@http)
+      @config.http.set(@http) unless @config.http.nil?
     end
 
     def self.host
@@ -45,6 +45,14 @@ module Nexmo
       @request_headers ||= {}
     end
 
+    def self.response_class
+      @response_class ||= Response
+    end
+
+    def self.response_class=(response_class)
+      @response_class = response_class
+    end
+
     private
 
     Get = Net::HTTP::Get
@@ -52,12 +60,12 @@ module Nexmo
     Post = Net::HTTP::Post
     Delete = Net::HTTP::Delete
 
-    def request(path, params: nil, type: Get, &block)
+    def request(path, params: nil, type: Get, response_class: nil, &block)
       uri = URI('https://' + @host + path)
 
       params ||= {}
 
-      authentication = self.class.authentication.new(@client)
+      authentication = self.class.authentication.new(@config)
       authentication.update(params)
 
       unless type::REQUEST_HAS_BODY || params.empty?
@@ -68,7 +76,7 @@ module Nexmo
 
       message = type.new(uri)
 
-      message['User-Agent'] = @client.user_agent
+      message['User-Agent'] = UserAgent.string(@config.app_name, @config.app_version)
 
       self.class.request_headers.each do |key, value|
         message[key] = value
@@ -88,18 +96,20 @@ module Nexmo
 
       @logger.debug(response.body) if response.body
 
-      parse(response)
+      parse(response, response_class || self.class.response_class)
     end
 
-    def parse(response)
+    def parse(response, response_class)
       case response
       when Net::HTTPNoContent
-        :no_content
+        response_class.new(nil, response)
       when Net::HTTPSuccess
         if response['Content-Type'].split(';').first == 'application/json'
-          ::JSON.parse(response.body, object_class: Nexmo::Entity)
+          entity = ::JSON.parse(response.body, object_class: Nexmo::Entity)
+
+          response_class.new(entity, response)
         else
-          response
+          response_class.new(nil, response)
         end
       else
         raise Errors.parse(response)