moovatom 0.1.0

data/init.rb

@@ -0,0 +1 @@
+require 'moovatom'

data/lib/moovatom/version.rb

@@ -0,0 +1,3 @@
+module MoovAtom
+  VERSION = "0.1.0"
+end

data/lib/moovatom.rb

@@ -0,0 +1,146 @@
+# :title: MoovAtom API Documentation
+# The MoovEngine API provides the RESTful interface for encoding, canceling and querying,
+# your videos on the MoovAtom servers. This library defines the methods and functionality
+# necessary for your app to communicate with that interface.
+#
+# See README file for installation details and general usage information.
+#
+# Author:: Dominic Giglio <mailto:humanshell@gmail.com>
+# Copyright:: Copyright (c) 2011 Dominic Giglio - All Rights Reserved
+# License:: MIT
+
+#-- required gems/libraries
+%w[net/https rexml/document builder uri].each { |item| require item }
+
+#-- wrap the whole library in a module to enforce namespace
+module MoovAtom
+  
+  #-- MoovAtom module constants
+  API_URL  = 'https://moovatom.com/api/api_request'
+  
+  class MoovEngine
+    
+    #-- class setters and getters
+    attr_reader :xml_response
+    attr_accessor :guid, :username, :userkey, :content_type, :title, :blurb, :sourcefile, :callbackurl
+    
+    # The initializer creates a set of instance variables to hold all the specifics about
+    # the video you're accessing. You can define these variables when instantiating a new
+    # MoovEngine object or after a blank object has been created. All variables with the
+    # exception of @xml_response and @action are writable. @xml_response is only readable
+    # because it contains the respnse from MoovAtom's servers. @action gets set in each of
+    # the methods below to correctly correspond with the associated request.
+    #
+    # Usage:
+    # * moov_engine = MoovAtom::MoovEngine.new
+    # * moov_engine.username = 'YOUR_USERNAME'
+    # * moov_engine.userkey = 'YOUR_USERKEY'
+    # * etc...
+    #
+    # Or:
+    # * args = { :username => 'YOUR_USERNAME', :userkey => 'YOUR_USERKEY', etc... }
+    # * moov_engine = MoovAtom::MoovEngine.new(args)
+    def initialize(args={})
+      @guid         = args[:guid]
+      @username     = args[:username]
+      @userkey      = args[:userkey]
+      @content_type = args[:content_type] || "video"
+      @title        = args[:title]
+      @blurb        = args[:blurb]
+      @sourcefile   = args[:sourcefile]
+      @callbackurl  = args[:callbackurl]
+    end #-- end initialize method
+    
+    # Use this method to get the details about a video that's finished encoding.
+    # This method requires @username, @userkey and @guid to be set.
+    #
+    # @TODO add the ability to yield to a block
+    #
+    # Usage:
+    # * moov_engine.details 'GUID_OF_VIDEO'
+    def details(guid)
+      @guid = guid
+      @action = 'details'
+      @xml_response = send_xml_request(build_xml_request)
+    end #-- end details method
+    
+    # Use this method to get the status of a video that is currently being encoded.
+    # This method requires @username, @userkey and @guid to be set.
+    #
+    # @TODO add the ability to yield to a block
+    #
+    # Usage:
+    # * moov_engine.status 'GUID_OF_VIDEO'
+    def status(guid)
+      @guid = guid
+      @action = 'status'
+      @xml_response = send_xml_request(build_xml_request)
+    end #-- end status method
+    
+    # Use this method to start encoding a new video.
+    # This method requires the following variables be set:
+    # * @username
+    # * @userkey
+    # * @content_type
+    # * @title
+    # * @blurb
+    # * @sourcefile
+    # * @callbackurl
+    #
+    # @TODO this method <b>REALLY</b> needs to be able to yield to a block!
+    #
+    # Usage:
+    # * moov_engine.status 'GUID_OF_VIDEO'
+    def encode
+      @action = 'encode'
+      @xml_response = send_xml_request(build_xml_request)
+      
+      if @xml_response.code == "200"
+        xml_doc = REXML::Document.new @xml_response.body
+        @guid = xml_doc.root.elements["uuid"].text
+      end
+    end #-- end encode method
+    
+    # Use this method to cancel the encoding of a video.
+    # This method requires @username, @userkey and @guid to be set.
+    #
+    # Usage:
+    # * moov_engine.cancel 'GUID_OF_VIDEO'
+    def cancel(guid)
+      @guid = guid
+      @action = 'cancel'
+      @xml_response = send_xml_request(build_xml_request)
+    end #-- end cancel method
+    
+    #-- start of private methods
+    private
+    
+    # Creates the XML object that is post'd to the MoovAtom servers
+    def build_xml_request
+      b = Builder::XmlMarkup.new
+      b.instruct!
+      xml = b.request do |r|
+        r.uuid(@guid)
+        r.username(@username)
+        r.userkey(@userkey)
+        r.action(@action)
+        r.content_type(@content_type)
+        r.title(@title)
+        r.blurb(@blurb)
+        r.sourcefile(@sourcefile)
+        r.callbackurl(@callbackurl)
+      end
+    end #-- end build_xml_request method
+    
+    # Sends the XML object to the MoovAtom servers
+    def send_xml_request(xml)
+      uri = URI.parse(MoovAtom::API_URL)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      response = http.post(uri.request_uri, "xml=#{URI.escape(xml)}")
+    end #-- end send_xml_request method
+    
+  end #-- end MoovEngine class
+  
+end #-- end MoovAtom module

data/moovatom.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "moovatom/version"
+
+Gem::Specification.new do |s|
+  
+  #-- author info
+  s.authors           = ["Dominic Giglio"]
+  s.email             = ["humanshell@gmail.com"]
+  s.homepage          = "http://moovatom.com"
+  
+  #-- gem info
+  s.name              = "moovatom"
+  s.version           = MoovAtom::VERSION
+  s.summary           = %q{Access MoovAtom API}
+  s.description       = %q{This gem defines methods for controlling your videos on MoovAtom using the MoovEngine API.}
+  s.rubyforge_project = "moovatom"
+  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"]
+  
+  #-- dependency info
+  s.add_dependency('builder')
+  
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: moovatom
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Dominic Giglio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-10 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: &70127118816140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70127118816140
+description: This gem defines methods for controlling your videos on MoovAtom using
+  the MoovEngine API.
+email:
+- humanshell@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- doc/Gemfile.html
+- doc/LICENSE_txt.html
+- doc/MoovAtom.html
+- doc/MoovAtom/MoovEngine.html
+- doc/Rakefile.html
+- doc/created.rid
+- doc/images/brick.png
+- doc/images/brick_link.png
+- doc/images/bug.png
+- doc/images/bullet_black.png
+- doc/images/bullet_toggle_minus.png
+- doc/images/bullet_toggle_plus.png
+- doc/images/date.png
+- doc/images/find.png
+- doc/images/loadingAnimation.gif
+- doc/images/macFFBgHack.png
+- doc/images/package.png
+- doc/images/page_green.png
+- doc/images/page_white_text.png
+- doc/images/page_white_width.png
+- doc/images/plugin.png
+- doc/images/ruby.png
+- doc/images/tag_green.png
+- doc/images/wrench.png
+- doc/images/wrench_orange.png
+- doc/images/zoom.png
+- doc/index.html
+- doc/init_rb.html
+- doc/js/darkfish.js
+- doc/js/jquery.js
+- doc/js/quicksearch.js
+- doc/js/thickbox-compressed.js
+- doc/lib/moovatom/version_rb.html
+- doc/lib/moovatom_rb.html
+- doc/rdoc.css
+- init.rb
+- lib/moovatom.rb
+- lib/moovatom/version.rb
+- moovatom.gemspec
+homepage: http://moovatom.com
+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: moovatom
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Access MoovAtom API
+test_files: []