vidispine 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 4d9919ba4f728d001342ea3e8c254eed8ecd59ae29a4fbf759b8faefac79fcfd
-  data.tar.gz: 1b4f5580669b0ed5edc15692f2d7deb19e6616ab1c8b98e2e52802e9e256b001
+SHA1:
+  metadata.gz: b384b244a314c8b4323b69ccc16c7824ae52ac2d
+  data.tar.gz: 1df54b7818102417191b43ba2be89e5b2c38ba2a
 SHA512:
-  metadata.gz: b7359a1382a8edeb9b33ec53178c4f9588a70b363378bc292cfe0f12a41260771b1b3b5e77603c86a7eae34bf1b5d6458fd1e361cd660771dfbeb023b8a0eea9
-  data.tar.gz: f97825f0cb2874fe8445dc98b8766b47750f41bf89f6b64586f974838970e8a334fd9fc58e235edbf45771824c19141f0fd2d3ef945bd846f2163522b8bfd644
+  metadata.gz: ae8d940adecdc9e174b60116ec9d911701b9e6796092261c4afb1917d03dae57368a8b8f5a5adbed4c5bdb55b94ac0c6370a61c41ec4e8a6405dbea71136ed1e
+  data.tar.gz: 5452d7e0cedb685b8874a352fc73709669e753a298c263eac6ae115b489c41982e6e397bb296444351aab9c43293750c57e6d11c5d0f1dec8a27210bc494d393

data/Gemfile

@@ -1,7 +1,5 @@
 source 'http://rubygems.org'
 
-gem 'aws-sdk-s3', '~> 1'
-
 gem 'json', '~> 1.8', :platforms => :mri_18
 # gem 'mini_portile', '~> 0.5.0', :platforms => :mri_18
 # gem 'mime-types', '~> 1.25.1', :platforms => :mri_18

data/bin/vidispine-notification-handler

@@ -4,239 +4,14 @@ require 'logger'
 require 'optparse'
 require 'pp'
 
-ARGV << '--uri'
-ARGV << 'https://o6h5m0r0ih.execute-api.us-east-1.amazonaws.com/latest/vidispine/notification'
-ARGV << '{changeSetId=[VX-460], userName=[admin], itemId=[VX-90], portal_mf201890=[3], sequenceNumber=[0]}'
-puts 'Arguments:'
-pp ARGV
-
-
 module Vidispine
 
-  class HTTPClient
-
-    class HTTPAuthorizationError < RuntimeError; end
-
-    attr_accessor :logger, :http, :http_host_address, :http_host_port, :base_uri, :default_base_path
-    attr_accessor :username, :password
-
-    attr_accessor :default_request_headers,
-                  :authorization_header_key, :authorization_header_value
-
-    attr_accessor :log_request_body, :log_response_body, :log_pretty_print_body
-
-    attr_accessor :request, :response, :use_exceptions
-
-    DEFAULT_HTTP_HOST_ADDRESS = 'localhost'
-    DEFAULT_HTTP_HOST_PORT = 80
-
-    DEFAULT_USERNAME = ''
-    DEFAULT_PASSWORD = ''
-    DEFAULT_BASE_PATH = '/'
-
-    DEFAULT_HEADER_CONTENT_TYPE = 'application/json; charset=utf-8'
-    DEFAULT_HEADER_ACCEPTS = 'application/json'
-
-    def initialize(args = { })
-      args = args.dup
-
-      @use_exceptions = args.fetch(:use_exceptions, true)
-
-      initialize_logger(args)
-      initialize_http(args)
-
-      logger.debug { "#{self.class.name}::#{__method__} Arguments: #{args.inspect}" }
-
-      @username = args[:username] || DEFAULT_USERNAME
-      @password = args[:password] || DEFAULT_PASSWORD
-      @authorization_header_value = args[:authorization_header_value]
-
-      @base_uri = "http#{http.use_ssl? ? 's' : ''}://#{http.address}:#{http.port}"
-      @default_base_path = args[:default_base_path] || DEFAULT_BASE_PATH
-
-      content_type = args[:content_type_header] ||= DEFAULT_HEADER_CONTENT_TYPE
-      accepts = args[:accepts_header] ||= args[:accept_header] || DEFAULT_HEADER_ACCEPTS
-
-      @default_request_headers = {
-          'Content-Type' => content_type,
-          'Accept' => accepts,
-      }
-
-      if !username.empty? && !password.empty?
-        @authorization_header_key ||= 'Authorization' #CaseSensitiveHeaderKey.new('Authorization')
-        @authorization_header_value ||= %(Basic #{["#{username}:#{password}"].pack('m').delete("\r\n")})
-        @default_request_headers[authorization_header_key] = authorization_header_value
-      end
-
-      @log_request_body = args.fetch(:log_request_body, true)
-      @log_response_body = args.fetch(:log_response_body, true)
-      @log_pretty_print_body = args.fetch(:log_pretty_print_body, true)
-
-      @parse_response = args.fetch(:parse_response, true)
-    end
-
-    def initialize_logger(args = { })
-      @logger = args[:logger] ||= Logger.new(args[:log_to] || STDOUT)
-      log_level = args[:log_level]
-      if log_level
-        @logger.level = log_level
-        args[:logger] = @logger
-      end
-      @logger
-    end
-
-    def initialize_http(args = { })
-      @http_host_address = args[:http_host_address] ||= DEFAULT_HTTP_HOST_ADDRESS
-      @http_host_port = args[:http_host_port] ||= DEFAULT_HTTP_HOST_PORT
-      @http = Net::HTTP.new(http_host_address, http_host_port)
-
-      use_ssl = args[:http_host_use_ssl]
-      if use_ssl
-        # @TODO Add SSL Support
-        http.use_ssl = true
-        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-      end
-
-      http
-    end
-
-    # Formats a HTTPRequest or HTTPResponse body for log output.
-    # @param [HTTPRequest|HTTPResponse] obj
-    # @return [String]
-    def format_body_for_log_output(obj)
-      if obj.content_type == 'application/json'
-        if @log_pretty_print_body
-          _body = obj.body
-          output = JSON.pretty_generate(JSON.parse(_body)) rescue _body
-          return output
-        else
-          return obj.body
-        end
-      elsif obj.content_type == 'application/xml'
-        return obj.body
-      else
-        return obj.body.inspect
-      end
-    end
-
-    # @param [HTTPRequest] request
-    def send_request(request)
-      @response_parsed = nil
-      @request = request
-      logger.debug { %(REQUEST: #{request.method} http#{http.use_ssl? ? 's' : ''}://#{http.address}:#{http.port}#{request.path} HEADERS: #{request.to_hash.inspect} #{log_request_body and request.request_body_permitted? ? "\n-- BODY BEGIN --\n#{format_body_for_log_output(request)}\n-- BODY END --" : ''}) }
-
-      @request_time_start = Time.now
-      @response = http.request(request)
-      @request_time_end = Time.now
-      logger.debug { %(RESPONSE: #{response.inspect} HEADERS: #{response.to_hash.inspect} #{log_response_body and response.respond_to?(:body) ? "\n-- BODY BEGIN --\n#{format_body_for_log_output(response)}\n-- BODY END--" : ''}\nTook: #{@request_time_end - @request_time_start} seconds) }
-      #logger.debug { "Parse Response? #{@parse_response}" }
-
-      raise HTTPAuthorizationError if @use_exceptions && @response.code == '401'
-
-      @parse_response ? response_parsed : response.body
-    end
-
-    def response_parsed
-      @response_parsed ||= begin
-        response_body = response.respond_to?(:body) ? response.body : ''
-        logger.debug { "Parsing Response. #{response_body.inspect}" }
-
-        case response.content_type
-          when 'application/json'
-            response_body.empty? ? response_body : JSON.parse(response_body) # rescue response
-          else
-            response_body
-        end
-      end
-    end
-
-    # @param [String] path
-    # @param [Hash|String|Nil] query
-    # @return [URI]
-    def build_uri(path = '', query = nil)
-      _query = query.is_a?(Hash) ? query.map { |k,v| "#{CGI.escape(k.to_s)}=#{CGI.escape(v.respond_to?(:to_s) ? v.to_s : v)}" }.join('&') : query
-      _path = "#{path}#{_query and _query.respond_to?(:empty?) and !_query.empty? ? "?#{_query}" : ''}"
-      URI.parse(File.join(base_uri, _path))
-    end
-
-    if RUBY_VERSION.start_with? '1.8.'
-      def request_method_name_to_class_name(method_name)
-        method_name.to_s.capitalize
-      end
-    else
-      def request_method_name_to_class_name(method_name)
-        method_name.to_s.capitalize.to_sym
-      end
-    end
-
-    # @param [Symbol] method_name (:get)
-    # @param [Hash] args
-    # @option args [Hash] :headers ({})
-    # @option args [String] :path ('')
-    # @option args [Hash] :query ({})
-    # @option args [Any] :body (nil)
-    # @param [Hash] options
-    # @option options [Hash] :default_request_headers (@default_request_headers)
-    def call_method(method_name = :get, args = { }, options = { })
-      headers = args[:headers] || options[:headers] || { }
-      path = args[:path] || ''
-      query = args[:query] || { }
-      body = args[:body]
-
-      # Allow the default request headers to be overridden
-      _default_request_headers = options.fetch(:default_request_headers, default_request_headers)
-      _default_request_headers ||= { }
-      _headers = _default_request_headers.merge(headers)
-
-      @uri = build_uri(path, query)
-      klass_name = request_method_name_to_class_name(method_name)
-      klass = Net::HTTP.const_get(klass_name)
-
-      request = klass.new(@uri.request_uri, _headers)
-
-      if request.request_body_permitted?
-        _body = (body and !body.is_a?(String)) ? JSON.generate(body) : body
-        logger.debug { "Processing Body: '#{_body}'" }
-        request.body = _body if _body
-      end
-
-      send_request(request)
-    end
-
-    def delete(path, options = { })
-      call_method(:delete, { :path => path }, options)
-    end
-
-    def get(path, options = { })
-      call_method(:get, { :path => path }, options)
-    end
-
-    def head(path, options = { })
-      call_method(:head, { :path => path }, options)
-    end
-
-    def options(path, options = { })
-      call_method(:options, { :path => path }, options)
-    end
-
-    def put(path, body, options = { })
-      call_method(:put, { :path => path, :body => body }, options)
-    end
-
-    def post(path, body, options = { })
-      call_method(:post, { :path => path, :body => body }, options)
-    end
-
-    # HTTPClient
-  end
-
   class NotificationHandler
 
     attr_accessor :logger
 
     def initialize(args = { })
       initialize_logger(args)
-      initialize_http(args)
     end
 
     def initialize_logger(args = { })
@@ -247,93 +22,22 @@ module Vidispine
       end
     end
 
-    def initialize_http(args = { })
-      uri_as_str = args[:uri]
-
-      uri = URI(uri_as_str)
-
-      args[:http_host_address] = uri.host
-      args[:http_host_port] = uri.port
-      args[:http_host_use_ssl] = uri.scheme == 'https'
-      args[:username] = uri.user
-      args[:password] = uri.password
-      args[:default_base_path] = uri.request_uri
-
-      @http_client = HTTPClient.new(args)
-    end
-
-    def forward_notification(notification)
-      @http_client.call_method(:post, :body => notification)
-    end
-
   end
 
 end
 
-LOGGING_LEVELS = {
-    :debug => Logger::DEBUG,
-    :info => Logger::INFO,
-    :warn => Logger::WARN,
-    :error => Logger::ERROR,
-    :fatal => Logger::FATAL
-}
-
-DEFAULT_HEADER_CONTENT_TYPE = 'application/json; charset=utf-8'
-
-def log_to_as_string
-  _log_to = arguments[:log_to]
-  case _log_to
-    when STDERR; 'STDERR'
-    when STDOUT; 'STDOUT'
-    else _log_to
-  end
-end
-
 
-default_arguments = {
+args = {
   :log_to => "/tmp/#{File.basename($0)}.log",
-  :log_level => Logger::DEBUG,
-  :options_file_path => File.expand_path(File.basename($0, '.*'), '~/.options'),
-  :http_method => :post
+  :log_level => Logger::DEBUG
 }
-@arguments = default_arguments.dup
-def arguments; @arguments end
-
-argument_parser = OptionParser.new
-argument_parser.on('--uri URI', 'The address of the server to communicate with.') { |v| arguments[:uri] = v }
-
-argument_parser.on('--content-type VALUE', 'The value for the Content-Type header sent in each request.', "\tdefault: #{DEFAULT_HEADER_CONTENT_TYPE}") { |v| arguments[:content_type] = v }
-argument_parser.on('--method METHOD', 'The HTTP method to use when submitting the notification.', "\tdefault: #{arguments[:http_method]}") { |v| arguments[:http_method] = v.to_sym }
-argument_parser.on('--pretty-print', 'Will format the output to be more human readable.') { |v| arguments[:pretty_print] = v }
-
-argument_parser.on('--log-to FILENAME', 'Log file location.', "\tdefault: #{log_to_as_string}") { |v| arguments[:log_to] = v }
-argument_parser.on('--log-level LEVEL', LOGGING_LEVELS.keys, "Logging level. Available Options: #{LOGGING_LEVELS.keys.join(', ')}",
-                   "\tdefault: #{LOGGING_LEVELS.invert[arguments[:log_level]]}") { |v| arguments[:log_level] = LOGGING_LEVELS[v] }
-
-argument_parser.on('--[no-]options-file [FILENAME]', 'Path to a file which contains default command line arguments.', "\tdefault: #{arguments[:options_file_path]}" ) { |v| arguments[:options_file_path] = v}
-argument_parser.on_tail('-h', '--help', 'Display this message.') { puts help; exit }
-
-arguments.clear
-original_argv_args = ARGV.dup
-argument_parser.parse!(ARGV)
-remaining_argv_args = ARGV.dup
-arguments_from_command_line = arguments.dup
-
-options_file_path = arguments_from_command_line[:options_file_path] || default_arguments[:options_file_path]
-
-arguments.clear
-argument_parser.load(options_file_path)
-arguments_from_options_file = arguments.dup
-
-arguments = default_arguments.merge(arguments_from_options_file).merge(arguments_from_command_line)
-
-pp arguments
-# @handler = Vidispine::NotificationHandler.new(arguments)
-# def logger; @handler.logger end
-# logger.debug { "ARGUMENTS: #{remaining_argv_args.inspect}" }
-
 
+@handler = Vidispine::NotificationHandler.new(args)
+def logger; @handler.logger end
+logger.debug { "ARGUMENTS: #{ARGV.inspect}" }
 
-# @handler.forward_notification(remaining_argv_args)
+# ARGV << '{changeSetId=[VX-460], userName=[admin], itemId=[VX-90], portal_mf201890=[3], sequenceNumber=[0]}'
+# puts 'Arguments:'
+# pp ARGV
 
 

data/lib/vidispine/api/client.rb

@@ -389,10 +389,6 @@ module Vidispine
       end
       alias :item_shape_files :item_shape_files_get
 
-      def item_shape_add(args = { }, options = { })
-
-      end
-
       # @see http://apidoc.vidispine.com/4.2.6/ref/item/shape.html#get-shape
       def item_shape_get(args = { }, options = { })
         _request = Requests::BaseRequest.new(

data/lib/vidispine/api/client/http_client.rb

@@ -9,7 +9,8 @@ module Vidispine
 
         class HTTPAuthorizationError < RuntimeError; end
 
-        attr_accessor :logger, :http, :http_host_address, :http_host_port, :base_uri, :default_base_path
+        attr_accessor :logger, :http, :http_host_address, :http_host_port, :base_uri, :default_base_path,
+                      :default_query_data
         attr_accessor :username, :password
 
         attr_accessor :default_request_headers,
@@ -46,6 +47,8 @@ module Vidispine
           @base_uri = args[:base_uri] || "http#{http.use_ssl? ? 's' : ''}://#{http.address}:#{http.port}"
           @default_base_path = args[:default_base_path] || DEFAULT_BASE_PATH
 
+          @default_query_data = args[:default_query_data] || { }
+
           # @user_agent_default = "#{@hostname}:#{@username} Ruby SDK Version #{Vidispine::VERSION}"
 
           @authorization_header_key ||= 'Authorization' #CaseSensitiveHeaderKey.new('Authorization')
@@ -81,12 +84,11 @@ module Vidispine
           @http_host_address = args[:http_host_address] ||= DEFAULT_HTTP_HOST_ADDRESS
           @http_host_port = args[:http_host_port] ||= DEFAULT_HTTP_HOST_PORT
           @http = Net::HTTP.new(http_host_address, http_host_port)
-
           use_ssl = args[:http_host_use_ssl]
           if use_ssl
-            # @TODO Add SSL Support
+            http_verify_mode = args.fetch(:http_verify_mode, OpenSSL::SSL::VERIFY_NONE)
             http.use_ssl = true
-            http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+            http.verify_mode = http_verify_mode if http_verify_mode
           end
 
           http
@@ -146,7 +148,7 @@ module Vidispine
         # @param [Hash|String|Nil] query
         # @return [URI]
         def build_uri(path = '', query = nil)
-          _query = query.is_a?(Hash) ? query.map { |k,v| "#{CGI.escape(k.to_s)}=#{CGI.escape(v.respond_to?(:to_s) ? v.to_s : v)}" }.join('&') : query
+          _query = query.is_a?(Hash) ? default_query_data.merge(query.map { |k,v| "#{CGI.escape(k.to_s)}=#{CGI.escape(v.respond_to?(:to_s) ? v.to_s : v)}" }.join('&')) : query
           _path = "#{path}#{_query and _query.respond_to?(:empty?) and !_query.empty? ? "?#{_query}" : ''}"
           URI.parse(File.join(base_uri, _path))
         end

data/lib/vidispine/api/client/requests/import_placeholder_item.rb

@@ -13,6 +13,7 @@ module Vidispine::API::Client::Requests
       :fileId,
       :tag,
       :original,
+      :createPosters,
       :createThumbnails,
       :overrideFastStart,
       :requireFastStart,

data/lib/vidispine/api/utilities.rb

@@ -592,7 +592,7 @@ module Vidispine
           file = { 'id' => file_id }
         end
 
-        if file and !file['item']
+        if file_id && file && !file['item']
           # If the passed file doesn't have an item then requery to verify that the item is absent
           storage_file_get_response = storage_file_get(:storage_id => storage_id, :file_id => file_id, :include_item => true)
 

data/lib/vidispine/cli.rb

@@ -21,7 +21,7 @@ module Vidispine
     def self.default_arguments
       @default_arguments ||= {
         :options_file_path => default_options_file_path,
-        :log_level => Logger::DEBUG,
+        :log_level => Logger::ERROR,
         :log_to => STDERR,
       }
     end
@@ -137,7 +137,6 @@ Options:
 
     def self.run(args = nil, init_options = { }, run_options = nil)
       args ||= parse_arguments
-      # puts "Arguments: #{args.inspect}"
       run_options ||= init_options
       new(args, init_options).run(args, run_options)
     end

data/lib/vidispine/version.rb

@@ -1,3 +1,3 @@
 module Vidispine
-  VERSION = '1.4.0'
+  VERSION = '1.5.0'
 end

data/vidispine.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['john.whitson@gmail.com']
   spec.summary       = %q{A Library to Interact with the Vidispine API}
   spec.description   = %q{}
-  spec.homepage      = 'https://github.com/XPlatform-Consulting/vidispine'
+  spec.homepage      = ''
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -23,4 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
 
+  # spec.add_runtime_dependency 'xml-simple', '~> 1.1.4'
+  # spec.add_runtime_dependency 'sinatra', '~> 1.4.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vidispine
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - John Whitson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-08 00:00:00.000000000 Z
+date: 2018-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,7 +90,7 @@ files:
 - lib/vidispine/version.rb
 - resources/postman/Vidispine API (From WADL v4.11).postman_collection.json
 - vidispine.gemspec
-homepage: https://github.com/XPlatform-Consulting/vidispine
+homepage: ''
 licenses:
 - MIT
 metadata: {}
@@ -110,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A Library to Interact with the Vidispine API