vzaar_api 2.0.0

data/spec/vzaar_api/signature/single_spec.rb

@@ -0,0 +1,72 @@
+module VzaarApi
+  module Signature
+    describe Single do
+
+      before do
+        setup_auth!
+      end
+
+      describe '#initialize' do
+        subject { described_class.new attrs }
+
+        let(:attrs) do
+          {
+            access_key_id: 'access_key_id',
+            acl: 'acl',
+            bucket: 'bucket',
+            content_type: 'content_type',
+            guid: 'guid',
+            key: 'key',
+            policy: 'policy',
+            signature: 'signature',
+            success_action_status: 'success_action_status',
+            upload_hostname: 'upload_hostname'
+          }
+        end
+
+        specify { expect(subject.access_key_id).to eq 'access_key_id' }
+        specify { expect(subject.acl).to eq 'acl' }
+        specify { expect(subject.bucket).to eq 'bucket' }
+        specify { expect(subject.content_type).to eq 'content_type' }
+        specify { expect(subject.guid).to eq 'guid' }
+        specify { expect(subject.key).to eq 'key' }
+        specify { expect(subject.policy).to eq 'policy' }
+        specify { expect(subject.signature).to eq 'signature' }
+        specify { expect(subject.success_action_status).to eq 'success_action_status' }
+        specify { expect(subject.upload_hostname).to eq 'upload_hostname' }
+      end
+
+      describe '#create' do
+        context 'when successful' do
+          it 'builds a signature' do
+            VCR.use_cassette('signature/single_201') do
+              attrs = { filename: 'video.mp4', filesize: 25165824, uploader: UPLOADER }
+              signature = described_class.create attrs
+              expect(signature.access_key_id).to eq 'access_key_id'
+              expect(signature.acl).to eq 'private'
+              expect(signature.bucket).to eq 'vzaar-upload-development'
+              expect(signature.content_type).to eq 'binary/octet-stream'
+              expect(signature.guid).to eq 'guid'
+              expect(signature.key).to eq 'vzaar/t8d/ec9/source/t8dec9434bcc64622b68d1dc16f3ddffap/${filename}'
+              expect(signature.policy).to eq 'policy'
+              expect(signature.signature).to eq 'signature'
+              expect(signature.success_action_status).to eq '201'
+              expect(signature.upload_hostname).to eq 'https://vzaar-upload-development.s3.amazonaws.com'
+            end
+          end
+        end
+
+        context 'when unsuccessful' do
+          it 'raises an error' do
+            VCR.use_cassette('signature/single_422') do
+              attrs = { filename: 'video.mp4' }
+              expect { described_class.create attrs }.
+                to raise_error(Error, 'Invalid parameters: uploader is missing')
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/spec/vzaar_api/upload/s3_spec.rb

@@ -0,0 +1,112 @@
+module VzaarApi
+  module Upload
+    describe S3 do
+
+      subject { described_class.new attrs, signature }
+
+      describe '#execute' do
+        context 'when multipart' do
+          let(:attrs) do
+            { path: 'spec/support/files/video-12.0MB.mp4', title: 'video-title' }
+          end
+
+          let(:signature_attrs) do
+            {
+              access_key_id: 'access_key_id',
+              key: 'vzaar/t22/063/source/t22063bd228834adc8b9c7d5fb320b2b3o/${filename}',
+              acl: 'private',
+              policy: 'policy',
+              signature: 'signature',
+              success_action_status: '201',
+              content_type: 'binary/octet-stream',
+              guid: 't22063bd228834adc8b9c7d5fb320b2b3o',
+              bucket: 'vzaar-upload-development',
+              upload_hostname: 'https://vzaar-upload-development.s3.amazonaws.com',
+              part_size: '5MB',
+              part_size_in_bytes: 5242880,
+              parts: 3
+            }
+          end
+
+          let(:signature) { Signature::Multipart.new signature_attrs.merge(signature_attrs) }
+
+          context 'when successful' do
+            let(:expected_result) do
+              { guid: 't22063bd228834adc8b9c7d5fb320b2b3o', title: 'video-title' }
+            end
+
+            it 'uploads the video file' do
+              VCR.use_cassette('upload/multipart_201') do
+                expect(subject.execute).to eq expected_result
+              end
+            end
+          end
+
+          context 'when unsuccessful' do
+            it 'handles an AWS 403 error' do
+              VCR.use_cassette('upload/multipart_403') do
+                expect { subject.execute }.to raise_error(
+                  Error, 'The AWS Access Key Id you provided does not exist in our records.')
+              end
+            end
+
+            it 'handles an unexpected error' do
+              allow(subject).to receive(:http_client).and_raise(SocketError, 'error message')
+              expect { subject.execute }.to raise_error(Error, 'error message')
+            end
+          end
+        end
+
+        context 'when single' do
+          let(:attrs) do
+            { path: 'spec/support/files/video-1.0MB.mp4', title: 'video-title' }
+          end
+
+          let(:signature_attrs) do
+            {
+              access_key_id: 'access_key_id',
+              key: "vzaar/t20/d72/source/t20d722afb9294989bda5f7cf01b11346v/${filename}",
+              acl: 'private',
+              policy: 'policy',
+              signature: 'signature',
+              success_action_status: "201",
+              content_type: "binary/octet-stream",
+              guid: "t20d722afb9294989bda5f7cf01b11346v",
+              bucket: "vzaar-upload-development",
+              upload_hostname: "https://vzaar-upload-development.s3.amazonaws.com"
+            }
+          end
+
+          let(:signature) { Signature::Single.new signature_attrs }
+
+          context 'when successful' do
+            let(:expected_result) do
+              { guid: 't20d722afb9294989bda5f7cf01b11346v', title: 'video-title' }
+            end
+
+            it 'uploads the video file' do
+              VCR.use_cassette('upload/single_201') do
+                expect(subject.execute).to eq expected_result
+              end
+            end
+          end
+
+          context 'when unsuccessful' do
+            it 'handles an AWS 403 error' do
+              VCR.use_cassette('upload/single_403') do
+                expect { subject.execute }.to raise_error(
+                  Error, 'The AWS Access Key Id you provided does not exist in our records.')
+              end
+            end
+
+            it 'handles an unexpected error' do
+              allow(subject).to receive(:http_client).and_raise(SocketError, 'error message')
+              expect { subject.execute }.to raise_error(Error, 'error message')
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/spec/vzaar_api/video_spec.rb

@@ -0,0 +1,248 @@
+module VzaarApi
+  describe Video do
+
+    before do
+      setup_auth!
+    end
+
+    describe '#initialize' do
+      subject { described_class.new attrs }
+
+      let(:attrs) do
+        {
+          id: 'id',
+          title: 'title',
+          user_id: 'user_id',
+          account_id: 'account_id',
+          description: 'description',
+          private: 'private',
+          seo_url: 'seo_url',
+          url: 'url',
+          thumbnail_url: 'thumbnail_url',
+          state: 'state',
+          categories: categories,
+          renditions: renditions,
+          created_at: 'created_at',
+          updated_at: 'updated_at',
+        }
+      end
+
+      let(:categories) do
+        [ { id: 'category-id' } ]
+      end
+
+      let(:renditions) do
+        [ { id: 'rendition-id' } ]
+      end
+
+      specify { expect(subject.id).to eq 'id' }
+      specify { expect(subject.title).to eq 'title' }
+      specify { expect(subject.user_id).to eq 'user_id' }
+      specify { expect(subject.account_id).to eq 'account_id' }
+      specify { expect(subject.description).to eq 'description' }
+      specify { expect(subject.private).to eq 'private' }
+      specify { expect(subject.seo_url).to eq 'seo_url' }
+      specify { expect(subject.url).to eq 'url' }
+      specify { expect(subject.thumbnail_url).to eq 'thumbnail_url' }
+      specify { expect(subject.state).to eq 'state' }
+      specify { expect(subject.categories.first.id).to eq 'category-id' }
+      specify { expect(subject.renditions.first.id).to eq 'rendition-id' }
+      specify { expect(subject.created_at).to eq 'created_at' }
+      specify { expect(subject.updated_at).to eq 'updated_at' }
+    end
+
+    describe 'description' do
+      let(:video) do
+        VCR.use_cassette('videos/find') do
+          described_class.find(7574982)
+        end
+      end
+
+      context 'when nothing has changed' do
+        let(:changed) { [] }
+        let(:changed_attributes) { {} }
+        let(:changes) { {} }
+
+        specify { expect(video).not_to be_changed }
+        specify { expect(video.changed).to match_array changed }
+        specify { expect(video.changed_attributes).to eq changed_attributes }
+        specify { expect(video.changes).to eq changes }
+      end
+
+      context 'when attributes have changed' do
+        before do
+          video.title = 'new-title'
+          video.description = 'new-desc'
+        end
+
+        let(:changed) { [:title, :description] }
+        let(:changed_attributes) { { title: 'new-title', description: 'new-desc'} }
+        let(:changes) { { title: %w(video-mp4 new-title), description: %w(description new-desc)} }
+
+        specify { expect(video).to be_changed }
+        specify { expect(video.changed).to match_array changed }
+        specify { expect(video.changed_attributes).to eq changed_attributes }
+        specify { expect(video.changes).to eq changes }
+      end
+    end
+
+    describe '.find' do
+      context 'when the video can be found' do
+        it 'finds the video' do
+          VCR.use_cassette('videos/find') do
+            video = described_class.find(7574982)
+            expect(video.id).to eq 7574982
+            expect(video.title).to eq 'video-mp4'
+            expect(video.user_id).to eq 79357
+            expect(video.account_id).to eq 79357
+            expect(video.description).to eq 'description'
+            expect(video.private).to eq false
+            expect(video.seo_url).to eq 'seo-url'
+            expect(video.url).to eq 'video-url'
+            expect(video.thumbnail_url).to eq 'https://view.vzaar.localhost/7574982/thumb'
+            expect(video.state).to eq 'ready'
+            expect(video.categories.count).to eq 2
+            expect(video.renditions.count).to eq 8
+            expect(video.legacy_renditions.count).to eq 8
+            expect(video.created_at).to eq '2016-12-01T17:27:12.000Z'
+            expect(video.updated_at).to eq '2017-01-30T12:49:41.000Z'
+          end
+        end
+      end
+
+      context 'when the video cannot be found' do
+        it 'raises an error' do
+          VCR.use_cassette('videos/find_404') do
+            expect { described_class.find(-1) }.
+              to raise_error(Error, 'Not found: Resource cannot be found')
+          end
+        end
+      end
+    end
+
+    describe '.create' do
+      context 'when we already have the guid' do
+        let(:attrs) do
+          { guid: 't8dec9434bcc64622b68d1dc16f3ddffap' }
+        end
+
+        context 'and a new video is created' do
+          it 'returns the new video' do
+            VCR.use_cassette('videos/create/guid_201') do
+              video = described_class.create(attrs)
+              expect(video.id).to eq 7574982
+            end
+          end
+        end
+
+        context 'and the video has already been created' do
+          it 'raises an error' do
+            VCR.use_cassette('videos/create/guid_error') do
+              expect { described_class.create attrs }.to raise_error(
+                Error, 'Invalid parameters: The provided guid already exists')
+            end
+          end
+        end
+      end
+
+      context 'when we have a file path' do
+        let(:attrs) do
+          { path: 'spec/support/files/video-1.0MB.mp4', title: 'video' }
+        end
+
+        context 'and a new video is created' do
+          it 'returns the new video' do
+            VCR.use_cassette('videos/create/path_201') do
+              video = described_class.create(attrs)
+              expect(video.id).to eq 7574827
+            end
+          end
+        end
+      end
+
+      context 'when we provide a url' do
+        let(:attrs) do
+          { url: 'http://example.com/video.mp4', uploader: UPLOADER }
+        end
+
+        context 'and a new video is created' do
+          it 'returns the new video' do
+            VCR.use_cassette('videos/create/link_201') do
+              video = described_class.create(attrs)
+              expect(video.id).to eq 7574826
+            end
+          end
+        end
+
+        context 'and invalid params are provided' do
+          it 'raises an error' do
+            VCR.use_cassette('videos/create/link_error') do
+              attrs.delete :uploader
+              expect { described_class.create attrs }.to raise_error(
+                Error, 'Invalid parameters: uploader is missing')
+            end
+          end
+        end
+      end
+
+      context 'when invalid params are provided' do
+        it 'raises an error' do
+          expect { described_class.create }.to raise_error(
+            Error, 'Invalid parameters: Expected one of :guid, :path, :url')
+        end
+      end
+    end
+
+    describe '#delete' do
+      context 'when video is deleted successfully' do
+        it 'returns true' do
+          VCR.use_cassette('videos/delete_204') do
+            video = described_class.find(7574985)
+            expect(video.delete).to eq true
+            expect { described_class.find(7574985) }.
+              to raise_error(Error, 'Not found: Resource cannot be found')
+          end
+        end
+      end
+    end
+
+    describe '.paginate' do
+      it 'loads the video collection' do
+        VCR.use_cassette('videos/paginate_first') do
+          pager = described_class.paginate(per_page: 3)
+          pager.first
+          ids = pager.collection.map { |video| video.id }
+          expect(ids).to match_array [7574851, 7574852, 7574853]
+        end
+      end
+
+      it 'loads the video collection' do
+        VCR.use_cassette('videos/paginate_next') do
+          pager = described_class.paginate(per_page: 3)
+          pager.next
+          ids = pager.collection.map { |video| video.id }
+          expect(ids).to match_array [7574848, 7574849, 7574850]
+        end
+      end
+
+      it 'loads the video collection' do
+        VCR.use_cassette('videos/paginate_last') do
+          pager = described_class.paginate(per_page: 3)
+          pager.last
+          ids = pager.collection.map { |video| video.id }
+          expect(ids).to match_array [927938, 935900]
+        end
+      end
+
+      it 'loads the video collection' do
+        VCR.use_cassette('videos/paginate_previous') do
+          pager = described_class.paginate(page: 4, per_page: 3)
+          pager.previous
+          ids = pager.collection.map { |video| video.id }
+          expect(ids).to match_array [7574844, 7574845, 7574847]
+        end
+      end
+    end
+
+  end
+end

data/spec/vzaar_api/vzaar_api_spec.rb

@@ -0,0 +1,18 @@
+describe VzaarApi do
+
+  before do
+    VzaarApi.auth_token = auth_token
+    VzaarApi.client_id = client_id
+    VzaarApi.hostname = hostname
+  end
+
+  let(:auth_token) { 'auth-token' }
+  let(:client_id) { 'client-id' }
+  let(:hostname) { 'app.vzaar.localhost' }
+
+  specify { expect(VzaarApi.auth_token).to eq auth_token }
+  specify { expect(VzaarApi.client_id).to eq client_id }
+  specify { expect(VzaarApi.hostname).to eq hostname }
+  specify { expect(VzaarApi.protocol).to eq 'https' }
+
+end

data/spec/vzaar_api_helper.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'vzaar_api'
+require 'vcr'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["./spec/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |c|
+  c.include Helpers
+end
+
+VCR.configure do |c|
+  c.default_cassette_options = { :match_requests_on => [:uri, :method] }
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.hook_into :webmock
+end

data/vzaar_api.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+require File.expand_path('../lib/vzaar_api/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'vzaar_api'
+  s.version     = VzaarApi::VERSION
+  s.authors     = ['vzaar']
+  s.email       = ['support@vzaar.com']
+  s.description = 'A Ruby gem for the vzaar API v2'
+  s.summary     = "vzaar-#{s.version}"
+  s.homepage    = 'http://vzaar.com'
+  s.license     = 'MIT'
+
+  s.platform              = Gem::Platform::RUBY
+  s.required_ruby_version = '>= 2.0'
+  s.rubygems_version      = ">= 2.5"
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(spec)/})
+  s.require_paths = ['lib']
+
+  s.add_dependency 'httpclient', '~> 2.8'
+  s.add_dependency 'request_store', '~> 1.3'
+
+  s.add_development_dependency 'bundler', '~> 1.3'
+  s.add_development_dependency 'fuubar', '~> 2.2'
+  s.add_development_dependency 'rake', '~> 10.5'
+  s.add_development_dependency 'growl', '~> 1.0'
+  s.add_development_dependency 'guard-rspec', '~> 4.6'
+  s.add_development_dependency 'pry-byebug', '~> 3.4'
+  s.add_development_dependency 'rspec', '~> 3.1'
+  s.add_development_dependency 'vcr', '~> 3.0'
+  s.add_development_dependency 'webmock', '~> 2.1'
+end