gp-ruby-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2caa679ac2292972b32a4e0d44a19f7a7201c0f4
+  data.tar.gz: 81bcdb42c564a483ed96e1f89fe7c24d2754e047
+SHA512:
+  metadata.gz: 76a1e6551a3651c72412259e6ef1bd8727f92ca33787477b226593b3349c759aed74ef31e6659e27723c5596606657591e4d33b792a0638e6a80541cd3408c51
+  data.tar.gz: 253c20540d0916a51f5f20b62905d71a2e9911f1af6d0508ea28bf5ba1a24aa1f6225a05fe9d749caebd112a454a1e07c6f7b25a8512c751a8b6f23bb5ca78d6

data/lib/cache_control.rb

@@ -0,0 +1,52 @@
+=begin
+ Copyright IBM Corp. 2015
+ 
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+ 
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License. 
+=end
+
+class CacheControl
+=begin
+	This class is meant to control how often the application updates
+	
+	ttl = how many seconds the application waits before updating
+	last_accessed = when you last accessed the application
+=end
+	@@cache_ttl = 600
+	@@cache_last_accessed = Time.now
+	
+	def get_ttl
+		@@cache_ttl
+	end
+	
+	def set_ttl(seconds)
+		@@cache_ttl = seconds
+	end
+	
+	# Sets cache_ttl to a high number so it never (rarely) updates
+	def turn_off_cache_update
+		@@cache_ttl = 9999999999
+	end
+	
+	# Sets cache_ttl to 0 so cache will update every time
+	def always_cache_update
+		@@cache_ttl = 0
+	end
+	
+	def get_last_accessed_time
+		@@cache_last_accessed
+	end
+	
+	def set_last_accessed_time(time)
+		@@cache_last_accessed = time
+	end
+end

data/lib/gp-ruby-client.rb

@@ -0,0 +1,108 @@
+=begin
+ Copyright IBM Corp. 2015
+ 
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+ 
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License. 
+=end
+
+=begin
+				This class is meant to be the main container that holds all the necessary objects
+				
+				It contains a service account object that identifies who you are and a REST client object
+				that makes the REST API calls and store the results of those calls. You must provide your bundle identifies
+				in order for the application to run effectively. You can choose the default translation language you would like 
+				by setting the locale
+				
+				cache_control = Cache Control Object - See cache_control.rb
+				locale = locale of the translated strings. Default is "" which indicates all locales will be loaded
+				use_service = parameter to set if user would like to disable/enable service
+				bundle_id = ID of the bundle that contains the translations
+				service_account = Service Account Object - See service_account.rb
+				rest_client = REST Client object - See rest_client.rb
+=end	
+			
+module GP
+	module Ruby
+		class Client
+			require_relative './service_account.rb'
+			require_relative './rest_client.rb'
+			require_relative './cache_control.rb'
+			
+			@@cache_control = CacheControl.new
+			
+			@@locale = ""
+			
+			@@just_started = true
+			@@use_service = true
+
+			def initialize(bundle_id)
+				@@bundle_id = bundle_id
+				
+				if @@use_service && (Time.now - @@cache_control.get_last_accessed_time >= @@cache_control.get_ttl || @@just_started)
+					@@just_started = false
+					@@cache_control.set_last_accessed_time(Time.now)
+					
+					backend = {}
+					I18n.backend = I18n::Backend::Chain.new(I18n::Backend::KeyValue.new(backend), I18n.backend)
+					
+					@@service_account = ServiceAccount.new
+					if @@service_account.nil?
+						raise "No valid service account"
+					end
+					
+					@@rest_client = RESTClient.new(@@service_account, @@bundle_id, @@locale)
+				end				
+			end
+			
+			def get_bundle_id
+				@@bundle_id
+			end
+			
+			def set_bundle_id(bundle_id)
+				@@bundle_id = bundle_id
+			end
+			
+			def get_locale
+				@@locale
+			end
+			
+			def set_locale(locale)
+				@@locale = locale
+			end
+			
+			def get_cache_control
+				@@cache_control
+			end
+			
+			def get_service_account
+				@@service_account
+			end
+			
+			def get_rest_client
+				@@rest_client
+			end
+			
+			def disable_service
+				@@use_service = false
+			end
+			
+			def enable_service
+				@@use_service = true
+			end
+			
+			def get_default_locale
+				request.env['HTTP_ACCEPT_LANGUAGE'].scan(/^[a-z]{2}/).first
+			end
+			
+		end
+	end
+end

data/lib/hmac.rb

@@ -0,0 +1,51 @@
+=begin
+ Copyright IBM Corp. 2015
+ 
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+ 
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License. 
+=end
+
+require 'time'
+require 'openssl'
+require 'base64'
+
+class HMAC
+=begin
+	This class is meant to provide HMAC authentication when making the REST API calls.
+=end
+	GAAS_SCHEME_STRING ||= "GaaS-HMAC"
+	SEPARATOR ||= ":"
+	ENCODING ||= "ISO-8859-1"
+	SHA1_STRING ||= "sha1"
+	
+	def get_auth_credentials(uid, secret, method, url, rfc1123date, body)
+		signature = get_signature(secret,method,url,rfc1123date,body)
+		if !signature.empty?
+			output = "#{GAAS_SCHEME_STRING} #{uid}#{SEPARATOR}#{signature}"
+			return output
+		end
+	end
+	
+	def get_signature(secret,method,url,rfc1123date,body)
+		secret.encode(ENCODING)
+		
+		key = "#{method.encode(ENCODING)}\n#{url.encode(ENCODING)}\n#{rfc1123date.encode(ENCODING)}\n#{body.encode(ENCODING)}"
+		
+		digest = OpenSSL::Digest.new(SHA1_STRING)
+		hex_string = OpenSSL::HMAC.digest(digest,secret,key)
+		return Base64.encode64(hex_string)
+	end
+	
+	def get_rfc1123_date
+		Time.now.httpdate
+	end
+end

data/lib/rest_client.rb

@@ -0,0 +1,195 @@
+=begin
+ Copyright IBM Corp. 2015
+ 
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+ 
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License. 
+=end
+
+require 'net/http'
+require 'json'
+require_relative './hmac.rb'
+
+class RESTClient	
+=begin
+	This object is used to make the REST API calls using credentials found in your service account object 
+	and store the results of the REST API calls.
+	
+	bundles = list of all the bundles associated to your service instance
+	language = a map of the languages of your translated string in the following format: {sourceLanguage : [targetLanguages]}
+	resource_data = hash containing your translalated strings in the following format: {locale: {key : translated_value}}
+	service_account = ServiceAccount object that contains the credentials necessary to make the REST API calls. See service_account.rb
+	bundle_id = ID of the bundle that contains the translated strings
+=end
+	
+	BUNDLE_STRING ||= "bundle"
+	SOURCE_LANGUAGE_STRING ||= "sourceLanguage"
+	TARGET_LANGUAGES_STRING ||= "targetLanguages"
+	RESOURCE_STRINGS ||= "resourceStrings"
+	BUNDLE_ID_STRING ||= "bundleIds"
+	
+	URL_PATH ||= "v2/bundles"
+	
+	@supportedLangs = ['en','de','es','fr','it', 'ja','ko', 'pt-BR', 'zh-Hans', 'zh-Hant'] 
+	@expectedMatches = {
+            'en': 'en', 'en_US': 'en', 'en-US': 'en',
+            'de': 'de', 'de_at': 'de', 'de-at': 'de',
+            'es': 'es', 'es_mx': 'es', 'es-mx': 'es',
+            'fr': 'fr', 'fr_FR': 'fr', 'fr-Fr': 'fr', 'fr_CA': 'fr',
+            'it': 'it', 'it_ch': 'it', 'it-ch': 'it', 'it-IT': 'it',
+            'ja': 'ja', 'ja_JA': 'ja', 'ja-JA': 'ja',
+            'ko': 'ko', 'ko_KO': 'ko', 'ko-KO': 'ko',
+            'pt-BR': 'pt-BR', 'pt': nil,
+            'zh': 'zh-Hans', 'zh-tw': 'zh-Hant', 'zh-cn': 'zh-Hans',
+            'zh-hk': 'zh-Hant', 'zh-sg': 'zh-Hans',
+    }
+	
+	def initialize(service_account, bundle_id, locale = "")
+		@bundles = []
+		@languages = {}
+		@resource_data = {}
+		@service_account = service_account
+		@bundle_id = bundle_id
+		
+		get_resource_strings(locale)
+	end
+	
+	def get_bundles
+		if @bundles.empty?
+			url_string = "#{@service_account.get_url_string}/#{@service_account.get_instance_id}/#{URL_PATH}"
+			response = make_request(url_string, service_account)
+			@bundles = request[BUNDLE_ID_STRING]
+		end
+		@bundles
+	end
+	
+	#bundle info contains the languages - used get_bundle_info to reflect current API
+	def get_bundle_info
+		if @languages.empty?
+			url_string = "#{@service_account.get_url_string}/#{@service_account.get_instance_id}/#{URL_PATH}/#{@bundle_id}"
+			puts url_string
+			response = make_request(url_string, @service_account)
+			source_language = response[BUNDLE_STRING][SOURCE_LANGUAGE_STRING]
+			@languages[source_language] = response[BUNDLE_STRING][TARGET_LANGUAGES_STRING]
+		end
+		@languages
+	end
+	
+	def get_resource_strings(locale = "")
+		if @resource_data.empty?
+			target_languages = []
+
+			if locale.empty?
+				language_dictionary = get_bundle_info
+				target_languages = get_target_languages.dup
+				target_languages << get_source_language
+			else
+				if (!@supportedLangs.include? locale)
+					if (@expectedMatches.has_key? locale)
+						locale = @expectedMatches[locale]
+					else
+						raise "Unsupported Locale: #{locale}"
+					end
+				end
+				target_languages << locale
+			end
+
+			get_translations(@service_account, target_languages, @bundle_id)
+		else
+			@resource_data
+		end
+	end
+		
+	def has_language(language)
+		if language.equal? get_source_language
+			return true
+		end
+		get_target_languages.each do |lang|
+			if lang.equal? language
+				return true
+			end
+		end
+		
+		return false
+	end
+	
+	def get_source_language
+		@languages.keys[0]
+	end
+	
+	def get_target_languages
+		source_language = get_source_language
+		@languages[source_language]
+	end
+	
+	def get_service_account
+		@service_account
+	end
+	
+	def get_bundle_id
+		@bundle_id
+	end
+	
+	def set_resource_strings (map)
+		@resource_data = map
+	end
+
+	def set_service_account(sa)
+		@service_account = sa
+	end
+	
+	def set_bundle_id(name)
+		@bundle_id = name
+	end
+	
+private
+
+	def make_request(url, service_account, basic_auth = false)
+		uri = URI.parse(url.to_s)
+		request = Net::HTTP::Get.new uri.path
+		
+		if basic_auth
+			request.basic_auth(service_account.get_user_id, service_account.get_password)
+		else
+			hmac = HMAC.new
+			d = hmac.get_rfc1123_date
+			request["Date"] = d
+			request["Authorization"] = hmac.get_auth_credentials(service_account.get_user_id, service_account.get_password, "GET", url,d, "").strip
+		end
+		
+		response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') {|http| 
+			http.request(request)
+		}
+		json_response = JSON.parse(response.body)
+
+		if json_response["status"] != "SUCCESS"
+			raise "Invalid HTTP Request #{json_response["message"]}"
+		end
+		
+		return json_response
+	end
+	
+	def get_translations(service_account, locale_list, project_name)
+		url_string = "#{service_account.get_url_string}/#{service_account.get_instance_id}/#{URL_PATH}/#{project_name}"
+		
+		locale_list.each do |language|
+			target_lang_url = "#{url_string}/#{language}"
+			response = make_request(target_lang_url, service_account)
+			
+			@resource_data[language] = {}
+
+			response[RESOURCE_STRINGS].each do |key, value|
+				I18n.backend.store_translations(language, {key => value}, :escape => false)
+				@resource_data[language][key] = value
+			end
+		end
+	end
+end

data/lib/service_account.rb

@@ -0,0 +1,166 @@
+=begin
+ Copyright IBM Corp. 2015
+ 
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+ 
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License. 
+=end
+
+require 'json'
+
+class ServiceAccount
+=begin
+	This object is meant to identify the user and contains credentials needed to make the REST API calls
+	
+	This class will either use user-provided variables, environment variables or vcap_services variables in your application
+	
+	url = base url string user must call for REST API
+	user_id = ID of user
+	password = password of user
+	instance_id = ID of your specific service instanceId
+=end
+
+	GP_URL ||= "GP_URL"
+	GP_USER_ID ||= "GP_USER_ID"
+	GP_PWD ||= "GP_PASSWORD"
+	GP_INSTANCE_ID ||="GP_INSTANCE_ID"
+	
+	APP_NAME ||= "g11n-pipeline"
+	APP_NAME_REGEX = /gp-(.*)/
+	
+	VCAP_SERVICES ||= "VCAP_SERVICES"
+	
+	CREDENTIALS ||= "credentials"
+	CREDENTIALS_INDEX = 0
+	
+	URL_STRING  ||="url"
+	USER_ID_STRING ||= "userId"
+	PASSWORD_STRING ||= "password"
+	INSTANCE_ID_STRING ||= "instanceId"
+	
+	def initialize(url_string = "", user_id = "", pwd = "", instance_id = "")
+		if !url_string.empty? && !user_id.empty? && !pwd.empty? && !instance_id.empty?
+			@url_string = url_string
+			@user_id = user_id
+			@pwd = pwd
+			@instance_id = instance_id
+		else
+			account = get_service_account_via_env_var
+			
+			if account.nil?
+				account = get_service_account_via_vcap_service
+					if account.nil?
+						raise "Couldn't create a service account"
+					end
+			end
+			
+			@url_string = account[0]
+			@user_id = account[1]
+			@pwd = account[2]
+			@instance_id=account[3]
+			
+		end
+	end
+		
+	def get_url_string
+		@url_string
+	end
+	
+	def get_user_id
+		@user_id
+	end
+	
+	def get_password
+		@pwd
+	end
+	
+	def get_instance_id
+		@instance_id
+	end
+	
+	def set_url_string(url)
+		@url_string = url
+	end
+	
+	def set_user_id(user_id)
+		@user_id = user_id
+	end
+	
+	def set_password(password)
+		@pwd = password
+	end
+	
+	def set_instance_id(instance_id)
+		@instance_id = instance_id
+	end
+	
+private
+
+	def get_service_account_via_env_var
+	
+		url_string = ENV[GP_URL]
+		if url_string.nil?
+			return
+		end
+		
+		user_id = ENV[GP_USER_ID]
+		if user_id.nil?
+			return
+		end
+		
+		pwd = ENV[GP_PWD]
+		if pwd.nil?
+			return
+		end
+		
+		instance_id = ENV[GP_INSTANCE_ID]
+		if instance_id.nil?
+			return
+		end
+	
+		return [url_string, user_id, pwd,instance_id]
+	end
+	
+	def get_service_account_via_vcap_service
+	
+		vcap_services = ENV[VCAP_SERVICES]
+
+		if vcap_services.nil?
+			return
+		end
+		
+		json_vcap_services = JSON.parse(vcap_services)
+		
+		app_name = ""
+		json_vcap_services.each do |key, value|
+			if (key =~ APP_NAME_REGEX or key.equals? (APP_NAME))
+				app_name = key
+				break
+			end
+		end
+
+		credentials_list = JSON.parse(vcap_services)[app_name][CREDENTIALS_INDEX][CREDENTIALS]
+		
+		if !credentials_list.nil?
+			url = credentials_list[URL_STRING]
+			user_id = credentials_list[USER_ID_STRING]
+			pwd = credentials_list[PASSWORD_STRING]
+			instance_id = credentials_list[INSTANCE_ID_STRING]
+			if url.nil? || user_id.nil? || pwd.nil? || instance_id.nil?
+				return
+			end
+			
+			return [url, user_id, pwd, instance_id]
+		end
+		
+		return
+	end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: gp-ruby-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Visaahan Anandarajah
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-27 00:00:00.000000000 Z
+dependencies: []
+description: Ruby SDK for Globalization Pipeline on IBM Bluemix
+email: visanand@ca.ibm.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cache_control.rb
+- lib/gp-ruby-client.rb
+- lib/hmac.rb
+- lib/rest_client.rb
+- lib/service_account.rb
+homepage: 
+licenses: []
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby SDK for Globalization Pipeline
+test_files: []
+has_rdoc: