framey 1.0.0

data/Manifest.txt

@@ -0,0 +1,7 @@
+Manifest.txt
+Rakefile
+README.txt
+lib/framey.rb
+lib/framey/api.rb
+lib/framey/configuration.rb
+lib/framey/view_helpers.rb

data/README.txt

@@ -0,0 +1,53 @@
+= 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.

data/Rakefile

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

data/lib/framey/api.rb

@@ -0,0 +1,93 @@
+require 'digest/md5'
+require 'httparty'
+
+module Framey
+  module Api
+    def self.get_video(video_name)
+      res = self.make_request("get","/api/videos/#{video_name}")
+      return Video.new(res["video"])
+    end
+
+    def self.delete_video(video_name)
+      res = self.make_request("delete","/api/videos/#{video_name}")
+      return true
+    end
+    
+    def self.make_request(method,url,params={})
+      timestamp, signature = self.sign
+      
+      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
+        nil
+      end
+      
+      parsed_res = res ? res.parsed_response : nil
+      
+      if !res || parsed_res["success"] == false
+        err = nil
+        msg = parsed_res ? parsed_res["message"]  : "There was a problem connecting to framey. Please try again."
+        
+        case res.code
+        when 400
+          err = BadRequest.new(msg,res.headers)
+        when 403
+          err = Forbidden.new(msg,res.headers)
+        when 404
+          err = NotFound.new(msg,res.headers)
+        when 500
+          err = InternalServerError.new(msg,res.headers)
+        else
+          err = SocketError.new(msg)
+        end
+        
+        raise err
+      end
+      
+      parsed_res
+    end
+    
+    def self.sign
+      timestamp = Time.now.utc + Framey.api_timeout * 60
+      signature = Digest::MD5.hexdigest(Framey.api_secret + "&" + timestamp.strftime("%m%d%Y%H%M%S"))
+      return timestamp.to_s, signature
+    end
+    
+    class Error < StandardError
+      attr_reader :http_headers
+
+      def initialize(message, http_headers={})
+        @http_headers = Hash[http_headers]
+        super message
+      end
+    end
+      
+    # 400
+    class BadRequest < Error; end
+
+    # 403
+    class Forbidden < Error; end
+
+    # 404
+    class NotFound < Error; end
+
+    # 500
+    class InternalServerError < Error; end
+  end
+  
+  class Video
+    attr_accessor :name, :url, :filesize, :duration, :state, :views, :data, :url, :thumbnail
+
+    def initialize(attrs={})
+      attrs.each do |k,v|
+        self.send("#{k.to_s}=",v)
+      end
+    end
+
+    def delete!
+      Framey::Api::delete_video(self.name)
+    end
+  end
+end
+

data/lib/framey/configuration.rb

@@ -0,0 +1,43 @@
+module Framey
+  
+  module Configuration
+    VERSION = '1.0.0'.freeze unless defined?(VERSION)
+    
+    DEFAULT_API_HOST = "http://framey.com".freeze
+    DEFAULT_USER_AGENT = "Framey Ruby Gem #{VERSION}".freeze
+    DEFAULT_RUN_ENV = "production"
+    
+    CONFIGURATION_OPTIONS = {
+      :api_key => nil,
+      :api_secret => nil,
+      :api_timeout => 15, # minutes
+      :max_recording_time => 30, # seconds
+      :api_host => DEFAULT_API_HOST,
+      :run_env => DEFAULT_RUN_ENV,
+      :user_agent => DEFAULT_USER_AGENT
+    }.freeze
+    
+    attr_accessor *(CONFIGURATION_OPTIONS.map { |k,v| k })
+    
+    def self.extended(base)
+      base.reset
+    end
+        
+    def configure(&blk)
+      yield(self)
+    end
+    
+    def options
+      options = {}
+      CONFIGURATION_OPTIONS.each{|k| options[k] = send(k) }
+      options
+    end
+
+    def reset
+      CONFIGURATION_OPTIONS.each do |k,v|
+        send("#{k}=",v)
+      end
+    end
+    
+  end
+end

data/lib/framey/view_helpers.rb

@@ -0,0 +1,80 @@
+module Framey
+
+  module ViewHelpers
+    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] || 30
+      divid = "frameyRecorderContainer_#{(rand*999999999).to_i}"
+      objid = "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("#{Framey.api_host}/recorder.swf", "#{divid}", "340", "340", "8", "", flashvars, params, attributes);
+  </script>
+END_RECORDER
+    end
+    
+    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}"
+      
+      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("#{Framey.api_host}/player.swf", "#{divid}", '340', '290', '9', 'false', flashvars, params, attributes);
+      </script>
+END_PLAYER
+    end
+  end
+  
+end
+
+module ActionView
+  module Helpers
+    include Framey::ViewHelpers
+  end
+end

data/lib/framey.rb

@@ -0,0 +1,9 @@
+require 'framey/configuration'
+require 'framey/api'
+require 'framey/view_helpers'
+
+module Framey
+  VERSION = "1.0.0"
+  
+  extend Configuration
+end

data/test/test_framey.rb

@@ -0,0 +1,8 @@
+require "test/unit"
+require "framey"
+
+class TestFramey < Test::Unit::TestCase
+  def test_sanity
+    flunk "write tests or I will kneecap you"
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: framey
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Shaun Salzberg
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-29 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 2
+        - 9
+        - 4
+        version: 2.9.4
+  type: :development
+  version_requirements: *id001
+description: A gem for easy Rails integration with the Framey video recording service.
+email: shaun@qlabs.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Manifest.txt
+- README.txt
+files: 
+- Manifest.txt
+- Rakefile
+- README.txt
+- lib/framey.rb
+- lib/framey/api.rb
+- lib/framey/configuration.rb
+- lib/framey/view_helpers.rb
+- test/test_framey.rb
+- .gemtest
+homepage: http://framey.com
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: framey
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: A gem for easy Rails integration with the Framey video recording service.
+test_files: 
+- test/test_framey.rb