framey 1.2.1 → 1.2.2

data/README.md

@@ -19,6 +19,10 @@ otherwise in your Gemfile:
 
 `gem framey`
 
+There are two options for using the framey gem: using included scaffold code for views, models and callbacks or creating your own views.  Depending on your choice, follow the appropriate instructions below to complete the installation. 
+
+## Using the included scaffold	
+
 Run the framey generator:
 
 `rails generate framey API_KEY API_SECRET`
@@ -31,6 +35,7 @@ This automatically creates default views, controller and routes for recording an
 	/framey/callback
 
 Create the supporting database tables:
+
 	rake db:migrate
 
 Edit the default configuration options in config/framey.rb:
@@ -42,6 +47,21 @@ Edit the default configuration options in config/framey.rb:
 	API_TIMEOUT = 15
 	MAX_TIME = 30
 
+## Creating your own views
+
+Create a framey initializer at config/framey.rb and modify the following code to use your API keys
+	
+	module Framey
+	  API_HOST = "http://framey.com"
+	  RUN_ENV = "production"
+	  API_KEY = "API_KEY_VALUE"
+	  SECRET = "API_SECRET_VALUE"
+	  API_TIMEOUT = 15
+	  MAX_TIME = 30
+	end
+	
+
+
 # User / Development Flow
 
 * You make a page on your site that displays the Framey flash video recorder

data/app/helpers/framey/videos_helper.rb

@@ -1,95 +1,4 @@
 module Framey
   module VideosHelper
-    # This method renders the Framey video recorder from within an ActionView in your Rails app.
-    #
-    # Example Usage (assuming ERB):
-    #    <%= javascript_include_tag "swfobject" %>
-    #    <%= render_recorder({
-    #      :id => "[some id]"               # the id of the flash embed object (optional, random by default)
-    #      :max_time => 60,                 # maximum allowed video length in seconds (optional, defaults to 30)
-    #      :session_data => {               # custom parameters to be passed along to your app later (optional)
-    #        :user_id => <%= @user.id %>    # you may, for example, want to relate this recording to a specific user in your system
-    #      }
-    #    }) %>
-    def render_recorder(opts={})
-      api_key = Framey::API_KEY
-      timestamp, signature = Framey::Api.sign
-      session_data = (opts[:session_data]||{}).map { |k,v| "#{k.to_s}=#{v.to_s}" }.join(",")
-      run_env = Framey::RUN_ENV
-      max_time = opts[:max_time] || Framey::MAX_TIME
-      divid = "frameyRecorderContainer_#{(rand*999999999).to_i}"
-      objid = opts[:id] || "the#{divid}"
-      
-raw <<END_RECORDER
-  <div id="#{divid}"></div>
-  <script type="text/javascript">
-  var flashvars = {
-  	api_key: "#{api_key}",
-  	signature: "#{signature}",
-  	time_stamp: "#{timestamp}",
-  	session_data: "#{session_data}",
-  	run_env: "#{run_env}",
-  	max_time: "#{max_time.to_s}"
-  };
-  var params = {
-    'allowscriptaccess': 'always',
-    "wmode": "transparent"
-  };
-  var attributes = {
-    'id': "#{objid}",
-    'name': "#{objid}"
-  };
-  swfobject.embedSWF("/recorder.swf", "#{divid}", "340", "340", "8", "", flashvars, params, attributes);
-  </script>
-END_RECORDER
-    end
-    
-    
-    # This method renders the Framey video player from within an ActionView in your Rails app.
-    #
-    # Example Usage (assuming ERB):
-    #    <%= javascript_include_tag "swfobject" %>
-    #    <%= render_player({
-    #      :video_url => "[video url]",          # the video url received in the callback (required)
-    #      :thumbnail_url => "[thumbnail url]",  # the thumbnail url received in the callback (required)
-    #      :progress_bar_color => "0x123456",    # the desired color for the progress bar (optional, defaults to black)
-    #      :volume_bar_color => "0x123456",      # the desired color for the volume bar (optional, defaults to black)
-    #      :id => "[some id]"                    # the id of the flash embed object (optional, random by default)
-    #    }) %>
-    def render_player(opts={})
-      video_url = opts[:video_url] || "#{Framey::API_HOST}/videos/#{opts[:video_name]}/source.flv"
-      thumbnail_url = opts[:thumbnail_url] || "#{Framey::API_HOST}/videos/#{opts[:video_name]}/thumbnail.jpg"
-      
-      divid = "frameyPlayerContainer_#{(rand*999999999).to_i}"
-      objid = opts[:id] || "the#{divid}"
-      
-      progress_bar_color = "#{opts[:progress_bar_color]}"
-      volume_bar_color = "#{opts[:volume_bar_color]}"
-      
-raw <<END_PLAYER
-      <div id="#{divid}"></div>
-      <script type="text/javascript">
-      var flashvars = {
-        'video_url': "#{video_url}",
-        'thumbnail_url': "#{thumbnail_url}",
-        "progress_bar_color": "#{progress_bar_color}",
-        "volume_bar_color": "#{volume_bar_color}"
-      };
-
-      var params = {
-        'allowfullscreen': 'true',
-        'allowscriptaccess': 'always',
-        "wmode": "transparent"
-      };
-
-      var attributes = {
-        'id': "#{objid}",
-        'name': "#{objid}"
-      };
-
-      swfobject.embedSWF("/player.swf", "#{divid}", '340', '290', '9', 'false', flashvars, params, attributes);
-      </script>
-END_PLAYER
-    end
   end
 end

data/lib/framey.rb

@@ -5,4 +5,5 @@ module Framey
   require 'httparty'
   require 'will_paginate'
   require 'api'
+  require 'view_helpers'
 end

data/lib/view_helpers.rb

@@ -1,7 +1,5 @@
 module Framey
-
   module ViewHelpers
-    
     # This method renders the Framey video recorder from within an ActionView in your Rails app.
     #
     # Example Usage (assuming ERB):
@@ -14,11 +12,11 @@ module Framey
     #      }
     #    }) %>
     def render_recorder(opts={})
-      api_key = Framey.api_key
+      api_key = Framey::API_KEY
       timestamp, signature = Framey::Api.sign
       session_data = (opts[:session_data]||{}).map { |k,v| "#{k.to_s}=#{v.to_s}" }.join(",")
-      run_env = Framey.run_env
-      max_time = opts[:max_time] || 30
+      run_env = Framey::RUN_ENV
+      max_time = opts[:max_time] || Framey::MAX_TIME
       divid = "frameyRecorderContainer_#{(rand*999999999).to_i}"
       objid = opts[:id] || "the#{divid}"
       
@@ -94,9 +92,7 @@ raw <<END_PLAYER
 END_PLAYER
     end
   end
-  
 end
-
 module ActionView
   module Helpers
     include Framey::ViewHelpers

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: framey
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-07 00:00:00.000000000Z
+date: 2011-09-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &2161364280 !ruby/object:Gem::Requirement
+  requirement: &2153424500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2161364280
+  version_requirements: *2153424500
 - !ruby/object:Gem::Dependency
   name: will_paginate
-  requirement: &2161362860 !ruby/object:Gem::Requirement
+  requirement: &2153423140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *2161362860
+  version_requirements: *2153423140
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2161361840 !ruby/object:Gem::Requirement
+  requirement: &2153421820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,8 +43,8 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2161361840
-description: TO DO
+  version_requirements: *2153421820
+description: A gem for easy Rails integration with the Framey video recording service.
 email: david@qlabs.com
 executables: []
 extensions: []