videojuicer-vj-sdk 0.1.5 → 0.1.12

data/lib/videojuicer/resource/embeddable.rb

@@ -0,0 +1,30 @@
+=begin rdoc
+  
+  A module that provides OEmbed functionality to any Videojuicer::Resource model.
+
+=end
+
+module Videojuicer
+  module Resource
+    module Embeddable
+      
+      OEMBED_ENDPOINT = "/oembed".freeze
+      
+      def oembed_payload(maxwidth, maxheight)
+        proxy = proxy_for(config)
+        result = proxy.get(OEMBED_ENDPOINT, :format=>"json", :url=>"#{proxy.host_stub}#{resource_path}?seed_name=#{seed_name}", :maxwidth=>maxwidth, :maxheight=>maxheight)
+        JSON.parse(result.body)
+      end
+      
+      def embed_size(maxwidth, maxheight)
+        p = oembed_payload(maxwidth, maxheight)
+        return p["width"], p["height"]
+      end
+      
+      def embed_code(maxwidth, maxheight)
+        oembed_payload(maxwidth, maxheight)["html"]
+      end
+      
+    end
+  end
+end

data/lib/videojuicer/resource/inferrable.rb

@@ -29,10 +29,56 @@ module Videojuicer
   
       def self.included(base)
         base.extend(SingletonMethods)
+        base.send :include, InstanceMethods
+      end
+      
+      module InstanceMethods
+        # Returns the appropriate resource path for this object.
+        # If the object is a new record, then the root object type path
+        # will be given. If the object is not new (has an ID) then the
+        # specific ID will be used.
+        def resource_path(action=nil, route_options={})
+          route_options = {:id=>id}.merge(route_options) unless new_record?
+          r = self.class.resource_route(action, route_options)
+          self.class.compile_route(r, attributes)
+        end
       end
       
       module SingletonMethods
         
+        def compile_route(mask, properties={})
+          properties = properties.deep_stringify
+          result = []
+          mask.split("/").each do |member|
+            if member[0..0] == ":"
+              result << (properties[member.delete(":")])
+            else
+              result << member
+            end            
+          end
+          "#{result.join("/")}"
+        end
+        
+        # Nested resources are inferred from the class hierarchy:
+        # Something.parent_class #=> nil
+        # Something::Else.parent_class #=> Something        
+        # Monkeys::Are::Delicious
+        def containing_class
+          c = self.to_s.split("::"); c.pop
+          (c.any?)? Object.full_const_get(c.join("::")) : nil
+        end
+        
+        # The route fragment under which nested resources should be mapped.
+        def nesting_route
+          r = ["/#{plural_name}/#{nesting_route_key}"]
+          r = ([(self.containing_class.nesting_route rescue nil)] + r).compact.join("")
+        end
+        
+        # The key used by other models when referring to this one in resource routes. User.nesting_route_key == ":user_id"
+        def nesting_route_key
+          ":#{resource_name}_id"
+        end
+        
         # Returns the lowercased, underscored version of the including class name.
         # e.g. Videojuicer::ExampleModel.singular_name => "example_model"
         def singular_name
@@ -40,13 +86,17 @@ module Videojuicer
                               gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
                               gsub(/([a-z\d])([A-Z])/,'\1_\2').
                               tr("-", "_").
-                              downcase
+                              downcase.snake_case
         end
         
         # Returns the plural version of the underscored singular name. This method,
         # when compared directly and fairly to something like ActiveSupport's inflection
         # module, is an idiot. You would be best to treat it as one.
         def plural_name
+          if singular_name.match(/y$/)
+          	return singular_name.gsub(/y$/, "ies")
+          end          
+          # Fall back to the simplest rules
           (singular_name.match(/s$/))? "#{singular_name}es" : "#{singular_name}s"
         end
         
@@ -63,16 +113,26 @@ module Videojuicer
         end
 
         # The path to this class's resource given the desired action route.
-        def resource_path(action=nil)
-          action_stem = (action)? "/#{action}" : ""
-          "#{base_path}#{action_stem}"
+        # Returned as a mask with replaceable keys e.g. /fixed/fixed/:replaceme/fixed
+        def resource_route(action=nil, route_options={})
+          id = route_options.delete(:id)
+          action_stem = (id)? "/#{id}" : ""
+          action_stem += (action)? "/#{action}" : ""
+          action_stem += ".json" unless action_stem.empty?
+          "#{base_path(route_options)}#{action_stem}"
         end
         
-        # The root path for requests to the API. By default this is inferred from the plural name
+        # The root route for requests to the API. By default this is inferred from the plural name
         # e.g. Videojuicer::Presentation uses /presentations as the resource_path.
-        def base_path
-          "/#{plural_name}"
+        def base_path(options={})
+  	      options = {
+  	      	:nested=>true
+  	      }.merge(options)
+          r = "/#{plural_name}"
+          r = "#{self.containing_class.nesting_route rescue nil}#{r}" if options[:nested]
+          return r
         end
+        
       end
       
       

data/lib/videojuicer/resource/property_registry.rb

@@ -74,9 +74,28 @@ module Videojuicer
         return value unless value
         klass = self.class.attributes[key][:class]
         if value.is_a?(String) and value.any?
+          # In-built types
+          if klass.kind_of?(Videojuicer::Resource::Types::Base)
+            return klass.new(value).dump
+          end
+          
+          # Dates
           if klass.respond_to?(:parse)
             return klass.parse(value) rescue raise "Invalid date: #{value.inspect}"
           end
+        elsif value.is_a? Hash and value.any?
+          if klass == DateTime
+            if value.is_a?(Hash)
+              year   = value[:year]
+              month  = value[:month]
+              day    = value[:day]
+              hour   = value[:hour] or "00"
+              minute = value[:minute] or "00"
+              value = klass.parse("#{year}-#{month}-#{day}T#{hour}:#{minute}:00+00:00")
+            else
+              raise ArgumentError, "Please supply a DateTime, Hash keyed w/ [:day, :month, :year, :hour, :minute] or a String that can be coerced into a date"
+            end
+          end
         end
         return value
       end

data/lib/videojuicer/resource/relationships/belongs_to.rb

@@ -17,9 +17,10 @@ module Videojuicer
             
             define_method name do
               id = self.send(options[:foreign_key])
+              klass = (options[:class].is_a?(String))? Videojuicer.const_get(options[:class]) : options[:class]
               return nil unless id
               begin
-                return options[:class].get(id)
+                return klass.get(id)
               rescue Videojuicer::Exceptions::NoResource
                 return nil
               end

data/lib/videojuicer/resource/types.rb

@@ -0,0 +1,28 @@
+module Videojuicer
+  module Resource
+    module Types
+      
+      class Base
+        def self.load(value)
+          return self.new(value)
+        end
+
+        def initialize(value)
+          @raw = value
+        end
+        
+        # Returns the source value
+        attr_reader :raw
+      end
+      
+      class Boolean < Base
+        # Boolean.new("1").dump #=> true
+        # Returns the coerced value
+        def dump
+          [1, "1", "true", "yes"].include?(raw)
+        end        
+      end
+    
+    end
+  end
+end

data/spec/assets/audio_spec.rb

@@ -0,0 +1,24 @@
+require File.join(File.dirname(__FILE__), "..", "helpers",  "spec_helper")
+
+describe Videojuicer::Asset::Audio do
+  
+  before(:all) do
+    @klass = Videojuicer::Asset::Audio
+    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
+  
+  
+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
+  
+  
+end

data/spec/assets/image_spec.rb

@@ -0,0 +1,24 @@
+require File.join(File.dirname(__FILE__), "..", "helpers",  "spec_helper")
+
+describe Videojuicer::Asset::Image do
+  
+  before(:all) do
+    @klass = Videojuicer::Asset::Image
+    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
+  
+  
+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
+  
+  
+end

data/spec/assets/video_spec.rb

@@ -0,0 +1,24 @@
+require File.join(File.dirname(__FILE__), "..", "helpers",  "spec_helper")
+
+describe Videojuicer::Asset::Video do
+  
+  before(:all) do
+    @klass = Videojuicer::Asset::Video
+    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
+  
+  
+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

@@ -5,15 +5,6 @@ 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
@@ -25,9 +16,6 @@ describe Videojuicer::Campaign 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"

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