mira 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+viddler.credentials

data/.rvmrc

@@ -0,0 +1 @@
+rvm ruby-1.8.7-p334@mira

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in mira.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+# copied from RSpec :-p
+require 'rspec'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec) do |t| 
+  t.rspec_path = 'rspec'
+  t.rspec_opts = %w[--color]
+  t.verbose = false
+end

data/example.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'lib/mira'
+require 'yaml'
+
+viddler = Mira::ViddlerClient.new(YAML.load(File.open("viddler.credentials")))
+viddler.upload(File.new("sample.mov"),
+               :title => "sample",
+               :tags => "your mom",
+               :description => "whatever")
+

data/lib/mira.rb

@@ -0,0 +1,8 @@
+module Mira
+  require 'json'
+  require 'rest_client'
+  require 'active_support'
+
+  require File.dirname(__FILE__) + '/mira/embed_code'
+  require File.dirname(__FILE__) + '/mira/upload'
+end

data/lib/mira/embed_code.rb

@@ -0,0 +1,78 @@
+module Mira
+  module Viddler
+    # attribution: this code is based very heavily on the original `viddler` gem
+
+    # Returns proper HTML code for embedding
+    #
+    # <tt>options</tt> hash could contain:
+    # * <tt>id:</tt> Viddler ID of the video to display (required);
+    # * <tt>player_type:</tt> The type of player to embed, either "simple" or "player" (default);
+    # * <tt>width:</tt> The width of the player (default is 437);
+    # * <tt>height:</tt> The height of the player (default is 370);
+    # * <tt>autoplay:</tt> Whether or not to autoplay the video, either
+    #       "t" or "f" (default is "f");
+    # * <tt>playAll:</tt> Set to "true" to enable play all player (requires
+    #       player_type to be "player");
+    #
+    # Any additional options passed to the method will be added as flashvars
+    #
+    # Example:
+    #
+    #  Mira::Viddler.embed_code(:player_type => 'simple',
+    #                           :width => 300,
+    #                           :height => 300,
+    #                           :autoplay => 't',
+    #                           :id => "e75e65b2")
+    #
+    # Returns embed code for auto playing video e75e65b2 in simple player with 300px width and height
+    #
+    def self.embed_code(options={})
+      raise "hell" unless options[:id]
+      options = {
+                  :player_type => 'player',
+                  :width => 437,
+                  :height => 370,
+                  :autoplay => 'f',
+                  :wmode => 'transparent'
+                }.merge(options)
+
+      # get non flashvars from options
+      player_type = options.delete(:player_type)
+      width       = options.delete(:width)
+      height      = options.delete(:height)
+      wmode       = options.delete(:wmode)
+      id          = options.delete(:id)
+
+      flashvars = options.collect{|key,value| "#{key}=#{value}"}.join('&')
+
+      html = <<-CODE
+      <!--[if IE]>
+        <object width="#{width}" height="#{height}" id="viddlerOuter-#{id}" classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000">
+          <param name="movie" value="http://www.viddler.com/#{player_type}/#{id}/">
+          <param name="allowScriptAccess" value="always">
+          <param name="allowNetworking" value="all">
+          <param name="allowFullScreen" value="true">
+          <param name="wmode" value="#{wmode}" />
+          <param name="flashVars" value="#{flashvars}">
+          <object id="viddlerInner-#{id}">
+            <video id="viddlerVideo-#{id}" src="http://www.viddler.com/file/#{id}/html5mobile/" type="video/mp4" width="#{width}" height="#{height}" poster="http://www.viddler.com/thumbnail/#{id}/" controls="controls"></video>
+          </object>
+        </object>
+      <![endif]-->
+      <!--[if !IE]> <!-->
+        <object width="#{width}" height="#{height}" id="viddlerOuter-#{id}" type="application/x-shockwave-flash" data="http://www.viddler.com/player/#{id}/"> 
+          <param name="movie" value="http://www.viddler.com/#{player_type}/#{id}/"> 
+          <param name="allowScriptAccess" value="always">
+          <param name="allowNetworking" value="all">
+          <param name="allowFullScreen" value="true">
+          <param name="wmode" value="#{wmode}" />
+          <param name="flashVars" value="#{flashvars}">
+          <object id="viddlerInner-#{id}">
+            <video id="viddlerVideo-#{id}" src="http://www.viddler.com/file/#{id}/html5mobile/" type="video/mp4" width="#{width}" height="#{height}" poster="http://www.viddler.com/thumbnail/#{id}/" controls="controls"></video>
+          </object>
+        </object>
+      <!--<![endif]-->
+    CODE
+    end
+  end
+end

data/lib/mira/upload.rb

@@ -0,0 +1,79 @@
+module Mira
+  class ViddlerClient
+
+    # there's a certain amount of stupidity in this code, because I built it
+    # against specs cribbed from the official Viddler gem, which supports a
+    # much broader range of functionality, so this code uses a slightly inflated
+    # set of assumptions.
+
+    # that being said, here's documentation mostly copied from viddler-ruby...
+
+    # Upload a video to the Viddler API.
+    #
+    # file      - The File you are uploading
+    # arguments - The Hash of arguments for the video
+    #             :title       - The String title of the video
+    #             :tags        - The String of tags for the video
+    #             :description - The String description of the video
+    #             :make_public - The Boolean to make the video public on
+    #                            upload. Please note that if set to false, it
+    #                            will not make your video private.
+    #
+    # Examples
+    #
+    #   viddler.upload File.open('myvideo.avi'), :title       => "My Video",
+    #                                            :tags        => "viddler, ruby",
+    #                                            :description => "This is cool"
+    #
+    # Returns a Hash containing the API response.
+
+    def upload(file, params = {})
+      json = self.get('viddler.videos.prepareUpload')
+      endpoint = json["upload"]["endpoint"]
+      token = json["upload"]["token"]
+      uploaded = RestClient.post(endpoint,
+                                 upload_params(file,
+                                               params.merge!(:token => token)))
+      JSON.parse uploaded
+    end
+
+    def get(api_method, params = {})
+      url = 'http://api.viddler.com/api/v2/' + api_method + '.json'
+      JSON.parse RestClient.get(url,
+                                :params => params.merge!(:sessionid => auth,
+                                                         :method => api_method,
+                                                         :api_key => @api_key))
+    end
+
+    def auth
+      return @session_id if @session_id
+
+      session_request = RestClient.get('http://api.viddler.com/api/v2/viddler.users.auth.json',
+                                       :params => {:user => @username,
+                                                   :password => @password,
+                                                   :api_key => @api_key})
+      @session_id = JSON.parse(session_request)["auth"]["sessionid"]
+    end
+
+    def initialize(credentials)
+      @username = credentials[:username]
+      @password = credentials[:password]
+      @api_key = credentials[:api_key]
+    end
+
+    def upload_params(file, params = {})
+      raise "file argument must be a File" unless file.is_a? File
+      ordered_arguments = ActiveSupport::OrderedHash.new
+
+      params.each {|k,v| ordered_arguments[k] = v}
+
+      ordered_arguments[:api_key]   = @api_key
+      ordered_arguments[:sessionid] = auth
+      ordered_arguments[:file]      = file
+
+      ordered_arguments
+    end
+
+  end
+end
+

data/lib/mira/version.rb

@@ -0,0 +1,3 @@
+module Mira
+  VERSION = "0.0.1"
+end

data/mira.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mira/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mira"
+  s.version     = Mira::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Giles Bowkett"]
+  s.email       = ["gilesb@gmail.com"]
+  s.homepage    = ""
+  s.summary     =  s.description = %q{Bare minimum Viddler API v2}
+
+  s.rubyforge_project = "mira"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specs
+  s.add_development_dependency 'rake', '0.8.7'
+  s.add_development_dependency 'rspec'
+
+  # I don't understand how people can tolerate IRB without my improvements to it. I
+  # get that this is arrogant, but it's also absolutely sincere.
+  s.add_development_dependency 'utility_belt'
+
+  # api methods
+  s.add_runtime_dependency 'json'
+  s.add_runtime_dependency 'rest-client'
+
+  # ordered hash
+  s.add_runtime_dependency 'activesupport'
+end
+

data/readme.md

@@ -0,0 +1,48 @@
+Mira
+====
+
+Mira is a minimal Viddler client. I named it Mira because I had just created another gem with a Spanish name (buscando_el_viento) and I figured I might as well keep the momentum going. "Mira" in Spanish means "look."
+
+I created Mira because the official Viddler gem `viddler-ruby` didn't work out of the box, and fixing whatever was wrong with it seemed like a lot more work than just writing my own.
+
+Mira supports only a tiny subset of the Viddler API's functionality - namely the ability to upload a video, and the ability to obtain an existing video's Flash video player embed code.
+
+code copying
+------------
+
+embed code copied from the original `viddler` gem (which was not actually written by Viddler); upload functionality and specs adapted from Viddler's official `viddler-ruby` gem.
+
+test it out
+-----------
+
+create a `viddler.credentials` yaml file:
+
+    :api_key: 1234123412341234
+    :username: your_username
+    :password: your_password
+
+use the `example.rb` script, or, to see every single step, pop into IRB and do this manually:
+
+    # setup
+    require 'yaml'
+    viddler = Mira::ViddlerClient.new(YAML.load(File.open("viddler.credentials")))
+
+    # optional, just if you want to see everything happen
+    viddler.auth
+    viddler.get('viddler.videos.prepareUpload')
+
+    # money shot
+    viddler.upload(File.new("sample.mov"),
+                   :title => "sample",
+                   :tags => "your mom",
+                   :description => "whatever")
+
+some or all of `:title`, `:tags`, and `:description` are required. API docs are not forthcoming on the subject and I couldn't care less. just throw them all in there and it'll work.
+
+note that after uploading, Viddler will lag before displaying your video, and will not display any kind of "uploaded but still processing..." message. so you basically have to wait a minute with your dick in your hand.
+
+TODO
+====
+
+add specs about that whole requiring title, tags, and/or description shit.
+

data/spec/embed_code_spec.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Mira::Viddler do
+  it "generates embed code" do
+    embed_code = <<-CODE
+      <!--[if IE]>
+        <object width="437" height="370" id="viddlerOuter-e75e65b2" classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000">
+          <param name="movie" value="http://www.viddler.com/player/e75e65b2/">
+          <param name="allowScriptAccess" value="always">
+          <param name="allowNetworking" value="all">
+          <param name="allowFullScreen" value="true">
+          <param name="wmode" value="transparent" />
+          <param name="flashVars" value="autoplay=f">
+          <object id="viddlerInner-e75e65b2">
+            <video id="viddlerVideo-e75e65b2" src="http://www.viddler.com/file/e75e65b2/html5mobile/" type="video/mp4" width="437" height="370" poster="http://www.viddler.com/thumbnail/e75e65b2/" controls="controls"></video>
+          </object>
+        </object>
+      <![endif]-->
+      <!--[if !IE]> <!-->
+        <object width="437" height="370" id="viddlerOuter-e75e65b2" type="application/x-shockwave-flash" data="http://www.viddler.com/player/e75e65b2/"> 
+          <param name="movie" value="http://www.viddler.com/player/e75e65b2/"> 
+          <param name="allowScriptAccess" value="always">
+          <param name="allowNetworking" value="all">
+          <param name="allowFullScreen" value="true">
+          <param name="wmode" value="transparent" />
+          <param name="flashVars" value="autoplay=f">
+          <object id="viddlerInner-e75e65b2">
+            <video id="viddlerVideo-e75e65b2" src="http://www.viddler.com/file/e75e65b2/html5mobile/" type="video/mp4" width="437" height="370" poster="http://www.viddler.com/thumbnail/e75e65b2/" controls="controls"></video>
+          </object>
+        </object>
+      <!--<![endif]-->
+    CODE
+    Mira::Viddler.embed_code(:id => "e75e65b2").should == embed_code
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require File.expand_path("lib/mira")
+%w{rubygems rest_client}.each {|lib| require lib}
+

data/spec/upload_spec.rb

