speechmatics 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec521f15165eb5671307764e769b2d06650fe094
-  data.tar.gz: d9ffee30ce7281635338fbdd10593ae9e1070f2d
+  metadata.gz: e754cb933758ea9ee1d9c6425fd294bc4c1431bd
+  data.tar.gz: 41b3c4c00034d9a6094b24b44f6586f658f9bafb
 SHA512:
-  metadata.gz: e64b84ee8115088b7f3f03f4dbe42dc195101232cb5fd90ae2a4df5d67bb7389251861053a0f4e78446aa87b3154d4c88ff9890522ae395bf1023c7abe2592ac
-  data.tar.gz: a99c7b5633fa325e24d35111d375dcbefaf4836105f5b893ad39da0c5afdf36f7e22b05af7ffed178b542d35dff93a7e1bcb16933e56095d13b97146ed589a89
+  metadata.gz: 13e42ae2ee8a6c501a21a537e314ccfb5f2ba3faae4a8cf538d6b1c0ce8c0e6cb337ceb50f6f348509aaa2aa0ebc76e5957938a4d99e40c38832c067551cff17
+  data.tar.gz: 919864f0a5588bd41547294e4775e6b0e8522bef2befa477a4976991ffcd399a9176bae238cc13c8c0a9b794110d12f357cfe0d3e94b7734d2fe3eb47c8df1fe

data/README.md

@@ -73,6 +73,12 @@ trans = c.user.jobs.transcript(5678)
 
 ## Changes
 
+* 0.2.1 - 13 Sept 2017
+  - Updated error handling with a class for each error type. Thanks @mziwisky
+
+* 0.2.0 - 10/12/2016
+  - Added alignment support, thanks @rogerz42892
+
 * 0.1.4 - 8/21/2015
   - Add support for video files.
 

data/lib/speechmatics.rb

@@ -7,6 +7,8 @@ require "speechmatics/version"
 require 'speechmatics/configuration'
 require 'speechmatics/connection'
 require 'speechmatics/response'
+require 'speechmatics/response/error'
+Gem.find_files('speechmatics/response/error/*.rb').each { |path| require path }
 require 'speechmatics/api'
 require 'speechmatics/api_factory'
 require 'speechmatics/client'

data/lib/speechmatics/api.rb

@@ -48,7 +48,7 @@ module Speechmatics
           request.body = params[:data]
         end
       end
-      Speechmatics::Response.new(response, {api: self, method: method, path: path, params: params})
+      Speechmatics::Response.parse(response, {api: self, method: method, path: path, params: params})
     end
 
     def base_path

data/lib/speechmatics/response.rb

@@ -2,25 +2,22 @@
 
 module Speechmatics
   class Response
+
+    def self.parse(response, request={})
+      new(response, request).tap do |res|
+        res.check_for_error
+      end
+    end
+
     attr_accessor :raw, :request
 
     def initialize(response, request={})
       @raw     = response
       @request = request
-
-      check_for_error(response)
     end
 
-    def check_for_error(response)
-      status_code_type = response.status.to_s[0]
-      case status_code_type
-      when "2"
-        # puts "all is well, status: #{response.status}"
-      when "4", "5"
-        raise "Whoops, error back from Speechmatics: #{response.status}"
-      else
-        raise "Unrecongized status code: #{response.status}"
-      end
+    def check_for_error
+      raise Error.classify(self) if raw.status >= 400
     end
 
     def body

data/lib/speechmatics/response/error.rb

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+
+module Speechmatics
+  class Response
+    class Error < StandardError
+      TYPES = []
+
+      class << self
+        def inherited(subclass)
+          TYPES << subclass
+        end
+
+        def classify(response)
+          klass = TYPES.find { |t| t.matches?(response) } || Unknown
+          klass.new(response)
+        end
+
+        def matches?(response)
+          matches_status?(response.raw.status) &&
+            matches_message?(error_message(response))
+        end
+
+        def matches_status?(status)
+          self::ERROR_STATUS == status
+        end
+
+        def matches_message?(message)
+          self::ERROR_MESSAGE == message
+        end
+
+        def error_message(response)
+          response['error']
+        rescue
+          ''
+        end
+      end
+
+      attr_reader :response
+
+      def initialize(response)
+        @response = response
+        super self.class.error_message(response)
+      end
+    end
+  end
+end

data/lib/speechmatics/response/error/bad_gateway.rb

@@ -0,0 +1,8 @@
+# -*- encoding: utf-8 -*-
+
+class Speechmatics::Response::Error
+  class BadGateway < self
+    ERROR_STATUS = 502
+    def self.matches_message?(_message); true; end
+  end
+end

data/lib/speechmatics/response/error/cannot_align.rb

@@ -0,0 +1,8 @@
+# -*- encoding: utf-8 -*-
+
+class Speechmatics::Response::Error
+  class CannotAlign < self
+    ERROR_STATUS = 404
+    ERROR_MESSAGE = 'Text could not be aligned to audio'
+  end
+end

data/lib/speechmatics/response/error/insufficient_credit.rb

@@ -0,0 +1,8 @@
+# -*- encoding: utf-8 -*-
+
+class Speechmatics::Response::Error
+  class InsufficientCredit < self
+    ERROR_STATUS = 403
+    ERROR_MESSAGE = 'Insufficient Credit'
+  end
+end

data/lib/speechmatics/response/error/internal_server_error.rb

@@ -0,0 +1,8 @@
+# -*- encoding: utf-8 -*-
+
+class Speechmatics::Response::Error
+  class InternalServerError < self
+    ERROR_STATUS = 500
+    def self.matches_message?(_message); true; end
+  end
+end

data/lib/speechmatics/response/error/invalid_audio.rb

@@ -0,0 +1,8 @@
+# -*- encoding: utf-8 -*-
+
+class Speechmatics::Response::Error
+  class InvalidAudio < self
+    ERROR_STATUS = 403
+    ERROR_MESSAGE = 'Job rejected due to invalid audio'
+  end
+end

data/lib/speechmatics/response/error/job_in_progress.rb

@@ -0,0 +1,8 @@
+# -*- encoding: utf-8 -*-
+
+class Speechmatics::Response::Error
+  class JobInProgress < self
+    ERROR_STATUS = 404
+    ERROR_MESSAGE = 'Job In Progress'
+  end
+end

data/lib/speechmatics/response/error/job_not_found.rb

@@ -0,0 +1,8 @@
+# -*- encoding: utf-8 -*-
+
+class Speechmatics::Response::Error
+  class JobNotFound < self
+    ERROR_STATUS = 404
+    ERROR_MESSAGE = 'Job not found'
+  end
+end

data/lib/speechmatics/response/error/malformed_request.rb

@@ -0,0 +1,8 @@
+# -*- encoding: utf-8 -*-
+
+class Speechmatics::Response::Error
+  class MalformedRequest < self
+    ERROR_STATUS = 400
+    ERROR_MESSAGE = 'Malformed request'
+  end
+end

data/lib/speechmatics/response/error/missing_callback.rb

@@ -0,0 +1,8 @@
+# -*- encoding: utf-8 -*-
+
+class Speechmatics::Response::Error
+  class MissingCallback < self
+    ERROR_STATUS = 400
+    ERROR_MESSAGE = 'Missing callback'
+  end
+end

data/lib/speechmatics/response/error/missing_data_file.rb

@@ -0,0 +1,8 @@
+# -*- encoding: utf-8 -*-
+
+class Speechmatics::Response::Error
+  class MissingDataFile < self
+    ERROR_STATUS = 400
+    ERROR_MESSAGE = 'Missing data_file'
+  end
+end

data/lib/speechmatics/response/error/missing_language.rb

@@ -0,0 +1,8 @@
+# -*- encoding: utf-8 -*-
+
+class Speechmatics::Response::Error
+  class MissingLanguage < self
+    ERROR_STATUS = 400
+    ERROR_MESSAGE = 'No language selected'
+  end
+end

data/lib/speechmatics/response/error/not_alignment_job.rb

@@ -0,0 +1,8 @@
+# -*- encoding: utf-8 -*-
+
+class Speechmatics::Response::Error
+  class NotAlignmentJob < self
+    ERROR_STATUS = 404
+    ERROR_MESSAGE = 'Job is not of type alignment'
+  end
+end

data/lib/speechmatics/response/error/product_not_available.rb

@@ -0,0 +1,8 @@
+# -*- encoding: utf-8 -*-
+
+class Speechmatics::Response::Error
+  class ProductNotAvailable < self
+    ERROR_STATUS = 400
+    ERROR_MESSAGE = 'Requested product not available'
+  end
+end

data/lib/speechmatics/response/error/rejected_on_submission.rb

@@ -0,0 +1,8 @@
+# -*- encoding: utf-8 -*-
+
+class Speechmatics::Response::Error
+  class RejectedOnSubmission < self
+    ERROR_STATUS = 404
+    ERROR_MESSAGE = 'Job was rejected on submission'
+  end
+end

data/lib/speechmatics/response/error/service_unavailable.rb

@@ -0,0 +1,8 @@
+# -*- encoding: utf-8 -*-
+
+class Speechmatics::Response::Error
+  class ServiceUnavailable < self
+    ERROR_STATUS = 503
+    def self.matches_message?(_message); true; end
+  end
+end

data/lib/speechmatics/response/error/too_many_requests.rb

@@ -0,0 +1,8 @@
+# -*- encoding: utf-8 -*-
+
+class Speechmatics::Response::Error
+  class TooManyRequests < self
+    ERROR_STATUS = 429
+    ERROR_MESSAGE = 'Too Many requests'
+  end
+end

data/lib/speechmatics/response/error/unauthorized.rb

@@ -0,0 +1,8 @@
+# -*- encoding: utf-8 -*-
+
+class Speechmatics::Response::Error
+  class Unauthorized < self
+    ERROR_STATUS = 401
+    ERROR_MESSAGE = 'Invalid User Id or Token'
+  end
+end

data/lib/speechmatics/response/error/unknown.rb

@@ -0,0 +1,7 @@
+# -*- encoding: utf-8 -*-
+
+class Speechmatics::Response::Error
+  class Unknown < self
+    def self.matches?(_response); false; end
+  end
+end

data/lib/speechmatics/response/error/unsupported_output_format.rb

@@ -0,0 +1,8 @@
+# -*- encoding: utf-8 -*-
+
+class Speechmatics::Response::Error
+  class UnsupportedOutputFormat < self
+    ERROR_STATUS = 404
+    ERROR_MESSAGE = 'Output format Not Supported'
+  end
+end

data/lib/speechmatics/version.rb

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

data/speechmatics.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "byebug"
 
   spec.add_development_dependency('minitest')
   spec.add_development_dependency('simplecov')

data/test/response/error_test.rb

@@ -0,0 +1,94 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+describe Speechmatics::Response::Error do
+  described_class = Speechmatics::Response::Error
+
+  describe '::classify' do
+    # see error table at https://app.speechmatics.com/api-details#errorCodes
+
+    describe '4xx errors' do
+      tests = [{
+        response: {status: 400, error: 'Malformed request'},
+        error_class: described_class::MalformedRequest
+      },{
+        response: {status: 400, error: 'Missing data_file'},
+        error_class: described_class::MissingDataFile
+      },{
+        response: {status: 400, error: 'No language selected'},
+        error_class: described_class::MissingLanguage
+      },{
+        response: {status: 400, error: 'Missing callback'},
+        error_class: described_class::MissingCallback
+      },{
+        response: {status: 400, error: 'Requested product not available'},
+        error_class: described_class::ProductNotAvailable
+      },{
+        response: {status: 401, error: 'Invalid User Id or Token'},
+        error_class: described_class::Unauthorized
+      },{
+        response: {status: 403, error: 'Job rejected due to invalid audio'},
+        error_class: described_class::InvalidAudio
+      },{
+        response: {status: 403, error: 'Insufficient Credit'},
+        error_class: described_class::InsufficientCredit
+      },{
+        response: {status: 404, error: 'Job not found'},
+        error_class: described_class::JobNotFound
+      },{
+        response: {status: 404, error: 'Text could not be aligned to audio'},
+        error_class: described_class::CannotAlign
+      },{
+        response: {status: 404, error: 'Job was rejected on submission'},
+        error_class: described_class::RejectedOnSubmission
+      },{
+        response: {status: 404, error: 'Job is not of type alignment'},
+        error_class: described_class::NotAlignmentJob
+      },{
+        response: {status: 404, error: 'Job In Progress'},
+        error_class: described_class::JobInProgress
+      },{
+        response: {status: 404, error: 'Output format Not Supported'},
+        error_class: described_class::UnsupportedOutputFormat
+      },{
+        response: {status: 429, error: 'Too Many requests'},
+        error_class: described_class::TooManyRequests
+      }]
+
+      tests.each do |t|
+        it "correctly classifies #{t[:response][:status]}: #{t[:response][:error]}" do
+          raw_response = raw_response_stub(
+            t[:response][:status],
+            { 'error' => t[:response][:error] }
+          )
+          response = Speechmatics::Response.new(raw_response)
+          err = described_class.classify(response)
+          err.class.must_equal t[:error_class]
+        end
+      end
+    end
+
+    describe '5xx errors' do
+      tests = [{
+        status: 500,
+        error_class: described_class::InternalServerError
+      },{
+        status: 502,
+        error_class: described_class::BadGateway
+      },{
+        status: 503,
+        error_class: described_class::ServiceUnavailable
+      }]
+
+      tests.each do |t|
+        it "correctly classifies status #{t[:status]}" do
+          raw_response = raw_response_stub(t[:status])
+          response = Speechmatics::Response.new(raw_response)
+          err = described_class.classify(response)
+          err.class.must_equal t[:error_class]
+        end
+      end
+    end
+  end
+end

data/test/response_test.rb

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+
+describe Speechmatics::Response do
+  describe '::parse' do
+    describe 'with an error response' do
+      let(:response) { raw_response_stub(422) }
+
+      it 'raises a Speechmatics::Response::Error' do
+        lambda {
+          Speechmatics::Response.parse(response)
+        }.must_raise Speechmatics::Response::Error
+      end
+    end
+
+    describe 'with an successful response' do
+      let(:response) { raw_response_stub(200, 'good stuff') }
+
+      it 'returns a Response object' do
+        res = Speechmatics::Response.parse(response)
+        res.class.must_equal Speechmatics::Response
+        res.body.must_equal 'good stuff'
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -9,3 +9,7 @@ require 'minitest/autorun'
 require 'minitest/spec'
 
 require 'speechmatics'
+
+def raw_response_stub(status, body = '')
+  Struct.new(:status, :body).new(status, body)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: speechmatics
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Andrew Kuklewicz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-12 00:00:00.000000000 Z
+date: 2017-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -184,12 +198,34 @@ files:
 - lib/speechmatics/connection.rb
 - lib/speechmatics/resource.rb
 - lib/speechmatics/response.rb
+- lib/speechmatics/response/error.rb
+- lib/speechmatics/response/error/bad_gateway.rb
+- lib/speechmatics/response/error/cannot_align.rb
+- lib/speechmatics/response/error/insufficient_credit.rb
+- lib/speechmatics/response/error/internal_server_error.rb
+- lib/speechmatics/response/error/invalid_audio.rb
+- lib/speechmatics/response/error/job_in_progress.rb
+- lib/speechmatics/response/error/job_not_found.rb
+- lib/speechmatics/response/error/malformed_request.rb
+- lib/speechmatics/response/error/missing_callback.rb
+- lib/speechmatics/response/error/missing_data_file.rb
+- lib/speechmatics/response/error/missing_language.rb
+- lib/speechmatics/response/error/not_alignment_job.rb
+- lib/speechmatics/response/error/product_not_available.rb
+- lib/speechmatics/response/error/rejected_on_submission.rb
+- lib/speechmatics/response/error/service_unavailable.rb
+- lib/speechmatics/response/error/too_many_requests.rb
+- lib/speechmatics/response/error/unauthorized.rb
+- lib/speechmatics/response/error/unknown.rb
+- lib/speechmatics/response/error/unsupported_output_format.rb
 - lib/speechmatics/user.rb
 - lib/speechmatics/user/jobs.rb
 - lib/speechmatics/version.rb
 - speechmatics.gemspec
 - test/api_test.rb
 - test/client_test.rb
+- test/response/error_test.rb
+- test/response_test.rb
 - test/test_helper.rb
 - test/user/jobs_test.rb
 - test/user_test.rb
@@ -215,13 +251,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.4.5.2
 signing_key: 
 specification_version: 4
 summary: 'Ruby client for Speechmatics API: https://speechmatics.com/api-details'
 test_files:
 - test/api_test.rb
 - test/client_test.rb
+- test/response/error_test.rb
+- test/response_test.rb
 - test/test_helper.rb
 - test/user/jobs_test.rb
 - test/user_test.rb