latchsdk 1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 35cad8b46afdbb0663e511f2f384c393d3321e50
+  data.tar.gz: 3c9c9773b086842240fb9c5c3674b4088f081f02
+SHA512:
+  metadata.gz: 9586fc07284b9b32bbe75c5b3d8f014aa7690a4c8139d3bbf937993c5fa91f62505587b28f19829b6f206f5eec7d03a46b67b6a30e3bc28f0c91c1b72ae2fe40
+  data.tar.gz: 1464d1d793df1cb735aee5e9c21749574b9060df6a729f8cbfbfedb0b24bfddad858682dee526a14861db2f1330f32c3f3402785c6241b86495db44dc91f2070

data/lib/latchsdk.rb

@@ -0,0 +1,217 @@
+#Latch Ruby SDK - Set of  reusable classes to  allow developers integrate Latch on their applications.
+#Copyright (C) 2013 Eleven Paths
+#
+#This library is free software; you can redistribute it and/or
+#modify it under the terms of the GNU Lesser General Public
+#License as published by the Free Software Foundation; either
+#version 2.1 of the License, or (at your option) any later version.
+#
+#This library is distributed in the hope that it will be useful,
+#but WITHOUT ANY WARRANTY; without even the implied warranty of
+#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#Lesser General Public License for more details.
+#
+#You should have received a copy of the GNU Lesser General Public
+#License along with this library; if not, write to the Free Software
+#Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require 'rubygems'
+require 'base64'
+require 'cgi'
+require 'net/http'
+require 'openssl'
+require 'json'
+
+require_relative 'latchsdk/LatchResponse'
+
+class Latch
+
+      attr_accessor  :api_host
+	API_HOST = "https://latch.elevenpaths.com"
+	API_VERSION = "0.6"
+	API_CHECK_STATUS_URL = "/api/0.6/status"
+	API_PAIR_URL = "/api/0.6/pair"
+	API_PAIR_WITH_ID_URL = "/api/0.6/pairWithId"
+	API_UNPAIR_URL =  "/api/0.6/unpair"
+
+	AUTHORIZATION_HEADER_NAME = "Authorization"
+	DATE_HEADER_NAME = "X-11Paths-Date"
+	AUTHORIZATION_METHOD = "11PATHS"
+	AUTHORIZATION_HEADER_FIELD_SEPARATOR = " "
+
+	HMAC_ALGORITHM = "sha1"
+
+	X_11PATHS_HEADER_PREFIX = "X-11Paths-"
+	X_11PATHS_HEADER_SEPARATOR = ":"
+
+
+
+
+
+	# The custom header consists of three parts, the method, the appId and the signature.
+	# This method returns the specified part if it exists.
+	# @param $part The zero indexed part to be returned
+	# @param $header The HTTP header value from which to extract the part
+	# @return string the specified part from the header or an empty string if not existent
+	def getPartFromHeader(part, header)
+		if (header.empty?)
+			parts = header.split(AUTHORIZATION_HEADER_FIELD_SEPARATOR)
+			if(parts.length > part)
+				return parts[part]
+			end
+		end
+		return ""
+	end
+
+	# @param $authorizationHeader Authorization HTTP Header
+	# @return string the Authorization method. Typical values are "Basic", "Digest" or "11PATHS"
+	def getAuthMethodFromHeader(authorizationHeader)
+		getPartFromHeader(0, authorizationHeader)
+    end
+
+	# @param $authorizationHeader Authorization HTTP Header
+	# @return string the requesting application Id. Identifies the application using the API
+    def getAppIdFromHeader(authorizationHeader)
+    	getPartFromHeader(1, authorizationHeader)
+    end
+
+
+	# @param $authorizationHeader Authorization HTTP Header
+	# @return string the signature of the current request. Verifies the identity of the application using the API
+    def getSignatureFromHeader(authorizationHeader)
+    	getPartFromHeader(2, authorizationHeader)
+    end
+
+
+	# Create an instance of the class with the Application ID and secret obtained from Eleven Paths
+	# @param $appId
+	# @param $secretKey
+    def initialize(appid, secret)
+    	@appid = appid
+    	@secret = secret
+      @api_host = API_HOST
+    end
+
+
+    def http_get(url, headers)
+    	     uri = URI.parse(url)
+		http = Net::HTTP.new(uri.host, uri.port)
+
+           if (uri.default_port == 443)
+		    http.use_ssl = true
+		    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+           end
+
+
+		request = Net::HTTP::Get.new(uri.request_uri)
+
+		headers.map do |key,value|
+			request[key] = value
+		end
+
+		response = http.request(request)
+		response.body
+    end
+
+
+	def http_get_proxy(url)
+		LatchResponse.new(http_get(api_host + url, authenticationHeaders('GET', url, nil)))
+	end
+
+
+	def pairWithId(accountId)
+		http_get_proxy(API_PAIR_WITH_ID_URL + '/' + accountId)
+	end
+
+
+	def pair(token)
+		http_get_proxy(API_PAIR_URL + '/' + token)
+	end
+
+
+	def status(accountId)
+		http_get_proxy(API_CHECK_STATUS_URL + '/' + accountId)
+	end
+
+
+	def operationStatus(accountId, operationId)
+		http_get_proxy(API_CHECK_STATUS_URL + "/" + accountId + '/' + operationId)
+	end
+
+
+	def unpair(accountId)
+		http_get_proxy(API_UNPAIR_URL + '/' + accountId)
+	end
+
+
+
+	# @param $data the string to sign
+	# @return string base64 encoding of the HMAC-SHA1 hash of the data parameter using {@code secretKey} as cipher key.
+	def signData(data)
+		Base64.encode64(OpenSSL::HMAC.digest(HMAC_ALGORITHM, @secret, data))
+	end
+
+
+	# Calculate the authentication headers to be sent with a request to the API
+	# @param $HTTPMethod the HTTP Method, currently only GET is supported
+	# @param $queryString the urlencoded string including the path (from the first forward slash) and the parameters
+	# @param $xHeaders HTTP headers specific to the 11-paths API. null if not needed.
+	# @param $utc the Universal Coordinated Time for the Date HTTP header
+	# @return array a map with the Authorization and Date headers needed to sign a Latch API request
+	def authenticationHeaders(httpMethod, queryString, xHeaders=nil, utc=nil)
+		if (utc == nil)
+			utc = getCurrentUTC
+		end
+
+		stringToSign = (httpMethod.upcase).strip + "\n" +
+						utc.to_s + "\n" +
+						getSerializedHeaders(xHeaders) + "\n" +
+						queryString.strip
+
+		authorizationHeader = AUTHORIZATION_METHOD +
+							   AUTHORIZATION_HEADER_FIELD_SEPARATOR +
+							   @appid +
+							   AUTHORIZATION_HEADER_FIELD_SEPARATOR +
+							   signData(stringToSign).chop
+
+		headers = {}
+		headers[AUTHORIZATION_HEADER_NAME] = authorizationHeader
+		headers[DATE_HEADER_NAME] = utc
+		return headers
+	end
+
+
+
+	# Prepares and returns a string ready to be signed from the 11-paths specific HTTP headers received
+	# @param $xHeaders a non necessarily ordered map of the HTTP headers to be ordered without duplicates.
+	# @return a String with the serialized headers, an empty string if no headers are passed, or null if there's a problem
+	# such as non 11paths specific headers
+	def getSerializedHeaders(xHeaders)
+		if(xHeaders != nil)
+			headers = xHeaders.inject({}) do |xHeaders, keys|
+			  hash[keys[0].downcase] = keys[1]
+			  hash
+			end
+
+
+			serializedHeaders = ''
+
+			headers.sort.map do |key,value|
+				if(key.downcase == X_11PATHS_HEADER_PREFIX.downcase)
+					puts "Error serializing headers. Only specific " + X_11PATHS_HEADER_PREFIX + " headers need to be singed"
+					return nil
+				end
+				serializedHeaders += key + X_11PATHS_HEADER_SEPARATOR + value + ' '
+			end
+			substitute = 'utf-8'
+			return serializedHeaders.gsub(/^[#{substitute}]+|[#{substitute}]+$/, '')
+		else
+			return ""
+		end
+	end
+
+	# @return a string representation of the current time in UTC to be used in a Date HTTP Header
+	def getCurrentUTC
+		Time.now.utc
+	end
+end

data/lib/latchsdk/Error.rb

@@ -0,0 +1,47 @@
+#Latch Ruby SDK - Set of  reusable classes to  allow developers integrate Latch on their applications.
+#Copyright (C) 2013 Eleven Paths
+#
+#This library is free software; you can redistribute it and/or
+#modify it under the terms of the GNU Lesser General Public
+#License as published by the Free Software Foundation; either
+#version 2.1 of the License, or (at your option) any later version.
+#
+#This library is distributed in the hope that it will be useful,
+#but WITHOUT ANY WARRANTY; without even the implied warranty of
+#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#Lesser General Public License for more details.
+#
+#You should have received a copy of the GNU Lesser General Public
+#License along with this library; if not, write to the Free Software
+#Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require 'rubygems'
+require 'json'
+
+class Error
+
+	attr_reader :code
+	attr_reader :message
+
+	# @param string json a Json representation of an error with "code" and "message" elements
+	def initialize(json)
+		if (json.is_a?(String))
+			json = JSON.Parse(json)
+		end
+
+		if(json.has_key?("code")  && json.has_key?("message"))
+			@code = json["code"]
+			@message = json["message"]
+		else
+			puts "Error creating error object from string " + json
+		end
+    end
+
+    # JSON representing the Error Object
+    def to_json
+		error =  {}
+		error["code"] = @code
+		error["message"] = @message
+		error.to_json
+	end
+end

data/lib/latchsdk/LatchResponse.rb

@@ -0,0 +1,61 @@
+#Latch Ruby SDK - Set of  reusable classes to  allow developers integrate Latch on their applications.
+#Copyright (C) 2013 Eleven Paths
+#
+#This library is free software; you can redistribute it and/or
+#modify it under the terms of the GNU Lesser General Public
+#License as published by the Free Software Foundation; either
+#version 2.1 of the License, or (at your option) any later version.
+#
+#This library is distributed in the hope that it will be useful,
+#but WITHOUT ANY WARRANTY; without even the implied warranty of
+#MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#Lesser General Public License for more details.
+#
+#You should have received a copy of the GNU Lesser General Public
+#License along with this library; if not, write to the Free Software
+#Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require 'rubygems'
+require 'json'
+require_relative 'Error'
+
+
+# This class models a response from any of the endpoints in the Latch API.
+# It consists of a "data" and an "error" elements. Although normally only one of them will be
+# present, they are not mutually exclusive, since errors can be non fatal, and therefore a response
+# could have valid information in the data field and at the same time inform of an error.
+class LatchResponse
+
+	attr_accessor :data
+	attr_accessor :error
+
+
+	# @param jsonString a json string received from one of the methods of the Latch API
+	def initialize(jsonString)
+		json = JSON.parse(jsonString)
+
+		if(json != nil)
+			if (json.has_key?("data"))
+				@data = json["data"]
+			end
+
+			if (json.has_key?("error"))
+				@error = Error.new(json["error"])
+			end
+		end
+    end
+
+    # Get JSON String that represents the LatchResponse object
+	def to_json
+		response = {}
+
+		if (@data != nil)
+			response["data"] = @data
+		end
+
+		if (@error != nil)
+			response["error"] = @error.to_json
+		end
+		response.to_json
+	end
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: latchsdk
+version: !ruby/object:Gem::Version
+  version: '1.1'
+platform: ruby
+authors:
+- ElevenPaths
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-12 00:00:00.000000000 Z
+dependencies: []
+description: This SDK allows developers to integrate Latch on their Ruby services.
+  Latch is a service that lets end-users add an extra level of security to their online
+  accounts and services. With this version of the SDK, developers can pair and unpair
+  users and check their latches status. For more information please visit https://latch.elevenpaths.com
+  or the SDK page on GitHub https://github.com/ElevenPaths/latch-sdk-ruby
+email: it@11paths.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/latchsdk.rb
+- lib/latchsdk/Error.rb
+- lib/latchsdk/LatchResponse.rb
+homepage: https://github.com/ElevenPaths/latch-sdk-ruby
+licenses:
+- LGPL
+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: Latchsdk
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: This SDK allows developers to integrate Latch on their Ruby services.
+test_files: []
+has_rdoc: