encoder-rb 0.0.3

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in encoding-rb.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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

@@ -0,0 +1,6 @@
+encoding-rb
+
+Encoding.com ruby wrapper
+
+Copyright (c) 2012 Big Bang Technology Inc. Under the MIT License
+

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc 'Default: run unit tests.'
+task :default => :unit
+
+desc 'Test the ruby_encoding_wrapper plugin.'
+RSpec::Core::RakeTask.new('unit') do |t|
+  t.pattern = 'spec/*/{*_spec.rb}'
+end
+

data/encoder.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "encoder/version"
+
+Gem::Specification.new do |s|
+  s.name        = "encoder-rb"
+  s.version     = Encoder::VERSION
+  s.authors     = ["Big Bang Technology Inc."]
+  s.email       = ["cameron@bigbangtechnology.com"]
+  s.homepage    = ""
+  s.summary     = %q{Ruby Client Library for Encoding.com}
+
+  s.rubyforge_project = "encoder-rb"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "fakeweb"
+
+  s.add_runtime_dependency "builder"
+  s.add_runtime_dependency "nokogiri"
+end

data/lib/encoder/version.rb

@@ -0,0 +1,3 @@
+module Encoder
+  VERSION = "0.0.3"
+end

data/lib/encoder.rb

@@ -0,0 +1,159 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'uri'
+require 'net/http'
+require 'builder'
+require 'nokogiri'
+require 'encoder/version'
+
+module EncodingActions
+  ADD_MEDIA = "AddMedia"
+  GET_STATUS = "GetStatus"
+  CANCEL_MEDIA = "CancelMedia"
+end
+
+module EncodingStatusType
+  NEW = "New"
+  WAITING = "Waiting for encoder"
+  PROCESSING = "Processing"
+  SAVING = "Saving"
+  FINISHED = "Finished"
+  ERROR = "Error"
+end
+
+module ErrorMessage
+  AUTHENTICATION = "Wrong user id or key!"
+  NO_FORMATS = "No formats specified!"
+  NO_SOURCE = "Source file is not indicated!"
+end
+
+module RequestResponse
+  ERROR = nil
+end
+
+module Encoder
+  def self.new
+    Client.new
+  end
+
+  class Client
+    attr_reader :user_id, :user_key, :url, :last_error
+
+    def initialize(user_id=nil, user_key=nil)
+      @user_id = user_id
+      @user_key = user_key
+      @url = 'http://manage.encoding.com/'
+    end
+
+    def request_encoding(source=nil, notify_url=nil)
+      #{ :size, :bitrate, :audio_bitrate, :audio_sample_rate,
+      #:audio_channels_number, :framerate, :two_pass, :cbr,
+      #:deinterlacing, :destination, :add_meta
+
+      xml = Builder::XmlMarkup.new :indent=>2
+      xml.instruct! 
+      xml.query do |q|
+        q.userid  @user_id
+        q.userkey @user_key
+        q.action  EncodingActions::ADD_MEDIA
+        q.source  source
+        q.notify  notify_url
+
+        yield q
+      end
+
+      response = request_send(xml.target!)
+      return RequestResponse::ERROR if request_error?(response)
+
+      document = Nokogiri::XML(response.body)
+      return RequestResponse::ERROR if api_error?(document)
+
+      document.css("MediaID").text.to_i
+    end
+
+    def request_status(media_id)
+      xml = Builder::XmlMarkup.new :indent=>2
+      xml.instruct!
+      xml.query do |q|
+        q.userid    @user_id
+        q.userkey   @user_key
+        q.action    EncodingActions::GET_STATUS
+        q.mediaid   media_id
+      end
+
+      response = request_send(xml.target!)
+      return RequestResponse::ERROR if request_error?(response)
+
+      document = Nokogiri::XML(response.body)
+      return RequestResponse::ERROR if api_error?(document)
+
+      status   = document.css("response > status").text
+      progress = document.css("progress").text.to_i
+
+      # there is a bug where the progress reports
+      # as 100% if the status is 'Waiting for encoder'
+      if (status == EncodingStatusType::WAITING)
+        progress = 0
+      end
+
+      status = { 
+        :message => status,
+        :progress => progress
+      }
+    end
+
+    def cancel_media(media_id)
+      xml = Builder::XmlMarkup.new :indent => 2
+      xml.instruct!
+      xml.query do |q|
+        q.userid    @user_id
+        q.userkey   @user_key
+        q.action    EncodingActions::CANCEL_MEDIA
+        q.mediaid   media_id
+      end
+
+      response = request_send(xml.target!)
+      return RequestResponse::ERROR if request_error?(response)
+
+      document = Nokogiri::XML(response.body)
+      return RequestResponse::ERROR if api_error?(document)
+
+      true
+
+    end
+
+
+    private
+
+    def request_error?(response)
+      if response.code =~ /(4|5)\d+/
+        @last_error = response.message
+        true
+      else
+        false
+      end
+    end
+
+    def api_error?(document)
+      if document.css('errors error').length > 0
+        @last_error = document.css('errors error').text
+        true
+      else
+        false
+      end
+    end
+
+    def request_send(xml)
+      url = URI.parse(@url)
+      request = Net::HTTP::Post.new(url.path)
+      request.form_data = { :xml => xml }
+
+      Net::HTTP.new(url.host, url.port).start { |http|
+        http.request(request)
+      }
+    end
+  end
+end
+
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+dir = File.dirname(__FILE__)
+$LOAD_PATH.unshift "#{dir}/../lib"
+
+require 'fakeweb'
+require 'encoder'
+
+FakeWeb.allow_net_connect = false
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

data/spec/unit/encoder_spec.rb

@@ -0,0 +1,254 @@
+require 'spec_helper'
+
+def fake_error(message)
+  FakeWeb.register_uri(:post, 'http://manage.encoding.com/', :body => "<?xml version=\"1.0\"?><response><errors><error>#{message}</error></errors></response>")
+end
+
+describe Encoder do
+
+  before do
+    FakeWeb.clean_registry
+    @sut = Encoder.new
+  end
+
+  describe "#request_encoding" do
+
+    describe "invalid user id or key" do
+      before do
+        fake_error(ErrorMessage::AUTHENTICATION)
+        @result = @sut.request_encoding {|query|}
+      end
+      it 'should be nil' do
+        @result.should be_nil
+      end
+      it 'should have "Wrong user id or key" as an error' do
+        @sut.last_error.should =~ /#{ErrorMessage::AUTHENTICATION}/
+      end
+    end
+
+    describe "the server returns a 404 error code" do
+      before do
+        FakeWeb.register_uri(:post, "http://manage.encoding.com/", :body => '', :status => ['404', 'Not Found'])
+        @result = @sut.request_encoding { |query| }
+      end
+
+      it 'should return nil' do
+        @result.should be_nil
+      end
+
+      it 'should have "Not Found" as an error' do
+        @sut.last_error.should == 'Not Found'
+      end
+
+    end
+
+    describe "the server returns a 500 error code" do
+      before do
+        FakeWeb.register_uri(:post, "http://manage.encoding.com/", :body => '', :status => ['500', 'Server Error'])
+        @result = @sut.request_encoding { |query| }
+      end
+
+      it 'should return nil' do
+        @result.should be_nil
+      end
+
+      it 'should have "Server Error" as an error' do
+        @sut.last_error.should == 'Server Error'
+      end
+
+    end
+
+    describe "no specified format(s)" do
+      before do
+        fake_error(ErrorMessage::NO_FORMATS)
+        @result = @sut.request_encoding {|query|}
+      end
+
+      it "should have 'No formats specified' as an error" do
+        @sut.last_error.should =~ /#{ErrorMessage::NO_FORMATS}/
+      end
+    end
+
+    describe "no source specified" do
+      before do
+        fake_error(ErrorMessage::NO_SOURCE)
+        @result = @sut.request_encoding do |query|
+          query.format do |f|
+            f.output('iphone')
+          end
+        end
+      end
+
+      it 'should have "Source file is not indicated" as an error' do
+        @sut.last_error.should =~ /#{ErrorMessage::NO_SOURCE}/
+      end
+
+    end
+
+    describe "valid encoding request" do
+      before do
+        @media_id = 1234
+        FakeWeb.register_uri(:post, 'http://manage.encoding.com/', :body => "<?xml version=\"1.0\"?><response><message>Added</message><MediaID>#{@media_id}</MediaID></response>")
+        @result = @sut.request_encoding { |query| }
+      end
+      it 'should return a MediaID' do
+        @result.should == @media_id
+      end
+    end
+
+
+  end
+
+  describe "#request_status" do
+    describe "invalid user id or key" do
+      before do
+        fake_error("Wrong user id or key!")
+        @result = @sut.request_status(1234)
+      end
+      it 'should be nil' do
+        @result.should be_nil
+      end
+      it 'should have "Wrong user id or key" as an error' do
+        @sut.last_error.should =~ /Wrong user id or key/
+      end
+    end
+
+    describe "the server returns a 404 error code" do
+      before do
+        FakeWeb.register_uri(:post, "http://manage.encoding.com/", :body => '', :status => ['404', 'Not Found'])
+        @result = @sut.request_status(1234) 
+      end
+
+      it 'should return nil' do
+        @result.should be_nil
+      end
+
+      it 'should have "Not Found" as an error' do
+        @sut.last_error.should == 'Not Found'
+      end
+
+    end
+
+    describe "the server returns a 500 error code" do
+      before do
+        FakeWeb.register_uri(:post, "http://manage.encoding.com/", :body => '', :status => ['500', 'Server Error'])
+        @result = @sut.request_status(1234) 
+      end
+
+      it 'should return nil' do
+        @result.should be_nil
+      end
+
+      it 'should have "Server Error" as an error' do
+        @sut.last_error.should == 'Server Error'
+      end
+
+    end
+
+    describe "valid status request" do
+      before do
+        @media_id = 1234
+        @progress = 10
+        FakeWeb.register_uri(:post, 'http://manage.encoding.com/', :body => "<?xml version=\"1.0\"?><response><id>#{@media_id}</id><status>#{EncodingStatusType::PROCESSING}</status><progress>#{@progress}</progress></response>")
+        @result = @sut.request_status(@media_id)
+      end
+
+      it 'should return exactly "Processing"' do
+        @result[ :message ].should == EncodingStatusType::PROCESSING
+      end
+
+      it 'should return 10% progress' do
+        @result[ :progress ].should == @progress
+      end
+      
+    end
+
+    describe "waiting for encoder" do
+      before do
+        @media_id = 1234
+        @progress = 100
+        FakeWeb.register_uri(:post, 'http://manage.encoding.com/', :body => "<?xml version=\"1.0\"?><response><id>#{@media_id}</id><status>#{EncodingStatusType::WAITING}</status><progress>#{@progress}</progress></response>")
+        @result = @sut.request_status(@media_id)
+      end
+      it 'should have 0% progress' do
+        @result[ :progress ].should be 0
+      end
+    end
+    
+    describe "finished encoding with multiple formats" do
+      before do
+        @media_id = 1234
+        @progress = 100
+        FakeWeb.register_uri(:post, 'http://manage.encoding.com/', :body => "<?xml version=\"1.0\"?><response><id>#{@media_id}</id><status>#{EncodingStatusType::FINISHED}</status><progress>#{@progress}</progress><format><status>#{EncodingStatusType::FINISHED}</status></format><format><status>#{EncodingStatusType::FINISHED}</status></format></response>")
+        @result = @sut.request_status(@media_id)
+      end
+      
+      it "should have a status of exactly Finished" do
+        @result[ :message ].should == EncodingStatusType::FINISHED
+      end
+    end
+
+  end
+
+  describe "#cancel_media" do
+
+    describe "invalid user id or key" do
+      before do
+        fake_error(ErrorMessage::AUTHENTICATION)
+        @result = @sut.cancel_media(1234)
+      end
+      it 'should be nil' do
+        @result.should be_nil
+      end
+      it 'should have "Wrong user id or key" as an error' do
+        @sut.last_error.should =~ /#{ErrorMessage::AUTHENTICATION}/
+      end
+    end
+
+    describe "the server returns a 404 error code" do
+      before do
+        FakeWeb.register_uri(:post, "http://manage.encoding.com/", :body => '', :status => ['404', 'Not Found'])
+        @result = @sut.cancel_media(1234) 
+      end
+
+      it 'should return nil' do
+        @result.should be_nil
+      end
+
+      it 'should have "Not Found" as an error' do
+        @sut.last_error.should == 'Not Found'
+      end
+
+    end
+
+    describe "the server returns a 500 error code" do
+      before do
+        FakeWeb.register_uri(:post, "http://manage.encoding.com/", :body => '', :status => ['500', 'Server Error'])
+        @result = @sut.cancel_media(1234) 
+      end
+
+      it 'should return nil' do
+        @result.should be_nil
+      end
+
+      it 'should have "Server Error" as an error' do
+        @sut.last_error.should == 'Server Error'
+      end
+
+    end
+
+    describe "valid cancel request" do
+      before do
+        @media_id = 1234
+        FakeWeb.register_uri(:post, 'http://manage.encoding.com/', :body => "<?xml version=\"1.0\"?><response><message>Deleted</message></response></response>")
+        @result = @sut.cancel_media(@media_id)
+      end
+      
+      it 'should return truthy' do
+        @result.should be true
+      end
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: encoder-rb
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Big Bang Technology Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70119603624500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70119603624500
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70119603623840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70119603623840
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &70119603623080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70119603623080
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: &70119603622220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70119603622220
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70119603621440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70119603621440
+description: 
+email:
+- cameron@bigbangtechnology.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .DS_Store
+- .gitignore
+- .rspec
+- Gemfile
+- MIT-LICENSE
+- README
+- Rakefile
+- encoder.gemspec
+- lib/.DS_Store
+- lib/encoder.rb
+- lib/encoder/version.rb
+- spec/.DS_Store
+- spec/spec_helper.rb
+- spec/unit/encoder_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: encoder-rb
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Ruby Client Library for Encoding.com
+test_files:
+- spec/spec_helper.rb
+- spec/unit/encoder_spec.rb
+has_rdoc: