seven_api 0.5.0 → 0.6.1

data/lib/seven_api/resources/sms.rb

@@ -1,21 +1,30 @@
-# frozen_string_literal: true
-
-require 'seven_api/resource'
-
-# This module exposes the methods for communicating with the API endpoint /sms.
-module SevenApi::Resources
-  class Sms < SevenApi::Resource
-    @endpoint = SevenApi::Endpoint::SMS
-    @http_methods = {
-      :retrieve => :post,
-    }
-
-    # Send SMS
-    # read more: https://www.seven.io/en/docs/gateway/http-api/sms-dispatch/
-    # @param params [Hash]
-    # @return [Integer,String,Hash]
-    def retrieve(params)
-      request(params)
-    end
-  end
+# frozen_string_literal: true
+
+require 'seven_api/resource'
+
+# This module exposes the methods for communicating with the API endpoint /sms.
+module SevenApi::Resources
+  class Sms < SevenApi::Resource
+    @endpoint = SevenApi::Endpoint::SMS
+    @http_methods = {
+      :delete => :delete,
+      :retrieve => :post,
+    }
+
+    # Delete SMS
+    # read more: https://docs.seven.io/en/rest-api/endpoints/sms#delete-sms
+    # @param ids [Array]
+    # @return [Hash]
+    def delete(ids)
+      request(:delete, ids)
+    end
+
+    # Send SMS
+    # read more: https://docs.seven.io/en/rest-api/endpoints/sms#send-sms
+    # @param params [Hash]
+    # @return [Integer,String,Hash]
+    def retrieve(params)
+      request(:post, params)
+    end
+  end
 end

data/lib/seven_api/resources/status.rb

@@ -1,21 +1,21 @@
-# frozen_string_literal: true
-
-require 'seven_api/resource'
-
-# This module exposes the methods for communicating with the API endpoint /status.
-module SevenApi::Resources
-  class Status < SevenApi::Resource
-    @endpoint = SevenApi::Endpoint::STATUS
-    @http_methods = {
-      :retrieve => :get,
-    }
-
-    # Retrieve delivery report for a SMS
-    # read more: https://www.seven.io/en/docs/gateway/http-api/status-reports/#query-delivery-reports
-    # @param params [Hash]
-    # @return [String]
-    def retrieve(params)
-      request(params)
-    end
-  end
+# frozen_string_literal: true
+
+require 'seven_api/resource'
+
+# This module exposes the methods for communicating with the API endpoint /status.
+module SevenApi::Resources
+  class Status < SevenApi::Resource
+    @endpoint = SevenApi::Endpoint::STATUS
+    @http_methods = {
+      :retrieve => :get,
+    }
+
+    # Retrieve delivery report for a SMS
+    # read more: https://docs.seven.io/en/rest-api/endpoints/status-reports#query-status-reports
+    # @param params [Hash]
+    # @return [String]
+    def retrieve(params)
+      request(:get, params)
+    end
+  end
 end

data/lib/seven_api/resources/subaccounts.rb

@@ -1,66 +1,66 @@
-# frozen_string_literal: true
-
-require 'seven_api/resource'
-require 'seven_api/subaccounts'
-
-# This module exposes the methods for communicating with the API endpoint /subaccounts.
-module SevenApi::Resources
-  class Subaccounts < SevenApi::Resource
-    @endpoint = SevenApi::Endpoint::SUBACCOUNTS
-    @http_methods = {
-      :create => :post,
-      :delete => :post,
-      :read => :get,
-      :transfer_credits => :post,
-      :update => :post,
-    }
-
-    # Create a subaccount
-    # read more: https://www.seven.io/en/docs/gateway/http-api/subaccounts/#create-subaccount
-    # @param params [Hash]
-    # @return [Hash]
-    def create(params)
-      SevenApi::Subaccounts::Validator::create(params)
-
-      request(params.merge({ :action => SevenApi::Subaccounts::Action::CREATE }))
-    end
-
-    # Delete a subaccount
-    # read more: https://www.seven.io/en/docs/gateway/http-api/subaccounts/#delete-subaccount
-    # @param params [Hash]
-    # @return [Hash]
-    def delete(params)
-      SevenApi::Subaccounts::Validator::delete(params)
-
-      request(params.merge({ :action => SevenApi::Subaccounts::Action::DELETE }))
-    end
-
-    # Retrieve all subaccounts
-    # read more: https://www.seven.io/en/docs/gateway/http-api/subaccounts/#read-subaccounts
-    # @param params [Hash]
-    # @return [Hash]
-    def read(params = {})
-      request({}, params.merge({ :action => SevenApi::Subaccounts::Action::READ }))
-    end
-
-    # Transfer credits to a subaccount
-    # read more: https://www.seven.io/en/docs/gateway/http-api/subaccounts/#transfer-credit
-    # @param params [Hash]
-    # @return [Hash]
-    def transfer_credits(params)
-      SevenApi::Subaccounts::Validator::transfer_credits(params)
-
-      request(params.merge({ :action => SevenApi::Subaccounts::Action::TRANSFER_CREDITS }))
-    end
-
-    # Update automatic charging of a subaccount
-    # read more: https://www.seven.io/en/docs/gateway/http-api/subaccounts/#update-automatic-charging-of-the-subaccount
-    # @param params [Hash]
-    # @return [Hash]
-    def update(params)
-      SevenApi::Subaccounts::Validator::update(params)
-
-      request(params.merge({ :action => SevenApi::Subaccounts::Action::UPDATE }))
-    end
-  end
+# frozen_string_literal: true
+
+require 'seven_api/resource'
+require 'seven_api/subaccounts'
+
+# This module exposes the methods for communicating with the API endpoint /subaccounts.
+module SevenApi::Resources
+  class Subaccounts < SevenApi::Resource
+    @endpoint = SevenApi::Endpoint::SUBACCOUNTS
+    @http_methods = {
+      :create => :post,
+      :delete => :post,
+      :read => :get,
+      :transfer_credits => :post,
+      :update => :post,
+    }
+
+    # Create a subaccount
+    # read more: https://docs.seven.io/en/rest-api/endpoints/subaccounts#create-subaccount
+    # @param params [Hash]
+    # @return [Hash]
+    def create(params)
+      SevenApi::Subaccounts::Validator::create(params)
+
+      request(:post, params.merge({ :action => SevenApi::Subaccounts::Action::CREATE }))
+    end
+
+    # Delete a subaccount
+    # read more: https://docs.seven.io/en/rest-api/endpoints/subaccounts#delete-a-subaccount
+    # @param params [Hash]
+    # @return [Hash]
+    def delete(params)
+      SevenApi::Subaccounts::Validator::delete(params)
+
+      request(:post, params.merge({ :action => SevenApi::Subaccounts::Action::DELETE }))
+    end
+
+    # Retrieve all subaccounts
+    # read more: https://docs.seven.io/en/rest-api/endpoints/subaccounts#list-subaccounts
+    # @param params [Hash]
+    # @return [Hash]
+    def read(params = {})
+      request(:get, {}, params.merge({ :action => SevenApi::Subaccounts::Action::READ }))
+    end
+
+    # Transfer credits to a subaccount
+    # read more: https://docs.seven.io/en/rest-api/endpoints/subaccounts#manual-credit-transfer
+    # @param params [Hash]
+    # @return [Hash]
+    def transfer_credits(params)
+      SevenApi::Subaccounts::Validator::transfer_credits(params)
+
+      request(:post, params.merge({ :action => SevenApi::Subaccounts::Action::TRANSFER_CREDITS }))
+    end
+
+    # Update automatic charging of a subaccount
+    # read more: https://docs.seven.io/en/rest-api/endpoints/subaccounts#automatic-credit-transfer
+    # @param params [Hash]
+    # @return [Hash]
+    def update(params)
+      SevenApi::Subaccounts::Validator::update(params)
+
+      request(:post, params.merge({ :action => SevenApi::Subaccounts::Action::UPDATE }))
+    end
+  end
 end

data/lib/seven_api/resources/validate_for_voice.rb

