cielo24 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e4dc072024de29bb1c0ae47f5c405b3540ea703
+  data.tar.gz: bf4e0476af267ce414663ccf50f4a8b353dab131
+SHA512:
+  metadata.gz: 970bf712df6d087537ae83db28563e8bd1d109427adc42fdff141c99ff0ea407b3e12af1fe07bbf95120944b57752f6bfc01f02ea0d268a26792bf4aea1b538e
+  data.tar.gz: dfa41a39b01104ee353f6627835442e9a3e25d7ab386493d9996c4a841888a52a77adbc81cc8a18e1ed9e15dfd42a174ae44c4ca4d3d471fe2846e0de5b6072d

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cielo24.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alan Johnson
+
+MIT License
+
+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,69 @@
+# Cielo24
+
+Cielo24 is a service for creating video captions and transcripts. This library interacts with the Cielo24 API to submit and retrieve captions.
+
+This is currently an incomplete implementation fo the Cielo24 API to solve my personal needs. Feel free to send a pull request if you want to complete more of the API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cielo24'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cielo24
+
+## Usage
+
+### Authentication:
+
+The Cielo24 team recommend password based authentication, so to configure your username and password:
+
+```
+Cielo24::Client.configure(username: "user", password: "somepass")
+```
+
+You may also authenticate through the Cielo24 sandbox with the following settings (use your own sandbox username and password):
+
+```
+Cielo24::Client.configure(username: "treehouse", password: "p@ssw0rd", 
+    uri: "https://sandbox.cogi.com", verify_mode: OpenSSL::SSL::VERIFY_NONE)
+```
+
+### Submitting a video for captioning:
+
+```
+client = Cielo24::Client.new
+job_id = client.create_job("Test Job")
+client.add_media(job_id, "http://test.com/my-media.mp4")
+task_id = client.perform_transcription(job_id)
+```
+
+Captioning defaults to professional fidelity and standard priority.
+
+### Checking if captions are complete:
+
+```
+client = Cielo24::Client.new
+client.task_complete?(task_id)
+```
+
+### Downloading captions
+
+```
+client = Cielo24::Client.new
+data = client.get_caption(job_id)
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/cielo24.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cielo24/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cielo24"
+  spec.version       = Cielo24::VERSION
+  spec.authors       = ["Alan Johnson"]
+  spec.email         = ["alan@teamtreehouse.com"]
+  spec.description   = %q{Library for submitting and requesting captions from Cielo24.}
+  spec.summary       = %q{Submit and request captions through Cielo24.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+  
+  spec.add_dependency "httpclient", "~> 2.3.4.1"  
+end

data/lib/cielo24.rb

@@ -0,0 +1,11 @@
+require_relative 'cielo24/version'
+require_relative 'cielo24/authentication'
+require_relative 'cielo24/jobs'
+require_relative 'cielo24/client'
+
+require 'uri'
+require 'httpclient'
+require 'json'
+
+module Cielo24
+end

data/lib/cielo24/authentication.rb

@@ -0,0 +1,11 @@
+module Cielo24
+  # Methods for authenticating.
+  module Authentication
+    
+    # Public: Get a api token for this session.
+    def log_in(username, password)
+      data = get_json("/api/account/login", {username: username, password: password})
+      data["ApiToken"]
+    end
+  end
+end

data/lib/cielo24/client.rb

@@ -0,0 +1,83 @@
+module Cielo24
+
+  # Class for interacting with the Cielo24 API.
+  class Client
+    include Cielo24::Authentication
+    include Cielo24::Jobs
+
+    attr_accessor :connection
+    attr_accessor :token
+
+    DEFAULT_URI = "https://api.cielo24.com"
+    VERSION = 1
+    VERIFY_MODE = nil
+
+    # Public: Configures the connection.
+    #
+    # options - the configuration options for use with Cielo24.
+    #     :username - The username to use for authentication.
+    #     :password - The password to use for authentication.
+    #     :uri - The uri to use for requests. Defaults to the Cielo24 API URI.
+    def self.configure(options = {})
+      @options = {uri: DEFAULT_URI, version: VERSION, verify_mode: VERIFY_MODE}.merge(options)
+    end
+
+    # Internal: Our configuration settings for Cielo24.
+    def self.options
+      @options ||= {}
+    end
+
+    def initialize
+      self.connection = connect
+
+      # Go ahead and set up the single use token for this session
+      @token = log_in(self.class.options[:username], self.class.options[:password])
+    end
+
+    # Internal: Returns an HTTPClient connection object.
+    def connect
+      connection = HTTPClient.new
+      connection.cookie_manager = nil
+
+      unless self.class.options[:verify_mode] == nil
+        connection.ssl_config.verify_mode = self.class.options[:verify_mode]
+      end
+
+      return connection
+    end
+
+    # Internal: Makes a get request with the given parameters.
+    #
+    # path - The path to request.
+    # params - The parameters to include with the request.
+    #
+    # Returns the JSON for the response we received.
+    def get(path, params = {})
+      uri = URI(self.class.options[:uri])
+      uri.path = path
+
+      # add api version to each request
+      params = {v: self.class.options[:version]}.merge(params)
+
+      # add token if possible
+      if token
+        params = {api_token: token}.merge(params)
+      end
+
+      response = connection.get(uri, params)
+      if response.status_code == 200
+        return response.body
+      else
+        # Cielo24 always returns error messages as JSON
+        raise(JSON.parse(response.body)["ErrorComment"])
+      end
+    end
+
+    # Internal: Makes a request to Cielo24 and returns JSON data
+    def get_json(path, params)
+      body = get(path, params)
+
+      JSON.parse(body)
+    end
+  end
+end

data/lib/cielo24/jobs.rb

@@ -0,0 +1,72 @@
+module Cielo24
+  module Jobs
+
+    # Public: Creates a new job.
+    #
+    # job_name - A human-readable name for the job to be created.
+    # language - An RFC 5646 Language tag indicating native job language. Defaults to ‘en’.
+    #
+    # Returns a job id for the newly created job.
+    def create_job(job_name, language = "en")
+      data = get_json("/api/job/new", {job_name: job_name, language: language})
+
+      return data["JobId"]
+    end
+
+    # Public: Attaches media to a job.
+    #
+    # job_id - The id of a job to attach media to.
+    # media_url - The URL of the media file to attach to the job.
+    #
+    # Returns the task id for the media.
+    def add_media(job_id, media_url)
+      data = get_json("/api/job/add_media", {job_id: job_id, media_url: media_url})
+
+      data["TaskId"]
+    end
+
+    # Public: Requests that a transcription be performed.
+    # 
+    # job_id - The id of a job to attach media to.
+    # fidelity - Should be one of MECHANICAL, PREMIUM, or PROFESSIONAL. Default: PROFESSIONAL
+    # priority - Should be one of ECONOMY, STANDARD, or PRIORITY. Default: STANDARD
+    # 
+    # Returns the task id for the transcription.
+    def perform_transcription(job_id, fidelity = "PROFESSIONAL", priority = "STANDARD")
+      data = get_json("/api/job/perform_transcription", 
+          {job_id: job_id, transcription_fidelity: fidelity, priority: priority})
+
+      data["TaskId"]
+    end
+
+    # Public: Requests info about a particular job.
+    #
+    # job_id - The job to get info about.
+    #
+    # Returns
+    def job_info(job_id)
+      get_json("/api/job/info", {job_id: job_id})
+    end
+
+    # Public: Returns whether or not a task has completed.
+    #
+    # task_id - The task to check status for.
+    #
+    # Returns true if the task is complete, false otherwise.
+    def task_complete?(task_id)
+      get_json("/api/job/task_status", {task_id: task_id})["TaskStatus"] == "COMPLETED"
+    end
+
+    # Public: Gets the caption results from a job.
+    #
+    # job_id - The id of the job we're pulling captions for.
+    # caption_format - THe format for the captions. SRT, SBV, DFXP, or QT. Defaults to SRT.
+    # options - Additional optional parameters for requesting captions. See the Cielo24 documentation
+    #           for the list of optional parameters.
+    #
+    # Returns the caption data as text.
+    def get_caption(job_id, caption_format = "SRT", options = {})
+      get("/api/job/get_caption", options.merge(caption_format: caption_format, job_id: job_id))
+    end
+  end
+end

data/lib/cielo24/version.rb

@@ -0,0 +1,3 @@
+module Cielo24
+  VERSION = "0.0.1"
+end

data/spec/jobs_spec.rb

@@ -0,0 +1,73 @@
+require "spec_helper"
+
+describe "Cielo24::Jobs" do
+
+  let(:client) { Cielo24::Client.new }
+
+  let(:job_id) do
+    stub_get_json("/api/job/new", {"JobId" => "JOB123"})
+    client.create_job("Test Job")
+  end
+
+  let(:job_with_media_id) do
+    stub_get_json("/api/job/add_media", {"TaskId" => "TASK123"})
+    client.add_media(job_id, "http://test.com/media.mp4")
+
+    job_id
+  end
+
+  let(:transcribed_job_id) do
+    stub_get_json("/api/job/perform_transcription", { "TaskId" => "TASK123"})
+    client.perform_transcription(job_with_media_id)
+
+    # it unfortunately takes a second to get a successful caption back from the
+    # sandbox
+    sleep(3) if test_sandbox?
+  end
+
+  describe "#create_job" do
+    it "returns the job id for the newly created job" do
+      stub_get_json("/api/job/new", {"JobId" => "JOB123"})
+      expect(client.create_job("Some New Job")).to_not be_nil
+    end
+  end
+
+  describe "#add_media" do
+    it "returns the task id for the media that was added" do
+      stub_get_json("/api/job/add_media", {"TaskId" => "TASK123"})
+      expect(client.add_media(job_id, "http://test.com/test_media.mp4")).to_not be_nil
+    end
+  end
+
+  describe "#perform_transcription" do
+    it "returns the task id for the transcription" do
+      stub_get_json("/api/job/perform_transcription", {"TaskId" => "TASK123"})
+      expect(client.perform_transcription(job_with_media_id)).to_not be_nil
+    end
+  end
+
+  describe "#task_complete?" do
+    it "returns true if the task has completed" do
+      pending("CANNOT GUARANTEE COMPLETED JOB IN SANDBOX") if test_sandbox?
+
+      stub_get_json("/api/job/task_status", {"TaskStatus" => "COMPLETED"})
+      expect(client.task_complete?("TASK123")).to be_true
+    end
+
+    it "returns false if the task hasn't completed" do
+      pending("CANNOT GUARANTEE INCOMPLETE JOB IN SANDBOX") if test_sandbox?
+
+      stub_get_json("/api/job/task_status", {"TaskStatus" => "INCOMPLETE"})
+      expect(client.task_complete?("TASK123")).to be_false
+    end
+  end
+
+  describe "get_caption" do
+    it "returns the captions" do
+      pending("SANDBOX DOESN'T ALWAYS RETURN CAPTIONS CORRECTLY") if test_sandbox?
+      
+      stub_get("/api/job/get_caption", "SOME CAPTION DATA")
+      expect(client.get_caption(transcribed_job_id)).to_not be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,57 @@
+require_relative "../lib/cielo24"
+
+if ENV["CIELO24_SANDBOX"]
+  Cielo24::Client.configure(username: ENV["CIELO24_SANDBOX_USERNAME"], 
+      password: ENV["CIELO24_SANDBOX_PASSWORD"], 
+      uri: "https://sandbox.cogi.com", verify_mode: OpenSSL::SSL::VERIFY_NONE)
+end
+
+
+module Cielo24
+  module SpecHelpers
+
+    # Internal: Returns whether or not we're testing against the sandbox.
+    def test_sandbox?
+      !ENV["CIELO24_SANDBOX"].nil?
+    end
+
+    # Internal: Stubs the get_json method unless we're testing against the sandbox.
+    # 
+    # path - The api path to stub.
+    # value - The value to return from the stubbed call.
+    #
+    # Examples:
+    #     stub_get_json("/api/job/new", {"JobId" => "12345"})
+    #     => get_json returns {"JobId" => "12345"}
+    def stub_get_json(path, value)
+      unless test_sandbox?
+        Cielo24::Client.any_instance.stub(:get_json).with(path, an_instance_of(Hash)).and_return(value)
+      end
+    end
+
+    # Internal: STubs the get method unless we're testing against the sandbox.
+    #
+    # path - The api path to stub.
+    # value - The value to return from the stubbed call.
+    #
+    # Examples:
+    #    stub_get("/api/job/get_caption", "SOME CAPTION DATA")
+    #    => get returns "SOME CAPTION DATA"
+    def stub_get(path, value)
+      unless test_sandbox?
+        Cielo24::Client.any_instance.stub(:get).with(path, an_instance_of(Hash)).and_return(value)
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include Cielo24::SpecHelpers
+
+  # Stub out logging in if needed
+  config.before(:each) do
+    unless test_sandbox?
+      Cielo24::Client.any_instance.stub(:log_in).and_return("FOOBARTOKEN")
+    end
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: cielo24
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alan Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.4.1
+description: Library for submitting and requesting captions from Cielo24.
+email:
+- alan@teamtreehouse.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cielo24.gemspec
+- lib/cielo24.rb
+- lib/cielo24/authentication.rb
+- lib/cielo24/client.rb
+- lib/cielo24/jobs.rb
+- lib/cielo24/version.rb
+- spec/jobs_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.0.6
+signing_key: 
+specification_version: 4
+summary: Submit and request captions through Cielo24.
+test_files:
+- spec/jobs_spec.rb
+- spec/spec_helper.rb
+has_rdoc: