twicas_stream 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d657ce62377fdadac0733f9e3419092332e3484f
-  data.tar.gz: 64e75337098cd48153c11576abbb3f664c88f767
+  metadata.gz: 190ddd6a8dba8840e8105796fdaac070e0948193
+  data.tar.gz: d6d19ed51e0bdc9025708ed56a14afdd93b267f6
 SHA512:
-  metadata.gz: 4b46a27061c258843864d9b1fdb03db741892f121f5da735a582f9ba33235b22cdd07e1fb3a2bec28c611d229f2afdcc37fd7f7b8d862b302f32b947bd693fcf
-  data.tar.gz: '0299009ee34a060b34f3dc51ded4e8266db96278f1499ef9519e91d8014e20c350624f322be71722ff95807c0c150f801942f3c551ca7221ff463e0896f8901b'
+  metadata.gz: a4b2c4fb6bde367d127fd335998e7111546b66d0f2e61d04908425e127abf853e95b541ffb38a7c449d74543b681d0aa176566d4add79f6053b3ae2d2934f338
+  data.tar.gz: 93e562700f7e02d92dffab2da8cd1e6dd96c6942432c6235480c2137bfc794c2cfc7716dd59c0c35c0544f6d34962d6dbf873505a50b4f03cc15f30bbe486f4c

data/README.md

@@ -1,6 +1,6 @@
 # twicas_stream
 
