seven_api 0.5.0 → 0.6.1

data/spec/seven_api/lookup_spec.rb

@@ -1,179 +1,197 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'seven_api/endpoint'
-require 'seven_api/lookup'
-require 'seven_api/resources/lookup'
-require 'json'
-
-RSpec.describe SevenApi, 'lookup' do
-  def request(type, stub, extra_args = {})
-    helper = Helper.new(SevenApi::Resources::Lookup)
-    helper.request(
-      helper.resource.method(type),
-      stub,
-      { number: '+491771783130' }.merge(extra_args))
-  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
-    }
-
-    res = request(SevenApi::Lookup::Type::FORMAT, stub, { number: '' })
-
-    expect(res).to be_a(Hash)
-    expect(res[: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(SevenApi::Lookup::Type::FORMAT, stub)
-
-    expect(body).to be_a(Hash)
-    expect(body[:carrier]).to be_a(String)
-    expect(body[:country_code]).to be_a(String)
-    expect(body[:country_iso]).to be_a(String)
-    expect(body[:country_name]).to be_a(String)
-    expect(body[:international]).to be_a(String)
-    expect(body[:international_formatted]).to be_a(String)
-    expect(body[:national]).to be_a(String)
-    expect(body[:network_type]).to be_a(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(SevenApi::Lookup::Type::CNAM, stub)
-
-    expect(body).to be_a(Hash)
-    expect(body[:code]).to be_a(String)
-    expect(body[:name]).to be_a(String)
-    expect(body[:number]).to be_a(String)
-    expect(body[:success]).to be_a(String)
-  end
-
-  it 'returns MNP details as text' do
-    body = request(SevenApi::Lookup::Type::MNP, 'eplus')
-
-    expect(body).to be_a(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(SevenApi::Lookup::Type::MNP, stub, { json: 1 })
-
-    expect(body).to be_a(Hash)
-    expect(body[:code]).to be_a(Integer)
-    expect(body[:price]).to be_a(Float)
-    expect(body[:mnp]).to be_a(Hash)
-    expect(body[:mnp][:country]).to be_a(String)
-    expect(body[:mnp][:international_formatted]).to be_a(String)
-    expect(body[:mnp][:isPorted]).to be_boolean
-    expect(body[:mnp][:mccmnc]).to be_a(String)
-    expect(body[:mnp][:national_format]).to be_a(String)
-    expect(body[:mnp][:network]).to be_a(String)
-    expect(body[:mnp][:number]).to be_a(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(SevenApi::Lookup::Type::HLR, stub)
-
-    expect(body).to be_a(Hash)
-    expect(body[:country_code]).to be_a(String)
-    expect(body[:country_name]).to be_a(String)
-    expect(body[:country_prefix]).to be_a(String)
-    assert_carrier(body[:current_carrier])
-    expect(body[:international_format_number]).to be_a(String)
-    expect(body[:international_formatted]).to be_a(String)
-    expect(body[:lookup_outcome]).to be_boolean
-    expect(body[:lookup_outcome_message]).to be_a(String)
-    expect(body[:national_format_number]).to be_a(String)
-    assert_carrier(body[:original_carrier])
-    expect(body[:status]).to be_boolean
-    expect(body[:status_message]).to be_a(String)
-    expect(body[:gsm_code]).to be_a(String)
-    expect(body[:gsm_message]).to be_a(String)
-    expect(body[:ported]).to be_a(String)
-    expect(body[:reachable]).to be_a(String)
-    expect(body[:roaming]).to be_a(String)
-    expect(body[:valid_number]).to be_a(String)
-  end
-
-  def assert_carrier(hash)
-    expect(hash).to be_a(Hash)
-    expect(hash[:country]).to be_a(String)
-    expect(hash[:name]).to be_a(String)
-    expect(hash[:network_code]).to be_a(String)
-    expect(hash[:network_type]).to be_a(String)
-  end
-end
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'seven_api/endpoint'
+require 'seven_api/lookup'
+require 'seven_api/resources/lookup'
+require 'json'
+
+RSpec.describe SevenApi, 'lookup' do
+  helper = Helper.new(SevenApi::Resources::Lookup)
+
+  def request(type, stub, params = { number: '+491771783130' })
+    helper.request(helper.resource.method(type), stub, params)
+  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
+    }
+    path = SevenApi::Resources::Lookup.const_get('PATHS')[:format]
+    res = helper.request(helper.resource.method(:format), stub, { number: '' }, path)
+
+    expect(res).to be_a(Hash)
+    expect(res[:success]).to match(false)
+  end
+
+  it 'returns number formatting details' 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
+    }
+    path = SevenApi::Resources::Lookup.const_get('PATHS')[:format]
+    body = helper.request(helper.resource.method(:format), stub, { number: '+491771783130' }, path)
+
+    assert_format(body)
+  end
+
+  it 'returns RCS lookup capabilities' do
+    stub = {
+      carrier: "O2",
+      country_code: "49",
+      country_iso: "DE",
+      country_name: "Germany",
+      international: "+49176123456789",
+      international_formatted: "+49 179 123456789",
+      national: "0176 12345679",
+      network_type: "mobile",
+      rcs_capabilities: %w[ACTION_CREATE_CALENDAR_EVENT ACTION_DIAL ACTION_OPEN_URL ACTION_SHARE_LOCATION ACTION_VIEW_LOCATION RICHCARD_CAROUSEL RICHCARD_STANDALONE],
+      success: true
+    }
+    path = SevenApi::Resources::Lookup.const_get('PATHS')[:rcs_capabilities]
+    body = helper.request(helper.resource.method(:rcs_capabilities), stub, { number: '+491771783130' }, path)
+
+    assert_format(body)
+    expect(body[:rcs_capabilities]).to be_a(Array)
+  end
+
+  it 'returns CNAM details' do
+    stub = {
+      code: '100',
+      name: 'GERMANY',
+      number: '+491771783130',
+      success: 'true'
+    }
+    path = SevenApi::Resources::Lookup.const_get('PATHS')[:cnam]
+    body = helper.request(helper.resource.method(:cnam), stub, { number: '+491771783130' }, path)
+
+    expect(body).to be_a(Hash)
+    expect(body[:code]).to be_a(String)
+    expect(body[:name]).to be_a(String)
+    expect(body[:number]).to be_a(String)
+    expect(body[:success]).to be_a(String)
+  end
+
+  it 'returns MNP details' 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
+    }
+    path = SevenApi::Resources::Lookup.const_get('PATHS')[:mnp]
+    body = helper.request(helper.resource.method(:mnp), stub, { number: '+491771783130' }, path)
+
+    expect(body).to be_a(Hash)
+    expect(body[:code]).to be_a(Integer)
+    expect(body[:price]).to be_a(Float)
+    expect(body[:mnp]).to be_a(Hash)
+    expect(body[:mnp][:country]).to be_a(String)
+    expect(body[:mnp][:international_formatted]).to be_a(String)
+    expect(body[:mnp][:isPorted]).to be_boolean
+    expect(body[:mnp][:mccmnc]).to be_a(String)
+    expect(body[:mnp][:national_format]).to be_a(String)
+    expect(body[:mnp][:network]).to be_a(String)
+    expect(body[:mnp][:number]).to be_a(String)
+    expect(body[:success]).to be_boolean
+  end
+
+  it 'returns HLR details' 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'
+    }
+    path = SevenApi::Resources::Lookup.const_get('PATHS')[:hlr]
+    body = helper.request(helper.resource.method(:hlr), stub, { number: '+491771783130' }, path)
+
+    expect(body).to be_a(Hash)
+    expect(body[:country_code]).to be_a(String)
+    expect(body[:country_name]).to be_a(String)
+    expect(body[:country_prefix]).to be_a(String)
+    assert_carrier(body[:current_carrier])
+    expect(body[:international_format_number]).to be_a(String)
+    expect(body[:international_formatted]).to be_a(String)
+    expect(body[:lookup_outcome]).to be_boolean
+    expect(body[:lookup_outcome_message]).to be_a(String)
+    expect(body[:national_format_number]).to be_a(String)
+    assert_carrier(body[:original_carrier])
+    expect(body[:status]).to be_boolean
+    expect(body[:status_message]).to be_a(String)
+    expect(body[:gsm_code]).to be_a(String)
+    expect(body[:gsm_message]).to be_a(String)
+    expect(body[:ported]).to be_a(String)
+    expect(body[:reachable]).to be_a(String)
+    expect(body[:roaming]).to be_a(String)
+    expect(body[:valid_number]).to be_a(String)
+  end
+
+  def assert_carrier(hash)
+    expect(hash).to be_a(Hash)
+    expect(hash[:country]).to be_a(String)
+    expect(hash[:name]).to be_a(String)
+    expect(hash[:network_code]).to be_a(String)
+    expect(hash[:network_type]).to be_a(String)
+  end
+
+  def assert_format(body)
+    expect(body).to be_a(Hash)
+    expect(body[:carrier]).to be_a(String)
+    expect(body[:country_code]).to be_a(String)
+    expect(body[:country_iso]).to be_a(String)
+    expect(body[:country_name]).to be_a(String)
+    expect(body[:international]).to be_a(String)
+    expect(body[:international_formatted]).to be_a(String)
+    expect(body[:national]).to be_a(String)
+    expect(body[:network_type]).to be_a(String)
+    expect(body[:success]).to be_boolean
+  end
+end

data/spec/seven_api/numbers_spec.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'seven_api/resources/numbers'
+
+dummy_number = {
+  "country": "DE",
+  "number": "49176123456789",
+  "friendly_name": "",
+  "billing": {
+    "fees": {
+      "setup": 19.9,
+      "basic_charge": 238.8,
+      "sms_mo": 0,
+      "voice_mo": 0
+    },
+    "payment_interval": "annually"
+  },
+  "features": {
+    "sms": true,
+    "a2p_sms": false,
+    "voice": true
+  },
+  "forward_sms_mo": {
+    "sms": {
+      "number": [
+        "4917612345678"
+      ],
+      "enabled": true
+    },
+    "email": {
+      "address": %w[j.doe@acme.inc john@doe.com],
+      "enabled": true
+    }
+  },
+  "expires": nil,
+  "created": "2024-01-31 17:06:27"
+}
+
+RSpec.describe SevenApi, 'numbers' do
+  $new_number_id = nil
+
+  def assert_new(response_body)
+    code = response_body[:return]
+    $new_number_id = response_body[:id]
+
+    expect(code).to be_numeric
+    expect($new_number_id).to be_an_instance_of(Integer)
+  end
+
+  def assert_number(number)
+    expect(number[:id]).to be_numeric
+    expect(number[:name]).to be_an_instance_of(String)
+  end
+
+  it 'returns available numbers' do
+    stub = {
+      availableNumbers: [
+        dummy_number,
+        dummy_number
+      ],
+    }
+
+    helper = Helper.new(SevenApi::Resources::Numbers)
+    body = helper.request(helper.resource.method(:available), stub)
+
+    expect(body).to be_a(Hash)
+    expect(body).to have_key(:availableNumbers)
+    expect(body[:availableNumbers]).to be_a(Array)
+
+    body[:availableNumbers].each do |number|
+      assert_number(number)
+    end
+  end
+
+  it 'returns active numbers' do
+    stub = {
+      availableNumbers: [
+        dummy_number,
+        dummy_number
+      ],
+    }
+
+    helper = Helper.new(SevenApi::Resources::Numbers)
+    body = helper.request(helper.resource.method(:active), stub)
+
+    expect(body).to be_a(Array)
+
+    body.each do |number|
+      assert_number(number)
+    end
+  end
+
+  it 'order a number' do
+    stub = dummy_number
+    helper = Helper.new(SevenApi::Resources::Numbers)
+    body = helper.request(helper.resource.method(:order), stub)
+
+    expect(body).to be_a(Hash)
+
+    assert_new(body)
+  end
+
+  it 'update a number' do
+    stub = dummy_number
+    helper = Helper.new(SevenApi::Resources::Numbers)
+    body = helper.request(helper.resource.method(:update), stub)
+
+    expect(body).to be_a(Hash)
+
+    assert_new(body)
+  end
+
+  it 'get a number' do
+    stub = dummy_number
+    helper = Helper.new(SevenApi::Resources::Numbers)
+    body = helper.request(helper.resource.method(:one[:number]), stub)
+
+    expect(body).to be_a(Hash)
+
+    assert_new(body)
+  end
+
+  it 'deletes a number' do
+    helper = Helper.new(SevenApi::Resources::Numbers)
+    body = helper.request(
+      helper.resource.method(:delete),
+      nil,
+      0
+    )
+
+    expect(body).to be_a(Hash)
+    expect(body[:return]).to be_a(String)
+  end
+end

data/spec/seven_api/pricing_spec.rb

@@ -1,76 +1,76 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'seven_api/resources/pricing'
-
-RSpec.describe SevenApi, '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 = Helper.new(SevenApi::Resources::Pricing)
-    res = helper.request(helper.resource.method(:retrieve), stub)
-    countries = res[:countries]
-
-    expect(res).to be_a(Hash)
-    expect(res[:countCountries]).to be_a(Integer)
-    expect(res[:countNetworks]).to be_a(Integer)
-    expect(countries).to be_a(Array)
-
-    countries.each do |country|
-      networks = country[:networks]
-
-      expect(country).to be_a(Hash)
-      expect(country[:countryCode]).to be_a(String)
-      expect(country[:countryName]).to be_a(String)
-      expect(country[:countryPrefix]).to be_a(String)
-      expect(networks).to be_a(Array)
-
-      networks.each do |network|
-        mncs = network[:mncs]
-        features = network[:features]
-
-        expect(network).to be_a(Hash)
-        expect(network[:mcc]).to be_a(String)
-        expect(mncs).to be_a(Array)
-        mncs.each do |mnc|
-          expect(mnc).to be_a(String)
-        end
-        expect(network[:networkName]).to be_a(String)
-        expect(network[:price]).to be_a(Float)
-        expect(features).to be_a(Array)
-        features.each do |feature|
-          expect(feature).to be_a(String)
-        end
-        expect(network[:comment]).to be_a(String)
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'seven_api/resources/pricing'
+
+RSpec.describe SevenApi, '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 = Helper.new(SevenApi::Resources::Pricing)
+    res = helper.request(helper.resource.method(:retrieve), stub)
+    countries = res[:countries]
+
+    expect(res).to be_a(Hash)
+    expect(res[:countCountries]).to be_a(Integer)
+    expect(res[:countNetworks]).to be_a(Integer)
+    expect(countries).to be_a(Array)
+
+    countries.each do |country|
+      networks = country[:networks]
+
+      expect(country).to be_a(Hash)
+      expect(country[:countryCode]).to be_a(String)
+      expect(country[:countryName]).to be_a(String)
+      expect(country[:countryPrefix]).to be_a(String)
+      expect(networks).to be_a(Array)
+
+      networks.each do |network|
+        mncs = network[:mncs]
+        features = network[:features]
+
+        expect(network).to be_a(Hash)
+        expect(network[:mcc]).to be_a(String)
+        expect(mncs).to be_a(Array)
+        mncs.each do |mnc|
+          expect(mnc).to be_a(String)
+        end
+        expect(network[:networkName]).to be_a(String)
+        expect(network[:price]).to be_a(Float)
+        expect(features).to be_a(Array)
+        features.each do |feature|
+          expect(feature).to be_a(String)
+        end
+        expect(network[:comment]).to be_a(String)
+      end
+    end
+  end
+end