miiCardConsumers 2.0.0 → 2.1.0

data/lib/miiCardConsumers.rb

@@ -4,7 +4,7 @@ require "json"
 class MiiCardServiceUrls
 	OAUTH_ENDPOINT = "https://sts.miicard.com/auth/OAuth.ashx"
 	STS_SITE = "https://sts.miicard.com"
-    CLAIMS_SVC = "https://sts.miicard.com/api/v1/Claims.svc/json"
+	CLAIMS_SVC = "https://sts.miicard.com/api/v1/Claims.svc/json"
 	
 	def self.get_method_url(method_name)
 		return MiiCardServiceUrls::CLAIMS_SVC + "/" + method_name
@@ -31,16 +31,16 @@ module MiiApiErrorCode
 	ACCESS_REVOKED = 100
 	# The user's miiCard subscription has elapsed. Only users with a current
 	# subscription can share their data with other applications and websites.	
-    USER_SUBSCRIPTION_LAPSED = 200
-    # Signifies that your account has not been enabled for transactional support.
-    TRANSACTIONAL_SUPPORT_DISABLED = 1000
-    # Signifies that your account's support status is development-only. This is the
-    # case when your application hasn't yet been made live in the miiCard system, for example
-    # while we process your billing details and perform final checks.
-    DEVELOPMENT_TRANSACTIONAL_SUPPORT_ONLY = 1010
-    # Signifies that the snapshot ID supplied to a snapshot-based API method was either invalid
-    # or corresponded to a user for which authorisation tokens didn't match.
-    INVALID_SNAPSHOT_ID = 1020
+	USER_SUBSCRIPTION_LAPSED = 200
+	# Signifies that your account has not been enabled for transactional support.
+	TRANSACTIONAL_SUPPORT_DISABLED = 1000
+	# Signifies that your account's support status is development-only. This is the
+	# case when your application hasn't yet been made live in the miiCard system, for example
+	# while we process your billing details and perform final checks.
+	DEVELOPMENT_TRANSACTIONAL_SUPPORT_ONLY = 1010
+	# Signifies that the snapshot ID supplied to a snapshot-based API method was either invalid
+	# or corresponded to a user for which authorisation tokens didn't match.
+	INVALID_SNAPSHOT_ID = 1020
 	# Signifies that your application has been suspended and no API access can take place
 	# until miiCard releases the suspension on your application.
 	BLACKLISTED = 2000
@@ -55,7 +55,7 @@ module MiiApiErrorCode
 	# A general exception occurred during processing - details may be available
 	# in the error_message property of the response object depending upon the
 	# nature of the exception.
-    EXCEPTION = 10000
+	EXCEPTION = 10000
 end
 
 # Describes the overall status of an API call.
@@ -199,51 +199,53 @@ class MiiUserProfile
 	attr_accessor :previous_first_name, :previous_middle_name, :previous_last_name
 	attr_accessor :last_verified, :profile_url, :profile_short_url, :card_image_url, :email_addresses, :identities, :postal_addresses
 	attr_accessor :phone_numbers, :web_properties, :identity_assured, :has_public_profile
-	attr_accessor :public_profile
+	attr_accessor :public_profile, :date_of_birth
 	
 	def initialize(
 		username,
 		salutation,
-        first_name,
-        middle_name,
-        last_name,
-        previous_first_name,
-        previous_middle_name,
-        previous_last_name,
-        last_verified,
-        profile_url,
-        profile_short_url,
-        card_image_url,
-        email_addresses,
-        identities,
-        phone_numbers,
-        postal_addresses,
-        web_properties,
-        identity_assured,
-        has_public_profile,
-        public_profile
+		first_name,
+		middle_name,
+		last_name,
+		previous_first_name,
+		previous_middle_name,
+		previous_last_name,
+		last_verified,
+		profile_url,
+		profile_short_url,
+		card_image_url,
+		email_addresses,
+		identities,
+		phone_numbers,
+		postal_addresses,
+		web_properties,
+		identity_assured,
+		has_public_profile,
+		public_profile,
+		date_of_birth
 		)
 		
 		@username= username
 		@salutation = salutation
-        @first_name = first_name
-        @middle_name = middle_name
-        @last_name = last_name
-        @previous_first_name = previous_first_name
-        @previous_middle_name = previous_middle_name
-        @previous_last_name = previous_last_name
-        @last_verified = last_verified
-        @profile_url = profile_url
-        @profile_short_url = profile_short_url
-        @card_image_url = card_image_url
-        @email_addresses = email_addresses
-        @identities = identities
-        @phone_numbers = phone_numbers
-        @postal_addresses = postal_addresses
-        @web_properties = web_properties
-        @identity_assured = identity_assured
-        @has_public_profile = has_public_profile
-        @public_profile = public_profile
+		@first_name = first_name
+		@middle_name = middle_name
+		@last_name = last_name
+		@previous_first_name = previous_first_name
+		@previous_middle_name = previous_middle_name
+		@previous_last_name = previous_last_name
+		@last_verified = last_verified
+		@profile_url = profile_url
+		@profile_short_url = profile_short_url
+		@card_image_url = card_image_url
+		@email_addresses = email_addresses
+		@identities = identities
+		@phone_numbers = phone_numbers
+		@postal_addresses = postal_addresses
+		@web_properties = web_properties
+		@identity_assured = identity_assured
+		@has_public_profile = has_public_profile
+		@public_profile = public_profile
+		@date_of_birth = date_of_birth
 	end
 	
 	def self.from_hash(hash)
@@ -303,7 +305,8 @@ class MiiUserProfile
 			web_properties_parsed,
 			hash['IdentityAssured'],
 			hash['HasPublicProfile'],
-			public_profile_parsed
+			public_profile_parsed,
+			Util::parse_dot_net_json_datetime(hash['DateOfBirth'])
 			)			
 	end
 end
@@ -323,11 +326,11 @@ class MiiApiResponse
 		payload_json = hash["Data"]
 		
 		if payload_json && !data_processor.nil?
-            if array_type_payload
-                payload = payload_json.map{|item| data_processor.call(item)}
-            else
-			    payload = data_processor.call(payload_json)
-            end
+			if array_type_payload
+				payload = payload_json.map{|item| data_processor.call(item)}
+			else
+				payload = data_processor.call(payload_json)
+			end
 		elsif !(payload_json.nil?)
 			payload = payload_json
 		else
@@ -345,39 +348,39 @@ class MiiApiResponse
 end
 
 class IdentitySnapshotDetails
-    attr_accessor :snapshot_id, :username, :timestamp_utc, :was_test_user
-    
-    def initialize(snapshot_id, username, timestamp_utc, was_test_user)
-        @snapshot_id = snapshot_id
-        @username = username
-        @timestamp_utc = timestamp_utc
-        @was_test_user = was_test_user
-    end
-    
-    def self.from_hash(hash)
-        return IdentitySnapshotDetails.new(
-            hash["SnapshotId"],
-            hash["Username"],
-            Util::parse_dot_net_json_datetime(hash["TimestampUtc"]),
-            hash["WasTestUser"]
-        )
-    end
+	attr_accessor :snapshot_id, :username, :timestamp_utc, :was_test_user
+	
+	def initialize(snapshot_id, username, timestamp_utc, was_test_user)
+		@snapshot_id = snapshot_id
+		@username = username
+		@timestamp_utc = timestamp_utc
+		@was_test_user = was_test_user
+	end
+	
+	def self.from_hash(hash)
+		return IdentitySnapshotDetails.new(
+			hash["SnapshotId"],
+			hash["Username"],
+			Util::parse_dot_net_json_datetime(hash["TimestampUtc"]),
+			hash["WasTestUser"]
+		)
+	end
 end
 
 class IdentitySnapshot
-    attr_accessor :details, :snapshot
-    
-    def initialize(details, snapshot)
-        @details = details
-        @snapshot = snapshot
-    end
-    
-    def self.from_hash(hash)
-        return IdentitySnapshot.new(
-            IdentitySnapshotDetails::from_hash(hash["Details"]),
-            MiiUserProfile::from_hash(hash["Snapshot"])
-        )
-    end
+	attr_accessor :details, :snapshot
+	
+	def initialize(details, snapshot)
+		@details = details
+		@snapshot = snapshot
+	end
+	
+	def self.from_hash(hash)
+		return IdentitySnapshot.new(
+			IdentitySnapshotDetails::from_hash(hash["Details"]),
+			MiiUserProfile::from_hash(hash["Snapshot"])
+		)
+	end
 end
 
 class MiiCardOAuthServiceBase
@@ -419,18 +422,18 @@ class MiiCardOAuthClaimsService < MiiCardOAuthServiceBase
 		
 		return make_request(MiiCardServiceUrls.get_method_url('AssuranceImage'), params, nil, false)
 	end
-        
-    def get_identity_snapshot_details(snapshot_id = nil)
-        params = Hash["snapshotId", snapshot_id]
-        
-        return make_request(MiiCardServiceUrls.get_method_url('GetIdentitySnapshotDetails'), params, IdentitySnapshotDetails.method(:from_hash), true, true)
-    end
-    
-    def get_identity_snapshot(snapshot_id)
-        params = Hash["snapshotId", snapshot_id]
-        
-        return make_request(MiiCardServiceUrls.get_method_url('GetIdentitySnapshot'), params, IdentitySnapshot.method(:from_hash), true)
-    end
+		
+	def get_identity_snapshot_details(snapshot_id = nil)
+		params = Hash["snapshotId", snapshot_id]
+		
+		return make_request(MiiCardServiceUrls.get_method_url('GetIdentitySnapshotDetails'), params, IdentitySnapshotDetails.method(:from_hash), true, true)
+	end
+	
+	def get_identity_snapshot(snapshot_id)
+		params = Hash["snapshotId", snapshot_id]
+		
+		return make_request(MiiCardServiceUrls.get_method_url('GetIdentitySnapshot'), params, IdentitySnapshot.method(:from_hash), true)
+	end
 	
 	private
 	def make_request(url, post_data, payload_processor, wrapped_response, array_type_payload = false)
@@ -440,7 +443,7 @@ class MiiCardOAuthClaimsService < MiiCardOAuthServiceBase
 		response = access_token.post(url, post_data.to_json(), { 'Content-Type' => 'application/json' })
 		
 		if wrapped_response
-            return MiiApiResponse::from_hash(JSON.parse(response.body), payload_processor, array_type_payload)
+			return MiiApiResponse::from_hash(JSON.parse(response.body), payload_processor, array_type_payload)
 		elsif !payload_processor.nil?
 			return payload_processor.call(response.body)
 		else
@@ -453,6 +456,6 @@ class Util
 	# Modified from http://stackoverflow.com/questions/1272195/c-sharp-serialized-json-date-to-ruby
 	def self.parse_dot_net_json_datetime(datestring)
 	  seconds_since_epoch = (datestring.scan(/[0-9]+/)[0].to_i) / 1000.0
-	  return Time.at(seconds_since_epoch)
+	  return DateTime.strptime(seconds_since_epoch.to_s, '%s')
 	end
 end

data/test/test_miiCardConsumers.rb

@@ -1,10 +1,11 @@
 require 'json'
 require 'miiCardConsumers'
 require 'test/unit'
+require 'date'
 
 class TestSomething < Test::Unit::TestCase
 	def setup
-		@jsonBody = '{"CardImageUrl":"https:\/\/my.miicard.com\/img\/test.png","EmailAddresses":[{"Verified":true,"Address":"test@example.com","DisplayName":"testEmail","IsPrimary":true},{"Verified":false,"Address":"test2@example.com","DisplayName":"test2Email","IsPrimary":false}],"FirstName":"Test","HasPublicProfile":true,"Identities":null,"IdentityAssured":true,"LastName":"User","LastVerified":"\/Date(1345812103)\/","MiddleName":"Middle","PhoneNumbers":[{"Verified":true,"CountryCode":"44","DisplayName":"Default","IsMobile":true,"IsPrimary":true,"NationalNumber":"7800123456"},{"Verified":false,"CountryCode":"44","DisplayName":"Default","IsMobile":false,"IsPrimary":false,"NationalNumber":"7800123457"}],"PostalAddresses":[{"House":"Addr1 House1","Line1":"Addr1 Line1","Line2":"Addr1 Line2","City":"Addr1 City","Region":"Addr1 Region","Code":"Addr1 Code","Country":"Addr1 Country","IsPrimary":true,"Verified":true},{"House":"Addr2 House1","Line1":"Addr2 Line1","Line2":"Addr2 Line2","City":"Addr2 City","Region":"Addr2 Region","Code":"Addr2 Code","Country":"Addr2 Country","IsPrimary":false,"Verified":false}],"PreviousFirstName":"PrevFirst","PreviousLastName":"PrevLast","PreviousMiddleName":"PrevMiddle","ProfileShortUrl":"http:\/\/miicard.me\/123456","ProfileUrl":"https:\/\/my.miicard.com\/card\/test","PublicProfile":{"CardImageUrl":"https:\/\/my.miicard.com\/img\/test.png","FirstName":"Test","HasPublicProfile":true,"IdentityAssured":true,"LastName":"User","LastVerified":"\/Date(1345812103)\/","MiddleName":"Middle","PreviousFirstName":"PrevFirst","PreviousLastName":"PrevLast","PreviousMiddleName":"PrevMiddle","ProfileShortUrl":"http:\/\/miicard.me\/123456","ProfileUrl":"https:\/\/my.miicard.com\/card\/test","PublicProfile":null,"Salutation":"Ms","Username":"testUser"},"Salutation":"Ms","Username":"testUser","WebProperties":[{"Verified":true,"DisplayName":"example.com","Identifier":"example.com","Type":0},{"Verified":false,"DisplayName":"2.example.com","Identifier":"http:\/\/www.2.example.com","Type":1}]}'
+		@jsonBody = '{"CardImageUrl":"https:\/\/my.miicard.com\/img\/test.png","DateOfBirth":"\/Date(435046400000)\/","EmailAddresses":[{"Verified":true,"Address":"test@example.com","DisplayName":"testEmail","IsPrimary":true},{"Verified":false,"Address":"test2@example.com","DisplayName":"test2Email","IsPrimary":false}],"FirstName":"Test","HasPublicProfile":true,"Identities":null,"IdentityAssured":true,"LastName":"User","LastVerified":"\/Date(1345812103000)\/","MiddleName":"Middle","PhoneNumbers":[{"Verified":true,"CountryCode":"44","DisplayName":"Default","IsMobile":true,"IsPrimary":true,"NationalNumber":"7800123456"},{"Verified":false,"CountryCode":"44","DisplayName":"Default","IsMobile":false,"IsPrimary":false,"NationalNumber":"7800123457"}],"PostalAddresses":[{"House":"Addr1 House1","Line1":"Addr1 Line1","Line2":"Addr1 Line2","City":"Addr1 City","Region":"Addr1 Region","Code":"Addr1 Code","Country":"Addr1 Country","IsPrimary":true,"Verified":true},{"House":"Addr2 House1","Line1":"Addr2 Line1","Line2":"Addr2 Line2","City":"Addr2 City","Region":"Addr2 Region","Code":"Addr2 Code","Country":"Addr2 Country","IsPrimary":false,"Verified":false}],"PreviousFirstName":"PrevFirst","PreviousLastName":"PrevLast","PreviousMiddleName":"PrevMiddle","ProfileShortUrl":"http:\/\/miicard.me\/123456","ProfileUrl":"https:\/\/my.miicard.com\/card\/test","PublicProfile":{"CardImageUrl":"https:\/\/my.miicard.com\/img\/test.png","DateOfBirth":"\/Date(435046400000)\/","FirstName":"Test","HasPublicProfile":true,"IdentityAssured":true,"LastName":"User","LastVerified":"\/Date(1345812103000)\/","MiddleName":"Middle","PreviousFirstName":"PrevFirst","PreviousLastName":"PrevLast","PreviousMiddleName":"PrevMiddle","ProfileShortUrl":"http:\/\/miicard.me\/123456","ProfileUrl":"https:\/\/my.miicard.com\/card\/test","PublicProfile":null,"Salutation":"Ms","Username":"testUser"},"Salutation":"Ms","Username":"testUser","WebProperties":[{"Verified":true,"DisplayName":"example.com","Identifier":"example.com","Type":0},{"Verified":false,"DisplayName":"2.example.com","Identifier":"http:\/\/www.2.example.com","Type":1}]}'
 		@jsonResponseBody = '{"ErrorCode":0,"Status":0,"ErrorMessage":"A test error message","Data":true}'
 	end
 
@@ -99,7 +100,8 @@ class TestSomething < Test::Unit::TestCase
         assert_equal("PrevLast", obj.previous_last_name)
 
         assert_equal(true, obj.identity_assured)
-        assert_equal("/Date(1345812103)/", obj.last_verified)
+		assert_equal(DateTime.strptime('1345812103','%s'), obj.last_verified)
+		assert_equal(DateTime.strptime('435046400', '%s'), obj.date_of_birth)
 
         assert_equal(true, obj.has_public_profile)
         assert_equal("http://miicard.me/123456", obj.profile_short_url)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: miiCardConsumers
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-11 00:00:00.000000000 Z
+date: 2013-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
@@ -46,7 +46,7 @@ dependencies:
 description: A simple wrapper library around the miiCard API that makes calling into
   it easier - just new up a MiiApiOAuthClaimsService with your consumer key, secret,
   access token and secret and start calling methods.
-email: paul.oneill@miicard.com
+email: info@miicard.com
 executables: []
 extensions: []
 extra_rdoc_files: []