vzaar_api 2.0.0

data/lib/vzaar_api/lib/has_attributes.rb

@@ -0,0 +1,49 @@
+module VzaarApi
+  module Lib
+    module HasAttributes
+
+      def self.prepended(klass)
+        klass::ATTR_READERS.each do |attr|
+          klass.send :attr_reader, attr
+        end
+
+        unless defined? klass::ATTR_ACCESSORS
+          klass.const_set 'ATTR_ACCESSORS', [].freeze
+        end
+
+        klass::ATTR_ACCESSORS.each do |attr|
+          klass.send :attr_accessor, attr
+
+          klass.send(:define_method, "#{attr}=") do |val|
+            if self.changes[attr]
+              self.changes[attr][1] = val
+            else
+              self.changes[attr] = [self.send(attr), val]
+            end
+            val
+          end
+        end
+      end
+
+      def initialize(attrs = {})
+        self.class::ATTR_READERS.each do |attr|
+          instance_variable_set("@#{attr}", attrs[attr])
+        end
+        self.class::ATTR_ACCESSORS.each do |attr|
+          instance_variable_set("@#{attr}", attrs[attr])
+        end
+        super
+      end
+
+      private
+
+      def update_from_attributes(attrs = {})
+        attrs.each do |attr, val|
+          instance_variable_set("@#{attr}", attrs[attr])
+        end
+        super
+      end
+
+    end
+  end
+end

data/lib/vzaar_api/lib/has_collection_builder.rb

@@ -0,0 +1,17 @@
+module VzaarApi
+  module Lib
+    module HasCollectionBuilder
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def build(data = [])
+          Array(data).map { |attrs| new attrs }
+        end
+      end
+
+    end
+  end
+end

data/lib/vzaar_api/lib/has_resource_url.rb

@@ -0,0 +1,24 @@
+module VzaarApi
+  module Lib
+    module HasResourceUrl
+
+      def self.included(base)
+        base.include(InstanceMethods)
+        base.extend(ClassMethods)
+      end
+
+      module InstanceMethods
+        def resource_url(path = nil)
+          self.class.resource_url(path)
+        end
+      end
+
+      module ClassMethods
+        def resource_url(path = nil)
+          Api.resource_url self::ENDPOINT, path
+        end
+      end
+
+    end
+  end
+end

data/lib/vzaar_api/lib/paged_resource.rb

@@ -0,0 +1,80 @@
+module VzaarApi
+  module Lib
+    class PagedResource
+
+      attr_reader :query, :meta, :collection, :resource_class, :resource_url
+
+      def initialize(query = {})
+        @query = query.dup
+        @resource_class = @query.delete(:resource_class)
+        @resource_url = @query.delete(:resource_url)
+        @loaded = false
+      end
+
+      def loaded?
+        @loaded
+      end
+
+      def each_item
+        return enum_for :each_item unless block_given?
+        begin
+          each { |record| yield record }
+        end while !self.next.empty?
+      end
+
+      def first
+        loaded? ? load_page_url(:first) : load!
+      end
+
+      def next
+        load_page_url :next
+      end
+
+      def previous
+        load_page_url :previous
+      end
+
+      def last
+        load_page_url :last
+      end
+
+      private
+
+      def load!
+        @loaded = true
+        load_from_url resource_url, query
+      end
+
+      def load_page_url(page)
+        load! unless loaded?
+        if url = meta_link(page)
+          load_from_url meta[:links][page]
+        else
+          []
+        end
+      end
+
+      def meta_link(page)
+        return unless meta
+        meta[:links][page]
+      end
+
+      def each
+        return enum_for :each unless block_given?
+        load! unless collection
+        collection.each { |record| yield record }
+      end
+
+      def load_from_url(url, query = {})
+        response = Api.new.get(url, query)
+        @meta = response.meta
+        @collection = build_collection response.data
+      end
+
+      def build_collection(items)
+        items.map { |attrs| resource_class.new attrs }
+      end
+
+    end
+  end
+end

data/lib/vzaar_api/lib/will_paginate.rb

@@ -0,0 +1,22 @@
+module VzaarApi
+  module Lib
+    module WillPaginate
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def each_item(query = {}, &block)
+          paginate(query).each_item(&block)
+        end
+
+        def paginate(query = {})
+          args = query.merge({ resource_url: resource_url, resource_class: self })
+          Lib::PagedResource.new(args)
+        end
+      end
+
+    end
+  end
+end

data/lib/vzaar_api/link_upload.rb

@@ -0,0 +1,14 @@
+module VzaarApi
+  module LinkUpload
+
+    include Lib::HasResourceUrl
+
+    ENDPOINT = 'link_uploads'
+
+    def self.create(attrs = {})
+      attrs[:uploader] = UPLOADER
+      Video.new Lib::Api.new.post(resource_url, attrs).data
+    end
+
+  end
+end

data/lib/vzaar_api/playlist.rb

@@ -0,0 +1,29 @@
+module VzaarApi
+  class Playlist < Abstract
+
+    ENDPOINT = 'feeds/playlists'
+
+    ATTR_READERS = %i(
+      id title sort_order sort_by autoplay continuous_play category_id
+      embed_code created_at updated_at
+    ).freeze
+
+    ATTR_ACCESSORS = %i(
+      category_id title sort_by sort_order private dimensions max_vids
+      position autoplay continuous_play max_vids
+    ).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 self.create(attrs = {})
+      url = Lib::Api.resource_url(ENDPOINT)
+      new Lib::Api.new.post(url, attrs).data
+    end
+  end
+end

data/lib/vzaar_api/rendition.rb

@@ -0,0 +1,16 @@
+module VzaarApi
+  class Rendition < Abstract
+
+    ATTR_READERS = [:audio_bitrate_kbps, :audio_channels,
+                    :audio_sample_rate, :bitrate_kbps,
+                    :encoding_preset_id, :error_message,
+                    :frame_rate, :height, :id, :keyframe,
+                    :name, :output_format, :profile, :size_in_bytes,
+                    :source_as_rendition, :state, :video_codec, :width,
+                    :created_at, :updated_at].freeze
+
+    prepend Lib::HasAttributes
+    include Lib::HasCollectionBuilder
+
+  end
+end

data/lib/vzaar_api/signature/abstract.rb

@@ -0,0 +1,40 @@
+module VzaarApi
+  module Signature
+    class Abstract
+
+      include Lib::HasResourceUrl
+
+      attr_reader :access_key_id, :acl, :bucket, :content_type,
+        :guid, :key, :policy, :signature, :success_action_status,
+        :upload_hostname
+
+      def initialize(attrs = {})
+        @access_key_id = attrs[:access_key_id]
+        @acl = attrs[:acl]
+        @bucket = attrs[:bucket]
+        @content_type = attrs[:content_type]
+        @guid = attrs[:guid]
+        @key = attrs[:key]
+        @policy = attrs[:policy]
+        @signature = attrs[:signature]
+        @success_action_status = attrs[:success_action_status]
+        @upload_hostname = attrs[:upload_hostname]
+        after_initialize(attrs)
+      end
+
+      def after_initialize(attrs = {})
+        raise Error.new('Cannot call #after_initialize on Signature::Abstract')
+      end
+
+      def multipart?
+        raise Error.new('Cannot call #multipart? on Signature::Abstract')
+      end
+
+      def self.create(attrs = {})
+        attrs[:uploader] = UPLOADER
+        new Lib::Api.new.post(resource_url, attrs).data
+      end
+
+    end
+  end
+end

data/lib/vzaar_api/signature/factory.rb

@@ -0,0 +1,39 @@
+module VzaarApi
+  module Signature
+    class Factory
+
+      # 5MB is min size required for multipart upload
+      MIN_S3_MULTIPART_FILE_SIZE = 5 * (1024 ** 2)
+
+      attr_reader :attrs, :path
+
+      def initialize(attrs)
+        @attrs = attrs
+        @path = attrs.fetch(:path)
+      end
+
+      def self.create(attrs)
+        new(attrs).create
+      end
+
+      def create
+        klass = multipart? ? Multipart : Single
+        klass.create(multipart_attrs)
+      end
+
+      def multipart?
+        multipart_attrs[:filesize].to_i >= MIN_S3_MULTIPART_FILE_SIZE
+      end
+
+      def multipart_attrs
+        {
+          filesize: File::Stat.new(path).size,
+          filename: File.basename(path)
+        }
+      rescue Errno::ENOENT
+        raise Error.new 'Invalid parameters: path is invalid'
+      end
+
+    end
+  end
+end

data/lib/vzaar_api/signature/multipart.rb

@@ -0,0 +1,23 @@
+module VzaarApi
+  module Signature
+    class Multipart < Abstract
+
+      include Lib::HasResourceUrl
+
+      ENDPOINT = 'signature/multipart'
+
+      attr_reader :upload_hostname, :part_size, :part_size_in_bytes, :parts
+
+      def after_initialize(attrs = {})
+        @part_size = attrs[:part_size]
+        @part_size_in_bytes = attrs[:part_size_in_bytes]
+        @parts = attrs[:parts]
+      end
+
+      def multipart?
+        true
+      end
+
+    end
+  end
+end

data/lib/vzaar_api/signature/single.rb

@@ -0,0 +1,17 @@
+module VzaarApi
+  module Signature
+    class Single < Abstract
+
+      ENDPOINT = 'signature/single'
+
+      def after_initialize(attrs = {})
+        # no-op in this class
+      end
+
+      def multipart?
+        false
+      end
+
+    end
+  end
+end

data/lib/vzaar_api/strategy/video/create.rb

@@ -0,0 +1,46 @@
+module VzaarApi
+  module Strategy
+    module Video
+      class Create
+
+        attr_reader :attrs, :video_class
+
+        def initialize(attrs, video_class)
+          @attrs = attrs
+          @video_class = video_class
+        end
+
+        def execute
+          case
+          when attrs.has_key?(:guid)
+            create_from_guid
+          when attrs.has_key?(:path)
+            create_from_path
+          when attrs.has_key?(:url)
+            create_from_url
+          else
+            raise Error.new('Invalid parameters: Expected one of :guid, :path, :url')
+          end
+        end
+
+        private
+
+        def create_from_guid
+          url = Lib::Api.resource_url video_class::ENDPOINT
+          video_class.new Lib::Api.new.post(url, attrs).data
+        end
+
+        def create_from_path
+          signature = Signature::Factory.create(attrs)
+          upload_attrs = Upload::S3.new(attrs, signature).execute
+          video_class.create upload_attrs
+        end
+
+        def create_from_url
+          LinkUpload.create(attrs.merge({ uploader: UPLOADER }))
+        end
+
+      end
+    end
+  end
+end

data/lib/vzaar_api/upload/s3.rb

@@ -0,0 +1,90 @@
+module VzaarApi
+  module Upload
+    class S3
+      extend Forwardable
+
+      SEND_TIMEOUT = 1800
+
+      attr_reader :attrs, :path, :signature
+
+      def_delegators :@signature, :access_key_id, :acl, :bucket,
+        :guid, :key, :multipart?, :part_size_in_bytes, :policy,
+        :success_action_status, :upload_hostname
+
+      def initialize(attrs, signature)
+        @attrs = attrs.dup
+        @path = @attrs.delete(:path)
+        @signature = signature
+      end
+
+      def execute
+        if multipart?
+          multipart_upload
+        else
+          single_part_upload
+        end
+        attrs.merge({ guid: guid })
+      end
+
+      private
+
+      def multipart_upload
+        _headers = headers.dup
+        chunk = 0
+        File.open(path, "r") do |file|
+          until file.eof?
+            _headers['key'] = "#{key}.#{chunk}"
+            _headers['file'] = VirtualFile.new(file, part_size_in_bytes)
+            validate_response! upload_file(_headers)
+            chunk += 1
+          end
+        end
+      rescue => e
+        raise Error.new(e.message)
+      end
+
+      def single_part_upload
+        File.open(path, "r") do |file|
+          _headers = headers.dup
+          _headers['key'] = key
+          _headers['file'] = file
+          validate_response! upload_file(_headers)
+        end
+      rescue => e
+        raise Error.new(e.message)
+      end
+
+      def upload_file(headers)
+        http_client.post upload_hostname, headers
+      end
+
+      def headers
+        @headers ||= {
+          'acl' => acl,
+          'bucket' => bucket,
+          'success_action_status' => success_action_status,
+          'policy' => policy,
+          'AWSAccessKeyId' => access_key_id,
+          'signature' => signature.signature,
+          'x-amz-meta-uploader' => UPLOADER
+        }
+      end
+
+      def http_client
+        @http_client ||= begin
+          HTTPClient.new.tap { |c| c.send_timeout = SEND_TIMEOUT }
+        end
+      end
+
+      def validate_response!(response)
+        return if response.ok?
+        raise error_message(response.body)
+      end
+
+      def error_message(body)
+        /Message\>(.+)\<\/Message/.match(body)[1]
+      end
+
+    end
+  end
+end

data/lib/vzaar_api/upload/virtual_file.rb

@@ -0,0 +1,14 @@
+module VzaarApi
+  module Upload
+    class VirtualFile < StringIO
+
+      attr_reader :path
+
+      def initialize(file, chunk_size)
+        @path = File.basename file.path
+        super file.read(chunk_size)
+      end
+
+    end
+  end
+end

data/lib/vzaar_api/version.rb

@@ -0,0 +1,4 @@
+module VzaarApi
+  VERSION  = '2.0.0'
+  UPLOADER = 'Ruby-2.0.0'
+end

data/lib/vzaar_api/video.rb

@@ -0,0 +1,38 @@
+module VzaarApi
+  class Video < Abstract
+
+    ENDPOINT = 'videos'
+
+    ATTR_READERS = [:id, :user_id, :account_id, :categories,
+                    :renditions, :legacy_renditions, :url,
+                    :thumbnail_url, :state,
+                    :created_at, :updated_at].freeze
+
+    ATTR_ACCESSORS = [:category_ids, :description, :private, :seo_url, :title].freeze
+
+    prepend Lib::HasAttributes
+    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 = {})
+      Strategy::Video::Create.new(attrs, self).execute
+    end
+
+    private
+
+    def update_from_attributes(attrs)
+      @categories = Category.build(attrs[:categories])
+      @category_ids = @categories.map(&:id)
+      @renditions = Rendition.build(attrs[:renditions])
+      @legacy_renditions = LegacyRendition.build(attrs[:renditions])
+    end
+
+  end
+end

data/lib/vzaar_api.rb

@@ -0,0 +1,60 @@
+$: << File.dirname(__FILE__)
+
+require 'forwardable'
+require 'httpclient'
+require 'json'
+
+require 'vzaar_api/version'
+
+require 'vzaar_api/lib/api'
+require 'vzaar_api/lib/api_response'
+require 'vzaar_api/lib/active_object'
+require 'vzaar_api/lib/has_attributes'
+require 'vzaar_api/lib/has_collection_builder'
+require 'vzaar_api/lib/has_resource_url'
+require 'vzaar_api/lib/paged_resource'
+require 'vzaar_api/lib/will_paginate'
+
+require 'vzaar_api/abstract'
+require 'vzaar_api/category'
+require 'vzaar_api/encoding_preset'
+require 'vzaar_api/ingest_recipe'
+require 'vzaar_api/legacy_rendition'
+require 'vzaar_api/link_upload'
+require 'vzaar_api/playlist'
+require 'vzaar_api/rendition'
+require 'vzaar_api/strategy/video/create'
+require 'vzaar_api/video'
+
+require 'vzaar_api/signature/abstract'
+require 'vzaar_api/signature/factory'
+require 'vzaar_api/signature/multipart'
+require 'vzaar_api/signature/single'
+
+require 'vzaar_api/upload/s3'
+require 'vzaar_api/upload/virtual_file'
+
+module VzaarApi
+  class Error < StandardError ; end
+
+  DEFAULT_HOSTNAME = 'api.vzaar.com'
+  DEFAULT_PROTOCOL = 'https'
+
+  class << self
+    attr_accessor :auth_token, :client_id, :hostname,
+      :rate_limit, :rate_limit_remaining, :rate_limit_reset
+
+    def hostname
+      @hostname || DEFAULT_HOSTNAME
+    end
+
+    def protocol
+      @protocol || DEFAULT_PROTOCOL
+    end
+
+    def protocol=(value)
+      @protocol = value.downcase == 'https' ? 'https' : 'http'
+    end
+  end
+
+end