vj-sdk 0.2.1

data/.gitignore

@@ -0,0 +1,4 @@
+log/*
+core-fixtures.yml
+pkg/*
+.DS_Store

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 danski
+
+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.rdoc

@@ -0,0 +1,7 @@
+= vj-sdk
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 danski. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,70 @@
+require 'rubygems'
+require 'merb-core'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "vj-sdk"
+    gem.summary = "Videojuicer core-sdk"
+    gem.email = "dan@videojuicer.com"
+    gem.homepage = "http://github.com/danski/vj-sdk"
+    gem.authors = ["danski", "thejohnny", "knowtheory", "sixones", "btab"]
+    
+    # Declare dependencies
+    gem.add_dependency "json", ">= 1.0"
+    gem.add_dependency "ruby-hmac", ">= 0.3.2"
+    gem.add_dependency "mash", ">= 0.0.3"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', 'spec/spec.opts']
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+namespace :spec do
+  task :sdk do
+    require 'tasks/vj-core'
+    Rake::Task["videojuicer:core:setup"].invoke
+    Rake::Task["spec"].execute
+    Rake::Task["videojuicer:core:cleanup"].invoke
+  end
+end
+task :default => :"spec:sdk"
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "vj-sdk #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "provide a console like merb -i or script/console"
+task :console do
+  exec "irb -r irb/completion -r lib/videojuicer.rb -r lib/sdk_connection_harness.rb"
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 2
+:patch: 1

data/lib/core_ext/cgi.rb

@@ -0,0 +1,12 @@
+class CGI
+  class << self
+    
+    def rfc3986_escape(str)
+      escape(str).gsub("+", "%20")
+    end
+    def rfc3986_unescape(str)
+      unescape(str)
+    end
+    
+  end
+end

data/lib/core_ext/hash.rb

@@ -0,0 +1,52 @@
+class Hash
+
+  # Returns a new hash just like this one, but with all the string keys expressed as symbols.
+  # Also applies to hashes within self.
+  # Based on an implementation within Rails 2.x, thanks Rails!
+  def deep_symbolize
+    target = dup    
+    target.inject({}) do |memo, (key, value)|
+      value = value.deep_symbolize if value.is_a?(Hash)
+      memo[(key.to_sym rescue key) || key] = value
+      memo
+    end
+  end
+  
+  # Returns a new hash just like this one, but with all the symbol keys expressed as strings.
+  # Also applies to hashes within self.
+  # Based on an implementation within Rails 2.x, thanks Rails!
+  def deep_stringify
+    target = dup
+    target.inject({}) do |memo, (key, value)|
+      value = value.deep_stringify if value.is_a?(Hash)
+      memo[(key.to_s rescue key) || key] = value
+      memo
+    end
+  end
+      
+  # Merges self with another hash, recursively.
+  # 
+  # This code was lovingly stolen from some random gem:
+  # http://gemjack.com/gems/tartan-0.1.1/classes/Hash.html
+  # 
+  # Thanks to whoever made it.
+  def deep_merge(hash)
+    target = dup
+    
+    hash.keys.each do |key|
+      if hash[key].is_a? Hash and self[key].is_a? Hash
+        target[key] = target[key].deep_merge(hash[key])
+        next
+      end      
+      target[key] = hash[key]
+    end    
+    target
+  end
+  
+  def to_xml
+    inject("") do |memo, (key, value)|
+      memo << "<#{key}>#{(value.respond_to?(:to_xml))? value.to_xml : value}</#{key}>"
+    end
+  end
+
+end

data/lib/core_ext/object.rb

@@ -0,0 +1,15 @@
+class Object
+
+  # Cribbed from DataMapper's Extlib library.
+  def full_const_get(name)
+    list = name.split("::")
+    list.shift if list.first.blank?
+    obj = self
+    list.each do |x|
+      # This is required because const_get tries to look for constants in the
+      # ancestor chain, but we only want constants that are HERE
+      obj = obj.const_defined?(x) ? obj.const_get(x) : obj.const_missing(x)
+    end
+    obj
+  end
+end

data/lib/core_ext/string.rb

@@ -0,0 +1,11 @@
+class String
+  def blank?
+    strip.empty?
+  end
+  
+  def snake_case
+    return self.downcase if self =~ /^[A-Z]+$/
+    self.gsub(/([A-Z]+)(?=[A-Z][a-z]?)|\B[A-Z]/, '_\&') =~ /_*(.*)/
+      return $+.downcase
+  end
+end

data/lib/sdk_connection_harness.rb

@@ -0,0 +1,101 @@
+begin
+  require 'extlib'
+rescue LoadError
+  require 'mash'
+end
+require 'yaml'
+class SDKConnectionHarness
+  class << self
+
+    attr_accessor :server_pid
+    attr_accessor :fixtures
+
+    def core_directory
+      File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "vj-core"))
+    end
+    
+    def start!
+      stop! if running?
+      puts "Starting vj-core from #{core_directory}\n"
+      Thread.new do
+        cur_dir = Dir.pwd
+        Dir.chdir(core_directory) do
+          `./bin/merb -d #{app_server} -p #{port} -e test --log ./log/sdk-development.log`
+        end
+        Dir.chdir(cur_dir)
+      end
+    end
+    
+    def stop!
+      Thread.new do
+        `killall -9 "merb : worker (port #{port})"`
+      end
+    end
+    
+    def running?
+      uri = URI.parse("http://localhost:#{port}/")
+      req = Net::HTTP::Get.new(uri.path)
+      
+      begin
+        resp = Net::HTTP.start(uri.host, uri.port) do |http|
+          http.request(req)
+        end
+        return true
+      rescue Exception => e
+        # Connection refused means the daemon isn't running
+        return false
+      end
+    end
+    
+    def load_fixtures
+      Dir.chdir(core_directory) do
+        out = `./bin/rake videojuicer:sdk:setup MERB_ENV=test`
+        out = out.match(/!!!([^!]+)!!!/m)
+        self.fixtures = out[1]
+      end
+    end
+    
+    def write_fixtures
+      f = File.open(File.join(File.dirname(__FILE__), "..", "core-fixtures.yml"), "w+")
+      f.rewind
+      f.write(self.fixtures)
+      f.close
+    end
+    
+    def app_server
+     begin
+       require 'thin'
+       adapter = 'thin'
+     rescue LoadError
+       adapter = 'mongrel'
+     end
+     return "--adapter #{adapter}"
+    end
+    
+    def port
+      6666
+    end
+    
+    def connect(overrides={})
+      fixtures = Mash.new(YAML.load(load_fixtures)).merge(overrides)
+      configure_test_settings(fixtures)
+      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
+    
+    def configure_test_settings(overrides={})
+      Videojuicer.configure!({
+        :consumer_key     => nil,
+        :consumer_secret  => nil,
+        :api_version      => 1,
+        :protocol         => "http",
+        :host             => "localhost",
+        :port             => port
+      }.merge(overrides))
+    end
+    
+  end
+end

data/lib/videojuicer/asset/audio.rb

@@ -0,0 +1,13 @@
+require File.join(File.dirname(__FILE__), "base")
+
+module Videojuicer
+  module Asset
+    class Audio < Base
+      property :bit_rate,    Integer, :writer => :private # bits per second
+      property :channels,    Integer, :writer => :private
+      property :duration,    Integer, :writer => :private # milliseconds
+      property :format,      String,  :writer => :private
+      property :sample_rate, Integer, :writer => :private # hertz
+    end
+  end
+end

data/lib/videojuicer/asset/base.rb

@@ -0,0 +1,80 @@
+module Videojuicer
+  module Asset
+    class Base
+      
+      def self.inherited(base)
+        base.send(:include, Videojuicer::Resource)
+        base.send(:extend, Videojuicer::Asset::Base::ClassMethods)
+        base.send(:include, Videojuicer::Asset::Base::InstanceMethods)
+        
+        # - heritage
+        base.property :derived_internally,  Videojuicer::Resource::Types::Boolean, :writer => :private
+        base.property :original_asset_id,   Integer,  :writer => :private
+        base.property :original_asset_type, String,   :writer => :private
+        base.property :preset_id,           Integer,  :writer => :private
+        base.property :user_id,             Integer,  :writer => :private
+        
+        # - transformation
+        base.property :source_space_window, String,   :writer => :private
+        base.property :source_time_window,  String,   :writer => :private
+        
+        # - generic file handling
+        base.property :file,                File
+        base.property :file_name,           String
+        base.property :file_size,           Integer,  :writer => :private # bytes
+        
+        # - common metadata
+        base.property :licensed_at,         Date
+        base.property :licensed_by,         String
+        base.property :licensed_under,      String
+        base.property :published_at,        Date
+        
+        # - access control / workflow
+        base.property :url,                 String,   :writer => :private
+        base.property :state,               String,   :writer => :private
+        base.property :state_changed_at,    DateTime, :writer => :private
+        base.property :state_changed_url,   String
+        base.property :created_at,          DateTime
+        base.property :updated_at,          DateTime
+      end
+      
+      module ClassMethods
+        def singular_name
+          "asset"
+        end
+        
+        def base_path(options={})
+          "/assets/#{self.to_s.downcase.split("::").last}"
+        end
+      end
+      
+      module InstanceMethods
+        def derive(preset)
+          response = proxy_for(config).post(resource_path, :preset_id => preset.id)
+          self.class.new(JSON.parse(response.body))
+        end
+        
+        def file
+          raise "use the value of #{self.class}#url to download a copy of the asset"
+        end
+        
+        def returnable_attributes
+          attrs = super
+          attrs.delete(:file) unless new_record?
+          attrs
+        end
+        
+        def set_derived(from_asset, preset)
+          params = {
+            :original_asset_type => from_asset.class.to_s.split("::").last,
+            :original_asset_id => from_asset.id,
+            :preset_id => preset.id
+          }
+          response = proxy_for(config).post(resource_path(:set_derived), params)
+          self.attributes = JSON.parse(response.body)
+        end
+      end
+      
+    end
+  end
+end

data/lib/videojuicer/asset/flash.rb

@@ -0,0 +1,8 @@
+require File.join(File.dirname(__FILE__), "base")
+
+module Videojuicer
+  module Asset
+    class Flash < Base
+    end
+  end
+end

data/lib/videojuicer/asset/image.rb

@@ -0,0 +1,10 @@
+require File.join(File.dirname(__FILE__), "base")
+
+module Videojuicer
+  module Asset
+    class Image < Base
+      property :width,  Integer, :writer => :private # pixels
+      property :height, Integer, :writer => :private # pixels
+    end
+  end
+end

data/lib/videojuicer/asset/text.rb

@@ -0,0 +1,8 @@
+require File.join(File.dirname(__FILE__), "base")
+
+module Videojuicer
+  module Asset
+    class Text < Base
+    end
+  end
+end

data/lib/videojuicer/asset/video.rb

@@ -0,0 +1,22 @@
+require File.join(File.dirname(__FILE__), "base")
+
+module Videojuicer
+  module Asset
+    class Video < Base
+      property :bit_rate,          Integer, :writer => :private # bits per second
+      property :duration,          Integer, :writer => :private # milliseconds
+
+      property :audio_bit_rate,    Integer, :writer => :private # bits per second
+      property :audio_channels,    Integer, :writer => :private
+      property :audio_format,      String,  :writer => :private
+      property :audio_sample_rate, Integer, :writer => :private # hertz
+
+      property :video_bit_rate,    Integer, :writer => :private # bits per second
+      property :video_format,      String,  :writer => :private
+      property :video_frame_rate,  Float,   :writer => :private # frames per second
+
+      property :width,             Integer, :writer => :private # pixels
+      property :height,            Integer, :writer => :private # pixels
+    end
+  end
+end

data/lib/videojuicer/campaign.rb

@@ -0,0 +1,19 @@
+module Videojuicer
+  class Campaign
+    include Videojuicer::Resource
+    include Videojuicer::Exceptions
+    
+    property :name,     String
+    property :user_id,  Integer
+    property :created_at, DateTime
+    property :updated_at, DateTime
+    belongs_to :user, :class=>Videojuicer::User
+    
+    attr_accessor :campaign_policies
+    def campaign_policies=(arg)
+      # Loop over and make objects or something
+      @campaign_policies=(arg)
+    end
+    
+  end
+end

data/lib/videojuicer/campaign_policy.rb

@@ -0,0 +1,116 @@
+module Videojuicer
+  class Campaign
+    class CampaignPolicy
+      include Videojuicer::Resource
+    
+      # Resource should note that this is a class within a class
+      # Should treat parent class as parent resource
+      
+      property :presentation_id,  Integer
+      property :campaign_id,      Integer
+      property :created_at,       DateTime
+      property :updated_at,       DateTime
+      
+      belongs_to :campaign
+      
+      attr_accessor :criteria
+      def criteria=(object_hash)
+        # TODO instantiate criteria in a useful object of some sort
+        
+        # Fail unless arg is an array
+        # Loop over array do |mem|
+          # if mem is a hash
+            # instantiate as a criterion
+            
+            
+          # if criterion object already on this policy
+            # leave be
+          # else
+            # add_criteria(mem)
+          # end
+        # end
+        
+        # what you want to be able to do is:
+        # policy.criteria.include?(some_criterion)
+        @criteria = {}
+        object_hash.map do |type_sym, criteria|
+          @criteria[type_sym.to_sym] = 
+          criteria.map do |criterion|
+            Videojuicer::Criterion.model_map[type_sym.to_sym].new(criterion) #rescue raise("No criteria class found for #{type_sym} in #{Videojuicer::Criterion.model_map.inspect}")
+          end
+        end
+      end
+      
+      def criteria
+        @criteria.values.flatten
+      end
+      
+      %w(date_criteria geolocation_criteria request_criteria time_criteria week_day_criteria).each do |key|
+        class_eval <<-DEF
+          def #{key}
+            @criteria[:#{key}]
+          end
+        DEF
+      end
+      
+      
+      def add_criteria(*criteria)
+        responses = criteria.map do |criterion|
+          proxy_for(config).post("#{path_for_dependents}#{criterion.class.base_path}", {:criterion => criterion.attributes})
+        end
+        self.reload
+        responses
+      end
+      
+      def remove_criteria(*criteria)
+        responses = criteria.map do |criterion|
+          proxy_for(config).delete("#{path_for_dependents}#{criterion.class.base_path}", {:criterion => criterion.attributes})
+        end
+        self.reload
+        responses
+      end
+      
+      def promos=(object_hash={})
+        @promos = {}
+        object_hash.map do |type_sym, promos|
+          @promos[type_sym.to_sym] = 
+          promos.map do |promo|
+            Videojuicer::Promo.model_map[type_sym.to_sym].new(promo)
+          end
+        end
+      end
+      
+      def promos
+        @promos.values.flatten
+      end
+
+      %w(audio images texts videos).each do |key|
+        class_eval <<-DEF
+          def #{key}
+            @promos[:#{key}]
+          end
+        DEF
+      end
+
+      def add_promo(*promos)
+        responses = promos.map do |promo|
+          proxy_for(config).post("#{path_for_dependents}#{promo.class.base_path}", {:promo => promo.attributes})
+        end
+        self.reload
+        responses
+      end
+      
+      def remove_promo(*promos)
+        responses = promos.map do |promo|
+          proxy_for(config).delete("#{path_for_dependents}#{promo.class.base_path}", {:promo => promo.attributes})
+        end
+        self.reload
+        responses
+      end
+      
+      def path_for_dependents
+        self.class.compile_route(self.class.nesting_route,{:campaign_policy_id => self.id, :campaign_id => self.campaign_id})
+      end
+    end
+  end
+end

data/lib/videojuicer/criterion/base.rb

@@ -0,0 +1,56 @@
+module Videojuicer
+  module Criterion
+    def self.model_map
+      { :date_criteria        => Videojuicer::Criterion::DateRange,
+        :geolocation_criteria => Videojuicer::Criterion::Geolocation,
+        :request_criteria     => Videojuicer::Criterion::Request,
+        :time_criteria        => Videojuicer::Criterion::Time,
+        :week_day_criteria    => Videojuicer::Criterion::WeekDay
+      }
+    end
+    
+    class Base
+      def self.inherited(base)
+        base.send(:include, Videojuicer::Resource)
+        base.send(:extend, Videojuicer::Criterion::Base::ClassMethods)
+        base.send(:include, Videojuicer::Criterion::Base::InstanceMethods)
+      end
+      
+      module ClassMethods
+        def singular_name
+          "criterion"
+        end
+        
+        def base_path(options={})
+          "/criteria/#{self.to_s.split("::").last.snake_case}"
+        end
+        
+        def get(*args); raise NoMethodError; end
+        def all(*args); raise NoMethodError; end
+        def first(*args); raise NoMethodError; end
+      end
+      
+      module InstanceMethods
+        def save(*args); raise NoMethodError; end
+        def destroy(*args); raise NoMethodError; end
+        def ==(other); self.attributes == other.attributes; end
+        def eql?(other); self.attributes.eql?(other.attributes) end
+        def matcher_attributes;  end
+        
+        def matcher_attributes
+          result = {}
+          self.matcher_keys.each do |key|
+            result[key] = self.send(key)
+          end
+          return result
+        end
+        
+        def matcher_keys
+          raise NoMethodError, "Matcher Attributes needs to be implemented for #{self.class}";
+        end
+
+      end
+            
+    end
+  end
+end

data/lib/videojuicer/criterion/date_range.rb

@@ -0,0 +1,15 @@
+require File.join(File.dirname(__FILE__), "base")
+
+module Videojuicer
+  module Criterion
+    class DateRange < Base
+      
+      property :until, DateTime
+      property :from, DateTime
+      
+      def matcher_keys
+        [:until, :from]
+      end
+    end
+  end
+end

data/lib/videojuicer/criterion/geolocation.rb

@@ -0,0 +1,18 @@
+require File.join(File.dirname(__FILE__), "base")
+
+module Videojuicer
+  module Criterion
+    class Geolocation < Base
+      
+      property :country,            String
+      property :region,             String
+      property :city,               String
+      property :exclude,            Boolean
+      
+      def matcher_keys
+        [:country, :region, :city, :exclude]
+      end
+
+    end
+  end
+end