-twicas_stream provides simple Ruby access to [TwitCasting](https://twitcasting.tv/) API.
+[twicas_stream](https://rubygems.org/gems/twicas_stream) provides simple Ruby access to [TwitCasting](https://twitcasting.tv/) API.
 
 ## Installation
 
@@ -97,18 +97,18 @@ Current version supports following requests.
 |:---------------|:-------------------------|:------------:|
 | User           | Get User Info            | Support |
 |                | Verify Credentials       | Support |
-| Live Thumbnail | Get Live Thumbnail Image | Not Support |
+| Live Thumbnail | Get Live Thumbnail Image | Support |
 | Movie          | Get Movie Info           | Support |
 |                | Get Movies by User       | Not Support |
 |                | Get Current Live         | Not Support |
 | Comment        | Get Comments             | Support |
 |                | Post Comment             | Not Support |
 |                | Delete Comment           | Not Support |
-| Supporter      | Get Supporting Status    | Not Support |
+| Supporter      | Get Supporting Status    | Support |
 |                | Support User             | Not Support |
 |                | Unsupport User           | Not Support |
-|                | Supporting List          | Not Support |
-|                | Supporter List           | Not Support |
+|                | Supporting List          | Support |
+|                | Supporter List           | Support |
 | Category       | Get Categories           | Support |
 | Search         | Search Users             | Support |
 |                | Search Live Movies       | Support |
@@ -280,17 +280,3 @@ end
 └─	README.md							  
 ```
 
-### Test
-
-#### execution of all test
-
-```rb
-ruby Test.rb
-```
-
-#### execution of each test
-
-```rb
-ruby TestUser.rb
-```
-

data/examples/get_live_thumbnail_image.rb

@@ -0,0 +1,16 @@
+#! /opt/local/bin/ruby
+# coding: utf-8
+
+if $0 == __FILE__
+	require File.expand_path(File.dirname(__FILE__) + '/../lib/twicas_stream')
+
+	path = File.expand_path(File.dirname(__FILE__)) + '/'
+	user_id = 'twitcasting_jp'
+	api = TwicasStream::LiveThumbnail::GetLiveThumbnailImage.new(path, user_id)
+
+	exit(0) if api.filepath.empty?
+
+	STDOUT.puts 'saved image is here.'
+	STDOUT.puts api.filepath
+
+end

data/lib/twicas_stream/category.rb

@@ -44,7 +44,7 @@ module TwicasStream
 
 				param['lang'] = lang
 
-				url = BASE_URL + '/' + PREFIX_URL + TwicasStream.make_query_string(param)
+				url = [BASE_URL, PREFIX_URL].join('/') + TwicasStream.make_query_string(param)
 				# => 'https://apiv2.twitcasting.tv/categories?lang=ja'
 
 				@response = TwicasStream.parse(TwicasStream.get(url))

data/lib/twicas_stream/comment.rb

@@ -60,7 +60,7 @@ module TwicasStream
 				param['limit'] = limit
 				param['slice_id'] = slice_id unless slice_id == DEFAULT_SLICE_ID
 
-				url = BASE_URL + '/' + PREFIX_URL + '/' + movie_id + '/' + SUFFIX_URL + TwicasStream.make_query_string(param)
+				url = [BASE_URL, PREFIX_URL, movie_id, SUFFIX_URL].join('/') + TwicasStream.make_query_string(param)
 				# => 'https://apiv2.twitcasting.tv/movies/:movie_id/comments?offset=0&limit=10'
 
 				@response = TwicasStream.parse(TwicasStream.get(url))

data/lib/twicas_stream/live_thumbnail.rb

@@ -4,6 +4,52 @@
 module TwicasStream
 	module LiveThumbnail
 		class GetLiveThumbnailImage
+			attr_reader :filepath
+
+			PREFIX_URL = 'users'
+
+			INFIX_URL = 'live'
+
+			SUFFIX_URL = 'thumbnail'
+
+			DEFAULT_SIZE = 'small'
+
+			SIZE_LIMITATION = ['large', 'small']
+
+			DEFAULT_POSITION = 'latest'
+
+			POSITION_LIMITATION = ['beginning', 'latest']
+
+			def initialize path, user_id, size = DEFAULT_SIZE, position = DEFAULT_POSITION
+				@filepath = ''
+				param = Hash.new
+
+				unless File.exists?(path)
+					STDERR.puts "#{__FILE__}:#{__LINE__}:Error: no such file or directory - #{path}"
+					return
+				end
+
+				unless File::ftype(path) == 'directory'
+					STDERR.puts "#{__FILE__}:#{__LINE__}:Error: not directory - #{path}"
+					return
+				end
+
+				unless SIZE_LIMITATION.include?(size)
+					STDERR.puts "#{__FILE__}:#{__LINE__}:Warning: out of limitation. support size are '#{SIZE_LIMITATION.join("' or '")}'."
+				end
+
+				unless POSITION_LIMITATION.include?(position)
+					STDERR.puts "#{__FILE__}:#{__LINE__}:Warning: out of limitation. support position are '#{POSITION_LIMITATION.join("' or '")}'."
+				end
+
+				param['size'] = size
+				param['position'] = position
+
+				url = [BASE_URL, PREFIX_URL, user_id, INFIX_URL, SUFFIX_URL].join('/') + TwicasStream.make_query_string(param)
+				# => 'https://apiv2.twitcasting.tv/users/twitcasting_jp/live/thumbnail?size=small&position=latest'
+
+				@filepath = TwicasStream.get_image(url, path)
+			end
 		end
 	end
 end

data/lib/twicas_stream/movie.rb

@@ -53,7 +53,7 @@ module TwicasStream
 			def initialize movie_id
 				@response = Hash.new
 
-				url = BASE_URL + '/' + PREFIX_URL + '/' + movie_id
+				url = [BASE_URL, PREFIX_URL, movie_id].join('/')
 				# => 'https://apiv2.twitcasting.tv/movies/:movie_id'
 
 				@response = TwicasStream.parse(TwicasStream.get(url))

data/lib/twicas_stream/search.rb

@@ -73,7 +73,7 @@ module TwicasStream
 				param['limit'] = limit
 				param['lang'] = lang
 
-				url = BASE_URL + '/' + PREFIX_URL + '/' + SUFFIX_URL + TwicasStream.make_query_string(param)
+				url = [BASE_URL, PREFIX_URL, SUFFIX_URL].join('/') + TwicasStream.make_query_string(param)
 				# => 'https://apiv2.twitcasting.tv/search/users?words=ツイキャス+公式&limit=10&lang=ja'
 
 				@response = TwicasStream.parse(TwicasStream.get(url))
@@ -168,7 +168,7 @@ module TwicasStream
 =end
 				param['lang'] = lang
 
-				url = BASE_URL + '/' + PREFIX_URL + '/' + SUFFIX_URL + TwicasStream.make_query_string(param)
+				url = [BASE_URL, PREFIX_URL, SUFFIX_URL].join('/') + TwicasStream.make_query_string(param)
 				# => 'https://apiv2.twitcasting.tv/search/lives?limit=10&type=recommend&lang=ja'
 
 				@response = TwicasStream.parse(TwicasStream.get(url))

data/lib/twicas_stream/supporter.rb

@@ -7,6 +7,23 @@ require File.expand_path(File.dirname(__FILE__) + '/twicas_api_object/supporter_
 module TwicasStream
 	module Supporter
 		class GetSupportingStatus
+			attr_reader :response
+
+			PREFIX_URL = 'users'
+
+			SUFFIX_URL = 'supporting_status'
+
+			def initialize user_id, target_user_id
+				@response = Hash.new
+				param = Hash.new
+
+				param['target_user_id'] = target_user_id
+
+				url = [BASE_URL, PREFIX_URL, user_id, SUFFIX_URL].join('/') + TwicasStream.make_query_string(param)
+				# => 'https://apiv2.twitcasting.tv/users/:user_id/supporting_status?target_user_id=casma_jp'
+
+				@response = TwicasStream.parse(TwicasStream.get(url))
+			end
 		end
 
 		class SupportUser
@@ -16,9 +33,88 @@ module TwicasStream
 		end
 
 		class SupportingList
+			attr_reader :response
+
+			PREFIX_URL = 'users'
+
+			SUFFIX_URL = 'supporting'
+
+			DEFAULT_OFFSET = 0
+
+			LOWER_OFFSET = 0
+
+			DEFAULT_LIMIT = 20
+
+			LOWER_LIMIT = 1
+
+			UPPER_LIMIT = 20
+
+			def initialize user_id, offset = DEFAULT_OFFSET, limit = DEFAULT_LIMIT
+				@response = Hash.new
+				param = Hash.new
+
+				if offset < LOWER_OFFSET
+					STDERR.puts "#{__FILE__}:#{__LINE__}:Warning: out of limitation. offset should be over than #{LOWER_OFFSET}."
+				end
+
+				unless limit >= LOWER_LIMIT and limit <= UPPER_LIMIT
+					STDERR.puts "#{__FILE__}:#{__LINE__}:Warning: out of limitation. limitation range is #{LOWER_LIMIT} ~ #{UPPER_LIMIT}."
+				end
+
+				param['offset'] = offset
+				param['limit'] = limit
+
+				url = [BASE_URL, PREFIX_URL, user_id, SUFFIX_URL].join('/') + TwicasStream.make_query_string(param)
+				# => 'https://apiv2.twitcasting.tv/users/twitcasting_jp/supporting?offset=10&limit=20'
+
+				@response = TwicasStream.parse(TwicasStream.get(url))
+			end
 		end
 
 		class SupporterList
+			attr_reader :response
+
+			PREFIX_URL = 'users'
+
+			SUFFIX_URL = 'supporters'
+
+			DEFAULT_OFFSET = 0
+
+			LOWER_OFFSET = 0
+
+			DEFAULT_LIMIT = 20
+
+			LOWER_LIMIT = 1
+
+			UPPER_LIMIT = 20
+
+			SORT_LIMITATION = ['new', 'ranking']
+
+			def initialize user_id, offset = DEFAULT_OFFSET, limit = DEFAULT_LIMIT, sort
+				@response = Hash.new
+				param = Hash.new
+
+				if offset < LOWER_OFFSET
+					STDERR.puts "#{__FILE__}:#{__LINE__}:Warning: out of limitation. offset should be over than #{LOWER_OFFSET}."
+				end
+
+				unless limit >= LOWER_LIMIT and limit <= UPPER_LIMIT
+					STDERR.puts "#{__FILE__}:#{__LINE__}:Warning: out of limitation. limitation range is #{LOWER_LIMIT} ~ #{UPPER_LIMIT}."
+				end
+
+				unless SORT_LIMITATION.include?(sort)
+					STDERR.puts "#{__FILE__}:#{__LINE__}:Warning: out of limitation. sort is '#{SORT_LIMITATION.join("' or '")}'."
+				end
+
+				param['offset'] = offset
+				param['limit'] = limit
+				param['sort'] = sort
+
+				url = [BASE_URL, PREFIX_URL, user_id, SUFFIX_URL].join('/') + TwicasStream.make_query_string(param)
+				# => 'https://apiv2.twitcasting.tv/users/twitcasting_jp/supporting?offset=10&limit=20'
+
+				@response = TwicasStream.parse(TwicasStream.get(url))
+			end
 		end
 	end
 end

data/lib/twicas_stream/twicas_api_object/supporter_user.rb

@@ -4,6 +4,25 @@
 module TwicasStream
 	module TwicasApiObject
 		class SupporterUser
+			attr_reader :object
+
+			def initialize elements = {}
+				@object = {
+							:id               => elements['id'],
+							:screen_id        => elements['screen_id'],
+							:name             => elements['name'],
+							:image            => elements['image'],
+							:profile          => elements['profile'],
+							:level            => elements['level'],
+							:last_movie_id    => elements['last_movie_id'],
+							:is_live          => elements['is_live'],
+							:supporter_count  => elements['supporter_count'],
+							:supporting_count => elements['supporting_count'],
+							:created          => elements['created'], 
+							:point            => elements['point'],
+							:total_point      => elements['total_point']
+						}
+			end
 		end
 	end
 end

data/lib/twicas_stream/user.rb

@@ -14,7 +14,7 @@ module TwicasStream
 			def initialize user_id
 				@response = Hash.new
 
-				url = BASE_URL + '/' + PREFIX_URL + '/' + user_id
+				url = [BASE_URL, PREFIX_URL, user_id].join('/')
 				# => 'https://apiv2.twitcasting.tv/users/:user_id'
 
 				@response = TwicasStream.parse(TwicasStream.get(url))
@@ -29,7 +29,7 @@ module TwicasStream
 			def initialize
 				@response = Hash.new
 
-				url = BASE_URL + '/' + PREFIX_URL
+				url = [BASE_URL, PREFIX_URL].join('/')
 				# => 'https://apiv2.twitcasting.tv/verify_credentials'
 
 				@response = TwicasStream.parse(TwicasStream.get(url))

data/lib/twicas_stream/version.rb

@@ -2,5 +2,5 @@
 # coding: utf-8
 
 module TwicasStream
-	VERSION = '1.0.0'
+	VERSION = '1.1.0'
 end

data/lib/twicas_stream.rb

@@ -17,6 +17,7 @@ require File.expand_path(File.dirname(__FILE__) + '/twicas_stream/twicas_api_obj
 require 'active_support/inflector'
 require 'curb'
 require 'json'
+require 'open-uri'
 
 module TwicasStream
 	extend RequestHeader
@@ -25,10 +26,11 @@ module TwicasStream
 
 	class << self
 		def parse result
-			hash = Hash.new
+			response = Hash.new
 
-			response = response(result)
+			response_code = response_code(result)
 			body = body(result)
+			header = header(result)
 
 			body.each{ |key, value|
 				# here is the plural form of TwicasStream
@@ -45,31 +47,39 @@ module TwicasStream
 							array.push tmp
 						}
 
-						hash[key.to_sym] = array
+						response[key.to_sym] = array
 
 					else
-						hash[key.to_sym] = value.map{ |e| parse_deep(key, e) }
+						response[key.to_sym] = value.map{ |i| parse_deep(key, i) }
 
 					end
+				# following keys is actually TwicasApiObject as 'SupporterUser', but is_TwicasApiObject?(key) = false
+				# so, we prepare special support as below
+				elsif key == 'supporting' or key == 'supporters'
+					response[key.to_sym] = value.map{ |i| parse_deep('SupporterUser', i) }
 
 				# here is a singular form of TwicasApiObject, also others are here
 				else
-					hash[key.to_sym] = parse_deep(key, value)
+					response[key.to_sym] = parse_deep(key, value)
 
 				end
 			}
 
-			hash
+			response
 		end
 
-		def response result
-			result[:response]
+		def response_code result
+			result[:response_code]
 		end
 
 		def body result
 			result[:body]
 		end
 
+		def header result
+			result[:header]
+		end
+
 		def get url
 			c = Curl.get(url) do |curl|
 				TwicasStream.configure do |request_header|
@@ -79,7 +89,19 @@ module TwicasStream
 				end
 			end
 
-			{ :body => JSON.parse(c.body_str), :response => c.response_code }
+			response, *headers = c.header_str.split(/[\r\n]+/).map(&:strip)
+			headers = Hash[headers.flat_map{ |s| s.scan(/^(\S+): (.+)/) }]
+
+			{ :header => headers, :body => JSON.parse(c.body_str), :response_code => c.response_code }
+		end
+
+		def get_image url, path
+			c = Curl.get(url)
+
+			response, *headers = c.header_str.split(/[\r\n]+/).map(&:strip)
+			headers = Hash[headers.flat_map{ |s| s.scan(/^(\S+): (.+)/) }]
+
+			save_image(path, headers['Location'])
 		end
 
 		def make_query_string options
@@ -94,13 +116,13 @@ module TwicasStream
 		private
 		def parse_deep key, value
 			if is_TwicasApiObject?(key)
-				str = [self.to_s, 'TwicasApiObject', key.singularize.capitalize].join('::')
+				str = [self.to_s, 'TwicasApiObject', key.singularize.camelize].join('::')
 				api = Object.const_get(str).new(value)
 
 				return api.object
 
-			# called by 'GetMovieInfo' method
-			elsif key == 'broadcaster'
+			# called by 'GetMovieInfo' or 'GetSupportingStatus' method
+			elsif key == 'broadcaster' or key == 'target_user'
 				str = [self.to_s, 'TwicasApiObject', 'User'].join('::')
 				api = Object.const_get(str).new(value)
 
@@ -114,9 +136,27 @@ module TwicasStream
 
 		private
 		def is_TwicasApiObject? str
-			TwicasApiObject.constants.include?(str.singularize.capitalize.to_sym)
+			TwicasApiObject.constants.include?(str.singularize.camelize.to_sym)
 			# TwicasApiObject.constants
 			# => [:App, :User, :Movie, :Comment, :SupporterUser, :SubCategory, :Category, :Error]
 		end
+
+		private
+		def save_image path, image_url
+			begin
+				filepath = path + File.basename(image_url)
+			rescue Exception => e
+				STDERR.puts "#{__FILE__}:#{__LINE__}:Error: #{e.message}"
+				filepath = ''
+			else
+				File.open(filepath, 'wb') do |file|
+					open(image_url) do |data|
+						file.write(data.read)
+					end
+				end
+			end
+
+			filepath
+		end
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twicas_stream
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Yuya Sato
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-23 00:00:00.000000000 Z
+date: 2018-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -112,6 +112,7 @@ files:
 - bin/setup
 - examples/get_categories.rb
 - examples/get_comments.rb
+- examples/get_live_thumbnail_image.rb
 - examples/get_movie_info.rb
 - examples/get_user_info.rb
 - examples/search_live_movies.rb