ibm_watson 0.9.2 → 0.10.0

data/lib/ibm_watson/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IBMWatson
-  VERSION = "0.9.2"
+  VERSION = "0.10.0"
 end

data/lib/ibm_watson/visual_recognition_v3.rb

@@ -124,33 +124,40 @@ module IBMWatson
       headers = {
         "Accept-Language" => accept_language
       }
+
       params = {
         "version" => @version
       }
+
+      form_data = {}
+
       unless images_file.nil?
-        mime_type = images_file_content_type.nil? ? "application/octet-stream" : images_file_content_type
         unless images_file.instance_of?(StringIO) || images_file.instance_of?(File)
           images_file = images_file.respond_to?(:to_json) ? StringIO.new(images_file.to_json) : StringIO.new(images_file)
         end
-        if images_filename
-          images_file = images_file.instance_of?(StringIO) ? HTTP::FormData::File.new(images_file, content_type: mime_type, filename: images_filename) : HTTP::FormData::File.new(images_file.path, content_type: mime_type, filename: images_filename)
-        else
-          images_file = images_file.instance_of?(StringIO) ? HTTP::FormData::File.new(images_file, content_type: mime_type) : HTTP::FormData::File.new(images_file.path, content_type: mime_type)
-        end
+        images_filename = images_file.path if images_filename.nil? && images_file.respond_to?(:path)
+        form_data[:images_file] = HTTP::FormData::File.new(images_file, content_type: images_file_content_type.nil? ? "application/octet-stream" : images_file_content_type, filename: images_filename)
       end
+
+      classifier_ids *= "," unless classifier_ids.nil?
+      owners *= "," unless owners.nil?
+
+      form_data[:url] = HTTP::FormData::Part.new(url.to_s, content_type: "text/plain") unless url.nil?
+
+      form_data[:threshold] = HTTP::FormData::Part.new(threshold.to_s, content_type: "application/json") unless threshold.nil?
+
+      form_data[:owners] = HTTP::FormData::Part.new(owners, content_type: "application/json") unless owners.nil?
+
+      form_data[:classifier_ids] = HTTP::FormData::Part.new(classifier_ids, content_type: "application/json") unless classifier_ids.nil?
+
       method_url = "/v3/classify"
+
       response = request(
         method: "POST",
         url: method_url,
         headers: headers,
         params: params,
-        form: {
-          images_file: images_file,
-          url: url,
-          threshold: threshold,
-          owners: owners,
-          classifier_ids: classifier_ids
-        },
+        form: form_data,
         accept_json: true
       )
       response
@@ -193,30 +200,31 @@ module IBMWatson
     def detect_faces(images_file: nil, url: nil, images_file_content_type: nil, images_filename: nil)
       headers = {
       }
+
       params = {
         "version" => @version
       }
+
+      form_data = {}
+
       unless images_file.nil?
-        mime_type = images_file_content_type.nil? ? "application/octet-stream" : images_file_content_type
         unless images_file.instance_of?(StringIO) || images_file.instance_of?(File)
           images_file = images_file.respond_to?(:to_json) ? StringIO.new(images_file.to_json) : StringIO.new(images_file)
         end
-        if images_filename
-          images_file = images_file.instance_of?(StringIO) ? HTTP::FormData::File.new(images_file, content_type: mime_type, filename: images_filename) : HTTP::FormData::File.new(images_file.path, content_type: mime_type, filename: images_filename)
-        else
-          images_file = images_file.instance_of?(StringIO) ? HTTP::FormData::File.new(images_file, content_type: mime_type) : HTTP::FormData::File.new(images_file.path, content_type: mime_type)
-        end
+        images_filename = images_file.path if images_filename.nil? && images_file.respond_to?(:path)
+        form_data[:images_file] = HTTP::FormData::File.new(images_file, content_type: images_file_content_type.nil? ? "application/octet-stream" : images_file_content_type, filename: images_filename)
       end
+
+      form_data[:url] = HTTP::FormData::Part.new(url.to_s, content_type: "text/plain") unless url.nil?
+
       method_url = "/v3/detect_faces"
+
       response = request(
         method: "POST",
         url: method_url,
         headers: headers,
         params: params,
-        form: {
-          images_file: images_file,
-          url: url
-        },
+        form: form_data,
         accept_json: true
       )
       response
@@ -226,7 +234,7 @@ module IBMWatson
     #########################
 
     ##
-    # @!method create_classifier(name:, **args)
+    # @!method create_classifier(name:, positive_examples:, negative_examples: nil, positive_examples_filename: nil, negative_examples_filename: nil)
     # Create a classifier.
     # Train a new multi-faceted classifier on the uploaded image data. Create your
     #   custom classifier with positive or negative examples. Include at least two sets of
@@ -237,8 +245,7 @@ module IBMWatson
     #   file names, and classifier and class names). The service assumes UTF-8 encoding if
     #   it encounters non-ASCII characters.
     # @param name [String] The name of the new classifier. Encode special characters in UTF-8.
-    # @param args [Hash] Hash for optional parameters
-    # @option args classname_positive_examples [File] A .zip file of images that depict the visual subject of a class in the new
+    # @param positive_examples [Hash] A .zip file of images that depict the visual subject of a class in the new
     #   classifier. You can include more than one positive example file in a call.
     #
     #   Specify the parameter name by appending `_positive_examples` to the class name.
@@ -254,53 +261,54 @@ module IBMWatson
     #   of the new classifier. Must contain a minimum of 10 images.
     #
     #   Encode special characters in the file name in UTF-8.
-    # @option args classname_positive_examples_filename [String] The filename for classname_positive_examples.
-    # @option args negative_examples_filename [String] The filename for negative_examples.
+    # @param positive_examples_filename [Hash] The filename for positive_examples.
+    # @param negative_examples_filename [String] The filename for negative_examples.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
-    def create_classifier(name:, **args)
-      raise ArgumentError("name must be provided") if name.nil?
+    def create_classifier(name:, positive_examples:, negative_examples: nil, positive_examples_filename: nil, negative_examples_filename: nil)
+      raise ArgumentError.new("name must be provided") if name.nil?
 
-      raise ArgumentError("<classname>_positive_examples must be provided") unless args.keys.any? { |key| key.to_s.end_with?("_positive_examples") }
+      raise ArgumentError.new("positive_examples must be a hash") unless positive_examples.is_a?(Hash)
+      raise ArgumentError.new("positive_examples must have at least one hash entry") if positive_examples.empty?
+
+      raise ArgumentError.new("positive_examples_filename must be a hash") unless positive_examples_filename.nil? || positive_examples_filename.is_a?(Hash)
 
-      positive_keys = args.keys
-      positive_keys.keep_if { |key| key.to_s.end_with?("_positive_examples") }
       headers = {
       }
+
       params = {
         "version" => @version
       }
-      mime_type = "application/octet-stream"
-      positive_keys.each do |k|
-        unless args[k].instance_of?(StringIO) || args[k].instance_of?(File)
-          args[k] = args[k].respond_to?(:to_json) ? StringIO.new(args[k].to_json) : StringIO.new(args[k])
-        end
-        if !args[(k.to_s + "_filename").to_sym].nil?
-          args[k] = args[k].instance_of?(StringIO) ? HTTP::FormData::File.new(args[k], content_type: mime_type, filename: args[(k.to_s + "_filename").to_sym]) : HTTP::FormData::File.new(args[k].path, content_type: mime_type, filename: args[(k.to_s + "_filename").to_sym])
-        else
-          args[k] = args[k].instance_of?(StringIO) ? HTTP::FormData::File.new(args[k], content_type: mime_type) : HTTP::FormData::File.new(args[k].path, content_type: mime_type)
+
+      form_data = {}
+
+      form_data[:name] = HTTP::FormData::Part.new(name.to_s, content_type: "text/plain")
+
+      positive_examples&.each do |key, value|
+        part_name = "%s_positive_examples" % key.to_s
+        unless value.instance_of?(StringIO) || value.instance_of?(File)
+          value = value.respond_to?(:to_json) ? StringIO.new(value.to_json) : StringIO.new(value)
         end
+        filename = positive_examples_filename[key] if !positive_examples_filename.nil? && positive_examples_filename.key?(key)
+        filename = value.path if filename.nil? && value.respond_to?(:path)
+        form_data[part_name.to_sym] = HTTP::FormData::File.new(value, content_type: "application/octet-stream", filename: filename)
       end
-      unless args[:negative_examples].nil?
-        mime_type = "application/octet-stream"
-        unless args[:negative_examples].instance_of?(StringIO) || args[:negative_examples].instance_of?(File)
-          args[:negative_examples] = args[:negative_examples].respond_to?(:to_json) ? StringIO.new(args[:negative_examples].to_json) : StringIO.new(args[:negative_examples])
-        end
-        if args[:negative_examples_filename]
-          args[:negative_examples] = args[:negative_examples].instance_of?(StringIO) ? HTTP::FormData::File.new(args[:negative_examples], content_type: mime_type, filename: args[:negative_examples_filename]) : HTTP::FormData::File.new(args[:negative_examples].path, content_type: mime_type, filename: args[:negative_examples_filename])
-        else
-          args[:negative_examples] = args[:negative_examples].instance_of?(StringIO) ? HTTP::FormData::File.new(args[:negative_examples], content_type: mime_type) : HTTP::FormData::File.new(args[:negative_examples].path, content_type: mime_type)
+
+      unless negative_examples.nil?
+        unless negative_examples.instance_of?(StringIO) || negative_examples.instance_of?(File)
+          negative_examples = negative_examples.respond_to?(:to_json) ? StringIO.new(negative_examples.to_json) : StringIO.new(negative_examples)
         end
+        negative_examples_filename = negative_examples.path if negative_examples_filename.nil? && negative_examples.respond_to?(:path)
+        form_data[:negative_examples] = HTTP::FormData::File.new(negative_examples, content_type: "application/octet-stream", filename: negative_examples_filename)
       end
-      form_hash = { name: name }
-      positive_keys.each { |k| form_hash[k] = args[k] }
-      form_hash[:negative_examples] = args[:negative_examples] unless args[:negative_examples].nil?
+
       method_url = "/v3/classifiers"
+
       response = request(
         method: "POST",
         url: method_url,
         headers: headers,
         params: params,
-        form: form_hash,
+        form: form_data,
         accept_json: true
       )
       response
@@ -315,11 +323,14 @@ module IBMWatson
     def list_classifiers(verbose: nil)
       headers = {
       }
+
       params = {
         "version" => @version,
         "verbose" => verbose
       }
+
       method_url = "/v3/classifiers"
+
       response = request(
         method: "GET",
         url: method_url,
@@ -337,14 +348,17 @@ module IBMWatson
     # @param classifier_id [String] The ID of the classifier.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def get_classifier(classifier_id:)
-      raise ArgumentError("classifier_id must be provided") if classifier_id.nil?
+      raise ArgumentError.new("classifier_id must be provided") if classifier_id.nil?
 
       headers = {
       }
+
       params = {
         "version" => @version
       }
+
       method_url = "/v3/classifiers/%s" % [ERB::Util.url_encode(classifier_id)]
+
       response = request(
         method: "GET",
         url: method_url,
@@ -356,7 +370,7 @@ module IBMWatson
     end
 
     ##
-    # @!method update_classifier(classifier_id:, **args)
+    # @!method update_classifier(classifier_id:, positive_examples: nil, negative_examples: nil, positive_examples_filename: nil, negative_examples_filename: nil)
     # Update a classifier.
     # Update a custom classifier by adding new positive or negative classes (examples)
     #   or by adding new images to existing classes. You must supply at least one set of
@@ -372,7 +386,7 @@ module IBMWatson
     #   previous requests. The retrained property shows the last time the classifier
     #   retraining finished.
     # @param classifier_id [String] The ID of the classifier.
-    # @option args classname_positive_examples [File] A .zip file of images that depict the visual subject of a class in the classifier.
+    # @param positive_examples [Hash] A .zip file of images that depict the visual subject of a class in the classifier.
     #   The positive examples create or update classes in the classifier. You can include
     #   more than one positive example file in a call.
     #
@@ -385,55 +399,55 @@ module IBMWatson
     #   MB per .zip file.
     #
     #   Encode special characters in the file name in UTF-8.
-    # @option args negative_examples [File] A .zip file of images that do not depict the visual subject of any of the classes
+    # @param negative_examples [File] A .zip file of images that do not depict the visual subject of any of the classes
     #   of the new classifier. Must contain a minimum of 10 images.
     #
     #   Encode special characters in the file name in UTF-8.
-    # @option args classname_positive_examples_filename [String] The filename for classname_positive_examples.
-    # @option args negative_examples_filename [String] The filename for negative_examples.
+    # @param positive_examples_filename [Hash] The filename for positive_examples.
+    # @param negative_examples_filename [String] The filename for negative_examples.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
-    def update_classifier(classifier_id:, **args)
-      raise ArgumentError("classifier_id must be provided") if classifier_id.nil?
+    def update_classifier(classifier_id:, positive_examples: nil, negative_examples: nil, positive_examples_filename: nil, negative_examples_filename: nil)
+      raise ArgumentError.new("classifier_id must be provided") if classifier_id.nil?
+
+      raise ArgumentError.new("positive_examples must be a hash") unless positive_examples.nil? || positive_examples.is_a?(Hash)
+
+      raise ArgumentError.new("positive_examples_filename must be a hash") unless positive_examples_filename.nil? || positive_examples_filename.is_a?(Hash)
 
       headers = {
       }
+
       params = {
         "version" => @version
       }
-      positive_keys = args.keys
-      positive_keys.keep_if { |key| key.to_s.end_with?("_positive_examples") }
-      mime_type = "application/octet-stream"
-      positive_keys.each do |k|
-        unless args[k].instance_of?(StringIO) || args[k].instance_of?(File)
-          args[k] = args[k].respond_to?(:to_json) ? StringIO.new(args[k].to_json) : StringIO.new(args[k])
-        end
-        if !args[(k.to_s + "_filename").to_sym].nil?
-          args[k] = args[k].instance_of?(StringIO) ? HTTP::FormData::File.new(args[k], content_type: mime_type, filename: args[(k.to_s + "_filename").to_sym]) : HTTP::FormData::File.new(args[k].path, content_type: mime_type, filename: args[(k.to_s + "_filename").to_sym])
-        else
-          args[k] = args[k].instance_of?(StringIO) ? HTTP::FormData::File.new(args[k], content_type: mime_type) : HTTP::FormData::File.new(args[k].path, content_type: mime_type)
+
+      form_data = {}
+
+      positive_examples&.each do |key, value|
+        part_name = "%s_positive_examples" % key.to_s
+        unless value.instance_of?(StringIO) || value.instance_of?(File)
+          value = value.respond_to?(:to_json) ? StringIO.new(value.to_json) : StringIO.new(value)
         end
+        filename = positive_examples_filename[key] if !positive_examples_filename.nil? && positive_examples_filename.key?(key)
+        filename = value.path if filename.nil? && value.respond_to?(:path)
+        form_data[part_name.to_sym] = HTTP::FormData::File.new(value, content_type: "application/octet-stream", filename: filename)
       end
-      unless args[:negative_examples].nil?
-        mime_type = "application/octet-stream"
-        unless args[:negative_examples].instance_of?(StringIO) || args[:negative_examples].instance_of?(File)
-          args[:negative_examples] = args[:negative_examples].respond_to?(:to_json) ? StringIO.new(args[:negative_examples].to_json) : StringIO.new(args[:negative_examples])
-        end
-        if args[:negative_examples_filename]
-          args[:negative_examples] = args[:negative_examples].instance_of?(StringIO) ? HTTP::FormData::File.new(args[:negative_examples], content_type: mime_type, filename: args[:negative_examples_filename]) : HTTP::FormData::File.new(args[:negative_examples].path, content_type: mime_type, filename: args[:negative_examples_filename])
-        else
-          args[:negative_examples] = args[:negative_examples].instance_of?(StringIO) ? HTTP::FormData::File.new(args[:negative_examples], content_type: mime_type) : HTTP::FormData::File.new(args[:negative_examples].path, content_type: mime_type)
+
+      unless negative_examples.nil?
+        unless negative_examples.instance_of?(StringIO) || negative_examples.instance_of?(File)
+          negative_examples = negative_examples.respond_to?(:to_json) ? StringIO.new(negative_examples.to_json) : StringIO.new(negative_examples)
         end
+        negative_examples_filename = negative_examples.path if negative_examples_filename.nil? && negative_examples.respond_to?(:path)
+        form_data[:negative_examples] = HTTP::FormData::File.new(negative_examples, content_type: "application/octet-stream", filename: negative_examples_filename)
       end
-      form_hash = {}
-      positive_keys.each { |k| form_hash[k] = args[k] }
-      form_hash[:negative_examples] = args[:negative_examples] unless args[:negative_examples].nil?
+
       method_url = "/v3/classifiers/%s" % [ERB::Util.url_encode(classifier_id)]
+
       response = request(
         method: "POST",
         url: method_url,
         headers: headers,
         params: params,
-        form: form_hash,
+        form: form_data,
         accept_json: true
       )
       response
@@ -445,14 +459,17 @@ module IBMWatson
     # @param classifier_id [String] The ID of the classifier.
     # @return [nil]
     def delete_classifier(classifier_id:)
-      raise ArgumentError("classifier_id must be provided") if classifier_id.nil?
+      raise ArgumentError.new("classifier_id must be provided") if classifier_id.nil?
 
       headers = {
       }
+
       params = {
         "version" => @version
       }
+
       method_url = "/v3/classifiers/%s" % [ERB::Util.url_encode(classifier_id)]
+
       request(
         method: "DELETE",
         url: method_url,
@@ -474,14 +491,17 @@ module IBMWatson
     # @param classifier_id [String] The ID of the classifier.
     # @return [DetailedResponse] A `DetailedResponse` object representing the response.
     def get_core_ml_model(classifier_id:)
-      raise ArgumentError("classifier_id must be provided") if classifier_id.nil?
+      raise ArgumentError.new("classifier_id must be provided") if classifier_id.nil?
 
       headers = {
       }
+
       params = {
         "version" => @version
       }
+
       method_url = "/v3/classifiers/%s/core_ml_model" % [ERB::Util.url_encode(classifier_id)]
+
       response = request(
         method: "GET",
         url: method_url,
@@ -508,15 +528,18 @@ module IBMWatson
     # @param customer_id [String] The customer ID for which all data is to be deleted.
     # @return [nil]
     def delete_user_data(customer_id:)
-      raise ArgumentError("customer_id must be provided") if customer_id.nil?
+      raise ArgumentError.new("customer_id must be provided") if customer_id.nil?
 
       headers = {
       }
+
       params = {
         "version" => @version,
         "customer_id" => customer_id
       }
+
       method_url = "/v3/user_data"
+
       request(
         method: "DELETE",
         url: method_url,

data/test/integration/test_compare_comply_v1.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require_relative("./../test_helper.rb")
+require("minitest/hooks/test")
+
+if !ENV["COMPARE_COMPLY_APIKEY"].nil?
+  # Integration tests for the Discovery V1 Service
+  class CompareComplyV1Test < Minitest::Test
+    include Minitest::Hooks
+    attr_accessor :service, :environment_id, :collection_id
+
+    def before_all
+      @service = IBMWatson::CompareComplyV1.new(
+        iam_apikey: ENV["COMPARE_COMPLY_APIKEY"],
+        version: "2018-10-15"
+      )
+      @service.add_default_headers(
+        headers: {
+          "X-Watson-Learning-Opt-Out" => "1",
+          "X-Watson-Test" => "1"
+        }
+      )
+    end
+
+    def test_convert_to_html
+      File.open(Dir.getwd + "/resources/cnc_test.pdf") do |file_info|
+        response = @service.convert_to_html(
+          file: file_info
+        ).result
+        refute(response.nil?)
+      end
+    end
+
+    def test_classiffy_elements
+      File.open(Dir.getwd + "/resources/cnc_test.pdf") do |file_info|
+        response = @service.classify_elements(
+          file: file_info
+        ).result
+        refute(response.nil?)
+      end
+    end
+
+    def test_extract_tables
+      File.open(Dir.getwd + "/resources/cnc_test.pdf") do |file_info|
+        response = @service.extract_tables(
+          file: file_info
+        ).result
+        refute(response.nil?)
+      end
+    end
+
+    def test_compare_documents
+      file_1 = File.open(Dir.getwd + "/resources/cnc_test.pdf")
+      file_2 = File.open(Dir.getwd + "/resources/cnc_test.pdf")
+      response = @service.compare_documents(
+        file_1: file_1,
+        file_2: file_2
+      ).result
+      refute(response.nil?)
+    end
+
+    def test_list_feedback
+      response = @service.list_feedback.result
+      refute(response.nil?)
+    end
+
+    def test_get_feedback
+      @service_dup = IBMWatson::CompareComplyV1.new(
+        iam_apikey: ENV["COMPARE_COMPLY_APIKEY"],
+        version: "2018-10-15"
+      )
+      @service_dup.add_default_headers(
+        headers: {
+          "X-Watson-Learning-Opt-Out" => "1",
+          "X-Watson-Test" => "1",
+          "x-watson-metadata" => "customer_id=sdk-test-customer-id"
+        }
+      )
+      response = @service_dup.get_feedback(
+        feedback_id: ENV["COMPARE_COMPLY_FEEDBACK_ID"]
+      ).result
+      refute(response.nil?)
+    end
+
+    def test_create_batch
+      skip "Skip to allow for concurrent travis jobs"
+      input_file = File.open(Dir.getwd + "/resources/cnc_input_credentials_file.json")
+      output_file = File.open(Dir.getwd + "/resources/cnc_output_credentials_file.json")
+      response = @service.create_batch(
+        function: "tables",
+        input_credentials_file: input_file,
+        input_bucket_location: "us-south",
+        input_bucket_name: "compare-comply-integration-test-bucket-input",
+        output_credentials_file: output_file,
+        output_bucket_location: "us-south",
+        output_bucket_name: "compare-comply-integration-test-bucket-output"
+      ).result
+      refute(response.nil?)
+    end
+
+    def test_list_batches
+      response = @service.list_batches.result
+      refute(response.nil?)
+    end
+  end
+else
+  class CompareComplyV1Test < Minitest::Test
+    def test_missing_credentials_skip_integration
+      skip "Skip discovery integration tests because credentials have not been provided"
+    end
+  end
+end