voicebase-client-ruby 1.2.4 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b1876791e35e64f7cfc3137f2c8df6b183954776
-  data.tar.gz: 95e70c5ae2df8c0b2dec354e1b496fdaedded626
+SHA256:
+  metadata.gz: db58cab69d568dc60664a1e7887597eaa872b864e86f61a689fea89dd9a8270b
+  data.tar.gz: e022d96cb97446db68e38eed733419d75b1a8c91a56cdb689c2ed83b14db6651
 SHA512:
-  metadata.gz: 817ab808bce6353791cd2012a992cb432a250ed821a0fb4a9e68fe7eabf51f3a2aedf9a570d663a9e73aea624a867cfcda937415983c747c9d087906593acddc
-  data.tar.gz: 8379041f78d9a0b55124e936e06308ab4a180382d77ce6b1f4b404266701de9d68c6eae8dbb5e4786937cfdf60475aa983f5f8b517a023188d32eab0ad77fe70
+  metadata.gz: dbd4a41f6f8fbb4692f3f61882b9d70ef603177d45d4f88e1fd3bb35d083441da617397eba1caa112328c0d51dd82b453e084daa12e237fd6905de9b93ae04d2
+  data.tar.gz: b1cb90bff2ab8fba5ba50288d10d02543b4ebdde5efaa4f09e13539d52e3e103ab986367b5ee7ac4227e337ecb30f0953560185458ad148f7306824d18ae628c

data/.travis.yml

@@ -1,7 +1,9 @@
 language: ruby
 rvm:
-  - 2.0
   - 2.1
   - 2.2
   - 2.3.1
+  - 2.4
+  - 2.5
+  - 2.6
 before_install: gem install bundler -v 1.13.6

data/lib/voicebase.rb

@@ -8,6 +8,7 @@ require "voicebase/helpers"
 
 require "voicebase/v1"
 require "voicebase/v2"
+require "voicebase/v3"
 
 require "voicebase/client"
 require "voicebase/client/token"

data/lib/voicebase/client.rb

@@ -1,4 +1,5 @@
 module VoiceBase
+  class UnknownApiVersionError < StandardError; end;
   class Client
     include HTTParty
 
@@ -30,11 +31,16 @@ module VoiceBase
         @token = VoiceBase::Client::Token.new(ENV['VOICEBASE_BEARER_TOKEN'])
       end
 
-      if @api_version.to_f < 2.0
+      if @api_version.to_i < 2
         self.extend(VoiceBase::V1::Client)
-      else
+      elsif  @api_version.to_i == 2
         self.extend(VoiceBase::V2::Client)
+      elsif @api_version.to_i == 3
+        self.extend(VoiceBase::V3::Client)
+      else
+        raise UnknownApiVersionError
       end
+
     end
 
     def uri

data/lib/voicebase/request/file_part.rb

@@ -0,0 +1,27 @@
+require "mime/types"
+require_relative "text_part"
+
+module VoiceBase
+  module Request
+    class FilePart < TextPart
+      attr_accessor :filepath
+
+      def initialize(name:, file:)
+        @name = name
+        @filepath = file.path
+        @body = file.read
+      end
+
+      def multipart
+        "Content-Disposition: form-data; name=\"#{CGI::escape(name)}\"; filename=\"#{ File.basename(filepath) }\"\r\n" +
+          "Content-Type: #{ mime_type.simplified }\r\n\r\n#{ body }\r\n\r\n"
+      end
+
+      private
+
+      def mime_type
+        MIME::Types.type_for(filepath)[0] || MIME::Types["application/octet-stream"][0]
+      end
+    end
+  end
+end

data/lib/voicebase/request/hash_part.rb

@@ -0,0 +1,13 @@
+require_relative "text_part"
+require "json"
+
+module VoiceBase
+  module Request
+    class HashPart < TextPart
+      def initialize(name:, hash:)
+        @name = name
+        @body = ::JSON.dump(hash)
+      end
+    end
+  end
+end

data/lib/voicebase/request/multipart_builder.rb

@@ -0,0 +1,32 @@
+require "securerandom"
+
+module VoiceBase
+  module Request
+    class MultipartBuilder
+      attr_accessor :parts, :boundary
+      def initialize(headers:)
+        @headers = headers
+        @parts = []
+        @boundary = SecureRandom.hex
+      end
+
+      def add(part)
+        parts << part
+      end
+
+      def body
+        "--#{boundary}\r\n#{multiparts}--#{boundary}--"
+      end
+
+      def headers
+        @headers.merge({"Content-Type" => "multipart/form-data; boundary=#{boundary}"})
+      end
+
+      private
+
+      def multiparts
+        parts.map(&:multipart).join("--#{boundary}\r\n")
+      end
+    end
+  end
+end

data/lib/voicebase/request/text_part.rb

@@ -0,0 +1,15 @@
+module VoiceBase
+  module Request
+    class TextPart
+      attr_accessor :name, :body
+      def initialize(name:, body:)
+        @name = name
+        @body = body
+      end
+
+      def multipart
+        "Content-Disposition: form-data; name=\"#{CGI::escape(name)}\"\r\n\r\n#{body}\r\n"
+      end
+    end
+  end
+end

data/lib/voicebase/response.rb

@@ -7,10 +7,14 @@ module VoiceBase
 
     def initialize(http_response, api_version = "1.1")
       @http_response = http_response
-      if api_version.to_f < 2
+      if api_version.to_i < 2
         self.extend(VoiceBase::V1::Response)
-      else
+      elsif api_version.to_i == 2
         self.extend(VoiceBase::V2::Response)
+      elsif api_version.to_i == 3
+        self.extend(VoiceBase::V3::Response)
+      else
+         raise UnknownApiVersionError
       end
     end
 

data/lib/voicebase/v3.rb

@@ -0,0 +1,10 @@
+module VoiceBase
+  module V3; end
+end
+
+require "voicebase/v3/client"
+require "voicebase/v3/response"
+require "voicebase/request/multipart_builder"
+require "voicebase/request/text_part"
+require "voicebase/request/file_part"
+require "voicebase/request/hash_part"

data/lib/voicebase/v3/client.rb

@@ -0,0 +1,49 @@
+module VoiceBase
+  module V3
+    module Client
+      include VoiceBase::V2::Client
+
+      def self.extended(client, args = {})
+        client.api_host     = client.args[:host] || ENV.fetch('VOICEBASE_V3_API_HOST', 'https://apis.voicebase.com')
+        client.api_endpoint = client.args[:api_endpoint] || ENV.fetch('VOICEBASE_V3_API_ENDPOINT', '/v3')
+      end
+
+      def upload_media(args = {}, headers = {})
+        require_media_file_or_url!(args)
+        r = ::VoiceBase::Request::MultipartBuilder.new(headers: default_headers(headers))
+
+        if args[:config]
+          r.add(VoiceBase::Request::HashPart.new(name: "configuration", hash: args[:config]))
+        end
+
+        if args[:media_url]
+          r.add(VoiceBase::Request::TextPart.new(name: "mediaUrl", body: args[:media_url]))
+        end
+
+        if args[:media_file]
+          r.add(VoiceBase::Request::FilePart.new(name: "media", file: args[:media_file]))
+        end
+
+        #TODO: make metadata an object
+        if args[:metadata]
+          r.add(VoiceBase::Request::HashPart.new(name: "metadata", hash: args[:metadata]))
+        end
+
+        response = self.class.post(
+            uri + '/media',
+            headers: r.headers,
+            body: r.body
+        )
+        VoiceBase::Response.new(response, api_version)
+      end
+
+      private
+
+      def require_media_file_or_url!(args = {})
+        if args[:media_url].nil? && args[:media_file].nil?
+          raise ArgumentError, "Missing argument :media_url or :media_file"
+        end
+      end
+    end
+  end
+end

data/lib/voicebase/v3/response.rb

@@ -0,0 +1,45 @@
+module VoiceBase
+  module V3
+    module Response
+
+      TRANSCRIPT_READY_STATUS = "finished".freeze
+
+      def success?
+        ok?
+      end
+
+      def media_id
+        voicebase_response['mediaId']
+      end
+
+      def transcript_ready?
+        voicebase_response['status'].downcase == TRANSCRIPT_READY_STATUS
+      end
+
+      def transcript
+        # this retrieves the JSON transcript only
+        # the plain text transcript is a plain text non-JSON response
+        voicebase_response['transcript']['words']
+      end
+
+      def keywords
+        knowledge["keywords"]
+      end
+
+      def topics
+        knowledge['topics']
+      end
+
+      private
+
+      def knowledge
+        voicebase_response.fetch("knowledge", {}) || {}
+      end
+
+      def voicebase_response
+        http_response.parsed_response
+      end
+
+    end
+  end
+end

data/lib/voicebase/version.rb

@@ -1,5 +1,5 @@
 module VoiceBase
-  VERSION = "1.2.4"
+  VERSION = "1.3.0"
 
   def self.version; VERSION; end
 end

data/voicebase-client-ruby.gemspec

@@ -6,7 +6,7 @@ require 'voicebase/version'
 Gem::Specification.new do |spec|
   spec.name          = "voicebase-client-ruby"
   spec.version       = VoiceBase::version
-  spec.authors       = ["Juergen Fesslmeier", "April Wensel", "Jerry Hogsett"]
+  spec.authors       = ["Juergen Fesslmeier", "April Wensel", "Jerry Hogsett", "Perry Lee"]
   spec.email         = ["jerry@usertesting.com", "client-dev@usertesting.com"]
 
   spec.summary       = %q{Ruby client for VoiceBase API Version 1.x and 2.x.}

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: voicebase-client-ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.3.0
 platform: ruby
 authors:
 - Juergen Fesslmeier
 - April Wensel
 - Jerry Hogsett
+- Perry Lee
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-07 00:00:00.000000000 Z
+date: 2019-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -121,6 +122,10 @@ files:
 - lib/voicebase/helpers.rb
 - lib/voicebase/json.rb
 - lib/voicebase/json/word.rb
+- lib/voicebase/request/file_part.rb
+- lib/voicebase/request/hash_part.rb
+- lib/voicebase/request/multipart_builder.rb
+- lib/voicebase/request/text_part.rb
 - lib/voicebase/response.rb
 - lib/voicebase/v1.rb
 - lib/voicebase/v1/client.rb
@@ -128,6 +133,9 @@ files:
 - lib/voicebase/v2.rb
 - lib/voicebase/v2/client.rb
 - lib/voicebase/v2/response.rb
+- lib/voicebase/v3.rb
+- lib/voicebase/v3/client.rb
+- lib/voicebase/v3/response.rb
 - lib/voicebase/version.rb
 - voicebase-client-ruby.gemspec
 homepage: https://github.com/usertesting/voicebase-client-ruby
@@ -149,8 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby client for VoiceBase API Version 1.x and 2.x.