brightcove-api 1.0.1 → 1.0.2

data/README.rdoc

@@ -5,6 +5,7 @@ Ruby gem for interacting with the Brightcove media API. http://docs.brightcove.c
 == Requirements
 
 * HTTParty
+* JSON
 * FakeWeb (only for testing)
 
 == Install
@@ -21,7 +22,9 @@ Ruby gem for interacting with the Brightcove media API. http://docs.brightcove.c
   => {"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}
+	  
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/Rakefile

@@ -12,7 +12,6 @@ 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

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.0.2

data/brightcove-api.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{brightcove-api}
-  s.version = "1.0.1"
+  s.version = "1.0.2"
 
   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.date = %q{2010-09-25}
   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 = [
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
      "VERSION",
      "brightcove-api.gemspec",
      "lib/brightcove-api.rb",
+     "test/fakeweb/delete_video_response.json",
      "test/fakeweb/find_all_videos_response.json",
      "test/helper.rb",
      "test/test_brightcove-api.rb"
@@ -46,18 +47,15 @@ Gem::Specification.new do |s|
     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

@@ -5,7 +5,7 @@ module Brightcove
   class API
     include HTTParty
     
-    VERSION = '1.0.1'.freeze
+    VERSION = '1.0.2'.freeze
     
     DEFAULT_HEADERS = {
       'User-Agent' => "brightcove-api gem #{VERSION}"
@@ -13,18 +13,22 @@ module Brightcove
     
     headers(DEFAULT_HEADERS)
         
-    API_URL = 'http://api.brightcove.com/services/library'
+    READ_API_URL = 'http://api.brightcove.com/services/library'
+    WRITE_API_URL = 'http://api.brightcove.com/services/post'
     
-    attr_accessor :api_url
+    attr_accessor :read_api_url
+    attr_accessor :write_api_url
+    attr_accessor :token
         
     # 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
     format(:json)
     
     # Initialize with your API token  
-    def initialize(token, api_url = API_URL)
+    def initialize(token, read_api_url = READ_API_URL, write_api_url = WRITE_API_URL)
       @token = token
-      @api_url = api_url
+      @read_api_url = read_api_url
+      @write_api_url = write_api_url
     end
     
     def debug(location = $stderr)
@@ -44,7 +48,18 @@ module Brightcove
       query = {}
       query.merge!({:query => options})
             
-      self.class.get(@api_url, query)
-    end    
+      self.class.get(@read_api_url, query)
+    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.
+    def post(api_method, parameters = {}) 
+      parameters.merge!({"token" => @token})
+      
+      body = {}
+      body.merge!({:method => api_method})          
+      body.merge!({:params => parameters})
+      
+      self.class.post(@write_api_url, {:body => {:json => JSON.generate(body)}})
+    end
   end
 end

data/test/fakeweb/delete_video_response.json

@@ -0,0 +1 @@
+{"result":{}, "id":nil, "error":nil}

data/test/test_brightcove-api.rb

@@ -12,14 +12,33 @@ class TestBrightcoveApi < Test::Unit::TestCase
   end
   
   def test_api_version
-    assert_equal '1.0.1', Brightcove::API::VERSION
+    assert_equal '1.0.2', Brightcove::API::VERSION
   end
   
-  def test_can_set_api_url
+  def test_can_set_read_api_url
     brightcove = Brightcove::API.new('apikeytoken')
-    brightcove.api_url = 'http://some.api.com'
     
-    assert_equal 'http://some.api.com', brightcove.api_url
+    assert_equal Brightcove::API::READ_API_URL, brightcove.read_api_url
+    
+    brightcove.read_api_url = 'http://some.api.com'
+    
+    assert_equal 'http://some.api.com', brightcove.read_api_url
+  end
+
+  def test_can_set_write_api_url
+    brightcove = Brightcove::API.new('apikeytoken')
+
+    assert_equal Brightcove::API::WRITE_API_URL, brightcove.write_api_url
+
+    brightcove.write_api_url = 'http://some.api.com'
+    
+    assert_equal 'http://some.api.com', brightcove.write_api_url
+  end
+  
+  def test_can_set_token
+    brightcove = Brightcove::API.new('apikeytoken')
+    
+    assert_equal 'apikeytoken', brightcove.token
   end
   
   def test_can_set_http_headers
@@ -41,4 +60,17 @@ class TestBrightcoveApi < Test::Unit::TestCase
     assert_equal 5, brightcove_response['items'].size
     assert_equal 0, brightcove_response['page_number']
   end
+  
+  def test_delete_video
+    FakeWeb.register_uri(:post, 
+                         'http://api.brightcove.com/services/post', 
+                         :body => File.join(File.dirname(__FILE__), 'fakeweb', 'delete_video_response.json'), 
+                         :content_type => "application/json")
+                         
+    brightcove = Brightcove::API.new('0Z2dtxTdJAxtbZ-d0U7Bhio2V1Rhr5Iafl5FFtDPY8E.')
+    brightcove_response = brightcove.post('delete_video', {:video_id => '595153261337'})
+    
+    assert brightcove_response.has_key?('result')
+    assert_equal brightcove_response['error'], 'nil'
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: brightcove-api
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - David Czarnecki
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-24 00:00:00 -04:00
+date: 2010-09-25 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,26 +50,10 @@ dependencies:
         version: 1.2.8
   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 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -81,7 +65,7 @@ dependencies:
         - 4
         version: 1.2.4
   type: :runtime
-  version_requirements: *id004
+  version_requirements: *id003
 description: Ruby gem for interacting with the Brightcove media API. http://docs.brightcove.com/en/media/
 email: dczarnecki@agoragames.com
 executables: []
@@ -100,6 +84,7 @@ files:
 - VERSION
 - brightcove-api.gemspec
 - lib/brightcove-api.rb
+- test/fakeweb/delete_video_response.json
 - test/fakeweb/find_all_videos_response.json
 - test/helper.rb
 - test/test_brightcove-api.rb