gettyimages-api 3.0.2 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bac4842026fc933c71984784db414c41e47a735cf21c87c35677c9301f083cce
-  data.tar.gz: 59043fcb36bac1d9389d70e71c84db00fb27216ccaadf338e1088245503bbe85
+  metadata.gz: 2a8ee53bb4ec7229bcebe8dcfaa801dbbad4e93d4445de51c2ec47a3e8bc0656
+  data.tar.gz: 62b5ea7d0b7026a00f96321809535169628f517ca93484198eb55ba036ca1abb
 SHA512:
-  metadata.gz: fb3bf4ba8313213e4664666c334b862ca1834f35f23540cbbf6a77540232abe0ebcf83c516e6fe2cfa19d4f2514993b60148c9807b3d9e42d2c497abfe948c54
-  data.tar.gz: 3527a5473f84b05151cebf46970d776381087bd20443a3381230efec5a414a983e6d15798a545326f99f55367cdf8daa224fe1427c1ad034ee7d160285f0f9fc
+  metadata.gz: 932551fd6e8c14c213ed7c100a90b7ea142e246379e963dee94994659a7a465f79a94c80fcffe3e5b7e6f37aca98a6451a35748688c3e9d909da556d4dfe190f
+  data.tar.gz: c343f59aa09825053609d4600456caff381f2bc96d797b66971edcb271ec85ee5ebdf1103e25885b6d5ef01bd06c97ddd8fc1d043b249301b6e223e1e234c233

data/.github/workflows/build.yml

@@ -2,9 +2,9 @@ name: Build
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 jobs:
   test:

data/Gemfile

@@ -4,3 +4,4 @@ gem 'rake'
 gem 'json'
 gem 'test-unit'
 gem 'webmock'
+gem 'rexml'

data/Gemfile.lock

@@ -10,6 +10,7 @@ GEM
     power_assert (1.1.6)
     public_suffix (4.0.6)
     rake (13.0.1)
+    rexml (3.2.5)
     safe_yaml (1.0.5)
     test-unit (3.3.5)
       power_assert
@@ -27,8 +28,9 @@ PLATFORMS
 DEPENDENCIES
   json
   rake
+  rexml
   test-unit
   webmock
 
 BUNDLED WITH
-   2.1.4
+   2.2.22

data/Makefile

@@ -1,5 +1,19 @@
+shell = /bin/sh
+UID := $(shell id -u)
+GID := $(shell id -g)
+
 build:
 	bundle config set --local path 'vendor/bundle'
-	bundle install --path vendor/bundle
+	bundle install 
 	bundle exec rake
 	gem build gettyimages-api.gemspec
+
+test:
+	rake
+
+# Run a Ruby container with the current directory mounted and as the
+# current user. This allows development without installing Ruby on your
+# system or if you have a version of Ruby not supported by the SDK.
+docker:
+	env UID=${UID} GID=${UID} docker run -it --net=host -v /${PWD}:/workdir -w //workdir -u ${UID}:${GID} ruby:2.7 /bin/bash
+	

data/README.md

@@ -40,7 +40,7 @@ api_secret = "API Secret"
 # create instance of the SDK
 apiClient = ApiClient.new(api_key, api_secret)
 result = apiClient
-    .search_images()
+    .search_images_creative()
     .with_phrase("gorilla")
     .with_fields(["artist", "id", "title"])
     .with_exclude_nudity("true")
@@ -109,6 +109,18 @@ result = apiClient
 puts result["uri"]
 ```
 
+### Make a request using custom parameter and header
+
+```ruby
+apiClient = ApiClient.new(api_key, api_secret)
+result = apiClient
+    .search_images_creative()
+    .with_phrase("beach")
+    .with_custom_parameter("safe_search", "true")
+    .with_custom_header("gi-country-code", "CAN")
+    .execute()
+```
+
 ### Use the custom request functionality for GET request with query parameters
 
 ```ruby
@@ -155,7 +167,7 @@ _Source code is only needed if you would like to contribute to the project. Othe
 
 ### Requirements
 
