hangouts_json_parser 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 268c24b7e13e37ad44ff7e608faa3a5ee46f0e33
-  data.tar.gz: 537eb8c1da511728032d80209a3e545861126c59
+  metadata.gz: 943423545cffd1c72445339df7b291598985165b
+  data.tar.gz: 0efc4089999bdad0128670d4158cf71c5819acf0
 SHA512:
-  metadata.gz: 82701c2d118aff68c95af16561b1d7fced8a2f89f6a5ca4060426b6953a17804682ad73baefc6184d11b0eca025e02652325c1170ac960859b14c138752f9feb
-  data.tar.gz: da11a84d0e872ced88b6f86a5909b6b65873658dd5752f1613a53b2269fa92b394ed200275c340289802bdbbcd2493212d99090511076a5f5300ab78e2195739
+  metadata.gz: 6fb7156fea27fe4e9ca7f6469ee292140be16eaf1ba0b0cee7bd40b0f4600d44207b8747e8143b96216e17517375ca71e0b4135201bdd779b9fdd0c7b568e800
+  data.tar.gz: bec713062ba76b29c6a541df29ce9a36f4885103594f2ed4eb689b377ec10908bb7658cc53b739f4423d3c0f383eddac2d7d6228dede2ac7b5e19429d2492c6b

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+bin/test

data/hangouts_json_parser.gemspec

@@ -20,4 +20,6 @@ Gem::Specification.new do |spec|
 
 	spec.add_development_dependency "bundler", "~> 1.11"
 	spec.add_development_dependency "rake", "~> 10.0"
+
+	spec.add_runtime_dependency "ruby_dig", '~> 0.0.2'
 end

data/lib/hangouts_json_parser.rb

@@ -1,7 +1,22 @@
+require "ruby_dig"
+
 require "hangouts_json_parser/version"
 require "hangouts_json_parser/user"
+require "hangouts_json_parser/attachment"
+require "hangouts_json_parser/attachment/location"
+require "hangouts_json_parser/attachment/photo"
+require "hangouts_json_parser/message"
 require "hangouts_json_parser/conversation"
 
 # Parse JSON formatted Hangouts data into more useful data structures
 module HangoutsJsonParser
+	# Parses conversation state into an array of Conversations
+	#
+	# @param state [Array<Hash>] converstation_state from the Takeout data
+	# @return [Array<Conversation>] all conversations in the state
+	def self.parse_conversation_state state
+		state.map do |s|
+			Conversation.from_state s['conversation_state']
+		end
+	end
 end

data/lib/hangouts_json_parser/attachment.rb

@@ -0,0 +1,28 @@
+module HangoutsJsonParser
+	# All possible attachments
+	module Attachment
+		# An attachment to a chat message
+		class Attachment
+			# Creates an attachment from message data
+			# @param data [Hash] attachment data
+			# @return [Attachment] new Attachment
+			def self.from_message_attachment data
+				raise "Data passed is not an attachment" if data.dig("embed_item", "type").nil?
+
+				case data.dig("embed_item", "type")
+				when Photo.type
+					Photo.from_message_attachment data
+				when Location.type
+					Location.from_message_attachment data
+				else
+					nil
+				end
+			end
+
+			# @return [Array] type identifier of this attachment
+			def self.type
+				nil
+			end
+		end
+	end
+end

data/lib/hangouts_json_parser/attachment/location.rb

@@ -0,0 +1,30 @@
+module HangoutsJsonParser
+	module Attachment
+		# A location attachment
+		class Location < Attachment
+			#TODO: Extract all data from this object
+			#This one actually looks like it holds other types of attachments, that might be worth looking in to
+
+			# @return [String] url to the location on Google Maps
+			attr_reader :url
+
+			def initialize url
+				@url = url
+			end
+
+			# Creates a Location from message data
+			# @param data [Hash] attachment data
+			# @return [Location] new Location
+			def self.from_message_attachment data
+				raise "Attachment passed is not a location" unless data.dig("embed_item", "type").eql? Location.type
+
+				Location.new data.dig("embed_item", "id")
+			end
+
+			# @return [Array] type identifier of this attachment
+			def self.type
+				["PLACE_V2", "THING_V2", "THING"]
+			end
+		end
+	end
+end

data/lib/hangouts_json_parser/attachment/photo.rb

