gettyimages-api 2.0.4 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 482643d3ef1c6faa8ed02ff34ea5b71f291c0617564431312b2be679a93d465f
-  data.tar.gz: 4cbf5f76b5501363a82e9500a382895c49ce9044ae277a1342fe592e2364f0d4
+  metadata.gz: bac4842026fc933c71984784db414c41e47a735cf21c87c35677c9301f083cce
+  data.tar.gz: 59043fcb36bac1d9389d70e71c84db00fb27216ccaadf338e1088245503bbe85
 SHA512:
-  metadata.gz: 0d9698e689db7edfc4e72fc0ff004284215780ca39e78308459af69b4623d6b75a759b2673132ae46babad2620d0b49f743cbb77ffbf7c75d345fe6732648f35
-  data.tar.gz: b0caca61c415a12f2c3da88c42a35dcd4b08b4d94a9a9abc96b168fdffe5e8e4faede238f3da8a9d9eb902d310015210e82ee14d0620c34b11f030ee77bf1c2c
+  metadata.gz: fb3bf4ba8313213e4664666c334b862ca1834f35f23540cbbf6a77540232abe0ebcf83c516e6fe2cfa19d4f2514993b60148c9807b3d9e42d2c497abfe948c54
+  data.tar.gz: 3527a5473f84b05151cebf46970d776381087bd20443a3381230efec5a414a983e6d15798a545326f99f55367cdf8daa224fe1427c1ad034ee7d160285f0f9fc

data/.github/workflows/build.yml

@@ -0,0 +1,35 @@
+name: Build
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [ 2.5, 2.6, 2.7 ]
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+
+      - name: 'Get Previous tag'
+        id: previoustag
+        uses: "WyriHaximus/github-action-get-previous-tag@v1"
+
+      - name: Set version
+        run: |
+          sed -i -e "s/0.0.0/${{ steps.previoustag.outputs.tag }}/" lib/GettyImagesApi/version.rb
+          cat lib/GettyImagesApi/version.rb
+
+      - run: make build

data/.github/workflows/publish.yml

@@ -0,0 +1,40 @@
+name: Publish
+
+on:
+  release:
+    types: [released]
+
+jobs:
+  publish:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.5
+
+      - name: 'Get Previous tag'
+        id: previoustag
+        uses: "WyriHaximus/github-action-get-previous-tag@v1"
+
+      - name: Set version
+        run: |
+          sed -i -e "s/0.0.0/${{ steps.previoustag.outputs.tag }}/" lib/GettyImagesApi/version.rb
+          cat lib/GettyImagesApi/version.rb
+
+      - run: make build
+
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem push gettyimages-api-${{ steps.previoustag.outputs.tag }}.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.gitignore

@@ -12,3 +12,5 @@
 *.o
 *.a
 mkmf.log
+*.gem
+vendor

data/Gemfile

@@ -3,4 +3,4 @@ source 'https://rubygems.org'
 gem 'rake'
 gem 'json'
 gem 'test-unit'
-gem 'webmock'                                                                                                                                                                                                                                                                                                                                                                                                                           
+gem 'webmock'

data/Gemfile.lock

@@ -1,22 +1,22 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    hashdiff (0.3.7)
-    json (1.8.6)
-    power_assert (1.1.1)
-    public_suffix (3.0.2)
-    rake (12.3.0)
-    safe_yaml (1.0.4)
-    test-unit (3.2.7)
+    hashdiff (1.0.0)
+    json (2.3.0)
+    power_assert (1.1.6)
+    public_suffix (4.0.6)
+    rake (13.0.1)
+    safe_yaml (1.0.5)
+    test-unit (3.3.5)
       power_assert
