ConnectSDK 1.0.1.Beta

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjdlMjg4NDU1Nzg3Zjk5YjRjZWJlMzQ0ODI1ZjAwMTE0Zjc1ODIyYg==
+  data.tar.gz: !binary |-
+    YWQ3ZTdkZWU5MTJlOWVlZDU1N2M4OWYyYzc5YTA0MWJjYmNkNTU4NQ==
+SHA512:
+  metadata.gz: !binary |-
+    ZTRmNjA5ZThjYmIwOTQ0MWM4NDQzNjczZTI2NDkzNDM4OGU0Yzc0MDQ0ZmRi
+    YTdjNjkxMTA0N2IzMDQ2ODYxYzU3MzFkOWY5NTEyYTUzM2NmYzNiMzdiNjFk
+    NzA3NzY3MzRjZDllMjlmMjFhZTNmNDUyNzE3NTkwMWQzOGE3OGI=
+  data.tar.gz: !binary |-
+    MjY3Mjk0NmYzYjNhMDVkYTMxODZkN2UyN2JjOWZkZGZmYzg3Y2U0M2Q4ZTAy
+    N2IxZGJhNGQ4YzJlNDY2ZGMxMWZmOTc1ZmQ4MTA4Mjg3YTlmMzAyNDU0ZDBh
+    MzkyOTFlYjExNDkxYWUzZTYzNjYxOTA5YjFjZTM4ZTc4MzI2NDI=

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/ConnectSDK.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ConnectSDK/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ConnectSDK"
+  spec.version       = ConnectSDK::VERSION
+  spec.authors       = ["Rod Santos, Lisa Guo"]
+  spec.email         = ["rod.santos@gettyimages.com"]
+  spec.summary       = "Connect SDK"
+  spec.description   = "Connect SDK"
+  spec.homepage      = "http://api.gettyimages.com/"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  
+end

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ConnectSDK.gemspec
+gemspec
+
+gem 'json', '~> 1.8.1'
+gem 'rake', '~> 0.9.2.2'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Getty Images
+
+MIT
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,9 @@
+## Requirements
+- Ruby version > 1.9.3
+- [Bundler](http://bundler.io) version > 1.7.3
+
+## Building Gem Package
+The following describes how to create the local gem package for Connect SDK. The package will be created in the pkg folder in the source code location. 
+
+	$ cd connect_sdk_ruby/ConnectSDK
+	$ bundle exec rake build

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/ConnectSDK.rb

@@ -0,0 +1,52 @@
+# Connect SDK by Getty Images.
+# Provides an interface to Getty Images connect api.
+# 
+# The goal of the SDK is to simplify credential management and provide a reusable library
+# for developers.
+
+require_relative "Credentials"
+require_relative "SearchRequest"
+require_relative "ImagesRequest"
+require_relative "DownloadRequest"
+
+# ConnectSDK
+# Provides a code api for interacting with getty rest services.
+# {https://connect.gettyimages.com/swagger/ui/index.html Connect Getty Images API}
+
+class ConnectSdk
+	
+	# Initialize the Credentials to be used by the SDK
+	def initialize(api_key, api_secret, user_name = nil, password = nil)
+
+		@credentials = Credentials.new(
+			:credential_type => (user_name.nil?) || (password.nil?) ? OAuthGrantType::CLIENT_CREDENTIALS : OAuthGrantType::PASSWORD, 
+			:client_key => api_key, 
+			:client_secret => api_secret,
+			:user_name => user_name,
+			:password => password)				
+	end
+
+	# Get access token to be used by the SDK
+	def get_access_token
+		return @credentials.get_access_token
+	end
+
+	# Create a search configuration that support image searching
+	# SearchRequest configured for a image search	
+	def search()
+		return SearchRequest.new(@credentials.client_key, @credentials.get_access_token)
+	end
+
+	# Create a image details configuration that support image details 
+	# == Returns:
+	# ImagesRequest configured for a image details	
+	def images()
+		return ImagesRequest.new(@credentials.client_key, @credentials.get_access_token)
+	end
+	
+	def download
+		return DownloadRequest.new(@credentials.client_key, @credentials.get_access_token)
+	end
+
+end
+

data/lib/ConnectSDK/version.rb

@@ -0,0 +1,3 @@
+module ConnectSDK
+	VERSION = '1.0.1.Beta'
+end

data/lib/Credentials.rb

@@ -0,0 +1,67 @@
+require 'open-uri'
+require 'net/https'
+
+class OAuthGrantType
+ 	PASSWORD = 'password'
+ 	CLIENT_CREDENTIALS = 'client_credentials'
+end
+
+class Credentials
+
+	attr_accessor :credential_type
+	attr_accessor :client_key
+	attr_accessor :client_secret
+	attr_accessor :user_name
+	attr_accessor :password
+
+	def initialize(args)
+		args.keys.each { |name| instance_variable_set "@" + name.to_s, args[name] }	
+	end
+
+	def get_uri(path)
+		return URI.parse "#{Connect_Api_Host::API_BASE_URL}#{path}"
+	end
+
+	# Get Access Token Using Connect API OAuth 2.0
+	def get_access_token
+		
+		# Determine OAuth Flow
+		case @credential_type
+			when OAuthGrantType::PASSWORD
+				oauth_data = {
+					:grant_type => @credential_type, 
+					:client_id => @client_key, 
+					:client_secret => @client_secret, 
+					:username => @user_name, 
+					:password => @password }
+			when OAuthGrantType::CLIENT_CREDENTIALS
+				oauth_data = {
+					:grant_type => @credential_type, 
+					:client_id => @client_key, 
+					:client_secret => @client_secret }
+			else
+				puts 'Current OAuth flow only supports Resource Owner and Client Credentials'				
+		end
+
+		# define endpoint
+		uri = get_uri '/oauth2/token'
+
+		# define HTTPS connection
+		https = Net::HTTP.new(uri.host, uri.port)
+		https.use_ssl = true
+		https.verify_mode = OpenSSL::SSL::VERIFY_NONE
+		
+		# define Request
+		req = Net::HTTP::Post.new uri.request_uri
+		req['Api-Key'] = @client_key
+		req.set_form_data oauth_data
+		
+		res = https.request req
+		data = res.body if res.is_a?(Net::HTTPSuccess)
+		result = JSON.parse(data)
+
+		return result['access_token']
+
+	end
+
+end

data/lib/DownloadRequest.rb

@@ -0,0 +1,32 @@
+require_relative 'HttpHelper'
+
+class DownloadRequest
+
+	attr_accessor :asset_id
+
+	def initialize(api_key, access_token)
+
+		self
+		@api_key = api_key
+		@access_token = access_token
+
+		@http_helper = HttpHelper.new(api_key, access_token)		
+
+	end	
+
+	public 	
+	def with_id(asset_id)	
+		self.asset_id = asset_id
+		return self
+	end
+
+	public
+	def execute
+		
+		uri = '/v3/downloads/' + self.asset_id + '?auto_download=false'
+		data = @http_helper.post(uri)			
+	 	return data['uri']
+
+	end
+
+end

data/lib/Example.rb

@@ -0,0 +1,22 @@
+require "pp"
+require_relative "ConnectSDK"
+
+api_key = "3z7q8fyw8ach5kr3mg35dkqz"
+api_secret = "kYksrEH4Vyn6txeT5tFDJjxsdVYqS6usNDupa3aYWpwkr"
+
+# Example of Connect SDK
+connectSdk 		= ConnectSdk.new(api_key, api_secret)
+search_results	= connectSdk.search().images().creative()
+					.with_phrase("gorilla")
+					.with_response_fields(["id","title"])
+					.with_graphical_styles("illustration")
+					.with_graphical_styles(["fine_art","photography"])
+					.with_page(2)
+					.with_page_size(5)
+					.execute()
+
+search_results["images"].each do | image |
+	puts "Id: #{image["id"]} Title: #{image["title"]}" 
+end
+
+

data/lib/HttpHelper.rb

@@ -0,0 +1,69 @@
+require "net/http"
+require "uri"
+require "json"
+
+class Connect_Api_Host
+	API_HOST = "connect.gettyimages.com"
+	# API_HOST = "gibson.candidate-gettyimages.com/Public"
+	API_BASE_URL = "https://#{API_HOST}"
+end
+
+class HttpHelper
+
+	def initialize(api_key, access_token)
+		@api_key = api_key
+		@access_token = access_token
+	end	
+
+	public
+	def get_uri(path)
+		return URI.parse "#{Connect_Api_Host::API_BASE_URL}#{path}"
+	end
+
+	public
+	def get(endpoint_path, query_params)
+		
+		uri = get_uri(endpoint_path)
+		#puts uri		
+		if !query_params.nil?
+			uri.query = URI.encode_www_form 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
+
+	end
+
+	public
+	def post(endpoint_path)
+
+		uri = get_uri endpoint_path	
+		req = Net::HTTP::Post.new uri.request_uri
+		return send uri, req, @api_key, @access_token
+
+	end
+
+	def send(connect_uri, connect_request, api_key, bearer_token = "")
+
+		# define HTTPS connection
+		https = Net::HTTP.new(connect_uri.host, connect_uri.port)
+		https.use_ssl = true
+		https.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+		# define headers
+		connect_request["Api-Key"] = api_key
+		connect_request["Authorization"] = "Bearer #{bearer_token}" unless bearer_token.empty?
+
+		# send request		
+		resp = https.request connect_request
+		# puts "HTTP RESPONSE: #{resp}" 
+
+		if !resp.is_a?(Net::HTTPSuccess)			
+			raise "HTTP RESPONSE: #{resp}" 
+		end
+
+		return JSON.parse(resp.body)
+
+	end 
+
+end

data/lib/ImagesRequest.rb

@@ -0,0 +1,32 @@
+require_relative "RequestBase"
+
+class ImagesRequest < RequestBase
+
+	CONNECT_ROUTE = "/v3/images" # mashery endpoint	
+
+	QUERY_PARAMS_NAMES = ["page","page_size"]
+
+	QUERY_PARAMS_NAMES.each do |key|
+    define_method :"with_#{key}" do |value = true| 
+    		if value.is_a?(Array)
+    			build_query_params(key, value.join(","))
+    		else
+    			build_query_params(key, value)
+    		end
+    		return self
+    	end
+  	end
+			
+	public 
+	def with_ids(ids)
+		@ids = ids.join("%2C") 
+		return self
+	end
+
+	public
+	def execute
+		return @http_helper.get("#{CONNECT_ROUTE}/#{@ids}", @query_params)			
+		return "here"
+	end
+
+end

data/lib/RequestBase.rb

@@ -0,0 +1,33 @@
+require_relative "HttpHelper"
+
+class RequestBase
+
+	attr_accessor :http_helper, :query_params
+
+	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
+
+	end	
+
+	public 
+	def with_response_fields(fields)
+		build_query_params("fields", fields.join(","))
+		return self
+	end
+
+	public 
+	def with_response_field(field)
+		build_query_params("fields", field)
+		return self
+	end
+
+	protected
+	def build_query_params(key, value)
+		@query_params[key].nil? ? @query_params[key] = value : @query_params[key] << "," + value
+	end 
+
+
+end

data/lib/SearchImages.rb

@@ -0,0 +1,38 @@
+require_relative "RequestBase"
+
+class SearchImages < RequestBase
+
+	CONNECT_ROUTE = "/v3/search/images" # mashery endpoint	
+	@@search_route = CONNECT_ROUTE
+	QUERY_PARAMS_NAMES = ["phrase","editorial_segments","graphical_styles","license_models","orientations","exclude_nudity","embed_content_only","page","page_size"]
+
+	QUERY_PARAMS_NAMES.each do |key|
+    define_method :"with_#{key}" do |value = true| 
+    		if value.is_a?(Array)
+    			build_query_params(key, value.join(","))
+    		else
+    			build_query_params(key, value)
+    		end
+    		return self
+    	end
+  	end
+
+	# {https://connect.gettyimages.com/swagger/ui/index.html#!/Search/Search_GetCreativeImagesByPhrase Creative Swagger}
+	# with_graphical_styles
+	# with_license_models
+	def creative()
+		@@search_route = "#{CONNECT_ROUTE}/creative"
+		return self
+	end	
+
+	def editorial()
+		@@search_route = "#{CONNECT_ROUTE}/editorial"
+		return self
+	end
+
+	def execute
+		return @http_helper.get(@@search_route, @query_params)			
+	end
+
+end
+

data/lib/SearchRequest.rb

@@ -0,0 +1,15 @@
+require_relative "SearchImages"
+
+class SearchRequest
+
+	def initialize(api_key, token)
+		@api_key = api_key
+		@token = token
+	end	
+	
+	public
+	def images()
+		return SearchImages.new(@api_key, @token)
+	end
+
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: ConnectSDK
+version: !ruby/object:Gem::Version
+  version: 1.0.1.Beta
+platform: ruby
+authors:
+- Rod Santos, Lisa Guo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Connect SDK
+email:
+- rod.santos@gettyimages.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- ConnectSDK.gemspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ConnectSDK.rb
+- lib/ConnectSDK/version.rb
+- lib/Credentials.rb
+- lib/DownloadRequest.rb
+- lib/Example.rb
+- lib/HttpHelper.rb
+- lib/ImagesRequest.rb
+- lib/RequestBase.rb
+- lib/SearchImages.rb
+- lib/SearchRequest.rb
+homepage: http://api.gettyimages.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: Connect SDK
+test_files: []