skylab_studio 1.0.6 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f99a61b73fab6e35ba741ca1c841822634c163b1542e96008f4a6126c7fc7e1e
-  data.tar.gz: 41cf785d1ff581766b3ba7fc05bd262648cbf0dde78daaabe3558c09e176dd9a
+  metadata.gz: 8dcea80a2765d6d89b736dbdaf420595a284c66b1c2319bdb537e6dce55d6c29
+  data.tar.gz: 26870d180ef19254df91ce67ffeb150564c6a144ccbc8965414c48938f687486
 SHA512:
-  metadata.gz: 06ca0fa9eb3a14c85c463abfe59b275a612181ffbfe1db9c5f3b61fda266911372446ecdf1db3c0666376b972ca7dec5147dec1ea6e14fdf3862bbd4df0f4855
-  data.tar.gz: 1aaaf67aeb7be27fd165a7b75d324db4408188b238d0b06eda13ff1f18dbd52969b09ee230ddac8b10422033f4da0b5c728d9687f82891fb578be087d15dec75
+  metadata.gz: b01781324fb9c33b8720b54d218ed0c60f346069b04ac646e720b641c85316ef140d96821d69f1054c73a997445a0c1cc4adbf56be3c2f3a765e42c7354ea6d4
+  data.tar.gz: e78732d764037a41fad813879db50e04defe51ac4eb2eadd1c437693f5e8e58489c5795d135f0c4e81a3d3a4c2d17b024d2897e6733603ec5d81d8a8f41cfef6

data/lib/skylab_studio/client.rb

@@ -1,9 +1,13 @@
+# frozen_string_literal: true
+
 require_relative 'error'
 require 'fileutils'
 require 'digest'
 require 'open-uri'
 require 'base64'
 require 'net/http'
+require 'vips'
+require 'concurrent'
 
 module SkylabStudio
   class ClientNilArgument < Error; end
@@ -30,8 +34,8 @@ module SkylabStudio
       @configuration = SkylabStudio::Config.new(settings)
     end
 
-    def list_jobs(options = {})
-      SkylabStudio::Request.new(@configuration).get(:jobs, options)
+    def list_jobs()
+      SkylabStudio::Request.new(@configuration).get(:jobs)
     end
 
     def create_job(options = {})
@@ -41,10 +45,10 @@ module SkylabStudio
       SkylabStudio::Request.new(@configuration).post(:jobs, options)
     end
 
-    def get_job(options = {})
-      validate_argument_presence options, :id
+    def get_job(job_id)
+      validate_argument_presence nil, :job_id
 
-      SkylabStudio::Request.new(@configuration).get("jobs/#{options[:id]}", options)
+      SkylabStudio::Request.new(@configuration).get("jobs/#{job_id}")
     end
 
     def get_job_by_name(options = {})
@@ -53,11 +57,10 @@ module SkylabStudio
       SkylabStudio::Request.new(@configuration).get('jobs/find_by_name', options)
     end
 
-    def update_job(options = {})
-      validate_argument_presence options, :id
-      validate_argument_presence options, :job
+    def update_job(job_id, options = {})
+      validate_argument_presence nil, :job_id
 
-      SkylabStudio::Request.new(@configuration).patch("jobs/#{options[:id]}", options)
+      SkylabStudio::Request.new(@configuration).patch("jobs/#{job_id}", options)
     end
 
     def queue_job(options = {})
@@ -66,20 +69,20 @@ module SkylabStudio
       SkylabStudio::Request.new(@configuration).post("jobs/#{options[:id]}/queue", options)
     end
 
-    def fetch_jobs_in_front(options = {})
-      SkylabStudio::Request.new(@configuration).get("jobs/#{options[:id]}/jobs_in_front", options)
+    def fetch_jobs_in_front(job_id)
+      SkylabStudio::Request.new(@configuration).get("jobs/#{job_id}/jobs_in_front")
     end
 
-    def delete_job(options = {})
-      validate_argument_presence options, :id
+    def delete_job(job_id)
+      validate_argument_presence nil, :job_id
 
-      SkylabStudio::Request.new(@configuration).delete("jobs/#{options[:id]}")
+      SkylabStudio::Request.new(@configuration).delete("jobs/#{job_id}")
     end
 
-    def cancel_job(options = {})
-      validate_argument_presence options, :id
+    def cancel_job(job_id)
+      validate_argument_presence nil, :job_id
 
-      SkylabStudio::Request.new(@configuration).post("jobs/#{options[:id]}/cancel", options)
+      SkylabStudio::Request.new(@configuration).post("jobs/#{job_id}/cancel", nil)
     end
 
     def list_profiles(options = {})
@@ -92,17 +95,16 @@ module SkylabStudio
       SkylabStudio::Request.new(@configuration).post(:profiles, options)
     end
 
-    def get_profile(options = {})
-      validate_argument_presence options, :id
+    def get_profile(profile_id)
+      validate_argument_presence nil, :profile_id
 
-      SkylabStudio::Request.new(@configuration).get("profiles/#{options[:id]}", options)
+      SkylabStudio::Request.new(@configuration).get("profiles/#{profile_id}")
     end
 
-    def update_profile(options = {})
-      validate_argument_presence options, :id
-      validate_argument_presence options, :profile
+    def update_profile(profile_id, options = {})
+      validate_argument_presence nil, :profile_id
 
-      SkylabStudio::Request.new(@configuration).patch("profiles/#{options[:id]}", options)
+      SkylabStudio::Request.new(@configuration).patch("profiles/#{profile_id}", options)
     end
 
     def upload_job_photo(photo_path = nil, job_id = nil)
@@ -119,31 +121,123 @@ module SkylabStudio
       upload_photo(photo_path, profile_id, 'profile')
     end
 
-    def get_photo(options = {})
-      validate_argument_presence options, :id
+    def get_photo(photo_id)
+      validate_argument_presence nil, :photo_id
 
-      SkylabStudio::Request.new(@configuration).get("photos/#{options[:id]}", options)
+      SkylabStudio::Request.new(@configuration).get("photos/#{photo_id}")
     end
 
-    def get_job_photos(job_identifier, value)
-      {
-        "job_#{job_identifier}".to_sym => value
-      }
+    def get_job_photos(job_id)
+      SkylabStudio::Request.new(@configuration).get('photos/list_for_job', { job_id: job_id })
+    end
+
+    def delete_photo(photo_id)
+      validate_argument_presence nil, :photo_id
 
-      SkylabStudio::Request.new(@configuration).get('phtos/list_for_job', options)
+      SkylabStudio::Request.new(@configuration).delete("photos/#{photo_id}")
     end
 
-    def update_photo(options = {})
-      validate_argument_presence options, :id
-      validate_argument_presence options, :photo
+    def download_photo(photo_id, output_path, profile: nil, options: {})
+      file_name = ''
+
+      unless Dir.exist?(output_path)
+        # Must be a file path - separate output_path and file_name
+        file_name = File.basename(output_path)
+        output_path = File.dirname(output_path) || ''
+      end
 
-      SkylabStudio::Request.new(@configuration).patch("photos/#{options[:id]}", options)
+      begin
+        photo = get_photo(photo_id)
+        profile_id = photo['job']['profileId']
+
+        file_name = photo['name'] if file_name.empty?
+
+        profile ||= get_profile(profile_id)
+
+        is_extract = profile['enableExtract'].to_s == 'true'
+        replace_background = profile['replaceBackground'].to_s == 'true'
+        is_dual_file_output = profile['dualFileOutput'].to_s == 'true'
+        profile['enableStripPngMetadata'].to_s
+        bgs = options[:bgs]
+
+        # Load output image
+        image_buffer = download_image_async(photo['retouchedUrl'])
+        image = Vips::Image.new_from_buffer(image_buffer, '')
+
+        if is_extract # Output extract image
+          png_file_name = "#{File.basename(file_name, '.*')}.png"
+
+          # Dual File Output will provide an image in the format specified in the outputFileType field
+          # and an extracted image as a PNG.
+          image.write_to_file(File.join(output_path, png_file_name)) if is_dual_file_output
+
+          download_replaced_background_image(file_name, image, output_path, profile: profile, bgs: bgs) if replace_background
+
+          # Regular Extract output
+          image.write_to_file(File.join(output_path, png_file_name)) unless is_dual_file_output || replace_background
+        else # Non-extracted regular image output
+          image.write_to_file(File.join(output_path, file_name))
+        end
+
+        puts "Successfully downloaded: #{file_name}"
+        [file_name, true]
+      rescue StandardError => e
+        error_msg = "Failed to download photo id: #{photo_id} - #{e}"
+        raise error_msg if options[:return_on_error].nil?
+
+        [file_name, false]
+      end
     end
 
-    def delete_photo(options = {})
-      validate_argument_presence options, :id
+    def download_all_photos(photos_list, profile, output_path)
+      raise 'Invalid output path' unless Dir.exist?(output_path)
+
+      success_photos = []
+      errored_photos = []
+      bgs = []
+
+      begin
+        profile = get_profile(profile['id'])
+        bgs = download_bg_images(profile) if profile && profile['photos']&.any?
+
+        photo_ids = photos_list.map { |photo| photo['id'].to_s }.compact
+
+        pool = Concurrent::FixedThreadPool.new(@configuration.settings[:max_download_concurrency])
+        download_tasks = []
+        photo_options = { return_on_error: true, bgs: bgs }
+        photo_ids.each do |photo_id|
+          download_tasks << Concurrent::Future.execute(executor: pool) do
+            download_photo(photo_id.to_i, output_path, profile: profile, options: photo_options)
+          end
+        end
 
-      SkylabStudio::Request.new(@configuration).delete("photos/#{options[:id]}")
+        # Wait for all download tasks to complete
+        results = download_tasks.map(&:value)
+        results.each do |result|
+          if result[1]
+            success_photos << result[0]
+          else
+            errored_photos << result[0]
+          end
+        end
+
+        { success_photos: success_photos, errored_photos: errored_photos }
+      rescue StandardError => e
+        warn e
+
+        { success_photos: success_photos, errored_photos: errored_photos }
+      end
+    end
+
+    def validate_hmac_headers(secret_key, job_json_string, request_timestamp, signature)
+      message = "#{request_timestamp}:#{job_json_string}".encode('utf-8')
+    
+      # Create the HMAC signature using SHA-256
+      hmac_digest = OpenSSL::HMAC.digest('sha256', secret_key.encode('utf-8'), message)
+      generated_sig = Base64.strict_encode64(hmac_digest).force_encoding('utf-8')
+    
+      # Compare the provided signature with the generated signature
+      signature == generated_sig
     end
 
     private
@@ -157,7 +251,6 @@ module SkylabStudio
     end
 
     def upload_photo(photo_path, id, model = 'job')
-      res = {}
       valid_exts_to_check = %w[.jpg .jpeg .png .webp]
 
       raise 'Invalid file type: must be of type jpg/jpeg/png/webp' unless valid_exts_to_check.any? { |ext| photo_path.downcase.end_with?(ext) }
@@ -167,6 +260,7 @@ module SkylabStudio
       raise 'Invalid file size: must be no larger than 27MB' if file_size > 27 * 1024 * 1024
 
       photo_name = File.basename(photo_path)
+      photo_ext = File.extname(photo_name)
       headers = {}
       md5hash = ''
 
@@ -178,10 +272,10 @@ module SkylabStudio
       end
 
       # model - either job or profile (job_id/profile_id)
-      photo_data = { "#{model}_id" => id, name: photo_name, 'use_cache_upload' => false }
+      photo_data = { "#{model}_id": id, name: "#{photo_name}#{photo_ext}", path: photo_path, 'use_cache_upload': false }
 
       if model == 'job'
-        job_type = get_job(id: id)['type']
+        job_type = get_job(id)['type']
 
         headers = { 'X-Amz-Tagging' => 'job=photo&api=true' } if job_type == 'regular'
       end
@@ -213,7 +307,7 @@ module SkylabStudio
         uri = URI(upload_url)
         request = Net::HTTP::Put.new(uri, headers)
         request.body = data
-        upload_photo_resp = Net::HTTP.start(uri.hostname) {|http| http.request(request) }
+        upload_photo_resp = Net::HTTP.start(uri.hostname) { |http| http.request(request) }
 
         unless upload_photo_resp
           puts 'First upload attempt failed, retrying...'
@@ -221,7 +315,7 @@ module SkylabStudio
           # Retry upload
 
           while retry_count < 3
-            upload_photo_resp = Net::HTTP.start(uri.hostname) {|http| http.request(request) }
+            upload_photo_resp = Net::HTTP.start(uri.hostname) { |http| http.request(request) }
             if upload_photo_resp
               break # Upload was successful, exit the loop
             elsif retry_count == 2 # Check if retry count is 2 (0-based indexing)
@@ -241,6 +335,70 @@ module SkylabStudio
       photo_response_json
     end
 
+    def download_image_async(image_url)
+      raise "Invalid retouchedUrl: \"#{image_url}\" - Please ensure the job is complete" unless image_url.start_with?('http', 'https')
+
+      begin
+        uri = URI(image_url)
+        response = Net::HTTP.get_response(uri)
+
+        if response.is_a?(Net::HTTPSuccess)
+          response.body
+
+        else
+          puts "Error downloading image: #{response.message}"
+          nil
+        end
+      rescue StandardError => e
+        puts "Error downloading image: #{e.message}"
+        nil
+      end
+    end
+
+    def download_bg_images(profile)
+      temp_bgs = []
+
+      bg_photos = profile['photos'].select { |photo| photo['jobId'].nil? }
+
+      bg_photos.each do |bg|
+        bg_buffer = download_image_async(bg['originalUrl'])
+        bg_image = Vips::Image.new_from_buffer(bg_buffer, '')
+        temp_bgs << bg_image
+      end
+
+      temp_bgs
+    end
+
+    def download_replaced_background_image(file_name, input_image, output_path, profile: nil, bgs: nil)
+      output_file_type = profile&.[]('outputFileType') || 'png'
+
+      bgs = download_bg_images(profile) if bgs.nil? && !profile.nil? && profile&.[]('photos')&.any?
+
+      alpha_channel = input_image[3]
+      rgb_channel = input_image[0..2]
+      rgb_cutout = rgb_channel.bandjoin(alpha_channel)
+
+      if bgs&.any?
+        bgs.each_with_index do |bg_image, i|
+          new_file_name = if i.zero?
+                            "#{File.basename(file_name,
+                                             '.*')}.#{output_file_type}"
+                          else
+                            "#{File.basename(file_name,
+                                             '.*')} (#{i + 1}).#{output_file_type}"
+                          end
+          resized_bg_image = bg_image.thumbnail_image(input_image.width, height: input_image.height, crop: :centre)
+          result_image = resized_bg_image.composite2(rgb_cutout, :over)
+          result_image.write_to_file(File.join(output_path, new_file_name))
+        end
+      end
+
+      true
+    rescue StandardError => e
+      error_msg = "Error downloading background image: #{e.message}"
+      raise error_msg
+    end
+
     def validate_argument_presence(options, key)
       raise SkylabStudio::ClientNilArgument, "#{key} cannot be nil" if options.is_a?(Hash) && options[key].nil?
 

data/lib/skylab_studio/config.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require_relative 'version'
 
 module SkylabStudio
   class Config
     attr_accessor :settings
 
-    DEFAULT_URL = 'https://studio.skylabtech.ai'.freeze
+    DEFAULT_URL = 'https://studio.skylabtech.ai'
 
     def self.defaults
       source = URI.parse(DEFAULT_URL)
@@ -17,7 +19,8 @@ module SkylabStudio
         port: source.port,
         api_version: 'v1',
         debug: true,
-        client_stub: "ruby-#{VERSION}"
+        client_stub: "ruby-#{VERSION}",
+        max_download_concurrency: 5
       }
     end
 

data/lib/skylab_studio/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SkylabStudio
-  VERSION = '1.0.6'
+  VERSION = '1.0.8'
 end

data/spec/lib/skylab_studio/client_spec.rb

@@ -48,13 +48,13 @@ RSpec.describe SkylabStudio::Client do
 
   describe '#get_job' do
     it 'should raise error with no id' do
-      expect { subject.get_job }.to raise_error(SkylabStudio::ClientNilArgument)
+      expect { subject.get_job }.to raise_error(ArgumentError)
     end
 
     it 'should return response' do
       SkylabStudio::Request.any_instance.stub(:get).and_return(true)
 
-      subject.get_job(id: 123).should eq(true)
+      subject.get_job(123).should eq(true)
     end
   end
 
@@ -62,12 +62,7 @@ RSpec.describe SkylabStudio::Client do
     it 'should return response' do
       SkylabStudio::Request.any_instance.stub(:patch).and_return(true)
 
-      subject.update_job(
-        id: 1,
-        job: {
-          profile_id: 2
-        }
-      ).should eq(true)
+      subject.update_job(1, { profile_id: 2 }).should eq(true)
     end
   end
 
@@ -75,9 +70,7 @@ RSpec.describe SkylabStudio::Client do
     it 'should return response' do
       SkylabStudio::Request.any_instance.stub(:delete).and_return(true)
 
-      subject.delete_job(
-        id: 1
-      ).should eq(true)
+      subject.delete_job(1).should eq(true)
     end
   end
 
@@ -95,9 +88,7 @@ RSpec.describe SkylabStudio::Client do
     it 'should return response' do
       SkylabStudio::Request.any_instance.stub(:post).and_return(true)
 
-      subject.cancel_job(
-        id: 1
-      ).should eq(true)
+      subject.cancel_job(1).should eq(true)
     end
   end
 
@@ -123,13 +114,13 @@ RSpec.describe SkylabStudio::Client do
 
   describe '#get_profile' do
     it 'should raise error with no id' do
-      expect { subject.get_profile }.to raise_error(SkylabStudio::ClientNilArgument)
+      expect { subject.get_profile }.to raise_error(ArgumentError)
     end
 
     it 'should return response' do
       SkylabStudio::Request.any_instance.stub(:get).and_return(true)
 
-      subject.get_profile(id: 123).should eq(true)
+      subject.get_profile(123).should eq(true)
     end
   end
 
@@ -137,12 +128,7 @@ RSpec.describe SkylabStudio::Client do
     it 'should return response' do
       SkylabStudio::Request.any_instance.stub(:patch).and_return(true)
 
-      subject.update_profile(
-        id: 1,
-        profile: {
-          name: 'Bar'
-        }
-      ).should eq(true)
+      subject.update_profile(1, { name: 'Bar' } ).should eq(true)
     end
   end
 
@@ -152,24 +138,27 @@ RSpec.describe SkylabStudio::Client do
         .to_return(status: 200, body: { id: 1, photo: {} }.to_json, headers: {})
 
       stub_request(:get, 'https://studio.skylabtech.ai/api/public/v1/photos/upload_url')
-        .to_return(status: 200, body: '', headers: {})
+        .to_return(status: 200, body: { url: 'http://test.test/' }.to_json, headers: {})
 
       stub_request(:get, 'https://studio.skylabtech.ai/api/public/v1/jobs/1')
-        .to_return(status: 200, body: '', headers: {})
+        .to_return(status: 200, body: {}.to_json, headers: {})
 
       stub_request(:delete, 'https://studio.skylabtech.ai/api/public/v1/photos/1')
         .to_return(status: 200, body: { id: 1 }.to_json, headers: {})
 
-      allow_any_instance_of(Net::HTTPSuccess).to receive(:body) { { id: 1 }.to_json }
+      stub_request(:put, /.*/)
+        .to_return(status: 200, body: {}.to_json, headers: {})
+
+      # allow_any_instance_of(Net::HTTPSuccess).to receive(:body) { { id: 1 }.to_json }
     end
 
     it 'should return response' do
       photo_path = "#{File.expand_path('../../', File.dirname(__FILE__))}/test-portrait-1.JPG"
       id = 1
 
-      expected_response = { "id" => id }
+      expected_response = { id: id, photo: {} }.to_json
 
-      subject.upload_job_photo(photo_path, id).should eq(expected_response)
+      expect(subject.upload_job_photo(photo_path, id).to_json).to eq(expected_response)
     end
   end
 
@@ -179,49 +168,40 @@ RSpec.describe SkylabStudio::Client do
         .to_return(status: 200, body: { id: 1, photo: {} }.to_json, headers: {})
 
       stub_request(:get, 'https://studio.skylabtech.ai/api/public/v1/photos/upload_url')
-        .to_return(status: 200, body: '', headers: {})
+        .to_return(status: 200, body: { url: 'http://test.test/' }.to_json, headers: {})
+
+      stub_request(:get, 'https://studio.skylabtech.ai/api/public/v1/profiles/upload_url')
+        .to_return(status: 200, body: { url: 'http://test.test/' }.to_json, headers: {})
 
       stub_request(:get, 'https://studio.skylabtech.ai/api/public/v1/jobs/1')
-        .to_return(status: 200, body: '', headers: {})
+        .to_return(status: 200, body: {}.to_json, headers: {})
 
       stub_request(:delete, 'https://studio.skylabtech.ai/api/public/v1/photos/1')
         .to_return(status: 200, body: { id: 1 }.to_json, headers: {})
 
-      allow_any_instance_of(Net::HTTPSuccess).to receive(:body) { { id: 1 }.to_json }
+      stub_request(:put, /.*/)
+        .to_return(status: 200, body: {}.to_json, headers: {})
     end
 
     it 'should return response' do
       photo_path = "#{File.expand_path('../../', File.dirname(__FILE__))}/test-portrait-1.JPG"
       id = 1
 
-      expected_response = { "id" => id }
+      expected_response = { id: id, photo: {} }.to_json
 
-      subject.upload_profile_photo(photo_path, 1).should eq(expected_response)
+      expect(subject.upload_profile_photo(photo_path, 1).to_json).to eq(expected_response)
     end
   end
 
   describe '#get_photo' do
     it 'should raise error with no id' do
-      expect { subject.get_photo }.to raise_error(SkylabStudio::ClientNilArgument)
+      expect { subject.get_photo }.to raise_error(ArgumentError)
     end
 
     it 'should return response' do
       SkylabStudio::Request.any_instance.stub(:get).and_return(true)
 
-      subject.get_photo(id: 123).should eq(true)
-    end
-  end
-
-  describe '#update_photo' do
-    it 'should return response' do
-      SkylabStudio::Request.any_instance.stub(:patch).and_return(true)
-
-      subject.update_photo(
-        id: 1,
-        photo: {
-          name: 'Bar'
-        }
-      ).should eq(true)
+      subject.get_photo(123).should eq(true)
     end
   end
 
@@ -229,9 +209,7 @@ RSpec.describe SkylabStudio::Client do
     it 'should return response' do
       SkylabStudio::Request.any_instance.stub(:delete).and_return(true)
 
-      subject.delete_photo(
-        id: 1
-      ).should eq(true)
+      subject.delete_photo(1).should eq(true)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skylab_studio
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.8
 platform: ruby
 authors:
 - Paul Lam
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-20 00:00:00.000000000 Z
+date: 2024-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec