voicebase 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4887234109d06ee9aae59259535dbb17ad263f7c
-  data.tar.gz: ae769013b8a1d712358b41e249fcdd25eb9265a5
+  metadata.gz: bd58117befe74a4921b5224da4d60b4ce1b03186
+  data.tar.gz: 9939f9f183c1ccb1eeba9901ca91890ebe07ca47
 SHA512:
-  metadata.gz: a82e2e7e1ff6d3121d11bf919e80b5a6a2fdb2ee287335eedeaa8599b0cfd30b72ed6bf99b9aeedbaf38177504b481a445c652c98a956a942ad8c36614887d7c
-  data.tar.gz: 6ab149b3e6694f79e5a31f51ff6c2cf244765866f73498d077b3b2bed18d2004580da0f43f3723c118516f77a819c6774d35965921f7c122422f485a4bd4c934
+  metadata.gz: 8668f2b6816639bbf9e59a33e32e6e75e251110b73f29e15aba07fd8178005db307211df8c48e0501184dc87b958df3d22e82bf308c9f423221e6f94597b400d
+  data.tar.gz: 81423b784a94bf38b72b03caa36b518e692e4312bb5f2f6a7a71494098f0b8c4a2fdca00978704111827525fd90581ade91295699b9fdc7fd37500d3200b5b39

data/CHANGELOG.md

@@ -1,4 +1,6 @@
 CHANGELOG
 ---------
 - **2016-01-25**: 0.0.1
-  - Initial release
+  - Initial release
+  - Upload media from file system
+  - Upload media from URL

data/README.md

@@ -12,13 +12,13 @@ VoiceBase Ruby SDK
 
 ## Overview
 
-Transcribe audio using VoiceBase.com service.
+Ruby SDK for VoiceBase.com audio transcription service.
 
 ## Installation
 
 ### Via Bundler
 
-Add 'voicebase' to Gemfile and then run `bundle`:
+Add `voicebase` to Gemfile and then run `bundle`:
 
 ```sh
 $ echo "gem 'voicebase'" >> Gemfile
@@ -33,18 +33,30 @@ $ gem install voicebase
 
 ## Usage
 
-### From Filepath
+### Upload Media
+
+The `upload_media` method will accept a hash of parameters to send to the VoiceBase API. All supported parameters can be passed in.
+
+#### From Filepath
+
+Using SDK helper the `:filePath` and `:fileContentType` parameters will be auto-converted to a `:file` parameter supported by the VoiceBase API. It is also possible to directly include a `:file` parameter using `Faraday::UploadIO`.
 
 ```ruby
 voicebase = VoiceBase::V1::Client.new('myApiKey', 'myPassword')
 
+# Using SDK Helpers
 voicebase.upload_media(
   :filePath => '/path/to/myFile.mp3'
   :fileContentType => 'audio/mpeg'
 )
+
+# Using Faraday::UploadIO directly
+voicebase.upload_media(
+  :file => Faraday::UploadIO.new('/path/to/myFile.mp3', 'audio/mpeg')
+)
 ```
 
-### From URL
+#### From URL
 
 ```ruby
 voicebase = VoiceBase::V1::Client.new('myApiKey', 'myPassword')
@@ -58,6 +70,12 @@ voicebase.upload_media(
 
 See [CHANGELOG.md](CHANGELOG.md)
 
+## Links
+
+Project Repo
+
+* https://github.com/grokify/voicebase-sdk-ruby
+
 ## Contributions
 
 Any reports of problems, comments or suggestions are most welcome.
@@ -66,9 +84,9 @@ Please report these on [Github](https://github.com/grokify/voicebase-sdk-ruby)
 
 ## License
 
-MIMEBuilder is available under an MIT-style license. See [LICENSE.txt](LICENSE.txt) for details.
+VoiceBase Ruby SDK is available under an MIT-style license. See [LICENSE.txt](LICENSE.txt) for details.
 
-MIMEBuilder © 2016 by John Wang
+VoiceBase Ruby SDK © 2016 by John Wang
 
  [gem-version-svg]: https://badge.fury.io/rb/voicebase.svg
  [gem-version-link]: http://badge.fury.io/rb/voicebase

data/Rakefile

@@ -2,7 +2,7 @@ require 'rake'
 require 'rake/testtask'
 
 desc 'Default: run unit tests.'
-task :default => :test
+task default: :test
 
 desc 'Test the library.'
 Rake::TestTask.new do |t|

data/lib/voicebase.rb

@@ -1,7 +1,7 @@
 module VoiceBase
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 
   VOICEBASE_API_BASE_PATH = 'https://api.voicebase.com/services'
 
   autoload :V1, 'voicebase/v1'
-end
+end

data/lib/voicebase/v1.rb

@@ -1,3 +1,5 @@
-module VoiceBase::V1
-  autoload :Client, 'voicebase/v1/client'
-end
+module VoiceBase
+  module V1
+    autoload :Client, 'voicebase/v1/client'
+  end
+end

data/lib/voicebase/v1/client.rb

@@ -5,8 +5,11 @@ require 'faraday_middleware'
 module VoiceBase::V1
   VOICEBASE_API_VERSION = '1.1'
 
+  attr_accessor :conn_url_encoded
+  attr_accessor :conn_multipart
+
   class Client
-    def initialize(api_key, password, transcript_type='machine-best')
+    def initialize(api_key, password, transcript_type = 'machine-best')
       @api_key = api_key
       @password = password
       @transcript_type = transcript_type
@@ -15,44 +18,43 @@ module VoiceBase::V1
     end
 
     def new_http_client(request = :url_encoded)
-      conn = Faraday.new(:url => VoiceBase::VOICEBASE_API_BASE_PATH) do |faraday|
-        faraday.request  request                  # multipart/form-data
+      Faraday.new(url: VoiceBase::VOICEBASE_API_BASE_PATH) \
+      do |faraday|
+        faraday.request request
         faraday.response :json
-        faraday.response :logger                  # log requests to STDOUT
-        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+        faraday.response :logger                # log requests to STDOUT
+        faraday.adapter Faraday.default_adapter # make requests with Net::HTTP
       end
-      return conn
     end
 
-    def upload_media(params={})
+    def upload_media(params = {})
       params = {
-        :version        => VOICEBASE_API_VERSION,
-        :apikey         => @api_key,
-        :password       => @password,
-        :action         => 'uploadMedia',
-        :title          => DateTime.now.strftime('%Y-%m-%d %I:%M:%S %p'),
-        :transcriptType => @transcript_type,
-        :desc           => 'file description',
-        :recordedDate   => DateTime.now.strftime('%Y-%m-%d %I:%M:%S'),
-        :collection     => '',
-        :public         => false,
-        :sourceUrl      => '',
-        :lang           => 'en',
-        :imageUrl       => ''
+        version: VOICEBASE_API_VERSION,
+        apikey: @api_key,
+        password: @password,
+        action: 'uploadMedia',
+        title: DateTime.now.strftime('%Y-%m-%d %I:%M:%S %p'),
+        transcriptType: @transcript_type,
+        desc: 'file description',
+        recordedDate: DateTime.now.strftime('%Y-%m-%d %I:%M:%S'),
+        collection: '',
+        public: false,
+        sourceUrl: '',
+        lang: 'en',
+        imageUrl: ''
       }.merge params
 
-      response = nil
-
       if params.key?(:filePath) && params.key?(:fileContentType)
-        params[:file] = Faraday::UploadIO.new(params[:filePath], params[:fileContentType])
+        params[:file] = Faraday::UploadIO.new(
+          params[:filePath],
+          params[:fileContentType]
+        )
         params.delete :filePath
         params.delete :fileContentType
-        response = @conn_multipart.post '/services', params
+        return @conn_multipart.post '/services', params
       else
-        response = @conn_url_encoded.post '/services', params
+        return @conn_url_encoded.post '/services', params
       end
-
-      return response
     end
   end
-end
+end

data/test/test_setup.rb

@@ -10,5 +10,7 @@ class VoiceBaseTest < Test::Unit::TestCase
 
   def test_main
     assert_equal 'VoiceBase::V1::Client', @vbsdk.class.name
+
+    assert_equal 'Faraday::Connection', @vbsdk.new_http_client.class.name
   end
 end

data/voicebase.gemspec

@@ -0,0 +1,19 @@
+lib = 'voicebase'
+lib_file = File.expand_path("../lib/#{lib}.rb", __FILE__)
+File.read(lib_file) =~ /\bVERSION\s*=\s*["'](.+?)["']/
+version = $1
+
+Gem::Specification.new do |s|
+  s.name        = lib
+  s.version     = version
+  s.date        = '2016-01-30'
+  s.summary     = 'VoiceBase is a Ruby SDK for the VoiceBase API'
+  s.description = 'Helper library to transcribe audio'
+  s.authors     = ['John Wang']
+  s.email       = 'johncwang@gmail.com'
+  s.homepage    = 'https://github.com/grokify/'
+  s.licenses    = ['MIT']
+  s.files       = Dir['lib/**/**/*'] + Dir['[A-Z]*'] + Dir['test/**/*']
+  # s.files.reject! { |fn| fn.include? "CVS" }
+  s.add_dependency 'faraday_middleware', '~> 0', '>= 0'
+end

metadata

@@ -1,33 +1,33 @@
 --- !ruby/object:Gem::Specification
 name: voicebase
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-25 00:00:00.000000000 Z
+date: 2016-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Helper library to transcribe audio
@@ -36,17 +36,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/voicebase/v1/client.rb
-- lib/voicebase/v1.rb
-- lib/voicebase.rb
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- Rakefile
 - README.md
+- Rakefile
+- lib/voicebase.rb
+- lib/voicebase/v1.rb
+- lib/voicebase/v1/client.rb
 - test/test_base.rb
 - test/test_setup.rb
+- voicebase.gemspec
 homepage: https://github.com/grokify/
 licenses:
 - MIT
@@ -57,17 +58,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: VoiceBase is a Ruby SDK for the VoiceBase API