voicebase 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4887234109d06ee9aae59259535dbb17ad263f7c
+  data.tar.gz: ae769013b8a1d712358b41e249fcdd25eb9265a5
+SHA512:
+  metadata.gz: a82e2e7e1ff6d3121d11bf919e80b5a6a2fdb2ee287335eedeaa8599b0cfd30b72ed6bf99b9aeedbaf38177504b481a445c652c98a956a942ad8c36614887d7c
+  data.tar.gz: 6ab149b3e6694f79e5a31f51ff6c2cf244765866f73498d077b3b2bed18d2004580da0f43f3723c118516f77a819c6774d35965921f7c122422f485a4bd4c934

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+CHANGELOG
+---------
+- **2016-01-25**: 0.0.1
+  - Initial release

data/Gemfile

@@ -0,0 +1,9 @@
+source ENV['GEM_SOURCE'] || 'https://rubygems.org'
+
+gem 'coveralls'
+gem 'faraday'
+gem 'faraday_middleware'
+gem 'mocha'
+gem 'rake'
+gem 'simplecov'
+gem 'test-unit'

data/Gemfile.lock

@@ -0,0 +1,53 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coveralls (0.8.1)
+      json (~> 1.8)
+      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.10.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+    docile (1.1.5)
+    domain_name (0.5.24)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    json (1.8.3)
+    metaclass (0.0.4)
+    mime (0.4.2)
+    mime-types (2.6.2)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    netrc (0.10.3)
+    power_assert (0.2.4)
+    rake (10.4.2)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    test-unit (3.1.4)
+      power_assert
+    thor (0.19.1)
+    tins (1.5.2)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coveralls
+  mime
+  mime-types
+  mocha
+  rake
+  simplecov
+  test-unit

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 John Wang
+ 
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,88 @@
+VoiceBase Ruby SDK
+==================
+
+[![Gem Version][gem-version-svg]][gem-version-link]
+[![Build Status][build-status-svg]][build-status-link]
+[![Dependency Status][dependency-status-svg]][dependency-status-link]
+[![Code Climate][codeclimate-status-svg]][codeclimate-status-link]
+[![Scrutinizer Code Quality][scrutinizer-status-svg]][scrutinizer-status-link]
+[![Downloads][downloads-svg]][downloads-link]
+[![Docs][docs-rubydoc-svg]][docs-rubydoc-link]
+[![License][license-svg]][license-link]
+
+## Overview
+
+Transcribe audio using VoiceBase.com service.
+
+## Installation
+
+### Via Bundler
+
+Add 'voicebase' to Gemfile and then run `bundle`:
+
+```sh
+$ echo "gem 'voicebase'" >> Gemfile
+$ bundle
+```
+
+### Via RubyGems
+
+```sh
+$ gem install voicebase
+```
+
+## Usage
+
+### From Filepath
+
+```ruby
+voicebase = VoiceBase::V1::Client.new('myApiKey', 'myPassword')
+
+voicebase.upload_media(
+  :filePath => '/path/to/myFile.mp3'
+  :fileContentType => 'audio/mpeg'
+)
+```
+
+### From URL
+
+```ruby
+voicebase = VoiceBase::V1::Client.new('myApiKey', 'myPassword')
+
+voicebase.upload_media(
+  :mediaUrl => 'http://example.com/path/to/myFile.mp3'
+)
+```
+
+## Change Log
+
+See [CHANGELOG.md](CHANGELOG.md)
+
+## Contributions
+
+Any reports of problems, comments or suggestions are most welcome.
+
+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.
+
+MIMEBuilder © 2016 by John Wang
+
+ [gem-version-svg]: https://badge.fury.io/rb/voicebase.svg
+ [gem-version-link]: http://badge.fury.io/rb/voicebase
+ [downloads-svg]: http://ruby-gem-downloads-badge.herokuapp.com/voicebase
+ [downloads-link]: https://rubygems.org/gems/voicebase
+ [build-status-svg]: https://api.travis-ci.org/grokify/voicebase-sdk-ruby.svg?branch=master
+ [build-status-link]: https://travis-ci.org/grokify/voicebase-sdk-ruby
+ [dependency-status-svg]: https://gemnasium.com/grokify/voicebase-sdk-ruby.svg
+ [dependency-status-link]: https://gemnasium.com/grokify/voicebase-sdk-ruby
+ [codeclimate-status-svg]: https://codeclimate.com/github/grokify/voicebase-sdk-ruby/badges/gpa.svg
+ [codeclimate-status-link]: https://codeclimate.com/github/grokify/voicebase-sdk-ruby
+ [scrutinizer-status-svg]: https://scrutinizer-ci.com/g/grokify/voicebase-sdk-ruby/badges/quality-score.png?b=master
+ [scrutinizer-status-link]: https://scrutinizer-ci.com/g/grokify/voicebase-sdk-ruby/?branch=master
+ [docs-rubydoc-svg]: https://img.shields.io/badge/docs-rubydoc-blue.svg
+ [docs-rubydoc-link]: http://www.rubydoc.info/gems/voicebase/
+ [license-svg]: https://img.shields.io/badge/license-MIT-blue.svg
+ [license-link]: https://github.com/grokify/voicebase-sdk-ruby/blob/master/LICENSE.txt

data/Rakefile

@@ -0,0 +1,20 @@
+require 'rake'
+require 'rake/testtask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the library.'
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/test_*.rb'
+  t.verbose = false
+end
+
+desc 'Generate YARD documentation.'
+task :gendoc do
+  # puts 'yard doc generation disabled until JRuby build native
+  # extensions for redcarpet or yard removes the dependency.'
+  system 'yardoc'
+  system 'yard stats --list-undoc'
+end

data/lib/voicebase.rb

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

data/lib/voicebase/v1.rb

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

data/lib/voicebase/v1/client.rb

@@ -0,0 +1,58 @@
+require 'date'
+require 'faraday'
+require 'faraday_middleware'
+
+module VoiceBase::V1
+  VOICEBASE_API_VERSION = '1.1'
+
+  class Client
+    def initialize(api_key, password, transcript_type='machine-best')
+      @api_key = api_key
+      @password = password
+      @transcript_type = transcript_type
+      @conn_url_encoded = new_http_client :url_encoded
+      @conn_multipart = new_http_client :multipart
+    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.response :json
+        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={})
+      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       => ''
+      }.merge params
+
+      response = nil
+
+      if params.key?(:filePath) && params.key?(:fileContentType)
+        params[:file] = Faraday::UploadIO.new(params[:filePath], params[:fileContentType])
+        params.delete :filePath
+        params.delete :fileContentType
+        response = @conn_multipart.post '/services', params
+      else
+        response = @conn_url_encoded.post '/services', params
+      end
+
+      return response
+    end
+  end
+end

data/test/test_base.rb

@@ -0,0 +1,6 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'test/unit'
+require 'mocha/test_unit'
+require 'voicebase'

data/test/test_setup.rb

@@ -0,0 +1,14 @@
+require './test/test_base.rb'
+
+class VoiceBaseTest < Test::Unit::TestCase
+  def setup
+    @vbsdk = VoiceBase::V1::Client.new(
+      'myApiKey',
+      'myPassword'
+    )
+  end
+
+  def test_main
+    assert_equal 'VoiceBase::V1::Client', @vbsdk.class.name
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: voicebase
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Wang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-25 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
+email: johncwang@gmail.com
+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
+- test/test_base.rb
+- test/test_setup.rb
+homepage: https://github.com/grokify/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: VoiceBase is a Ruby SDK for the VoiceBase API
+test_files: []