Merge pull request #5 from gettyimages/accept_language_header

Add accept language header functionality
gettyimages · Jul 26, 2018 · 7df612f · 7df612f
2 parents 2874adf + b920452
commit 7df612f
Show file tree

Hide file tree

Showing 23 changed files with 292 additions and 34 deletions.
diff --git a/lib/CustomRequest/CustomRequest.rb b/lib/CustomRequest/CustomRequest.rb
@@ -2,7 +2,7 @@
 
 class CustomRequest < RequestBase
 
-    attr_accessor :method, :body, :route
+    attr_accessor :method, :body, :route, :headers
     # @route = "/v3/"
 
     def initialize(api_key, access_token)
@@ -13,13 +13,13 @@ def initialize(api_key, access_token)
     def execute
         case @method
         when "GET"
-            return @http_helper.get(@route, @query_params)
+            return @http_helper.get(@route, @query_params, self.headers)
         when "POST"
-            return @http_helper.post(@route, @query_params, self.body)
+            return @http_helper.post(@route, @query_params, self.body, self.headers)
         when "PUT"
-            return @http_helper.put(@route, @query_params, self.body)
+            return @http_helper.put(@route, @query_params, self.body, self.headers)
         when "DELETE"
-            return @http_helper.delete(@route, @query_params)
+            return @http_helper.delete(@route, @query_params, self.headers)
         else
             raise "No appropriate HTTP method found for this request."
         end
@@ -60,4 +60,9 @@ def with_body(body)
         return self
     end
 
+    def with_headers(headers)	
+        self.headers = headers
+        return self
+    end
+
 end
diff --git a/lib/Downloads/DownloadImages.rb b/lib/Downloads/DownloadImages.rb
@@ -2,7 +2,7 @@
 
 class DownloadImages < RequestBase
 
-    attr_accessor :asset_id
+    attr_accessor :asset_id, :accept_language
 
 	API_ROUTE = "/v3/downloads/images" # mashery endpoint	
 	QUERY_PARAMS_NAMES = ["file_type","height","product_id","product_type"]	
@@ -23,10 +23,16 @@ def with_id(asset_id)
         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)			
+		return @http_helper.post(uri, @query_params, nil, accept_language)			
 	end
 
 end
diff --git a/lib/Downloads/DownloadVideos.rb b/lib/Downloads/DownloadVideos.rb
@@ -2,7 +2,7 @@
 
 class DownloadVideos < RequestBase
 
-    attr_accessor :asset_id
+    attr_accessor :asset_id, :accept_language
 
 	API_ROUTE = "/v3/downloads/videos" # mashery endpoint	
 	QUERY_PARAMS_NAMES = ["product_id","size"]	
@@ -23,10 +23,16 @@ def with_id(asset_id)
         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)			
+		return @http_helper.post(uri, @query_params, nil, accept_language)			
 	end
 
 end
diff --git a/lib/HttpHelper.rb b/lib/HttpHelper.rb
@@ -20,7 +20,7 @@ def get_uri(path)
 		return URI.parse "#{Api_Host::API_BASE_URL}#{path}"
 	end
 
-	def get(endpoint_path, query_params)
+	def get(endpoint_path, query_params, headers = nil)
 
 		uri = get_uri(endpoint_path)
 		#puts uri		
@@ -29,11 +29,11 @@ def get(endpoint_path, query_params)
 		end
 		#puts "REQUEST URI: #{uri.request_uri}" 
 		req = Net::HTTP::Get.new uri.request_uri
-		return send uri, req, @api_key, @access_token
+		return send uri, req, @api_key, @access_token, headers
 
 	end
 
-	def post(endpoint_path, query_params, body)
+	def post(endpoint_path, query_params, body, headers = nil)
 
 		uri = get_uri(endpoint_path)
 		if !query_params.nil?
@@ -44,11 +44,11 @@ def post(endpoint_path, query_params, body)
 			req["Content-Type"] = "application/json"
 			req.body = body.to_json
 		end
-		return send uri, req, @api_key, @access_token
+		return send uri, req, @api_key, @access_token, headers
 
 	end
 
-	def put(endpoint_path, query_params, body)
+	def put(endpoint_path, query_params, body, headers = nil)
 
 		uri = get_uri(endpoint_path)
 		if !query_params.nil?
@@ -59,18 +59,18 @@ def put(endpoint_path, query_params, body)
 			req["Content-Type"] = "application/json"
 			req.body = body.to_json
 		end
-		return send uri, req, @api_key, @access_token
+		return send uri, req, @api_key, @access_token, headers
 
 	end
 
-	def delete(endpoint_path, query_params)
+	def delete(endpoint_path, query_params, headers = nil)
 
 		uri = get_uri(endpoint_path)
 		if !query_params.nil?
 			uri.query = URI.encode_www_form query_params
 		end	
 		req = Net::HTTP::Delete.new uri.request_uri
-		return send uri, req, @api_key, @access_token
+		return send uri, req, @api_key, @access_token, headers
 
 	end
 
@@ -93,14 +93,15 @@ def os
   	end
 
 	private
-	def send(uri, request, api_key, bearer_token = "")
+	def send(uri, request, api_key, bearer_token = "", headers)
 
 		# define HTTPS connection
 		https = Net::HTTP.new(uri.host, uri.port)
 		https.use_ssl = true
 		https.verify_mode = OpenSSL::SSL::VERIFY_NONE
 
 		# define headers
+		request.initialize_http_header(headers)
 		request["User-Agent"] = "GettImagesApiSdk/#{GettyImagesApi::VERSION} (#{os} ; Ruby #{RUBY_VERSION})"
 		request["Api-Key"] = api_key
 		request["Authorization"] = "Bearer #{bearer_token}" unless bearer_token.empty?

diff --git a/lib/Images/Images.rb b/lib/Images/Images.rb
@@ -2,7 +2,7 @@
 
 class Images < RequestBase
 
-    attr_accessor :asset_id
+    attr_accessor :asset_id, :accept_language
 
 	API_ROUTE = "/v3/images" # mashery endpoint	
 	QUERY_PARAMS_NAMES = ["ids","fields"]
@@ -24,10 +24,16 @@ def with_id(id)
 		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)			
+		return @http_helper.get(uri, @query_params, @accept_language)			
 	end
 
 end
diff --git a/lib/Search/SearchImages.rb b/lib/Search/SearchImages.rb
@@ -2,7 +2,9 @@
 
 class SearchImages < RequestBase
 
-	API_ROUTE = "/v3/search/images" # mashery endpoint	
+	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",
 		"file_types","graphical_styles","keyword_ids","license_models","minimum_size","number_of_people","orientations","page","page_size","phrase","prestige_content_only","product_types",
 		"sort_order","specific_people"]
@@ -23,10 +25,15 @@ class SearchImages < RequestBase
     		end
     		return self
     	end
-  	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)			
+		return @http_helper.get(API_ROUTE, @query_params, @accept_language)			
 	end
 
 end

diff --git a/lib/Search/SearchImagesCreative.rb b/lib/Search/SearchImagesCreative.rb
@@ -2,6 +2,8 @@
 
 class SearchImagesCreative < RequestBase
 
+	attr_accessor :accept_language
+
 	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","license_models","minimum_size","number_of_people","orientations","page","page_size","phrase","prestige_content_only","product_types",
@@ -23,10 +25,15 @@ class SearchImagesCreative < RequestBase
     		end
     		return self
     	end
-  	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)			
+		return @http_helper.get(API_ROUTE, @query_params, @accept_language)			
 	end
 
 end
diff --git a/lib/Search/SearchImagesEditorial.rb b/lib/Search/SearchImagesEditorial.rb
@@ -2,6 +2,8 @@
 
 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",
         "event_ids","exclude_nudity","fields","file_types","graphical_styles","keyword_ids","minimum_quality_rank","minimum_size","number_of_people","orientations","page","page_size","phrase",
@@ -23,10 +25,15 @@ class SearchImagesEditorial < RequestBase
     		end
     		return self
     	end
-  	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)			
+		return @http_helper.get(API_ROUTE, @query_params, @accept_language)			
 	end
 
 end
diff --git a/lib/Search/SearchVideos.rb b/lib/Search/SearchVideos.rb
@@ -2,6 +2,8 @@
 
 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",
         "keyword_ids","license_models","page","page_size","phrase","product_types","sort_order","specific_people"]
@@ -22,10 +24,15 @@ class SearchVideos < RequestBase
     		end
     		return self
     	end
-  	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)			
+		return @http_helper.get(API_ROUTE, @query_params, @accept_language)			
 	end
 
 end
diff --git a/lib/Search/SearchVideosCreative.rb b/lib/Search/SearchVideosCreative.rb
@@ -2,6 +2,8 @@
 
 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",
         "keyword_ids","license_models","page","page_size","phrase","product_types","sort_order"]
@@ -22,10 +24,15 @@ class SearchVideosCreative < RequestBase
     		end
     		return self
     	end
-  	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)			
+		return @http_helper.get(API_ROUTE, @query_params, @accept_language)			
 	end
 
 end
diff --git a/lib/Search/SearchVideosEditorial.rb b/lib/Search/SearchVideosEditorial.rb
@@ -2,6 +2,8 @@
 
 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",
         "keyword_ids","page","page_size","phrase","product_types","sort_order","specific_people"]
@@ -24,8 +26,13 @@ class SearchVideosEditorial < RequestBase
     	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)			
+		return @http_helper.get(API_ROUTE, @query_params, @accept_language)			
 	end
 
 end
diff --git a/lib/Videos/Videos.rb b/lib/Videos/Videos.rb
@@ -2,7 +2,7 @@
 
 class Videos < RequestBase
 
-    attr_accessor :asset_id
+    attr_accessor :asset_id, :accept_language
 
 	API_ROUTE = "/v3/videos" # mashery endpoint	
 	QUERY_PARAMS_NAMES = ["ids","fields"]
@@ -24,10 +24,16 @@ def with_id(id)
 		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)			
+		return @http_helper.get(uri, @query_params, @accept_language)			
 	end
 
 end