vidispine 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b384b244a314c8b4323b69ccc16c7824ae52ac2d
-  data.tar.gz: 1df54b7818102417191b43ba2be89e5b2c38ba2a
+  metadata.gz: fad78c8b766bf87d952d77f3a73a667d887b064f
+  data.tar.gz: eb13dce39554cdd7a0b4b1b00e212ecb7a5abe72
 SHA512:
-  metadata.gz: ae8d940adecdc9e174b60116ec9d911701b9e6796092261c4afb1917d03dae57368a8b8f5a5adbed4c5bdb55b94ac0c6370a61c41ec4e8a6405dbea71136ed1e
-  data.tar.gz: 5452d7e0cedb685b8874a352fc73709669e753a298c263eac6ae115b489c41982e6e397bb296444351aab9c43293750c57e6d11c5d0f1dec8a27210bc494d393
+  metadata.gz: 18a6979587fe7a8d85f90dcb248c7cb45558e6d8393a0064a921fa6d8000a7206b33b5f9d483f5bf5fee1ff7d074cfd6905e58b8849f3e9989361991efed13bf
+  data.tar.gz: 867ace58974e2d2615bfba584b00585010db7438aeff9dd6dc6c520944898be4990d7f3b9409fd1370e45662340e535885523501245c39526b244656d97a5c86

data/lib/vidispine/api/client.rb

@@ -9,7 +9,16 @@ module Vidispine
 
       attr_accessor :http_client, :request, :response, :logger
 
+      attr_accessor :api_endpoint_prefix, :api_noauth_endpoint_prefix
+
       def initialize(args = { })
+
+        # API Path
+        @api_endpoint_prefix = args.fetch(:api_endpoint_prefix, 'API')
+
+        # APInoAuth Path
+        @api_noauth_endpoint_prefix = args.fetch(:api_noauth_endpoint_prefix, 'APInoauth')
+
         @http_client = HTTPClient.new(args)
         @logger = http_client.logger
       end
@@ -20,7 +29,7 @@ module Vidispine
         request.client = self unless request.client
         options ||= request.options
         logger.warn { "Request is Missing Required Arguments: #{request.missing_required_arguments.inspect}" } unless request.missing_required_arguments.empty?
-        @response = http_client.call_method(request.http_method, { :path => request.path, :query => request.query, :body => request.body }, options)
+        @response = http_client.build_and_send_request(request.http_method, { :path => request.path, :query => request.query, :body => request.body }, options)
       end
 
       def process_request_using_class(request_class, args, options = { })
@@ -137,7 +146,8 @@ module Vidispine
           _args = _data[:arguments_out]
           _args[:collection_id]
         end
-        http(:delete, "/collection/#{collection_id}")
+        path = File.join(api_endpoint_prefix, "/collection/#{collection_id}")
+        http(:delete, path)
       end
 
       # @see http://apidoc.vidispine.com/4.2/ref/collection.html#retrieve-the-contents-of-a-collection
@@ -147,7 +157,8 @@ module Vidispine
           _args = _data[:arguments_out]
           _args[:collection_id]
         end
-        http(:get, "/collection/#{collection_id}")
+        path = File.join(api_endpoint_prefix, "/collection/#{collection_id}")
+        http(:get, path)
       end
       alias :collection :collection_get
 
@@ -158,7 +169,8 @@ module Vidispine
           _args = _data[:arguments_out]
           _args[:collection_id]
         end
-        http(:get, "collection/#{collection_id}/item")
+        path = File.join(api_endpoint_prefix, "collection/#{collection_id}/item")
+        http(:get, path)
       end
       alias :collection_items :collection_items_get
 
@@ -170,7 +182,8 @@ module Vidispine
           _args = _data[:arguments_out]
           _args[:collection_id]
         end
-        http(:get, "/collection/#{collection_id}/metadata")
+        path = File.join(api_endpoint_prefix, "/collection/#{collection_id}/metadata")
+        http(:get, path)
       end
 
       # @see http://apidoc.vidispine.com/4.2/ref/collection.html#update-collection-metadata
@@ -317,7 +330,8 @@ module Vidispine
           _args = _data[:arguments_out]
           _args[:item_id]
         end
-        http(:get, "/item/#{item_id}/collections")
+        path = File.join(api_endpoint_prefix, "/item/#{item_id}/collections")
+        http(:get, path)
       end
       alias :item_collections :item_collections_get
 
@@ -504,7 +518,8 @@ module Vidispine
         query[:priority] = priority if priority
         query[:jobmetadata] = job_metadata if job_metadata
 
-        http(:post, "/item/#{item_id}/shape", '', :query => query)
+        path = File.join(api_endpoint_prefix, "/item/#{item_id}/shape")
+        http(:post, path, '', :query => query)
       end
 
       def item_sidecar_import(args = { }, options = { })
