messagebird-rest 3.1.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 377efa55fd0f725542290a4a79fac960bf918bdd8bd5cad01f17dccfacbc2dc1
-  data.tar.gz: 57616887a846b29fc83a21e3e28edc5abdb2eb54cfbbc2990389f7bb13b4dd43
+  metadata.gz: bb20303b6fdb4eb301b53bd6423e5f0398bd2f74037f53794bb91b09bb0da975
+  data.tar.gz: 201337fdad3472b79cd83fab56def8bcbd503b04a223e414ad4c9098bd5eaac6
 SHA512:
-  metadata.gz: 79eb3dd3fee60deb9ae97411fab95c0137ad55a9bf9daf39897be39c3b71fc5891b6618b0bd23719a1d5b8cf2c7dac223d63871ef0012ff4faabcc783ce4e4f7
-  data.tar.gz: a555a6c55b363ed6102768b803e9f884af7bd65e78dab3f41951253edf2127886f1ec690fb3709c243d0ae63aeed8adf57787cd63f79e23a64c709cda5f1a521
+  metadata.gz: fca6980452a534999802b252f07a88fac2b282087cbe40499c88a4b69370eea8172fda5fba0a3282c8dbceaad4857916a69ad2722872f6623a441d5ff5cddcf7
+  data.tar.gz: f0c5f96a9ab18e83291b4ed81758d6fb704b34e01d2c69f8135f77e216af6a00aed266c134b632386c13c976da823f0a8a2dccec71e1499e3e3655034a6d4715

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://github.com/messagebird/ruby-rest-api/actions/workflows/ruby_ci.yml/badge.svg)](https://github.com/messagebird/ruby-rest-api/actions)
+[![Build Status](https://github.com/messagebird/ruby-rest-api/actions/workflows/test.yml/badge.svg)](https://github.com/messagebird/ruby-rest-api/actions)
 
 Requirements
 ------------
@@ -15,10 +15,11 @@ Installation
 You can either include the following line in your Gemfile:
 
 ```ruby
-gem 'messagebird-rest', :require => 'messagebird'
+gem 'messagebird-rest', require: 'messagebird'
 ```
 
 Or you can just manually install it from the command line:
+
 ```sh
 $ gem install messagebird-rest
 ```
@@ -28,7 +29,7 @@ Examples
 We have put some self-explanatory examples in the *examples* directory, but here is a quick breakdown on how it works. First, you need to create an instance of **MessageBird::Client**. Be sure to replace **YOUR_ACCESS_KEY** with something real in the bottom example.
 
 ```ruby
-require 'pp'              # Only needed for this example
+require 'pp' # Only needed for this example
 require 'messagebird'
 
 client = MessageBird::Client.new(YOUR_ACCESS_KEY)
@@ -54,7 +55,7 @@ Chances are that the most common use you'll have for this API client is the abil
 Optional parameters can be specified as a hash.
 
 ```ruby
-pp client.message_create('FromMe', '31612345678', 'Hello World', :reference => 'MyReference')
+pp client.message_create('FromMe', '31612345678', 'Hello World', reference: 'MyReference')
 
 #<MessageBird::Message:0x007f8d5b883520
  @body="Hello World",
@@ -118,7 +119,7 @@ You can send and verify One-Time Passwords through the MessageBird API using the
 
 ```ruby
 # verify_create requires a recipient as a required parameter, and other optional paramaters
-client.verify_create(31612345678, {:reference => "YourReference"})
+client.verify_create(31612345678, reference: "YourReference")
 
 #<MessageBird::Verify:0x007fb3c18c8148
  @id="080b7f804555213678f14f6o24607735",
@@ -143,7 +144,7 @@ MessageBird also offers the ability to send out a text message as a voice messag
 Optional parameters can be specified as a hash.
 
 ```ruby
-pp client.voice_message_create('31612345678', 'Hello World', :reference => 'MyReference')
+pp client.voice_message_create('31612345678', 'Hello World', reference: 'MyReference')
 
 #<MessageBird::VoiceMessage:0x000001030101b8
  @body="Hello World",
@@ -179,7 +180,7 @@ client.voice_message('a08e51a0353bd16cea7f298a37405850')
 There is also a Numbers API that allow you to search for and purchase number subscriptions to use as originator in other services.
 
 ```ruby
-pp client.number_search("NL", {:limit=>5})
+pp client.number_search("NL", limit: 52)
 
 #<List:0x00007fa405130618
  @count=5,
@@ -230,4 +231,4 @@ Complete documentation, instructions, and examples are available at:
 
 License
 -------
-The MessageBird REST Client for Ruby is licensed under [The BSD 2-Clause License](http://opensource.org/licenses/BSD-2-Clause). Copyright (c) 2014, MessageBird
+The MessageBird REST Client for Ruby is licensed under [The BSD 2-Clause License](http://opensource.org/licenses/BSD-2-Clause). Copyright (c) 2025, MessageBird

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)
@@ -457,13 +460,13 @@ module MessageBird
       number_request(:delete, "phone-numbers/#{number}")
     end
 
-    def call_flow_create(title, steps, default, record, params = {})
+    def call_flow_create(steps, default, record, params = {})
       params = params.merge(
-        title: title,
         steps: steps,
         default: default,
         record: record
       )
+
       CallFlow.new(voice_request(:post, 'call-flows', params))
     end
 
@@ -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

@@ -20,7 +20,7 @@ module MessageBird
     #
     # @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)
+    def initialize(signature_key, skip_url_validation: false)
       @signature_key = signature_key
       @skip_url_validation = skip_url_validation
     end
@@ -71,14 +71,14 @@ module MessageBird
 
     def validate_url(url, url_hash)
       expected_url_hash = Digest::SHA256.hexdigest url
-      unless JWT::SecurityUtils.secure_compare(expected_url_hash, url_hash)
+      unless 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)
+        unless secure_compare(Digest::SHA256.hexdigest(body), payload_hash)
           raise ValidationError, 'invalid jwt: claim payload_hash is invalid'
         end
       elsif !body.to_s.empty?
@@ -87,5 +87,15 @@ module MessageBird
         raise ValidationError, 'invalid jwt: claim payload_hash is set but actual payload is missing'
       end
     end
+
+    # Adaption of https://github.com/rails/rails/blob/cf6ff17e9a3c6c1139040b519a341f55f0be16cf/activesupport/lib/active_support/security_utils.rb#L33
+    # Copied here so as to avoid adding a dependency on ActiveSupport to this gem
+    #
+    # Note that unlike `fixed_length_secure_compare` in the above url we don't fall back to a custom implementation
+    # of fixed_length_secure_compare, since OpenSSL.fixed_length_secure_compare is present in OpenSSL 2.2
+    # https://github.com/ruby/openssl/blob/master/History.md#version-220 which is included in Ruby 3.0 and above
+    def secure_compare(first, second)
+      first.bytesize == second.bytesize && OpenSSL.fixed_length_secure_compare(first, second)
+    end
   end
 end

data/lib/messagebird/version.rb

@@ -2,6 +2,6 @@
 
 module MessageBird
   module Version
-    STRING = '3.1.1'
+    STRING = '5.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)

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: messagebird-rest
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 5.0.0
 platform: ruby
 authors:
 - Maurice Nonnekes
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-31 00:00:00.000000000 Z
+date: 2025-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.2.3
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.2.3
+        version: '4'
 - !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: []
@@ -120,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
@@ -128,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.1.2
-signing_key: 
+rubygems_version: 3.4.20
+signing_key:
 specification_version: 4
 summary: MessageBird's REST API
 test_files: []