@@ -1,21 +1,21 @@
-# frozen_string_literal: true
-
-require 'seven_api/resource'
-
-# This module exposes the methods for communicating with the API endpoint /validate_for_voice.
-module SevenApi::Resources
-  class ValidateForVoice < SevenApi::Resource
-    @endpoint = SevenApi::Endpoint::VALIDATE_FOR_VOICE
-    @http_methods = {
-      :retrieve => :post,
-    }
-
-    # Validate a phone number for using it as caller ID via our voice API
-    # read more: https://www.seven.io/en/docs/gateway/http-api/caller-ids/
-    # @param params [Hash]
-    # @return [Hash]
-    def retrieve(params)
-      request(params)
-    end
-  end
+# frozen_string_literal: true
+
+require 'seven_api/resource'
+
+# This module exposes the methods for communicating with the API endpoint /validate_for_voice.
+module SevenApi::Resources
+  class ValidateForVoice < SevenApi::Resource
+    @endpoint = SevenApi::Endpoint::VALIDATE_FOR_VOICE
+    @http_methods = {
+      :retrieve => :post,
+    }
+
+    # Validate a phone number for using it as caller ID via our voice API
+    # read more: https://docs.seven.io/en/rest-api/endpoints/sender-identifiers#validate-sender-for-voice
+    # @param params [Hash]
+    # @return [Hash]
+    def retrieve(params)
+      request(:post, params)
+    end
+  end
 end

data/lib/seven_api/resources/voice.rb

@@ -1,21 +1,30 @@
-# frozen_string_literal: true
-
-require 'seven_api/resource'
-
-# This module exposes the methods for communicating with the API endpoint /voice.
-module SevenApi::Resources
-  class Voice < SevenApi::Resource
-    @endpoint = SevenApi::Endpoint::VOICE
-    @http_methods = {
-      :send => :post,
-    }
-
-    # Convert text to speech, call number and read voice message out loud.
-    # read more: https://www.seven.io/en/docs/gateway/http-api/voice/
-    # @param params [Hash]
-    # @return [String,Hash]
-    def send(params)
-      request(params)
-    end
-  end
+# frozen_string_literal: true
+
+require 'seven_api/resource'
+
+# This module exposes the methods for communicating with the API endpoint /voice.
+module SevenApi::Resources
+  class Voice < SevenApi::Resource
+    @endpoint = SevenApi::Endpoint::VOICE
+    @http_methods = {
+      :hangup => :post,
+      :send => :post,
+    }
+
+    # This endpoint ends an active call. Only calls with the status in-progress can be ended.
+    # read more: https://docs.seven.io/en/rest-api/endpoints/voice#hangup-a-call
+    # @param call_id [String]
+    # @return Hash
+    def hangup(call_id)
+      request(:post, {}, {}, "/#{call_id}/hangup")
+    end
+
+    # Convert text to speech, call number and read voice message out loud.
+    # read more: https://docs.seven.io/en/rest-api/endpoints/voice#send-voice-call
+    # @param params [Hash]
+    # @return [String,Hash]
+    def send(params)
+      request(:post, params)
+    end
+  end
 end

data/lib/seven_api/sms.rb

@@ -1,9 +1,9 @@
-# frozen_string_literal: true
-
-# This module holds all utilities related to the /sms endpoint.
-module SevenApi::Sms
-  module Type
-    DIRECT = 'direct'
-    ECONOMY = 'economy'
-  end
-end
+# frozen_string_literal: true
+
+# This module holds all utilities related to the /sms endpoint.
+module SevenApi::Sms
+  module Type
+    DIRECT = 'direct'
+    ECONOMY = 'economy'
+  end
+end

data/lib/seven_api/subaccounts.rb

@@ -1,55 +1,55 @@
-# frozen_string_literal: true
-
-# This module holds all utilities related to the /subaccounts endpoint.
-module SevenApi::Subaccounts
-  module Action
-    CREATE = 'create'
-    DELETE = 'delete'
-    READ = 'read'
-    TRANSFER_CREDITS = 'transfer_credits'
-    UPDATE = 'update'
-  end
-
-  module Validator
-    def self.is_action?(str)
-      SevenApi::Util::in_module_constants?(str, SevenApi::Subaccounts::Action)
-    end
-
-    def self.validate(params)
-      action = params[:action]
-
-      case action
-      when SevenApi::Subaccounts::Action::CREATE
-        raise 'Parameter validation failed' unless SevenApi::Subaccounts::Validator::create(params)
-      when SevenApi::Subaccounts::Action::DELETE
-        raise 'Parameter validation failed' unless SevenApi::Subaccounts::Validator::delete(params)
-      when SevenApi::Subaccounts::Action::TRANSFER_CREDITS
-        raise 'Parameter validation failed' unless SevenApi::Subaccounts::Validator::transfer_credits(params)
-      when SevenApi::Subaccounts::Action::UPDATE
-        raise 'Parameter validation failed' unless SevenApi::Subaccounts::Validator::update(params)
-      else
-        raise "Unknown action #{action}" unless SevenApi::Subaccounts::Validator::is_action?(action)
-      end
-    end
-
-    def self.create(params)
-      SevenApi::Util::lengthy_string?(params[:email]) &&
-        SevenApi::Util::lengthy_string?(params[:name])
-    end
-
-    def self.delete(params)
-      SevenApi::Util::is_positive_integer?(params[:id])
-    end
-
-    def self.transfer_credits(params)
-      SevenApi::Util::is_positive_integer?(params[:amount]) &&
-        SevenApi::Util::is_positive_integer?(params[:id])
-    end
-
-    def self.update(params)
-      SevenApi::Util::is_positive_integer?(params[:amount]) &&
-        SevenApi::Util::is_positive_integer?(params[:id]) &&
-        SevenApi::Util::is_positive_integer?(params[:threshold])
-    end
-  end
-end
+# frozen_string_literal: true
+
+# This module holds all utilities related to the /subaccounts endpoint.
+module SevenApi::Subaccounts
+  module Action
+    CREATE = 'create'
+    DELETE = 'delete'
+    READ = 'read'
+    TRANSFER_CREDITS = 'transfer_credits'
+    UPDATE = 'update'
+  end
+
+  module Validator
+    def self.is_action?(str)
+      SevenApi::Util::in_module_constants?(str, SevenApi::Subaccounts::Action)
+    end
+
+    def self.validate(params)
+      action = params[:action]
+
+      case action
+      when SevenApi::Subaccounts::Action::CREATE
+        raise 'Parameter validation failed' unless SevenApi::Subaccounts::Validator::create(params)
+      when SevenApi::Subaccounts::Action::DELETE
+        raise 'Parameter validation failed' unless SevenApi::Subaccounts::Validator::delete(params)
+      when SevenApi::Subaccounts::Action::TRANSFER_CREDITS
+        raise 'Parameter validation failed' unless SevenApi::Subaccounts::Validator::transfer_credits(params)
+      when SevenApi::Subaccounts::Action::UPDATE
+        raise 'Parameter validation failed' unless SevenApi::Subaccounts::Validator::update(params)
+      else
+        raise "Unknown action #{action}" unless SevenApi::Subaccounts::Validator::is_action?(action)
+      end
+    end
+
+    def self.create(params)
+      SevenApi::Util::lengthy_string?(params[:email]) &&
+        SevenApi::Util::lengthy_string?(params[:name])
+    end
+
+    def self.delete(params)
+      SevenApi::Util::is_positive_integer?(params[:id])
+    end
+
+    def self.transfer_credits(params)
+      SevenApi::Util::is_positive_integer?(params[:amount]) &&
+        SevenApi::Util::is_positive_integer?(params[:id])
+    end
+
+    def self.update(params)
+      SevenApi::Util::is_positive_integer?(params[:amount]) &&
+        SevenApi::Util::is_positive_integer?(params[:id]) &&
+        SevenApi::Util::is_positive_integer?(params[:threshold])
+    end
+  end
+end

data/lib/seven_api/util.rb

@@ -1,69 +1,69 @@
-require 'date'
-
-# This module exposes general utilities used throughout the library.
-module SevenApi::Util
-  def self.to_numbered_bool(val)
-    if true == val
-      return 1
-    elsif false == val
-      return 0
-    end
-
-    return val
-  end
-
-  def self.get_namespace_members_by_type(ns, type)
-    ns.constants.map(&ns.method(:const_get)).grep(type)
-  end
-
-  def self.get_namespace_classes(ns)
-    return self.get_namespace_members_by_type(ns, Class)
-  end
-
-  def self.get_module_constant_values(mod)
-    mod.constants(false).map &mod.method(:const_get)
-  end
-
-  def self.is_valid_url?(str)
-    str =~ URI::regexp
-  end
-
-  def self.is_valid_datetime?(str)
-    begin
-      DateTime.parse(str)
-      true
-    rescue ArgumentError
-      false
-    end
-  end
-
-  def self.is_positive_integer?(val)
-    /\A\d+\z/.match?(val.to_s)
-  end
-
-  def self.in_module_constants?(needle, mod)
-    get_module_constant_values(mod).include?(needle)
-  end
-
-  def self.valid_float?(str)
-    !!Float(str) rescue false
-  end
-
-  def self.numeric?(val)
-    return true if val.is_a?(Integer)
-
-    val.scan(/\D/).empty?
-  end
-
-  def self.boolean?(val)
-    [true, false].include? val
-  end
-
-  def self.nil_or_lengthy_string?(val)
-    val.nil? || (val.is_a?(String) && val.length)
-  end
-
-  def self.lengthy_string?(val)
-    return val.is_a?(String) && !val.empty?
-  end
+require 'date'
+
+# This module exposes general utilities used throughout the library.
+module SevenApi::Util
+  def self.to_numbered_bool(val)
+    if true == val
+      return 1
+    elsif false == val
+      return 0
+    end
+
+    return val
+  end
+
+  def self.get_namespace_members_by_type(ns, type)
+    ns.constants.map(&ns.method(:const_get)).grep(type)
+  end
+
+  def self.get_namespace_classes(ns)
+    return self.get_namespace_members_by_type(ns, Class)
+  end
+
+  def self.get_module_constant_values(mod)
+    mod.constants(false).map &mod.method(:const_get)
+  end
+
+  def self.is_valid_url?(str)
+    str =~ URI::regexp
+  end
+
+  def self.is_valid_datetime?(str)
+    begin
+      DateTime.parse(str)
+      true
+    rescue ArgumentError
+      false
+    end
+  end
+
+  def self.is_positive_integer?(val)
+    /\A\d+\z/.match?(val.to_s)
+  end
+
+  def self.in_module_constants?(needle, mod)
+    get_module_constant_values(mod).include?(needle)
+  end
+
+  def self.valid_float?(str)
+    !!Float(str) rescue false
+  end
+
+  def self.numeric?(val)
+    return true if val.is_a?(Integer)
+
+    val.scan(/\D/).empty?
+  end
+
+  def self.boolean?(val)
+    [true, false].include? val
+  end
+
+  def self.nil_or_lengthy_string?(val)
+    val.nil? || (val.is_a?(String) && val.length)
+  end
+
+  def self.lengthy_string?(val)
+    return val.is_a?(String) && !val.empty?
+  end
 end

data/lib/seven_api/version.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
-
-module SevenApi
-  VERSION = '0.5.0'
-end
+# frozen_string_literal: true
+
+module SevenApi
+  VERSION = '0.6.1'
+end

data/lib/seven_api.rb

@@ -1,6 +1,6 @@
-# frozen_string_literal: true
-
-require 'seven_api/version'
-
-module SevenApi
-end
+# frozen_string_literal: true
+
+require 'seven_api/version'
+
+module SevenApi
+end

data/release.sh

@@ -1,5 +1,5 @@
-#!/bin/sh
-
-gem build --strict
-
+#!/bin/sh
+
+gem build --strict
+
 gem push "$(find . -name "*.gem" -print0 | xargs -r -0 ls -1 -t | head -1)"

data/seven_api.gemspec

@@ -4,10 +4,10 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'seven_api/version'
 
 Gem::Specification.new do |spec|
-  spec.add_development_dependency 'bundler', '~> 2.1'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.9'
-  spec.add_runtime_dependency 'faraday', '~> 1.1'
+  spec.add_development_dependency 'bundler', '~> 2.4'
+  spec.add_development_dependency 'rake', '~> 13.1'
+  spec.add_development_dependency 'rspec', '~> 3.13'
+  spec.add_runtime_dependency 'faraday', '~> 2.9'
   spec.author = 'seven communications GmbH & Co. KG'
   spec.description = 'Send SMS & text-to-speech messages via the seven SMS Gateway.'
   spec.email = 'support@seven.io'
@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.homepage = 'https://github.com/seven-io/ruby-client'
   spec.license = 'MIT'
   spec.name = 'seven_api'
-  spec.required_ruby_version = '>= 2.6.0'
+  spec.required_ruby_version = '>= 3.1.0'
   spec.summary = 'Official API Client for the seven SMS Gateway'
   spec.test_files = Dir['spec/**/*']
   spec.version = SevenApi::VERSION