add tests, example docs and missing import

lib/assemblyai.rb

@@ -6,6 +6,7 @@
 require_relative "assemblyai/files/client"
 require_relative "assemblyai/transcripts/client"
 require_relative "assemblyai/transcripts/polling_client"
+require_relative "assemblyai/transcripts/list_by_url_client"
 require_relative "assemblyai/realtime/client"
 require_relative "assemblyai/lemur/client"
 

lib/assemblyai/transcripts/list_by_url_client.rb

@@ -8,11 +8,16 @@ module AssemblyAI
 
   # :nodoc:
   class TranscriptsClient
-    # Retrieve a list of transcripts you created
+    # Retrieve a list of transcripts you created, this is used for pagination to easily retrieve the next page of transcripts
     #
     # @param url [String] The URL to retrieve the transcript list from
     # @param request_options [RequestOptions]
     # @return [Transcripts::TranscriptList]
+    #
+    # @example Retrieve the next page of results
+    #   client = AssemblyAI::Client.new(api_key: "YOUR_API_KEY")
+    #   transcript_list = client.transcripts.list(limit: 1)
+    #   client.transcripts.list_by_url(url: transcript_list.page_details.next_url)
     def list_by_url(url: nil, request_options: nil)
       if url.nil?
         url = "/v2/transcript"
@@ -34,6 +39,13 @@ class AsyncTranscriptsClient
     # @param url [String] The URL to retrieve the transcript list from
     # @param request_options [RequestOptions]
     # @return [Transcripts::TranscriptList]
+    #
+    # @example Retrieve the next page of results
+    #   client = AssemblyAI::AsyncClient.new(api_key: "YOUR_API_KEY")
+    #   Sync do
+    #     transcript_list = client.transcripts.list(limit: 1).wait
+    #     client.transcripts.list_by_url(url: transcript_list.page_details.next_url)
+    #   end
     def list_by_url(url: nil, request_options: nil)
       Async do
         if url.nil?

test/test_assemblyai.rb

@@ -5,12 +5,35 @@
 
 # Basic AssemblyAI tests
 class TestAssemblyAI < Minitest::Test
+  def test_pagination
+    client = AssemblyAI::Client.new(api_key: "YOUR API KEY")
+    transcript_list = client.transcripts.list
+
+    count = 0
+    client.transcripts.list.transcripts.each do |transcript|
+      assert !transcript.id.nil?
+      count += 1
+    end
+    assert count.positive?
+
+    while transcript_list.page_details.next_url
+      transcript_list = client.transcripts.list_by_url(url: transcript_list.page_details.next_url)
+
+      count = 0
+      client.transcripts.list.transcripts.each do |transcript|
+        assert !transcript.id.nil?
+        count += 1
+      end
+      assert count.positive?
+    end
+  end
+
   def test_polling
-    client = AssemblyAI::Client.new(api_key: "YOUR_API_KEY")
+    client = AssemblyAI::Client.new(api_key: "YOUR API KEY")
     transcript = client.transcripts.transcribe(audio_url: "https://storage.googleapis.com/aai-web-samples/espn-bears.m4a")
     assert transcript.status == AssemblyAI::Transcripts::TranscriptStatus::COMPLETED
 
-    client = AssemblyAI::AsyncClient.new(api_key: "YOUR_API_KEY")
+    client = AssemblyAI::AsyncClient.new(api_key: "YOUR API KEY")
     Sync do
       transcript_task = client.transcripts.transcribe(audio_url: "https://storage.googleapis.com/aai-web-samples/espn-bears.m4a")
       assert transcript_task.is_a? Async::Task
@@ -21,7 +44,7 @@ def test_polling
 
   def test_transcribe
     # Transcribe
-    client = AssemblyAI::Client.new(api_key: "YOUR_API_KEY")
+    client = AssemblyAI::Client.new(api_key: "YOUR API KEY")
 
     transcript_submission = client.transcripts.submit(audio_url: "https://storage.googleapis.com/aai-web-samples/espn-bears.m4a")
     assert !transcript_submission.id.nil?
@@ -37,7 +60,7 @@ def test_transcribe
   end
 
   def test_lemur
-    client = AssemblyAI::Client.new(api_key: "YOUR_API_KEY")
+    client = AssemblyAI::Client.new(api_key: "YOUR API KEY")
     assert !client.lemur.summary(transcript_ids: ["369849ed-b5a1-4add-9dde-ac936d3e7b99"]).response.nil?
 
     assert !client.lemur.question_answer(transcript_ids: ["369849ed-b5a1-4add-9dde-ac936d3e7b99"], questions: [{question: "What are they discussing?", answer_format: "text"}]).response.nil?