videojuicer-vj-sdk 0.1.0

data/lib/videojuicer/user.rb

@@ -0,0 +1,43 @@
+module Videojuicer
+  class User
+    include Videojuicer::Resource
+    include Videojuicer::Exceptions
+    
+    property :name, String
+    property :login, String
+    property :email, String
+    property :password, String
+    property :password_confirmation, String
+    property :created_at, DateTime
+    property :updated_at, DateTime
+    
+    # Authenticates the given login and password and returns
+    # a user if the details are correct. Requires a Master token.
+    def self.authenticate(login, password)
+      proxy = Videojuicer::OAuth::RequestProxy.new
+      begin
+        jobj = JSON.parse(proxy.get("/users/authenticate.json", :login=>login, :password=>password).body)
+        o = new(:id=>jobj["id"])
+        o.reload
+        return o
+      rescue NoResource =>e
+        return nil
+      end
+    end
+    
+    # Manage virtual attributes that are not sent back to the API
+    attr_accessor :roles
+    def has_role?(symbol)
+      roles.include?(symbol.to_s)
+    end
+    
+    def add_role(*symbols)
+      symbols.each {|r| proxy_for(config).post(resource_path(:add_role), :role=>r) }
+    end
+
+    def remove_role(*symbols)
+      symbols.each {|r| proxy_for(config).post(resource_path(:remove_role), :role=>r) }
+    end
+    
+  end
+end

data/lib/videojuicer.rb

@@ -0,0 +1,97 @@
+$:.unshift File.dirname(__FILE__)     # For use/testing when no gem is installed
+
+# Gem and stdlib dependencies
+require 'rubygems'
+require 'cgi'
+require 'json'
+require 'hmac-sha1'
+require 'net/http'
+
+# Core ext
+require 'core_ext/hash'
+# Core mixins
+require 'videojuicer/shared/exceptions'
+require 'videojuicer/shared/configurable'
+# Authentication and authorisation
+require 'videojuicer/oauth/request_proxy'
+require 'videojuicer/oauth/proxy_factory'
+# Resource handling
+require 'videojuicer/resource/relationships/belongs_to'
+require 'videojuicer/resource/errors'
+require 'videojuicer/resource/collection'
+require 'videojuicer/resource/inferrable'
+require 'videojuicer/resource/property_registry'
+require 'videojuicer/resource/base'
+require 'videojuicer/session'
+# Frontend models
+require 'videojuicer/user'
+require 'videojuicer/campaign'
+require 'videojuicer/presentation'
+require 'videojuicer/asset/audio'
+require 'videojuicer/asset/video'
+require 'videojuicer/asset/text'
+require 'videojuicer/asset/image'
+
+module Videojuicer
+  
+  DEFAULTS = {
+    :consumer_key     => nil,
+    :consumer_secret  => nil,
+    :token            => nil,
+    :token_secret     => nil,
+    :api_version      => nil,
+    :seed_name        => nil,
+    :user_id          => nil,
+    :protocol         => "http",
+    :host             => "api.videojuicer.com",
+    :port             => 80
+  }.freeze
+
+  @default_options = {}
+  @scope_stack = []
+  
+  class << self
+
+    def scopes
+      ([default_options]+@scope_stack).compact
+    end
+    
+    def in_scope?
+      !@scope_stack.empty?
+    end
+    
+    def current_scope
+      scopes.last
+    end
+    
+    def enter_scope(config)
+      @scope_stack.push current_scope.merge(config)
+    end
+    
+    def exit_scope
+      @scope_stack.pop
+    end
+    
+    def exit_all!
+      @scope_stack = []
+    end
+    
+    def [](key)
+      @default_options[key]
+    end
+    
+    def configure!(options={})
+      @default_options = DEFAULTS.merge(@default_options.merge(options))
+    end
+
+    def unconfigure!
+      @default_options = DEFAULTS
+    end
+
+    def default_options
+      @default_options
+    end
+  end
+  
+  
+end

data/spec/audio_spec.rb

@@ -0,0 +1,43 @@
+require File.join(File.dirname(__FILE__), "helpers", "spec_helper")
+
+describe Videojuicer::Asset::Audio do
+  
+  before(:all) do
+    @klass = Videojuicer::Asset::Audio
+    configure_test_settings
+    Videojuicer.enter_scope :seed_name => fixtures.seed.name, 
+                            :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
+  end
+  
+  after(:all) do
+    Videojuicer.exit_scope
+  end
+  
+  describe "instantiation" do
+    it_should_behave_like "a configurable"
+  end
+  
+  describe "general interface:" do
+    before(:all) do
+      @singular_name = "asset"
+      @plural_name = "assets/audio"
+      @good_attributes = {
+        :user_id        => rand(100) + 1,
+        :licensed_at    => Time.now,
+        :licensed_by    => "foo, bar",
+        :licensed_under => "CC BY:NC:SA",
+        :published_at   => Time.now,      
+        :duration       => 180000, 
+        :bit_rate       => 262144, 
+        :file => File.open(File.join(File.dirname(__FILE__), "files", "audio.mp3"))
+      }
+    end
+    
+    it_should_behave_like "a RESTFUL resource model"
+  end
+  
+  
+end

data/spec/belongs_to_spec.rb

@@ -0,0 +1,45 @@
+require File.join(File.dirname(__FILE__), "helpers", "spec_helper")
+
+describe Videojuicer::Resource::Relationships::BelongsTo do
+  
+  after(:all) do
+    Videojuicer.exit_scope
+  end
+  
+  before(:all) do
+    configure_test_settings
+    Videojuicer.enter_scope :seed_name => fixtures.seed.name, 
+                            :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
+    
+    @user = Videojuicer::User.first
+    @user.should be_kind_of(Videojuicer::User)
+    
+    class ::BelongsToExample
+      include Videojuicer::Resource
+      
+      property :user_id, Integer
+      belongs_to :user, :class=>Videojuicer::User
+    end
+    
+    @example = ::BelongsToExample.new
+    @example.user_id = @user.id
+  end
+  
+  it "retrieves the user" do
+    @example.user.id.should == @user.id
+  end
+  
+  it "returns nil when the user_id is nonsense" do
+    bad_example = ::BelongsToExample.new(:user_id=>9900000000)
+    bad_example.user.should be_nil
+  end
+  
+  it "sets the user" do
+    @example.user = @user
+    @example.user_id.should == @user.id
+  end
+  
+end

data/spec/campaign_spec.rb

@@ -0,0 +1,37 @@
+require File.join(File.dirname(__FILE__), "helpers", "spec_helper")
+
+describe Videojuicer::Campaign do
+  
+  before(:all) do
+    @klass = Videojuicer::Campaign
+    configure_test_settings
+    Videojuicer.enter_scope :seed_name => fixtures.seed.name, 
+                            :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
+  end
+  
+  after(:all) do
+    Videojuicer.exit_scope
+  end
+  
+  describe "instantiation" do
+    it_should_behave_like "a configurable"
+  end
+  
+  describe "general interface:" do
+    before(:all) do
+      string_mash = (("A".."z").to_a + ("a".."z").to_a)
+      @singular_name = "campaign"
+      @plural_name = "campaigns"
+      @good_attributes = {
+        :name => (0..rand(75)).map{ string_mash[rand(string_mash.size - 1)] }.join
+      }
+    end
+    
+    it_should_behave_like "a RESTFUL resource model"
+  end
+  
+  
+end

data/spec/collection_spec.rb

@@ -0,0 +1,25 @@
+require File.join(File.dirname(__FILE__), "helpers", "spec_helper")
+
+describe Videojuicer::Resource::Collection do
+
+  before(:all) do
+    @objects = [:foo]*100
+    @collection = Videojuicer::Resource::Collection.new(@objects[0..9], 155, 17, 10)
+  end
+  
+  it "is instantiated correctly" do    
+    @collection.should be_kind_of(Videojuicer::Resource::Collection)
+    @collection.total.should == 155
+    @collection.offset.should == 17
+    @collection.limit.should == 10
+  end
+  
+  it "can count the number of pages" do
+    @collection.page_count.should == 16
+  end
+  
+  it "can tell the current page" do
+    @collection.page_number.should == 2
+  end
+  
+end

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/spec_helper.rb

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'spec'
+require 'mash'
+require 'yaml'
+require File.join(File.dirname(__FILE__), "..", "..", "lib", "videojuicer")
+
+require File.join(File.dirname(__FILE__), "..", "shared", "configurable_spec")
+require File.join(File.dirname(__FILE__), "..", "shared", "resource_spec")
+
+module SpecHelper
+  
+  def configure_test_settings(overrides={})
+    Videojuicer.configure!({
+      :consumer_key     => nil,
+      :consumer_secret  => nil,
+      :api_version      => 1,
+      :protocol         => "http",
+      :host             => "localhost",
+      :port             => 5555
+    }.merge(overrides))
+  end
+  
+  def fixtures
+    @fixtures ||= Mash.new(YAML.load(File.open(File.join(File.dirname(__FILE__), "..", "..", "core-fixtures.yml")).read))
+  end
+  
+  def cycle_attributes(attrs)
+    r = rand(99999)
+    attrs.inject({}) do |memo, (key, value)| 
+      memo.merge({
+        key =>  if value.respond_to?(:read)
+                  value
+                elsif value.is_a?(Date) or value.is_a?(DateTime) or value.is_a?(Time)
+                  value
+                else 
+                  value.to_s.gsub(/\d+/, r.to_s)
+                end
+      })
+    end
+  end
+  
+  def strip_files(attrs)
+    
+  end
+  
+end
+
+Spec::Runner.configure do |config|
+    config.include(SpecHelper)
+end

data/spec/image_spec.rb

@@ -0,0 +1,44 @@
+require File.join(File.dirname(__FILE__), "helpers", "spec_helper")
+
+describe Videojuicer::Asset::Image do
+  
+  before(:all) do
+    @klass = Videojuicer::Asset::Image
+    configure_test_settings
+    Videojuicer.enter_scope :seed_name => fixtures.seed.name, 
+                            :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
+  end
+  
+  after(:all) do
+    Videojuicer.exit_scope
+  end
+  
+  describe "instantiation" do
+    it_should_behave_like "a configurable"
+  end
+  
+  describe "general interface:" do
+    before(:all) do
+      @singular_name = "asset"
+      @plural_name = "assets/image"
+      @good_attributes = {
+        :user_id        => rand(100) + 1,
+        :licensed_at    => Time.now,
+        :licensed_by    => "foo, bar",
+        :licensed_under => "CC BY:NC:SA",
+        :published_at   => Time.now,      
+        :duration       => 180000, 
+        :width          => 640,
+        :height         => 480,
+        :file => File.open(File.join(File.dirname(__FILE__), "files", "image.jpg"))
+      }
+    end
+    
+    it_should_behave_like "a RESTFUL resource model"
+  end
+  
+  
+end

data/spec/presentation_spec.rb

@@ -0,0 +1,38 @@
+require File.join(File.dirname(__FILE__), "helpers", "spec_helper")
+
+describe Videojuicer::Presentation do
+  
+  before(:all) do
+    @klass = Videojuicer::Presentation
+    configure_test_settings
+    Videojuicer.enter_scope :seed_name => fixtures.seed.name, 
+                            :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
+  end
+  
+  after(:all) do
+    Videojuicer.exit_scope
+  end
+  
+  describe "instantiation" do
+    it_should_behave_like "a configurable"
+  end
+  
+  describe "general interface:" do
+    before(:all) do
+      @singular_name = "presentation"
+      @plural_name = "presentations"
+      @good_attributes = {
+        :title=>"Presentation title #{rand 99999}",
+        :abstract=>"Presentation abstract #{rand 99999}",
+        :author=>"Bob Anon"
+      }
+    end
+    
+    it_should_behave_like "a RESTFUL resource model"
+  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,94 @@
+require File.join(File.dirname(__FILE__), "helpers", "spec_helper")
+
+describe Videojuicer::OAuth::RequestProxy do
+  
+  before(:each) { configure_test_settings }
+  
+  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 "does not include binary file parameters in the signature"
+    
+    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.escape "http://localhost/test"}&#{CGI.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
+      @fixtures = fixtures["write-master"]
+      @proxy = Videojuicer::OAuth::RequestProxy.new(:seed_name=>@seed.name, :consumer_key=>@fixtures.consumer.consumer_key, :consumer_secret=>@fixtures.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 == @fixtures.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
+    
+    it "throws an exception when given a 401 return status"
+    it "throws an exception when given a 406 return status"
+  end
+  
+end