easy-vimeo 0.3.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright © 2009 Novelys & Promopixel.
+
+Written by Nicolas Blanco.
+
+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/README.textile

@@ -0,0 +1,56 @@
+h1. EasyVimeo
+
+EasyVimeo aims to be a very easy and Ruby wrapper around the Vimeo API.
+
+With EasyVimeo, you can upload a video file to the Vimeo website and set its basic properties in a few lines of code.
+
+h1. What's new ?
+
+0.3.0 : updates to new Ruby Vimeo API with some cleanup. We don't need curl anymore because the Ruby Vimeo API now uses HTTPClient to upload.
+
+h1. Example
+
+h2. Send a video in just a few lines of code...
+
+<pre>
+<code>
+  v = Vimeo::Easy.new :api_key => VIMEO_API_KEY, :secret_key => VIMEO_SECRET_KEY, :auth_token => VIMEO_AUTH_TOKEN
+  v.title = "Ma great video"
+  v.description = "Great cool video"
+  v.tags = "youpi, super, cool"
+  v.privacy = :anybody
+  
+  v.file = "/Users/nicolas/test.mov"
+  v.save
+</code>
+</pre>
+
+h2. Or just get the attributes from an existing video...
+
+<pre>
+<code>
+  v = Vimeo::Easy.find 2052244, :api_key => VIMEO_API_KEY, :secret_key => VIMEO_SECRET_KEY
+</code>
+</pre>
+  
+h2. Other interesting methods...
+
+<pre>
+<code>
+  v.available? # => returns true if the video is currenly available on Vimeo (uploaded & transcoded)
+  v.destroy    # => destroy the video
+  v.reload     # => reload the attributes
+</code>
+</pre>
+
+h1. TODO
+
+Add some error management.
+
+And that's all for now ;). Thanks!
+
+h1. Copyright
+
+Copyright (c) 2009 Novelys & Promopixel. See LICENSE for details.
+
+Written by Nicolas Blanco.

data/Rakefile

@@ -0,0 +1,66 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "easy-vimeo"
+    gem.summary = "EasyVimeo is an object wrapper around the Ruby Vimeo API to easily upload videos to Vimeo.com"
+    gem.description = "EasyVimeo is an object wrapper around the Ruby Vimeo API to easily upload videos to Vimeo.com"
+    gem.email = "slainer68@gmail.com"
+    gem.homepage = "http://github.com/slainer68/easy-vimeo"
+    gem.authors = ["slainer68"]
+    
+    if gem.respond_to? :specification_version then
+      current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+      gem.specification_version = 3
+
+      if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+        gem.add_runtime_dependency(%q<vimeo>, [">= 1.0.0"])
+        gem.add_runtime_dependency(%q<httpclient>, [">= 2.1.5"])
+      else
+        gem.add_dependency(%q<vimeo>, [">= 1.0.0"])
+        gem.add_dependency(%q<httpclient>, [">= 2.1.5"])
+      end
+    else
+      gem.add_dependency(%q<vimeo>, [">= 1.0.0"])
+      gem.add_dependency(%q<httpclient>, [">= 2.1.5"])
+    end
+    
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "easy-vimeo #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/easy-vimeo.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{easy-vimeo}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["slainer68"]
+  s.date = %q{2009-12-08}
+  s.description = %q{EasyVimeo is an object wrapper around the Ruby Vimeo API to easily upload videos to Vimeo.com}
+  s.email = %q{slainer68@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "easy-vimeo.gemspec",
+     "lib/easy-vimeo.rb",
+     "spec/easy-vimeo_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/slainer68/easy-vimeo}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{EasyVimeo is an object wrapper around the Ruby Vimeo API to easily upload videos to Vimeo.com}
+  s.test_files = [
+    "spec/easy-vimeo_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<vimeo>, [">= 1.0.0"])
+      s.add_runtime_dependency(%q<httpclient>, [">= 2.1.5"])
+    else
+      s.add_dependency(%q<vimeo>, [">= 1.0.0"])
+      s.add_dependency(%q<httpclient>, [">= 2.1.5"])
+    end
+  else
+    s.add_dependency(%q<vimeo>, [">= 1.0.0"])
+    s.add_dependency(%q<httpclient>, [">= 2.1.5"])
+  end
+end

data/lib/easy-vimeo.rb

@@ -0,0 +1,141 @@
+require "vimeo"
+
+module Vimeo
+  class Easy
+    
+    UPLOAD_URL = "http://vimeo.com/services/upload"
+    PRIVACY_MODES = [:anybody, :contacts, :nobody, :users]
+    
+    private
+    attr_writer :thumbnail
+    
+    public
+    attr_accessor :vimeo_upload, :api_key, :auth_token, :vimeo_video, :video_id, :description, :title, :file
+    attr_reader :privacy, :thumbnail, :tags
+    
+    # This method initializes a new instance.
+    # You should pass an options Hash containing :
+    # :api_key # The API key of your account
+    # :secret_key # The secret key
+    # :auth_token # (optional) The authorization token, needed to upload a video
+    # :video_id # (optional) The ID of the video, if it is already uploaded
+    #
+    def initialize(options = {})
+      raise "You must pass :api_key and :secret_key at least to initialize the class." unless options[:api_key] && options[:secret_key]
+      self.api_key = options[:api_key]
+      self.auth_token = options[:auth_token]
+      self.video_id = options[:video_id]
+      self.vimeo_upload = Vimeo::Advanced::Upload.new(self.api_key, options[:secret_key])
+      self.vimeo_video = Vimeo::Advanced::Video.new(self.api_key, options[:secret_key])
+      self.privacy = :anybody
+      @new_record = true
+      
+      if self.video_id
+        self.reload
+      end
+    end
+    
+    def self.find(video_id, options = {})
+      self.new(options.merge(:video_id => video_id))
+    end
+    
+    def new_record?
+      @new_record
+    end
+    
+    def tags=(tags)
+      return tags if self.tags && tags.split(',').map(&:strip).sort == self.tags.split(',').map(&:strip).sort # Do not change attributes if the tags are the same
+      @tags = @new_tags = tags
+    end
+    
+    def privacy=(mode)
+      raise "Privacy mode not allowed, should be one of : #{PRIVACY_MODES.join(', ')}." unless PRIVACY_MODES.include?(mode)
+      @privacy = mode
+    end
+    
+    # This method destroys the Vimeo Video
+    #
+    def destroy
+      check_presence_of :video_id, :auth_token
+      
+      self.vimeo_video.delete(self.auth_token, self.video_id)
+      true
+    rescue
+      false
+    end
+    
+    def available?
+      !!@availability
+    end
+    
+    def reload
+      check_presence_of :video_id
+
+      begin
+        video_response = self.vimeo_video.get_info(self.video_id)['video'][0]
+        self.title = video_response['title']
+        self.description = video_response['description']
+        self.privacy = video_response['privacy'].to_sym
+        self.thumbnail = (video_response['thumbnails']['thumbnail'].first rescue nil)
+        @tags = (video_response['tags']['tag'].join(', ') rescue nil)
+        @availability = video_response['is_transcoding'].to_i.zero? && video_response['is_uploading'].to_i.zero?
+        @new_record = false
+
+        true
+      rescue
+        false
+      end
+    end
+    
+    def save
+      if self.file
+        raise "Cannot upload a video file on an existing video! Create a new instance instead." unless new_record?
+        post_video!
+      end
+      check_presence_of :video_id, :auth_token
+      
+      begin
+        self.vimeo_video.set_privacy(self.auth_token, self.video_id, self.privacy.to_s)
+        self.vimeo_video.set_description(self.auth_token, self.video_id, self.description) if self.description
+        self.vimeo_video.set_title(self.auth_token, self.video_id, self.title) if self.title
+        if @new_tags
+          self.vimeo_video.clear_tags(self.auth_token, self.video_id)
+          self.vimeo_video.add_tags(self.auth_token, self.video_id, self.tags)
+          @new_tags = nil
+        end
+      rescue
+        return false
+      end
+      
+      @new_record = false
+      @file = nil
+      true
+    end
+    
+    private
+    def check_presence_of(*attributes)
+      raise "You must set #{attributes.join(' and ')} to use this method." unless attributes.all? { |a| self.send(a) != nil }
+    end
+    
+    # This method post a new video
+    # The parameter is the video filename
+    # After uploading, the video_id is set to the id of the new uploaded video
+    #
+    def post_video!
+      raise "You must set auth_token to use this method." unless self.auth_token
+      raise "File does not exist (#{self.file})." unless File.exists?(self.file)
+      
+      ticket = self.vimeo_upload.get_ticket(self.auth_token)["ticket"]
+      ticket_id = ticket["id"]
+      
+      end_point = ticket["endpoint"]
+      json_manifest = self.vimeo_upload.upload(self.auth_token, self.file, ticket_id, end_point)
+            
+      request_confirm = self.vimeo_upload.confirm(self.auth_token, ticket_id, json_manifest)
+            
+      self.video_id = request_confirm["ticket"]["video_id"]
+    rescue # FIXME : that's bad to rescue all exceptions, but for now, throw false.
+      false
+    end
+  end
+end

data/spec/easy-vimeo_spec.rb

@@ -0,0 +1,114 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+VIDEO_RESPONSE_HASH = { 'video' => [{ 'title' => 'Ma video', 'description' => 'Great description', 'caption' => 'Great caption', 'privacy' => 'nobody', 'thumbnails' => { 'thumbnail' => ['http://first_thumb.jpg'] }, 'tags' => { 'tag' => ['cool', 'great'] }, 'is_transcoding' => '0', 'is_uploading' => '0' }] }
+
+describe "EasyVimeo" do
+
+  def video_init(options = {})
+    @api_key = "pipo"
+    @secret_key = "molo"
+    @video = Vimeo::Easy.new :api_key => @api_key, :secret_key => @secret_key, :auth_token => options[:auth_token]
+  end
+  
+  def video_load
+    @video.vimeo_video.should_receive(:get_info).and_return(VIDEO_RESPONSE_HASH)
+    @video.video_id = 9999999
+    @video.reload
+  end
+
+  it "should not initialize without secret_key & api_key" do
+    lambda { Vimeo::Easy.new }.should raise_error
+  end
+  
+  it "should initialize with secret_key & api_key and set default attributes" do
+    video_init
+    
+    @video.api_key.should == @api_key
+    @video.privacy.should == :anybody
+    
+    @video.vimeo_upload.should be_a(Vimeo::Advanced::Upload)
+    @video.vimeo_video.should be_a(Vimeo::Advanced::Video)
+    
+    @video.should be_new_record
+  end
+  
+  it "should not accept bad privacy type" do
+    video_init
+    
+    lambda { @video.privacy = :pipo }.should raise_error
+  end
+  
+  it "should not reload the video without video_id" do
+    video_init
+    
+    lambda { @video.reload }.should raise_error
+  end
+  
+  it "should reload the video with video_id" do
+    video_init
+    video_load
+    
+    @video.title.should == 'Ma video'
+    @video.description.should == 'Great description'
+    @video.privacy.should == :nobody
+    @video.tags.should == 'cool, great'
+    @video.thumbnail.should == 'http://first_thumb.jpg'
+    
+    @video.should be_available
+    @video.should_not be_new_record
+  end
+  
+  it "should not be able to save with a file if video is already uploaded" do
+    video_init(:auth_token => "pipo")
+    video_load
+    
+    @video.file = '/tmp/pipo'
+    lambda { @video.save }.should raise_error
+  end
+  
+  it 'should not be able to save a video without auth_token or video_id' do
+    video_init
+    video_load
+    
+    lambda { @video.save }.should raise_error
+    
+    video_init(:auth_token => "pipo")
+    lambda { @video.save }.should raise_error
+  end
+  
+  it 'should be able to save a video' do
+    video_init(:auth_token => "pipo")
+    video_load
+    
+    @video.vimeo_video.should_receive(:set_privacy).and_return(true)
+    @video.vimeo_video.should_receive(:set_description).and_return(true)
+    @video.vimeo_video.should_receive(:set_title).and_return(true)
+    
+    @video.save.should == true
+  end
+  
+  it 'should be able to save a video with a file' do
+    video_init(:auth_token => "pipo")
+    
+    @video.file = '/tmp/pipo'
+    
+    File.should_receive(:exists?).with('/tmp/pipo').and_return(true)
+    @video.vimeo_upload.should_receive(:get_ticket).and_return({ "ticket" => { "id" => "123456", "endpoint" => "654321" } })
+    @video.vimeo_upload.should_receive(:upload).with("pipo", "/tmp/pipo", "123456", "654321").and_return("MD5")
+    
+    @video.vimeo_upload.should_receive(:confirm).with("pipo", "123456", "MD5").and_return({ "ticket" => { "video_id" => "99999" } })
+    
+    @video.vimeo_video.should_receive(:set_privacy).and_return(true)
+    @video.vimeo_video.should_not_receive(:set_description)
+    @video.vimeo_video.should_not_receive(:set_title)
+    
+    @video.save.should == true
+    @video.video_id.should == "99999"
+    @video.should_not be_new_record
+  end
+  
+  it 'should be able to find a video with a Vimeo ID' do
+    Vimeo::Easy.should_receive(:new).with(:toto => "pipo", :video_id => 123456).and_return(true)
+    Vimeo::Easy.find(123456, :toto => "pipo")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require "rubygems"
+require 'easy-vimeo'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: easy-vimeo
+version: !ruby/object:Gem::Version 
+  version: 0.3.0
+platform: ruby
+authors: 
+- slainer68
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-08 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: vimeo
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: httpclient
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.5
+    version: 
+description: EasyVimeo is an object wrapper around the Ruby Vimeo API to easily upload videos to Vimeo.com
+email: slainer68@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- easy-vimeo.gemspec
+- lib/easy-vimeo.rb
+- spec/easy-vimeo_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/slainer68/easy-vimeo
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: EasyVimeo is an object wrapper around the Ruby Vimeo API to easily upload videos to Vimeo.com
+test_files: 
+- spec/easy-vimeo_spec.rb
+- spec/spec_helper.rb