flixit 0.0.11

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Leandro Pedroni
+
+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,21 @@
+flixit
+======
+
+Heavily based on the [flixcloud gem](http://github.com/flixcloud/flix_cloud-gem).
+I removed dependancies on a specific httpclient. To play nice with fakeweb this gem relies on rest-client.
+I will improve tests as I go.
+
+Note on Patches/Pull Requests
+----------------------------- 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+Copyright
+---------
+
+Copyright (c) 2010 Leandro Pedroni. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "flixit"
+    gem.summary = %Q{Interface with flixcloud.com api}
+    gem.description = %Q{Performs requests and interprets responses with flixcloud.com}
+    gem.email = "ilpoldo@gmail.com"
+    gem.homepage = "http://github.com/ilpoldo/flixit"
+    gem.authors = ["Leandro Pedroni"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "fredo", ">= 0.1.5"
+    
+    gem.add_dependency('rest-client', '>= 1.4.0')
+    gem.add_dependency('builder', '>= 2.1.1')
+    gem.add_dependency('crack', '>= 0.1.6')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "flixit #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.11

data/lib/flixit.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'rest_client'
+require 'builder'
+require 'crack'
+
+require 'flixit/ext/hash'
+require 'flixit/record'
+require 'flixit/job'
+require 'flixit/file_locations'
+require 'flixit/file'
+require 'flixit/parameters'
+require 'flixit/response'
+require 'flixit/exceptions'
+require 'flixit/notification'
+
+module Flixit
+  
+  VERSION = ::File.exist?('VERSION') ? ::File.read('VERSION') : ""
+  
+end

data/lib/flixit/exceptions.rb

@@ -0,0 +1,9 @@
+class Flixit::Error < StandardError; end
+class Flixit::SaveError < Flixit::Error; end
+class Flixit::CreateError < Flixit::Error; end
+class Flixit::ServerBrokeConnection < Flixit::Error; end
+class Flixit::RequestTimeout < Flixit::Error; end
+class Flixit::ConnectionRefused < Flixit::Error; end
+
+class Flixit::AuthenticationError < Flixit::Error
+end

data/lib/flixit/ext/hash.rb

@@ -0,0 +1,22 @@
+module Flixit
+  module Extensions
+    # Both methods ripped directly out of rails
+    module Hash
+      def deep_merge(other_hash)
+        self.merge(other_hash) do |key, oldval, newval|
+          oldval = oldval.to_hash if oldval.respond_to?(:to_hash)
+          newval = newval.to_hash if newval.respond_to?(:to_hash)
+          oldval.class.to_s == 'Hash' && newval.class.to_s == 'Hash' ? oldval.deep_merge(newval) : newval
+        end
+      end
+
+      # Returns a new hash with +self+ and +other_hash+ merged recursively.
+      # Modifies the receiver in place.
+      def deep_merge!(other_hash)
+        replace(deep_merge(other_hash))
+      end
+    end
+  end
+end
+
+Hash.send(:include, Flixit::Extensions::Hash) unless Hash.instance_methods.include?('deep_merge')

data/lib/flixit/file.rb

@@ -0,0 +1,21 @@
+class Flixit::File < Flixit::Record
+
+  attr_accessor :url, :size, :width, :height, :duration, :cost
+
+  record_column :parameters, 'Parameters'
+
+  def valid?
+    self.errors = []
+
+    unless url
+      self.errors << "url is required"
+    end
+
+    if parameters && !parameters.valid?
+      self.errors << {:parameters => parameters.errors}
+    end
+
+    errors.empty?
+  end
+
+end

data/lib/flixit/file_locations.rb

@@ -0,0 +1,34 @@
+class Flixit::FileLocations < Flixit::Record
+
+  record_column :input, 'File'
+  record_column :output, 'File'
+  record_column :watermark, 'File'
+  record_column :thumbnails, 'File'
+
+  def valid?
+    self.errors = []
+
+    if input
+      unless input.valid?
+        self.errors << {:input => input.errors}
+      end
+    else
+      self.errors << "input is required"
+    end
+
+    if output
+      unless output.valid?
+        self.errors << {:output => output.errors}
+      end
+    else
+      self.errors << "output is required"
+    end
+
+    if watermark && !watermark.valid?
+      self.errors << {:watermark => watermark.errors}
+    end
+
+    errors.empty?
+  end
+
+end

data/lib/flixit/job.rb

@@ -0,0 +1,161 @@
+class Flixit::Job < Flixit::Record
+
+  attr_accessor :id, :initialized_at, :api_key, :recipe_id, :recipe_name, :response, :notification_url
+
+  record_column :file_locations, 'FileLocations'
+
+  def initialize(attrs={})
+    super
+    self.shortcut_attributes = attrs
+  end
+
+  def valid?
+    self.errors = []
+
+    if file_locations
+      unless file_locations.valid?
+        self.errors << {:file_locations => file_locations.errors}
+      end
+    else
+      self.errors << "file_locations is required"
+    end
+
+    if recipe_id || recipe_name
+      if recipe_id && recipe_name
+        self.errors << "recipe_id and recipe_name cannot both be used"
+      end
+    else
+      self.errors << "recipe_id or recipe_name is required"
+    end
+
+    unless api_key
+      self.errors << "api_key is required"
+    end
+
+    errors.empty?
+  end
+
+  def save
+    return false unless valid?
+
+    self.response = post('jobs', to_xml)
+
+    if response.success?
+      self.id = response.body_as_hash['job']['id']
+      self.initialized_at = response.body_as_hash['job']['initialized_job_at']
+    else
+      self.errors = response.errors
+    end
+
+    response.success?
+  end
+
+  def save!
+    raise Flixit::SaveError unless save
+    true
+  end
+
+  def self.create(attrs={})
+    job = new(attrs)
+    job.save
+    job
+  end
+
+  def self.create!(attrs={})
+    job = create(attrs)
+    raise Flixit::CreateError unless job.id
+    job
+  end
+
+  def to_xml
+    xml = Builder::XmlMarkup.new
+
+    xml.instruct! :xml, :version => "1.0", :encoding => "UTF-8"
+
+    xml.tag!("api-request") do
+      xml.tag!("api-key", api_key)
+
+      if recipe_name
+        xml.tag!("recipe-name", recipe_name)
+      else
+        xml.tag!("recipe-id", recipe_id)
+      end
+
+      if notification_url
+        xml.tag!('notification-url', notification_url)
+      end
+
+      if file_locations
+        xml.tag!("file-locations") do
+          if file_locations.input
+            xml.input do
+              xml.url(file_locations.input.url)
+              if file_locations.input.parameters
+                xml.parameters do
+                  xml.user(file_locations.input.parameters.user)
+                  xml.password(file_locations.input.parameters.password)
+                end
+              end
+            end
+          end
+
+          if file_locations.output
+            xml.output do
+              xml.url(file_locations.output.url)
+              if file_locations.output.parameters
+                xml.parameters do
+                  xml.user(file_locations.output.parameters.user)
+                  xml.password(file_locations.output.parameters.password)
+                end
+              end
+            end
+          end
+
+          if file_locations.watermark
+            xml.watermark do
+              xml.url(file_locations.watermark.url)
+              if file_locations.watermark.parameters
+                xml.parameters do
+                  xml.user(file_locations.watermark.parameters.user)
+                  xml.password(file_locations.watermark.parameters.password)
+                end
+              end
+            end
+          end
+
+          if file_locations.thumbnails
+            xml.thumbnails do
+              xml.url(file_locations.thumbnails.url)
+              xml.prefix "thumb_"
+            end
+          end
+        end
+      end
+    end
+
+    xml.target!
+  end
+
+
+protected
+
+  def shortcut_attributes=(attrs)
+    translated_attributes = {}
+
+    attrs.each do |key, value|
+      if match = key.to_s.match(/^(input|output|watermark|thumbnails)_(url|user|password)$/)
+        file_type = match[1].to_sym
+        parameter_type = match[2].to_sym
+
+        if parameter_type == :url
+          translated_attributes.deep_merge!(:file_locations => { file_type => { :url => value}})
+        else
+          translated_attributes.deep_merge!(:file_locations => { file_type => { :parameters => { parameter_type => value}}})
+        end
+      end
+    end
+
+    self.attributes = translated_attributes unless translated_attributes.empty?
+  end
+
+end

data/lib/flixit/notification.rb

@@ -0,0 +1,32 @@
+class Flixit::Notification < Flixit::Record
+  attr_accessor :xml, :id, :finished_job_at, :initialized_job_at,
+                :recipe_name, :recipe_id, :state, :error_message
+
+  record_column :input_media_file, 'File'
+  record_column :output_media_file, 'File'
+  record_column :watermark_file, 'File'
+
+  def initialize(attrs={})
+    if attrs.is_a?(String)
+      self.xml = attrs
+      attrs = Crack::XML.parse(attrs)
+    end
+
+    attrs = attrs['job'] if attrs['job']
+
+    super(attrs)
+  end
+
+  def successful?
+    state == 'successful_job'
+  end
+
+  def failed?
+    state == 'failed_job'
+  end
+
+  def cancelled?
+    state == 'cancelled_job'
+  end
+
+end

data/lib/flixit/parameters.rb

@@ -0,0 +1,19 @@
+class Flixit::Parameters < Flixit::File
+
+  attr_accessor :user, :password
+
+  def valid?
+    self.errors = []
+
+    unless user
+      self.errors << "user is required"
+    end
+
+    unless password
+      self.errors << "password is required"
+    end
+
+    errors.empty?
+  end
+
+end

data/lib/flixit/record.rb

@@ -0,0 +1,45 @@
+class Flixit::Record
+
+  attr_accessor :errors
+
+  def initialize(attrs={})
+    self.errors = []
+    self.attributes = attrs
+  end
+
+  def attributes=(attrs)
+    attrs.each do |key, value|
+      send("#{key}=", value) if respond_to?("#{key}=")
+    end
+  end
+
+  def self.record_column(attribute, klass)
+    eval %{
+      attr_reader :#{attribute}
+
+      def #{attribute}=(value)
+        if @#{attribute}
+          @#{attribute}.attributes = value
+        else
+          @#{attribute} = Flixit::#{klass}.new(value)
+        end
+      end
+    }
+  end
+
+
+protected
+
+  def post(path, body)
+    begin
+      Flixit::Response.new(RestClient.post "https://flixcloud.com/#{path}", body, :content_type => :xml, :accept => :xml)
+    # rescue HTTPClient::KeepAliveDisconnected
+    #   raise Flixit::ServerBrokeConnection, $!.message
+    # rescue HTTPClient::ReceiveTimeoutError
+    #   raise Flixit::RequestTimeout, $!.message
+    # rescue HTTPClient::ConnectTimeoutError
+    #   raise Flixit::ConnectionRefused, $!.message
+    end
+  end
+
+end

data/lib/flixit/response.rb

@@ -0,0 +1,29 @@
+class Flixit::Response
+
+  attr_accessor :code, :body, :errors, :body_as_hash
+
+  def initialize(response)
+    self.body = response.body
+    case self.code = response.code
+    when 401 then raise Flixit::AuthenticationError
+    else  
+      self.body_as_hash = Crack::XML.parse(response.body)
+      self.errors = []
+      process_response_xml
+    end
+  end
+
+  def success?
+    201 == code.to_i
+  end
+
+
+protected
+
+  def process_response_xml
+    if body_as_hash['errors'] && body_as_hash['errors'].is_a?(Hash) && body_as_hash['errors']['error']
+      self.errors = Array(body_as_hash['errors']['error'])
+    end
+  end
+
+end

data/spec/flixit_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Flixit" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/job_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+
+context "Create a Job" do
+  before(:each) do
+    @job = Flixit::Job.new(:recipe_id => 1,
+                           :api_key => 'this_is_an_api_key',
+                           :file_locations => { :input =>      {:url => 'http://flixcloud.com/somefile.mp4'},
+                                                :output =>     {:url => 's3://flixcloud/somefile.flv'},
+                                                :thumbnails => {:url => "s3://flixcloud/somefile/",:prefix => 'thumbnail'}})
+    Fredo.post "https://flixcloud.com/jobs" do
+      %{<?xml version="1.0" encoding="UTF-8"?><job><id type="integer">3254</id><initialized-job-at type="datetime">2009-02-11T01:23:54Z</initialized-job-at></job>}
+    end
+
+  end
+  
+  it "formats a message for flixcloud" do
+    @job.to_xml.should eql(%{<?xml version=\"1.0\" encoding=\"UTF-8\"?><api-request><api-key>this_is_an_api_key</api-key><recipe-id>1</recipe-id><file-locations><input><url>http://flixcloud.com/somefile.mp4</url></input><output><url>s3://flixcloud/somefile.flv</url></output><thumbnails><url>s3://flixcloud/somefile/</url><prefix>thumb_</prefix></thumbnails></file-locations></api-request>})
+  end
+  
+  it "posts a message to flixcloud" do    
+    @job.save
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'flixit'
+require 'spec'
+require 'spec/autorun'
+require 'fredo'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification 
+name: flixit
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 11
+  version: 0.0.11
+platform: ruby
+authors: 
+- Leandro Pedroni
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-27 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: fredo
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 5
+        version: 0.1.5
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 0
+        version: 1.4.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: builder
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 1
+        version: 2.1.1
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: crack
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 6
+        version: 0.1.6
+  type: :runtime
+  version_requirements: *id005
+description: Performs requests and interprets responses with flixcloud.com
+email: ilpoldo@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/flixit.rb
+- lib/flixit/exceptions.rb
+- lib/flixit/ext/hash.rb
+- lib/flixit/file.rb
+- lib/flixit/file_locations.rb
+- lib/flixit/job.rb
+- lib/flixit/notification.rb
+- lib/flixit/parameters.rb
+- lib/flixit/record.rb
+- lib/flixit/response.rb
+- spec/flixit_spec.rb
+- spec/job_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/ilpoldo/flixit
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Interface with flixcloud.com api
+test_files: 
+- spec/flixit_spec.rb
+- spec/job_spec.rb
+- spec/spec_helper.rb