vzaar_api 2.0.0

data/examples/ingest_recipe/lookup_spec.rb

@@ -0,0 +1,35 @@
+require_relative './../spec_helper'
+
+module VzaarApi
+  describe 'Ingest recipe: Lookup' do
+
+    let(:described_class) { IngestRecipe }
+    let(:id) { api_envs['ingest_recipe']['default'] }
+
+    context 'when user is authenticated' do
+      before { setup_for :account_owner }
+
+      context 'and resource can be found' do
+        subject { described_class.find(id) }
+        specify { expect(subject.id).to eq id }
+      end
+
+      context 'and resource cannot be found' do
+        it 'raises an error' do
+          expect{ described_class.find(-1) }.to raise_error(
+            Error, 'Not found: Resource cannot be found')
+        end
+      end
+    end
+
+    context 'when user is not authenticated' do
+      before { setup_for :intruder }
+
+      it 'raises an error' do
+        expect{ described_class.find(id) }.to raise_error(
+          Error, 'Authentication failed: Invalid credentials')
+      end
+    end
+
+  end
+end

data/examples/playlist/create_update_delete_spec.rb

@@ -0,0 +1,97 @@
+require_relative './../spec_helper'
+
+module VzaarApi
+  describe 'Playlist: Create / Update / Delete' do
+
+    let(:described_class) { Playlist }
+
+    context 'when user is authenticated' do
+      before { setup_for :account_owner }
+
+      let(:attrs) { { title: 'new SDK playlist', category_id: api_envs['category_id'] } }
+
+      context "missing required parameters" do
+        it "errors out" do
+          expect{described_class.create}.to raise_error(
+            Error, "Invalid parameters: title is missing, category_id is missing"
+          )
+        end
+      end
+
+      it 'creates, updates and deletes a playlist' do
+        # create new playlist
+        playlist = described_class.create attrs
+        expect(playlist.title).to eq attrs[:title]
+        expect(playlist.category_id).to eq attrs[:category_id]
+        expect(playlist.max_vids).to eq 10
+        expect(playlist.sort_by).to eq 'created_at'
+        expect(playlist.sort_order).to eq 'desc'
+        expect(playlist.private).to be_truthy
+        expect(playlist.dimensions).to eq 'auto'
+        expect(playlist.position).to eq 'left'
+        expect(playlist.autoplay).to be_falsey
+        expect(playlist.continuous_play).to be_falsey
+        expect(playlist.embed_code).to match(
+          "<iframe id=\"vzpl-#{playlist.id}\" name=\"vzpl-#{playlist.id}\" " \
+          "title=\"vzaar video player\" class=\"vzaar video player\" " \
+          "type=\"text/html\" width=\"927\" height=\"432\" frameborder=\"0\" " \
+          "allowFullScreen allowTransparency=\"true\" mozallowfullscreen " \
+          "webkitAllowFullScreen src=\"//#{api_envs["vd_hostname"]}/playlists/#{playlist.id}\">" \
+          "</iframe>"
+        )
+
+        # reload the playlist
+        playlist = described_class.find(playlist.id)
+
+        # update the playlist
+        expect(playlist).not_to be_changed
+        new_title = playlist.title = "(updated): #{Time.now.utc}"
+        playlist.max_vids = 11
+        playlist.sort_by = 'title'
+        playlist.sort_order = 'asc'
+        playlist.private = false
+        playlist.dimensions = '400x200'
+        playlist.position = 'top'
+        playlist.autoplay = true
+        playlist.continuous_play = true
+
+        expect(playlist).to be_changed
+        playlist.save
+        expect(playlist).not_to be_changed
+
+        expect(playlist.title).to eq new_title
+        expect(playlist.max_vids).to eq 11
+        expect(playlist.sort_by).to eq 'title'
+        expect(playlist.sort_order).to eq 'asc'
+        expect(playlist.private).to be_falsey
+        expect(playlist.dimensions).to eq '400x200'
+        expect(playlist.position).to eq 'top'
+        expect(playlist.autoplay).to be_truthy
+        expect(playlist.continuous_play).to be_truthy
+        expect(playlist.embed_code).to match(
+          "<iframe id=\"vzpl-#{playlist.id}\" name=\"vzpl-#{playlist.id}\" " \
+          "title=\"vzaar video player\" class=\"vzaar video player\" " \
+          "type=\"text/html\" width=\"400\" height=\"330\" frameborder=\"0\" " \
+          "allowFullScreen allowTransparency=\"true\" mozallowfullscreen " \
+          "webkitAllowFullScreen src=\"//#{api_envs["vd_hostname"]}/playlists/#{playlist.id}\">" \
+          "</iframe>"
+        )
+
+        # delete the playlist
+        playlist.delete
+        expect{ described_class.find(playlist.id) }.to raise_error(
+          Error, 'Not found: Resource cannot be found')
+      end
+    end
+
+    context 'when user is not authenticated' do
+      before { setup_for :intruder }
+      let(:attrs) { { title: 'no', category_id: 2253 } }
+
+      it 'raises an error' do
+        expect{ described_class.create(attrs) }.to raise_error(
+          Error, 'Authentication failed: Invalid credentials')
+      end
+    end
+  end
+end

