voice_id 0.1.0

data/lib/voice_id/request_helpers.rb

@@ -0,0 +1,33 @@
+require 'http'
+
+module VoiceId
+  module RequestHelpers
+    class InvalidApiRequestError < StandardError; end
+
+    # generate body for content-type "multipart/form-data"
+    def create_body_for_enrollment(audio_file_path)
+      { :form => { :file   => HTTP::FormData::File.new(audio_file_path) } }
+    end
+
+    def parse_error_response(response)
+      msg = response.parse["error"]["message"] || "request returned status #{response.code}"
+      raise InvalidApiRequestError, msg
+    end
+
+    def send_request(path, method, req_headers, body)
+      _headers =  req_headers ? headers.merge(req_headers) : headers
+      _path    = api_base_url + path
+      _req     = HTTP.headers(_headers)
+
+      case method
+      when :Post
+        body ? _req.post(_path, body) : _req.post(_path)
+      when :Get
+        _req.get(_path)
+      when :Delete
+        _req.delete(_path)
+      end
+    end
+
+  end
+end

data/lib/voice_id/utils.rb

@@ -0,0 +1,7 @@
+module VoiceId
+  module Utils
+    def get_operation_id(operation_url)
+      operation_url.match(/operations\/(.+)/)[1]
+    end
+  end
+end

data/lib/voice_id/verification.rb

@@ -0,0 +1,251 @@
+module VoiceId
+  class Verification < VoiceId::Base
+
+    # params
+    #   profile_id
+    #     unique profile id
+    #   audio_file_path
+    #     path to the audio of speaker
+    #
+    # Microsoft API response
+    # 200 Response 
+    # {
+    #   "result" : "Accept", // [Accept | Reject]
+    #   "confidence" : "Normal", // [Low | Normal | High]
+    #   "phrase": "recognized phrase"
+    # }
+    #
+    #
+    # returns
+    #   success
+    #     verification results { Hash }
+    #   fail (500 error)
+    #     false
+    def verify_speaker(profile_id, audio_file_path)
+        _method   = :Post
+        _path     = "/verify?verificationProfileId=#{profile_id}"
+        _headers  = { } 
+        _body     = create_body_for_enrollment(audio_file_path)
+        _response = send_request(_path, _method, _headers, _body)
+
+        _response.code == 200 ? _response.parse : parse_error_response(_response)
+    end
+
+    # Microsoft API response
+    # 200 Response 
+    # {
+    #   "verificationProfileId": "49a36324-fc4b-4387-aa06-090cfbf0064f",
+    # }
+    #
+    # 500 Response
+    # {
+    #   "error":{
+    #     "code" : "InternalServerError",
+    #     "message" : "SpeakerInvalid",
+    #   }
+    # }
+    #
+    # returns
+    #   success
+    #     new profileId { Hash }
+    #   fail
+    #     false (indicating new profile was not created)
+    def create_profile
+      super("/verificationProfiles")
+    end
+
+    # params
+    #   profileId - required
+    #     a valid id { String }
+    #
+    # Microsoft API response
+    # 200 Response
+    # "" (empty string)
+    # 
+    # 500 Response
+    #    {
+    #      "error": {
+    #        "code" : "InternalServerError",
+    #        "message" : "SpeakerInvalid", 
+    #      }
+    #   }
+    #
+    # returns
+    #   success
+    #     profile id that was deleted { String }
+    #   fail
+    #     false (indicating delete of id failed)
+    def delete_profile(profileId)
+      super("/verificationProfiles/#{profileId}")
+    end
+
+    # Microsoft API response
+    # 200 Response
+    #   [{
+    #     "verificationProfileId" : "111f427c-3791-468f-b709-fcef7660fff9",
+    #     "locale" : "en-US",
+    #     "enrollmentsCount" : 2,
+    #     "remainingEnrollmentsCount" : 0,
+    #     "createdDateTime" : "2015-04-23T18:25:43.511Z", 
+    #     "lastActionDateTime" : "2015-04-23T18:25:43.511Z",
+    #     "enrollmentStatus" : "Enrolled" //[Enrolled | Enrolling | Training]
+    #   }, …]
+    # 
+    # 500 Response
+    #    {
+    #      "error": {
+    #        "code" : "InternalServerError",
+    #        "message" : "SpeakerInvalid", 
+    #      }
+    #   }
+    #
+    # returns
+    #   success
+    #     A list of all the profiles { Array }
+    #   fail
+    #     false (indicating delete of id failed)
+    def get_all_profiles
+      super('/verificationProfiles')
+    end
+
+    # params
+    #   profileId
+    #     a valid profileId { String }
+    #
+    # Microsoft API response
+    # 200 Response
+    #   {
+    #     "verificationProfileId" : "111f427c-3791-468f-b709-fcef7660fff9",
+    #     "locale" : "en-US",
+    #     "enrollmentsCount" : 2,
+    #     "remainingEnrollmentsCount" : 0,
+    #     "createdDateTime" : "2015-04-23T18:25:43.511Z", 
+    #     "lastActionDateTime" : "2015-04-23T18:25:43.511Z",
+    #     "enrollmentStatus" : "Enrolled" // [Enrolled | Enrolling | Training]
+    #   }
+    # 
+    # 500 Response
+    #    {
+    #      "error": {
+    #        "code" : "InternalServerError",
+    #        "message" : "SpeakerInvalid", 
+    #      }
+    #   }
+    #
+    # returns
+    #   success
+    #     a profile { Hash }
+    #   fail
+    #     false (indicating delete of id failed)
+    def get_profile(profileId)
+      super("/verificationProfiles/#{profileId}")
+    end
+
+    # each speaker(profile) must provide at least 3 enrollments to the api
+    # params
+    #   profileId
+    #     a valid profileId { String }
+    #   audio_file_path
+    #     path to the audio file { String }
+    #     audio requirments => Wav, PCM, 16k rate, 16 bit sample rate, mono
+    #
+    # Microsoft API response
+    # 200 Response
+    #   {
+    #     "enrollmentStatus" : "Enrolled", // [Enrolled | Enrolling | Training]
+    #     "enrollmentsCount":0,
+    #     "remainingEnrollments" : 0,
+    #     "phrase" : "Recognized verification phrase"
+    #   }
+    # 
+    # 500 Response
+    #    {
+    #      "error": {
+    #        "code" : "InternalServerError",
+    #        "message" : "SpeakerInvalid", 
+    #      }
+    #   }
+    #
+    # returns
+    #   success
+    #     enrollment details { Hash }
+    #   fail
+    #     false
+    def create_enrollment(profileId, audio_file_path)
+      _method   = :Post
+      _path     = "/verificationProfiles/#{profileId}/enroll"
+      _headers  = { } 
+      _body     = create_body_for_enrollment(audio_file_path)
+      _response = send_request(_path, _method, _headers, _body)
+
+      _response.code == 200 ? _response.parse : parse_error_response(_response)
+    end
+
+    # params
+    #   profileId - required
+    #     a valid id { String }
+    #
+    # Microsoft API response
+    # 200 Response
+    # "" (empty string)
+    # 
+    # 500 Response
+    #    {
+    #      "error": {
+    #        "code" : "InternalServerError",
+    #        "message" : "SpeakerInvalid", 
+    #      }
+    #   }
+    #
+    # returns
+    #   success
+    #     profile id that was deleted { String }
+    #   fail
+    #     false (indicating delete of enrollments failed)
+    def reset_all_enrollments_for_profile(profileId)
+      super("/verificationProfiles/#{profileId}/reset")
+    end
+
+    # params
+    #   locale - required
+    #     a valid query string (used to return phrases in selected language)
+    #
+    # Microsoft API response
+    # 200 Response
+    #  [
+    #   {"phrase"=>"i am going to make him an offer he cannot refuse"}, 
+    #   {"phrase"=>"houston we have had a problem"}, 
+    #   {"phrase"=>"my voice is my passport verify me"}, 
+    #   {"phrase"=>"apple juice tastes funny after toothpaste"}, 
+    #   {"phrase"=>"you can get in without your password"}, 
+    #   {"phrase"=>"you can activate security system now"}, 
+    #   {"phrase"=>"my voice is stronger than passwords"}, 
+    #   {"phrase"=>"my password is not your business"}, 
+    #   {"phrase"=>"my name is unknown to you"}, 
+    #   {"phrase"=>"be yourself everyone else is already taken"}
+    # ]
+    # 
+    # 500 Response
+    #    {
+    #      "error": {
+    #        "code" : "InternalServerError",
+    #        "message" : "SpeakerInvalid", 
+    #      }
+    #   }
+    #
+    # returns
+    #   success
+    #     list of acceptable phrases { Array }
+    #   fail
+    #     false
+    def list_all_verification_phrases
+      _method   = :Get
+      _locale   = "en-us"
+      _path     = "/verificationPhrases?locale=#{_locale}"
+      _headers  = { "Content-Type" => "application/json" }
+      _response = send_request(_path, _method, _headers, nil)
+
+      _response.code == 200 ? _response.parse : parse_error_response(_response)
+    end
+  end
+end

data/spec/identification_spec.rb

@@ -0,0 +1,95 @@
+require_relative "spec_helper"
+
+describe VoiceId::Identification do
+
+  @profile = {
+    "identificationProfileId" => "111f427c-3791-468f-b709-fcef7660fff9",
+    "locale" => "en-US",
+    "enrollmentSpeechTime" => 0.0,
+    "remainingEnrollmentSpeechTime" => 0.0,
+    "createdDateTime" => "2015-04-23T18:25:43.511Z",
+    "lastActionDateTime" => "2015-04-23T18:25:43.511Z",
+    "enrollmentStatus" => "Enrolled"
+  }
+
+  before :each do
+    @identification = VoiceId::Identification.new("some_api_key")
+    @identification.api_base_url = "http://localhost:11988"
+  end
+
+
+  describe "#create_profile" do
+    it "should be able to create a new profile and return the details" do
+      expect(@identification.create_profile).to eql(@identification_profile)
+    end
+  end
+
+  describe "#delete_profile" do
+    it "should delete a profile and return true" do
+      profileId = "12345678"        
+      expect(@identification.delete_profile(profileId)).to eql(true)
+    end
+  end
+
+  describe "#get_all_profiles" do
+    it "should return an array of all profiles" do
+      expect(@identification.get_all_profiles).to eql(@identification_profiles)
+    end
+  end
+
+  describe "#get_profile" do
+    it "should return a profile hash" do
+      profileId = "987654321"
+      expect(@identification.get_profile(profileId)).to eql(@profile)
+    end
+  end
+
+  describe "#create_enrollment" do
+    it "should create a new enrollment for a profile and return an operation url" do
+      data       = { :form => { :file   => "cool.wav" } }
+      profileId  = "0991883883"
+      shortAudio = true
+      allow_any_instance_of(VoiceId::RequestHelpers).to receive(:create_body_for_enrollment).and_return(data)
+      expect(@identification.create_enrollment(profileId , shortAudio, '/path/to/some/audio_file.wav')).to eql("https://www.coolsite/operations/123456789")
+    end
+  end
+
+  describe "#reset_all_enrollments_for_profile" do
+    it "should return true if all enrollments for a profile was deleted" do
+      profileId = "0991883883"
+      expect(@identification.reset_all_enrollments_for_profile(profileId)).to eql(true)
+    end
+  end
+
+  describe "#get_operation_id" do
+    it "returns an operation id" do
+      operation_url = "https://api.projectoxford.ai/spid/v1.0/operations/995a8745-0098-4c12-9889-bad14859y7a4"
+      expect(@identification.get_operation_id(operation_url)).to eql("995a8745-0098-4c12-9889-bad14859y7a4")
+    end
+  end
+
+  describe "#identify_speaker" do
+    it "identifies a speaker using any audio snippet" do
+      data = { :form => { :file   => "cool.wav" } }
+      profile_ids = ["profile_id1", "profile_id2"]
+      short_audio = true
+      audio_file_path = '/path/to/some/audio_file.wav'
+      allow_any_instance_of(VoiceId::RequestHelpers).to receive(:create_body_for_enrollment).and_return(data)
+      expect(@identification.identify_speaker(profile_ids, short_audio, audio_file_path)).to eql("https://www.coolsite/operations/123456789")
+    end
+  end
+
+  describe "#get_operation_status(operationId)" do
+    it "returns operation status" do
+      operation_id = "1234567890"
+      expect(@identification.get_operation_status(operation_id)).to eql(@operation_status)
+    end
+  end
+
+  describe "#parse_error_response" do
+    it "throws an error" do
+      @identification.api_base_url = "http://localhost:11988/error"
+      expect { @identification.create_profile }.to raise_error(VoiceId::RequestHelpers::InvalidApiRequestError, "oh no everything's going wrong today!")
+    end
+  end
+end

data/spec/mock_server.rb

@@ -0,0 +1,122 @@
+json_type = { "content-type" => "application/json" }
+form_data_type = { "content-type" => "multipart/form-data"}
+enrollment_operation = { "Operation-Location" => "https://www.coolsite/operations/123456789" }
+
+@new_identification_profile = {
+  "identificationProfileId" => "49a36324-fc4b-4387-aa06-090cfbf0064f",
+}
+
+@identification_profile = {
+  "identificationProfileId" => "111f427c-3791-468f-b709-fcef7660fff9",
+  "locale" => "en-US",
+  "enrollmentSpeechTime" => 0.0,
+  "remainingEnrollmentSpeechTime" => 0.0,
+  "createdDateTime" => "2015-04-23T18:25:43.511Z",
+  "lastActionDateTime" => "2015-04-23T18:25:43.511Z",
+  "enrollmentStatus" => "Enrolled"
+}
+
+@identification_profiles = [
+  {
+    "identificationProfileId" => "111f427c-3791-468f-b709-fcef7660fff9",
+    "locale" => "en-US",
+    "enrollmentSpeechTime" => 0.0,
+    "remainingEnrollmentSpeechTime" => 0.0,
+    "createdDateTime" => "2015-04-23T18:25:43.511Z",
+    "lastActionDateTime" => "2015-04-23T18:25:43.511Z",
+    "enrollmentStatus" => "Enrolled"
+  }
+]
+
+@new_verification_profile = {
+  "verificationProfileId" => "49a36324-fc4b-4387-aa06-090cfbf0064f",
+}
+
+@verification_profiles = [
+  {
+    "verificationProfileId" => "111f427c-3791-468f-b709-fcef7660fff9",
+    "locale" => "en-US",
+    "enrollmentsCount" => 2,
+    "remainingEnrollmentsCount" => 0,
+    "createdDateTime" => "2015-04-23T18:25:43.511Z", 
+    "lastActionDateTime" => "2015-04-23T18:25:43.511Z",
+    "enrollmentStatus" => "Enrolled"
+  }
+]
+
+@verification_profile = {
+  "verificationProfileId" => "111f427c-3791-468f-b709-fcef7660fff9",
+  "locale" => "en-US",
+  "enrollmentsCount" => 2,
+  "remainingEnrollmentsCount" => 0,
+  "createdDateTime" => "2015-04-23T18:25:43.511Z", 
+  "lastActionDateTime" => "2015-04-23T18:25:43.511Z",
+  "enrollmentStatus" => "Enrolled"
+}
+
+@all_verification_phrases = [
+  {"phrase" => "i am going to make him an offer he cannot refuse"}, 
+  {"phrase" => "houston we have had a problem"}, 
+  {"phrase" => "my voice is my passport verify me"}, 
+  {"phrase" => "apple juice tastes funny after toothpaste"}, 
+  {"phrase" => "you can get in without your password"}, 
+  {"phrase" => "you can activate security system now"}, 
+  {"phrase" => "my voice is stronger than passwords"}, 
+  {"phrase" => "my password is not your business"}, 
+  {"phrase" => "my name is unknown to you"}, 
+  {"phrase" => "be yourself everyone else is already taken"}
+]
+
+@verification_enrollment_response = {
+  "enrollmentStatus" => "Enrolling",
+  "enrollmentsCount" => 1,
+  "remainingEnrollments" => 2,
+  "phrase" => "i am going to make him an offer he cannot refuse"
+}
+
+@verify_speaker_result = {
+  "result" => "Accept", 
+  "confidence" => "High", 
+  "phrase" => "i am going to make him an offer he cannot refuse"
+}
+
+@operation_status = {
+  "status" => "succeeded", 
+  "createdDateTime" => "2016-09-20T01:51:39.134487Z", 
+  "lastActionDateTime" => "2016-09-20T01:51:41.4183611Z", 
+  "processingResult" => {
+    "enrollmentStatus" => "Enrolled", 
+    "remainingEnrollmentSpeechTime" => 0.0, 
+    "speechTime" => 7.93, # useful speech duration
+    "enrollmentSpeechTime" => 31.72
+   }
+}
+
+error_response = {
+  "error" => {
+    "message" => "oh no everything's going wrong today!"
+  }
+}
+
+Mimic.mimic do
+  post("/error/identificationProfiles").returning(error_response.to_json, 400, json_type)
+  post("/error/verificationProfiles").returning(error_response.to_json, 400, json_type)
+
+  get("/identificationProfiles").returning(@identification_profiles.to_json, 200, json_type)
+  get("/operations/:operationId").returning(@operation_status.to_json, 200, json_type)
+  get("/identificationProfiles/:profileId").returning(@identification_profile.to_json, 200, json_type)
+  post("/identificationProfiles").returning(@new_identification_profile.to_json, 200, json_type)
+  post("/identificationProfiles/:profileId/reset").returning("".to_json, 200, json_type)
+  post("/identificationProfiles/:profileId/enroll").returning("".to_json, 202, json_type.merge(enrollment_operation))
+  post("/identify").returning("".to_json, 202, json_type.merge(enrollment_operation))
+  delete("/identificationProfiles/:profileId").returning("".to_json, 200, json_type)
+
+  get("/verificationProfiles").returning(@verification_profiles.to_json, 200, json_type)
+  get("/verificationProfiles/:profileId").returning(@verification_profile.to_json, 200, json_type)
+  get("/verificationPhrases").returning(@all_verification_phrases.to_json, 200, json_type)
+  post("/verificationProfiles").returning(@new_verification_profile.to_json, 200, json_type)
+  post("/verificationProfiles/:profileId/reset").returning("".to_json, 200, json_type)
+  post("/verificationProfiles/:profileId/enroll").returning(@verification_enrollment_response.to_json, 200, json_type)
+  post("/verify").returning(@verify_speaker_result, 200, json_type)
+  delete("/verificationProfiles/:profileId").returning("".to_json, 200, json_type)
+end