gettyimages-api 2.0.4 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 482643d3ef1c6faa8ed02ff34ea5b71f291c0617564431312b2be679a93d465f
4
- data.tar.gz: 4cbf5f76b5501363a82e9500a382895c49ce9044ae277a1342fe592e2364f0d4
3
+ metadata.gz: 31113aa92bf244a65e8040691beecaa2232eb66b1bb3ea9ad6f9fd843574146b
4
+ data.tar.gz: 00726d3b086b2af02737236e2aaafc26d8b51d57d6167f66d0ada5aec4936a82
5
5
  SHA512:
6
- metadata.gz: 0d9698e689db7edfc4e72fc0ff004284215780ca39e78308459af69b4623d6b75a759b2673132ae46babad2620d0b49f743cbb77ffbf7c75d345fe6732648f35
7
- data.tar.gz: b0caca61c415a12f2c3da88c42a35dcd4b08b4d94a9a9abc96b168fdffe5e8e4faede238f3da8a9d9eb902d310015210e82ee14d0620c34b11f030ee77bf1c2c
6
+ metadata.gz: 09818fe998e2335dc648082b00d91328e1eb9e253797ac0039f207326a4cfed21dbf06305f26264b487b02917e30b65f3ce8bcbaf1ef0799e8f7e0ac1879627d
7
+ data.tar.gz: a79dcc1d12946e283e0657e03d4722ecefa15996d46ce4c1e5ff35b4d4f0c006a0e9451f0009c0f5c2cb2c478162bbc5d812b980de1af19f48ac53064803c6d3
@@ -2,7 +2,7 @@ require_relative "../RequestBase.rb"
2
2
 
3
3
  class CustomRequest < RequestBase
4
4
 
5
- attr_accessor :method, :body, :route
5
+ attr_accessor :method, :body, :route, :headers
6
6
  # @route = "/v3/"
7
7
 
8
8
  def initialize(api_key, access_token)
@@ -13,13 +13,13 @@ class CustomRequest < RequestBase
13
13
  def execute
14
14
  case @method
15
15
  when "GET"
16
- return @http_helper.get(@route, @query_params)
16
+ return @http_helper.get(@route, @query_params, self.headers)
17
17
  when "POST"
18
- return @http_helper.post(@route, @query_params, self.body)
18
+ return @http_helper.post(@route, @query_params, self.body, self.headers)
19
19
  when "PUT"
20
- return @http_helper.put(@route, @query_params, self.body)
20
+ return @http_helper.put(@route, @query_params, self.body, self.headers)
21
21
  when "DELETE"
22
- return @http_helper.delete(@route, @query_params)
22
+ return @http_helper.delete(@route, @query_params, self.headers)
23
23
  else
24
24
  raise "No appropriate HTTP method found for this request."
25
25
  end
@@ -60,4 +60,9 @@ class CustomRequest < RequestBase
60
60
  return self
61
61
  end
62
62
 
63
+ def with_headers(headers)
64
+ self.headers = headers
65
+ return self
66
+ end
67
+
63
68
  end
@@ -2,7 +2,7 @@ require_relative "../RequestBase.rb"
2
2
 
3
3
  class DownloadImages < RequestBase
4
4
 
5
- attr_accessor :asset_id
5
+ attr_accessor :asset_id, :accept_language
6
6
 
7
7
  API_ROUTE = "/v3/downloads/images" # mashery endpoint
8
8
  QUERY_PARAMS_NAMES = ["file_type","height","product_id","product_type"]
@@ -23,10 +23,16 @@ class DownloadImages < RequestBase
23
23
  return self
24
24
  end
25
25
 
26
+ public
27
+ def with_accept_language(language)
28
+ @accept_language = {"Accept-Language" => language}
29
+ return self
30
+ end
31
+
26
32
  def execute
27
33
  build_query_params("auto_download", "false")
28
34
  uri = API_ROUTE + "/" + self.asset_id
29
- return @http_helper.post(uri, @query_params, nil)
35
+ return @http_helper.post(uri, @query_params, nil, accept_language)
30
36
  end
31
37
 
32
38
  end
@@ -2,7 +2,7 @@ require_relative "../RequestBase.rb"
2
2
 
3
3
  class DownloadVideos < RequestBase
4
4
 
5
- attr_accessor :asset_id
5
+ attr_accessor :asset_id, :accept_language
6
6
 
7
7
  API_ROUTE = "/v3/downloads/videos" # mashery endpoint
8
8
  QUERY_PARAMS_NAMES = ["product_id","size"]
@@ -23,10 +23,16 @@ class DownloadVideos < RequestBase
23
23
  return self
24
24
  end
25
25
 
26
+ public
27
+ def with_accept_language(language)
28
+ @accept_language = {"Accept-Language" => language}
29
+ return self
30
+ end
31
+
26
32
  def execute
27
33
  build_query_params("auto_download", "false")
28
34
  uri = API_ROUTE + "/" + self.asset_id
29
- return @http_helper.post(uri, @query_params, nil)
35
+ return @http_helper.post(uri, @query_params, nil, accept_language)
30
36
  end
31
37
 
32
38
  end
@@ -1,3 +1,3 @@
1
1
  module GettyImagesApi
2
- VERSION = "2.0.4"
2
+ VERSION = "2.1.0"
3
3
  end
@@ -20,7 +20,7 @@ class HttpHelper
20
20
  return URI.parse "#{Api_Host::API_BASE_URL}#{path}"
21
21
  end
22
22
 
23
- def get(endpoint_path, query_params)
23
+ def get(endpoint_path, query_params, headers = nil)
24
24
 
25
25
  uri = get_uri(endpoint_path)
26
26
  #puts uri
@@ -29,11 +29,11 @@ class HttpHelper
29
29
  end
30
30
  #puts "REQUEST URI: #{uri.request_uri}"
31
31
  req = Net::HTTP::Get.new uri.request_uri
32
- return send uri, req, @api_key, @access_token
32
+ return send uri, req, @api_key, @access_token, headers
33
33
 
34
34
  end
35
35
 
36
- def post(endpoint_path, query_params, body)
36
+ def post(endpoint_path, query_params, body, headers = nil)
37
37
 
38
38
  uri = get_uri(endpoint_path)
39
39
  if !query_params.nil?
@@ -44,11 +44,11 @@ class HttpHelper
44
44
  req["Content-Type"] = "application/json"
45
45
  req.body = body.to_json
46
46
  end
47
- return send uri, req, @api_key, @access_token
47
+ return send uri, req, @api_key, @access_token, headers
48
48
 
49
49
  end
50
50
 
51
- def put(endpoint_path, query_params, body)
51
+ def put(endpoint_path, query_params, body, headers = nil)
52
52
 
53
53
  uri = get_uri(endpoint_path)
54
54
  if !query_params.nil?
@@ -59,18 +59,18 @@ class HttpHelper
59
59
  req["Content-Type"] = "application/json"
60
60
  req.body = body.to_json
61
61
  end
62
- return send uri, req, @api_key, @access_token
62
+ return send uri, req, @api_key, @access_token, headers
63
63
 
64
64
  end
65
65
 
66
- def delete(endpoint_path, query_params)
66
+ def delete(endpoint_path, query_params, headers = nil)
67
67
 
68
68
  uri = get_uri(endpoint_path)
69
69
  if !query_params.nil?
70
70
  uri.query = URI.encode_www_form query_params
71
71
  end
72
72
  req = Net::HTTP::Delete.new uri.request_uri
73
- return send uri, req, @api_key, @access_token
73
+ return send uri, req, @api_key, @access_token, headers
74
74
 
75
75
  end
76
76
 
@@ -93,7 +93,7 @@ class HttpHelper
93
93
  end
94
94
 
95
95
  private
96
- def send(uri, request, api_key, bearer_token = "")
96
+ def send(uri, request, api_key, bearer_token = "", headers)
97
97
 
98
98
  # define HTTPS connection
99
99
  https = Net::HTTP.new(uri.host, uri.port)
@@ -101,6 +101,7 @@ class HttpHelper
101
101
  https.verify_mode = OpenSSL::SSL::VERIFY_NONE
102
102
 
103
103
  # define headers
104
+ request.initialize_http_header(headers)
104
105
  request["User-Agent"] = "GettImagesApiSdk/#{GettyImagesApi::VERSION} (#{os} ; Ruby #{RUBY_VERSION})"
105
106
  request["Api-Key"] = api_key
106
107
  request["Authorization"] = "Bearer #{bearer_token}" unless bearer_token.empty?
@@ -2,7 +2,7 @@ require_relative "../RequestBase.rb"
2
2
 
3
3
  class Images < RequestBase
4
4
 
5
- attr_accessor :asset_id
5
+ attr_accessor :asset_id, :accept_language
6
6
 
7
7
  API_ROUTE = "/v3/images" # mashery endpoint
8
8
  QUERY_PARAMS_NAMES = ["ids","fields"]
@@ -24,10 +24,16 @@ class Images < RequestBase
24
24
  return self
25
25
  end
26
26
 
27
+ public
28
+ def with_accept_language(language)
29
+ @accept_language = {"Accept-Language" => language}
30
+ return self
31
+ end
32
+
27
33
  public
28
34
  def execute
29
35
  self.asset_id.nil? ? uri = API_ROUTE : uri = API_ROUTE + "/" + self.asset_id
30
- return @http_helper.get(uri, @query_params)
36
+ return @http_helper.get(uri, @query_params, @accept_language)
31
37
  end
32
38
 
33
39
  end
@@ -2,7 +2,9 @@ require_relative "../RequestBase.rb"
2
2
 
3
3
  class SearchImages < RequestBase
4
4
 
5
- API_ROUTE = "/v3/search/images" # mashery endpoint
5
+ attr_accessor :accept_language
6
+
7
+ API_ROUTE = "/v3/search/images" # mashery endpoint
6
8
  QUERY_PARAMS_NAMES = ["age_of_people","artists","collection_codes","collections_filter_type","color","compositions","embed_content_only","ethnicity","event_ids","exclude_nudity","fields",
7
9
  "file_types","graphical_styles","keyword_ids","license_models","minimum_size","number_of_people","orientations","page","page_size","phrase","prestige_content_only","product_types",
8
10
  "sort_order","specific_people"]
@@ -23,10 +25,15 @@ class SearchImages < RequestBase
23
25
  end
24
26
  return self
25
27
  end
26
- end
28
+ end
29
+
30
+ def with_accept_language(language)
31
+ @accept_language = {"Accept-Language" => language}
32
+ return self
33
+ end
27
34
 
28
35
  def execute
29
- return @http_helper.get(API_ROUTE, @query_params)
36
+ return @http_helper.get(API_ROUTE, @query_params, @accept_language)
30
37
  end
31
38
 
32
39
  end
@@ -2,6 +2,8 @@ require_relative "../RequestBase.rb"
2
2
 
3
3
  class SearchImagesCreative < RequestBase
4
4
 
5
+ attr_accessor :accept_language
6
+
5
7
  API_ROUTE = "/v3/search/images/creative" # mashery endpoint
6
8
  QUERY_PARAMS_NAMES = ["age_of_people","artists","collection_codes","collections_filter_type","color","compositions","embed_content_only","ethnicity","exclude_nudity","fields","file_types",
7
9
  "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
23
25
  end
24
26
  return self
25
27
  end
26
- end
28
+ end
29
+
30
+ def with_accept_language(language)
31
+ @accept_language = {"Accept-Language" => language}
32
+ return self
33
+ end
27
34
 
28
35
  def execute
29
- return @http_helper.get(API_ROUTE, @query_params)
36
+ return @http_helper.get(API_ROUTE, @query_params, @accept_language)
30
37
  end
31
38
 
32
39
  end
@@ -2,6 +2,8 @@ require_relative "../RequestBase.rb"
2
2
 
3
3
  class SearchImagesEditorial < RequestBase
4
4
 
5
+ attr_accessor :accept_language
6
+
5
7
  API_ROUTE = "/v3/search/images/editorial" # mashery endpoint
6
8
  QUERY_PARAMS_NAMES = ["age_of_people","artists","collection_codes","collections_filter_type","compositions","editorial_segments","embed_content_only","end_date","entity_uris","ethnicity",
7
9
  "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
23
25
  end
24
26
  return self
25
27
  end
26
- end
28
+ end
27
29
 
30
+ def with_accept_language(language)
31
+ @accept_language = {"Accept-Language" => language}
32
+ return self
33
+ end
34
+
28
35
  def execute
29
- return @http_helper.get(API_ROUTE, @query_params)
36
+ return @http_helper.get(API_ROUTE, @query_params, @accept_language)
30
37
  end
31
38
 
32
39
  end
@@ -2,6 +2,8 @@ require_relative "../RequestBase.rb"
2
2
 
3
3
  class SearchVideos < RequestBase
4
4
 
5
+ attr_accessor :accept_language
6
+
5
7
  API_ROUTE = "/v3/search/videos" # mashery endpoint
6
8
  QUERY_PARAMS_NAMES = ["age_of_people","collection_codes","collections_filter_type","editorial_video_types","exclude_nudity","fields","format_available","frame_rates",
7
9
  "keyword_ids","license_models","page","page_size","phrase","product_types","sort_order","specific_people"]
@@ -22,10 +24,15 @@ class SearchVideos < RequestBase
22
24
  end
23
25
  return self
24
26
  end
25
- end
27
+ end
28
+
29
+ def with_accept_language(language)
30
+ @accept_language = {"Accept-Language" => language}
31
+ return self
32
+ end
26
33
 
27
34
  def execute
28
- return @http_helper.get(API_ROUTE, @query_params)
35
+ return @http_helper.get(API_ROUTE, @query_params, @accept_language)
29
36
  end
30
37
 
31
38
  end
@@ -2,6 +2,8 @@ require_relative "../RequestBase.rb"
2
2
 
3
3
  class SearchVideosCreative < RequestBase
4
4
 
5
+ attr_accessor :accept_language
6
+
5
7
  API_ROUTE = "/v3/search/videos/creative" # mashery endpoint
6
8
  QUERY_PARAMS_NAMES = ["age_of_people","collection_codes","collections_filter_type","exclude_nudity","fields","format_available","frame_rates",
7
9
  "keyword_ids","license_models","page","page_size","phrase","product_types","sort_order"]
@@ -22,10 +24,15 @@ class SearchVideosCreative < RequestBase
22
24
  end
23
25
  return self
24
26
  end
25
- end
27
+ end
28
+
29
+ def with_accept_language(language)
30
+ @accept_language = {"Accept-Language" => language}
31
+ return self
32
+ end
26
33
 
27
34
  def execute
28
- return @http_helper.get(API_ROUTE, @query_params)
35
+ return @http_helper.get(API_ROUTE, @query_params, @accept_language)
29
36
  end
30
37
 
31
38
  end
@@ -2,6 +2,8 @@ require_relative "../RequestBase.rb"
2
2
 
3
3
  class SearchVideosEditorial < RequestBase
4
4
 
5
+ attr_accessor :accept_language
6
+
5
7
  API_ROUTE = "/v3/search/videos/editorial" # mashery endpoint
6
8
  QUERY_PARAMS_NAMES = ["age_of_people","collection_codes","collections_filter_type","editorial_video_types","entity_uris","exclude_nudity","fields","format_available","frame_rates",
7
9
  "keyword_ids","page","page_size","phrase","product_types","sort_order","specific_people"]
@@ -24,8 +26,13 @@ class SearchVideosEditorial < RequestBase
24
26
  end
25
27
  end
26
28
 
29
+ def with_accept_language(language)
30
+ @accept_language = {"Accept-Language" => language}
31
+ return self
32
+ end
33
+
27
34
  def execute
28
- return @http_helper.get(API_ROUTE, @query_params)
35
+ return @http_helper.get(API_ROUTE, @query_params, @accept_language)
29
36
  end
30
37
 
31
38
  end
@@ -2,7 +2,7 @@ require_relative "../RequestBase.rb"
2
2
 
3
3
  class Videos < RequestBase
4
4
 
5
- attr_accessor :asset_id
5
+ attr_accessor :asset_id, :accept_language
6
6
 
7
7
  API_ROUTE = "/v3/videos" # mashery endpoint
8
8
  QUERY_PARAMS_NAMES = ["ids","fields"]
@@ -24,10 +24,16 @@ class Videos < RequestBase
24
24
  return self
25
25
  end
26
26
 
27
+ public
28
+ def with_accept_language(language)
29
+ @accept_language = {"Accept-Language" => language}
30
+ return self
31
+ end
32
+
27
33
  public
28
34
  def execute
29
35
  self.asset_id.nil? ? uri = API_ROUTE : uri = API_ROUTE + "/" + self.asset_id
30
- return @http_helper.get(uri, @query_params)
36
+ return @http_helper.get(uri, @query_params, @accept_language)
31
37
  end
32
38
 
33
39
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: gettyimages-api
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.0.4
4
+ version: 2.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Getty Images
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2018-05-10 00:00:00.000000000 Z
11
+ date: 2018-07-26 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -91,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
91
91
  version: '0'
92
92
  requirements: []
93
93
  rubyforge_project:
94
- rubygems_version: 2.7.6
94
+ rubygems_version: 2.7.7
95
95
  signing_key:
96
96
  specification_version: 4
97
97
  summary: Getty Images API SDK