seven_api 0.5.0 → 0.6.0

data/lib/seven_api/resources/numbers.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'seven_api/resource'
+
+# This module exposes the methods for communicating with the API endpoint /numbers.
+module SevenApi::Resources
+  class Groups < SevenApi::Resource
+    @endpoint = SevenApi::Endpoint::NUMBERS
+    @http_methods = {
+      :active => :get,
+      :available => :get,
+      :order => :post,
+      :one => :get,
+      :update => :patch,
+    }
+
+    # Retrieve active phone numbers
+    # read more: https://docs.seven.io/en/rest-api/endpoints/numbers#active-numbers
+    # @return [Array]
+    def active
+      request({}, {}, '/active')
+    end
+
+
+    # Retrieve available phone numbers
+    # read more: https://docs.seven.io/en/rest-api/endpoints/numbers#available-numbers
+    # @return [Hash]
+    def available
+      request(params, {}, '/available')
+    end
+
+    # Order a phone number
+    # read more: https://docs.seven.io/en/rest-api/endpoints/numbers#order-a-number
+    # @param number [String]
+    # @param payment_interval [String]
+    # @return [Hash]
+    def order(number, payment_interval = PaymentInterval.ASCENDING)
+      payload = {
+        number => number,
+        payment_interval => payment_interval,
+      }
+      request(payload, {}, '/order')
+    end
+
+    # Delete a number
+    # read more: https://docs.seven.io/en/rest-api/endpoints/numbers#delete-number
+    # @param number [String]
+    # @return [Hash]
+    def delete(number, delete_immediately = false)
+      request({}, {delete_immediately => delete_immediately}, "/active/#{number}")
+    end
+
+    # Retrieve a number
+    # read more: https://docs.seven.io/en/rest-api/endpoints/numbers#get-number
+    # @param number [String]
+    # @return [Hash]
+    def one(number)
+      request({}, {}, "/active/#{number}")
+    end
+
+    # Update a number
+    # read more: https://docs.seven.io/en/rest-api/endpoints/numbers#update-number
+    # @param number [String]
+    # @param params [Hash]
+    # @return [Hash]
+    def update(number, params)
+      request(params, {}, "/active/#{number}")
+    end
+  end
+end

data/lib/seven_api/resources/pricing.rb

@@ -11,7 +11,7 @@ module SevenApi::Resources
     }
 
     # Retrieve pricing
-    # read more: https://www.seven.io/en/docs/gateway/http-api/pricing/
+    # read more: https://docs.seven.io/en/rest-api/endpoints/account#prices
     # @param params [Hash]
     # @return [Hash,String]
     def retrieve(params = {})

data/lib/seven_api/resources/rcs.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'seven_api/resource'
+
+# This module exposes the methods for communicating with the API endpoint /rcs.
+module SevenApi::Resources
+  class Rcs < SevenApi::Resource
+    @endpoint = SevenApi::Endpoint::RCS
+    @http_methods = {
+      :delete => :delete,
+      :dispatch => :post,
+      :event => :post
+    }
+
+    # Send RCS
+    # read more: https://docs.seven.io/en/rest-api/endpoints/rcs#send-rcs
+    # @param params [Hash]
+    # @return [Hash]
+    def dispatch(params)
+      request(params, {}, '/messages')
+    end
+
+    # Delete scheduled RCS
+    # read more: https://docs.seven.io/en/rest-api/endpoints/rcs#delete-rcs
+    # @param params [Hash]
+    # @return [Hash]
+    def delete(params)
+      request({}, {}, "/messages/#{params[:id]}")
+    end
+
+    # Send Event
+    # read more: https://docs.seven.io/en/rest-api/endpoints/rcs#events
+    # @param params [Hash]
+    # @return [Hash]
+    def event(params)
+      request(params, {}, '/events')
+    end
+  end
+end

data/lib/seven_api/resources/sms.rb

@@ -11,7 +11,7 @@ module SevenApi::Resources
     }
 
     # Send SMS
-    # read more: https://www.seven.io/en/docs/gateway/http-api/sms-dispatch/
+    # read more: https://docs.seven.io/en/rest-api/endpoints/sms#send-sms
     # @param params [Hash]
     # @return [Integer,String,Hash]
     def retrieve(params)

data/lib/seven_api/resources/status.rb

@@ -11,7 +11,7 @@ module SevenApi::Resources
     }
 
     # Retrieve delivery report for a SMS
-    # read more: https://www.seven.io/en/docs/gateway/http-api/status-reports/#query-delivery-reports
+    # read more: https://docs.seven.io/en/rest-api/endpoints/status-reports#query-status-reports
     # @param params [Hash]
     # @return [String]
     def retrieve(params)

data/lib/seven_api/resources/subaccounts.rb

@@ -16,7 +16,7 @@ module SevenApi::Resources
     }
 
     # Create a subaccount
-    # read more: https://www.seven.io/en/docs/gateway/http-api/subaccounts/#create-subaccount
+    # read more: https://docs.seven.io/en/rest-api/endpoints/subaccounts#create-subaccount
     # @param params [Hash]
     # @return [Hash]
     def create(params)
@@ -26,7 +26,7 @@ module SevenApi::Resources
     end
 
     # Delete a subaccount
-    # read more: https://www.seven.io/en/docs/gateway/http-api/subaccounts/#delete-subaccount
+    # read more: https://docs.seven.io/en/rest-api/endpoints/subaccounts#delete-a-subaccount
     # @param params [Hash]
     # @return [Hash]
     def delete(params)
@@ -36,7 +36,7 @@ module SevenApi::Resources
     end
 
     # Retrieve all subaccounts
-    # read more: https://www.seven.io/en/docs/gateway/http-api/subaccounts/#read-subaccounts
+    # read more: https://docs.seven.io/en/rest-api/endpoints/subaccounts#list-subaccounts
     # @param params [Hash]
     # @return [Hash]
     def read(params = {})
@@ -44,7 +44,7 @@ module SevenApi::Resources
     end
 
     # Transfer credits to a subaccount
-    # read more: https://www.seven.io/en/docs/gateway/http-api/subaccounts/#transfer-credit
+    # read more: https://docs.seven.io/en/rest-api/endpoints/subaccounts#manual-credit-transfer
     # @param params [Hash]
     # @return [Hash]
     def transfer_credits(params)
@@ -54,7 +54,7 @@ module SevenApi::Resources
     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
+    # read more: https://docs.seven.io/en/rest-api/endpoints/subaccounts#automatic-credit-transfer
     # @param params [Hash]
     # @return [Hash]
     def update(params)

data/lib/seven_api/resources/validate_for_voice.rb

@@ -11,7 +11,7 @@ module SevenApi::Resources
     }
 
     # 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/
+    # read more: https://docs.seven.io/en/rest-api/endpoints/sender-identifiers#validate-sender-for-voice
     # @param params [Hash]
     # @return [Hash]
     def retrieve(params)

data/lib/seven_api/resources/voice.rb

@@ -11,7 +11,7 @@ module SevenApi::Resources
     }
 
     # Convert text to speech, call number and read voice message out loud.
-    # read more: https://www.seven.io/en/docs/gateway/http-api/voice/
+    # read more: https://docs.seven.io/en/rest-api/endpoints/voice#send-voice-call
     # @param params [Hash]
     # @return [String,Hash]
     def send(params)

data/lib/seven_api/version.rb

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

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

data/spec/seven_api/analytics_spec.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'seven_api/resources/analytics'
+
+RSpec.describe SevenApi, 'analytics' do
+  base_stub = {
+    hlr: 0,
+    inbound: 72,
+    mnp: 0,
+    rcs: 1,
+    sms: 145,
+    usage_eur: 0.208,
+    voice: 0
+  }
+  helper = Helper.new(SevenApi::Resources::Analytics)
+
+  it 'returns an array with analytics grouped by country' do
+    stub = [base_stub.merge({ country: "DE" })]
+    params = { country: "DE" }
+    fn = helper.resource.method(:by_country)
+    path = SevenApi::Resources::Analytics.const_get('PATHS')[:by_country]
+    entries = helper.request(fn, stub, params, path)
+    expect(entries).to be_a(Array)
+  end
+
+  it 'returns an array with analytics grouped by date' do
+    stub = [base_stub.merge({ date: "2020-05-13" })]
+    fn = helper.resource.method(:by_date)
+    path = SevenApi::Resources::Analytics.const_get('PATHS')[:by_date]
+    entries = helper.request(fn, stub, nil, path)
+    expect(entries).to be_a(Array)
+  end
+
+  it 'returns an array with analytics grouped by label' do
+    stub = [base_stub.merge({ label: "Label" })]
+    fn = helper.resource.method(:by_label)
+    path = SevenApi::Resources::Analytics.const_get('PATHS')[:by_label]
+    entries = helper.request(fn, stub, nil, path)
+    expect(entries).to be_a(Array)
+  end
+
+  it 'returns an array with analytics grouped by subaccount' do
+    stub = [base_stub.merge({ account: "Subaccount" })]
+    path = SevenApi::Resources::Analytics.const_get('PATHS')[:by_subaccount]
+    entries = helper.request(helper.resource.method(:by_subaccount), stub, nil, path)
+    expect(entries).to be_a(Array)
+  end
+end

data/spec/seven_api/balance_spec.rb

@@ -6,7 +6,13 @@ 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)
+    stub = {
+      amount: 44.631,
+      currency: "EUR"
+    }
+    balance = helper.request(helper.resource.method(:retrieve), stub)
+    expect(balance).to be_a(Hash)
+    expect(balance[:amount]).to be_a(Float)
+    expect(balance[:currency]).to be_a(String)
   end
 end

data/spec/seven_api/contacts_spec.rb

@@ -4,76 +4,70 @@ require 'spec_helper'
 require 'seven_api/contacts'
 require 'seven_api/resources/contacts'
 
+dummy_contact = {
+  "id": 12876882,
+  "avatar": "https://static.seven.io/uploads/contact_images/4A000c0d4e9431F483090dE8D13F3806.jpg",
+  "validation": {
+    "state": nil,
+    "timestamp": nil
+  },
+  "initials": {
+    "initials": "",
+    "color": "EEE0C9"
+  },
+  "properties": {
+    "address": nil,
+    "birthday": nil,
+    "city": nil,
+    "email": nil,
+    "firstname": nil,
+    "home_number": nil,
+    "lastname": nil,
+    "mobile_number": nil,
+    "notes": nil,
+    "postal_code": nil,
+  },
+  "groups": [
+  ],
+  "created": "2024-01-09 13:12:48"
+}
+
 RSpec.describe SevenApi, 'contacts' do
-  $new_contact_id = nil
+  $new_number_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
+      code, $new_number_id = response_body.split("\n")
+      $new_number_id = $new_number_id.to_i
     else
       code = response_body[:return]
-      $new_contact_id = response_body[:id]
+      $new_number_id = response_body[:id]
     end
 
     expect(code).to be_numeric
-    expect($new_contact_id).to be_an_instance_of(Integer)
+    expect($new_number_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
+    expect(contact[:id]).to be_numeric
   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' }
-    ]
+  it 'returns all contacts' do
+    stub = {
+      data: [
+        dummy_contact,
+        dummy_contact
+      ],
+      pagingMetadata: {
+        count: 30,
+        has_more: true,
+        offset: 0,
+        total: 20013
+      },
+    }
 
     helper = Helper.new(SevenApi::Resources::Contacts)
-    body = helper.request(helper.resource.method(:read), stub, { json: true })
+    body = helper.request(helper.resource.method(:all), stub)
 
     expect(body).to be_a(Array)
 
@@ -82,28 +76,10 @@ RSpec.describe SevenApi, 'contacts' do
     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
+    stub = dummy_contact
     helper = Helper.new(SevenApi::Resources::Contacts)
-    body = helper.request(helper.resource.method(:write), { id: 4868401, return: '152' }, { json: true })
+    body = helper.request(helper.resource.method(:create), stub)
 
     expect(body).to be_a(Hash)
 
@@ -114,13 +90,8 @@ RSpec.describe SevenApi, 'contacts' do
     helper = Helper.new(SevenApi::Resources::Contacts)
     body = helper.request(
       helper.resource.method(:delete),
-      {
-        return: '152'
-      },
-      {
-        id: $new_contact_id,
-        json: true,
-      }
+      nil,
+      0
     )
 
     expect(body).to be_a(Hash)

data/spec/seven_api/groups_spec.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'seven_api/resources/groups'
+
+dummy_group = {
+  "created": "2023-12-21 21:59:53",
+  "id": 17923,
+  "members_count": 543,
+  "name": "Group 1",
+}
+
+RSpec.describe SevenApi, 'groups' 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_group(group)
+    expect(group[:id]).to be_numeric
+    expect(group[:name]).to be_an_instance_of(String)
+  end
+
+  it 'returns all groups' do
+    stub = {
+      data: [
+        dummy_group,
+        dummy_group
+      ],
+      pagingMetadata: {
+        count: 30,
+        has_more: true,
+        offset: 0,
+        total: 20013
+      },
+    }
+
+    helper = Helper.new(SevenApi::Resources::Groups)
+    body = helper.request(helper.resource.method(:all), stub)
+
+    expect(body).to be_a(Array)
+
+    body.each do |group|
+      assert_group(group)
+    end
+  end
+
+  it 'creates a group and returns its ID' do
+    stub = dummy_group
+    helper = Helper.new(SevenApi::Resources::Groups)
+    body = helper.request(helper.resource.method(:create), stub)
+
+    expect(body).to be_a(Hash)
+
+    assert_new(body)
+  end
+
+  it 'deletes a group with given ID' do
+    helper = Helper.new(SevenApi::Resources::Groups)
+    body = helper.request(
+      helper.resource.method(:delete),
+      nil,
+      0
+    )
+
+    expect(body).to be_a(Hash)
+    expect(body[:return]).to be_a(String)
+  end
+end