framey 1.0.0 → 1.0.1

data/Manifest.txt

@@ -1,6 +1,6 @@
 Manifest.txt
 Rakefile
-README.txt
+README.md
 lib/framey.rb
 lib/framey/api.rb
 lib/framey/configuration.rb

data/README.md

@@ -0,0 +1,122 @@
+# The Framey Ruby Gem
+
+This gem can be used for easy Rails integration with the Framey video recording service. See http://framey.com for more information.
+
+# Dependencies:
+
+* httparty (ruby gem)
+* swfobject (javascript file)
+
+# Installation
+
+If not using bundler, do:
+
+`gem install framey`
+
+otherwise in your Gemfile:
+
+`gem framey`
+
+# User / Development Flow
+
+* You make a page on your site that displays the Framey flash video recorder
+* Your user visits that page and clicks record
+* If your user likes the video she just recorded, she clicks "Publish"
+* After a little while, Framey pings your servers at a specified callback url with a url to the video file
+* You can choose to store those urls on your end, or just the id of the Framey video to access it later on Framey via an API call
+* You then display the video to your user using either the Framey video player or your own favorite flash video player
+
+# Usage
+
+First, sign up at http://framey.com to get an API key and secret and to set your callback url. 
+
+Then in environment.rb do:
+
+    Framey.configure do |config|
+      config.api_key = "[YOUR API KEY]"                             # required
+      config.api_secret = "[YOUR API SECRET]"                       # required
+      config.api_timeout = [API SIGNATURE EXPIRATION IN MINUTES]    # optional (15 by default)
+      config.max_recording_time = [DEFAULT MAXIMUM VIDEO LENGTH]    # optional (30 by default)
+    end
+
+To render the Framey video recorder in an ActionView (example assumes ERB) do:
+
+    <%= javascript_include_tag "swfobject" %>
+    <%= render_recorder({
+      :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
+      }
+    }) %>
+    
+When your user then views this recorder, records a video, and clicks "Publish", your app receives a POST to the specified callback url with the following parameters:
+
+    {
+      :video => {
+        :name => [video name],                  # this is the video's UUID within the Framey system
+        :filesize => [filesize],                # the filesize in bytes of the video
+        :duration => [duration],                # the duration of the video in seconds
+        :state => [state],                      # the state of the video, in this case "uploaded"
+        :views => [number of views],            # the number of times this video has been viewed, in this case 0
+        :data => [the data hash you specified], # this is the exact data you specified in the :session_data hash when rendering the recorder
+        :url => [video url],                    # url to the flash video file on framey that you can feed into a video player later
+        :thumbnail => [thumbnail url]           # url to the thumbnail image that was generated for this video 
+      }
+    } 
+    
+To render the Framey video player in an ActionView (example assumes ERB) do:
+
+    <%= 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)
+    })%>
+    
+Note that you don't have to use the Framey video player, though, and can use any other flash video player you'd like.
+
+To get updated stats information about a given video, do:
+
+    @video = Framey::Api.get_video("[framey video name]")
+    
+This returns a simple Framey::Video object, like so:
+
+    #<Framey::Video:0x1037b4450 @state="uploaded", @filesize=123456, @name="c96323e0-54b1-012e-9d34-7c6d628c53d4", @thumbnail="http://framey.com/videos/c96323e0-54b1-012e-9d34-7c6d628c53d4/thumbnail.jpg", @data={"user_id" => 1}, @url="http://framey.com/videos/c96323e0-54b1-012e-9d34-7c6d628c53d4/source.flv", @views=12, @duration=15.62>
+    
+To delete a video on Framey, do:
+
+    @video.delete!
+
+or:
+
+    Framey::Api.delete_video("[framey video name]")
+
+# Other Documentation
+
+* http://rubydoc.info/gems/framey/1.0.0/frames
+
+# License
+
+(The MIT License)
+
+Copyright (c) 2011 FIX
+
+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/Rakefile

@@ -3,7 +3,7 @@ require 'hoe'
 $:.unshift(File.dirname(__FILE__) + "/lib")
 require 'framey'
 
-Hoe.new('framey', "1.0.0") do |p|
+Hoe.new('framey', "1.0.1") do |p|
   p.name = "framey"
   p.author = "Shaun Salzberg"
   p.description = "A gem for easy Rails integration with the Framey video recording service."
@@ -13,3 +13,5 @@ Hoe.new('framey', "1.0.0") do |p|
   p.changes = p.paragraphs_of('CHANGELOG', 0..1).join("\n\n")
   p.remote_rdoc_dir = '' # Release to root
 end
+
+

data/lib/framey.rb

@@ -3,7 +3,7 @@ require 'framey/api'
 require 'framey/view_helpers'
 
 module Framey
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
   
   extend Configuration
 end

data/lib/framey/api.rb

@@ -3,11 +3,20 @@ require 'httparty'
 
 module Framey
   module Api
+    
+    # Use this method to fetch updating information about a recording.
+    #
+    # Example Usage:
+    #   Framey::Api.get_video("c96323e0-54b1-012e-9d34-7c6d628c53d4")
     def self.get_video(video_name)
       res = self.make_request("get","/api/videos/#{video_name}")
       return Video.new(res["video"])
     end
-
+    
+    # Use this method to delete a recording.
+    #
+    # Example Usage:
+    #   Framey::Api.delete_video("c96323e0-54b1-012e-9d34-7c6d628c53d4")
     def self.delete_video(video_name)
       res = self.make_request("delete","/api/videos/#{video_name}")
       return true

data/lib/framey/configuration.rb

@@ -1,7 +1,7 @@
 module Framey
   
   module Configuration
-    VERSION = '1.0.0'.freeze unless defined?(VERSION)
+    VERSION = '1.0.1'.freeze unless defined?(VERSION)
     
     DEFAULT_API_HOST = "http://framey.com".freeze
     DEFAULT_USER_AGENT = "Framey Ruby Gem #{VERSION}".freeze

data/lib/framey/view_helpers.rb

@@ -1,6 +1,18 @@
 module Framey
 
   module ViewHelpers
+    
+    # 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
@@ -8,7 +20,7 @@ module Framey
       run_env = Framey.run_env
       max_time = opts[:max_time] || 30
       divid = "frameyRecorderContainer_#{(rand*999999999).to_i}"
-      objid = "the#{divid}"
+      objid = opts[:id] || "the#{divid}"
       
 raw <<END_RECORDER
   <div id="#{divid}"></div>
@@ -34,12 +46,24 @@ raw <<END_RECORDER
 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 = "the#{divid}"
+      objid = opts[:id] || "the#{divid}"
       
       progress_bar_color = "#{opts[:progress_bar_color]}"
       volume_bar_color = "#{opts[:volume_bar_color]}"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: framey
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Shaun Salzberg
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-29 00:00:00 Z
+date: 2011-05-02 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: hoe
@@ -41,11 +41,10 @@ extensions: []
 
 extra_rdoc_files: 
 - Manifest.txt
-- README.txt
 files: 
 - Manifest.txt
 - Rakefile
-- README.txt
+- README.md
 - lib/framey.rb
 - lib/framey/api.rb
 - lib/framey/configuration.rb

data/README.txt

@@ -1,53 +0,0 @@
-= framey
-
-* http://framey.com
-
-== DESCRIPTION:
-
-This ruby gem can be used for easy Rails integration with the Framey video recording service.
-
-== FEATURES/PROBLEMS:
-
-* Easily embed the framey recorders and players and make API calls to the framey web service.
-
-== SYNOPSIS:
-
-  Framey::API.get_video([your video name])
-  Framey::API.delete_video([your video name])
-  <%= render_recorder %>
-  <%= render_player(:video_url => [your framey video url]) %>
-
-== REQUIREMENTS:
-
-* httparty
-
-== INSTALL:
-
-* sudo gem install framey
-
-== DEVELOPERS:
-
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2011 FIX
-
-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.