speechmatics 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e754cb933758ea9ee1d9c6425fd294bc4c1431bd
-  data.tar.gz: 41b3c4c00034d9a6094b24b44f6586f658f9bafb
+  metadata.gz: 697e88c1f9ebedcd924258f0332ae03a9706614a
+  data.tar.gz: 1af5416ff390993bf5fa5f7764987523a629c30b
 SHA512:
-  metadata.gz: 13e42ae2ee8a6c501a21a537e314ccfb5f2ba3faae4a8cf538d6b1c0ce8c0e6cb337ceb50f6f348509aaa2aa0ebc76e5957938a4d99e40c38832c067551cff17
-  data.tar.gz: 919864f0a5588bd41547294e4775e6b0e8522bef2befa477a4976991ffcd399a9176bae238cc13c8c0a9b794110d12f357cfe0d3e94b7734d2fe3eb47c8df1fe
+  metadata.gz: b30b8bb3f74917f546a137e4714733a153370efc2fa21d9a892d386f129a63356f11fb7f5e478369d128fdab966f8e5232091f5e6d3fb0926b9350803f13b74e
+  data.tar.gz: cf3fef36e28878fe53475ca88914b7fb77252d1f67db8d9f866f580464c1e6b2a25578470020ca7a926db65932962a1364521409fe9b4882dba6cdad534d62ef

data/.gitignore

@@ -17,4 +17,6 @@ test/version_tmp
 tmp
 .key
 notes.txt
-.DS_Store
+.DS_Store
+.env
+.byebug_history

data/README.md

@@ -72,6 +72,8 @@ trans = c.user.jobs.transcript(5678)
 ```
 
 ## Changes
+* 0.2.2 - 9 July 2018
+  - Permit requesting transcriptions in text/plain, or mixed requests. Thanks @benlangfeld
 
 * 0.2.1 - 13 Sept 2017
   - Updated error handling with a class for each error type. Thanks @mziwisky

data/lib/speechmatics/api.rb

@@ -5,7 +5,7 @@ module Speechmatics
 
     include Connection
 
-    attr_reader *Speechmatics::Configuration.keys
+    attr_reader(*Speechmatics::Configuration.keys)
 
     attr_accessor :current_options
 
@@ -89,7 +89,7 @@ module Speechmatics
     end
 
     def args_to_options(args)
-      params =  if args.is_a?(String) || args.is_a?(Symbol) || args.is_a?(Numeric)
+      if args.is_a?(String) || args.is_a?(Symbol) || args.is_a?(Numeric)
         {"#{self.class.name.demodulize.downcase.singularize}_id" => args.to_s}
       elsif args.is_a?(Hash)
         args

data/lib/speechmatics/configuration.rb

@@ -20,7 +20,7 @@ module Speechmatics
     # The value sent in the http header for 'User-Agent' if none is set
     DEFAULT_USER_AGENT = "Speechmatics Ruby Gem #{Speechmatics::VERSION}".freeze
 
-    attr_accessor *VALID_OPTIONS_KEYS
+    attr_accessor(*VALID_OPTIONS_KEYS)
 
     # Convenience method to allow for global setting of configuration options
     def configure

data/lib/speechmatics/connection.rb

@@ -30,12 +30,6 @@ module Speechmatics
     end
 
     def connection(options={})
-      if options[:allow_text]
-        allow_text = true
-        options.delete(:allow_text)
-      else
-        allow_text =false
-      end
       opts = merge_default_options(options)
 
       @conn ||= Faraday::Connection.new(opts) do |connection|
@@ -55,11 +49,7 @@ module Speechmatics
 
           connection.response :mashify
           connection.response :logger if ENV['DEBUG']
-          if allow_text
-            connection.response :json, :content_type => /\bjson$/
-          else
-            connection.response :json
-          end
+          connection.response :json, :content_type => /\bjson$/
           connection.adapter(*adapter)
         end
       end

data/lib/speechmatics/user/jobs.rb

@@ -15,12 +15,16 @@ module Speechmatics
 
     def transcript(params={})
       self.current_options = current_options.merge(args_to_options(params))
-      request(:get, "#{base_path}/transcript")
+      if params[:format] == "txt"
+        request(:get, "#{base_path}/transcript?format=txt")
+      else
+        request(:get, "#{base_path}/transcript")
+      end
     end
 
     def alignment(params={})
       self.current_options = current_options.merge(args_to_options(params))
-      request(:get, "#{base_path}/alignment", {:options => {:allow_text => true}})
+      request(:get, "#{base_path}/alignment")
     end
 
     def set_mode(params={})
@@ -33,7 +37,7 @@ module Speechmatics
     def attach_audio(params={})
       file_path = params[:data_file]
       raise "No file specified for new job, please provide a :data_file value" unless file_path
-      raise "No file exists at path '#{file_path}'" unless File.exists?(file_path)
+      raise "No file exists at path '#{file_path}'" unless File.exist?(file_path)
 
       content_type = params[:content_type] || MimeMagic.by_path(file_path).to_s
       raise "No content type specified for file, please provide a :content_type value" unless content_type

data/lib/speechmatics/version.rb

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
 
 module Speechmatics
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

data/test/test_helper.rb

@@ -8,6 +8,8 @@ require 'minitest'
 require 'minitest/autorun'
 require 'minitest/spec'
 
+require 'byebug'
+
 require 'speechmatics'
 
 def raw_response_stub(status, body = '')

data/test/user/jobs_test.rb

@@ -72,11 +72,17 @@ describe Speechmatics::Client do
     }
   }
 
+  let(:alignment) {
+    "[00:00:00.1]	Hello world how are you?"
+  }
+
   let(:stubs) {
     Faraday::Adapter::Test::Stubs.new do |stub|
-      stub.get('/v1.0/user/1/jobs/?auth_token=token') { [200, {}, list_jobs.to_json] }
-      stub.post('/v1.0/user/1/jobs/?auth_token=token') { [200, {}, new_job.to_json] }
-      stub.get('/v1.0/user/1/jobs/1/transcript?auth_token=token') { [200, {}, transcript.to_json] }
+      stub.get('/v1.0/user/1/jobs/?auth_token=token') { [200, {"Content-Type" => "application/json"}, list_jobs.to_json] }
+      stub.post('/v1.0/user/1/jobs/?auth_token=token') { [200, {"Content-Type" => "application/json"}, new_job.to_json] }
+      stub.get('/v1.0/user/1/jobs/1/transcript?format=txt&auth_token=token') { [200, {"Content-Type" => "text/plain"}, "Hello World."] }
+      stub.get('/v1.0/user/1/jobs/1/transcript?auth_token=token') { [200, {"Content-Type" => "application/json"}, transcript.to_json] }
+      stub.get('/v1.0/user/1/jobs/1/alignment?auth_token=token') { [200, {"Content-Type" => "text/plain"}, alignment] }
     end
   }
 
@@ -99,7 +105,7 @@ describe Speechmatics::Client do
     r.cost.must_equal 0.50
     r.balance.must_equal 90
   end
-  
+
   it "creates job for a video file" do
     r = jobs.create(data_file: File.expand_path(File.dirname(__FILE__) + '/../zero.mp4'))
     r.id.must_equal 2
@@ -113,4 +119,31 @@ describe Speechmatics::Client do
     t.words.count.must_equal 3
   end
 
+  it "gets transcript as text" do
+    t = jobs.transcript(job_id: 1, format: "txt")
+    t.object.must_equal "Hello World."
+  end
+
+  it "can align a text representation of the audio" do
+    a = jobs.alignment(job_id: 1)
+    a.object.must_equal alignment
+  end
+
+  it "can fetch txt transcription after fetching full" do
+    t1 = jobs.transcript(job_id: 1)
+    t1.speakers.count.must_equal 1
+    t1.words.count.must_equal 3
+
+    t2 = jobs.transcript(job_id: 1, format: "txt")
+    t2.object.must_equal "Hello World."
+  end
+
+  it "can fetch alignment after fetching transcription" do
+    t = jobs.transcript(job_id: 1)
+    t.speakers.count.must_equal 1
+    t.words.count.must_equal 3
+
+    a = jobs.alignment(job_id: 1)
+    a.object.must_equal alignment
+  end
 end

data/test/user_test.rb

@@ -7,8 +7,8 @@ describe Speechmatics::Client do
   let(:response) {
     {
       user: {
-         balance: 90, 
-         email: "demo@speechmatics.com", 
+         balance: 90,
+         email: "demo@speechmatics.com",
          id: 1
        }
     }
@@ -16,7 +16,7 @@ describe Speechmatics::Client do
 
   let(:stubs) {
     Faraday::Adapter::Test::Stubs.new do |stub|
-      stub.get('/v1.0/user/1/?auth_token=token') { [200, {}, response.to_json] }
+      stub.get('/v1.0/user/1/?auth_token=token') { [200, {"Content-Type" => "application/json"}, response.to_json] }
     end
   }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: speechmatics
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Andrew Kuklewicz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-15 00:00:00.000000000 Z
+date: 2018-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday