brightcove-api 1.0.11 → 1.0.12

data/.gitignore

@@ -0,0 +1,11 @@
+.DS_Store
+*.tmproj
+tmtags
+*~
+\#*
+.\#*
+*.swp
+coverage
+rdoc
+pkg
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format doc

data/.rvmrc

@@ -1,2 +1,3 @@
-rvm --create 1.8.7@brightcove-api_gem
-rvm --create 1.9.2@brightcove-api_gem
+rvm use --create 1.8.7@brightcove-api_gem
+rvm use --create 1.9.2@brightcove-api_gem
+rvm use --create 1.9.3@brightcove-api_gem

data/{CHANELOG.markdown → CHANGELOG.markdown}

@@ -1,3 +1,7 @@
+# 1.0.12 (2012-06-12)
+
+* Allow post streaming when you have an file handle instead of a filename. Thanks @keysolutions
+
 # 1.0.11 (2011-09-13)
 
  * Only set `timeout` and `open_timeout` in `post_file(...)` and `post_file_streaming(...)` if they are set

data/Gemfile

@@ -1,18 +1,3 @@
 source :rubygems
 
-group :development do
-  gem 'bundler', '~> 1.0.0'
-  gem 'jeweler', '~> 1.5.1'
-  gem 'rcov', '~> 0.9.9'
-end
-
-group :test do
-	gem 'fakeweb'
-	gem 'mocha'
-end
-
-gem 'httparty'
-gem 'json'
-gem 'rest-client'
-gem 'multipart-post'
-gem 'orderedhash'
+gemspec

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2011 David Czarnecki
+Copyright (c) 2010-2012 David Czarnecki
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,10 +1,8 @@
-brightcove-api
-==============
+# brightcove-api
 
 Ruby gem for interacting with the Brightcove media API. http://docs.brightcove.com/en/media/
 
-Requirements
-============
+## Requirements
 
 * HTTParty
 
@@ -13,41 +11,54 @@ Requirements
 * multipart-post (for the `post_file_streaming(...) method`)
 * orderedhash (only if you're using Ruby 1.8.7)
 
-Install
-=======
+## Install
 
-* sudo gem install brightcove-api
+```
+gem install brightcove-api
+```
 
-Examples
-========
+## Examples
 
-    >> require 'brightcove-api'
-    => true
-    >> brightcove = Brightcove::API.new('0Z2dtxTdJAxtbZ-d0U7Bhio2V1Rhr5Iafl5FFtDPY8E.')
-    => #<Brightcove::API:0x114dbc8 @token="0Z2dtxTdJAxtbZ-d0U7Bhio2V1Rhr5Iafl5FFtDPY8E.", @api_url="http://api.brightcove.com/services/library">
-    >> response = brightcove.get('find_all_videos', {:page_size => 3, :video_fields => 'id,name,linkURL,linkText'})
-    => {"items"=>[{"name"=>"Documentarian Skydiving", "id"=>496518762, "linkText"=>nil, "linkURL"=>nil}, {"name"=>"Surface Tricks", "id"=>496518763, "linkText"=>nil, "linkURL"=>nil}, {"name"=>"Free Skiing", "id"=>496518765, "linkText"=>nil, "linkURL"=>nil}], "page_number"=>0, "page_size"=>3, "total_count"=>-1}
-    >> response = brightcove.get('find_all_videos', {:page_size => 5, :sort_by => 'PLAYS_TOTAL'})
-    => {"items"=>[{"longDescription"=>nil, "name"=>"Wild Slopes '06", "lastModifiedDate"=>"1171324523307", "thumbnailURL"=>"http://brightcove.vo.llnwd.net/d2/unsecured/media/270881183/270881183_502534829_94499905676eb7cd04a558da2adcf6a34f437b88.jpg?pubId=270881183", "tags"=>["adventure", "snowboarding"], "playsTrailingWeek"=>35, "shortDescription"=>"A ski and snowboard movie that challenges the hype and dares you to see what freeskiing and snowboarding have become. Documenting the very best of this year's riding and culture.", "playsTotal"=>4458, "adKeys"=>nil, "id"=>496518766, "length"=>51251, "videoStillURL"=>"http://brightcove.vo.llnwd.net/d2/unsecured/media/270881183/270881183_502534838_f80fe64f052328cd3b2e158d7234003a23091845.jpg?pubId=270881183", "publishedDate"=>"1171324434811", "creationDate"=>"1171267200000", "linkText"=>nil, "economics"=>"FREE", "referenceId"=>"title010", "linkURL"=>nil}, {"longDescription"=>nil, "name"=>"Jellyfish", "lastModifiedDate"=>"1245181300374", "thumbnailURL"=>"http://brightcove.vo.llnwd.net/d7/unsecured/media/270881183/270881183_26530711001_jellyFish.jpg?pubId=270881183", "tags"=>["sea", "custom skins"], "playsTrailingWeek"=>46, "shortDescription"=>"Jellyfish", "playsTotal"=>4081, "adKeys"=>nil, "id"=>26512561001, "length"=>28400, "videoStillURL"=>"http://brightcove.vo.llnwd.net/d7/unsecured/media/270881183/270881183_26519430001_vs-270881183-vid26513829001-img0000.jpg?pubId=270881183", "publishedDate"=>"1245172164326", "creationDate"=>"1245172164326", "linkText"=>nil, "economics"=>"AD_SUPPORTED", "referenceId"=>nil, "linkURL"=>nil}, {"longDescription"=>"Long Description", "name"=>"Demo Title 2", "lastModifiedDate"=>"1263581295791", "thumbnailURL"=>"http://brightcove.vo.llnwd.net/d2/unsecured/media/270881183/270881183_275925069_d1f97c7f07f2a3f4de7b38eda3761f16f39d2a99.jpg?pubId=270881183", "tags"=>[], "playsTrailingWeek"=>1, "shortDescription"=>"Short Description", "playsTotal"=>3876, "adKeys"=>nil, "id"=>276024035, "length"=>418742, "videoStillURL"=>"http://brightcove.vo.llnwd.net/d2/unsecured/media/270881183/270881183_275943599_b7e2ca63c0311fa3f0b027304b41d252f12d2d66.jpg?pubId=270881183", "publishedDate"=>"1161296014264", "creationDate"=>"1161241200000", "linkText"=>"Related Link", "economics"=>"FREE", "referenceId"=>nil, "linkURL"=>"http://www.brightcove.com"}, {"longDescription"=>nil, "name"=>"Dolphins", "lastModifiedDate"=>"1263581295790", "thumbnailURL"=>"http://brightcove.vo.llnwd.net/d7/unsecured/media/270881183/270881183_26531197001_dolphins.jpg?pubId=270881183", "tags"=>["sea", "custom skins"], "playsTrailingWeek"=>30, "shortDescription"=>"Dolphins", "playsTotal"=>3870, "adKeys"=>nil, "id"=>26511963001, "length"=>12800, "videoStillURL"=>"http://brightcove.vo.llnwd.net/d7/unsecured/media/270881183/270881183_26519372001_vs-270881183-vid26510372001-img0000.jpg?pubId=270881183", "publishedDate"=>"1245171732987", "creationDate"=>"1245171732987", "linkText"=>nil, "economics"=>"AD_SUPPORTED", "referenceId"=>nil, "linkURL"=>nil}, {"longDescription"=>nil, "name"=>"Welcome to Brightcove 3", "lastModifiedDate"=>"1225134261511", "thumbnailURL"=>"http://brightcove.vo.llnwd.net/d6/unsecured/media/270881183/270881183_1858983740_brightcove3-thumb.jpg?pubId=270881183", "tags"=>[], "playsTrailingWeek"=>0, "shortDescription"=>"Tareef Kawaf, Brightcove's SVP of Engineering, welcomes you to Brightcove 3.", "playsTotal"=>3349, "adKeys"=>nil, "id"=>1858922805, "length"=>53820, "videoStillURL"=>"http://brightcove.vo.llnwd.net/d6/unsecured/media/270881183/270881183_1858994782_vid-StudioDashboards.jpg?pubId=270881183", "publishedDate"=>"1225134261508", "creationDate"=>"1224096089173", "linkText"=>nil, "economics"=>"AD_SUPPORTED", "referenceId"=>nil, "linkURL"=>nil}], "page_number"=>0, "page_size"=>5, "total_count"=>-1}
-    >> response = brightcove.post('delete_video', {:video_id => '595153263001'})
-  	=> {"result"=>{}, "id"=>nil, "error"=>nil}
+```ruby
+require 'brightcove-api'
+=> true
+
+brightcove = Brightcove::API.new('0Z2dtxTdJAxtbZ-d0U7Bhio2V1Rhr5Iafl5FFtDPY8E.')
+=> #<Brightcove::API:0x114dbc8 @token="0Z2dtxTdJAxtbZ-d0U7Bhio2V1Rhr5Iafl5FFtDPY8E.", @api_url="http://api.brightcove.com/services/library">
+
+response = brightcove.get('find_all_videos', {:page_size => 3, :video_fields => 'id,name,linkURL,linkText'})
+=> {"items"=>[{"name"=>"Documentarian Skydiving", "id"=>496518762, "linkText"=>nil, "linkURL"=>nil}, {"name"=>"Surface Tricks", "id"=>496518763, "linkText"=>nil, "linkURL"=>nil}, {"name"=>"Free Skiing", "id"=>496518765, "linkText"=>nil, "linkURL"=>nil}], "page_number"=>0, "page_size"=>3, "total_count"=>-1}
+
+response = brightcove.get('find_all_videos', {:page_size => 5, :sort_by => 'PLAYS_TOTAL'})
+=> {"items"=>[{"longDescription"=>nil, "name"=>"Wild Slopes '06", "lastModifiedDate"=>"1171324523307", "thumbnailURL"=>"http://brightcove.vo.llnwd.net/d2/unsecured/media/270881183/270881183_502534829_94499905676eb7cd04a558da2adcf6a34f437b88.jpg?pubId=270881183", "tags"=>["adventure", "snowboarding"], "playsTrailingWeek"=>35, "shortDescription"=>"A ski and snowboard movie that challenges the hype and dares you to see what freeskiing and snowboarding have become. Documenting the very best of this year's riding and culture.", "playsTotal"=>4458, "adKeys"=>nil, "id"=>496518766, "length"=>51251, "videoStillURL"=>"http://brightcove.vo.llnwd.net/d2/unsecured/media/270881183/270881183_502534838_f80fe64f052328cd3b2e158d7234003a23091845.jpg?pubId=270881183", "publishedDate"=>"1171324434811", "creationDate"=>"1171267200000", "linkText"=>nil, "economics"=>"FREE", "referenceId"=>"title010", "linkURL"=>nil}, {"longDescription"=>nil, "name"=>"Jellyfish", "lastModifiedDate"=>"1245181300374", "thumbnailURL"=>"http://brightcove.vo.llnwd.net/d7/unsecured/media/270881183/270881183_26530711001_jellyFish.jpg?pubId=270881183", "tags"=>["sea", "custom skins"], "playsTrailingWeek"=>46, "shortDescription"=>"Jellyfish", "playsTotal"=>4081, "adKeys"=>nil, "id"=>26512561001, "length"=>28400, "videoStillURL"=>"http://brightcove.vo.llnwd.net/d7/unsecured/media/270881183/270881183_26519430001_vs-270881183-vid26513829001-img0000.jpg?pubId=270881183", "publishedDate"=>"1245172164326", "creationDate"=>"1245172164326", "linkText"=>nil, "economics"=>"AD_SUPPORTED", "referenceId"=>nil, "linkURL"=>nil}, {"longDescription"=>"Long Description", "name"=>"Demo Title 2", "lastModifiedDate"=>"1263581295791", "thumbnailURL"=>"http://brightcove.vo.llnwd.net/d2/unsecured/media/270881183/270881183_275925069_d1f97c7f07f2a3f4de7b38eda3761f16f39d2a99.jpg?pubId=270881183", "tags"=>[], "playsTrailingWeek"=>1, "shortDescription"=>"Short Description", "playsTotal"=>3876, "adKeys"=>nil, "id"=>276024035, "length"=>418742, "videoStillURL"=>"http://brightcove.vo.llnwd.net/d2/unsecured/media/270881183/270881183_275943599_b7e2ca63c0311fa3f0b027304b41d252f12d2d66.jpg?pubId=270881183", "publishedDate"=>"1161296014264", "creationDate"=>"1161241200000", "linkText"=>"Related Link", "economics"=>"FREE", "referenceId"=>nil, "linkURL"=>"http://www.brightcove.com"}, {"longDescription"=>nil, "name"=>"Dolphins", "lastModifiedDate"=>"1263581295790", "thumbnailURL"=>"http://brightcove.vo.llnwd.net/d7/unsecured/media/270881183/270881183_26531197001_dolphins.jpg?pubId=270881183", "tags"=>["sea", "custom skins"], "playsTrailingWeek"=>30, "shortDescription"=>"Dolphins", "playsTotal"=>3870, "adKeys"=>nil, "id"=>26511963001, "length"=>12800, "videoStillURL"=>"http://brightcove.vo.llnwd.net/d7/unsecured/media/270881183/270881183_26519372001_vs-270881183-vid26510372001-img0000.jpg?pubId=270881183", "publishedDate"=>"1245171732987", "creationDate"=>"1245171732987", "linkText"=>nil, "economics"=>"AD_SUPPORTED", "referenceId"=>nil, "linkURL"=>nil}, {"longDescription"=>nil, "name"=>"Welcome to Brightcove 3", "lastModifiedDate"=>"1225134261511", "thumbnailURL"=>"http://brightcove.vo.llnwd.net/d6/unsecured/media/270881183/270881183_1858983740_brightcove3-thumb.jpg?pubId=270881183", "tags"=>[], "playsTrailingWeek"=>0, "shortDescription"=>"Tareef Kawaf, Brightcove's SVP of Engineering, welcomes you to Brightcove 3.", "playsTotal"=>3349, "adKeys"=>nil, "id"=>1858922805, "length"=>53820, "videoStillURL"=>"http://brightcove.vo.llnwd.net/d6/unsecured/media/270881183/270881183_1858994782_vid-StudioDashboards.jpg?pubId=270881183", "publishedDate"=>"1225134261508", "creationDate"=>"1224096089173", "linkText"=>nil, "economics"=>"AD_SUPPORTED", "referenceId"=>nil, "linkURL"=>nil}], "page_number"=>0, "page_size"=>5, "total_count"=>-1}
+
+response = brightcove.post('delete_video', {:video_id => '595153263001'})
+=> {"result"=>{}, "id"=>nil, "error"=>nil}
+```
 
 If you want to perform a file upload, for example, to create a video, you can use the __post_file()__ method.
 
-    >> response = brightcove.post_file('create_video', '/path/to/video.mov', :video => {:shortDescription => 'Short Description', :name => 'Video name'})
-    => {"result"=>653155417001, "error=>nil, "id"=>nil}
+```ruby
+response = brightcove.post_file('create_video', '/path/to/video.mov', :video => {:shortDescription => 'Short Description', :name => 'Video name'})
+=> {"result"=>653155417001, "error=>nil, "id"=>nil}
+```
 
 If you want to perform a file upload using HTTP streaming, for example, to create a video, you can use the __post_file_streaming()__ method.
 
-    >> response = brightcove.post_file_streaming('create_video', '/path/to/video.mov', 'video/quicktime', :video => {:shortDescription => 'Short Description', :name => 'Video name'})
-    => {"result"=>653155417001, "error=>nil, "id"=>nil}
+```ruby
+response = brightcove.post_file_streaming('create_video', '/path/to/video.mov', 'video/quicktime', :video => {:shortDescription => 'Short Description', :name => 'Video name'})
+=> {"result"=>653155417001, "error=>nil, "id"=>nil}
+```
+
+You can also use the `post_io_streaming(api_method, file, content_type, parameters)` method which takes an I/O handle instead of a filename.
 
 You can now pass `{:output => 'mrss'}` in the __get(...)__ method to return output in Media RSS format. Example:
 
-    >> response = brightcove.get('find_all_videos', {:output => 'mrss'})
+```ruby
+response = brightcove.get('find_all_videos', {:output => 'mrss'})
+```
 
-Searching
-=========
+## Searching
 
 To replicate one of the brightcove search API examples:
 
@@ -55,14 +66,19 @@ To replicate one of the brightcove search API examples:
 > description, and which also have the tag "free", and also have either the tag "color" or the
 > tag "technicolor"
 
-    >> brightcove = Brightcove::API.new(...)
-    >> response = brightcove.get('search_videos', {
-         :any => [ "tag:color", "tag:technicolor" ],
-         :all => ["football", "chicago", "tag:free"]
-       })
+```ruby
+brightcove = Brightcove::API.new(...)
+response = brightcove.get('search_videos', {
+  :any => [ "tag:color", "tag:technicolor" ],
+  :all => ["football", "chicago", "tag:free"]
+})
+```
+
+## Compatibility
 
-Note on Patches/Pull Requests
-=============================
+The brightcove-api gem is built and tested under Ruby 1.8.7, 1.9.2 and 1.9.3.
+
+## Note on Patches/Pull Requests
 
 * Fork the project.
 * Make your feature addition or bug fix.
@@ -72,6 +88,6 @@ Note on Patches/Pull Requests
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
-Copyright
-=========
-Copyright (c) 2010-2011 David Czarnecki. See LICENSE for details.
+## Copyright
+
+Copyright (c) 2010-2012 David Czarnecki. See LICENSE for details.

data/Rakefile

@@ -1,53 +1,15 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "brightcove-api"
-  gem.homepage = "http://github.com/BrightcoveOS/Ruby-MAPI-Wrapper"
-  gem.license = "MIT"
-  gem.summary = %Q{Ruby gem for interacting with the Brightcove media API}
-  gem.description = %Q{Ruby gem for interacting with the Brightcove media API. http://docs.brightcove.com/en/media/}
-  gem.email = "dczarnecki@agoragames.com"
-  gem.authors = ["David Czarnecki"]
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+require 'bundler/gem_tasks'
+require 'rspec/core'
+require 'rspec/core/rake_task'
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "brightcove-api #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.rspec_opts = ['--backtrace']
+  # spec.ruby_opts = ['-w']
 end
 
-task :default => :test_rubies
+task :default => :spec
 
 task :test_rubies do
-  system "rvm 1.8.7@brightcove-api_gem,1.9.2@brightcove-api_gem rake test"
+  system "rvm 1.8.7@brightcove-api_gem,1.9.2@brightcove-api_gem,1.9.3@brightcove-api_gem do rake spec"
 end

data/brightcove-api.gemspec

@@ -1,80 +1,33 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
 
-Gem::Specification.new do |s|
-  s.name = %q{brightcove-api}
-  s.version = "1.0.11"
+require 'brightcove-api/version'
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{David Czarnecki}]
-  s.date = %q{2011-09-13}
+Gem::Specification.new do |s|
+  s.name        = "brightcove-api"
+  s.version     = Brightcove::API::VERSION.dup
+  s.authors     = ["David Czarnecki"]
+  s.email       = ["dczarnecki@agoragames.com"]
+  s.homepage    = "http://github.com/BrightcoveOS/Ruby-MAPI-Wrapper"
+  s.summary     = %q{Ruby gem for interacting with the Brightcove media API}
   s.description = %q{Ruby gem for interacting with the Brightcove media API. http://docs.brightcove.com/en/media/}
-  s.email = %q{dczarnecki@agoragames.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.md"
-  ]
-  s.files = [
-    ".rvmrc",
-    "CHANELOG.markdown",
-    "Gemfile",
-    "LICENSE",
-    "README.md",
-    "Rakefile",
-    "VERSION",
-    "brightcove-api.gemspec",
-    "lib/brightcove-api.rb",
-    "test/fakeweb/create_video_response.json",
-    "test/fakeweb/delete_video_response.json",
-    "test/fakeweb/find_all_videos_response.json",
-    "test/fakeweb/find_all_videos_response.xml",
-    "test/fakeweb/movie.mov",
-    "test/helper.rb",
-    "test/test_brightcove-api.rb"
-  ]
-  s.homepage = %q{http://github.com/BrightcoveOS/Ruby-MAPI-Wrapper}
-  s.licenses = [%q{MIT}]
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.8}
-  s.summary = %q{Ruby gem for interacting with the Brightcove media API}
-  s.test_files = [
-    "test/helper.rb",
-    "test/test_brightcove-api.rb"
-  ]
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  s.rubyforge_project = "brightcove-api"
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<httparty>, [">= 0"])
-      s.add_runtime_dependency(%q<json>, [">= 0"])
-      s.add_runtime_dependency(%q<rest-client>, [">= 0"])
-      s.add_runtime_dependency(%q<multipart-post>, [">= 0"])
-      s.add_runtime_dependency(%q<orderedhash>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
-      s.add_development_dependency(%q<rcov>, ["~> 0.9.9"])
-    else
-      s.add_dependency(%q<httparty>, [">= 0"])
-      s.add_dependency(%q<json>, [">= 0"])
-      s.add_dependency(%q<rest-client>, [">= 0"])
-      s.add_dependency(%q<multipart-post>, [">= 0"])
-      s.add_dependency(%q<orderedhash>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
-      s.add_dependency(%q<rcov>, ["~> 0.9.9"])
-    end
-  else
-    s.add_dependency(%q<httparty>, [">= 0"])
-    s.add_dependency(%q<json>, [">= 0"])
-    s.add_dependency(%q<rest-client>, [">= 0"])
-    s.add_dependency(%q<multipart-post>, [">= 0"])
-    s.add_dependency(%q<orderedhash>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
-    s.add_dependency(%q<rcov>, ["~> 0.9.9"])
-  end
-end
+  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"]
 
+  s.add_dependency('httparty')
+  s.add_dependency('json')
+  s.add_dependency('rest-client')
+  s.add_dependency('multipart-post')
+  s.add_dependency('orderedhash')
+  
+  s.add_development_dependency('fakeweb')
+  s.add_development_dependency('mocha')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('vcr')
+end

data/lib/brightcove-api.rb

@@ -3,14 +3,13 @@ require 'json'
 require 'rest-client'
 require 'orderedhash'
 require 'net/http/post/multipart'
+require 'brightcove-api/version'
 
 module Brightcove
   class API
     include HTTParty
     disable_rails_query_string_format
 
-    VERSION = '1.0.11'.freeze
-
     DEFAULT_HEADERS = {
       'User-Agent' => "brightcove-api gem #{VERSION}"
     }
@@ -29,7 +28,11 @@ module Brightcove
     # RestClient POST timeout for opening connection
     attr_accessor :open_timeout
 
-    # Initialize with your API token
+    # Initialize a new instance of the +Brightcove::API+ using a Brightcove token.
+    #
+    # @param token [String] Brightcove token which can be a read-only, write or read-write token.
+    # @param read_api_url [String] Read API URL or the default of +Brightcove::API::READ_API_URL+.
+    # @param write_api_url [String] Write API URL or the default of +Brightcove::API::WRITE_API_URL+.
     def initialize(token, read_api_url = READ_API_URL, write_api_url = WRITE_API_URL)
       @token = token
       @read_api_url = read_api_url
@@ -38,39 +41,44 @@ module Brightcove
       @open_timeout = nil
     end
 
+    # Set a location for debug HTTP output to be written to.
+    # 
+    # @param location [Object] Defaults to +$stderr+.
     def debug(location = $stderr)
       self.class.debug_output(location)
     end
 
+    # Set HTTP headers that should be used in API requests. The 
+    # +Brightcove::API::DEFAULT_HEADERS+ will be merged into the passed-in
+    # hash.
+    #
+    # @param http_headers [Hash] Updated HTTP headers.
     def set_http_headers(http_headers = {})
       http_headers.merge!(DEFAULT_HEADERS)
       headers(http_headers)
     end
 
+    # Set a timeout for HTTP requests.
+    # 
+    # @param timeout [int] HTTP timeout value.
     def set_timeout(timeout)
       default_timeout(timeout)
     end
 
-    def build_query_from_options(api_method, options = {})
-      # normalize options to a hash
-      unless options.respond_to?(:merge!)
-        options = CGI.parse(options)
-      end
-      
-      options.merge!({:command => api_method, :token => @token})
-      options.merge!({:format => :xml}) if options.key?(:output) && 'mrss'.eql?(options[:output])
-      { :query => options }
-    end
-
-    # Call Brightcove using a particular API method, api_method.
-    # The options parameter can be either a query string or a hash. In either case, it is where
-    # you can add any parameters appropriate for the API call. If a query string, it will be
-    # normalized to a hash via CGI.parse.
+    # Make an HTTP GET call to the Brightcove API for a particular API method.
+    #
+    # @param api_method [String] Brightcove API method.
+    # @param options [Hash] Optional hash containing parameter names and values. The options 
+    #   parameter can be either a query string or a hash. If a query string, it will be
+    #   normalized to a hash via CGI.parse.
     def get(api_method, options = {})
       self.class.get(@read_api_url, build_query_from_options(api_method, options))
     end
 
-    # Post to Brightcove using a particular API method, api_method. The parameters hash is where you add all the required parameters appropriate for the API call.
+    # Make an HTTP POST call to the Brightcove API for a particular API method.
+    # 
+    # @param api_method [String] Brightcove API method.
+    # @param parameters [Hash] Optional hash containing parameter names and values.
     def post(api_method, parameters = {})
       parameters.merge!({"token" => @token})
 
@@ -81,6 +89,11 @@ module Brightcove
       self.class.post(@write_api_url, {:body => {:json => JSON.generate(body)}})
     end
 
+    # Post a file to the Brightcove API, e.g. uploading video. 
+    #
+    # @param api_method [String] Brightcove API method.
+    # @param file [String] Full path of file to be uploaded.
+    # @param parameters [Hash] Optional hash containing parameter names and values.
     def post_file(api_method, file, parameters = {})
       parameters.merge!({"token" => @token})
 
@@ -116,7 +129,21 @@ module Brightcove
       JSON.parse(response)
     end
     
+    # Post a file via HTTP streaming to the Brightcove API, e.g. uploading video. 
+    #
+    # @param api_method [String] Brightcove API method.
+    # @param upload_file [String] Full path of file to be uploaded.
+    # @param parameters [Hash] Optional hash containing parameter names and values.
     def post_file_streaming(api_method, upload_file, content_type, parameters)
+      File.open(upload_file) { |file| post_io_streaming(api_method, file, content_type, parameters) }
+    end
+    
+    # Post a file IO object via HTTP streaming to the Brightcove API, e.g. uploading video. 
+    #
+    # @param api_method [String] Brightcove API method.
+    # @param file [File handle] File handle of file to be uploaded.
+    # @param parameters [Hash] Optional hash containing parameter names and values.
+    def post_io_streaming(api_method, file, content_type, parameters)
       parameters.merge!({"token" => @token})
 
       body = {}
@@ -133,20 +160,38 @@ module Brightcove
             
       url = URI.parse(@write_api_url)
       response = nil
-      File.open(upload_file) do |file|
-        payload[:json] = body.to_json
-        payload[:file] = UploadIO.new(file, content_type)
-        
-        request = Net::HTTP::Post::Multipart.new(url.path, payload)
-        
-        response = Net::HTTP.start(url.host, url.port) do |http|
-          http.read_timeout = @timeout if @timeout
-          http.open_timeout = @open_timeout if @open_timeout
-          http.request(request)
-        end
+      
+      payload[:json] = body.to_json
+      payload[:file] = UploadIO.new(file, content_type)
+      
+      request = Net::HTTP::Post::Multipart.new(url.path, payload)
+      
+      response = Net::HTTP.start(url.host, url.port) do |http|
+        http.read_timeout = @timeout if @timeout
+        http.open_timeout = @open_timeout if @open_timeout
+        http.request(request)
       end
 
       JSON.parse(response.body)
     end
+
+    private
+
+    # Build an appropriate query for the Brightcove API given an +api_method+ and +options+.
+    # This will also merge in your API token and set the +format+ to XML if +mrss+ has been 
+    # requested for the +:output+.
+    #
+    # @param api_method [String] Brightcove API method.
+    # @param options [Hash] Optional hash containing parameter names and values.
+    def build_query_from_options(api_method, options = {})
+      # normalize options to a hash
+      unless options.respond_to?(:merge!)
+        options = CGI.parse(options)
+      end
+      
+      options.merge!({:command => api_method, :token => @token})
+      options.merge!({:format => :xml}) if options.key?(:output) && 'mrss'.eql?(options[:output])
+      { :query => options }
+    end    
   end
 end