twicas_stream 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d657ce62377fdadac0733f9e3419092332e3484f
+  data.tar.gz: 64e75337098cd48153c11576abbb3f664c88f767
+SHA512:
+  metadata.gz: 4b46a27061c258843864d9b1fdb03db741892f121f5da735a582f9ba33235b22cdd07e1fb3a2bec28c611d229f2afdcc37fd7f7b8d862b302f32b947bd693fcf
+  data.tar.gz: '0299009ee34a060b34f3dc51ded4e8266db96278f1499ef9519e91d8014e20c350624f322be71722ff95807c0c150f801942f3c551ca7221ff463e0896f8901b'

data/.gitignore

@@ -0,0 +1,5 @@
+# It must be ignored
+config/access_token.txt
+pkg
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.8
+before_install: gem install bundler -v 1.15.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in twicas_stream.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Yuya Sato
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,296 @@
+# twicas_stream
+
+twicas_stream provides simple Ruby access to [TwitCasting](https://twitcasting.tv/) API.
+
+## Installation
+
+```rb
+gem install twicas_stream
+```
+
+## Documentation / Help
+
+- [Developer API](https://twitcasting.tv/indexapi.php)
+- [API Documentation (APIv2)](http://apiv2-doc.twitcasting.tv/)
+
+## Preparation before using
+
+Before using twicas_stream, we need to get access token in order to access TwitCasting API (APIv2).
+Flow is as below.
+
+1. Registration  
+Create new application, getting access token need 'ClientID' and 'ClientSecret'.
+2. Get Access Token  
+TwitCasting API (APIv2) provides two types of authorization flow.
+For more information, please refer to API Documentation (APIv2).
+
+## Usage
+
+### Get Movie Info
+
+Get comments of movie id which you set
+
+```rb
+# (*) following data are just example
+
+TwicasStream.configure do |request_header|
+	#request_header.api_version
+	# => default is '2.0'
+	#request_header.accept_encoding
+	# => default is 'application/json'
+	# Above value don't need to change, default setting must be enough.
+
+	request_header.access_token = 'xxx'
+	# => you must set access token before using.
+end
+
+movie_id = '189037369'
+api = TwicasStream::Movie::GetMovieInfo.new(movie_id)
+movie_info = api.response[:movie]
+
+p movie_info[:title]
+# => 'ライブ #189037369'
+p movie_info[:subtitle]
+# => 'ライブ配信中！'
+p movie_info[:current_view_count]
+# => 20848
+p movie_info[:total_view_count]
+# => 20848
+p api.response[:tags]
+# => ['人気', 'コンティニュー中', 'レベル40+', '初見さん大歓迎', 'まったり', '雑談']
+```
+
+### Get Comments
+
+Get comments of movie id which you set
+
+```rb
+# (*) following data are just example
+
+TwicasStream.configure do |request_header|
+	request_header.access_token = 'xxx'
+end
+
+movie_id = '189037369'
+api = TwicasStream::Comment::GetComments.new(movie_id)
+comments = api.response[:comments]
+
+p comments.first[:from_user][:name]
+# => 'ツイキャス公式'
+p comments.first[:from_user][:screen_id]
+# => 'twitcasting_jp'
+p comments.first[:message]
+# => 'モイ！'
+p comments.first[:created]
+# => 1479579471
+# (**) unix timestamp
+```
+
+For more usage, please refer to 'examples' directory.
+There are some example source code in there, and help you to understand more.
+
+## Support Request List
+
+Current version supports following requests.
+
+| Classification | Request                  | Support |
+|:---------------|:-------------------------|:------------:|
+| User           | Get User Info            | Support |
+|                | Verify Credentials       | Support |
+| Live Thumbnail | Get Live Thumbnail Image | Not 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 |
+|                | Support User             | Not Support |
+|                | Unsupport User           | Not Support |
+|                | Supporting List          | Not Support |
+|                | Supporter List           | Not Support |
+| Category       | Get Categories           | Support |
+| Search         | Search Users             | Support |
+|                | Search Live Movies       | Support |
+
+---
+
+## Appendix
+
+Here is for developer of twicas_stream
+
+### Preparation before developing
+
+Before develop twicas_stream, we need to prepare as below.
+Because example srouce code and test code need access
+
+1. Create '/config' directory
+2. Create 'access_token.txt' in there
+3. Write your access token in that file
+
+### twicas_stream
+
+```rb
+module TwicasStream
+	module TwicasApiObject
+		class App
+		end
+
+		class User
+		end
+
+		class Movie
+		end
+
+		class Comment
+		end
+
+		class SupporterUser
+		end
+
+		class Category
+		end
+
+		class SubCategory
+		end
+	end
+
+	module User
+		class GetUserInfo
+		end
+
+		class VerifyCredentials
+		end
+	end
+
+	module LiveThumbnail
+		class GetLiveThumbnailImage
+		end
+	end
+
+	module Movie
+		class GetMovieInfo
+		end
+
+		class GetMoviesbyUser
+		end
+
+		class GetCurrentLive
+		end
+	end
+
+	module Comment
+		class GetComments
+		end
+
+		class PostComment
+		end
+
+		class DeleteComment
+		end
+	end
+
+	module Supporter
+		class GetSupportingStatus
+		end
+
+		class SupportUser
+		end
+
+		class UnsupportUser
+		end
+
+		class SupportingList
+		end
+
+		class SupporterList
+		end
+	end
+
+	module Category
+		class GetCategories
+		end
+	end
+
+	module Search
+		class SearchUsers
+		end
+
+		class SearchLiveMovies
+		end
+	end
+end
+```
+
+### Twicas API Object
+
+- App
+- User
+- Movie
+- Comment
+- SupporterUser
+- Category
+- SubCategory
+- Error
+
+### Directory Structure
+
+```
+/										  
+├─	/config								  
+│	└─	access_token.txt				  
+├─	/examples							  
+│	├─	get_categories.rb				  
+│	├─	get_comments.rb					  
+│	├─	get_movie_info.rb				  
+│	├─	get_user_info.rb				  
+│	├─	search_live_movies.rb			  
+│	├─	search_users.rb					  
+│	└─	verify_credentials.rb			  
+├─	/lib								  
+│	├─	/twicas_stream					  
+│	│	├─	/twicas_api_object			  
+│	│	│	├─	app.rb					  
+│	│	│	├─	user.rb					  
+│	│	│	├─	movie.rb				  
+│	│	│	├─	comment.rb				  
+│	│	│	├─	supporter_user.rb		  
+│	│	│	├─	category.rb				  
+│	│	│	└─	sub_category.rb			  
+│	│	├─	category.rb					  
+│	│	├─	comment.rb					  
+│	│	├─	live_thumbnail.rb			  
+│	│	├─	movie.rb					  
+│	│	├─	request_header.rb			  
+│	│	├─	search.rb					  
+│	│	├─	support.rb					  
+│	│	├─	user.rb						  
+│	│	└─	version.rb					  
+│	└─	twicas_stream.rb				  
+├─	/spec								  
+│	├─	/twicas_stream					  
+│	│	├─	category_spec.rb			  
+│	│	├─	comment_spec.rb				  
+│	│	├─	movie_spec.rb				  
+│	│	├─	search_spec.rb				  
+│	│	└─	user_spec.rb				  
+│	└─	spec_helper.rb					  
+│	└─	twicas_stream_spec.rb			  
+├─	LICENSE								  
+└─	README.md							  
+```
+
+### Test
+
+#### execution of all test
+
+```rb
+ruby Test.rb
+```
+
+#### execution of each test
+
+```rb
+ruby TestUser.rb
+```
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "twicas_stream"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/get_categories.rb

@@ -0,0 +1,38 @@
+#! /opt/local/bin/ruby
+# coding: utf-8
+
+if $0 == __FILE__
+	require File.expand_path(File.dirname(__FILE__) + '/../lib/twicas_stream')
+
+	TwicasStream.configure do |request_header|
+		#request_header.access_token = File.read(File.expand_path(File.dirname(__FILE__) + '/../config/access_token.txt'))
+		# => for developer
+
+		request_header.access_token = 'xxx'# put your access token here
+	end
+
+	lang = 'ja'
+	api = TwicasStream::Category::GetCategories.new(lang)
+	categories = api.response[:categories]
+
+	exit(0) unless api.response[:error].nil?
+
+	STDOUT.puts
+
+	STDOUT.puts '--------------------------------'
+	STDOUT.puts 'category name'
+	STDOUT.puts
+	STDOUT.puts '    sub category name'
+	STDOUT.puts '--------------------------------'
+	categories.each{ |category|
+		STDOUT.puts category[:name]
+		STDOUT.puts
+		category[:sub_categories].each{ |sub_category|
+			STDOUT.puts '    ' + sub_category[:name]
+		}
+		STDOUT.puts '--------------------------------'
+	}
+
+	STDOUT.puts
+
+end

data/examples/get_comments.rb

@@ -0,0 +1,41 @@
+#! /opt/local/bin/ruby
+# coding: utf-8
+
+if $0 == __FILE__
+	require File.expand_path(File.dirname(__FILE__) + '/../lib/twicas_stream')
+
+	TwicasStream.configure do |request_header|
+		#request_header.access_token = File.read(File.expand_path(File.dirname(__FILE__) + '/../config/access_token.txt'))
+		# => for developer
+
+		request_header.access_token = 'xxx'# put your access token here
+	end
+
+	movie_id = '189037369'
+	api = TwicasStream::Comment::GetComments.new(movie_id)
+	comments = api.response[:comments]
+
+	exit(0) unless api.response[:error].nil?
+
+	STDOUT.puts
+
+	STDOUT.puts 'Movie ID is ' + api.response[:movie_id]
+	STDOUT.puts
+
+	STDOUT.puts '--------------------------------'
+	STDOUT.puts 'name' + ' ' + '(' + '@' + 'screen_id' + ')'
+	STDOUT.puts
+	STDOUT.puts 'message'
+	STDOUT.puts 'created time'
+	STDOUT.puts '--------------------------------'
+	comments.each{ |comment|
+		STDOUT.puts comment[:from_user][:name] + ' ' + '(' + '@' + comment[:from_user][:screen_id] + ')'
+		STDOUT.puts
+		STDOUT.puts comment[:message]
+		STDOUT.puts Time.at(comment[:created])
+		STDOUT.puts '--------------------------------'
+	}
+
+	STDOUT.puts
+
+end

data/examples/get_movie_info.rb

@@ -0,0 +1,38 @@
+#! /opt/local/bin/ruby
+# coding: utf-8
+
+if $0 == __FILE__
+	require File.expand_path(File.dirname(__FILE__) + '/../lib/twicas_stream')
+
+	TwicasStream.configure do |request_header|
+		#request_header.access_token = File.read(File.expand_path(File.dirname(__FILE__) + '/../config/access_token.txt'))
+		# => for developer
+
+		request_header.access_token = 'xxx'# put your access token here
+	end
+
+	movie_id = '189037369'
+	api = TwicasStream::Movie::GetMovieInfo.new(movie_id)
+	movie_info = api.response[:movie]
+
+	exit(0) unless api.response[:error].nil?
+
+	STDOUT.puts
+
+	STDOUT.puts 'Movie ID is ' + movie_info[:id]
+	STDOUT.puts
+
+	STDOUT.puts '<Title>'
+	STDOUT.puts movie_info[:title] + ' ~ ' + movie_info[:subtitle]
+	STDOUT.puts
+
+	STDOUT.puts '<Tags>'
+	STDOUT.puts api.response[:tags]
+	STDOUT.puts
+
+	STDOUT.puts 'Current View Count = ' + movie_info[:current_view_count].to_s
+	STDOUT.puts 'Total View Count = ' + movie_info[:total_view_count].to_s
+
+	STDOUT.puts
+
+end

data/examples/get_user_info.rb

@@ -0,0 +1,34 @@
+#! /opt/local/bin/ruby
+# coding: utf-8
+
+if $0 == __FILE__
+	require File.expand_path(File.dirname(__FILE__) + '/../lib/twicas_stream')
+
+	TwicasStream.configure do |request_header|
+		#request_header.access_token = File.read(File.expand_path(File.dirname(__FILE__) + '/../config/access_token.txt'))
+		# => for developer
+
+		request_header.access_token = 'xxx'# put your access token here
+	end
+
+	user_id = 'twitcasting_jp'
+	api = TwicasStream::User::GetUserInfo.new(user_id)
+	user_info = api.response[:user]
+
+	exit(0) unless api.response[:error].nil?
+
+	STDOUT.puts
+
+	STDOUT.puts '<Name>'
+	STDOUT.puts user_info[:name]
+	STDOUT.puts
+
+	STDOUT.puts '<Screen ID>'
+	STDOUT.puts user_info[:screen_id]
+	STDOUT.puts
+
+	STDOUT.puts '<Profile>'
+	STDOUT.puts user_info[:profile]
+	STDOUT.puts
+
+end

data/examples/search_live_movies.rb

@@ -0,0 +1,44 @@
+#! /opt/local/bin/ruby
+# coding: utf-8
+
+if $0 == __FILE__
+	require File.expand_path(File.dirname(__FILE__) + '/../lib/twicas_stream')
+
+	TwicasStream.configure do |request_header|
+		#request_header.access_token = File.read(File.expand_path(File.dirname(__FILE__) + '/../config/access_token.txt'))
+		# => for developer
+
+		request_header.access_token = 'xxx'# put your access token here
+	end
+
+	limit = 2
+	type = 'recommend'
+	context = 'ツイキャス 公式'
+	lang = 'ja'
+	api = TwicasStream::Search::SearchLiveMovies.new(limit, type, context, lang)
+	movies = api.response[:movies]
+
+	exit(0) unless api.response[:error].nil?
+
+	STDOUT.puts '--------------------------------'
+	movies.each{ |movie|
+		STDOUT.puts 'Movie ID is ' + movie[:movie][:id]
+		STDOUT.puts
+
+		STDOUT.puts '<Title>'
+		STDOUT.puts movie[:movie][:title].to_s + ' ~ ' + movie[:movie][:subtitle].to_s
+		STDOUT.puts
+
+		STDOUT.puts '<Tags>'
+		STDOUT.puts movie[:tags]
+		STDOUT.puts
+
+		STDOUT.puts 'Current View Count = ' + movie[:movie][:current_view_count].to_s
+		STDOUT.puts 'Total View Count = ' + movie[:movie][:total_view_count].to_s
+
+		STDOUT.puts '--------------------------------'
+	}
+
+	STDOUT.puts
+
+end

data/examples/search_users.rb

@@ -0,0 +1,43 @@
+#! /opt/local/bin/ruby
+# coding: utf-8
+
+if $0 == __FILE__
+	require File.expand_path(File.dirname(__FILE__) + '/../lib/twicas_stream')
+
+	TwicasStream.configure do |request_header|
+		#request_header.access_token = File.read(File.expand_path(File.dirname(__FILE__) + '/../config/access_token.txt'))
+		# => for developer
+
+		request_header.access_token = 'xxx'# put your access token here
+	end
+
+	words = 'ツイキャス 公式'
+	limit = 3
+	lang = 'ja'
+	api = TwicasStream::Search::SearchUsers.new(words, limit, lang)
+	users = api.response[:users]
+
+	exit(0) unless api.response[:error].nil?
+
+	STDOUT.puts
+
+	STDOUT.puts '--------------------------------'
+	users.each{ |user|
+		STDOUT.puts '<Name>'
+		STDOUT.puts user[:name]
+		STDOUT.puts
+
+		STDOUT.puts '<Screen ID>'
+		STDOUT.puts user[:screen_id]
+		STDOUT.puts
+
+		STDOUT.puts '<Profile>'
+		STDOUT.puts user[:profile]
+		STDOUT.puts
+
+		STDOUT.puts '--------------------------------'
+	}
+
+	STDOUT.puts
+
+end

data/examples/verify_credentials.rb

@@ -0,0 +1,50 @@
+#! /opt/local/bin/ruby
+# coding: utf-8
+
+if $0 == __FILE__
+	require File.expand_path(File.dirname(__FILE__) + '/../lib/twicas_stream')
+
+	TwicasStream.configure do |request_header|
+		#request_header.access_token = File.read(File.expand_path(File.dirname(__FILE__) + '/../config/access_token.txt'))
+		# => for developer
+
+		request_header.access_token = 'xxx'# put your access token here
+	end
+
+	api = TwicasStream::User::VerifyCredentials.new
+	app = api.response[:app]
+	user = api.response[:user]
+
+	unless api.response[:error].nil?
+		STDOUT.puts
+
+		STDOUT.puts '<Error Code>'
+		STDOUT.puts api.response[:error][:code]
+		STDOUT.puts
+
+		STDOUT.puts '<Error Message>'
+		STDOUT.puts api.response[:error][:message]
+		STDOUT.puts
+
+		exit(0)
+	end
+
+	STDOUT.puts
+
+	STDOUT.puts '<Client ID>'
+	STDOUT.puts app[:client_id]
+	STDOUT.puts
+
+	STDOUT.puts '<Application Name>'
+	STDOUT.puts app[:name]
+	STDOUT.puts
+
+	STDOUT.puts '<Name>'
+	STDOUT.puts user[:name]
+	STDOUT.puts
+
+	STDOUT.puts '<Screen ID>'
+	STDOUT.puts user[:screen_id]
+	STDOUT.puts
+
+end