vzaar_api 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a66c41aa22b7ac34c00d55f887bd51e67f477326
-  data.tar.gz: aabba334cffe595e17690a893a0eabc8a5a0dc3f
+SHA256:
+  metadata.gz: 8b2a8bb6c3c1e32cf3a7fecd0d5323fc1fba1972a774b6502aadd1c00352aeb0
+  data.tar.gz: f34001576b71d42580328f96d3c0623df78ad150b9ab3cd98f5d7d63030dd892
 SHA512:
-  metadata.gz: 8d39461adbe0756c34809fb76ca493fb1686d74ab3f4910c2cbfdb1340fc38255b5647f4d91c1cb10cdcd956e82146003f307659ec59ca7c4df97b1ad5d09c15
-  data.tar.gz: 4159a4a63fa90ef7f28306bd045fe6dda90828ee137bc2eaa7265cb158dc0e33870d5dc3b5245d273f2378dc39076a148f1732b28966945be56ec8fb37e4af71
+  metadata.gz: 482edfd45da157a5aec9acc3a8d1b71cc40c825ee1a5417198c29d9ce8a0b40cd0051dea5d257307046794fb774b7ce8b3b60d72dc98b6dcbba04b31b52f2f62
+  data.tar.gz: 6b7293a4df35e0850ea3237fc79136887d69a8301b22975ff0f41ce9384bf66944285f6500a637774db98ee4ef500e137b074e57987e02ca04c5cfa73ce2bc5f

data/.gitignore

@@ -11,3 +11,5 @@ test*.rb
 .ruby-gemset
 .ruby-version
 tags
+.#*
+*mp4

data/README.md

@@ -15,7 +15,7 @@ Ruby 2.2+
 ## Installation
 
 ```
-gem install vzaar --version
+gem install vzaar_api
 ```
 
 
@@ -39,7 +39,7 @@ VzaarApi.auth_token = '<your-auth-token>'
 VzaarApi.client_id  = '<your-client-id>'
 ```
 
-Usage instructions and examples are available on [vzaar's documentation site](https://vzaar.readme.io).
+Usage instructions and examples are available on [vzaar's documentation site](https://developer.vzaar.com).
 
 
 ## Contributing

data/lib/vzaar_api/abstract.rb

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

data/lib/vzaar_api/lib/active_object.rb

@@ -22,8 +22,9 @@ module VzaarApi
 
         module ClassMethods
           def create(attrs)
-            response = Lib::Api.new.post(resource_url, attrs)
-            new response.data
+            scope_id = attrs.delete :scope_id
+            response = Lib::Api.new.post(resource_url(nil, scope_id), attrs)
+            new response.data.merge(scope_id: scope_id)
           end
         end
       end
@@ -36,7 +37,11 @@ module VzaarApi
         module InstanceMethods
           def save
             if changed?
-              response = Lib::Api.new.patch(resource_url(id), changed_attributes)
+              response = Lib::Api.new.patch(
+                resource_url(id, scope_id),
+                changed_attributes
+              )
+
               update_from_attributes response.data
               saved!
             end
@@ -81,7 +86,7 @@ module VzaarApi
 
         module InstanceMethods
           def delete
-            Lib::Api.new.delete(resource_url(id))
+            Lib::Api.new.delete(resource_url(id, scope_id))
             true
           end
         end

data/lib/vzaar_api/lib/api.rb

@@ -23,7 +23,8 @@ module VzaarApi
       end
 
       def post(url, body = {})
-        handle_response http_client.post(url, body.to_json, headers)
+        args = block_given? ? yield(body, headers) : [body.to_json, headers]
+        handle_response http_client.post url, *args
       end
 
       def handle_response(response)

data/lib/vzaar_api/lib/has_resource_url.rb

@@ -8,14 +8,17 @@ module VzaarApi
       end
 
       module InstanceMethods
-        def resource_url(path = nil)
-          self.class.resource_url(path)
+        def resource_url(path = nil, scope_id = nil)
+          self.class.resource_url(path, scope_id)
         end
       end
 
       module ClassMethods
-        def resource_url(path = nil)
-          Api.resource_url self::ENDPOINT, path
+        def resource_url(path=nil, scope_id=nil)
+          ep = self::ENDPOINT
+          args = ep.is_a?(Proc) ? [ep.call(scope_id, path), nil] : [ep, path]
+
+          Api.resource_url *args
         end
       end
 

data/lib/vzaar_api/lib/paged_resource.rb

@@ -2,12 +2,14 @@ module VzaarApi
   module Lib
     class PagedResource
 
-      attr_reader :query, :meta, :collection, :resource_class, :resource_url
+      attr_reader :query, :meta, :collection, :resource_class, :resource_url,
+                  :scope_id
 
       def initialize(query = {})
         @query = query.dup
         @resource_class = @query.delete(:resource_class)
         @resource_url = @query.delete(:resource_url)
+        @scope_id = @query.delete(:scope_id)
         @loaded = false
       end
 
@@ -72,7 +74,10 @@ module VzaarApi
       end
 
       def build_collection(items)
-        items.map { |attrs| resource_class.new attrs }
+        items.map do |attrs|
+          attrs = scope_id ? attrs.merge(scope_id: scope_id) : attrs
+          resource_class.new attrs
+        end
       end
 
     end

data/lib/vzaar_api/lib/will_paginate.rb

@@ -12,7 +12,11 @@ module VzaarApi
         end
 
         def paginate(query = {})
-          args = query.merge({ resource_url: resource_url, resource_class: self })
+          args = query.merge(
+            resource_url: resource_url(nil, query[:scope_id]),
+            resource_class: self
+          )
+
           Lib::PagedResource.new(args)
         end
       end

data/lib/vzaar_api/playlist.rb

@@ -10,7 +10,7 @@ module VzaarApi
 
     ATTR_ACCESSORS = %i(
       category_id title sort_by sort_order private dimensions max_vids
-      position autoplay continuous_play max_vids
+      position autoplay continuous_play max_vids video_ids
     ).freeze
 
     prepend Lib::HasAttributes

data/lib/vzaar_api/signature/abstract.rb

@@ -5,20 +5,27 @@ module VzaarApi
       include Lib::HasResourceUrl
 
       attr_reader :access_key_id, :acl, :bucket, :content_type,
-        :guid, :key, :policy, :signature, :success_action_status,
-        :upload_hostname
+        :guid, :key, :policy, :success_action_status,
+        :upload_hostname, :x_amz_headers
+
+      X_AMZ_HEADERS = [
+        "x-amz-credential",
+        "x-amz-algorithm",
+        "x-amz-date",
+        "x-amz-signature"
+      ]
+
 
       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]
+        @x_amz_headers = build_x_amz_headers(attrs)
         after_initialize(attrs)
       end
 
@@ -35,6 +42,12 @@ module VzaarApi
         new Lib::Api.new.post(resource_url, attrs).data
       end
 
+      def build_x_amz_headers(attrs)
+        X_AMZ_HEADERS.reduce({}) do |col, key|
+          col[key] = attrs[key.to_sym]
+          col
+        end
+      end
     end
   end
 end

data/lib/vzaar_api/signature/multipart.rb

@@ -4,7 +4,7 @@ module VzaarApi
 
       include Lib::HasResourceUrl
 
-      ENDPOINT = 'signature/multipart'
+      ENDPOINT = 'signature/multipart/2'
 
       attr_reader :upload_hostname, :part_size, :part_size_in_bytes, :parts
 

data/lib/vzaar_api/signature/single.rb

@@ -2,7 +2,7 @@ module VzaarApi
   module Signature
     class Single < Abstract
 
-      ENDPOINT = 'signature/single'
+      ENDPOINT = 'signature/single/2'
 
       def after_initialize(attrs = {})
         # no-op in this class

data/lib/vzaar_api/strategy/image/abstract.rb

@@ -0,0 +1,25 @@
+module VzaarApi
+  module Strategy
+    module Image
+      class Abstract
+
+        attr_reader :video_id, :attrs, :video_class
+
+        def initialize(video_id, attrs, video_class)
+          @attrs = attrs
+          @video_id = video_id
+          @video_class = video_class
+        end
+
+        def execute
+          raise 'not implemented'
+        end
+
+        def url
+          path = File.join(video_class::ENDPOINT, video_id.to_s, "image")
+          Lib::Api.resource_url path
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module VzaarApi
+  module Strategy
+    module Image
+      class Create < Abstract
+        def execute
+          path = attrs[:path]
+          raise Error.new('Invalid parameters: path is missing') unless path
+
+          File.open(path, "r") do |file|
+            res = Lib::Api.new.post(url, image: file) do |body, headers|
+              headers.delete('Content-Type')
+              [body, headers]
+            end
+
+            video_class.new res.data
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vzaar_api/strategy/image/update.rb

@@ -0,0 +1,11 @@
+module VzaarApi
+  module Strategy
+    module Image
+      class Update < Abstract
+        def execute
+          video_class.new Lib::Api.new.patch(url, attrs).data
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+module VzaarApi
+  module Strategy
+    module Subtitle
+      class Create
+        attr_reader :video_id, :attrs, :klass
+
+        def initialize(video_id, attrs, klass)
+          @attrs = attrs
+          @video_id = video_id
+          @klass = klass
+        end
+
+        def execute
+          res = attrs[:file] ? create_from_file : Lib::Api.new.post(url, attrs)
+          klass.new res.data.merge(scope_id: video_id)
+        end
+
+        private
+
+        def create_from_file
+          File.open(attrs[:file], "r") do |file|
+            Lib::Api.new.post(url, attrs.merge(file: file)) do |body, headers|
+              headers.delete('Content-Type')
+              [body, headers]
+            end
+          end
+        end
+
+        def url
+          path = VzaarApi::Video::Subtitle::ENDPOINT.call(video_id, nil)
+          Lib::Api.resource_url path
+        end
+      end
+    end
+  end
+end

data/lib/vzaar_api/upload/s3.rb

@@ -9,7 +9,7 @@ module VzaarApi
 
       def_delegators :@signature, :access_key_id, :acl, :bucket,
         :guid, :key, :multipart?, :part_size_in_bytes, :policy,
-        :success_action_status, :upload_hostname
+        :success_action_status, :upload_hostname, :x_amz_headers
 
       def initialize(attrs, signature)
         @attrs = attrs.dup
@@ -64,10 +64,8 @@ module VzaarApi
           'bucket' => bucket,
           'success_action_status' => success_action_status,
           'policy' => policy,
-          'AWSAccessKeyId' => access_key_id,
-          'signature' => signature.signature,
           'x-amz-meta-uploader' => UPLOADER
-        }
+        }.merge! x_amz_headers
       end
 
       def http_client

data/lib/vzaar_api/version.rb

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

data/lib/vzaar_api/video/subtitle.rb

@@ -0,0 +1,38 @@
+module VzaarApi
+  class Video
+    class Subtitle < Abstract
+      ENDPOINT = Proc.new do |video_id, subtitle_id|
+        File.join 'videos', video_id.to_s, 'subtitles', subtitle_id.to_s
+      end
+
+      ATTR_READERS = [:id,
+                      :code,
+                      :title,
+                      :language,
+                      :created_at,
+                      :updated_at
+                     ].freeze
+
+      ATTR_ACCESSORS = [:code].freeze
+
+      prepend Lib::HasAttributes
+      include Lib::HasResourceUrl
+      include Lib::ActiveObject::Create
+      include Lib::ActiveObject::Save
+      include Lib::ActiveObject::Delete
+      include Lib::WillPaginate
+
+      def initialize(attrs = {})
+        @scope_id = attrs.delete(:scope_id)
+      end
+
+      def self.paginate(video_id, query = {})
+        super query.merge(scope_id: video_id)
+      end
+
+      def self.create(video_id, attrs = {})
+        VzaarApi::Strategy::Subtitle::Create.new(video_id, attrs, self).execute
+      end
+    end
+  end
+end

data/lib/vzaar_api/video.rb

@@ -1,6 +1,5 @@
 module VzaarApi
   class Video < Abstract
-
     ENDPOINT = 'videos'
 
     ATTR_READERS = [:id, :user_id, :account_id, :categories,
@@ -25,6 +24,14 @@ module VzaarApi
       Strategy::Video::Create.new(attrs, self).execute
     end
 
+    def self.set_image_frame(video_id, attrs = {})
+      Strategy::Image::Update.new(video_id, attrs, self).execute
+    end
+
+    def self.upload_image_frame(video_id, attrs = {})
+      Strategy::Image::Create.new(video_id, attrs, self).execute
+    end
+
     private
 
     def update_from_attributes(attrs)

data/lib/vzaar_api.rb

@@ -23,8 +23,13 @@ require 'vzaar_api/legacy_rendition'
 require 'vzaar_api/link_upload'
 require 'vzaar_api/playlist'
 require 'vzaar_api/rendition'
+require 'vzaar_api/strategy/image/abstract'
+require 'vzaar_api/strategy/image/update'
+require 'vzaar_api/strategy/image/create'
+require 'vzaar_api/strategy/subtitle/create'
 require 'vzaar_api/strategy/video/create'
 require 'vzaar_api/video'
+require 'vzaar_api/video/subtitle'
 
 require 'vzaar_api/signature/abstract'
 require 'vzaar_api/signature/factory'

data/spec/fixtures/vcr_cassettes/signature/multipart_201.yml

@@ -2,21 +2,21 @@
 http_interactions:
 - request:
     method: post
-    uri: https://app.vzaar.localhost/api/v2/signature/multipart
+    uri: https://app.vzaar.localhost/api/v2/signature/multipart/2
     body:
       encoding: UTF-8
-      string: '{"filename":"video.mp4","filesize":25165824,"uploader":"Ruby-2.0.0-alpha"}'
+      string: '{"filename":"video.mp4","filesize":25165824,"uploader":"Ruby-2.0.0"}'
     headers:
       User-Agent:
-      - HTTPClient/1.0 (2.8.2.4, ruby 2.3.1 (2016-04-26))
+      - HTTPClient/1.0 (2.8.3, ruby 2.3.0 (2015-12-25))
       Accept:
       - "*/*"
       Date:
-      - Thu, 03 Nov 2016 17:12:08 GMT
+      - Wed, 28 Nov 2018 11:12:15 GMT
       X-Auth-Token:
-      - TUGXzNL17ypaougMYpR3
+      - pVrjGuKWP27U_kz4anfy
       X-Client-Id:
-      - lair-tend72
+      - glide-franca-raise
       Content-Type:
       - application/json
   response:
@@ -25,38 +25,38 @@ http_interactions:
       message: Created
     headers:
       Server:
-      - nginx/1.10.1
+      - nginx
       Date:
-      - Thu, 03 Nov 2016 17:12:10 GMT
+      - Wed, 28 Nov 2018 11:12:16 GMT
       Content-Type:
       - application/json
       Content-Length:
-      - '1018'
+      - '1066'
       Connection:
       - keep-alive
-      X-RateLimit-Limit:
+      X-Ratelimit-Limit:
       - '200'
-      X-RateLimit-Remaining:
+      X-Ratelimit-Remaining:
       - '199'
-      X-RateLimit-Reset:
-      - '1478193188'
-      X-RateLimit-Reset-In:
-      - 60 seconds
+      X-Ratelimit-Reset:
+      - '1543403580'
+      X-Ratelimit-Reset-In:
+      - 45 seconds
       Cache-Control:
       - no-store, must-revalidate, private, max-age=0
       X-Request-Id:
-      - a63fc572-b759-4a88-a6e3-6a2311612cb1
+      - 80747688-ff96-489e-849a-3e77424192cb
       X-Runtime:
-      - '1.670516'
+      - '0.956148'
       Set-Cookie:
       - __profilin=p%3Dt; path=/
       - __profilin=p%3Dt; path=/
       - __profilin=p%3Dt; path=/
       X-Miniprofiler-Ids:
-      - '["1yxtukjg4moaigyh1xsu","4cgrjuu9znv5flechaye","xnttqh4f6tb6mlow6fqp","51m8dv0qththvbewgq13","x64kuijqm7wvs2v4hn7w","huk6yekaaonvewr8gorm","vbeuauig2dkult7iwd88","20346z4sk0xdmgjxe013","ojqf7ud6fx3fp4ugy5qy","a3g9j8ng0wd0z95f8byp"]'
+      - '["wzqk5h1llxroowv76or","x6d0sryoaznh4tbj83i2","8fwa4v4jf9bmwd6vvqr","wng1g0lxjpf0d1m0xiff","t9k7dkc5tnuowk9auwey","smpx96fbyoyotkt4xebh","xr2g8orikxxkzhefaeec","osnz4pgxt5ivkz457xt7","lemn2tp0lc9pfn64elxq","pt82m4whmu8qyhjv5fia"]'
     body:
       encoding: UTF-8
-      string: '{"data":{"access_key_id":"access_key_id","key":"vzaar/t8d/ec9/source/t8dec9434bcc64622b68d1dc16f3ddffap/${filename}","acl":"private","policy":"policy","signature":"signature","success_action_status":"201","content_type":"binary/octet-stream","guid":"guid","bucket":"vzaar-upload-development","upload_hostname":"https://vzaar-upload-development.s3.amazonaws.com","part_size":"5MB","part_size_in_bytes":5242880,"parts":5}}'
+      string: '{"data":{"x-amz-credential":"credential","x-amz-algorithm":"AWS4-HMAC-SHA256","x-amz-date":"date","x-amz-signature":"signature","key":"vzaar/tjY/fV-/source/tjYfV-j3o754/${filename}","acl":"private","policy":"policy","success_action_status":"201","guid":"tjYfV-j3o754","bucket":"vzaar-upload-development","upload_hostname":"https://vzaar-upload-development.s3.amazonaws.com","part_size":"5MB","part_size_in_bytes":5242880,"parts":5}}'
     http_version:
-  recorded_at: Thu, 03 Nov 2016 17:12:10 GMT
+  recorded_at: Wed, 28 Nov 2018 11:12:16 GMT
 recorded_with: VCR 3.0.3

data/spec/fixtures/vcr_cassettes/signature/multipart_422.yml

@@ -2,21 +2,21 @@
 http_interactions:
 - request:
     method: post
-    uri: https://app.vzaar.localhost/api/v2/signature/multipart
+    uri: https://app.vzaar.localhost/api/v2/signature/multipart/2
     body:
       encoding: UTF-8
-      string: '{"filename":"video.mp4","filesize":null,"uploader":"Ruby-2.0.0-alpha"}'
+      string: '{"filename":"video.mp4","filesize":null,"uploader":"Ruby-2.0.0"}'
     headers:
       User-Agent:
-      - HTTPClient/1.0 (2.8.2.4, ruby 2.3.1 (2016-04-26))
+      - HTTPClient/1.0 (2.8.3, ruby 2.3.0 (2015-12-25))
       Accept:
       - "*/*"
       Date:
-      - Thu, 03 Nov 2016 17:25:50 GMT
+      - Wed, 28 Nov 2018 11:12:16 GMT
       X-Auth-Token:
-      - TUGXzNL17ypaougMYpR3
+      - pVrjGuKWP27U_kz4anfy
       X-Client-Id:
-      - lair-tend72
+      - glide-franca-raise
       Content-Type:
       - application/json
   response:
@@ -25,9 +25,9 @@ http_interactions:
       message: Unprocessable Entity
     headers:
       Server:
-      - nginx/1.10.1
+      - nginx
       Date:
-      - Thu, 03 Nov 2016 17:25:50 GMT
+      - Wed, 28 Nov 2018 11:12:16 GMT
       Content-Type:
       - application/json
       Content-Length:
@@ -37,9 +37,9 @@ http_interactions:
       Cache-Control:
       - no-cache
       X-Request-Id:
-      - bfb53109-118e-47b8-9afd-abee3e4305f4
+      - a04de2f9-a812-4df0-97e6-f7ee36b336e1
       X-Runtime:
-      - '0.050045'
+      - '0.077673'
       Set-Cookie:
       - __profilin=p%3Dt; path=/
       - __profilin=p%3Dt; path=/
@@ -47,6 +47,6 @@ http_interactions:
       encoding: UTF-8
       string: '{"errors":[{"message":"Invalid parameters","detail":"Filesize must
         be between 5MB and 5TB"}]}'
-    http_version: 
-  recorded_at: Thu, 03 Nov 2016 17:25:50 GMT
+    http_version:
+  recorded_at: Wed, 28 Nov 2018 11:12:16 GMT
 recorded_with: VCR 3.0.3