seven_api 0.5.0

data/lib/seven_api/subaccounts.rb

@@ -0,0 +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

data/lib/seven_api/util.rb

@@ -0,0 +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
+end

data/lib/seven_api/version.rb

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

data/lib/seven_api.rb

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

data/release.sh

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

data/seven_api.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path('../lib', __FILE__)
+$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.author = 'seven communications GmbH & Co. KG'
+  spec.description = 'Send SMS & text-to-speech messages via the seven SMS Gateway.'
+  spec.email = 'support@seven.io'
+  spec.files = `git ls-files`.split("\n")
+  spec.homepage = 'https://github.com/seven-io/ruby-client'
+  spec.license = 'MIT'
+  spec.name = 'seven_api'
+  spec.required_ruby_version = '>= 2.6.0'
+  spec.summary = 'Official API Client for the seven SMS Gateway'
+  spec.test_files = Dir['spec/**/*']
+  spec.version = SevenApi::VERSION
+end

data/spec/EnvKeyStore.rb

@@ -0,0 +1,15 @@
+class EnvKeyStore
+  def initialize(key)
+    @key = "SEVEN_TEST_#{key}"
+
+    @store = ENV[@key]
+  end
+
+  def get(fallback = nil)
+    @store.nil? ? fallback : @store
+  end
+
+  def set(val, only_on_nil = false)
+    @store = val unless only_on_nil
+  end
+end

data/spec/matchers.rb

@@ -0,0 +1,23 @@
+RSpec::Matchers.define :be_nil_or_lengthy_string do
+  match do |val|
+    SevenApi::Util::nil_or_lengthy_string?(val)
+  end
+end
+
+RSpec::Matchers.define :be_boolean do
+  match do |val|
+    SevenApi::Util::boolean?(val)
+  end
+end
+
+RSpec::Matchers.define :be_numeric do
+  match do |val|
+    SevenApi::Util::numeric?(val)
+  end
+end
+
+RSpec::Matchers.define :be_lengthy_string do
+  match do |val|
+    SevenApi::Util::lengthy_string?(val)
+  end
+end

data/spec/seven_api/balance_spec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'seven_api/resources/balance'
+
+RSpec.describe SevenApi, 'balance' do
+  it 'returns the account balance' do
+    helper = Helper.new(SevenApi::Resources::Balance)
+    balance = helper.request(helper.resource.method(:retrieve), 155.55)
+    expect(balance).to be_a(Float)
+  end
+end

data/spec/seven_api/client_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'seven_api/client'
+require 'seven_api/resource'
+
+RSpec.describe SevenApi, 'client' do
+  it 'should contain all resource modules' do
+    client = SevenApi::Client.new(SevenApi::Resource.new('x'))
+
+    client.instance_variables.each do |var|
+      expect(SevenApi::Resources.const_get(client.instance_variable_get(var).class.name)).to be_truthy
+    end
+  end
+end

data/spec/seven_api/contacts_spec.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'seven_api/contacts'
+require 'seven_api/resources/contacts'
+
+RSpec.describe SevenApi, 'contacts' do
+  $new_contact_id = nil
+
+  def assert_new(response_body)
+    if response_body.is_a?(String)
+      code, $new_contact_id = response_body.split("\n")
+      $new_contact_id = $new_contact_id.to_i
+    else
+      code = response_body[:return]
+      $new_contact_id = response_body[:id]
+    end
+
+    expect(code).to be_numeric
+    expect($new_contact_id).to be_an_instance_of(Integer)
+  end
+
+  def assert_contact(contact)
+    if contact.is_a?(String)
+      id, name, number = contact.split(';')
+
+      id = id.gsub('"', '')
+      name = name.gsub('"', '')
+      number = number.gsub('"', '')
+    else
+      id = contact[:ID]
+      name = contact[:Name]
+      number = contact[:Number]
+    end
+
+    expect(id).to be_numeric
+    expect(name).to be_an_instance_of(String)
+    expect(number.sub('+', '')).to be_numeric
+  end
+
+  it 'returns all contacts as CSV' do
+    stub = <<~CSV
+      "4848436";"";""
+      "4848437";"";""
+      "4848433";"Alf Albert";"007"
+      "3172517";"BNN Nolte";"004911112"
+      "4848434";"Harry Harald";"0049123456"
+      "4848431";"Karl Konrad";"00123456"
+      "4848432";"Petra Pan";"00513414"
+      "2925186";"Tom Tester";"004901234567890"
+    CSV
+
+    helper = Helper.new(SevenApi::Resources::Contacts)
+    body = helper.request(helper.resource.method(:read), stub)
+
+    expect(body).to be_a(String)
+
+    body.split("\n").each do |contact|
+      assert_contact(contact)
+    end
+  end
+
+  it 'returns all contacts as JSON' do
+    stub = [
+      { ID: '4848436', Name: '', Number: '' },
+      { ID: '4848437', Name: '', Number: '' },
+      { ID: '4848433', Name: 'Alf Albert', Number: '007' },
+      { ID: '3172517', Name: 'BNN Nolte', Number: '004911112' },
+      { ID: '4848434', Name: 'Harry Harald', Number: '0049123456' },
+      { ID: '4848431', Name: 'Karl Konrad', Number: '00123456' },
+      { ID: '4848432', Name: 'Petra Pan', Number: '00513414' },
+      { ID: '2925186', Name: 'Tom Tester', Number: '004901234567890' }
+    ]
+
+    helper = Helper.new(SevenApi::Resources::Contacts)
+    body = helper.request(helper.resource.method(:read), stub, { json: true })
+
+    expect(body).to be_a(Array)
+
+    body.each do |contact|
+      assert_contact(contact)
+    end
+  end
+
+  it 'creates a contact and returns its ID as TEXT' do
+    stub = <<~TEXT
+      152
+      4868400
+    TEXT
+
+    helper = Helper.new(SevenApi::Resources::Contacts)
+    body = helper.request(helper.resource.method(:write), stub, {})
+
+    expect(body).to be_a(String)
+
+    assert_new(body)
+  end
+
+  it 'deletes a contact with given ID and return code' do
+    helper = Helper.new(SevenApi::Resources::Contacts)
+    expect(helper.request(helper.resource.method(:delete), 152, { id: $new_contact_id })).to be_a(Integer)
+  end
+
+  it 'creates a contact and returns its ID as JSON' do
+    helper = Helper.new(SevenApi::Resources::Contacts)
+    body = helper.request(helper.resource.method(:write), { id: 4868401, return: '152' }, { json: true })
+
+    expect(body).to be_a(Hash)
+
+    assert_new(body)
+  end
+
+  it 'deletes a contact with given ID and return code as JSON' do
+    helper = Helper.new(SevenApi::Resources::Contacts)
+    body = helper.request(
+      helper.resource.method(:delete),
+      {
+        return: '152'
+      },
+      {
+        id: $new_contact_id,
+        json: true,
+      }
+    )
+
+    expect(body).to be_a(Hash)
+    expect(body[:return]).to be_a(String)
+  end
+end

data/spec/seven_api/hooks_spec.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'securerandom'
+require 'seven_api/hooks'
+require 'seven_api/util'
+require 'seven_api/resources/hooks'
+
+RSpec.describe SevenApi, 'hooks' do
+  HOOK_ID = EnvKeyStore.new('HOOK_ID')
+
+  def alter_action_stub
+    {
+      :code => nil,
+      :success => true
+    }
+  end
+
+  def request(fn, stub, extra_params = {})
+    helper = Helper.new(SevenApi::Resources::Hooks)
+
+    res = helper.request(helper.resource.method(fn), stub, extra_params)
+
+    expect(res).to be_a(Hash)
+
+    stub_keys = stub.keys
+
+    res.each do |k, v|
+      expect(stub_keys).to include(k)
+      expect(v.class).to match(stub[:"#{k}"].class)
+    end
+
+    res
+  end
+
+  it 'returns all hooks' do
+    res = request(:read, {
+      :code => nil,
+      :hooks => [
+        {
+          :created => "2020-11-04 23:04:15",
+          :event_type => "sms_mo",
+          :id => "30",
+          :request_method => "GET",
+          :target_url => "http://my.tld/testHook"
+        }
+      ],
+      :success => true
+    })
+
+    expect(res).to include(:code, :hooks, :success)
+    expect(res[:code]).to eq(nil)
+    expect(res[:hooks]).to be_a(Array)
+    expect(res[:success]).to be_boolean
+
+    res[:hooks].each do |hook|
+      expect(hook).to include(:created, :event_type, :id, :request_method, :target_url)
+
+      expect(SevenApi::Util::is_valid_datetime?(hook[:created])).to be
+      expect(hook[:created]).to match(/^\d\d\d\d-(0?[1-9]|1[0-2])-(0?[1-9]|[12][0-9]|3[01]) (1[0-9]|2[0-3]|0[0-9]):([0-9]|[0-5][0-9]):([0-9]|[0-5][0-9])$/)
+      expect(SevenApi::Hooks::Validator::event_type?(hook[:event_type])).to be
+      expect(SevenApi::Util::is_positive_integer?(hook[:id])).to be
+      expect(SevenApi::Hooks::Validator::request_method?(hook[:request_method])).to be
+      expect(SevenApi::Hooks::Validator::target_url?(hook[:target_url])).to be
+    end
+  end
+
+=begin
+  it 'subscribes' do
+    helper = Helper.new(Seven::Resources::Hooks)
+    stub = alter_action_stub.merge({ :id => rand(1...1000000) })
+
+    res = request(helper.resource.method(:subscribe), stub, {
+      :event_type => Seven::Hooks::EventType::NEW_INBOUND_SMS,
+      :request_method => Seven::Hooks::RequestMethod::GET,
+      :target_url => "http://ruby.tld/#{SecureRandom.uuid}"
+    })
+
+    expect(Seven::Util::is_positive_integer?(res[:id])).to be
+    expect(res[:id]).to be_a(Integer)
+    expect(stub[:id]).to match(res[:id]) unless Helper::IS_HTTP
+
+    assert_alter_response(res)
+
+    puts "Subscribed ID: #{Helper::IS_HTTP ? res[:id] : stub[:id]}"
+
+    HOOK_ID.set(res[:id])
+  end
+
+  it 'unsubscribes' do
+    helper = Helper.new(Seven::Resources::Hooks)
+    id = HOOK_ID.get
+    res = request(helper.resource.method(:unubscribe), alter_action_stub, { :id => id })
+
+    assert_alter_response(res)
+
+    expect(res[:success]).to be_boolean
+
+    puts "Unsubscribed ID #{id}: #{res[:success]}"
+
+    res[:success]
+  end
+=end
+
+  def assert_alter_response(res)
+    expect(res[:code]).to match(nil)
+    expect(res[:success]).to be_boolean
+  end
+end

data/spec/seven_api/instance_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+#noinspection RubyResolve
+require 'spec_helper'
+require 'seven_api/resource'
+
+#noinspection RubyResolve
+RSpec.describe SevenApi, 'instance' do
+  helper = Helper.new(SevenApi::Resource)
+
+  it 'checks api key' do
+    expect(helper.resource.api_key).to be_lengthy_string
+  end
+
+  it 'checks sentWith' do
+    expect(helper.resource.sent_with).to be_lengthy_string
+  end
+
+  it 'fails authentication' do
+    expect { SevenApi::Resource.new('') }.to raise_error(RuntimeError)
+  end
+end

data/spec/seven_api/journal_spec.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'seven_api/journal'
+require 'seven_api/resources/journal'
+require 'seven_api/sms'
+
+RSpec.describe SevenApi, 'journal' do
+  def valid_timestamp?(str)
+    str.match(/[\d]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][\d]|3[0-1]) (2[0-3]|[01][\d]):[0-5][\d]/)
+  end
+
+  def request(type)
+    stub = [{
+              :from => "SMS",
+              :id => "123456789",
+              :price => "1.2",
+              :text => "Hey my friend!",
+              :timestamp => "2020-10-14 14:25:04",
+              :to => "49170123456789",
+            }]
+
+    helper = Helper.new(SevenApi::Resources::Journal)
+    res = helper.request(helper.resource.method(:retrieve), stub, { type: type })
+
+    expect(res).to be_a(Array)
+
+    res.each do |journal|
+      expect(journal).to be_a(Hash)
+      expect(journal[:from]).to be_lengthy_string
+      expect(journal[:id]).to be_numeric
+      expect(SevenApi::Util::valid_float?(journal[:price])).to be_truthy
+      expect(journal[:text]).to be_lengthy_string
+      expect(valid_timestamp?(journal[:timestamp])).to be_truthy
+      expect(journal[:to]).to be_lengthy_string
+    end
+
+    res
+  end
+
+  it 'returns all inbound messages' do
+    request(SevenApi::Journal::Type::INBOUND)
+  end
+
+  it 'returns all outbound messages' do
+    request(SevenApi::Journal::Type::OUTBOUND).each do |journal|
+      journal.merge!({
+                       :connection => "http",
+                       :dlr => "DELIVERED",
+                       :dlr_timestamp => "2020-10-04 09:26:10.000",
+                       :foreign_id => "MyForeignId",
+                       :label => "MyCustomLabel",
+                       :latency => "5.1060",
+                       :mccmnc => "26207",
+                       :type => "direct",
+                     })
+      expect(journal[:connection]).to be_lengthy_string
+      expect(journal[:dlr]).to be_nil_or_lengthy_string
+      expect(valid_timestamp?(journal[:dlr_timestamp])).to be_truthy
+      expect(journal[:foreign_id]).to be_nil_or_lengthy_string
+      expect(journal[:label]).to be_nil_or_lengthy_string
+      expect(journal[:latency]).to be_nil_or_lengthy_string
+      expect(journal[:mccmnc]).to be_nil_or_lengthy_string
+      expect(SevenApi::Util::in_module_constants?(journal[:type], SevenApi::Sms::Type)).to be_truthy
+    end
+  end
+
+  it 'returns all voice messages' do
+    request(SevenApi::Journal::Type::VOICE).each do |journal|
+      journal.merge!({
+                       :duration => "2",
+                       :error => "",
+                       :status => "completed",
+                       :xml => false,
+                     })
+      expect(journal[:duration]).to be_numeric
+      expect(journal[:error]).to be_nil_or_lengthy_string
+      expect(journal[:status]).to be_lengthy_string
+      expect(journal[:xml]).to be_boolean
+    end
+  end
+
+  it 'returns all reply messages' do
+    request(SevenApi::Journal::Type::REPLIES)
+  end
+end