viddler-ruby 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,9 @@
+source :gemcutter
+
+# Specify your gem's dependencies in viddler-ruby.gemspec
+gemspec
+
+group :test do
+  gem "rspec"
+  gem "ZenTest"
+end

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    viddler-ruby (0.0.1)
+      activesupport (> 2.3.0)
+      json
+      rest-client
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.4.0)
+    activesupport (2.3.10)
+    diff-lcs (1.1.2)
+    json (1.4.6)
+    mime-types (1.16)
+    rest-client (1.6.1)
+      mime-types (>= 1.16)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ZenTest
+  activesupport (> 2.3.0)
+  bundler (>= 1.0.0)
+  json
+  rest-client
+  rspec
+  viddler-ruby!

data/README.md

@@ -0,0 +1,27 @@
+viddler-ruby
+============
+
+viddler-ruby provides a simple interface to [Viddler](http://viddler.com)'s API.  To use, just instantiate an instance of Viddler::Client and call the `#get` and `#post` methods. For example, to get the details of a video:
+
+    viddler = Viddler::Client.new('your api key')
+    video = viddler.get 'viddler.videos.getDetails', :video_id => 'abc123'
+    
+    puts video['title'] # => "My video"
+    puts video['id']    # => "abc123"
+    
+For an authenticated client, just pass a username and password:
+
+    viddler = Viddler::Client.new('your api key', 'username', 'password')
+    
+Then, any calls made on `viddler` will be done using the correct session id.
+
+Uploading
+---------
+
+To upload a file, use the upload method:
+
+    viddler.upload(File.open('./myvideo.mov'), {
+      :title       => 'My video',
+      :description => 'This video is awesome!',
+      :tags        => 'awesome'
+    })

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/lib/viddler-ruby.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'rest-client'
+require 'json'
+require 'active_support'
+
+require 'viddler/client'

data/lib/viddler/client.rb

@@ -0,0 +1,132 @@
+module Viddler
+  # Base class for accessing the Viddler API.
+  #
+  # For more information about the Viddler API, check out the documentation:
+  # http://developers.viddler.com/documentation/api-v2/
+  #
+  # Examples
+  # 
+  #  # Initialize a client with just an API key
+  #  viddler = Viddler::Client.new 'your api key'
+  #  
+  class Client
+    DEFAULT_ENDPOINT = 'http://api.viddler.com/api/v2/'
+    
+    attr_accessor :api_key, :sessionid
+    
+    # Sets the API key and sessionid if needed for the given arguments
+    # 
+    # api_key  - The String API Key from Viddler
+    #
+    # Examples
+    #
+    #  # Initialize a client with just an API key
+    #  viddler = Viddler::Client.new 'your api key'
+    #
+    # Returns an instance of Viddler::Client
+    def initialize(api_key)
+      self.api_key = api_key
+    end
+    
+    # Public: Simple method to determine if this is an authenticated client
+    #
+    # Examples
+    #
+    #   viddler = Viddler::Client.new 'abc123'
+    #   viddler.authenticated?
+    #   # => false
+    #
+    #   viddler = Viddler::Client.new 'abc123'
+    #   viddler.authenticate! 'user', 'pass'
+    #   viddler.authenticated?
+    #   # => true
+    #
+    # Returns Boolean
+    def authenticated?
+      !sessionid.nil?
+    end
+    
+    # Public: Authenticate the client using a username and password. Any
+    #   subsequent calls will be made using the session.
+    #
+    # username - The String Viddler username
+    # password - The String Viddler password
+    #
+    # Examples
+    #
+    #   viddler.authenticate! 'username', 'password'
+    #
+    # Returns a String sessionid
+    def authenticate!(username, password)
+      auth = get 'viddler.users.auth', :user => username, :password => password
+      self.sessionid = auth['auth']['sessionid']
+    end
+
+    # Public: Make a GET call to the Viddler API.
+    #
+    # method    - The String API method you'd like to call.
+    # arguments - The Hash of arguments to the API method (default: {}).
+    #
+    # Examples
+    #
+    #   viddler.get 'viddler.videos.getDetails', :video_id => 'abc123'
+    #
+    # Returns a Hash containing the API response.
+    # Raises ApiException if an error is returned from the API.
+    def get(method, arguments={})
+      arguments[:api_key]   = api_key
+      arguments[:sessionid] = sessionid if authenticated?
+      JSON.parse RestClient.get(DEFAULT_ENDPOINT + method + '.json', :params => arguments)
+    end
+    
+    # Public: Make a POST call to the Viddler API.
+    #
+    # method    - The String API method you'd like to call.
+    # arguments - The Hash of arguments to the API method (default: {}).
+    #
+    # Examples
+    #
+    #   viddler.post 'viddler.videos.setDetails', :video_id => 'abc123',
+    #                                             :title    => 'new title'
+    #
+    # Returns a Hash containing the API response.
+    # Raises ApiException if an error is returned from the API.
+    def post(method, arguments={})
+      arguments[:api_key]   = api_key
+      arguments[:sessionid] = sessionid if authenticated?
+      JSON.parse RestClient.post(DEFAULT_ENDPOINT + method + '.json', :params => arguments)
+    end
+    
+    # Public: 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.
+    # Raises ApiException if an error is returned from the API
+    def upload(file, arguments)
+      # Need to use OrderedHash, because the API needs the file argument last
+      ordered_arguments = ActiveSupport::OrderedHash.new
+      
+      arguments.each {|k,v| ordered_arguments[k] = v}
+      
+      ordered_arguments[:api_key]   = api_key
+      ordered_arguments[:sessionid] = sessionid
+      ordered_arguments[:file]      = file
+      
+      JSON.parse RestClient.post(DEFAULT_ENDPOINT + 'viddler.videos.upload.json', ordered_arguments)
+    end
+  end
+end

data/lib/viddler/version.rb

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

data/spec/client_spec.rb

@@ -0,0 +1,149 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Viddler::Client, ".new" do
+  it "sets API key" do
+    Viddler::Client.new('abc123').api_key.should == 'abc123'
+  end
+end
+
+describe Viddler::Client, "#authenticate!" do
+  before(:each) do
+    @client = Viddler::Client.new('abc123')
+    @client.stub!(:get).and_return({
+      'auth' => {
+        'sessionid' => 'mysess'
+      }
+    })
+  end
+  
+  it "calls GET viddler.users.auth with username and password" do
+    @client.should_receive(:get).with('viddler.users.auth', :password => 'pass', :user => 'user')
+    @client.authenticate! 'user', 'pass'
+  end
+  
+  it "sets sessionid" do
+    @client.authenticate! 'user', 'pass'
+    @client.sessionid.should == 'mysess'
+  end
+  
+  it "returns sessionid" do
+    @client.authenticate!('user', 'pass').should == 'mysess'
+  end
+end
+
+describe Viddler::Client, "#authenticated?" do
+  before(:each) do
+    @client = Viddler::Client.new('abc123')
+  end
+  
+  it "returns true if a sessionid is set" do
+    @client.sessionid = 'mysess'
+    @client.should be_authenticated
+  end
+  
+  it "returns false if a sessionid is not set" do
+    @client.should_not be_authenticated
+  end
+end
+
+describe Viddler::Client, "#get" do
+  before(:each) do
+    @client = Viddler::Client.new('abc123')
+    RestClient.stub!(:get).and_return('{"response":["hello", "howdy"]}')
+  end
+  
+  it "calls RestClient.get with proper params" do
+    RestClient.should_receive(:get).with('http://api.viddler.com/api/v2/viddler.api.getInfo.json', :params => hash_including(:param1 => 'asdf', :param2 => true))
+    @client.get('viddler.api.getInfo', :param1 => 'asdf', :param2 => true)
+  end
+  
+  it "returns result of JSON.parse(response)" do
+    JSON.stub!(:parse).and_return('abc')
+    @client.get('method').should == 'abc'
+  end
+  
+  it "includes API key" do
+    RestClient.should_receive(:get).with(anything, :params => hash_including(:api_key => 'abc123'))
+    @client.get('viddler.api.getInfo')
+  end
+  
+  it "raises ApiException if an error occurs"
+  
+  context "with authenticated client" do
+    before(:each) do
+      @client.sessionid = "mysess"
+    end
+    
+    it "calls RestClient.get with sessionid" do
+      RestClient.should_receive('get').with(anything, :params => hash_including(:sessionid => 'mysess'))
+      @client.get('viddler.api.getInfo', :something => 'yes')
+    end
+  end
+end
+
+describe Viddler::Client, "#post" do
+  before(:each) do
+    @client = Viddler::Client.new('abc123')
+    RestClient.stub!(:post).and_return('{"response":["hello","howdy"]}')
+  end
+  
+  it "calls RestClient.post with proper params" do
+    RestClient.should_receive(:post).with('http://api.viddler.com/api/v2/viddler.api.getInfo.json', :params => hash_including(:param1 => 'asdf', :param2 => true))
+    @client.post('viddler.api.getInfo', :param1 => 'asdf', :param2 => true)
+  end
+  
+  it "returns result of JSON.parse(response)" do
+    JSON.stub!(:parse).and_return('abc')
+    @client.post('method').should == 'abc'
+  end
+  
+  it "includes API key" do
+    RestClient.should_receive(:post).with(anything, :params => hash_including(:api_key => 'abc123'))
+    @client.post('viddler.api.getInfo')
+  end
+  
+  it "raises ApiException if an error occurs"
+  
+  context "with authenticated client" do
+    before(:each) do
+      @client.sessionid = "mysess"
+    end
+    
+    it "calls RestClient.post with sessionid" do
+      RestClient.should_receive('post').with(anything, :params => hash_including(:sessionid => 'mysess'))
+      @client.post('viddler.api.getInfo', :something => 'yes')
+    end
+  end
+end
+
+describe Viddler::Client, "#upload" do
+  before(:each) do
+    @client = Viddler::Client.new('abc123')
+    @file   = mock(File)
+    
+    @client.sessionid = 'mysess'
+    RestClient.stub!(:post).and_return('{"response":["hello","howdy"]}')
+  end
+  
+  it "calls RestClient.post with params and file" do
+    RestClient.should_receive(:post).with('http://api.viddler.com/api/v2/viddler.videos.upload.json', hash_including(:param1 => 'asdf', :param2 => true, :file => @file))
+    @client.upload @file, :param1 => 'asdf', :param2 => true
+  end
+  
+  it "includes sessionid" do
+    RestClient.should_receive(:post).with(anything, hash_including(:sessionid => 'mysess'))
+    @client.upload @file, :param1 => 'asdf', :param2 => true
+  end
+  
+  it "includes API key" do
+    RestClient.should_receive(:post).with(anything, hash_including(:api_key => 'abc123'))
+    @client.upload @file, :param1 => 'asdf', :param2 => true
+  end
+  
+  it "returns result of JSON.parse" do
+    JSON.stub!(:parse).and_return('asdfasdf')
+    @client.upload(@file, :param1 => 'asdf').should == 'asdfasdf'
+  end
+  
+  it "raises an ApiException on API error"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'rspec'
+require 'rspec/autorun'
+
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+require 'viddler'

data/viddler-ruby.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/viddler/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "viddler-ruby"
+  s.version     = Viddler::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Kyle Slattery"]
+  s.email       = ["kyle@viddler.com"]
+  s.homepage    = "http://github.com/viddler/viddler-ruby"
+  s.summary     = "An API wrapper for Viddler's v2 API"
+  s.description = "An API wrapper for Viddler's v2 API"
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "viddler-ruby"
+
+  s.add_dependency "rest-client"
+  s.add_dependency "json"
+  s.add_dependency "activesupport", "> 2.3.0"
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification 
+name: viddler-ruby
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Kyle Slattery
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-13 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id004
+description: An API wrapper for Viddler's v2 API
+email: 
+- kyle@viddler.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- autotest/discover.rb
+- lib/viddler-ruby.rb
+- lib/viddler/client.rb
+- lib/viddler/version.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb
+- viddler-ruby.gemspec
+has_rdoc: true
+homepage: http://github.com/viddler/viddler-ruby
+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: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: viddler-ruby
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: An API wrapper for Viddler's v2 API
+test_files: []
+