@@ -0,0 +1,78 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+# attribution: these specs were very closely adapted from the official Viddler gem.
+# however the implementation is a good deal looser.
+
+describe Mira::ViddlerClient, "auth" do
+  # this example goes in a different describe block because the step it specs
+  # is stubbed out in the before(:each) for every other example
+  it "gets the session id from the Viddler API" do
+    @viddler_client = Mira::ViddlerClient.new(:username => "user",
+                                              :password => "s3kr3t",
+                                              :api_key => "12345")
+    json = '{"auth":{"sessionid":"15e3c113126b488654849545245434f52444b"}}'
+    RestClient.should_receive(:get).with(anything, anything).and_return(json)
+    @viddler_client.auth.should eq("15e3c113126b488654849545245434f52444b")
+  end
+end
+
+describe Mira::ViddlerClient, "upload" do
+  before(:each) do
+    @file = File.new(File.expand_path("mira.gemspec"))
+    @endpoint = "http://upload.viddler.com/upload.json"
+    @viddler_client = Mira::ViddlerClient.new(:username => "user",
+                                              :password => "s3kr3t",
+                                              :api_key => "12345")
+
+    RestClient.stub!(:post).and_return('{"response":["hello","howdy"]}')
+    @viddler_client.stub!(:get).and_return({"upload" => {"endpoint" => @endpoint}})
+    @viddler_client.should_receive(:auth).and_return('some_session')
+  end
+  
+  it "calls get with viddler.videos.prepareUpload" do
+    @viddler_client.should_receive(:get).with('viddler.videos.prepareUpload')
+    @viddler_client.upload @file,
+                           :param1 => 'asdf',
+                           :param2 => true # FIXME: WTF
+  end
+  
+  it "calls RestClient.post with endpoint, params, and file" do
+    RestClient.should_receive(:post).with(@endpoint,
+                                          hash_including(:param1 => 'asdf',
+                                                         :param2 => true,
+                                                         :file => @file))
+    @viddler_client.upload @file, :param1 => 'asdf', :param2 => true
+  end
+  
+  it "includes sessionid" do
+    RestClient.should_receive(:post).with(anything, hash_including(:sessionid => 'some_session'))
+    @viddler_client.upload @file, :param1 => 'asdf', :param2 => true
+  end
+  
+  it "includes API key" do
+    RestClient.should_receive(:post).with(anything, hash_including(:api_key => '12345'))
+    @viddler_client.upload @file, :param1 => 'asdf', :param2 => true
+  end
+  
+  it "returns result of JSON.parse" do
+    JSON.stub!(:parse).and_return('asdfasdf')
+    @viddler_client.upload(@file, :param1 => 'asdf').should == 'asdfasdf'
+  end
+
+  it "submits the file argument to the API last" do
+    acceptable_params = ActiveSupport::OrderedHash.new
+    acceptable_params[:argle] = :bargle
+    acceptable_params[:api_key] = '12345'
+    acceptable_params[:sessionid] = 'some_session'
+    acceptable_params[:file] = @file
+
+    @viddler_client.upload_params(@file, :argle => :bargle).should == acceptable_params
+  end
+
+  it "requires an actual File" do
+    lambda {@viddler_client.upload_params(@file)}.should_not raise_error
+    lambda {@viddler_client.upload_params("file")}.should raise_error
+  end
+  
+end
+

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification 
+name: mira
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Giles Bowkett
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-14 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  requirement: *id001
+  name: rake
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+  name: rspec
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+  name: utility_belt
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+  name: json
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+  name: rest-client
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id006
+  name: activesupport
+  prerelease: false
+  type: :runtime
+description: Bare minimum Viddler API v2
+email: 
+- gilesb@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- Rakefile
+- example.rb
+- lib/mira.rb
+- lib/mira/embed_code.rb
+- lib/mira/upload.rb
+- lib/mira/version.rb
+- mira.gemspec
+- readme.md
+- sample.mov
+- spec/embed_code_spec.rb
+- spec/spec_helper.rb
+- spec/upload_spec.rb
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: mira
+rubygems_version: 1.8.3
+signing_key: 
+specification_version: 3
+summary: Bare minimum Viddler API v2
+test_files: 
+- spec/embed_code_spec.rb
+- spec/spec_helper.rb
+- spec/upload_spec.rb