@@ -0,0 +1,46 @@
+module HangoutsJsonParser
+	module Attachment
+		# A photo attachment
+		class Photo < Attachment
+			# @return [String] photo ID
+			attr_reader :id
+			# @return [String] album ID that the photo is in
+			attr_reader :album
+			# @return [String] link to the photo on Google+
+			attr_reader :photo_link
+			# @return [String] URL to thumbnail of the image
+			attr_reader :thumbnail
+			# @return [String] URL of the image
+			attr_reader :url
+
+			def initialize id, album, photo_link, thumbnail, url
+				@album = album
+				@id = id
+				@photo_link = photo_link
+				@thumbnail = thumbnail
+				@url = url
+			end
+
+			# Creates a Photo from message data
+			# @param data [Hash] attachment data
+			# @return [Photo] new Photo
+			def self.from_message_attachment data
+				raise "Attachment passed is not a photo" unless data.dig("embed_item", "type").eql? Photo.type
+
+				photo = data.dig("embed_item", "embeds.PlusPhoto.plus_photo")
+				raise "Photo data not found" if photo.nil?
+
+				Photo.new photo["photo_id"],
+							photo["album_id"],
+							photo.dig("thumbnail", "url"),
+							photo.dig("thumbnail", "image_url"),
+							photo["url"]
+			end
+
+			# @return [Array] type identifier of this attachment
+			def self.type
+				["PLUS_PHOTO"]
+			end
+		end
+	end
+end

data/lib/hangouts_json_parser/conversation.rb

@@ -7,5 +7,36 @@ module HangoutsJsonParser
 		attr_reader :type
 		# @return [Array<User>] the Users that are participating in this chat
 		attr_reader :participants
+		# @return [Array<Message>] the Messages in this chat
+		attr_reader :messages
+
+		def initialize id, type, participants, messages
+			@id = id
+			@type = type
+			@participants = participants
+			@messages = messages
+		end
+
+		# Creates a Conversation based on a conversation_state object
+		# @param state [Hash] conversation_state
+		# @return [Conversation] resulting Conversation
+		def self.from_state state
+			Conversation.new state['conversation']['id']['id'],
+				type_from_string(state['conversation']['type']),
+				state['conversation']['participant_data'].map(&User.method(:from_participant_data)),
+				state['event'].select{ |e| e["event_type"].eql? "REGULAR_CHAT_MESSAGE" }.map(&Message.method(:from_event_data))
+		end
+
+		private
+		def self.type_from_string str
+			case str
+			when "STICKY_ONE_TO_ONE"
+				:private
+			when "GROUP"
+				:group
+			else
+				:unknown
+			end
+		end
 	end
 end

data/lib/hangouts_json_parser/message.rb

@@ -0,0 +1,30 @@
+module HangoutsJsonParser
+	# A message sent in a Conversation
+	class Message
+		# @return [User] the User that sent this message
+		attr_reader :sender
+		# @return [Time] timestamp
+		attr_reader :timestamp
+		# @return [Array<Attachment>] attachments
+		attr_reader :attachments
+
+		def initialize sender, timestamp, attachments
+			@sender = sender
+			@timestamp = timestamp
+			@attachments = attachments
+		end
+
+		# Creates a message from event data
+		def self.from_event_data data
+			# TODO: move type to const?
+			raise "Event passed is not a message" unless data["event_type"].eql? "REGULAR_CHAT_MESSAGE"
+
+			attachments = (data.dig("chat_message", "message_content", "attachment") || []).map do |data|
+				Attachment::Attachment.from_message_attachment data
+			end
+
+			# Timestamp is in microseconds, convert to float seconds
+			Message.new nil, Time.at(data["timestamp"].to_f / 1.0e06), attachments
+		end
+	end
+end

data/lib/hangouts_json_parser/user.rb

@@ -10,5 +10,16 @@ module HangoutsJsonParser
 		def profile
 			"https://plus.google.com/#{id}"
 		end
+
+		def initialize id, name
+			@id = id
+			@name = name
+		end
+
+		# Creates a user from participant data
+		def self.from_participant_data data
+			# TODO: Use the Google+ API to actually look up this person?
+			User.new data['id']['gaia_id'], data['fallback_name']
+		end
 	end
 end

data/lib/hangouts_json_parser/version.rb

@@ -1,4 +1,4 @@
 module HangoutsJsonParser
 	# gem version
-	VERSION = "0.1.0"
+	VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hangouts_json_parser
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tim van Dalen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-23 00:00:00.000000000 Z
+date: 2016-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: ruby_dig
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.2
 description: 
 email:
 - tim.vandalen@nubisonline.nl
@@ -54,7 +68,11 @@ files:
 - bin/setup
 - hangouts_json_parser.gemspec
 - lib/hangouts_json_parser.rb
+- lib/hangouts_json_parser/attachment.rb
+- lib/hangouts_json_parser/attachment/location.rb
+- lib/hangouts_json_parser/attachment/photo.rb
 - lib/hangouts_json_parser/conversation.rb
+- lib/hangouts_json_parser/message.rb
 - lib/hangouts_json_parser/user.rb
 - lib/hangouts_json_parser/version.rb
 homepage: https://github.com/nubisonline/hangouts_json_parser