@@ -740,12 +755,14 @@ module Vidispine
       def metadata_field_terse_schema(args = { }, options = { })
         default_options = { :headers => { 'accept' => '*/*' } }
         _options = default_options.merge(options)
-        http(:get, 'metadata-field/terse-schema', _options)
+        path = File.join(api_endpoint_prefix, 'metadata-field/terse-schema')
+        http(:get, path, _options)
       end
 
       # @see http://apidoc.vidispine.com/4.2/ref/metadata/field.html#get--metadata-field
       def metadata_fields_get(args = { }, options = { })
-        http(:get, 'metadata-field', options)
+        path = File.join(api_endpoint_prefix, 'metadata-field')
+        http(:get, path, options)
       end
       alias :metadata_fields :metadata_fields_get
 
@@ -936,7 +953,8 @@ module Vidispine
           _args = _data[:arguments_out]
           _args[:storage_id]
         end
-        http(:post, "storage/#{storage_id ? "#{storage_id}/" : ''}rescan", '')
+        path = File.join(api_endpoint_prefix, "storage/#{storage_id ? "#{storage_id}/" : ''}rescan")
+        http(:post, path, '')
       end
 
       # @see http://apidoc.vidispine.com/4.2/ref/storage/storage.html#retrieve-list-of-storages
@@ -961,7 +979,7 @@ module Vidispine
       alias :storages :storages_get
 
       def version(args = { }, options = { })
-        http(:get, 'API/version')
+        http(:get, File.join(api_endpoint_prefix, 'version'))
       end
 
       # @!endgroup API Endpoints

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

@@ -25,7 +25,7 @@ module Vidispine
 
         DEFAULT_USERNAME = 'admin'
         DEFAULT_PASSWORD = 'password'
-        DEFAULT_BASE_PATH = 'API/'
+        DEFAULT_BASE_PATH = '/'
 
         DEFAULT_HEADER_CONTENT_TYPE = 'application/json; charset=utf-8'
         DEFAULT_HEADER_ACCEPTS = 'application/json'
@@ -40,19 +40,21 @@ module Vidispine
 
           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 = args[:base_uri] || "http#{http.use_ssl? ? 's' : ''}://#{http.address}:#{http.port}"
-          @default_base_path = args[:default_base_path] || DEFAULT_BASE_PATH
+          @default_base_path = args.fetch(: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')
-          @authorization_header_value ||= %(Basic #{["#{username}:#{password}"].pack('m').delete("\r\n")})
+          @username = args[:username] || DEFAULT_USERNAME
+          @password = args[:password] || DEFAULT_PASSWORD
+
+          @authorization_header_key = args.fetch(:authorization_header_key, 'Authorization')
+          @authorization_header_value = args.fetch(:authorization_header_value,
+                                                   %(Basic #{["#{username}:#{password}"]
+                                                                 .pack('m')
+                                                                 .delete("\r\n")}))
 
           content_type = args[:content_type_header] ||= DEFAULT_HEADER_CONTENT_TYPE
           accepts = args[:accepts_header] ||= args[:accept_header] || DEFAULT_HEADER_ACCEPTS
@@ -144,13 +146,26 @@ module Vidispine
           end
         end
 
+        # Compiles a full URI
+        #
         # @param [String] path
         # @param [Hash|String|Nil] query
+        # @param [Hash] options
+        # @option options [Hash] :default_query_data
+        # @option options [Hash] :default_base_path
+        #
         # @return [URI]
-        def build_uri(path = '', query = nil)
-          _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
+        def build_uri(path = '', query = nil, options = { })
+          _default_query_data = options.fetch(:default_query_data, default_query_data) || { }
+          _default_base_path = options.fetch(:default_base_path, default_base_path)
+
+          query = { } if query.nil?
+
+          _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))
+          _path = File.join(_default_base_path, _path) if _default_base_path
+          _path = File.join(base_uri, _path)
+          URI.parse(_path)
         end
 
         if RUBY_VERSION.start_with? '1.8.'
@@ -163,6 +178,8 @@ module Vidispine
           end
         end
 
+        # Builds the HTTP request
+        #
         # @param [Symbol] method_name (:get)
         # @param [Hash] args
         # @option args [Hash] :headers ({})
@@ -171,7 +188,7 @@ module Vidispine
         # @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 = { })
+        def build_request(method_name = :get, args = { }, options = { })
           headers = args[:headers] || options[:headers] || { }
           path = args[:path] || ''
           query = args[:query] || { }
@@ -182,102 +199,59 @@ module Vidispine
           _default_request_headers ||= { }
           _headers = _default_request_headers.merge(headers)
 
-          @uri = build_uri(path, query)
+          @uri = build_uri(path, query, options)
           klass_name = request_method_name_to_class_name(method_name)
           klass = Net::HTTP.const_get(klass_name)
 
-          request = klass.new(@uri.request_uri, _headers)
+          _request = klass.new(@uri.request_uri, _headers)
 
-          if request.request_body_permitted?
+          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
+            _request.body = _body if _body
           end
 
-          send_request(request)
+          _request
+        end
+
+        # First builds and then sends the HTTP request
+        #
+        # @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 build_and_send_request(method_name = :get, args = { }, options = { })
+          _request = build_request(method_name, args, options)
+          send_request(_request)
         end
 
         def delete(path, options = { })
-          query = options.fetch(:query, { })
-          base_path = options[:base_path] || ( path.start_with?(@default_base_path) ? '' : @default_base_path )
-          @uri = build_uri(File.join(base_path, path), query)
-          request = Net::HTTP::Delete.new(@uri.request_uri, default_request_headers)
-          send_request(request)
+          build_and_send_request(:delete, { :path => path }, options)
         end
 
         def get(path, options = { })
-          # Allow the default request headers to be overridden
-          headers = options[:headers] || { }
-          _default_request_headers = options.fetch(:default_request_headers, default_request_headers) || { }
-          _headers = _default_request_headers.merge(headers)
-
-          query ||= options.fetch(:query, { })
-          base_path = options[:base_path] || ( path.start_with?(@default_base_path) ? '' : @default_base_path )
-          @uri = build_uri(File.join(base_path, path), query)
-          request = Net::HTTP::Get.new(@uri.request_uri, _headers)
-          send_request(request)
+          build_and_send_request(:get, { :path => path }, options)
         end
 
         def head(path, options = { })
-          # Allow the default request headers to be overridden
-          headers = options[:headers] || { }
-          _default_request_headers = options.fetch(:default_request_headers, default_request_headers) || { }
-          _headers = _default_request_headers.merge(headers)
-
-          query ||= options.fetch(:query, { })
-          base_path = options[:base_path] || ( path.start_with?(@default_base_path) ? '' : @default_base_path )
-          @uri = build_uri(File.join(base_path, path), query)
-
-          request = Net::HTTP::Head.new(@uri.request_uri, _headers)
-          send_request(request)
+          build_and_send_request(:head, { :path => path }, options)
         end
 
         def options(path, options = { })
-          # Allow the default request headers to be overridden
-          headers = options[:headers] || { }
-          _default_request_headers = options.fetch(:default_request_headers, default_request_headers) || { }
-          _headers = _default_request_headers.merge(headers)
-
-          query ||= options.fetch(:query, { })
-          base_path = options[:base_path] || ( path.start_with?(@default_base_path) ? '' : @default_base_path )
-          @uri = build_uri(File.join(base_path, path), query)
-          request = Net::HTTP::Options.new(@uri.request_uri, _headers)
-          send_request(request)
+          build_and_send_request(:options, { :path => path }, options)
         end
 
         def put(path, body, options = { })
-          # Allow the default request headers to be overridden
-          headers = options[:headers] || { }
-          _default_request_headers = options.fetch(:default_request_headers, default_request_headers) || { }
-          _headers = _default_request_headers.merge(headers)
-
-          query = options.fetch(:query, { })
-          base_path = options[:base_path] || ( path.start_with?(@default_base_path) ? '' : @default_base_path )
-          @uri = build_uri(File.join(base_path, path), query)
-          request = Net::HTTP::Put.new(@uri.request_uri, _headers)
-
-          body = JSON.generate(body) if body and !body.is_a?(String)
-
-          request.body = body if body
-          send_request(request)
+          build_and_send_request(:put, { :path => path, :body => body }, options)
         end
 
         def post(path, body, options = { })
-          # Allow the default request headers to be overridden
-          headers = options[:headers] || { }
-          _default_request_headers = options.fetch(:default_request_headers, default_request_headers) || { }
-          _headers = _default_request_headers.merge(headers)
-
-          query = options.fetch(:query, { })
-          base_path = options[:base_path] || ( path.start_with?(@default_base_path) ? '' : @default_base_path )
-          @uri = build_uri(File.join(base_path, path), query)
-
-          request = Net::HTTP::Post.new(@uri.request_uri, _headers)
-
-          body = JSON.generate(body) if body and !body.is_a?(String)
-
-          request.body = body if body
-          send_request(request)
+          build_and_send_request(:post, { :path => path, :body => body }, options)
         end
 
         # HTTPClient

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

@@ -9,7 +9,7 @@ module Vidispine
         class BaseRequest
 
           HTTP_METHOD = :get
-          HTTP_BASE_PATH = '/API/'
+          HTTP_BASE_PATH = '/API/' # Not used, using client.api_endpoint_prefix instead
           HTTP_PATH = ''
           HTTP_SUCCESS_CODE = '200'
 
@@ -150,7 +150,7 @@ module Vidispine
           end
 
           def base_path
-            @base_path ||= self.class::HTTP_BASE_PATH
+            @base_path ||= client.api_endpoint_prefix # self.class::HTTP_BASE_PATH
           end
 
           def body_arguments

data/lib/vidispine/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vidispine
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - John Whitson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-20 00:00:00.000000000 Z
+date: 2018-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler