cielo24 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34c8bd4e8d0e69f444549855053d3586842451d7
-  data.tar.gz: 221e505a00b96f4bf4e5b3c51976c570592c629e
+  metadata.gz: 688492c209e5e419abe9c75cdbcd5f64e6a1a68a
+  data.tar.gz: 0a7f8ceb04c9c35ad3c770328977b571fe10efe8
 SHA512:
-  metadata.gz: 90ebd99c577803c2fca0d3a7ef5c8fd88d397928a940533e93f76cf9465ce540b1e1f11bb05099b8eeb9f5db6289d9fb7ccd2bde8b666914ac2793763bd93550
-  data.tar.gz: 416d31cb27851b07f55f278d2b27bb952ae42e499458d65ef5959e730030a77d92bbb21e16cf746c4548ca7a88c5e2ddedac3eec7f95e3c427ecb0688080ebfc
+  metadata.gz: 907ddbc758b372ce37d8eaca182e0945e6beb2bff62cfdf640829c2a91f889c4bb0ffd3349789bf0cfd8295a33755c1818e05260c708760bfb968c0be0e40bfa
+  data.tar.gz: 97d8014a43aa4709a58e0bd33ba8c75a3a7116b8a224fce2b0a6bb97210c7d5a0ce6eda4bc578ec77b42e1d7b6c5e4b8199170c09eb17521a800fa0782ce4fd0

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+bin/

data/CHANGELOG

@@ -0,0 +1,27 @@
+# Changelog
+
+## 0.0.3 - 2014-07-01
+
+Special thanks to [zackm](https://github.com/zackm) for his contributions on this release. It's pretty much
+all him!
+
+### Added
+
+- The configure method now supports using logins with passwords or with longer
+term API keys, using the `api_key` option.
+- Added the `task_status` method.
+- Added the `get_transcript` method.
+- `perform_transcription` now supports an options hash for additional Cielo24
+options.
+
+### Deprecated
+
+- Nothing.
+
+### Removed
+
+- Nothing.
+
+### Fixed
+
+- Nothing.

data/README.md

@@ -1,6 +1,8 @@
 # Cielo24
 
-Cielo24 is a service for creating video captions and transcripts. This library interacts with the Cielo24 API to submit and retrieve captions.
+[ ![Codeship Status for commondream/cielo24](https://www.codeship.io/projects/3b4c3d90-e3ac-0131-3a67-06aaa1f2b67c/status)](https://www.codeship.io/projects/25486)
+
+Cielo24 is a service for creating video captions and transcripts. This library interacts with the Cielo24 API to submit and retrieve captions. Cielo24 API documentation is available [here](http://cielo24.com/static/cielo24/documents/Cielo24ServicesAPI-v1.4.9.pdf).
 
 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.
 
@@ -25,14 +27,20 @@ Or install it yourself as:
 The Cielo24 team recommend password based authentication, so to configure your username and password:
 
 ```
-Cielo24::Client.configure(username: "user", password: "somepass")
+Cielo24::Client.configure({username: "user", password: "somepass"})
+```
+
+Alternatively, you can login with your username and API key:
+
+```
+Cielo24::Client.configure({username: "user", securekey: "api_key"})
 ```
 
 You may also authenticate through the Cielo24 sandbox with the following settings (use your own sandbox username and password):
 
 ```
 Cielo24::Client.configure(username: "username", password: "password", 
-    uri: "https://sandbox.cogi.com", verify_mode: OpenSSL::SSL::VERIFY_NONE)
+    uri: "https://sandbox.cielo24.com", verify_mode: OpenSSL::SSL::VERIFY_NONE)
 ```
 
 ### Submitting a video for captioning:
@@ -49,21 +57,52 @@ Captioning defaults to professional fidelity and standard priority.
 ### Checking if captions are complete:
 
 ```
-client = Cielo24::Client.new
 client.task_complete?(task_id)
 ```
 
-### Downloading captions
+### Downloading captions:
 
 ```
-client = Cielo24::Client.new
 data = client.get_caption(job_id)
 ```
 
+#### Optional arguments
+
+```
+format = "DFXP" # Defaults to "SRT"
+options = {:remove_sound_references => true} # add as many or as few options as you like
+data = client.get_caption(job_id, format, options)
+```
+
+### Downloading transcripts:
+
+```
+data = client.get_transcript(job_id)
+```
+
+#### Optional arguments
+
+```
+options = {:remove_sound_references => true}
+data = client.get_transcript(job_id, options)
+```
+
+### Get Job Info:
+
+```
+json_data = client.job_info(job_id)
+```
+
+### Get Task Status:
+
+```
+json_data = client.task_status(task_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
+5. Create new Pull Request

data/lib/cielo24/authentication.rb

@@ -3,8 +3,12 @@ module Cielo24
   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})
+    #
+    # options - a Hash with either of the following sets of keys:
+    #     username, password
+    #     username, securekey
+    def log_in(options)
+      data = get_json("/api/account/login", options)
       data["ApiToken"]
     end
   end

data/lib/cielo24/client.rb

@@ -17,6 +17,7 @@ module Cielo24
     # options - the configuration options for use with Cielo24.
     #     :username - The username to use for authentication.
     #     :password - The password to use for authentication.
+    #     :api_key - The API key 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)
@@ -30,8 +31,14 @@ module Cielo24
     def initialize
       self.connection = connect
 
+      login_options = {username: self.class.options[:username]}
+      if self.class.options[:api_key]
+        login_options['securekey'] = self.class.options[:api_key]
+      else
+        login_options['password'] = self.class.options[:password]
+      end
       # Go ahead and set up the single use token for this session
-      @token = log_in(self.class.options[:username], self.class.options[:password])
+      @token = log_in(login_options)
     end
 
     # Internal: Returns an HTTPClient connection object.

data/lib/cielo24/jobs.rb

@@ -30,11 +30,13 @@ module Cielo24
     # 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
+    # options - Additional optional parameters for perform the transcription. See the Cielo24 documentation
+    #           for the full list.
     # 
     # 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})
+    def perform_transcription(job_id, fidelity = "PROFESSIONAL", priority = "STANDARD", options = {})
+      options = options.merge(job_id: job_id, transcription_fidelity: fidelity, priority: priority)
+      data = get_json("/api/job/perform_transcription", options)
 
       data["TaskId"]
     end
@@ -43,18 +45,27 @@ module Cielo24
     #
     # job_id - The job to get info about.
     #
-    # Returns
+    # Returns the job info as JSON
     def job_info(job_id)
       get_json("/api/job/info", {job_id: job_id})
     end
 
+    # Public: Requests the status info for a particular task.
+    #
+    # task_id - The task to get info about.
+    #
+    # Returns the task info as JSON
+    def task_status(task_id)
+      get_json("/api/job/task_status", {task_id: task_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"] == "COMPLETE"
+      task_status(task_id)["TaskStatus"] == "COMPLETE"
     end
 
     # Public: Gets the caption results from a job.
@@ -68,5 +79,16 @@ module Cielo24
     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
+
+    # Public: Gets the transcript results from a job.
+    #
+    # job_id - The id of the job we're retrieving a transcription for.
+    # options - Optional parameters for requesting transcripts. See the Cielo24 documentation
+    #           for the full list of parameters.
+    #
+    # Returns the transcript data as text.
+    def get_transcript(job_id, options = {})
+      get("/api/job/get_transcript", options.merge(job_id: job_id))
+    end
   end
 end

data/lib/cielo24/version.rb

@@ -1,3 +1,3 @@
 module Cielo24
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/jobs_spec.rb

@@ -62,7 +62,21 @@ describe "Cielo24::Jobs" do
     end
   end
 
-  describe "get_caption" do
+  describe "#job_info" do
+    it "returns job info" do
+      stub_get_json("/api/job/info", {"JobId" => "JOB123", "JobName" => "A Test Job"})
+      expect(client.job_info(job_id)).to_not be_nil
+    end
+  end
+
+  describe "#task_status" do
+    it "returns the task status" do
+      stub_get_json("/api/job/task_status", {"TaskId" => "TASK123", "TaskType" => "JOB_PERFORM_TRANSCRIPT"})
+      expect(client.task_status("TASK123")).to_not be_nil
+    end
+  end
+
+  describe "#get_caption" do
     it "returns the captions" do
       pending("SANDBOX DOESN'T ALWAYS RETURN CAPTIONS CORRECTLY") if test_sandbox?
       
@@ -70,4 +84,13 @@ describe "Cielo24::Jobs" do
       expect(client.get_caption(transcribed_job_id)).to_not be_nil
     end
   end
+
+  describe "#get_transcript" do
+    it "returns the transcripts" do
+      pending("SANDBOX DOESN'T ALWAYS RETURN TRANSCRIPTS CORRECTLY") if test_sandbox?
+
+      stub_get("/api/job/get_transcript", "This is some transcript data.")
+      expect(client.get_transcript(transcribed_job_id)).to_not be_nil
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -54,4 +54,5 @@ RSpec.configure do |config|
       Cielo24::Client.any_instance.stub(:log_in).and_return("FOOBARTOKEN")
     end
   end
-end
+end
+

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: cielo24
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Alan Johnson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-12 00:00:00.000000000 Z
+date: 2014-07-02 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.
@@ -73,7 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- CHANGELOG
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -96,21 +97,20 @@ 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
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Submit and request captions through Cielo24.
 test_files:
 - spec/jobs_spec.rb
 - spec/spec_helper.rb
-has_rdoc: