twicas_stream 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 431b96ece0e9f78b23280df634aad1f2adba3767
-  data.tar.gz: 85b5faf76044f7916c3c028b8a2e211732e64d5e
+  metadata.gz: 5662ec6c489c009b1b71b2a9e860000b5ca92b89
+  data.tar.gz: 0ce1a545d0105013d63da36b6e9518f7ded718bc
 SHA512:
-  metadata.gz: 48b1da24ef9b1103c87750731f0277b74e4a8ac5a3dcf6dd8299ba16212e82ab4a0425724b6998757bfbee07b185ae13e414a05d71333ea034a09312e056a5b0
-  data.tar.gz: 70da8a7811004f5e303ee0c4c8bc4483510a8a78d60dcbdc2ebb778c722466f4c656bf8ab11699120226d23cfef3f22cb7ad32373d2120f07c06861059d7459d
+  metadata.gz: 2dc78eafac69d2224ff7f45066b7f2d9e90a222b0b8d814aac5468c9112b832536eee73f0541a007f39bc7cb905b89a3c98c73d243a9fc636f80c4ec520c7b4e
+  data.tar.gz: 6db259451b0978e2015cdadbe0a00b36fe21947139b8b2967ed507667cd805015fc58a7e3173298926978a54dc00de4f62b47663119662578ae2af02ddc37500

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## v1.2.0
+[full changelog](http://github.com/ysato5654/twicas_stream/compare/v1.1.1...v1.2.0)
+
+* change request interface
+	* Get Comments
+		- define the minimum value of slice_id
+* change response data
+	* Get User Info
+		- add supporter_count and supporting_count
+* the following value of User object are deprecated, and all are always '0'
+	- created
+	- supporter_count
+	- supporting_count
+
 ## v1.1.1
 [full changelog](http://github.com/ysato5654/twicas_stream/compare/v1.1.0...v1.1.1)
 

data/README.md

@@ -4,7 +4,7 @@
 
 # twicas_stream
 
-[twicas_stream](https://rubygems.org/gems/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/) APIv2(β).
 
 ## Installation
 
@@ -119,6 +119,76 @@ Current version supports following requests.
 
 (*) 'POST/DELETE/PUT' HTTP method. Current version supports 'GET' method only.
 
+## Response Data Structure
+
+Response data of 'Get User Info' is as below.
+
+```rb
+{
+	:supporter_count => 10,
+	:supporting_count => 24,
+	:user => {
+		:id => "182224938",
+		:screen_id => "twitcasting_jp",
+		:name => "ツイキャス公式",
+		:image => "http://202-234-44-53.moi.st/image3s/pbs.twimg.com/profile_images/613625726512705536/GLlBoXcS_normal.png",
+		:profile => "ツイキャスの公式アカウントです。ツイキャスに関するお知らせなどを投稿します。なお、お問い合わせは https://t.co/4gCf7XVm7N までお願いします。公式Facebookページhttps://t.co/bxYVwpzTJB\n公式Instagram\nhttps://t.co/Bm2O2J2Kfs",
+		:level => 24,
+		:last_movie_id => "189037369",
+		:is_live => false,
+		:supporter_count => 0,
+		:supporting_count => 0,
+		:created => 0
+	}
+}
+```
+
+'Get Movie Info' is as below.
+
+```rb
+{
+	:movie => {
+		:id => "189037369",
+		:user_id => "182224938",
+		:title => "ライブ #189037369",
+		:subtitle =>  "ライブ配信中！",
+		:last_owner_comment =>  "もいもい",
+		:category =>  "girls_jcjk_jp",
+		:link => "http://twitcasting.tv/twitcasting_jp/movie/189037369",
+		:is_live => false,
+		:is_recorded => false,
+		:comment_count => 2124,
+		:large_thumbnail => "http://202-230-12-92.twitcasting.tv/image3/image.twitcasting.tv/image55_1/39/7b/0b447b39-1.jpg",
+		:small_thumbnail => "http://202-230-12-92.twitcasting.tv/image3/image.twitcasting.tv/image55_1/39/7b/0b447b39-1-s.jpg",
+		:country => "jp",
+		:duration => 1186,
+		:created => 1438500282,
+		:is_collabo => false,
+		:is_protected => false,
+		:max_view_count => 1675,
+		:current_view_count => 20848,
+		:total_view_count => 20848,
+		:hls_url => "http://twitcasting.tv/twitcasting_jp/metastream.m3u8/?video=1"
+	},
+	:broadcaster => {
+		:id => "182224938",
+		:screen_id => "twitcasting_jp",
+		:name => "ツイキャス公式",
+		:image => "http://202-234-44-53.moi.st/image3s/pbs.twimg.com/profile_images/613625726512705536/GLlBoXcS_normal.png",
+		:profile => "ツイキャスの公式アカウントです。ツイキャスに関するお知らせなどを投稿します。なお、お問い合わせは https://t.co/4gCf7XVm7N までお願いします。公式Facebookページ:ttps://t.co/bxYVwpzTJB\n公式Instagram\nhttps://t.co/Bm2O2J2Kfs",
+		:level => 24,
+		:last_movie_id => "189037369",
+		:is_live => true,
+		:supporter_count => 0,
+		:supporting_count => 0,
+		:created => 0
+	},
+	:tags => ["人気", "コンティニュー中", "レベル40+", "初見さん大歓迎", "まったり", "雑談"]
+}
+```
+
+For others response data structure, please refer to [API Documentation (APIv2)](http://apiv2-doc.twitcasting.tv/).
+
 ---
 
 ## Development
@@ -246,6 +316,7 @@ end
 
 ```
 /										  
+├─	/bin								  
 ├─	/config								  
 │	└─	access_token.txt				  
 ├─	/examples							  
@@ -276,6 +347,7 @@ end
 │	│	├─	user.rb						  
 │	│	└─	version.rb					  
 │	└─	twicas_stream.rb				  
+├─	/pkg								  
 ├─	/spec								  
 │	├─	/twicas_stream					  
 │	│	├─	category_spec.rb			  

data/lib/twicas_stream/comment.rb

@@ -23,9 +23,9 @@ module TwicasStream
 						   # 										:level => 24,
 						   # 										:last_movie_id => "189037369",
 						   # 										:is_live => false,
-						   # 										:supporter_count =>  10,
-						   # 										:supporting_count =>  24,
-						   # 										:created => 1282620640
+						   # 										:supporter_count => 0,
+						   # 										:supporting_count => 0,
+						   # 										:created => 0
 						   # 									},
 						   # 						:created => 1479579471
 						   # 					},
@@ -48,6 +48,8 @@ module TwicasStream
 
 			DEFAULT_SLICE_ID = 'none'
 
+			LOWER_SLICE_ID = 1
+
 			def initialize movie_id, offset = DEFAULT_OFFSET, limit = DEFAULT_LIMIT, slice_id = DEFAULT_SLICE_ID
 				@response = Hash.new
 				param = Hash.new
@@ -56,6 +58,16 @@ module TwicasStream
 					STDERR.puts "#{__FILE__}:#{__LINE__}:Warning: out of limitation. limitation range is #{LOWER_LIMIT} ~ #{UPPER_LIMIT}."
 				end
 
+				if slice_id.kind_of?(Integer)
+					if slice_id < LOWER_SLICE_ID
+						STDERR.puts "#{__FILE__}:#{__LINE__}:Warning: out of limitation. slice id (comment id) should be over than #{LOWER_SLICE_ID}."
+					end
+				else
+					unless slice_id == DEFAULT_SLICE_ID
+						STDERR.puts "#{__FILE__}:#{__LINE__}:Error: invalid parameter. default is '#{DEFAULT_SLICE_ID}'."
+					end
+				end
+
 				param['offset'] = offset
 				param['limit'] = limit
 				param['slice_id'] = slice_id unless slice_id == DEFAULT_SLICE_ID

data/lib/twicas_stream/movie.rb

@@ -41,9 +41,9 @@ module TwicasStream
 						   # 						:level => 24,
 						   # 						:last_movie_id => "189037369",
 						   # 						:is_live => true,
-						   # 						:supporter_count =>  10,
-						   # 						:supporting_count =>  24,
-						   # 						:created => 1282620640
+						   # 						:supporter_count => 0,
+						   # 						:supporting_count => 0,
+						   # 						:created => 0
 						   # 					},
 						   # 	:tags => ["人気", "コンティニュー中", "レベル40+", "初見さん大歓迎", "まったり", "雑談"]
 						   # }

data/lib/twicas_stream/search.rb

@@ -19,9 +19,9 @@ module TwicasStream
 						   # 					:level => 24,
 						   # 					:last_movie_id => "189037369",
 						   # 					:is_live => true,
-						   # 					:supporter_count =>  10,
-						   # 					:supporting_count =>  24,
-						   # 					:created => 1282620640
+						   # 					:supporter_count => 0,
+						   # 					:supporting_count => 0,
+						   # 					:created => 0
 						   # 				},
 						   # 				{
 						   # 					:id => "2880417757",
@@ -32,9 +32,9 @@ module TwicasStream
 						   # 					:level => 24,
 						   # 					:last_movie_id => "323387579",
 						   # 					:is_live => false,
-						   # 					:supporter_count =>  10,
-						   # 					:supporting_count =>  24,
-						   # 					:created => 1414474646
+						   # 					:supporter_count => 0,
+						   # 					:supporting_count => 0,
+						   # 					:created => 0
 						   # 				},
 						   # 				:
 						   # 				:

data/lib/twicas_stream/twicas_api_object/user.rb

@@ -16,9 +16,9 @@ module TwicasStream
 							: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']
+							:supporter_count  => elements['supporter_count'], # deprecated (2018/09/03's change log)
+							:supporting_count => elements['supporting_count'], # deprecated (2018/09/03's change log)
+							:created          => elements['created'] # deprecated (2018/08/03's change log)
 						}
 			end
 		end

data/lib/twicas_stream/user.rb

@@ -8,6 +8,23 @@ module TwicasStream
 	module User
 		class GetUserInfo
 			attr_reader :response
+						   # {
+						   # 	:supporter_count => 10,
+						   # 	:supporting_count => 24,
+						   # 	:user => {
+						   # 				:id => "182224938",
+						   # 				:screen_id => "twitcasting_jp",
+						   # 				:name => "ツイキャス公式",
+						   # 				:image => "http://202-234-44-53.moi.st/image3s/pbs.twimg.com/profile_images/613625726512705536/GLlBoXcS_normal.png",
+						   # 				:profile => "ツイキャスの公式アカウントです。ツイキャスに関するお知らせなどを投稿します。なお、お問い合わせは https://t.co/4gCf7XVm7N までお願いします。公式Facebookページ:ttps://t.co/bxYVwpzTJB\n公式Instagram\nhttps://t.co/Bm2O2J2Kfs",
+						   # 				:level => 24,
+						   # 				:last_movie_id => "466324920",
+						   # 				:is_live => false,
+						   # 				:supporter_count => 0,
+						   # 				:supporting_count => 0,
+						   # 				:created => 0
+						   # 			}
+						   # }
 
 			PREFIX_URL = 'users'
 
@@ -23,6 +40,28 @@ module TwicasStream
 
 		class VerifyCredentials
 			attr_reader :response
+						   # {
+						   # 	:app => {
+						   # 				:client_id => "182224938.d37f58350925d568e2db24719fe86f11c4d14e0461429e8b5da732fcb1917b6e",
+						   # 				:name => "サンプルアプリケーション",
+						   # 				:owner_user_id => "182224938"
+						   # 		},
+						   # 	:supporter_count => 10,
+						   # 	:supporting_count => 24,
+						   # 	:user => {
+						   # 				:id => "182224938",
+						   # 				:screen_id => "twitcasting_jp",
+						   # 				:name => "ツイキャス公式",
+						   # 				:image => "http://202-234-44-53.moi.st/image3s/pbs.twimg.com/profile_images/613625726512705536/GLlBoXcS_normal.png",
+						   # 				:profile => "ツイキャスの公式アカウントです。ツイキャスに関するお知らせなどを投稿します。なお、お問い合わせは https://t.co/4gCf7XVm7N までお願いします。公式Facebookページ:ttps://t.co/bxYVwpzTJB\n公式Instagram\nhttps://t.co/Bm2O2J2Kfs",
+						   # 				:level => 24,
+						   # 				:last_movie_id => "466324920",
+						   # 				:is_live => false,
+						   # 				:supporter_count => 0,
+						   # 				:supporting_count => 0,
+						   # 				:created => 0
+						   # 			}
+						   # }
 
 			PREFIX_URL = 'verify_credentials'
 

data/lib/twicas_stream/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twicas_stream
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Yuya Sato
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-06 00:00:00.000000000 Z
+date: 2018-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport