framey 1.2.0 → 1.2.1

data/README.md

@@ -0,0 +1,143 @@
+# 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)
+* will_paginate (ruby gem)
+
+# Installation
+
+First, sign up at http://framey.com to get an API key and secret and to set your callback url. 
+
+If not using bundler, do:
+
+`gem install framey`
+
+otherwise in your Gemfile:
+
+`gem framey`
+
+Run the framey generator:
+
+`rails generate framey API_KEY API_SECRET`
+
+This automatically creates default views, controller and routes for recording and viewing videos, as well as the callback that framey.com pings with the video information:
+
+	/framey/videos
+	/framey/videos/new
+	/framey/videos/<video_id>
+	/framey/callback
+
+Create the supporting database tables:
+	rake db:migrate
+
+Edit the default configuration options in config/framey.rb:
+
+	API_HOST = "http://framey.com"
+	RUN_ENV = "production"
+	API_KEY = "API_KEY_VALUE"
+	SECRET = "API_SECRET_VALUE"
+	API_TIMEOUT = 15
+	MAX_TIME = 30
+
+# 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"
+* The user's video is processed and stored on the Framey servers.
+* Framey emails you and/or 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 or HTML 5 video player
+
+# Usage
+
+
+To render the Framey video recorder in an ActionView (example assumes ERB) do:
+
+    <%= javascript_include_tag "swfobject" %>
+    <%= render_recorder({
+      :id => "myRecorder",             # id for 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
+      }
+    }) %>
+    
+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
+        :flv_url => [video url],                    # url to the flash video file on framey that you can feed into a video player later
+        :mp4_url => [h.264 video url],              # url to the h.264 video file on framey that you can feed into a video player later
+        :large_thumbnail_url => [thumbnail url]     # url to the large thumbnail image that was generated for this video 
+        :medium_thumbnail_url => [thumbnail url]    # url to the medium thumbnail image that was generated for this video 
+        :small_thumbnail_url => [thumbnail url]     # url to the small 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({
+      :id => "myPlayer",                    # id for the flash embed object (optional, random by default)
+      :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", @large_thumbnail_url="http://framey.com/thumbnails/c96323e0-54b1-012e-9d34-7c6d628c53d4.jpg", @medium_thumbnail_url="http://framey.com/thumbnails/c96323e0-54b1-012e-9d34-7c6d628c53d4.jpg", @small_thumbnail_url="http://framey.com/thumbnails/c96323e0-54b1-012e-9d34-7c6d628c53d4.jpg", @data={"user_id" => 1}, @flv_url="http://framey.com/videos/source/c96323e0-54b1-012e-9d34-7c6d628c53d4/source.flv", @mp4_url="http://framey.com/videos/source/c96323e0-54b1-012e-9d34-7c6d628c53d4/source.mp4", @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.2.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/app/helpers/framey/videos_helper.rb

@@ -16,7 +16,7 @@ module Framey
       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
+      max_time = opts[:max_time] || Framey::MAX_TIME
       divid = "frameyRecorderContainer_#{(rand*999999999).to_i}"
       objid = opts[:id] || "the#{divid}"
       

data/config/routes.rb

@@ -3,13 +3,11 @@ Rails.application.routes.draw do |map|
   mount_at = Framey::Engine.config.mount_at
 
   match mount_at => 'framey/videos#index'
-
+  
   map.resources :videos, :only => [ :index, :show, :new],
                           :controller => "framey/videos",
                           :path_prefix => mount_at,
                           :name_prefix => "framey_"
   post "/framey/callback" => "framey/videos#callback"
 
-                          
-
 end

data/lib/api.rb

@@ -25,7 +25,7 @@ module Framey
     def self.make_request(method,url,params={})
       timestamp, signature = self.sign
       
-      params = params.merge({:time_stamp => timestamp, :signature => signature, :api_key => Framey.api_key})
+      params = params.merge({:time_stamp => timestamp, :signature => signature, :api_key => Framey::API_KEY})
       res = begin
         HTTParty.send(method,Framey::API_HOST + url,{:query => params}) 
       rescue SocketError => e

data/lib/engine.rb

@@ -8,7 +8,7 @@ module Framey
 
     # Config defaults
     config.video_factory_name = "default factory name"
-    config.mount_at = '/'
+    config.mount_at = '/framey'
     
     # Load rake tasks
     rake_tasks do

data/lib/rails/generators/framey/templates/initializer.rb

@@ -2,7 +2,7 @@ module Framey
   class Engine < Rails::Engine
 
     config.mount_at = '/framey'
-    config.video_factory_name = 'Factory Name'
+    config.video_factory_name = 'Framey Factory'
         
   end
   
@@ -11,4 +11,6 @@ module Framey
   API_KEY = "API_KEY_VALUE"
   SECRET = "API_SECRET_VALUE"
   API_TIMEOUT = 15
+  MAX_TIME = 30
 end
+

data/lib/rails/railties/tasks.rake

@@ -1,8 +1,4 @@
 namespace :framey do
-  
-  desc "example gem rake task"
-  task :report => :environment do
-    puts "you just ran the example gem rake task"
-  end
+
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: framey
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-06 00:00:00.000000000Z
+date: 2011-09-07 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &2156150860 !ruby/object:Gem::Requirement
+  requirement: &2161364280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2156150860
+  version_requirements: *2161364280
 - !ruby/object:Gem::Dependency
   name: will_paginate
-  requirement: &2156148300 !ruby/object:Gem::Requirement
+  requirement: &2161362860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *2156148300
+  version_requirements: *2161362860
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2156147600 !ruby/object:Gem::Requirement
+  requirement: &2161361840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,13 +43,13 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156147600
+  version_requirements: *2161361840
 description: TO DO
 email: david@qlabs.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.rdoc
+- README.md
 files:
 - app/controllers/framey/videos_controller.rb
 - app/helpers/application_helper.rb
@@ -77,7 +77,7 @@ files:
 - public/player.swf
 - public/recorder.swf
 - public/stylesheets/framey.css
-- README.rdoc
+- README.md
 homepage: http://framey.com
 licenses: []
 post_install_message: 

data/README.rdoc

@@ -1,56 +0,0 @@
-== Overview
-
-One of the things I was most looking forward to in rails 3 was the plugin / engine architecture. Recently, I sat down to figure out how to create my first engine and package it up as a gem and it took me awhile of time just to get the structure of the engine setup. It's missing a lot of the "rails" you get in a normal rails app.
-
-In it's simplest form engines are quite easy, however for a full-featured engine (such as creating a forum) there are a lot of extras that you're going to want. These are the things I spent time figuring out that I've packaged up into an easy starting point:
-
-* Namespacing models & controllers so they don't collide with those in the main app
-* Creating a global layout within your engine that gets nested within your application layout
-* Generating migrations from your engine
-* Creating an "acts_as_[plugin]" declaration for use inside your main app's models
-* Easy plugin configuration file editable from main app directory
-* Rake tasks within engine
-* Writing tests for models complete with fixtures
-* Serving static assets within engine
-* Packaging and distributing as a gem
-* Code is here - I've created an engine stub that has all the things setup for you already. I want to see a lot more rails 3 engines get created, I hope this helps! I'd love to hear feedback from you if you try it out.
-
-Here’s how you get ready to create your first gem by using this starting point:
-
-* git clone http://github.com/krschacht/rails_3_engine_demo.git
-* cd rails_3_engine_demo
-* [edit test/database.yml]
-* rake test (this will initialize your test database and run the basic test suite)
-
-Now, create a plain rails app and set it up to use your engine. FYI: even though the engine's directory is 'rails_3_engine_demo', internally the engine is named 'cheese'
-
-* cd .. [ this is to take you outside the 'rails_3_engine_demo' directory that was created above' ]
-* rails new demo_app_to_use_gem -d mysql
-* cd demo_app_to_use_gem
-* [edit config/database.yml]
-* [edit Gemfile, add line: ] gem ‘cheese’, :path => "../rails_3_engine_demo"
-* rails generate cheese
-* [examine config/initializers/cheese.rb to see basic config parameters]
-* rake db:create
-* rake db:migrate (one of the migrations that you'll see run came from the engine)
-
-You have now setup a empty rails app that utilizes your engine. To test out the functionality, startup the demo app’s webserver:
-
-* rails server
-* Then visit: http://localhost:3000/cheese (this is a controller included within the engine)
-* Watch the server logs as you're viewing this page and you'll see some output which is coming from an application before_filter which is executing from inside the engine (in lib/application_controller.rb)
-* rake cheese:report (this is a a rake task that is included inside the engine)
-
-Lastly, let's package up your engine as a real gem. You’ll need Jeweler installed for this:
-
-* cd rails_3_engine_demo
-* sudo gem install jeweler
-* rake gemspec
-* rake build
-* rake install (you have now installed your engine as a gem locally)
-* [ At this point if you wanted your demo app to use your installed gem, edit the Gemfile in your demo app and remove the 'path' option from your gem line. It should look like this: ] gem ‘cheese’
-* rake gemcutter:release (this pushes your gem up to Gemcutter, a public gem repository)
-
-Now you’re ready to start customizing this engine for your own purposes. Do a global find in your engine directory and replace every instance of "cheese" and "Cheese" with your engine name (be sure to preserve capitalization). Likewise, rename every directory and file that’s named "cheese" with your engine name. I should really automate this but I haven’t figured out how to create a rake task that I can run from within the engine directory itself.
-
-P.S. Special thanks to Chrispy for helping figure out the application_controller includes!