-    webmock (3.3.0)
+    webmock (3.8.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
@@ -31,4 +31,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.16.1
+   2.1.4

data/Makefile

@@ -0,0 +1,5 @@
+build:
+	bundle config set --local path 'vendor/bundle'
+	bundle install --path vendor/bundle
+	bundle exec rake
+	gem build gettyimages-api.gemspec

data/README.md

@@ -12,11 +12,14 @@ This SDK makes using the Getty Images [API](http://developers.gettyimages.com) e
 ## Help & Support
 
 * [Getty Images API](http://developers.gettyimages.com/)
-* [Contact Developer Support](mailto:developersupport@gettyimages.com)
 * [Issue Tracker](https://github.com/gettyimages/gettyimages-api_ruby/issues)
 
 ## Getting started
 
+### Obtain an API Key
+
+If you don't already have an API key, fill out and submit the [contact form](http://engage.gettyimages.com/api-contact) to be connected to our Sales team.
+
 ### Installing the ruby gem package
 
 The SDK is available as a [ruby gem](https://rubygems.org/gems/gettyimages-api) package. Install in your workspace with:
@@ -152,7 +155,7 @@ _Source code is only needed if you would like to contribute to the project. Othe
 
 ### Requirements
 
-- Ruby version >= 2.4
+- Ruby version >= 2.5
 - [Bundler](http://bundler.io)
 
 Install bundler and all dependencies

data/lib/CustomRequest/CustomRequest.rb

@@ -2,7 +2,7 @@ require_relative "../RequestBase.rb"
 
 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 @@ class CustomRequest < RequestBase
     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 @@ class CustomRequest < RequestBase
         return self
     end
 
+    def with_headers(headers)	
+        self.headers = headers
+        return self
+    end
+
 end

data/lib/Downloads/DownloadImages.rb

@@ -2,7 +2,7 @@ require_relative "../RequestBase.rb"
 
 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 @@ 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)			
+		return @http_helper.post(uri, @query_params, nil, accept_language)			
 	end
 
 end

data/lib/Downloads/DownloadVideos.rb

@@ -2,7 +2,7 @@ require_relative "../RequestBase.rb"
 
 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 @@ 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)			
+		return @http_helper.post(uri, @query_params, nil, accept_language)			
 	end
 
 end

data/lib/GettyImagesApi/version.rb

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

data/lib/HttpHelper.rb

@@ -20,7 +20,7 @@ class HttpHelper
 		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 @@ class HttpHelper
 		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 @@ class HttpHelper
 			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 @@ class HttpHelper
 			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,7 +93,7 @@ class HttpHelper
   	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)
@@ -101,6 +101,7 @@ class HttpHelper
 		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?

data/lib/Images/Images.rb

@@ -2,7 +2,7 @@ require_relative "../RequestBase.rb"
 
 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 @@ 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)			
+		return @http_helper.get(uri, @query_params, @accept_language)			
 	end
 
 end

data/lib/Search/SearchImages.rb

@@ -2,9 +2,11 @@ require_relative "../RequestBase.rb"
 
 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",
+		"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|
@@ -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

data/lib/Search/SearchImagesCreative.rb

@@ -2,9 +2,11 @@ require_relative "../RequestBase.rb"
 
 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",
+        "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|
@@ -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

data/lib/Search/SearchImagesEditorial.rb

@@ -2,6 +2,8 @@ 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",
         "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

data/lib/Search/SearchVideos.rb

@@ -2,6 +2,8 @@ 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",
         "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

data/lib/Search/SearchVideosCreative.rb

@@ -2,6 +2,8 @@ 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",
         "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

data/lib/Search/SearchVideosEditorial.rb

@@ -2,6 +2,8 @@ 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",
         "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

data/lib/Videos/Videos.rb

@@ -2,7 +2,7 @@ require_relative "../RequestBase.rb"
 
 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 @@ 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)			
+		return @http_helper.get(uri, @query_params, @accept_language)			
 	end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gettyimages-api
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 3.0.2
 platform: ruby
 authors:
 - Getty Images
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-10 00:00:00.000000000 Z
+date: 2021-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -45,12 +45,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
+- ".github/workflows/publish.yml"
 - ".gitignore"
 - ".vscode/launch.json"
 - ".vscode/tasks.json"
 - Gemfile
 - Gemfile.lock
 - LICENSE
+- Makefile
 - README.md
 - Rakefile
 - gettyimages-api.gemspec
@@ -91,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.6.3
 signing_key: 
 specification_version: 4
 summary: Getty Images API SDK