sproutvideo-rb 1.3.1 → 1.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f047d8bd8097756d80ea282187cc357c982817bf
+  data.tar.gz: 8bf54d8d9157f9e456a097ba71800582c020c676
+SHA512:
+  metadata.gz: 57804f28aff4ecda9270a28c3677097720e70f331a77237ffbf6efaddfebc24416051c2bd44f8f99776112bc5def0ef40a716cb9f96d852bd859263a4a1b088e
+  data.tar.gz: e3acbb9d220a254a62d60733bb36d1136e6a7f475a7a429cda0b8eab716614945f17cd9e49c5f5d807060d70b3c1bd9b3b5958e60f4d69220c58abb9bb4e0ae1

data/Gemfile

@@ -6,7 +6,6 @@ gem "multi_json"
 group :development do
   gem "rspec", "~> 2.8.0"
   gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.0.0"
+  gem "bundler"
   gem "jeweler", "~> 1.8.3"
-  gem "rcov", ">= 0"
 end

data/Gemfile.lock

@@ -12,7 +12,6 @@ GEM
     mime-types (1.19)
     multi_json (1.0.4)
     rake (0.9.2.2)
-    rcov (1.0.0)
     rdoc (3.12)
       json (~> 1.4)
     rest-client (1.6.1)
@@ -30,10 +29,9 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.0)
+  bundler
   jeweler (~> 1.8.3)
   multi_json
-  rcov
   rdoc (~> 3.12)
   rest-client
   rspec (~> 2.8.0)

data/README.markdown

@@ -10,7 +10,7 @@ First, you'll need to install the gem
 The first thing you'll need to interact with the SproutVideo API is your API key. You can use your API key in one of two ways. The first and easiest is to set it and forget it on the Sproutvideo module like so:
 
 ```ruby
-SproutVideo.api_key = 'abcd1234'
+Sproutvideo.api_key = 'abcd1234'
 ```
 
 Alternatively, you can use an environment variable:
@@ -20,18 +20,39 @@ ENV['SPROUTVIDEO_API_KEY'] = 'abcd1234'
 ```
 
 # Videos
-The following methods are available: `list`, `create`, `details`, `update`, `delete`.
+The following methods are available: `list`, `create`, `details`, `update`, `upload_poster_frame`,`destroy`.
 
 ##list
-By default the videos listing is paginated with 25 videos per page and sorted by upload date in ascending order. You can pass two parameters to control the paging: page and per_page. You can also pass in the id of a tag to just return the videos tagged with that tag.
+By default the videos listing is paginated with 25 videos per page and sorted by upload date in ascending order.
+You can pass two parameters to control the paging: `page` and `per_page`.
 
 ```ruby
 Sproutvideo::Video.list
 Sproutvideo::Video.list(:per_page => 10)
 Sproutvideo::Video.list(:per_page => 10, :page => 2)
-Sproutvideo::Video.list(:tag_id => 'abc')
 ```
 
+You can control sorting order by `order_by` and `order_dir` parameter.
+
+```ruby
+Sproutvideo::Video.list(:order_by => "created_at")
+Sproutvideo::Video.list(:order_by => "updated_at")
+Sproutvideo::Video.list(:order_by => "title", :order_dir => "asc")
+Sproutvideo::Video.list(:order_by => "duration", :order_dir => "desc")
+```
+
+You can also pass `tag_id`, `tag_name`, `privacy` and `state` parameters to restrict result.
+
+```ruby
+Sproutvideo::Video.list(:tag_id => 'a323d32')
+Sproutvideo::Video.list(:tag_name => 'funny cat videos')
+Sproutvideo::Video.list(:privacy => 2)
+Sproutvideo::Video.list(:state => "processing")
+```
+
+Values of `privacy` is listed at [Video Privacy](http://sproutvideo.com/docs/api.html#VideoPrivacy) section.
+Values of `state` is listed at [Video States](http://sproutvideo.com/docs/api.html#VideoStates) section.
+
 ##details
 The string passed to details is the ID of a SproutVideo video.
 
@@ -96,12 +117,18 @@ You can remove all of the tags from a video by just passing an empty array as th
 ```ruby
 Sproutvideo::Video.update('abc123', :tags => [])
 ```
+##Upload poster frame
+You can upload a custom poster frame for a video by calling the upload_poster_frame method. The first parameter is the id of the video for wish you'd like the poster frame to be associated and the second parameter is the path to the image file.
+
+```ruby
+SproutVideo::Video.upload_poster_frame('abc123', '/path/to/image.jpg')
+```
 
-##delete
+##destroy
 Pass in the id of the video you wish to delete.
 
 ```ruby
-Sproutvideo::Video.delete('abc123')
+Sproutvideo::Video.destroy('abc123')
 ```
 
 ##Signed Embed Codes
@@ -133,7 +160,7 @@ Sproutvideo::Video.signed_embed_code('abc123','def456', {}, nil, 'https') #Use h
 ```
 
 # Tags
-The following methods are available: `list`, `create`, `details`, `update`, `delete`.
+The following methods are available: `list`, `create`, `details`, `update`, `destroy`.
 
 ##list
 By default the tag listing is paginated with 25 tags per page and sorted by created at date in ascending order. You can pass two parameters to control the paging: page and per_page. 
@@ -155,15 +182,15 @@ Sproutvideo::Tag.create(:name => 'new tag')
 Sproutvideo::Tag.update('abc123', :name => 'updated tag name')
 ```
 
-##delete
+##destroy
 Pass in the id of the tag you wish to delete.
 
 ```ruby
-Sproutvideo::Tag.delete('abc123')
+Sproutvideo::Tag.destroy('abc123')
 ```
 
 # Playlists
-The following methods are available: `list`, `create`, `details`, `update`, `delete`.
+The following methods are available: `list`, `create`, `details`, `update`, `destroy`.
 ##list
 By default the playlist listing is paginated with 25 playlists per page and sorted by created at date in ascending order. You can pass two parameters to control the paging: page and per_page. 
 
@@ -209,15 +236,15 @@ You can remove all of the videos from a playlist by just passing an empty array
 Sproutvideo::Playlist.update('abc123', :videos => [])
 ```
 
-##delete
+##destroy
 Pass in the id of the playlist you wish to delete.
 
 ```ruby
-Sproutvideo::Playlist.delete('abc123')
+Sproutvideo::Playlist.destroy('abc123')
 ```
 
 # Logins
-The following methods are available: `list`, `create`, `details`, `update`, `delete`
+The following methods are available: `list`, `create`, `details`, `update`, `destroy`
 
 ## list
 By default the login listing is paginated with 25 tags per page and sorted by created at date in ascending order. You can pass two parameters to control the paging: page and per_page.
@@ -253,14 +280,14 @@ Sproutvideo::Login.update('abc123',
   :password => 'newpassword')
 ```
 
-## delete
+## destroy
 Pass in the id of the login you wish to delete.
 
 ```ruby
-Sproutvideo::Login.delete('asdf1234')
+Sproutvideo::Login.destroy('asdf1234')
 ```
 # Access Grants
-The following methods are available: `list`, `create`, `details`, `update`, `delete`
+The following methods are available: `list`, `create`, `details`, `update`, `destroy`
 
 ## list
 By default the access grant listing is paginated with 25 tags per page and sorted by created at date in ascending order. You can pass two parameters to control the paging: page and per_page.
@@ -275,7 +302,7 @@ Sproutvideo::AccessGrant.list(:per_page => 10, :page => 2)
 Create takes two required parameters, `video_id` and `login_id`, which will be used to allow a viewer to login to watch a video based on the other optional parameters.
     
 ```ruby
-Sproutvideo::Login.create(
+Sproutvideo::AccessGrant.create(
   :video_id => 'abc123',
   :login_id => 'abc123')
 ```
@@ -284,7 +311,7 @@ Sproutvideo::Login.create(
 The string passed to details is the ID of a SproutVideo login.
 
 ```ruby
-Sproutvideo::Login.details('abc123')
+Sproutvideo::AccessGrant.details('abc123')
 ```
 
 ## update
@@ -292,16 +319,16 @@ Sproutvideo::Login.details('abc123')
 You can change the optional parameters for an access grant.
 
 ```ruby
-Sproutvideo::Login.update('abc123', 
+Sproutvideo::AccessGrant.update('abc123', 
   :allowed_plays => 20,
   :access_ends_at => DateTime.parse('8/4/2014'))
 ```
 
-## delete
+## destory
 Pass in the id of the access grant you wish to delete.
 
 ```ruby
-Sproutvideo::AccessGrant.delete('asdf1234')
+Sproutvideo::AccessGrant.destroy('asdf1234')
 ```
 #Analytics
 The following methods are available through the API client for analytics:
@@ -374,4 +401,4 @@ Sproutvideo::Analytics.engagement_sessions('abc123', :page => 3, :per_page => 40
 # Copyright
 
 Copyright (c) 2012 SproutVideo. See LICENSE.txt for
-further details.
+further details.

data/Rakefile

@@ -2,7 +2,7 @@
 require 'rubygems'
 require 'bundler'
 
-require 'lib/sproutvideo/version.rb'
+require File.expand_path(File.dirname(__FILE__) + '/lib/sproutvideo/version.rb')
 
 begin
   Bundler.setup(:default, :development)
@@ -17,7 +17,7 @@ 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 = "sproutvideo-rb"
-  gem.homepage = "http://github.com/sproutvideo/sproutvideo-rb"
+  gem.homepage = "http://github.com/SproutVideo/sproutvideo-rb"
   gem.license = "MIT"
   gem.summary = %Q{SproutVideo API Client}
   gem.description = %Q{SproutVideo API Client}

data/lib/sproutvideo/resource.rb

@@ -22,14 +22,25 @@ module Sproutvideo
 
     def self.upload(path, file_path, options={})
       resp = nil
+      
+      method = options.delete(:method) == :PUT ? :PUT : :POST
+
       File.open(file_path) do |file|
-        body = {:source_video => file}.merge(options.dup)
+        
+        if method == :POST
+          body = {:source_video => file}.merge(options.dup)
+        else
+          body = {:custom_poster_frame => file}
+        end
+
         begin
-          resp = RestClient.post(
+          resp = RestClient.send(
+            method == :POST ? 'post' : 'put',
             "#{base_url}#{path}",
             body,
             {'SproutVideo-Api-Key' => api_key, :timeout => 18000})
         rescue => e
+          puts e
           resp = e.response
         end
       end

data/lib/sproutvideo/version.rb

@@ -1,3 +1,3 @@
 module Sproutvideo
-	VERSION = "1.3.1"
+	VERSION = "1.4.0"
 end

data/lib/sproutvideo/video.rb

@@ -22,6 +22,10 @@ module Sproutvideo
       put("/videos/#{video_id}", options)
     end
 
+    def self.upload_poster_frame(video_id, file_path='')
+      upload("/videos/#{video_id}", file_path, {:method => :PUT})
+    end
+
     def self.destroy(video_id, options={})
       delete("/videos/#{video_id}", options)
     end

data/spec/sproutvideo/video_spec.rb

@@ -97,6 +97,32 @@ describe Sproutvideo::Video do
 
 	end
 
+	describe "#upload_poster_frame" do
+		before(:each) do
+			@video_id = 1
+			@url = "#{Sproutvideo.base_url}/videos/#{@video_id}"
+		end
+
+		it "should PUT the correct url and return a response" do
+			File.open('poster_test', 'w+') do |f|
+				f.syswrite('poster_frame')
+			end
+
+			file = File.open('poster_test')
+
+			File.stub!(:open).with('poster_test').and_yield(file)
+
+			RestClient.should_receive(:put).with(
+				@url,
+				{:custom_poster_frame => file},
+				{'SproutVideo-Api-Key' => @api_key, :timeout => 18000}).and_return(@msg)
+			Sproutvideo::Video.upload_poster_frame(@video_id, 'poster_test').class.should == Sproutvideo::Response
+
+			FileUtils.rm('poster_test')
+		end
+
+	end
+
 	describe "#delete" do
 		before(:each) do
 			@video_id = 1

data/sproutvideo-rb.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "sproutvideo-rb"
-  s.version = "1.3.1"
+  s.version = "1.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["SproutVideo"]
-  s.date = "2013-05-09"
+  s.date = "2014-01-16"
   s.description = "SproutVideo API Client"
   s.email = "support@sproutvideo.com"
   s.extra_rdoc_files = [
@@ -46,40 +46,37 @@ Gem::Specification.new do |s|
     "spec/sproutvideo_spec.rb",
     "sproutvideo-rb.gemspec"
   ]
-  s.homepage = "http://github.com/sproutvideo/sproutvideo-rb"
+  s.homepage = "http://github.com/SproutVideo/sproutvideo-rb"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.25"
+  s.rubygems_version = "2.0.7"
   s.summary = "SproutVideo API Client"
 
   if s.respond_to? :specification_version then
-    s.specification_version = 3
+    s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<rest-client>, [">= 0"])
       s.add_runtime_dependency(%q<multi_json>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
     else
       s.add_dependency(%q<rest-client>, [">= 0"])
       s.add_dependency(%q<multi_json>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 2.8.0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
-      s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
     s.add_dependency(%q<rest-client>, [">= 0"])
     s.add_dependency(%q<multi_json>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 2.8.0"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
-    s.add_dependency(%q<rcov>, [">= 0"])
   end
 end
 

metadata

@@ -1,137 +1,107 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: sproutvideo-rb
-version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: 
-  segments: 
-  - 1
-  - 3
-  - 1
-  version: 1.3.1
+version: !ruby/object:Gem::Version
+  version: 1.4.0
 platform: ruby
-authors: 
+authors:
 - SproutVideo
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-05-09 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-01-16 00:00:00.000000000 Z
+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"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: multi_json
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 47
-        segments: 
-        - 2
-        - 8
-        - 0
+      - !ruby/object:Gem::Version
         version: 2.8.0
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rdoc
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 3
-        - 12
-        version: "3.12"
+      - !ruby/object:Gem::Version
+        version: '3.12'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: jeweler
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 49
-        segments: 
-        - 1
-        - 8
-        - 3
+      - !ruby/object:Gem::Version
         version: 1.8.3
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: rcov
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id007
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
 description: SproutVideo API Client
 email: support@sproutvideo.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
 - README.markdown
-files: 
+files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -160,38 +130,28 @@ files:
 - spec/sproutvideo/video_spec.rb
 - spec/sproutvideo_spec.rb
 - sproutvideo-rb.gemspec
-homepage: http://github.com/sproutvideo/sproutvideo-rb
-licenses: 
+homepage: http://github.com/SproutVideo/sproutvideo-rb
+licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+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: 3
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.7
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: SproutVideo API Client
 test_files: []
-