vj-sdk 0.2.1

data/lib/videojuicer/shared/configurable.rb

@@ -0,0 +1,103 @@
+=begin
+
+  Configurable is a mixin intended for internal use within the SDK.
+  
+  It provides a suite of helper methods to objects that use the scoped configuration
+  system within the root Videojuicer module.
+  
+  Objects that are Configurable have a local configuration, which will always be 
+  respected, and a shared configuration object which merges the current configuration
+  scope with the local configuration.
+  
+  For instance:
+  
+    # Assuming that the Videojuicer default configuration is a simple hash containing {:in_a_scope=>false}
+  
+    a_configurable.configure! :foo=>"bar" # config[:foo] will ALWAYS == "bar" for this object.
+    a_configurable.local_config #=> {:foo=>"bar"}
+    a_configurable.config #=> {:in_a_scope=>false, :foo=>"bar"}
+    
+    # Now let's enter a scope:
+    Videojuicer.enter_scope :in_a_scope=>true, :foo=>"not bar"
+    
+    a_configurable.local_config #=> {:foo=>"bar"}
+    a_configurable.config #=> {:in_a_scope=>true, :foo=>"bar"}
+    
+    # And leave it again..
+    Videojuicer.exit_scope
+    
+    a_configurable.local_config #=> {:foo=>"bar"}
+    a_configurable.config #=> {:in_a_scope=>false, :foo=>"bar"}
+
+=end
+
+module Videojuicer
+  module Configurable
+    
+    attr_accessor :local_config
+    
+    # Sets the local configuration for this Configurable.
+    # The local configuration will always be respected regardless of the 
+    # current controller scope.
+    def configure!(options={})
+      self.local_config = options
+    end
+    
+    # Returns the shared configuration, which is the current
+    # controller scope merged with the local config.
+    def config
+      Videojuicer.current_scope.merge(local_config || {})
+    end
+    
+    # Executes a block of code within the scope of this Configurable's
+    # local configuration.
+    #
+    # This is achieved by pushing the local configuration onto the controller's
+    # scope stack, executing the given block and then exiting the scope. During
+    # this procedure the local configuration on this object will remain unchanged.
+    # 
+    # Example:
+    # Videojuicer.configure! :bar=>"baz"
+    # configurable_a.configure! :foo=>"a"
+    # configurable_b.configure! :foo=>"b"
+    # 
+    # configurable_a.scope do |config|
+    #   config[:bar] #=> "baz"
+    #   config[:foo] #=> "a"
+    #   
+    #   configurable_b.scope do |config|
+    #     config[:foo] #=> "b"
+    #   end
+    #
+    #   config[:foo] #=> "a"
+    # end
+    def scope(&block)
+      Videojuicer.enter_scope local_config
+      block_out = block.call(Videojuicer.current_scope)
+      Videojuicer.exit_scope
+      return block_out
+    end
+    
+    # Retrieves the host from the configuration options.
+    def host; config[:host]; end
+    # Retrieves the port from the configuration options.
+    def port; config[:port]; end
+    # Retrieves the consumer_key from the configuration options.
+    def consumer_key; config[:consumer_key]; end
+    # Retrieves the consumer_secret from the configuration options.
+    def consumer_secret; config[:consumer_secret]; end
+    # Retrieves the token from the configuration options.
+    def token; config[:token]; end
+    # Retrieves the token_secret from the configuration options.
+    def token_secret; config[:token_secret]; end
+    # Retrieves the api_version from the configuration options.
+    def api_version; config[:api_version]; end
+    # Retrieves the protocol from the configuration options.
+    def protocol; config[:protocol]; end
+    # Retrieves the seed name from the configuration options.
+    def seed_name; config[:seed_name]; end
+    # Retrieves the user_id from the configuration options. Master tokens can be used to authenticate as any user.
+    def user_id; config[:user_id]; end
+    
+  end
+end

data/lib/videojuicer/shared/exceptions.rb

@@ -0,0 +1,32 @@
+module Videojuicer
+  module Exceptions
+   
+    class NotAuthorised < ::StandardError; end
+    
+    # Raised when a method requiring instance-specific data from the remote API
+    # is called on an object that does not exist remotely.
+    class NoResource < ::RuntimeError; end
+    
+    # Raised when a record cannot be saved because it has attributes that are well rubbish.
+    class InvalidRecord < ::RuntimeError; end
+    
+    # Raised when a request is completely buggered by the remote API.
+    class RemoteApplicationError < ::StandardError; end
+    
+    # Raised when the remote resource refuses to carry out an action.
+    class Forbidden < ::StandardError; end
+    
+    # Raised when status is 401
+    class Unauthenticated < ::StandardError; end
+    
+    # Raised when status is 406
+    class NotAcceptable < ::StandardError; end
+    
+    # Raised when status is 411
+    class ContentLengthRequired < ::StandardError; end
+    
+    # Raised on an unclassified exception
+    class UnhandledHTTPStatus < ::StandardError; end
+    
+  end
+end

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,110 @@
+$:.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'
+require 'core_ext/string'
+require 'core_ext/object'
+require 'core_ext/cgi'
+# 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/embeddable'
+require 'videojuicer/resource/types'
+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/campaign_policy'
+require 'videojuicer/presentation'
+require 'videojuicer/asset/audio'
+require 'videojuicer/asset/flash'
+require 'videojuicer/asset/image'
+require 'videojuicer/asset/text'
+require 'videojuicer/asset/video'
+require 'videojuicer/promo/base'
+require 'videojuicer/criterion/date_range'
+require 'videojuicer/criterion/geolocation'
+require 'videojuicer/criterion/request'
+require 'videojuicer/criterion/time'
+require 'videojuicer/criterion/week_day'
+require 'videojuicer/promo/base'
+require 'videojuicer/preset'
+
+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 # class << self
+end # module Videojuicer

data/spec/assets/audio_spec.rb

@@ -0,0 +1,25 @@
+require File.join(File.dirname(__FILE__), "..", "helpers",  "spec_helper")
+
+describe Videojuicer::Asset::Audio do
+  
+  before(:all) do
+    @klass = Videojuicer::Asset::Audio
+    @preset_params = {:derived_type => "Audio", :file_format => "mp3"}
+    configure_test_settings
+  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"
+    end
+    
+    it_should_behave_like "a RESTFUL resource model"
+  end
+  
+  it_should_behave_like "an asset"
+end

data/spec/assets/flash_spec.rb

@@ -0,0 +1,24 @@
+require File.join(File.dirname(__FILE__), "..", "helpers",  "spec_helper")
+
+describe Videojuicer::Asset::Flash do
+  
+  before(:all) do
+    @klass = Videojuicer::Asset::Flash
+    configure_test_settings
+  end
+  
+  describe "instantiation" do
+    it_should_behave_like "a configurable"
+  end
+  
+  describe "general interface:" do
+    before(:all) do
+      @singular_name = "asset"
+      @plural_name = "assets/flash"
+    end
+    
+    it_should_behave_like "a RESTFUL resource model"
+  end
+  
+  it_should_behave_like "an asset"
+end

data/spec/assets/image_spec.rb

@@ -0,0 +1,25 @@
+require File.join(File.dirname(__FILE__), "..", "helpers",  "spec_helper")
+
+describe Videojuicer::Asset::Image do
+  
+  before(:all) do
+    @klass = Videojuicer::Asset::Image
+    @preset_params = {:derived_type => "Image", :file_format => "png"}
+    configure_test_settings
+  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"
+    end
+    
+    it_should_behave_like "a RESTFUL resource model"
+  end
+  
+  it_should_behave_like "an asset"
+end

data/spec/assets/text_spec.rb

@@ -0,0 +1,24 @@
+require File.join(File.dirname(__FILE__), "..", "helpers",  "spec_helper")
+
+describe Videojuicer::Asset::Text do
+  
+  before(:all) do
+    @klass = Videojuicer::Asset::Text
+    configure_test_settings
+  end
+  
+  describe "instantiation" do
+    it_should_behave_like "a configurable"
+  end
+  
+  describe "general interface:" do
+    before(:all) do
+      @singular_name = "asset"
+      @plural_name = "assets/text"
+    end
+    
+    it_should_behave_like "a RESTFUL resource model"
+  end
+  
+  it_should_behave_like "an asset"
+end

data/spec/assets/video_spec.rb

@@ -0,0 +1,25 @@
+require File.join(File.dirname(__FILE__), "..", "helpers",  "spec_helper")
+
+describe Videojuicer::Asset::Video do
+  
+  before(:all) do
+    @klass = Videojuicer::Asset::Video
+    @preset_params = {:derived_type => "Video", :file_format => "mp4"}
+    configure_test_settings
+  end
+  
+  describe "instantiation" do
+    it_should_behave_like "a configurable"
+  end
+  
+  describe "general interface:" do
+    before(:all) do
+      @singular_name = "asset"
+      @plural_name = "assets/video"
+    end
+    
+    it_should_behave_like "a RESTFUL resource model"
+  end
+  
+  it_should_behave_like "an asset"
+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_policy_spec.rb

@@ -0,0 +1,41 @@
+require File.join(File.dirname(__FILE__), "helpers", "spec_helper")
+
+describe Videojuicer::Campaign::CampaignPolicy do
+  
+  before(:all) do
+    @klass = Videojuicer::Campaign::CampaignPolicy
+    configure_test_settings
+  end
+  
+  describe "instantiation" do
+    it_should_behave_like "a configurable"
+  end
+  
+  describe "general interface:" do
+    before(:all) do
+      @singular_name = "campaign_policy"
+      @plural_name = "campaign_policies"
+      @fixed_attributes = [:campaign_id]
+    end
+    
+    it_should_behave_like "a RESTFUL resource model"
+  end
+  
+  describe "adding policies" do
+  
+  end
+  
+  describe "removing policies" do
+  
+  end
+  
+  describe "adding promos" do
+  
+  end
+  
+  describe "removing promos" do
+  
+  end
+  
+  
+end

data/spec/campaign_spec.rb

@@ -0,0 +1,25 @@
+require File.join(File.dirname(__FILE__), "helpers", "spec_helper")
+
+describe Videojuicer::Campaign do
+  
+  before(:all) do
+    @klass = Videojuicer::Campaign
+    configure_test_settings
+  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"
+    end
+    
+    it_should_behave_like "a RESTFUL resource model"
+  end
+  
+  
+end

data/spec/collection_spec.rb

@@ -0,0 +1,31 @@
+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
+  
+  it "pagination copes with a nil limit" do
+    collection = Videojuicer::Resource::Collection.new(@objects[0..9], 155, 17, nil)
+    collection.page_count.should == 1
+    collection.page_number.should == 1
+  end
+  
+end

data/spec/criterion/date_range_spec.rb

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

data/spec/criterion/geolocation_spec.rb

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

data/spec/criterion/request_spec.rb

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

data/spec/criterion/time_spec.rb

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

data/spec/criterion/week_day_spec.rb

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