messagebird-rest 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9dc78fcfe4e496c197244a6e62ad347bc439c52334d69a453f25977f7981c23b
-  data.tar.gz: 6cef4d63e95ddd4455dd4a003b60bdfc3dfb1b10cfc1049cee9aecc7d8d5fb41
+  metadata.gz: 7f7b235894410103a5ae0cddb620fb84e1e713c022a8f974ab54d114d69fe1d0
+  data.tar.gz: 95411be3e97854eb9696c0b2f24092fdbd0f41deab6949be4656566312520e01
 SHA512:
-  metadata.gz: f235d92c2c49b14c7529c3aa2ad5e8fb6e03adf66a74f4d55229b1b262c66d8beca1a9137ff1d24da439a8d9051915765c7371e17fc1eae63bc0e56e8b96f715
-  data.tar.gz: 4b264d192ab011f784aedd9f336e750a1d20b9413d6cb9fd2e67d37cef6b36f7ceed25b80d6dbb74e90b4ffb452f90939b3343a732d2043138071a2b15f6260e
+  metadata.gz: 13e721d025a6e85b5f503770fe04a09a60048358ca9c76556a42903a7d59134f9290b2b736a6504bbfab559997bd29d53c8fd76b74b861544dd80d7de3d502d3
+  data.tar.gz: 26762318e8db116c1ddff86d49b64434328b0569815ab84f247c255978d7e60773e0d87f6ab589441bbcd1ab4460815734b1c42944b4425dbc998a7d11da6f23

data/README.md

@@ -2,7 +2,7 @@ MessageBird's REST API for Ruby
 ===============================
 This repository contains the open source Ruby client for MessageBird's REST API. Documentation can be found at: https://developers.messagebird.com/
 
-[![Build Status](https://travis-ci.org/messagebird/ruby-rest-api.svg?branch=master)](https://travis-ci.org/messagebird/ruby-rest-api)
+[![Build Status](https://github.com/messagebird/ruby-rest-api/actions/workflows/ruby_ci.yml/badge.svg)](https://github.com/messagebird/ruby-rest-api/actions)
 
 Requirements
 ------------

data/lib/messagebird/base.rb

@@ -7,6 +7,8 @@ module MessageBird
   class Base
     # takes each element from the given hash and apply it to ourselves through an assignment method
     def map_hash_elements_to_self(hash)
+      return if hash.nil?
+
       hash.each do |key, value|
         method_name = key.gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase # convert came case to snake case
         method_name += '='

data/lib/messagebird/callflow.rb

@@ -26,7 +26,8 @@ module MessageBird
   end
 
   class CallFlowList < List
-    attr_accessor :perPage, :currentPage, :pageCount, :totalCount
+    attr_accessor :per_page, :current_page, :page_count, :total_count
+
     PER_PAGE = 20
     CURRENT_PAGE = 1
 
@@ -53,8 +54,8 @@ module MessageBird
 
   class CallFlowStepOption < MessageBird::Base
     attr_accessor :destination, :payload, :language, :voice, :repeat,
-                  :media, :length, :maxLength, :timeout, :finishOnKey, :transcribe,
-                  :transcribeLanguage, :record, :url, :ifMachine, :machineTimeout,
-                  :onFinish, :mask
+                  :media, :length, :max_length, :timeout, :finish_on_key, :transcribe,
+                  :transcribe_language, :record, :url, :if_machine, :machine_timeout,
+                  :on_finish, :mask
   end
 end

data/lib/messagebird/client.rb

@@ -30,14 +30,16 @@ require 'messagebird/voice/call'
 require 'messagebird/voice/call_leg'
 require 'messagebird/voice/call_leg_recording'
 require 'messagebird/voice/transcription'
-require 'messagebird/voice/list'
 
 module MessageBird
   class ErrorException < StandardError
     attr_reader :errors
 
     def initialize(errors)
+      super()
       @errors = errors
+      message = errors.map(&:message).join(', ')
+      super(message)
     end
   end
 
@@ -47,7 +49,8 @@ module MessageBird
   class Client
     attr_reader :access_key, :http_client, :conversation_client, :voice_client
 
-    def initialize(access_key = nil, http_client = nil, conversation_client = nil, voice_client = nil)
+    def initialize(access_key = nil, http_client = nil, conversation_client = nil, voice_client = nil) # rubocop:disable Metrics/ParameterLists
+      super()
       @access_key = access_key || ENV['MESSAGEBIRD_ACCESS_KEY']
       @http_client = http_client || HttpClient.new(@access_key)
       @conversation_client = conversation_client || ConversationClient.new(@access_key)
@@ -490,7 +493,7 @@ module MessageBird
       # JSON by default. See also:
       # https://developers.messagebird.com/docs/alternatives.
 
-      '_method=PUT&' + contact_ids.map { |id| "ids[]=#{id}" }.join('&')
+      contact_ids.map { |id| "ids[]=#{id}" }.join('&').prepend('_method=PUT&')
     end
 
     def add_querystring(path, params)

data/lib/messagebird/conversation_client.rb

@@ -14,9 +14,9 @@ module MessageBird
       request.body = params.to_json
       request
     end
-  end
 
-  def endpoint
-    ENDPOINT
+    def endpoint
+      ENDPOINT
+    end
   end
 end

data/lib/messagebird/error.rb

@@ -5,5 +5,13 @@ require 'messagebird/base'
 module MessageBird
   class Error < MessageBird::Base
     attr_accessor :code, :description, :parameter
+
+    def message
+      if parameter
+        "#{description} (error code: #{code}, parameter: #{parameter})"
+      else
+        "#{description} (error code: #{code})"
+      end
+    end
   end
 end

data/lib/messagebird/http_client.rb

@@ -33,7 +33,7 @@ module MessageBird
       http
     end
 
-    def request(method, path, params = {}, check_json = true)
+    def request(method, path, params = {}, check_json: true)
       uri     = URI.join(endpoint, path)
       http    = build_http_client(uri)
       request = build_request(method, uri, params)

data/lib/messagebird/list.rb

@@ -2,23 +2,25 @@
 
 require 'messagebird/base'
 
-class List < MessageBird::Base
-  attr_accessor :offset, :limit, :count, :total_count, :links
-  attr_reader :items
+module MessageBird
+  class List < MessageBird::Base
+    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, {}).
-  def initialize(type, json)
-    @type = type
+    # type will be used to create objects for the items, e.g.
+    # List.new(Contact, {}).
+    def initialize(type, json)
+      @type = type
 
-    super(json)
-  end
+      super(json)
+    end
 
-  def items=(value)
-    @items = value.map { |i| @type.new i }
-  end
+    def items=(value)
+      @items = value.map { |i| @type.new i }
+    end
 
-  def [](index)
-    @items[index]
+    def [](index)
+      @items[index]
+    end
   end
 end

data/lib/messagebird/message.rb

@@ -6,7 +6,7 @@ require 'messagebird/recipient'
 module MessageBird
   class Message < MessageBird::Base
     attr_accessor :id, :href, :direction, :type, :originator, :body, :reference,
-                  :validity, :gateway, :typeDetails, :datacoding, :mclass
+                  :validity, :gateway, :type_details, :datacoding, :mclass
     attr_reader :scheduled_date_time, :created_datetime, :recipients
 
     def scheduled_date_time=(value)

data/lib/messagebird/request_validator.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'digest'
+require 'time'
+require 'jwt'
+
+module MessageBird
+  class ValidationError < StandardError
+  end
+
+  ##
+  # RequestValidator validates request signature signed by MessageBird services.
+  #
+  # @see https://developers.messagebird.com/docs/verify-http-requests
+  class RequestValidator
+    ALLOWED_ALGOS = %w[HS256 HS384 HS512].freeze
+
+    ##
+    #
+    # @param [string] signature_key customer signature key. Can be retrieved through <a href="https://dashboard.messagebird.com/developers/settings">Developer Settings</a>. This is NOT your API key.
+    # @param [bool] skip_url_validation whether url_hash claim validation should be skipped. Note that when true, no query parameters should be trusted.
+    def initialize(signature_key, skip_url_validation: false)
+      @signature_key = signature_key
+      @skip_url_validation = skip_url_validation
+    end
+
+    ##
+    # This method validates provided request signature, which is a JWT token.
+    # This JWT is signed with a MessageBird account unique secret key, ensuring the request is from MessageBird and a specific account.
+    # The JWT contains the following claims:
+    #      *   "url_hash" - the raw URL hashed with SHA256 ensuring the URL wasn't altered.
+    #      *    "payload_hash" - the raw payload hashed with SHA256 ensuring the payload wasn't altered.
+    #      *    "jti" - a unique token ID to implement an optional non-replay check (NOT validated by default).
+    #      *    "nbf" - the not before timestamp.
+    #      *    "exp" - the expiration timestamp is ensuring that a request isn't captured and used at a later time.
+    #      *    "iss" - the issuer name, always MessageBird.
+    # @param [String] signature the actual signature taken from request header "MessageBird-Signature-JWT".
+    # @param [String] url the raw url including the protocol, hostname and query string, e.g. "https://example.com/?example=42".
+    # @param [Array] request_body the raw request body.
+    # @return [Array] raw signature payload
+    # @raise [ValidationError] if signature is invalid
+    # @see https://developers.messagebird.com/docs/verify-http-requests
+    def validate_signature(signature, url, request_body)
+      raise ValidationError, 'Signature can not be empty' if signature.to_s.empty?
+      raise ValidationError, 'URL can not be empty' if !@skip_url_validation && url.to_s.empty?
+
+      claims = decode_signature signature
+      validate_url(url, claims['url_hash']) unless @skip_url_validation
+      validate_payload(request_body, claims['payload_hash'])
+
+      claims
+    end
+
+    private # Applies to every method below this line
+
+    def decode_signature(signature)
+      begin
+        claims, * = JWT.decode signature, @signature_key, true,
+                               algorithm: ALLOWED_ALGOS,
+                               iss: 'MessageBird',
+                               required_claims: %w[iss nbf exp],
+                               verify_iss: true,
+                               leeway: 1
+      rescue JWT::DecodeError => e
+        raise ValidationError, e
+      end
+
+      claims
+    end
+
+    def validate_url(url, url_hash)
+      expected_url_hash = Digest::SHA256.hexdigest url
+      unless JWT::SecurityUtils.secure_compare(expected_url_hash, url_hash)
+        raise ValidationError, 'invalid jwt: claim url_hash is invalid'
+      end
+    end
+
+    def validate_payload(body, payload_hash)
+      if !body.to_s.empty? && !payload_hash.to_s.empty?
+        unless JWT::SecurityUtils.secure_compare(Digest::SHA256.hexdigest(body), payload_hash)
+          raise ValidationError, 'invalid jwt: claim payload_hash is invalid'
+        end
+      elsif !body.to_s.empty?
+        raise ValidationError, 'invalid jwt: claim payload_hash is not set but payload is present'
+      elsif !payload_hash.to_s.empty?
+        raise ValidationError, 'invalid jwt: claim payload_hash is set but actual payload is missing'
+      end
+    end
+  end
+end

data/lib/messagebird/signed_request.rb

@@ -5,10 +5,16 @@ require 'digest'
 require 'time'
 
 module MessageBird
+  ##
+  # @deprecated Use {MessageBird::RequestValidator::ValidationError} instead.
   class ValidationException < TypeError
   end
 
+  ##
+  # @deprecated Use {MessageBird::RequestValidator} instead.
   class SignedRequest
+    ##
+    # @deprecated Use {MessageBird::RequestValidator} instead.
     def initialize(query_parameters, signature, request_timestamp, body)
       unless query_parameters.is_a? Hash
         raise ValidationException, 'The "query_parameters" value is invalid.'
@@ -29,12 +35,16 @@ module MessageBird
       @body = body
     end
 
+    ##
+    # @deprecated Use {MessageBird::RequestValidator::validateSignature} instead.
     def verify(signing_key)
       calculated_signature = OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'), signing_key, build_payload)
       expected_signature = Base64.decode64(@signature)
       calculated_signature.bytes == expected_signature.bytes
     end
 
+    ##
+    # @deprecated Use {MessageBird::RequestValidator} instead.
     def build_payload
       parts = []
       parts.push(@request_timestamp)
@@ -43,6 +53,8 @@ module MessageBird
       parts.join("\n")
     end
 
+    ##
+    # @deprecated Use {MessageBird::RequestValidator} instead.
     def recent?(offset = 10)
       (Time.now.getutc.to_i - @request_timestamp) < offset
     end

data/lib/messagebird/version.rb

@@ -2,6 +2,6 @@
 
 module MessageBird
   module Version
-    STRING = '3.0.0'
+    STRING = '4.0.0'
   end
 end

data/lib/messagebird/voice/call_leg_recording.rb

@@ -11,6 +11,7 @@ module MessageBird
 
       # further processed attributes for convenience
       attr_accessor :_links, :uri
+
       # Grab the URI to the downloadable file and provide it as a direct attribute
       def handle_links(links_object)
         @uri = links_object['file']

data/lib/messagebird/voice/list.rb

@@ -6,6 +6,7 @@ module MessageBird
   module Voice
     class List < List
       attr_accessor :per_page, :current_page, :page_count, :total_count
+
       PER_PAGE = 20
       CURRENT_PAGE = 1
       def data=(value)

data/lib/messagebird.rb

@@ -12,7 +12,8 @@ require 'messagebird/group_reference'
 require 'messagebird/hlr'
 require 'messagebird/http_client'
 require 'messagebird/message_reference'
-require 'messagebird/signed_request'
+require 'messagebird/signed_request' # @deprecated
+require 'messagebird/request_validator'
 require 'messagebird/verify'
 require 'messagebird/message'
 require 'messagebird/voicemessage'

metadata

@@ -1,57 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: messagebird-rest
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Maurice Nonnekes
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-25 00:00:00.000000000 Z
+date: 2022-04-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.11.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.77.0
+        version: 1.26.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.77.0
+        version: 1.26.1
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.5
+        version: 3.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.5
+        version: 3.14.0
 description: A simple REST API for MessageBird in Ruby
 email: maurice@messagebird.com
 executables: []
@@ -87,6 +101,7 @@ files:
 - lib/messagebird/number.rb
 - lib/messagebird/number_client.rb
 - lib/messagebird/recipient.rb
+- lib/messagebird/request_validator.rb
 - lib/messagebird/signed_request.rb
 - lib/messagebird/verify.rb
 - lib/messagebird/verify_email_message.rb
@@ -105,7 +120,7 @@ homepage: https://github.com/messagebird/ruby-rest-api
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -113,15 +128,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key:
+rubygems_version: 3.1.2
+signing_key: 
 specification_version: 4
 summary: MessageBird's REST API
 test_files: []