SWI-1771 Add Unit Tests (#103)

* update spec and use 6.6

* changes we'd need to automate

* newline in readme

* remove config tests

* revert config back to working version

* regenerate with v6.5.0

* fix other files

* dont try to clean up calls since voice api is slow

* update spec

* add custom templates and update readme badge

* update test workflow name

* add openapitools

* add sdk update workflow

* add config test file and fix it

* update config test

* update integration tests

* Revert "update integration tests"

This reverts commit 77545d9.

* add client option to rakefile

* update version logic and ignore file

* remove unnecessary env vars from build wf

* revert version change

* remove unnecessary spec_helper imports

* lots of small changes based on rubocop linting

* update custom templates

* add rubocop badge to README

* add gem version badge to readme

* remove unnecessary deploy action

* update codeowners

* update workflows

* add gem version env var to test wfs

* remove newlines from bxml tests

* unit tests for acc stats

* comment

* fix eventTime data type

* answer callback tests and improve

* bridge callback and improve

* bridge target

* enum tests

* test desc

* delete unused spec files for unit tests

* update message time to be date-time

* add suite of encompassing unit tests

* update gitignore

* fix small logic error in bxml library

* calls_api unit tests

* remove unnecessary require

* update calls tests to be better and add conferences tests

* add webmock

* move 4xx tests to client suite

* skip all integration tests

* skip 4xx tests for now (TODO: fix these)

* rubocop linting for calls and conferences

* add comment to document test skips

* spacing

* fix hashes

* media tests

* remove unnecessary flag from media integration

* rubocop doesnt like my newline

* add argument error tests to media

* reorganizing

* recordings tests

* update list message item receive time

* messages tests

* add argument error tests to messages

* fix expects

* update messages

* mfa tests

* i can test basic auth in the client, not needed in apis

* assert arrays

* be_a -> be_instance_of

* tnlookup tests

* statistics tests

* add gems to Gemfile and template

* bring back statistics integration tests

* bring back mfa

* remove json dep

* tnlookup

* enforce single quotes

* more quotes changes

* single quotes

* media

* add string interpolation rule

* quotes in tests

* dont do config

* exclude files from rubocop

* ignore rubocop

* messages

* calls

* newline

* assertion cleanup

* conferences

* consistency

* recordings

* update model tests

* start on client tests

* configuration tests

* small changes

* update openapi-generator-ignore to ignore all tests

* update error checking

* error checking

* lots of client tests

* lowercase require?

* use @uri

* refactor to use let

* use let for rest of unit tests

* use let

* final client tests

* use let in integration tests

* rubocop save me

* rubocop newlines around blocks

* add ApiError tests

* no longer need to install hub

* update unit tests

* finalize workflow

* add limitTotalCount (new msg param)

Author: ckoegel

.github/workflows/update-sdk.yml

@@ -41,7 +41,7 @@ jobs:
         id: jira
         run: |
           JIRA_KEY=$(jq -r '.key' <<< $(curl -s -u $JIRA_USERNAME:$JIRA_TOKEN \
-          -X POST https://415a76a1898d1ab9952165e173353bb1.m.pipedream.net \
+          -X POST https://bandwidth-jira.atlassian.net/rest/api/2/issue \
           -H "Content-Type: application/json" \
           --data-binary @- << EOF
           {
@@ -102,8 +102,6 @@ jobs:
       - name: Open Pull Request
         if: steps.build.outputs.changes
         run: |
-          sudo apt update
-          sudo apt-get install -y hub
-          hub pull-request -b Bandwidth:main -h Bandwidth:${{ steps.jira.outputs.jira-key }} -m '${{ steps.jira.outputs.jira-key }} Update SDK Based on Recent Spec Changes' -m 'Auto-generated by Update SDK Workflow'
+          gh pr create -B main -H Bandwidth:${{ steps.jira.outputs.jira-key }} -t '${{ steps.jira.outputs.jira-key }} Update SDK Based on Recent Spec Changes' -b 'Auto-generated by Update SDK Workflow'
         env:
           GITHUB_TOKEN: ${{ env.DX_GITHUB_TOKEN }}

.gitignore

@@ -37,3 +37,5 @@ Gemfile.lock
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+
+.DS_Store

.openapi-generator-ignore

@@ -1,8 +1,7 @@
 # OpenAPI Generator Ignore
 # Generated by openapi-generator https://github.com/openapitools/openapi-generator
 
-/spec/spec_helper.rb
-/spec/configuration_spec.rb
-/spec/api_client_spec.rb
+/spec/**
 Rakefile
 .gitignore
+.rubocop.yml

.openapi-generator/FILES

@@ -1,6 +1,5 @@
 .gitlab-ci.yml
 .rspec
-.rubocop.yml
 .travis.yml
 Gemfile
 README.md

.rubocop.yml

@@ -40,6 +40,9 @@ Layout/EmptyLinesAroundMethodBody:
 Layout/EmptyLinesAroundModuleBody:
   Enabled: true
 
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: true
+
 Layout/FirstArgumentIndentation:
   Enabled: true
 
@@ -108,9 +111,17 @@ Layout/SpaceInsideParens:
   Enabled: true
 
 # Check quotes usage according to lint rule below.
-#Style/StringLiterals:
-#  Enabled: true
-#  EnforcedStyle: single_quotes
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+  Exclude:
+    - lib/bandwidth-sdk/api_client.rb
+    - lib/bandwidth-sdk/configuration.rb
+
+#Check quotes inside the string interpolation.
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes
 
 # Detect hard tabs, no hard tabs.
 Layout/IndentationStyle:

Gemfile

@@ -6,4 +6,6 @@ group :development, :test do
   gem 'rake', '~> 13.0.1'
   gem 'pry-byebug'
   gem 'rubocop', '~> 1.52.0'
+  gem 'webmock', '~> 3.18.0'
+  gem 'simplecov', '~> 0.21.2'
 end

Rakefile

@@ -1,4 +1,4 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
 begin
   require 'rspec/core/rake_task'

bandwidth-sdk.gemspec

@@ -12,20 +12,20 @@ OpenAPI Generator version: 6.5.0
 
 =end
 
-$:.push File.expand_path("../lib", __FILE__)
-require "bandwidth-sdk/version"
+$:.push File.expand_path('../lib', __FILE__)
+require 'bandwidth-sdk/version'
 
 Gem::Specification.new do |s|
-  s.name        = "bandwidth-sdk"
+  s.name        = 'bandwidth-sdk'
   s.version     = Bandwidth::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Bandwidth"]
-  s.email       = ["[email protected]"]
-  s.homepage    = "https://github.com/Bandwidth/ruby-sdk"
-  s.summary     = "Bandwidth Ruby SDK"
-  s.description = "The official client SDK for Bandwidth's Voice, Messaging, MFA, and WebRTC APIs"
-  s.license     = "MIT"
-  s.required_ruby_version = ">=2.7"
+  s.authors     = ['Bandwidth']
+  s.email       = ['[email protected]']
+  s.homepage    = 'https://github.com/Bandwidth/ruby-sdk'
+  s.summary     = 'Bandwidth Ruby SDK'
+  s.description = 'The official client SDK for Bandwidth's Voice, Messaging, MFA, and WebRTC APIs'
+  s.license     = 'MIT'
+  s.required_ruby_version = '>=2.7'
 
   s.add_runtime_dependency 'faraday', '>= 1.0.1', '< 3.0'
   s.add_runtime_dependency 'faraday-multipart'
@@ -36,5 +36,5 @@ Gem::Specification.new do |s|
   s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
   s.test_files    = `find spec/*`.split("\n")
   s.executables   = []
-  s.require_paths = ["lib"]
+  s.require_paths = ['lib']
 end

bandwidth.yml

@@ -171,6 +171,7 @@ paths:
         - $ref: '#/components/parameters/sort'
         - $ref: '#/components/parameters/pageToken'
         - $ref: '#/components/parameters/limit'
+        - $ref: '#/components/parameters/limitTotalCount'
       responses:
         '200':
           $ref: '#/components/responses/listMessagesResponse'
@@ -1237,7 +1238,9 @@ components:
       properties:
         totalCount:
           type: integer
-          description: Total number of messages matched by the search.
+          description: >-
+            The total number of messages matched by the search. When the request
+            has limitTotalCount set to true this value is limited to 10,000.
           example: 100
         pageInfo:
           $ref: '#/components/schemas/pageInfo'
@@ -1281,6 +1284,7 @@ components:
           example: 9902
         receiveTime:
           type: string
+          format: date-time
           description: The ISO 8601 datetime of the message.
           example: 2020-04-07T14:03:07.000Z
         carrierName:
@@ -1411,6 +1415,7 @@ components:
           example: 93de2206-9669-4e07-948d-329f4b722ee2
         time:
           type: string
+          format: date-time
           description: The datetime stamp of the message in ISO 8601
           example: 2022-09-14T18:20:16.000Z
         segmentCount:
@@ -3860,10 +3865,12 @@ components:
       example: bridgeComplete
     eventTime:
       type: string
+      format: date-time
       description: >-
         The approximate UTC date and time when the event was generated by the
         Bandwidth server, in ISO 8601 format. This may not be exactly the time
         of event execution.
+      example: '2022-06-17T22:19:40.375Z'
     accountId:
       type: string
       description: The user account associated with the call.
@@ -4952,6 +4959,19 @@ components:
       schema:
         type: integer
       example: 50
+    limitTotalCount:
+      in: query
+      name: limitTotalCount
+      required: false
+      description: >-
+        When set to true, the response's totalCount field will have a maximum
+        value of 10,000. When set to false, or excluded, this will give an
+        accurate totalCount of all messages that match the provided filters. If
+        you are experiencing latency, try using this parameter to limit your
+        results.
+      example: true
+      schema:
+        type: boolean
     callId:
       name: callId
       in: path

custom_templates/Gemfile.mustache

@@ -6,4 +6,6 @@ group :development, :test do
   gem 'rake', '~> 13.0.1'
   gem 'pry-byebug'
   gem 'rubocop', '~> 1.52.0'
+  gem 'webmock', '~> 3.18.0'
+  gem 'simplecov', '~> 0.21.2'
 end