data/examples/playlist/list_spec.rb

@@ -0,0 +1,37 @@
+require_relative './../spec_helper'
+
+module VzaarApi
+  describe 'Playlist: List' do
+
+    let(:described_class) { Playlist }
+
+    context 'when user is authenticated' do
+      before { setup_for :account_owner }
+
+      describe '#each_item' do
+        it 'retrieves the resource list' do
+          ids = described_class.each_item.map(&:id)
+          expect(ids).not_to be_empty
+        end
+      end
+
+      describe '#paginate' do
+        let(:pager) { described_class.paginate(page: 2, per_page: 1) }
+        specify { expect(pager.first.count).to eq 1 }
+        specify { expect(pager.next.count).to eq 1 }
+        specify { expect(pager.previous.count).to eq 1 }
+        specify { expect(pager.last.count).to eq 1 }
+      end
+    end
+
+    context 'when user is not authenticated' do
+      before { setup_for :intruder }
+
+      it 'raises an error' do
+        pager = described_class.paginate
+        expect{ pager.first }.to raise_error(
+          Error, 'Authentication failed: Invalid credentials')
+      end
+    end
+  end
+end

data/examples/playlist/lookup_spec.rb

@@ -0,0 +1,34 @@
+require_relative './../spec_helper'
+
+module VzaarApi
+  describe 'Playlist: Lookup' do
+
+    let(:described_class) { Playlist }
+    let(:id) { api_envs['playlist_id'] }
+
+    context 'when user is authenticated' do
+      before { setup_for :account_owner }
+
+      context 'and resource can be found' do
+        subject { described_class.find(id) }
+        specify { expect(subject.id).to eq id }
+      end
+
+      context 'and resource cannot be found' do
+        it 'raises an error' do
+          expect{ described_class.find(-1) }.to raise_error(
+            Error, 'Not found: Resource cannot be found')
+        end
+      end
+    end
+
+    context 'when user is not authenticated' do
+      before { setup_for :intruder }
+
+      it 'raises an error' do
+        expect{ described_class.find(id) }.to raise_error(
+          Error, 'Authentication failed: Invalid credentials')
+      end
+    end
+  end
+end

data/examples/rate_limit_spec.rb

@@ -0,0 +1,18 @@
+require_relative './spec_helper'
+
+module VzaarApi
+  describe 'Rate limit' do
+
+    let(:described_class) { EncodingPreset }
+    let(:id) { api_envs['encoding_preset_id'] }
+
+    before { setup_for :account_owner }
+
+    it 'is available after each request' do
+      EncodingPreset.find(id)
+      expect(VzaarApi.rate_limit).to eq 200
+      expect(VzaarApi.rate_limit_remaining).to be < 200
+    end
+
+  end
+end

data/examples/spec_helper.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'vzaar_api'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["./examples/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |c|
+  c.include Helpers
+  c.order = 'defined'
+end
+
+VCR.configure do |c|
+  c.allow_http_connections_when_no_cassette = true
+end

data/examples/support/helpers.rb

@@ -0,0 +1,16 @@
+module Helpers
+
+  def api_envs
+    @api_envs = begin
+      env = ENV["API_ENV"] || "development"
+      YAML.load_file("api_envs.yml")[env]
+    end
+  end
+
+  def setup_for(user)
+    VzaarApi.hostname   = api_envs['hostname'] if api_envs['hostname']
+    VzaarApi.auth_token = api_envs[user.to_s]['auth_token']
+    VzaarApi.client_id  = api_envs[user.to_s]['client_id']
+  end
+
+end

data/examples/video/create_update_delete_spec.rb

@@ -0,0 +1,73 @@
+require_relative './../spec_helper'
+
+module VzaarApi
+  describe 'Video: Create' do
+
+    let(:described_class) { Video }
+
+    context 'when user is authenticated' do
+      before { setup_for :account_owner }
+
+      context 'when doing a single-part upload' do
+        it 'creates, updates and deletes the video' do
+          attrs = { title: "single: #{Time.now.utc}", path: 'examples/support/videos/small.mp4' }
+          video = described_class.create(attrs)
+          expect(video.title).to eq attrs[:title]
+
+          # reload the video
+          video = described_class.find(video.id)
+
+          # update the video
+          expect(video).not_to be_changed
+          video.title = "single (updated): #{Time.now.utc}"
+          video.description = 'this is the new description'
+          expect(video).to be_changed
+          video.save
+          expect(video).not_to be_changed
+
+          # delete the video
+          video.delete
+          expect{ described_class.find(video.id) }.to raise_error(
+            Error, 'Not found: Resource cannot be found')
+        end
+      end
+
+      context 'when doing a multi-part upload' do
+        it 'creates the video' do
+          attrs = { title: "multi-part: #{Time.now.utc}", path: 'examples/support/videos/medium.mp4' }
+          video = described_class.create(attrs)
+          expect(video.title).to eq attrs[:title]
+        end
+      end
+
+      context 'when doing a multi-part upload with a non-default ingest recipe' do
+        it 'creates the video' do
+          attrs = { title: "custom-recipe: #{Time.now.utc}",
+            ingest_recipe_id: api_envs['ingest_recipe']['other'],
+            path: 'examples/support/videos/medium.mp4' }
+          video = described_class.create(attrs)
+          expect(video.title).to eq attrs[:title]
+        end
+      end
+
+      context 'when doing a link upload' do
+        it 'creates the video' do
+          attrs = { title: "link: #{Time.now.utc}", url: 'https://www.dropbox.com/s/zu1n51dm9sabogq/dropbox-video.mp4?dl=0' }
+          video = described_class.create(attrs)
+          expect(video.title).to eq attrs[:title]
+        end
+      end
+    end
+
+    context 'when user is not authenticated' do
+      before { setup_for :intruder }
+
+      it 'raises an error' do
+        attrs = { path: 'examples/support/videos/small.mp4' }
+        expect{ described_class.create(attrs) }.to raise_error(
+          Error, 'Authentication failed: Invalid credentials')
+      end
+    end
+
+  end
+end

data/lib/vzaar_api/abstract.rb

@@ -0,0 +1,9 @@
+module VzaarApi
+  class Abstract
+
+    def initialize(attrs = {}); end
+
+    def update_from_attributes(attrs); end
+
+  end
+end

data/lib/vzaar_api/category.rb

@@ -0,0 +1,39 @@
+module VzaarApi
+  class Category < Abstract
+
+    ENDPOINT = 'categories'
+
+    ATTR_READERS = [:id, :account_id, :user_id, :name,
+                    :description, :parent_id, :depth,
+                    :node_children_count, :tree_children_count,
+                    :node_video_count, :tree_video_count,
+                    :created_at, :updated_at].freeze
+
+    ATTR_ACCESSORS = [:name, :parent_id, :move_to_root].freeze
+
+    prepend Lib::HasAttributes
+    include Lib::HasCollectionBuilder
+    include Lib::HasResourceUrl
+    include Lib::ActiveObject::Find
+    include Lib::ActiveObject::Save
+    include Lib::ActiveObject::Delete
+    include Lib::WillPaginate
+
+    def initialize(attrs = {})
+      update_from_attributes attrs
+    end
+
+    def self.create(attrs = {})
+      url = Lib::Api.resource_url(ENDPOINT)
+      new Lib::Api.new.post(url, attrs).data
+    end
+
+    def subtree(query = {})
+      args = query.merge(
+        resource_url: resource_url("#{id}/subtree"),
+        resource_class: self.class
+      )
+      Lib::PagedResource.new(args)
+    end
+  end
+end

data/lib/vzaar_api/encoding_preset.rb

@@ -0,0 +1,19 @@
+module VzaarApi
+  class EncodingPreset < Abstract
+
+    ENDPOINT = 'encoding_presets'
+
+    ATTR_READERS = [:id, :name, :description, :output_format,
+                    :bitrate_kbps, :long_dimension, :video_codec,
+                    :profile, :frame_rate_upper_threshold, :keyframe_upper_threshold,
+                    :audio_bitrate_kbps, :audio_channels, :audio_sample_rate,
+                    :max_bitrate_kbps, :created_at, :updated_at].freeze
+
+    prepend Lib::HasAttributes
+    include Lib::HasCollectionBuilder
+    include Lib::HasResourceUrl
+    include Lib::ActiveObject::Find
+    include Lib::WillPaginate
+
+  end
+end

data/lib/vzaar_api/ingest_recipe.rb

@@ -0,0 +1,35 @@
+module VzaarApi
+  class IngestRecipe < Abstract
+
+    ENDPOINT = 'ingest_recipes'
+
+    ATTR_READERS = [:id, :recipe_type, :account_id, :user_id,
+                    :created_at, :updated_at].freeze
+
+    ATTR_ACCESSORS = [:name, :description, :default, :multipass,
+                      :frame_grab_time, :encoding_preset_ids,
+                      :generate_animated_thumb, :generate_sprite,
+                      :use_watermark, :send_to_youtube,
+                      :encoding_presets].freeze
+
+    prepend Lib::HasAttributes
+    include Lib::HasResourceUrl
+    include Lib::ActiveObject::Find
+    include Lib::ActiveObject::Create
+    include Lib::ActiveObject::Save
+    include Lib::ActiveObject::Delete
+    include Lib::WillPaginate
+
+    def initialize(attrs = {})
+      update_from_attributes(attrs)
+    end
+
+    private
+
+    def update_from_attributes(attrs = {})
+      @encoding_presets = EncodingPreset.build(attrs[:encoding_presets])
+      @encoding_preset_ids = @encoding_presets.map(&:id)
+    end
+
+  end
+end

data/lib/vzaar_api/legacy_rendition.rb

@@ -0,0 +1,11 @@
+module VzaarApi
+  class LegacyRendition < Abstract
+
+    ATTR_READERS = [:id, :type, :width, :height, :bitrate,
+                    :status, :created_at, :updated_at].freeze
+
+    prepend Lib::HasAttributes
+    include Lib::HasCollectionBuilder
+
+  end
+end

data/lib/vzaar_api/lib/active_object.rb

@@ -0,0 +1,92 @@
+module VzaarApi
+  module Lib
+    module ActiveObject
+
+      module Find
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        module ClassMethods
+          def find(id)
+            response = Lib::Api.new.get(resource_url(id))
+            new response.data
+          end
+        end
+      end
+
+      module Create
+        def self.included(base)
+          base.extend(ClassMethods)
+        end
+
+        module ClassMethods
+          def create(attrs)
+            response = Lib::Api.new.post(resource_url, attrs)
+            new response.data
+          end
+        end
+      end
+
+      module Save
+        def self.included(base)
+          base.include(InstanceMethods)
+        end
+
+        module InstanceMethods
+          def save
+            if changed?
+              response = Lib::Api.new.patch(resource_url(id), changed_attributes)
+              update_from_attributes response.data
+              saved!
+            end
+            true
+          end
+
+          def changed?
+            !changes.empty?
+          end
+
+          def changed
+            changes.keys
+          end
+
+          def changed_attributes
+            {}.tap do |result|
+              changes.each do |attr, vals|
+                result[attr] = vals[1]
+              end
+            end
+          end
+
+          def changes
+            @changes ||= {}
+          end
+
+          def has_changed?(attr)
+            changed.include? attr.to_sym
+          end
+
+          def saved!
+            @changes = nil
+          end
+          private :saved!
+        end
+      end
+
+      module Delete
+        def self.included(base)
+          base.include(InstanceMethods)
+        end
+
+        module InstanceMethods
+          def delete
+            Lib::Api.new.delete(resource_url(id))
+            true
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/vzaar_api/lib/api.rb

@@ -0,0 +1,54 @@
+module VzaarApi
+  module Lib
+    class Api
+
+      def self.api_root_url
+        "#{VzaarApi.protocol}://#{VzaarApi.hostname}/api/v2"
+      end
+
+      def self.resource_url(resource, path = nil)
+        [api_root_url, resource, path].compact.join('/')
+      end
+
+      def delete(url)
+        handle_response http_client.delete(url, {}, headers)
+      end
+
+      def get(url, query = {})
+        handle_response http_client.get(url, query, headers)
+      end
+
+      def patch(url, body = {})
+        handle_response http_client.patch(url, body.to_json, headers)
+      end
+
+      def post(url, body = {})
+        handle_response http_client.post(url, body.to_json, headers)
+      end
+
+      def handle_response(response)
+        api_response = ApiResponse.new(response)
+        VzaarApi.rate_limit = api_response.rate_limit
+        VzaarApi.rate_limit_remaining = api_response.rate_limit_remaining
+        VzaarApi.rate_limit_reset = api_response.rate_limit_reset
+        return api_response if api_response.ok?
+        raise Error.new(api_response.error)
+      end
+
+      def http_client
+        HTTPClient.new.tap do |c|
+          c.ssl_config.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+      end
+
+      def headers
+        {
+          'X-Auth-Token' => VzaarApi.auth_token,
+          'X-Client-Id'  => VzaarApi.client_id,
+          'Content-Type' => 'application/json'
+        }
+      end
+
+    end
+  end
+end

data/lib/vzaar_api/lib/api_response.rb

@@ -0,0 +1,61 @@
+module VzaarApi
+  module Lib
+    class ApiResponse
+
+      attr_reader :response
+
+      def initialize(response)
+        @response = response
+      end
+
+      def data
+        json[:data]
+      end
+
+      def meta
+        json[:meta]
+      end
+
+      def error
+        simple_errors.join('; ')
+      end
+
+      def ok?
+        response.ok?
+      end
+
+      def rate_limit
+        rate_limit_value 'X-RateLimit-Limit'
+      end
+
+      def rate_limit_remaining
+        rate_limit_value 'X-RateLimit-Remaining'
+      end
+
+      def rate_limit_reset
+        rate_limit_value 'X-RateLimit-Reset'
+      end
+
+      private
+
+      def rate_limit_value(header)
+        if limit = response.headers[header]
+          limit.to_i
+        else
+          nil
+        end
+      end
+
+      def simple_errors
+        json[:errors].map { |e| [e[:message], e[:detail]].join(': ') }
+      end
+
+      def json
+        @json ||= JSON.parse(response.body, symbolize_names: true)
+      rescue JSON::ParserError
+        raise Error.new('Invalid JSON response from API')
+      end
+
+    end
+  end
+end