-- Ruby version >= 2.5
+- Ruby version >= 3.0
 - [Bundler](http://bundler.io)
 
 Install bundler and all dependencies

data/lib/Credentials.rb

@@ -21,7 +21,7 @@ class Credentials
 	end
 
 	def get_uri(path)
-		return URI.parse "#{Api_Host::API_BASE_URL}#{path}"
+		return URI.parse "#{Api_Host::AUTH_BASE_URL}#{path}"
 	end
 
 	def token_has_expired()

data/lib/Downloads/DownloadImages.rb

@@ -2,13 +2,13 @@ require_relative "../RequestBase.rb"
 
 class DownloadImages < RequestBase
 
-    attr_accessor :asset_id, :accept_language
+    attr_accessor :asset_id
 
-	API_ROUTE = "/v3/downloads/images" # mashery endpoint	
-	QUERY_PARAMS_NAMES = ["file_type","height","product_id","product_type"]	
+	API_ROUTE = "/v3/downloads/images"
+	QUERY_PARAM_NAMES = ["file_type","height","product_id","product_type"]	
 
-	QUERY_PARAMS_NAMES.each do |key|
-    define_method :"with_#{key}" do |value = true| 
+	QUERY_PARAM_NAMES.each do |key|
+        define_method :"with_#{key}" do |value = true| 
             if (!key.include? "id") && (value.is_a?(String))
                 value.downcase!
             end	
@@ -23,16 +23,10 @@ class DownloadImages < RequestBase
         return self
     end
 
-    public
-	def with_accept_language(language)
-		@accept_language = {"Accept-Language" => language}
-		return self
-	end
-
     def execute
         build_query_params("auto_download", "false")
         uri = API_ROUTE + "/" + self.asset_id
-		return @http_helper.post(uri, @query_params, nil, accept_language)			
+		return @http_helper.post(uri, @query_params, nil, @headers)			
 	end
 
 end

data/lib/Downloads/DownloadVideos.rb

@@ -2,20 +2,17 @@ require_relative "../RequestBase.rb"
 
 class DownloadVideos < RequestBase
 
-    attr_accessor :asset_id, :accept_language
+    attr_accessor :asset_id
 
-	API_ROUTE = "/v3/downloads/videos" # mashery endpoint	
-	QUERY_PARAMS_NAMES = ["product_id","size"]	
+	API_ROUTE = "/v3/downloads/videos"
+	QUERY_PARAM_NAMES = ["product_id","size"]	
 
-	QUERY_PARAMS_NAMES.each do |key|
-    define_method :"with_#{key}" do |value = true| 
-            if (!key.include? "id") && (value.is_a?(String))
-                value.downcase!
-            end	
-            build_query_params(key, value)
-            return self
-        end
-    end
+	QUERY_PARAM_NAMES.each do |key|
+		define_method :"with_#{key}" do |value = true| 
+			add_parameter(key, value)
+			return self
+		end
+	end
       
     public 	
     def with_id(asset_id)	
@@ -23,16 +20,10 @@ class DownloadVideos < RequestBase
         return self
     end
 
-    public
-	def with_accept_language(language)
-		@accept_language = {"Accept-Language" => language}
-		return self
-	end
-
     def execute
         build_query_params("auto_download", "false")
         uri = API_ROUTE + "/" + self.asset_id
-		return @http_helper.post(uri, @query_params, nil, accept_language)			
+		return @http_helper.post(uri, @query_params, nil, @headers)			
 	end
 
 end

data/lib/GettyImagesApi/version.rb

@@ -1,3 +1,3 @@
 module GettyImagesApi
-	VERSION = "3.0.2"
+	VERSION = "3.2.0"
 end

data/lib/HttpHelper.rb

@@ -7,6 +7,8 @@ require_relative 'GettyImagesApi/version'
 class Api_Host
 	API_HOST = "api.gettyimages.com"
 	API_BASE_URL = "https://#{API_HOST}"
+	AUTH_HOST = "authentication.gettyimages.com"
+	AUTH_BASE_URL = "https://#{AUTH_HOST}"
 end
 
 class HttpHelper

data/lib/Images/Images.rb

@@ -2,21 +2,17 @@ require_relative "../RequestBase.rb"
 
 class Images < RequestBase
 
-    attr_accessor :asset_id, :accept_language
+    attr_accessor :asset_id
 
-	API_ROUTE = "/v3/images" # mashery endpoint	
-	QUERY_PARAMS_NAMES = ["ids","fields"]
+	API_ROUTE = "/v3/images"
+	QUERY_PARAM_NAMES = ["ids","fields"]
 
-	QUERY_PARAMS_NAMES.each do |key|
-    define_method :"with_#{key}" do |value = true| 
-            value = value.join(",")
-            if !key.include? "id"
-                value.downcase!
-            end	
-            build_query_params(key, value)
-    		return self
-    	end
-  	end
+	QUERY_PARAM_NAMES.each do |key|
+		define_method :"with_#{key}" do |value = true| 
+			add_parameter(key, value)
+			return self
+		end
+	end
 			
 	public 
     def with_id(id)
@@ -24,16 +20,11 @@ class Images < RequestBase
 		return self
 	end
 
-	public
-	def with_accept_language(language)
-		@accept_language = {"Accept-Language" => language}
-		return self
-	end
 
 	public
     def execute
         self.asset_id.nil? ? uri = API_ROUTE : uri = API_ROUTE + "/" + self.asset_id
-		return @http_helper.get(uri, @query_params, @accept_language)			
+		return @http_helper.get(uri, @query_params, @headers)			
 	end
 
 end

data/lib/RequestBase.rb

@@ -2,13 +2,14 @@ require_relative "HttpHelper"
 
 class RequestBase
 
-	attr_accessor :http_helper, :query_params
+	attr_accessor :http_helper, :query_params, :headers
 
 	def initialize(api_key, access_token)
 		
 		#puts "here is my token #{access_token}" 		
 		@http_helper = HttpHelper.new(api_key, access_token)						
 		@query_params = Hash.new
+		@headers = Hash.new
 
 	end	
 
@@ -17,4 +18,37 @@ class RequestBase
 		@query_params[key].nil? ? @query_params[key] = value : @query_params[key] << "," + value
 	end 
 
+	protected
+	def add_parameter(key, value)
+		if value.is_a?(Array)
+			value = value.join(",")
+			if (!key.include? "id") && (!key.include? "orientations")
+				value.downcase!
+			end	
+			build_query_params(key, value)
+		else
+			if (!key.include? "id") && (!key.include? "orientations") && (value.is_a?(String))
+				value.downcase!
+			end	
+			build_query_params(key, value)
+		end
+	end
+
+	public
+	def with_accept_language(language)
+		@headers["Accept-Language"] = language
+		return self
+	end
+
+	public
+	def with_custom_header(key, value)
+		@headers[key] = value
+		return self
+	end
+
+	public
+	def with_custom_parameter(key, value)
+		add_parameter(key, value)
+		return self
+	end
 end

data/lib/Search/SearchImages.rb

@@ -2,38 +2,20 @@ require_relative "../RequestBase.rb"
 
 class SearchImages < RequestBase
 
-	attr_accessor :accept_language
-
 	API_ROUTE = "/v3/search/images" # mashery endpoint
-	QUERY_PARAMS_NAMES = ["age_of_people","artists","collection_codes","collections_filter_type","color","compositions","embed_content_only","ethnicity","event_ids","exclude_nudity","fields",
+	QUERY_PARAM_NAMES = ["age_of_people","artists","collection_codes","collections_filter_type","color","compositions","embed_content_only","ethnicity","event_ids","exclude_nudity","fields",
 		"file_types","graphical_styles","keyword_ids","minimum_size","number_of_people","orientations","page","page_size","phrase","prestige_content_only","product_types",
 		"sort_order","specific_people"]
-
-	QUERY_PARAMS_NAMES.each do |key|
-    define_method :"with_#{key}" do |value = true| 
-			if value.is_a?(Array)
-				value = value.join(",")
-				if (!key.include? "id") && (!key.include? "orientations")
-					value.downcase!
-				end	
-    			build_query_params(key, value)
-			else
-				if (!key.include? "id") && (!key.include? "orientations") && (value.is_a?(String))
-					value.downcase!
-				end	
-    			build_query_params(key, value)
-    		end
-    		return self
-    	end
-	end
-			  
-	def with_accept_language(language)
-		@accept_language = {"Accept-Language" => language}
-		return self
+	
+	QUERY_PARAM_NAMES.each do |key|
+		define_method :"with_#{key}" do |value = true| 
+			add_parameter(key, value)
+			return self
+		end
 	end
 
 	def execute
-		return @http_helper.get(API_ROUTE, @query_params, @accept_language)			
+		return @http_helper.get(API_ROUTE, @query_params, @headers)			
 	end
 
 end

data/lib/Search/SearchImagesCreative.rb

@@ -2,38 +2,24 @@ require_relative "../RequestBase.rb"
 
 class SearchImagesCreative < RequestBase
 
-	attr_accessor :accept_language
+	QUERY_PARAM_NAMES = ["age_of_people","artists","collection_codes","collections_filter_type","color","compositions","embed_content_only","ethnicity","exclude_nudity","fields","file_types",
+		"graphical_styles","keyword_ids","minimum_size","number_of_people","orientations","page","page_size","phrase","prestige_content_only","product_types",
+		"sort_order"]
 
-	API_ROUTE = "/v3/search/images/creative" # mashery endpoint	
-    QUERY_PARAMS_NAMES = ["age_of_people","artists","collection_codes","collections_filter_type","color","compositions","embed_content_only","ethnicity","exclude_nudity","fields","file_types",
-        "graphical_styles","keyword_ids","minimum_size","number_of_people","orientations","page","page_size","phrase","prestige_content_only","product_types",
-        "sort_order"]
-
-	QUERY_PARAMS_NAMES.each do |key|
-    define_method :"with_#{key}" do |value = true| 
-			if value.is_a?(Array)
-				value = value.join(",")
-				if (!key.include? "id") && (!key.include? "orientations")
-					value.downcase!
-				end	
-    			build_query_params(key, value)
-			else
-				if (!key.include? "id") && (!key.include? "orientations") && (value.is_a?(String))
-					value.downcase!
-				end	
-    			build_query_params(key, value)
-    		end
-    		return self
-    	end
-	  end
-	  		  
-	def with_accept_language(language)
-		@accept_language = {"Accept-Language" => language}
-		return self
+	def initialize(api_key, access_token)
+		super
+		@api_route = "/v3/search/images/creative"
 	end
 
+	QUERY_PARAM_NAMES.each do |key|
+		define_method :"with_#{key}" do |value = true| 
+			add_parameter(key, value)
+			return self
+		end
+	end
+	  		  
 	def execute
-		return @http_helper.get(API_ROUTE, @query_params, @accept_language)			
+		return @http_helper.get(@api_route, @query_params, @headers)			
 	end
 
 end

data/lib/Search/SearchImagesEditorial.rb

@@ -2,38 +2,21 @@ require_relative "../RequestBase.rb"
 
 class SearchImagesEditorial < RequestBase
 
-	attr_accessor :accept_language
-
-	API_ROUTE = "/v3/search/images/editorial" # mashery endpoint	
-    QUERY_PARAMS_NAMES = ["age_of_people","artists","collection_codes","collections_filter_type","compositions","editorial_segments","embed_content_only","end_date","entity_uris","ethnicity",
+	API_ROUTE = "/v3/search/images/editorial"
+    QUERY_PARAM_NAMES = ["age_of_people","artists","collection_codes","collections_filter_type","compositions","editorial_segments","embed_content_only","end_date","entity_uris","ethnicity",
         "event_ids","exclude_nudity","fields","file_types","graphical_styles","keyword_ids","minimum_quality_rank","minimum_size","number_of_people","orientations","page","page_size","phrase",
         "product_types","sort_order","specific_people","start_date"]
 
-	QUERY_PARAMS_NAMES.each do |key|
-    define_method :"with_#{key}" do |value = true| 
-			if value.is_a?(Array)
-				value = value.join(",")
-				if (!key.include? "id") && (!key.include? "orientations")
-					value.downcase!
-				end	
-    			build_query_params(key, value)
-			else
-				if (!key.include? "id") && (!key.include? "orientations") && (value.is_a?(String))
-					value.downcase!
-				end	
-    			build_query_params(key, value)
-    		end
-    		return self
-    	end
+	QUERY_PARAM_NAMES.each do |key|
+		define_method :"with_#{key}" do |value = true| 
+			add_parameter(key, value)
+			return self
+		end
 	end
 
-	def with_accept_language(language)
-		@accept_language = {"Accept-Language" => language}
-		return self
-	end
-	  
+
 	def execute
-		return @http_helper.get(API_ROUTE, @query_params, @accept_language)			
+		return @http_helper.get(API_ROUTE, @query_params, @headers)			
 	end
 
 end

data/lib/Search/SearchVideos.rb

@@ -1,38 +1,20 @@
 require_relative "../RequestBase.rb"
 
 class SearchVideos < RequestBase
-
-	attr_accessor :accept_language
 	
-	API_ROUTE = "/v3/search/videos" # mashery endpoint	
-    QUERY_PARAMS_NAMES = ["age_of_people","collection_codes","collections_filter_type","editorial_video_types","exclude_nudity","fields","format_available","frame_rates",
+	API_ROUTE = "/v3/search/videos"
+    QUERY_PARAM_NAMES = ["age_of_people","collection_codes","collections_filter_type","editorial_video_types","exclude_nudity","fields","format_available","frame_rates",
         "keyword_ids","license_models","page","page_size","phrase","product_types","sort_order","specific_people"]
 
-	QUERY_PARAMS_NAMES.each do |key|
-    define_method :"with_#{key}" do |value = true| 
-			if value.is_a?(Array)
-				value = value.join(",")
-				if !key.include? "id"
-					value.downcase!
-				end	
-    			build_query_params(key, value)
-			else
-				if (!key.include? "id") && (value.is_a?(String))
-					value.downcase!
-				end	
-    			build_query_params(key, value)
-    		end
-    		return self
-    	end
-	end
-	
-	def with_accept_language(language)
-		@accept_language = {"Accept-Language" => language}
-		return self
+	QUERY_PARAM_NAMES.each do |key|
+		define_method :"with_#{key}" do |value = true| 
+			add_parameter(key, value)
+			return self
+		end
 	end
 
 	def execute
-		return @http_helper.get(API_ROUTE, @query_params, @accept_language)			
+		return @http_helper.get(API_ROUTE, @query_params, @headers)			
 	end
 
 end

data/lib/Search/SearchVideosCreative.rb

@@ -2,37 +2,19 @@ require_relative "../RequestBase.rb"
 
 class SearchVideosCreative < RequestBase
 
-	attr_accessor :accept_language
-
-	API_ROUTE = "/v3/search/videos/creative" # mashery endpoint	
-    QUERY_PARAMS_NAMES = ["age_of_people","collection_codes","collections_filter_type","exclude_nudity","fields","format_available","frame_rates",
+	API_ROUTE = "/v3/search/videos/creative"
+    QUERY_PARAM_NAMES = ["age_of_people","collection_codes","collections_filter_type","exclude_nudity","fields","format_available","frame_rates",
         "keyword_ids","license_models","page","page_size","phrase","product_types","sort_order"]
 
-	QUERY_PARAMS_NAMES.each do |key|
-    define_method :"with_#{key}" do |value = true| 
-			if value.is_a?(Array)
-				value = value.join(",")
-				if !key.include? "id"
-					value.downcase!
-				end	
-    			build_query_params(key, value)
-			else
-				if (!key.include? "id") && (value.is_a?(String))
-					value.downcase!
-				end	
-    			build_query_params(key, value)
-    		end
-    		return self
-    	end
-	  end
-	  
-	def with_accept_language(language)
-		@accept_language = {"Accept-Language" => language}
-		return self
+	QUERY_PARAM_NAMES.each do |key|
+		define_method :"with_#{key}" do |value = true| 
+			add_parameter(key, value)
+			return self
+		end
 	end
-
+	  
 	def execute
-		return @http_helper.get(API_ROUTE, @query_params, @accept_language)			
+		return @http_helper.get(API_ROUTE, @query_params, @headers)			
 	end
 
 end

data/lib/Search/SearchVideosEditorial.rb

@@ -2,37 +2,19 @@ require_relative "../RequestBase.rb"
 
 class SearchVideosEditorial < RequestBase
 
-	attr_accessor :accept_language
-
-	API_ROUTE = "/v3/search/videos/editorial" # mashery endpoint	
-    QUERY_PARAMS_NAMES = ["age_of_people","collection_codes","collections_filter_type","editorial_video_types","entity_uris","exclude_nudity","fields","format_available","frame_rates",
+	API_ROUTE = "/v3/search/videos/editorial"
+    QUERY_PARAM_NAMES = ["age_of_people","collection_codes","collections_filter_type","editorial_video_types","entity_uris","exclude_nudity","fields","format_available","frame_rates",
         "keyword_ids","page","page_size","phrase","product_types","sort_order","specific_people"]
 
-	QUERY_PARAMS_NAMES.each do |key|
-    define_method :"with_#{key}" do |value = true| 
-			if value.is_a?(Array)
-				value = value.join(",")
-				if !key.include? "id"
-					value.downcase!
-				end	
-    			build_query_params(key, value)
-			else
-				if (!key.include? "id") && (value.is_a?(String))
-					value.downcase!
-				end	
-    			build_query_params(key, value)
-    		end
-    		return self
-    	end
-  	end
-
-	def with_accept_language(language)
-		@accept_language = {"Accept-Language" => language}
-		return self
+	QUERY_PARAM_NAMES.each do |key|
+		define_method :"with_#{key}" do |value = true| 
+			add_parameter(key, value)
+			return self
+		end
 	end
-
+	
 	def execute
-		return @http_helper.get(API_ROUTE, @query_params, @accept_language)			
+		return @http_helper.get(API_ROUTE, @query_params, @headers)			
 	end
 
 end

data/lib/Videos/Videos.rb

@@ -2,21 +2,17 @@ require_relative "../RequestBase.rb"
 
 class Videos < RequestBase
 
-    attr_accessor :asset_id, :accept_language
+    attr_accessor :asset_id
 
-	API_ROUTE = "/v3/videos" # mashery endpoint	
-	QUERY_PARAMS_NAMES = ["ids","fields"]
+	API_ROUTE = "/v3/videos"
+	QUERY_PARAM_NAMES = ["ids","fields"]
 
-	QUERY_PARAMS_NAMES.each do |key|
-    define_method :"with_#{key}" do |value = true| 
-            value = value.join(",")
-            if !key.include? "id"
-                value.downcase!
-            end	
-            build_query_params(key, value)
-    		return self
-    	end
-  	end
+	QUERY_PARAM_NAMES.each do |key|
+		define_method :"with_#{key}" do |value = true| 
+			add_parameter(key, value)
+			return self
+		end
+	end
 			
 	public 
     def with_id(id)
@@ -24,16 +20,11 @@ class Videos < RequestBase
 		return self
 	end
 
-	public
-	def with_accept_language(language)
-		@accept_language = {"Accept-Language" => language}
-		return self
-	end
 
 	public
     def execute
         self.asset_id.nil? ? uri = API_ROUTE : uri = API_ROUTE + "/" + self.asset_id
-		return @http_helper.get(uri, @query_params, @accept_language)			
+		return @http_helper.get(uri, @query_params, @headers)			
 	end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gettyimages-api
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.2.0
 platform: ruby
 authors:
 - Getty Images
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-13 00:00:00.000000000 Z
+date: 2023-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler