sms77 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fe2489e8f42e261bf888d5d5d86805caba5e7a293dae1020399069b37ba26e2a
+  data.tar.gz: cbb1faa8e91e0c29df20fa27ed31c8baa8a8655582fa180b64d45b24b27545a1
+SHA512:
+  metadata.gz: f0db040721b53efa7b02a8dc48af77d7ca6d43f0e5a8f0cdbae8700fef7abd856dd52fa149d68f3e61740a25761b37336274d0f65b3fa7d82071814be65cd824
+  data.tar.gz: b22a80577d8b440de469a221f6013bf3fff1daa7ca9f3a8f8df9e9e59f7cfe94aef6ab79bf76c07b0cff800315acd1ac9c91e0b3f1f62a6dd29f01478cb85756

data/.gitignore

@@ -0,0 +1,4 @@
+/.idea
+sms77.gem
+Gemfile.lock
+.ruby-gemset

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020-present sms77 e.K.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,15 @@
+![](https://www.sms77.io/wp-content/uploads/2019/07/sms77-Logo-400x79.png "Sms77.io Logo")
+
+# Sms77.io SMS Gateway API Client
+
+## Installation
+
+```gem install sms77```
+
+### Usage
+
+```ruby
+client = Sms77::Client.new(api_key: ENV['SMS77_API_KEY'])
+balance = client.get(url: '/api/balance')
+puts balance.inspect
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/sms77.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'sms77/version'
+require 'sms77/client'
+
+module Sms77
+end

data/lib/sms77/client.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'cgi'
+require 'json'
+require 'faraday'
+require 'sms77/endpoint'
+require 'sms77/contacts_action'
+require 'sms77/header'
+
+module Sms77
+  class Client
+    def initialize(api_key, conn, sent_with = 'ruby')
+      @api_key = api_key
+      @conn = conn
+      @sent_with = sent_with
+
+      raise 'missing api_key in config' if !@api_key || @api_key.empty?
+      raise 'missing conn in config' unless @conn
+
+      @conn.headers['sentWith'] = @sent_with
+      @conn.authorization :Bearer, @api_key
+    end
+
+    BASE_URI = 'https://gateway.sms77.io'
+    API_SUFFIX = '/api/'
+    API_URI = "#{BASE_URI}#{API_SUFFIX}"
+
+    def analytics(params = {})
+      get(Sms77::Endpoint::ANALYTICS, params)
+    end
+
+    def balance
+      get(Sms77::Endpoint::BALANCE)
+    end
+
+    def contacts(params)
+      method(params['action'] == ContactsAction::READ ? 'get' : 'post').call(Sms77::Endpoint::CONTACTS, params)
+    end
+
+    def lookup(params)
+      get(Sms77::Endpoint::LOOKUP, params)
+    end
+
+    def pricing(params = {})
+      get(Sms77::Endpoint::PRICING, params)
+    end
+
+    def sms(params)
+      post(Sms77::Endpoint::SMS, params)
+    end
+
+    def status(params)
+      get(Sms77::Endpoint::STATUS, params)
+    end
+
+    def validate_for_voice(params)
+      get(Sms77::Endpoint::VALIDATE_FOR_VOICE, params)
+    end
+
+    def voice(params)
+      post(Sms77::Endpoint::VOICE, params)
+    end
+
+    private
+
+    def get(endpoint, params = {})
+      request(endpoint, 'get', params)
+    end
+
+    def post(endpoint, params)
+      request(endpoint, 'post', params)
+    end
+
+    def request(endpoint, method, params)
+      url = "#{API_SUFFIX}#{endpoint}"
+
+      if ENV['SMS77_DEBUG']
+        puts "requesting url: #{url}"
+        puts "headers: #{@conn.headers.inspect}"
+      end
+
+      response = if method == 'get'
+                   @conn.get(url, params)
+                 else
+                   @conn.post do |req|
+                     req.path = url
+                     req.params = params
+                   end
+                 end
+
+      raise "Error requesting (#{self.class.name}) with code: #{response.status}" if response.status != 200
+
+      puts "received body: #{response.body}" if ENV['SMS77_DEBUG']
+
+      response
+    end
+  end
+end

data/lib/sms77/contacts_action.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Sms77
+  module ContactsAction
+    DEL = 'del'
+    READ = 'read'
+    WRITE = 'write'
+  end
+end

data/lib/sms77/endpoint.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Sms77
+  module Endpoint
+    ANALYTICS = 'analytics'
+    BALANCE = 'balance'
+    CONTACTS = 'contacts'
+    LOOKUP = 'lookup'
+    PRICING = 'pricing'
+    SMS = 'sms'
+    STATUS = 'status'
+    VALIDATE_FOR_VOICE = 'validate_for_voice'
+    VOICE = 'voice'
+  end
+end

data/lib/sms77/header.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Sms77
+  module Header
+    CONTENT_TYPE = 'Content-Type'
+  end
+end

data/lib/sms77/lookup_type.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Sms77
+  module LookupType
+    CNAM = 'cnam'
+    FORMAT = 'format'
+    HLR = 'hlr'
+    MNP = 'mnp'
+  end
+end

data/lib/sms77/version.rb

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

data/sms77.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'sms77/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'sms77'
+  spec.version = Sms77::VERSION.dup
+  spec.summary = 'Official Sms77.io API Client for Ruby'
+  spec.description = 'Send SMS & Text2Voice messages via the Sms77.io SMS Gateway.'
+  spec.authors = ['sms77 e.K.']
+  spec.email = ['support@sms77.io']
+  spec.homepage = 'https://github.com/sms77io/ruby-client'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.6.5'
+  spec.require_paths = ['lib']
+  spec.files = `git ls-files`.split("\n")
+  spec.test_files = Dir['test/**/*']
+
+  spec.add_runtime_dependency 'faraday', '~> 1'
+
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'rake', '~> 13'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/spec/sms77/balance_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'sms77/endpoint'
+
+RSpec.describe Sms77, 'balance' do
+  it 'returns the account balance' do
+    Helper.stubs.get("/api/#{Sms77::Endpoint::BALANCE}") { |_env| [200, {}, '12.34'] } unless Helper.is_http
+
+    response = Helper.client.balance
+
+    expect(response.class).to eq(Faraday::Response)
+    expect(response.body.to_f).to be_kind_of(Float)
+  end
+end

data/spec/sms77/contacts_spec.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'sms77/endpoint'
+require 'sms77/contacts_action'
+
+RSpec.describe Sms77, '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
+
+  def request(action, stub, extra_params = {})
+    Helper.request(Sms77::Endpoint::CONTACTS, { action: action }.merge(extra_params), stub)
+  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
+
+    body = request(Sms77::ContactsAction::READ, stub)
+
+    expect(body).to be_kind_of(String)
+
+    body.split("\n").each do |contact|
+      assert_contact(contact)
+    end
+  end
+
+  it 'returns all contacts as CSV' 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' }
+    ]
+
+    body = request(Sms77::ContactsAction::READ, stub, { json: 1 })
+
+    expect(body).to be_kind_of(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
+
+    body = request(Sms77::ContactsAction::WRITE, stub)
+
+    expect(body).to be_kind_of(String)
+
+    assert_new(body)
+  end
+
+  it 'deletes a contact with given ID and return code' do
+    expect(request(Sms77::ContactsAction::DEL, 152, { id: $new_contact_id })).to be_kind_of(Integer)
+  end
+
+  it 'creates a contact and returns its ID as JSON' do
+    body = request(Sms77::ContactsAction::WRITE, { id: 4868401, return: '152' }, { json: 1 })
+
+    expect(body).to be_kind_of(Hash)
+
+    assert_new(body)
+  end
+
+  it 'deletes a contact with given ID and return code as JSON' do
+    body = request(Sms77::ContactsAction::DEL, { return: '152' }, { id: $new_contact_id, json: 1 })
+
+    expect(body).to be_kind_of(Hash)
+    expect(body['return']).to be_kind_of(String)
+  end
+end

data/spec/sms77/http_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'logger'
+
+describe Sms77::Http do
+  before(:all) do
+  end
+
+  after(:all) do
+  end
+
+  after(:each) do
+  end
+
+  let(:config) do
+    Helper.config
+  end
+
+  let(:logger) do
+    Logger.new($stderr).tap do |logger|
+      logger.level = Logger::ERROR
+    end
+  end
+
+  let(:instance) do
+    described_class.new(config, logger)
+  end
+
+  context 'GET' do
+    it 'performs GET requests' do
+      Helper.maybe_stub_balance(:get)
+
+      response = instance.get(url: 'balance')
+      puts response.body
+
+      expect(response.body.to_f).to be_kind_of(Float)
+    end
+  end
+end

data/spec/sms77/lookup_spec.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'sms77/endpoint'
+require 'sms77/lookup_type'
+require 'json'
+
+RSpec.describe Sms77, 'lookup' do
+  def request(type, stub, extra_args = {})
+    Helper.stubs.get("/api/#{Sms77::Endpoint::LOOKUP}") { |_env| [200, {}, JSON.generate(stub)] } unless Helper.is_http
+
+    response = Helper.client.lookup({ type: type, number: '+491771783130' }.merge(extra_args))
+
+    expect(response.class).to eq(Faraday::Response)
+
+    body = response.body
+
+    begin
+      body = JSON.parse(body)
+    rescue StandardError
+      # Ignored
+    end
+
+    body
+  end
+
+  it 'misses number to lookup' do
+    stub = {
+      carrier: nil,
+      country_code: false,
+      country_iso: nil,
+      country_name: nil,
+      international: '+',
+      international_formatted: '',
+      national: '',
+      network_type: nil,
+      success: false
+    }
+
+    body = request(Sms77::LookupType::FORMAT, stub, { number: '' })
+
+    expect(body).to be_kind_of(Hash)
+    expect(body['success']).to match(false)
+  end
+
+  it 'returns number formatting details as json' do
+    stub = {
+      carrier: 'Eplus',
+      country_code: '49',
+      country_iso: 'DE',
+      country_name: 'Germany',
+      international: '+491771783130',
+      international_formatted: '+49 177 1783130',
+      national: '0177 1783130',
+      network_type: 'mobile',
+      success: true
+    }
+
+    body = request(Sms77::LookupType::FORMAT, stub)
+
+    expect(body).to be_kind_of(Hash)
+    expect(body['carrier']).to be_kind_of(String)
+    expect(body['country_code']).to be_kind_of(String)
+    expect(body['country_iso']).to be_kind_of(String)
+    expect(body['country_name']).to be_kind_of(String)
+    expect(body['international']).to be_kind_of(String)
+    expect(body['international_formatted']).to be_kind_of(String)
+    expect(body['national']).to be_kind_of(String)
+    expect(body['network_type']).to be_kind_of(String)
+    expect(body['success']).to be_boolean
+  end
+
+  it 'returns CNAM details as json' do
+    stub = {
+      code: '100',
+      name: 'GERMANY',
+      number: '+491771783130',
+      success: 'true'
+    }
+    body = request(Sms77::LookupType::CNAM, stub)
+
+    expect(body).to be_kind_of(Hash)
+    expect(body['code']).to be_kind_of(String)
+    expect(body['name']).to be_kind_of(String)
+    expect(body['number']).to be_kind_of(String)
+    expect(body['success']).to be_kind_of(String)
+  end
+
+  it 'returns MNP details as text' do
+    body = request(Sms77::LookupType::MNP, 'eplus')
+
+    expect(body).to be_kind_of(String)
+  end
+
+  it 'returns MNP details as json' do
+    stub = {
+      code: 100,
+      mnp: {
+        country: 'DE',
+        international_formatted: '+49 177 1783130',
+        isPorted: false,
+        mccmnc: '26203',
+        national_format: '0177 1783130',
+        network: "Telef\u00f3nica Germany GmbH & Co. oHG (O2)",
+        number: '+491771783130'
+      },
+      price: 0.005,
+      success: true
+    }
+    body = request(Sms77::LookupType::MNP, stub, { json: 1 })
+
+    expect(body).to be_kind_of(Hash)
+    expect(body['code']).to be_kind_of(Integer)
+    expect(body['price']).to be_kind_of(Float)
+    expect(body['mnp']).to be_kind_of(Hash)
+    expect(body['mnp']['country']).to be_kind_of(String)
+    expect(body['mnp']['international_formatted']).to be_kind_of(String)
+    expect(body['mnp']['isPorted']).to be_boolean
+    expect(body['mnp']['mccmnc']).to be_kind_of(String)
+    expect(body['mnp']['national_format']).to be_kind_of(String)
+    expect(body['mnp']['network']).to be_kind_of(String)
+    expect(body['mnp']['number']).to be_kind_of(String)
+    expect(body['success']).to be_boolean
+  end
+
+  it 'returns HLR details as json' do
+    stub = {
+      country_code: 'DE',
+      country_name: 'Germany',
+      country_prefix: '49',
+      current_carrier: {
+        country: 'DE',
+        name: "Telef\u00f3nica Germany GmbH & Co. oHG (O2)",
+        network_code: '26203',
+        network_type: 'mobile'
+      },
+      international_format_number: '491771783130',
+      international_formatted: '+49 177 1783130',
+      lookup_outcome: true,
+      lookup_outcome_message: 'success',
+      national_format_number: '0177 1783130',
+      original_carrier: {
+        country: 'DE',
+        name: "Telef\u00f3nica Germany GmbH & Co. oHG (O2)",
+        network_code: '26203',
+        network_type: 'mobile'
+      },
+      status: true,
+      status_message: 'success',
+      gsm_code: '0',
+      gsm_message: 'No error',
+      ported: 'assumed_not_ported',
+      reachable: 'reachable',
+      roaming: 'not_roaming',
+      valid_number: 'valid'
+    }
+
+    body = request(Sms77::LookupType::HLR, stub)
+
+    expect(body).to be_kind_of(Hash)
+    expect(body['country_code']).to be_kind_of(String)
+    expect(body['country_name']).to be_kind_of(String)
+    expect(body['country_prefix']).to be_kind_of(String)
+    expect(body['current_carrier']).to be_kind_of(Hash)
+    expect(body['current_carrier']['country']).to be_kind_of(String)
+    expect(body['current_carrier']['name']).to be_kind_of(String)
+    expect(body['current_carrier']['network_code']).to be_kind_of(String)
+    expect(body['current_carrier']['network_type']).to be_kind_of(String)
+    expect(body['international_format_number']).to be_kind_of(String)
+    expect(body['international_formatted']).to be_kind_of(String)
+    expect(body['lookup_outcome']).to be_boolean
+    expect(body['lookup_outcome_message']).to be_kind_of(String)
+    expect(body['national_format_number']).to be_kind_of(String)
+    expect(body['original_carrier']).to be_kind_of(Hash)
+    expect(body['original_carrier']['country']).to be_kind_of(String)
+    expect(body['original_carrier']['name']).to be_kind_of(String)
+    expect(body['original_carrier']['network_code']).to be_kind_of(String)
+    expect(body['original_carrier']['network_type']).to be_kind_of(String)
+    expect(body['status']).to be_boolean
+    expect(body['status_message']).to be_kind_of(String)
+    expect(body['gsm_code']).to be_kind_of(String)
+    expect(body['gsm_message']).to be_kind_of(String)
+    expect(body['ported']).to be_kind_of(String)
+    expect(body['reachable']).to be_kind_of(String)
+    expect(body['roaming']).to be_kind_of(String)
+    expect(body['valid_number']).to be_kind_of(String)
+  end
+end

data/spec/sms77/pricing_spec.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'sms77/endpoint'
+require 'json'
+
+RSpec.describe Sms77, 'pricing' do
+  it 'returns all countries pricing as json' do
+    stub = {
+      countCountries: 1,
+      countNetworks: 4,
+      countries: [
+        {
+          countryCode: 'AT',
+          countryName: 'Austria',
+          countryPrefix: '43',
+          networks: [
+            {
+              comment: '',
+              features: [],
+              mcc: '232',
+              mncs: ['02'],
+              networkName: 'A1 Telekom Austria',
+              price: 0.075
+            },
+            {
+              comment: '',
+              features: %w[alpha Numeric dlr sc],
+              mcc: '232',
+              mncs: ['01'],
+              networkName: 'A1 Telekom Austria (A1.net)',
+              price: 0.075
+            }
+          ]
+        }
+      ]
+    }
+
+    Helper.stubs.get("/api/#{Sms77::Endpoint::PRICING}") { |_env| [200, {}, JSON.generate(stub)] } unless Helper.is_http
+
+    response = Helper.client.pricing
+    body = JSON.parse(response.body)
+    countries = body['countries']
+
+    expect(response.class).to eq(Faraday::Response)
+    expect(body).to be_kind_of(Hash)
+    expect(body['countCountries']).to be_kind_of(Integer)
+    expect(body['countNetworks']).to be_kind_of(Integer)
+    expect(countries).to be_kind_of(Array)
+
+    countries.each do |country|
+      networks = country['networks']
+
+      expect(country).to be_kind_of(Hash)
+      expect(country['countryCode']).to be_kind_of(String)
+      expect(country['countryName']).to be_kind_of(String)
+      expect(country['countryPrefix']).to be_kind_of(String)
+      expect(networks).to be_kind_of(Array)
+
+      networks.each do |network|
+        mncs = network['mncs']
+        features = network['features']
+
+        expect(network).to be_kind_of(Hash)
+        expect(network['mcc']).to be_kind_of(String)
+        expect(mncs).to be_kind_of(Array)
+        mncs.each do |mnc|
+          expect(mnc).to be_kind_of(String)
+        end
+        expect(network['networkName']).to be_kind_of(String)
+        expect(network['price']).to be_kind_of(Float)
+        expect(features).to be_kind_of(Array)
+        features.each do |feature|
+          expect(feature).to be_kind_of(String)
+        end
+        expect(network['comment']).to be_kind_of(String)
+      end
+    end
+  end
+end

data/spec/sms77/sms_spec.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'sms77/endpoint'
+require 'sms77/contacts_action'
+
+RSpec.describe Sms77, 'sms' do
+  $text = 'Your glasses are ready for pickup.'
+
+  def assert_response(response)
+    if response.is_a?(String)
+      id, name, number = response.split("\n")
+    else
+      id = response['ID']
+      name = response['Name']
+      number = response['Number']
+    end
+
+    expect(Integer(id)).to be_an_instance_of(Integer)
+    expect(name.to_f).to be_an_instance_of(Float) if id != ''
+    expect(number.to_f).to be_an_instance_of(Float)
+  end
+
+  def request(stub, extra_params = {})
+    params = {
+      from: Helper.virtual_inbound_nr_eplus,
+      text: $text,
+      to: Helper.virtual_inbound_nr_eplus
+    }.merge(extra_params)
+
+    Helper.request(Sms77::Endpoint::SMS, params, stub)
+  end
+
+  it 'sends a single sms and returns success code' do
+    expect(request(100)).to be_kind_of(Integer)
+  end
+
+  it 'sends a single sms and returns detailed text response' do
+    stub = <<~TEXT
+      100
+      Verbucht: 0
+      Preis: 0.075
+      Guthaben: 4.575
+      Text: Your glasses are ready for pickup.
+      SMS-Typ: direct
+      Flash SMS: false
+      Encoding: gsm
+      GSM0338: true
+      Debug: true
+    TEXT
+
+    body = request(stub, { details: 1 })
+
+    expect(body).to be_kind_of(String)
+
+    code, booked, cost, balance, text, type, flash, encoding, gsm0338, debug = body.split("\n")
+
+    expect(code).to be_kind_of(String)
+    expect(booked.split(':').last.to_f).to be_kind_of(Float)
+    expect(cost.split(':').last.to_f).to be_kind_of(Float)
+    expect(balance.split(':').last.to_f).to be_kind_of(Float)
+    expect(text.split(':').last.strip!).to eq($text)
+    expect(type.split(':').last.strip!).to eq('direct')
+    expect(flash.split(':').last.strip!).to eq('false')
+    expect(encoding.split(':').last.strip!).to eq('gsm')
+    expect(gsm0338.split(':').last.strip!).to eq('true')
+    expect(debug.split(':').last.strip!).to eq('true')
+  end
+
+  it 'sends a single sms and returns json response' do
+    stub = {
+      success: '100',
+      total_price: 0,
+      balance: 4.5,
+      debug: 'true',
+      sms_type: 'direct',
+      messages: [{ id: nil,
+                   sender: '491771783130',
+                   recipient: '491771783130',
+                   text: 'Your glasses are ready for pickup.',
+                   encoding: 'gsm',
+                   parts: 1,
+                   price: 0,
+                   success: true,
+                   error: nil,
+                   error_text: nil }]
+    }
+
+    body = request(stub, { json: 1 })
+
+    expect(body).to be_kind_of(Hash)
+
+    expect(body['success']).to be_kind_of(String)
+    expect(body['total_price']).to be_numeric
+    expect(body['balance']).to be_kind_of(Float)
+    expect(body['debug']).to be_kind_of(String)
+    expect(body['sms_type']).to eq('direct')
+    expect(body['messages']).to be_kind_of(Array)
+    body['messages'].each do |message|
+      expect(message).to be_kind_of(Hash)
+    end
+  end
+end

data/spec/sms77/validate_for_voice_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'sms77/endpoint'
+require 'json'
+
+RSpec.describe Sms77, 'validate_for_voice' do
+  it 'returns caller id information' do
+    number = '491771783130'
+    callback_host = Helper.is_http ? `curl http://ipecho.net/plain` : '127.0.0.1'
+    callback = "#{callback_host}/callback.php"
+    stub = { success: true }
+
+    body = Helper.request(Sms77::Endpoint::VALIDATE_FOR_VOICE, { number: number, callback: callback }, stub)
+
+    expect(body).to be_kind_of(Hash)
+    expect(body['success']).to be_boolean
+  end
+end

data/spec/sms77/voice_spec.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'sms77/endpoint'
+require 'sms77/contacts_action'
+
+RSpec.describe Sms77, 'voice' do
+  def assert_response(response)
+    expect(response).to be_kind_of(String)
+
+    code, id, cost = response.split("\n")
+
+    expect(Integer(code)).to be_an_instance_of(Integer)
+    expect(id.to_f).to be_an_instance_of(Float) if id != ''
+    expect(cost.to_f).to be_an_instance_of(Float)
+  end
+
+  def request(text, extra_params = {})
+    stub = <<~TEXT
+      301
+      
+      0.1
+    TEXT
+
+    params = { to: Helper.virtual_inbound_nr_eplus, text: text, from: Helper.virtual_inbound_nr_eplus }
+               .merge(extra_params)
+
+    Helper.request(Sms77::Endpoint::VOICE, params, stub)
+  end
+
+  it 'calls a number with text input' do
+    assert_response(request('Your glasses are ready for pickup.'))
+  end
+
+  it 'calls a number with xml input' do
+    text = <<~XML
+      <?xml version="1.0" encoding="UTF-8"?>
+      <Response>
+        <Say voice="woman" language="en-EN">
+          Your glasses are ready for pickup.
+        </Say>
+        <Record maxlength="20" />
+      </Response>
+    XML
+
+    assert_response(request(text, { xml: 1 }))
+  end
+end

data/spec/sms77_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Sms77 do
+  it 'has a version number' do
+    expect(Sms77::VERSION).not_to be nil
+  end
+
+  context 'failing authentication' do
+    it 'balance' do
+      expect { Sms77::Client.new('NotExistingApiKey', nil) }.to raise_error(RuntimeError)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+
+require 'sms77'
+
+RSpec::Matchers.define :be_boolean do
+  match do |value|
+    [true, false].include? value
+  end
+end
+
+RSpec::Matchers.define :be_numeric do
+  match do |value|
+    return true if value.is_a?(Integer)
+
+    value.scan(/\D/).empty?
+  end
+end
+
+class Helper
+  @is_http = ENV.key?('TEST_HTTP')
+  @stubs = Faraday::Adapter::Test::Stubs.new
+  @conn = Faraday.new(Sms77::Client::BASE_URI) do |b|
+    b.adapter(:test, @stubs) unless @is_http
+  end
+  @client = Sms77::Client.new(ENV['SMS77_DUMMY_API_KEY'], @conn, 'ruby-test')
+  @virtual_inbound_nr_eplus = '+491771783130'
+
+  def self.request(endpoint, params, stub, extra_params = {})
+    path = "#{Sms77::Client::API_SUFFIX}#{endpoint}"
+
+    # TODO-START: determine request method to avoid multiple useless stubs
+    @stubs.get(path) { |_env| [200, {}, JSON.generate(stub)] } unless @is_http
+    @stubs.post(path) { |_env| [200, {}, JSON.generate(stub)] } unless @is_http
+    # TODO-END
+
+    response = @client.method(endpoint).call(params.merge(extra_params))
+
+    raise 'unexpected response' unless Faraday::Response == response.class
+
+    body = response.body
+
+    begin
+      body = JSON.parse(body)
+    rescue StandardError
+      # Ignored
+    end
+
+    body
+  end
+
+  class << self
+    attr_reader :is_http, :stubs, :conn, :client, :virtual_inbound_nr_eplus
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: sms77
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- sms77 e.K.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Send SMS & Text2Voice messages via the Sms77.io SMS Gateway.
+email:
+- support@sms77.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sms77.rb
+- lib/sms77/client.rb
+- lib/sms77/contacts_action.rb
+- lib/sms77/endpoint.rb
+- lib/sms77/header.rb
+- lib/sms77/lookup_type.rb
+- lib/sms77/version.rb
+- sms77.gemspec
+- spec/sms77/balance_spec.rb
+- spec/sms77/contacts_spec.rb
+- spec/sms77/http_spec.rb
+- spec/sms77/lookup_spec.rb
+- spec/sms77/pricing_spec.rb
+- spec/sms77/sms_spec.rb
+- spec/sms77/validate_for_voice_spec.rb
+- spec/sms77/voice_spec.rb
+- spec/sms77_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sms77io/ruby-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.5
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Official Sms77.io API Client for Ruby
+test_files: []