vj-sdk 0.2.1

data/spec/files/text.txt

@@ -0,0 +1 @@
+Today, we celebrate the first glorious anniversary of the Information Purification Directives. We have created, for the first time in all history, a garden of pure ideology. Where each worker may bloom secure from the pests purveying contradictory thoughts. Our Unification of Thoughts is more powerful a weapon than any fleet or army on earth. We are one people, with one will, one resolve, one cause. Our enemies shall talk themselves to death and we will bury them with their own confusion. We shall prevail! 

data/spec/helpers/be_equal_to.rb

@@ -0,0 +1,26 @@
+class BeEqualTo
+  def initialize(expectation)
+    @expectation = expectation
+  end
+  
+  def matches?(instance)
+    @instance = instance
+    return @instance == @expectation
+  end
+  
+  def description
+    "be equal to #{@expectation}"
+  end
+  
+  def failure_message
+    " expected to be equal to #{@expectation}, but was not, and had the following errors:\n #{@instance}"
+  end
+  
+  def negative_failure_message
+    " expected to not be valid, but was. (Are you missing a validation?)"
+  end
+end
+
+def be_equal_to(expectation)
+  BeEqualTo.new(expectation)
+end

data/spec/helpers/spec_fixtures.rb

@@ -0,0 +1,227 @@
+=begin rdoc
+  SDK Fixtures
+  
+  Here is a fixture helper. It helps you generate good attributes for use in your
+  test instances.
+=end
+
+module Videojuicer
+  
+  module FixtureHelper
+    def self.included(base)
+      base.send(:include, InstanceMethods)
+      base.send(:extend, ClassMethods)
+    end
+    
+    module ClassMethods
+      def gen(fixture=:default, overrides={})
+        fixture, overrides = :default, fixture if fixture.is_a?(Hash)
+        create(gen_attributes(fixture).merge(overrides))
+      end
+      
+      def gen_attributes(fixture=:default)
+        attribute_proc(fixture).call
+      end
+      def blank_attributes(fixture=:default)
+        gen_attributes(fixture).inject({}) do |memo, (key, value)|
+          memo.update(key => " ")
+        end
+      end
+      def attribute_proc(fixture=:default)
+        @attribute_procs[fixture]
+      end
+      def set_attribute_proc(fixture=:default, &block)
+        @attribute_procs ||= {}
+        @attribute_procs[fixture] = block
+      end
+    end
+    
+    module InstanceMethods
+      
+    end
+  end
+  
+  class User
+    include FixtureHelper
+    set_attribute_proc {{
+      :login => /testuser(\d{1,5})/.gen,
+      :name => /(\d{1,5}) Jones/.gen,
+      :email => /test(\d{1,5}+)@test\.videojuicer\.com/.gen,
+      :password => "#{p = rand(99999)}",
+      :password_confirmation => p
+    }}
+  end
+  
+  class Presentation    
+    include FixtureHelper
+    set_attribute_proc {{
+      :title=>/Presentation title (\d{1,5})/.gen,
+      :abstract=>/Presentation abstract (\d{1,5})/.gen,
+      :author=>"Bob Anon"
+    }}
+  end
+  
+  class Campaign
+    include FixtureHelper
+    set_attribute_proc {{
+      :name => /\w+/.gen
+    }}
+  end
+  
+  class Campaign::CampaignPolicy
+    include FixtureHelper
+    set_attribute_proc {{
+	    :campaign_id => Campaign.gen.id,
+	    :presentation_id => (Presentation.first.id rescue Presentation.gen.id)
+    }}
+  end
+  
+  class Criterion::DateRange
+    include FixtureHelper
+    set_attribute_proc {{
+      :until => DateTime.send(:today) + 1,
+      :from => DateTime.send(:today) - 1
+    }}
+  end
+  
+  class Criterion::Geolocation
+    include FixtureHelper
+    set_attribute_proc {{
+      :city => "Columbus", 
+      :region => "OH",
+      :country => "United States"
+    }}
+  end
+  
+  class Criterion::Request
+    include FixtureHelper
+    set_attribute_proc {{
+      :referrer => "http://www.google.com"
+    }}
+  end
+  
+  class Criterion::Time
+    include FixtureHelper
+    set_attribute_proc {{
+      :from => (Time.now - 3600).strftime("%H:%M"),
+      :until => (Time.now + 3600).strftime("%H:%M")
+    }}
+  end
+  
+  class Criterion::WeekDay
+    include FixtureHelper
+    set_attribute_proc {{
+      :monday => true
+    }}
+  end
+  
+  class Promo::Image
+    include FixtureHelper
+    set_attribute_proc {{
+      :role => "Thumbnail",
+      :href => "http://www.videojuicer.com",
+      :asset_id => 1
+    }}
+  end
+  
+  class Promo::Audio
+    include FixtureHelper
+    set_attribute_proc {{
+      :role => "Voice Over",
+      :href => "http://www.videojuicer.com",
+      :asset_id => 1
+    }}
+  end
+  
+  class Promo::Video
+    include FixtureHelper
+    set_attribute_proc {{
+      :role => "preroll",
+      :href => "http://www.videojuicer.com",
+      :asset_id => 1
+    }}
+  end
+  
+  class Promo::Text
+    include FixtureHelper
+    set_attribute_proc {{
+      :role => "Description",
+      :href => "http://www.videojuicer.com",
+      :asset_id => 1
+    }}
+  end
+  
+  class Asset::Audio
+    include FixtureHelper
+    set_attribute_proc {{
+      :user_id        => rand(100) + 1,
+      :licensed_at    => Time.now,
+      :licensed_by    => "foo, bar",
+      :licensed_under => "CC BY:NC:SA",
+      :published_at   => Time.now,
+      :file => File.open(File.join(File.dirname(__FILE__), "..", "files", "audio.mp3"))
+    }}
+  end
+  
+  class Asset::Image
+    include FixtureHelper
+    set_attribute_proc {{
+      :user_id        => rand(100) + 1,
+      :licensed_at    => Time.now,
+      :licensed_by    => "foo, bar",
+      :licensed_under => "CC BY:NC:SA",
+      :published_at   => Time.now,
+      :file => File.open(File.join(File.dirname(__FILE__), "..", "files", "image.jpg"))
+    }}
+  end
+  
+  class Asset::Flash
+    include FixtureHelper
+    set_attribute_proc {{
+      :user_id        => rand(100) + 1,
+      :licensed_at    => Time.now,
+      :licensed_by    => "foo, bar",
+      :licensed_under => "CC BY:NC:SA",
+      :published_at   => Time.now,
+      :file => File.open(File.join(File.dirname(__FILE__), "..", "files", "flash.swf"))
+    }}
+  end
+  
+  class Asset::Text
+    include FixtureHelper
+    set_attribute_proc {{
+      :user_id        => rand(100) + 1,
+      :licensed_at    => Time.now,
+      :licensed_by    => "foo, bar",
+      :licensed_under => "CC BY:NC:SA",
+      :published_at   => Time.now,
+      :file => File.open(File.join(File.dirname(__FILE__), "..", "files", "text.txt"))
+    }}
+  end
+  
+  class Asset::Video
+    include FixtureHelper
+    set_attribute_proc {{
+      :user_id           => rand(100) + 1,
+      :licensed_at       => Time.now,
+      :licensed_by       => "foo, bar",
+      :licensed_under    => "CC BY:NC:SA",
+      :published_at      => Time.now,
+      :file => File.open(File.join(File.dirname(__FILE__), "..", "files", "video.mov"))
+    }}
+  end
+  
+  class Preset
+    include FixtureHelper
+    set_attribute_proc {{
+      :name         => /\w{10}/.gen,
+      :derived_type => "Video",
+      :file_format  => "mp4",
+      :audio_format => "libfaac",
+      :video_format => "mpeg4",
+      :width        => 640,
+      :height       => 480
+    }}
+  end
+    
+end

data/spec/helpers/spec_helper.rb

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'spec'
+require 'yaml'
+
+unless defined?(Mash)
+  # Don't require Mash twice. It causes cranial trauma.
+  require 'mash'
+end
+
+begin
+  require 'randexp'
+rescue LoadError
+  raise "The Randexp gem is required in order to run the test suites, but it is not required to use the SDK in production environments. To run the tests, please `sudo gem install randexp`"
+end
+
+require File.join(File.dirname(__FILE__), "..", "..", "lib", "videojuicer")
+require File.join(File.dirname(__FILE__), "..", "shared", "configurable_spec")
+require File.join(File.dirname(__FILE__), "..", "shared", "model_spec")
+require File.join(File.dirname(__FILE__), "..", "shared", "resource_spec")
+require File.join(File.dirname(__FILE__), "..", "shared", "embeddable_spec")
+require File.join(File.dirname(__FILE__), "..", "shared", "dependent_spec")
+require File.join(File.dirname(__FILE__), "..", "shared", "asset_spec")
+
+# Load the fixture helper
+require File.join(File.dirname(__FILE__), "spec_fixtures")
+
+module SpecHelper
+  
+  def configure_test_settings(overrides={})
+    Videojuicer.configure!({
+      :api_version      => 1,
+      :protocol         => "http",
+      :host             => "localhost",
+      :port             => 6666,
+      :consumer_key     => fixtures["write-master"]["consumer"]["consumer_key"],
+      :consumer_secret  => fixtures["write-master"]["consumer"]["consumer_secret"],
+      :token            => fixtures["write-master"]["authorized_token"]["oauth_token"],
+      :token_secret     => fixtures["write-master"]["authorized_token"]["oauth_token_secret"],
+      :seed_name        => fixtures["seed"]["name"]
+    }.merge(overrides))
+  end
+  
+  def fixtures
+    fixture_path = File.join(File.dirname(__FILE__), "..", "..", "core-fixtures.yml")
+    fixture_src = File.open(fixture_path).read
+    @core_fixtures ||= Mash.new(YAML.load(fixture_src))
+  end
+  
+end
+
+Spec::Runner.configure do |config|
+    config.include(SpecHelper)
+end

data/spec/presentation_spec.rb

@@ -0,0 +1,25 @@
+require File.join(File.dirname(__FILE__), "helpers", "spec_helper")
+
+describe Videojuicer::Presentation do
+  
+  before(:all) do
+    @klass = Videojuicer::Presentation
+    configure_test_settings
+  end
+
+  describe "instantiation" do
+    it_should_behave_like "a configurable"
+  end
+  
+  describe "general interface:" do
+    before(:all) do
+      @singular_name = "presentation"
+      @plural_name = "presentations"
+    end
+    
+    it_should_behave_like "a RESTFUL resource model"
+    it_should_behave_like "an embeddable"
+  end
+  
+  
+end

data/spec/preset_spec.rb

@@ -0,0 +1,30 @@
+require File.join(File.dirname(__FILE__), "helpers",  "spec_helper")
+
+describe Videojuicer::Preset do
+  
+  before(:all) do
+    @klass = Videojuicer::Preset
+    configure_test_settings
+  end
+  
+  describe "instantiation" do
+    it_should_behave_like "a configurable"
+  end
+  
+  describe "general interface:" do
+    before(:all) do
+      @singular_name = "preset"
+      @plural_name = "presets"
+    end
+    
+    it_should_behave_like "a RESTFUL resource model"
+  end
+  
+  describe "formats" do
+    it "should return a hash of available file, audio and video formats" do
+      formats = @klass.formats
+      formats.should be_kind_of(Hash)
+      formats.keys.sort.should == %w(audio_formats file_formats video_formats)
+    end
+  end
+end

data/spec/promos/audio_spec.rb

@@ -0,0 +1,23 @@
+require File.join(File.dirname(__FILE__), "..", "helpers",  "spec_helper")
+
+describe Videojuicer::Promo::Audio do
+
+   before(:all) do
+    @klass = Videojuicer::Promo::Audio
+    configure_test_settings
+  end
+  
+  describe "instantiation" do
+    it_should_behave_like "a configurable"
+  end
+  
+  describe "general interface:" do
+    before(:all) do
+      @singular_name = "promo"
+      @plural_name = "promos/audio"
+    end
+    
+    it_should_behave_like "a dependent non-resource object"
+  end
+
+end

data/spec/promos/image_spec.rb

@@ -0,0 +1,24 @@
+require File.join(File.dirname(__FILE__), "..", "helpers",  "spec_helper")
+
+describe Videojuicer::Promo::Image do
+
+   before(:all) do
+    @klass = Videojuicer::Promo::Image
+    configure_test_settings
+  end
+  
+  describe "instantiation" do
+    it_should_behave_like "a configurable"
+  end
+  
+  describe "general interface:" do
+    before(:all) do
+      @singular_name = "promo"
+      @plural_name = "promos/image"
+    end
+    
+    it_should_behave_like "a dependent non-resource object"
+  end
+
+end
+  

data/spec/promos/text_spec.rb

@@ -0,0 +1,23 @@
+require File.join(File.dirname(__FILE__), "..", "helpers",  "spec_helper")
+
+describe Videojuicer::Promo::Text do
+
+   before(:all) do
+    @klass = Videojuicer::Promo::Text
+    configure_test_settings
+  end
+  
+  describe "instantiation" do
+    it_should_behave_like "a configurable"
+  end
+  
+  describe "general interface:" do
+    before(:all) do
+      @singular_name = "promo"
+      @plural_name = "promos/text"
+    end
+    
+    it_should_behave_like "a dependent non-resource object"
+  end
+
+end

data/spec/promos/video_spec.rb

@@ -0,0 +1,23 @@
+require File.join(File.dirname(__FILE__), "..", "helpers",  "spec_helper")
+
+describe Videojuicer::Promo::Video do
+
+   before(:all) do
+    @klass = Videojuicer::Promo::Video
+    configure_test_settings
+  end
+  
+  describe "instantiation" do
+    it_should_behave_like "a configurable"
+  end
+  
+  describe "general interface:" do
+    before(:all) do
+      @singular_name = "promo"
+      @plural_name = "promos/video"
+    end
+    
+    it_should_behave_like "a dependent non-resource object"
+  end
+
+end

data/spec/property_registry_spec.rb

@@ -0,0 +1,130 @@
+require File.join(File.dirname(__FILE__), "helpers", "spec_helper")
+
+describe Videojuicer::Resource::PropertyRegistry do
+
+  describe "attribute registry" do
+    before(:all) do
+      class ::FooAttributeRegistry
+        include Videojuicer::Resource::PropertyRegistry
+      
+        property :integer, Integer
+        property :string, String
+        property :string_with_default, String, :default=>"this is the default"
+      end
+    
+      class ::BarAttributeRegistry
+        include Videojuicer::Resource::PropertyRegistry
+      
+        property :bar, String
+      end
+    
+      class ::NameConditionTestRegistry
+        include Videojuicer::Resource::PropertyRegistry
+      
+        property :name, String
+        property :email, String          
+      end
+    
+      class ::PrivatePropertyRegistry
+        include Videojuicer::Resource::PropertyRegistry
+      
+        property :private_attr, String, :writer=>:private
+        property :public_attr, String          
+      end
+      
+      class ::DateRegistry
+        include Videojuicer::Resource::PropertyRegistry
+        
+        property :date, DateTime
+      end
+    end
+    before(:each) do
+      @example_registry = ::FooAttributeRegistry.new
+      @example_private_prop_registry = ::PrivatePropertyRegistry.new
+      @date_registry = ::DateRegistry.new
+    end
+  
+    it "registers an attribute with a type at the class scope" do
+      ::FooAttributeRegistry.attributes.should include(:integer)
+      ::FooAttributeRegistry.attributes.should include(:string)
+      ::FooAttributeRegistry.attributes.should include(:string_with_default)
+      ::FooAttributeRegistry.attributes.should_not include(:bar)
+    
+      ::BarAttributeRegistry.attributes.should include(:bar)
+      ::BarAttributeRegistry.attributes.should_not include(:integer)
+      ::BarAttributeRegistry.attributes.should_not include(:string)
+      ::BarAttributeRegistry.attributes.should_not include(:string_with_default)
+    end
+    it "registers an attribute with a type at the instance scope" do
+      @example_registry.attributes.should include(:integer)
+      @example_registry.attributes.should include(:string)
+      @example_registry.attributes.should include(:string_with_default)
+    end
+    it "respects specific defaults on properties" do
+      @example_registry.string_with_default.should == "this is the default"
+    end
+    it "sets the default to be nil" do
+      @example_registry.string.should be_nil
+    end
+      
+    it "allows an object to be set and read directly" do
+      @example_registry.string = "1234567"
+      @example_registry.string.should == "1234567"
+    end
+  
+    it "allows an object to be set and read via the indirect helper" do
+      @example_registry.attr_set :string, "987654321"
+      @example_registry.attr_get(:string).should == "987654321"
+    end
+  
+    it "converts attributes to a date when a string is passed into a datetime object" do
+      @date_registry.date = "2009-07-01 13:14:15"
+      @date_registry.date.should be_kind_of(DateTime)
+      @date_registry.date.year.should == 2009
+      @date_registry.date.month.should == 7
+      @date_registry.date.day.should == 1
+      @date_registry.date.hour.should == 13
+      @date_registry.date.min.should == 14
+      @date_registry.date.sec.should == 15
+    end
+  
+    it "does not include the ID in the returnable attributes" do
+      @example_private_prop_registry.returnable_attributes.should_not include(:id)
+    end
+    it "does not include the private attributes in the returnable attributes" do
+      @example_private_prop_registry.returnable_attributes.should_not include(:private_attr)
+      @example_private_prop_registry.returnable_attributes.should include(:public_attr)
+    end
+  
+    it "allows an object to be created with a hash of attributes" do
+      created = ::FooAttributeRegistry.new(:integer=>0, :string=>"0000", :string_with_default=>"1111")
+      created.integer.should == 0
+      created.string.should == "0000"
+      created.string_with_default.should == "1111"
+    end
+  
+    it "allows attributes to be set with a hash" do
+      created = ::FooAttributeRegistry.new
+      created.attributes = {:integer=>0, :string=>"0000", :string_with_default=>"1111"}
+      created.integer.should == 0
+      created.string.should == "0000"
+      created.string_with_default.should == "1111"
+    end
+    it "allows attributes to be read as a hash" do
+      created = ::FooAttributeRegistry.new(:integer=>0, :string=>"0000", :string_with_default=>"1111", :id=>5)
+      created.attributes.should == {:integer=>0, :string=>"0000", :string_with_default=>"1111", :id=>5}
+    end
+  
+    it "allows mass assignment with indifferent access" do
+      created = ::NameConditionTestRegistry.new
+      created.attributes = {"name"=>"name set", "email"=>"gooooo"}
+      created.name.should == "name set"
+      created.email.should == "gooooo"
+    
+      created = ::NameConditionTestRegistry.new
+      created.attributes = {:name=>"name set", :email=>"gooooo"}
+      created.name.should == "name set"
+      created.email.should == "gooooo"
+    end
+  end
+end

data/spec/request_proxy_spec.rb

@@ -0,0 +1,90 @@
+require File.join(File.dirname(__FILE__), "helpers", "spec_helper")
+
+describe Videojuicer::OAuth::RequestProxy do
+  
+  before(:each) do
+    configure_test_settings
+  end
+  
+  describe "instantiation" do
+    before(:all) do
+      @klass = Videojuicer::OAuth::RequestProxy
+    end    
+    it_should_behave_like "a configurable"
+  end
+  
+  describe "URL normalizer" do
+    before(:all) do
+      @proxy = Videojuicer::OAuth::RequestProxy.new
+    end
+    
+    it "can split a parameter hash into a regular and multipart hash" do
+      f = File.open(__FILE__)
+      params = {:user=>{:attributes=>{:file=>f, :name=>"user name"}}, :foo=>"bar"}
+      normal, multipart = @proxy.split_by_signature_eligibility(params)
+      normal.should == {:user=>{:attributes=>{:name=>"user name"}}, :foo=>"bar"}
+      multipart.should == {:user=>{:attributes=>{:file=>f}}}
+    end
+    
+    it "can sort a basic parameter hash correctly" do
+      @proxy.normalize_params(:a=>"1", :b=>"2", :c=>"2", :d=>1).should == "a=1&b=2&c=2&d=1"
+    end
+    it "can sort complex nested parameter hashes correctly" do
+      @proxy.normalize_params(:a=>"1", :b=>"2", :c=>{:a=>"AAA", :b=>"BBB", :c=>"CCC"}, :d=>{:e=>"foo"}).should == "a=1&b=2&c%5Ba%5D=AAA&c%5Bb%5D=BBB&c%5Bc%5D=CCC&d%5Be%5D=foo"
+    end    
+    it "escapes the signature base string elements and adjoins them with an ampersand" do
+      @proxy.signature_base_string(:get, "/test", :foo=>"bar", :bar=>"baz").should == "GET&#{CGI.rfc3986_escape "http://localhost:6666/test"}&#{CGI.rfc3986_escape "bar=baz&foo=bar"}"
+    end
+        
+    describe "with no token supplied" do
+      before(:all) do
+        @proxy = Videojuicer::OAuth::RequestProxy.new(:token=>nil, :token_secret=>nil, :consumer_key=>"conkey", :consumer_secret=>"consec")
+      end
+      
+      it "omits the token secret from the signature secret" do
+        @proxy.signature_secret.should == "consec&"
+      end
+      
+      it "omits the token from the signature params" do
+        ap = @proxy.authify_params(:get, "/test", :a=>1, :b=>2)
+        ap[:a].should == 1
+        ap[:b].should == 2
+        ap.include?(:oauth_token).should be_false
+        ap[:oauth_consumer_key].should == "conkey"
+      end
+    end
+    
+    describe "with a token supplied" do
+      before(:all) do
+        @proxy = Videojuicer::OAuth::RequestProxy.new(:token=>"token", :token_secret=>"tosec", :consumer_key=>"conkey", :consumer_secret=>"consec")
+      end
+      
+      it "includes the token secret in the signature secret" do
+        @proxy.signature_secret.should == "consec&tosec"
+      end
+      
+      it "includes the token automatically in the signature params" do
+        ap = @proxy.authify_params(:get, "/test", :a=>1, :b=>2)
+        ap[:a].should == 1
+        ap[:b].should == 2
+        ap[:oauth_token].should == "token"
+        ap[:oauth_consumer_key].should == "conkey"
+      end
+    end
+  end
+      
+  describe "request factory" do
+    before(:all) do
+      @seed = fixtures.seed
+      @fix = fixtures["write-master"]
+      @proxy = Videojuicer::OAuth::RequestProxy.new(:seed_name=>@seed.name, :consumer_key=>@fix.consumer.consumer_key, :consumer_secret=>@fix.consumer.consumer_secret, :token=>nil, :token_secret=>nil)
+    end
+    
+    it "can successfully retrieve a request token (indicating a successful signature verification)" do
+      @proxy.consumer_key.should == @fix.consumer.consumer_key
+      response = @proxy.get("/oauth/tokens")
+      response.body.should =~ /oauth_token=[a-zA-Z0-9]+&oauth_token_secret=[a-zA-Z0-9]+/
+    end
+  end
+  
+end