vzaar 1.2.4 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ead17a9da83c804eed68c6c5216fcfc2a829a4b
-  data.tar.gz: 7e4937420e0b0d14218869924fb5c1427e85aff7
+  metadata.gz: a0f8c545d337aa9a7a6ac806dbaf953b94626c11
+  data.tar.gz: fbf6792107a9b92b0db766751513d556daa99667
 SHA512:
-  metadata.gz: ff7a580c3554b96b9b680e18416fa5af97b93636e214d487eaef344832d89ec2f639770674dc50340cb0ab087f1c2b2eec620a438332f5df25315cca73d1229d
-  data.tar.gz: c2400435c3e52772e60e09861a30b295a94cafa5dc271c0579ab1e011639e02bdaaebc85984b0050a1df99c410fd19c94cee893ddf10e243fd8ae2ccbf1a5a63
+  metadata.gz: b6ad173b1e4851f03347435aae3a75b36ad4d4dab5405564c244ee712c7f6db36411eb742fe5cc8fed6c5786b6c291f32cb63a11c071a596a8fc001838943cfd
+  data.tar.gz: 872224645b46d7a36d2364f21d38e55e903e789f13c85d2ed47a5ba9975d5a09310f049b6ff7a63e3b67603f62174b2187a07fee5e3f5012eb4425256a50b124

data/.gitignore

@@ -24,3 +24,4 @@ load.rb
 test.rb
 .tags
 .gemtags
+api_envs.yml

data/README.md

@@ -18,8 +18,7 @@ And then execute:
 ### Usage
 
 ```ruby
-conn = Vzaar::Connection.new(:application_token => "API token", :login => "vzaar login")
-api = Vzaar::Api.new(conn)
+api = Vzaar::Api.new(application_token: "API token", login: "vzaar login")
 ```
 
 If your login and API token are correct, you should be able to fetch your login by calling:

data/Rakefile

@@ -6,3 +6,13 @@ desc "Run all specs"
 task :default do
   exec 'rspec spec'
 end
+
+namespace :spec do
+  namespace :api do
+
+    task :dev do
+      exec 'API_ENV=development bundle exec rspec examples'
+    end
+
+  end
+end

data/examples/account_details_spec.rb

@@ -0,0 +1,13 @@
+require_relative './spec_helper'
+
+describe "Account Details" do
+  context "when user is unauthenticated" do
+    before(:all) do
+      api = unauthenticated_api()
+      @res = api.account_type(34)
+    end
+
+    it_behaves_like "200 OK"
+    specify { expect(@res.title).to eq("Staff") }
+  end
+end

data/examples/add_subtitle_spec.rb

@@ -0,0 +1,55 @@
+require_relative './spec_helper'
+
+describe "Add Subtitle" do
+  context "when user is unauthenticated" do
+    it_behaves_like "Unauthenticated", -> (api) do
+      api.add_subtitle(test_video_id("user1"), body: "x", language: "en")
+    end
+  end
+
+  context "Authenticated User" do
+    before(:all) do
+      @api = _api(login: user1["login"],
+                  application_token: user1["rw_token"])
+    end
+
+    context "RW token" do
+      context "when params are valid" do
+        before(:all) do
+          @res = @api.add_subtitle(test_video_id("user1"), body: "SRT", language: "en")
+        end
+
+        it_behaves_like "202 Accepted"
+      end
+
+      context "when language param is blank" do
+        before(:all) do
+          @res = @api.add_subtitle(test_video_id("user1"), body: "SRT", language: "")
+        end
+
+        it_behaves_like "422 Failure"
+
+        specify { expect(@res.errors.first["language"]).to eq("empty string") }
+      end
+    end
+
+
+    context "RO token" do
+      it_behaves_like "RO only", user1["login"], user1["ro_token"], -> (api) do
+        api.add_subtitle(test_video_id("user1"), body: "SRT", language: "en")
+      end
+    end
+
+    context "when user doesn't have permission to the video" do
+      before(:all) do
+        @res = @api.add_subtitle(test_video_id("user2"), body: "SRT", language: "en")
+      end
+
+      it_behaves_like "422 Failure"
+
+      specify do
+        expect(@res.errors.first["user"]).to match(/Permission Denied/)
+      end
+    end
+  end
+end

data/examples/api_envs.yml.example

@@ -0,0 +1,10 @@
+development:
+  user1:
+    login: vz-account1
+    rw_token: cyCFbqQ4YTkrQhjFu7OZ2yoO3ol2avg79jRqWhKCpo
+    test_video_id: 1465464
+
+  user2:
+    login: vz-account2
+    rw_token: tnDyOtR0YPx6nKPdgw9MM35Cicm5y4ZZGNCglOtI
+    test_video_id: 1465488

data/examples/authentication_spec.rb

@@ -0,0 +1,18 @@
+require_relative './spec_helper'
+
+describe "Authentication" do
+  describe "whoami" do
+    context "when user is unauthenticated" do
+      it_behaves_like "Unauthenticated", -> (api) { api.whoami }
+    end
+
+    context "when auth success" do
+      specify do
+        api = _api(login: user1["login"],
+                   application_token: user1["rw_token"])
+
+        expect(api.whoami).to eq(user1["login"])
+      end
+    end
+  end
+end

data/examples/delete_video_spec.rb

@@ -0,0 +1,40 @@
+require_relative './spec_helper'
+
+describe "Delete Video" do
+  vid_id = nil
+
+  before(:all) do
+    file_path = "./spec/support/video.mov"
+    desc = "Delete Video"
+    @api = _api(login: user1["login"],
+               application_token: user1["rw_token"])
+
+    @title = "api-test-#{rand_str}"
+
+    res = @api.upload_video(path: file_path, title: @title, description: desc)
+    vid_id = res.id
+  end
+
+  context "when user is unauthenticated" do
+    it_behaves_like "Unauthenticated", -> (api) do
+      api.delete_video(vid_id)
+    end
+  end
+
+  context "Authenticated User" do
+    context "RW token" do
+      before(:all) do
+        @res = @api.delete_video(vid_id)
+      end
+
+      specify { expect(@res.http_status_code).to eq 200 }
+      specify { expect(@res.title).to eq(@title) }
+    end
+
+    context "RO token" do
+      it_behaves_like "RO only", user1["login"], user1["ro_token"], -> (api) do
+        api.delete_video(vid_id)
+      end
+    end
+  end
+end

data/examples/edit_video_spec.rb

@@ -0,0 +1,39 @@
+require_relative './spec_helper'
+
+describe "Upload Thumbnail" do
+  context "when user is unauthenticated" do
+    it_behaves_like "Unauthenticated", -> (api) do
+      api.edit_video(test_video_id("user1"), title: "foo")
+    end
+  end
+
+  context "Authenticated User" do
+    context "RW token" do
+      before(:all) do
+        @api = _api(login: user1["login"],
+                    application_token: user1["rw_token"])
+      end
+
+      describe "updating params" do
+        before(:all) do
+          @title = rand_str()
+          @desc = rand_str()
+          @res = @api.edit_video(test_video_id("user1"),
+                                 title: @title,
+                                 description: @desc)
+        end
+
+        it_behaves_like "200 OK"
+
+        specify { expect(@res.title).to eq(@title) }
+        specify { expect(@res.description).to eq(@desc) }
+      end
+    end
+
+    context "RO token" do
+      it_behaves_like "RO only", user1["login"], user1["ro_token"], -> (api) do
+        api.edit_video(test_video_id("user1"), title: "woof")
+      end
+    end
+  end
+end

data/examples/generate_thumbnail_spec.rb

@@ -0,0 +1,65 @@
+require_relative './spec_helper'
+
+describe "Generate Thumbnail" do
+  before(:all) do
+    @video_id = test_video_id("user1")
+    @video_id2 = test_video_id("user2")
+  end
+
+  context "when user is unauthenticated" do
+    it_behaves_like "Unauthenticated", -> (api) do
+      api.generate_thumbnail(test_video_id("user1"), time: 3)
+    end
+  end
+
+  context "Authenticated User" do
+    context "RW token" do
+      before(:all) do
+        @api = _api(login: user1["login"],
+                    application_token: user1["rw_token"])
+      end
+
+      context "when params are valid" do
+        before(:all) do
+          @res = @api.generate_thumbnail(test_video_id("user1"), time: 3)
+        end
+
+        it_behaves_like "202 Accepted"
+      end
+
+      context "when time param is invalid" do
+        before(:all) do
+          @res = @api.generate_thumbnail(test_video_id("user1"), time: "invalid")
+        end
+
+        it_behaves_like "422 Failure"
+
+        specify do
+          expect(@res.errors.first["thumb_time"]).to eq("invalid integer")
+        end
+      end
+    end
+
+
+    context "RO token" do
+      it_behaves_like "RO only", user1["login"], user1["ro_token"], -> (api) do
+        api.generate_thumbnail(test_video_id("user1"), time: 3)
+      end
+    end
+
+
+    context "when user doesn't have permission to the video" do
+      before(:all) do
+        api = _api(login: user1["login"],
+                   application_token: user1["rw_token"])
+        @res = api.generate_thumbnail(test_video_id("user2"), time: 3)
+      end
+
+      it_behaves_like "422 Failure"
+
+      specify do
+        expect(@res.errors.first["user"]).to match(/Permission Denied/)
+      end
+    end
+  end
+end

data/examples/readme.md

@@ -0,0 +1,7 @@
+To run the tests you need to setup 2 testing accounts on vzaar app and upload testing video to your first account.
+Then generate RW and RO tokens for each account.
+
+After that copy examples/api_envs.yml.example to the main gem's directory (as a api_envs.yml) and fill config with the data from your accounts.
+
+
+rake spec:api:dev will run all api specs

data/examples/spec_helper.rb

@@ -0,0 +1,100 @@
+require 'rspec'
+require 'vzaar'
+require 'yaml'
+require 'pry'
+
+
+RSpec.shared_examples("RO only") do |login, token, fn|
+  specify do
+    api = _api(login: login, application_token: token)
+
+    expect do
+      fn.call(api)
+    end.to raise_error(Vzaar::Error, "Protected Resource")
+  end
+end
+
+
+RSpec.shared_examples("Unauthenticated") do |fn|
+  specify do
+    api = unauthenticated_api()
+    expect do
+      fn.call(api)
+    end.to raise_error(Vzaar::Error, "Protected Resource")
+  end
+end
+
+
+RSpec.shared_examples("422 Failure") do
+  specify { expect(@res.http_status_code).to eq(422) }
+  specify { expect(@res.status).to eq("Failure") }
+end
+
+RSpec.shared_examples("202 Accepted") do
+  specify { expect(@res.http_status_code).to eq 202 }
+  specify { expect(@res.status).to eq("Accepted") }
+end
+
+RSpec.shared_examples("200 OK") do
+  specify { expect(@res.http_status_code).to eq 200 }
+end
+
+RSpec.shared_examples("401 Unauthorized") do
+  specify { expect(@res.http_status_code).to eq 401 }
+end
+
+def env
+  ENV["API_ENV"] || "development"
+end
+
+def server
+  case env
+  when "development" then "http://app.vzaar.localhost"
+  end
+end
+
+def api_envs
+  @api_envs ||= YAML.load_file("api_envs.yml")
+end
+
+def user1
+  api_envs[env]["user1"]
+end
+
+def user2
+  api_envs[env]["user2"]
+end
+
+def user_with_public_api
+  api_envs[env]["user_with_public_api"]
+end
+
+def user_with_public_videos_access_only
+  api_envs[env]["user_with_public_videos_access_only"]
+end
+
+def test_video_id(account)
+  api_envs[env][account]["test_video_id"]
+end
+
+def user_ro
+end
+
+def conn_params(params={})
+  { application_token: params[:application_token],
+    login: params[:login],
+    server: server,
+    force_http: true }
+end
+
+def _api(params)
+  Vzaar::Api.new(conn_params(params))
+end
+
+def unauthenticated_api
+  _api(login: "unknown", application_token: "wrong")
+end
+
+def rand_str
+  (0...8).map { (65 + rand(26)).chr }.join
+end

data/examples/upload_thumbnail_spec.rb

@@ -0,0 +1,48 @@
+require_relative './spec_helper'
+
+describe "Upload Thumbnail" do
+  file_path = "./spec/support/pic.jpg"
+
+  context "when user is unauthenticated" do
+    it_behaves_like "Unauthenticated", -> (api) do
+      api.upload_thumbnail(test_video_id("user1"), path: file_path)
+    end
+  end
+
+  context "Authenticated User" do
+    context "RW token" do
+      before(:all) do
+        @api = _api(login: user1["login"],
+                    application_token: user1["rw_token"])
+      end
+
+      context "when params are valid" do
+        before(:all) do
+          @res = @api.upload_thumbnail(test_video_id("user1"), path: file_path)
+        end
+
+        it_behaves_like "202 Accepted"
+      end
+    end
+
+    context "RO token" do
+      it_behaves_like "RO only", user1["login"], user1["ro_token"], -> (api) do
+        api.upload_thumbnail(test_video_id("user1"), path: file_path)
+      end
+    end
+
+    context "when user doesn't have permission to the video" do
+      before(:all) do
+        api = _api(login: user1["login"],
+                    application_token: user1["rw_token"])
+        @res = api.upload_thumbnail(test_video_id("user2"), path: file_path)
+      end
+
+      it_behaves_like "422 Failure"
+
+      specify do
+        expect(@res.errors.first["user"]).to match(/Permission Denied/)
+      end
+    end
+  end
+end

data/examples/upload_video_spec.rb

@@ -0,0 +1,62 @@
+require_relative './spec_helper'
+
+describe "Upload Video" do
+
+  context "File uploads" do
+    file_path = "./spec/support/video.mov"
+    desc = "Upload Video/File Uploads"
+
+    context "Authenticated User" do
+      context "RW token" do
+        before(:all) do
+          api = _api(login: user1["login"],
+                     application_token: user1["rw_token"])
+
+          title = "api-test-#{rand_str}"
+          @res = api.upload_video(path: file_path, title: title, description: desc)
+        end
+
+        specify { expect(@res.http_status_code).to eq 201 }
+        specify { expect(@res.id.to_s).to match(/^[0-9]+$/) }
+      end
+
+      context "RO token" do
+        it_behaves_like "RO only", user1["login"], user1["ro_token"], -> (api) do
+          api.upload_video(path: file_path, description: desc)
+        end
+      end
+    end
+
+    context "when user is unauthenticated" do
+      it_behaves_like "Unauthenticated", -> (api) do
+        api.upload_video(path: file_path, title: "woof", description: desc)
+      end
+    end
+  end
+
+
+
+  context "Link uploads" do
+    desc = "Upload Video/Link Uploads"
+    file_url = "http://samples.mplayerhq.hu/MPEG-4/turn-on-off.mp4"
+
+    context "Authenticated User" do
+      before(:all) do
+        api = _api(login: user1["login"],
+                   application_token: user1["rw_token"])
+
+        title = "api-test-#{rand_str}"
+        @res = api.upload_video(url: file_url, title: title, description: desc)
+      end
+
+      specify { expect(@res.http_status_code).to eq 200 }
+      specify { expect(@res.id.to_s).to match(/^[0-9]+$/) }
+    end
+
+    context "when user is unauthenticated" do
+      it_behaves_like "Unauthenticated", -> (api) do
+        api.upload_video(url: file_url, title: "woof", description: desc)
+      end
+    end
+  end
+end

data/examples/user_details_spec.rb

@@ -0,0 +1,12 @@
+require_relative './spec_helper'
+
+describe "User Details" do
+  context "when user is unauthenticated" do
+    before(:all) do
+      api = unauthenticated_api()
+      @res = api.user_details(user1['login'])
+    end
+
+    it_behaves_like "200 OK"
+  end
+end

data/examples/video_details_spec.rb

@@ -0,0 +1,37 @@
+require_relative './spec_helper'
+
+describe "Video Details" do
+  context "Fully Protected API" do
+    it_behaves_like "Unauthenticated", -> (api) do
+      api.video_details(test_video_id("user1"))
+    end
+  end
+
+  context "Public API" do
+    before(:all) do
+      api = unauthenticated_api
+      @res = api.video_details(test_video_id("user_with_public_api"))
+    end
+
+    it_behaves_like "200 OK"
+  end
+
+  context "Protected API with access for public videos" do
+    scope = api_envs[env]["user_with_public_videos_access_only"]
+
+    context "when video is public" do
+      before do
+        api = unauthenticated_api
+        @res = api.video_details(scope["test_public_video_id"])
+      end
+
+      it_behaves_like "200 OK"
+    end
+
+    context "when video is private" do
+      it_behaves_like "Unauthenticated", -> (api) do
+        api.video_details(scope["test_video_id"])
+      end
+    end
+  end
+end

data/examples/video_list_spec.rb

@@ -0,0 +1,19 @@
+require_relative './spec_helper'
+
+describe "Video List" do
+  context "when user is unauthenticated" do
+    it_behaves_like "Unauthenticated", -> (api) do
+      api.video_list(user1["login"])
+    end
+
+
+    context "when Public API Feeds is enabled" do
+      before(:all) do
+        api = unauthenticated_api
+        @res = api.video_list(user_with_public_api["login"])
+      end
+
+      it_behaves_like "200 OK"
+    end
+  end
+end

data/lib/vzaar/api.rb

@@ -1,5 +1,8 @@
 module Vzaar
-  class Api < Struct.new(:conn)
+  class Api < Struct.new(:options)
+    def conn
+      @conn ||= Connection.new(options)
+    end
 
     def whoami(opts={})
       resource = Request::WhoAmI.new(conn, opts).execute

data/lib/vzaar/connection.rb

@@ -5,7 +5,7 @@ module Vzaar
     SERVER = "vzaar.com"
     attr_reader :application_token, :force_http, :login, :options
 
-    def initialize(options)
+    def initialize(options={})
       @options = options
       @application_token = options[:application_token]
       @force_http = options[:force_http]

data/lib/vzaar/resources/video_collection.rb

@@ -4,7 +4,7 @@ module Vzaar
       attr_reader :http_status_code
 
       def initialize(xml_body, status_code)
-        @http_status_code = status_code
+        @http_status_code = status_code.to_i
 
         doc = Nokogiri::XML(xml_body)
         doc.xpath("//videos/video").each do |xml|

data/lib/vzaar/version.rb

@@ -1,3 +1,3 @@
 module Vzaar
-  VERSION = "1.2.4"
+  VERSION = "1.3.0"
 end

data/spec/vzaar/api_xml_spec.rb

@@ -2,9 +2,7 @@ require 'spec_helper'
 
 module Vzaar
   describe Api do
-
-    subject { described_class.new connection }
-    let(:connection) { Connection.new options }
+    subject { described_class.new(options) }
 
     let(:application_token) { 'b0v8p14Ugpx5zMgDf6leUOxSt8pkcGCFyBcsh0ugHg' }
     let(:force_http) { false }
@@ -20,8 +18,6 @@ module Vzaar
       }
     end
 
-    specify { expect(subject.conn).to eq(connection) }
-
     describe "#whoami" do
       context "with valid credentials" do
         it "returns the user login" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vzaar
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.3.0
 platform: ruby
 authors:
 - Ed James
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-18 00:00:00.000000000 Z
+date: 2014-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -184,6 +184,20 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/account_details_spec.rb
+- examples/add_subtitle_spec.rb
+- examples/api_envs.yml.example
+- examples/authentication_spec.rb
+- examples/delete_video_spec.rb
+- examples/edit_video_spec.rb
+- examples/generate_thumbnail_spec.rb
+- examples/readme.md
+- examples/spec_helper.rb
+- examples/upload_thumbnail_spec.rb
+- examples/upload_video_spec.rb
+- examples/user_details_spec.rb
+- examples/video_details_spec.rb
+- examples/video_list_spec.rb
 - lib/vzaar.rb
 - lib/vzaar/api.rb
 - lib/vzaar/connection.rb
@@ -263,6 +277,7 @@ files:
 - spec/support/cfx.jpeg
 - spec/support/cfx.png
 - spec/support/pic.jpg
+- spec/support/video.mov
 - spec/support/video.mp4
 - spec/vzaar/api_xml_spec.rb
 - spec/vzaar/connection_spec.rb
@@ -297,7 +312,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: vzaar-1.2.4
+summary: vzaar-1.3.0
 test_files:
 - spec/fixtures/vcr_cassettes/account_type-fail.yml
 - spec/fixtures/vcr_cassettes/account_type-success.yml
@@ -337,6 +352,7 @@ test_files:
 - spec/support/cfx.jpeg
 - spec/support/cfx.png
 - spec/support/pic.jpg
+- spec/support/video.mov
 - spec/support/video.mp4
 - spec/vzaar/api_xml_spec.rb
 - spec/vzaar/connection_spec.rb