brightcove-api 1.0.0 → 1.0.1

data/LICENSE

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

data/README.rdoc

@@ -1,7 +1,27 @@
 = brightcove-api
 
-Description goes here.
+Ruby gem for interacting with the Brightcove media API. http://docs.brightcove.com/en/media/
 
+== Requirements
+
+* HTTParty
+* FakeWeb (only for testing)
+
+== Install
+
+* sudo gem install brightcove-api
+
+== Example
+
+  >> 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}
+  
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/Rakefile

@@ -12,6 +12,8 @@ begin
     gem.authors = ["David Czarnecki"]
     gem.add_dependency('httparty', '0.5.2')
     gem.add_dependency('fakeweb', '1.2.8')
+    gem.add_dependency('mocha', '0.9.8')
+    gem.add_dependency('json', '1.2.4')
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/brightcove-api.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{brightcove-api}
+  s.version = "1.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["David Czarnecki"]
+  s.date = %q{2010-09-24}
+  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.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "brightcove-api.gemspec",
+     "lib/brightcove-api.rb",
+     "test/fakeweb/find_all_videos_response.json",
+     "test/helper.rb",
+     "test/test_brightcove-api.rb"
+  ]
+  s.homepage = %q{http://github.com/agoragames/brightcove}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  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
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, ["= 0.5.2"])
+      s.add_runtime_dependency(%q<fakeweb>, ["= 1.2.8"])
+      s.add_runtime_dependency(%q<mocha>, ["= 0.9.8"])
+      s.add_runtime_dependency(%q<json>, ["= 1.2.4"])
+    else
+      s.add_dependency(%q<httparty>, ["= 0.5.2"])
+      s.add_dependency(%q<fakeweb>, ["= 1.2.8"])
+      s.add_dependency(%q<mocha>, ["= 0.9.8"])
+      s.add_dependency(%q<json>, ["= 1.2.4"])
+    end
+  else
+    s.add_dependency(%q<httparty>, ["= 0.5.2"])
+    s.add_dependency(%q<fakeweb>, ["= 1.2.8"])
+    s.add_dependency(%q<mocha>, ["= 0.9.8"])
+    s.add_dependency(%q<json>, ["= 1.2.4"])
+  end
+end
+

data/lib/brightcove-api.rb

@@ -1,16 +1,21 @@
 require 'httparty'
+require 'json'
 
 module Brightcove
   class API
     include HTTParty
     
-    VERSION = '1.0.0'.freeze
+    VERSION = '1.0.1'.freeze
     
     DEFAULT_HEADERS = {
       'User-Agent' => "brightcove-api gem #{VERSION}"
     }
+    
+    headers(DEFAULT_HEADERS)
         
     API_URL = 'http://api.brightcove.com/services/library'
+    
+    attr_accessor :api_url
         
     # Brightcove returns text/html as the Content-Type for a response even though the response is JSON.
     # So, let's just parse the response as JSON
@@ -25,8 +30,13 @@ module Brightcove
     def debug(location = $stderr)
       self.class.debug_output(location)
     end
+        
+    def set_http_headers(http_headers = {})
+      http_headers.merge!(DEFAULT_HEADERS)
+      headers(http_headers)
+    end
     
-    # Call Brightcove using a particular API method. The options hash is where you can add any parameters appropriate for the API call.
+    # Call Brightcove using a particular API method, api_method. The options hash is where you can add any parameters appropriate for the API call.
     def get(api_method, options = {})
       options.merge!({:command => api_method})
       options.merge!({:token => @token})

data/test/fakeweb/find_all_videos_response.json

@@ -0,0 +1,108 @@
+{ "items" : [ { "adKeys" : null,
+        "creationDate" : "1171267200000",
+        "economics" : "FREE",
+        "id" : 496518762,
+        "lastModifiedDate" : "1263581295791",
+        "length" : 111077,
+        "linkText" : null,
+        "linkURL" : null,
+        "longDescription" : null,
+        "name" : "Documentarian Skydiving",
+        "playsTotal" : 906,
+        "playsTrailingWeek" : 4,
+        "publishedDate" : "1171324433253",
+        "referenceId" : "title006",
+        "shortDescription" : "Thrill seekers document their adventure, from the door of the plane all the way to the ground.",
+        "tags" : [ "adventure",
+            "base jumping"
+          ],
+        "thumbnailURL" : "http://brightcove.vo.llnwd.net/d2/unsecured/media/270881183/270881183_502534822_86408e4e20580f7bf0b41c82be8ca9f4b95fb055.jpg?pubId=270881183",
+        "videoStillURL" : "http://brightcove.vo.llnwd.net/d2/unsecured/media/270881183/270881183_502534831_9c1e5fe9c3e95ca5009e7ceb68df2915ff669774.jpg?pubId=270881183"
+      },
+      { "adKeys" : null,
+        "creationDate" : "1171267200000",
+        "economics" : "FREE",
+        "id" : 496518763,
+        "lastModifiedDate" : "1250624757582",
+        "length" : 70337,
+        "linkText" : null,
+        "linkURL" : null,
+        "longDescription" : null,
+        "name" : "Surface Tricks",
+        "playsTotal" : 3253,
+        "playsTrailingWeek" : 28,
+        "publishedDate" : "1225126643431",
+        "referenceId" : "surface",
+        "shortDescription" : "Instructions on how to do the most common snowboarding tricks that are performed on the ground.",
+        "tags" : [ "adventure",
+            "snowboarding"
+          ],
+        "thumbnailURL" : "http://brightcove.vo.llnwd.net/d5/unsecured/media/270881183/270881183_34465519001_asset-1250624757285.jpg?pubId=270881183",
+        "videoStillURL" : "http://brightcove.vo.llnwd.net/d5/unsecured/media/270881183/270881183_34465520001_asset-1250624757522.jpg?pubId=270881183"
+      },
+      { "adKeys" : null,
+        "creationDate" : "1171267200000",
+        "economics" : "FREE",
+        "id" : 496518765,
+        "lastModifiedDate" : "1205689028256",
+        "length" : 11611,
+        "linkText" : null,
+        "linkURL" : null,
+        "longDescription" : null,
+        "name" : "Free Skiing",
+        "playsTotal" : 2471,
+        "playsTrailingWeek" : 15,
+        "publishedDate" : "1171324434490",
+        "referenceId" : "title009",
+        "shortDescription" : "Hot dog skiing of the 1970s has begun a new life as Freeskiing. Often referred to as New School, Freeride, Park Skiing or Slopestyle, Freeskiing boasts of innovative young skiers who quest for something more extreme and radical than the norm.",
+        "tags" : [ "adventure",
+            "snowboarding"
+          ],
+        "thumbnailURL" : "http://brightcove.vo.llnwd.net/d5/unsecured/media/270881183/270881183_1459169541_b317544d5275ab9df2d3030da2f8cbefde8fbdea.jpg?pubId=270881183",
+        "videoStillURL" : "http://brightcove.vo.llnwd.net/d5/unsecured/media/270881183/270881183_1459169542_55bfa4b674d1d31c469b91af71d8e81baad2ab32.jpg?pubId=270881183"
+      },
+      { "adKeys" : null,
+        "creationDate" : "1171267200000",
+        "economics" : "FREE",
+        "id" : 496518766,
+        "lastModifiedDate" : "1171324523307",
+        "length" : 51251,
+        "linkText" : null,
+        "linkURL" : null,
+        "longDescription" : null,
+        "name" : "Wild Slopes '06",
+        "playsTotal" : 4458,
+        "playsTrailingWeek" : 35,
+        "publishedDate" : "1171324434811",
+        "referenceId" : "title010",
+        "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.",
+        "tags" : [ "adventure",
+            "snowboarding"
+          ],
+        "thumbnailURL" : "http://brightcove.vo.llnwd.net/d2/unsecured/media/270881183/270881183_502534829_94499905676eb7cd04a558da2adcf6a34f437b88.jpg?pubId=270881183",
+        "videoStillURL" : "http://brightcove.vo.llnwd.net/d2/unsecured/media/270881183/270881183_502534838_f80fe64f052328cd3b2e158d7234003a23091845.jpg?pubId=270881183"
+      },
+      { "adKeys" : null,
+        "creationDate" : "1161241200000",
+        "economics" : "FREE",
+        "id" : 276024035,
+        "lastModifiedDate" : "1263581295791",
+        "length" : 418742,
+        "linkText" : "Related Link",
+        "linkURL" : "http://www.brightcove.com",
+        "longDescription" : "Long Description",
+        "name" : "Demo Title 2",
+        "playsTotal" : 3876,
+        "playsTrailingWeek" : 1,
+        "publishedDate" : "1161296014264",
+        "referenceId" : null,
+        "shortDescription" : "Short Description",
+        "tags" : [  ],
+        "thumbnailURL" : "http://brightcove.vo.llnwd.net/d2/unsecured/media/270881183/270881183_275925069_d1f97c7f07f2a3f4de7b38eda3761f16f39d2a99.jpg?pubId=270881183",
+        "videoStillURL" : "http://brightcove.vo.llnwd.net/d2/unsecured/media/270881183/270881183_275943599_b7e2ca63c0311fa3f0b027304b41d252f12d2d66.jpg?pubId=270881183"
+      }
+    ],
+  "page_number" : 0,
+  "page_size" : 5,
+  "total_count" : -1
+}

data/test/test_brightcove-api.rb

@@ -1,5 +1,6 @@
 require 'helper'
 require 'fakeweb'
+require 'mocha'
 
 class TestBrightcoveApi < Test::Unit::TestCase
   def setup
@@ -10,6 +11,24 @@ class TestBrightcoveApi < Test::Unit::TestCase
     FakeWeb.allow_net_connect = true
   end
   
+  def test_api_version
+    assert_equal '1.0.1', Brightcove::API::VERSION
+  end
+  
+  def test_can_set_api_url
+    brightcove = Brightcove::API.new('apikeytoken')
+    brightcove.api_url = 'http://some.api.com'
+    
+    assert_equal 'http://some.api.com', brightcove.api_url
+  end
+  
+  def test_can_set_http_headers
+    brightcove = Brightcove::API.new('apikeytoken')
+    brightcove.expects(:headers).at_least_once
+    
+    brightcove.set_http_headers({'Accept' => 'application/json'})
+  end
+  
   def test_find_all_videos
     FakeWeb.register_uri(:get, 
                          'http://api.brightcove.com/services/library?page_size=5&token=0Z2dtxTdJAxtbZ-d0U7Bhio2V1Rhr5Iafl5FFtDPY8E.&command=find_all_videos', 

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: brightcove-api
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  hash: 21
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - David Czarnecki
@@ -9,29 +15,73 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-29 00:00:00 -04:00
+date: 2010-09-24 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: httparty
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 5
+        - 2
         version: 0.5.2
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: fakeweb
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 2
+        - 8
         version: 1.2.8
-    version: 
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 2
+        - 4
+        version: 1.2.4
+  type: :runtime
+  version_requirements: *id004
 description: Ruby gem for interacting with the Brightcove media API. http://docs.brightcove.com/en/media/
 email: dczarnecki@agoragames.com
 executables: []
@@ -48,7 +98,9 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- brightcove-api.gemspec
 - lib/brightcove-api.rb
+- test/fakeweb/find_all_videos_response.json
 - test/helper.rb
 - test/test_brightcove-api.rb
 has_rdoc: true
@@ -61,21 +113,27 @@ 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"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Ruby gem for interacting with the Brightcove media API