twitch_oauth2 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 774bd262b409e02731b8d17031f22130f886a821b8042e8eb948e8e6b7137114
+  data.tar.gz: 32afb0a9c9406acc3225d468e9d23245470eaaa40ae94c6d0795d7137bf3a8bf
+SHA512:
+  metadata.gz: 6b0220445931a12f5cb271b178ead318674d4a9c9e113758dc8784853e16a3305d1623c6595cf3783d40a84293fe28e60abd537c5f7e33148d4ac70c314d5972
+  data.tar.gz: 28dc850d48767600756bcba6ff1a609f062ff971dd05e39a257a34c8c59892b7069191e7b74ae932de751c6e752297b6de57561e0f8077c7fbfd443a1f725a7b

data/.cirrus.yml

@@ -0,0 +1,32 @@
+bundle_cache: &bundle_cache
+  bundle_cache:
+    folder: /usr/local/bundle
+    fingerprint_script:
+      - echo $CIRRUS_OS
+      - ruby -v
+      - cat Gemfile
+      - cat *.gemspec
+  install_script: bundle update
+
+test_task:
+  container:
+    matrix:
+      image: ruby:2.5
+      image: ruby:2.6
+      image: ruby:2.7
+  <<: *bundle_cache
+  environment:
+    CODECOV_TOKEN: ENCRYPTED[b26ecd3e49540f09f5c9bf830caa29f5daedaf6769d6b1ba1a650eb6e81432ffb857f19421aed8e8dfddf21724fb57b6]
+  test_script: bundle exec rake
+
+rubocop_task:
+  container:
+    image: ruby:latest
+  <<: *bundle_cache
+  rubocop_script: bundle exec rubocop
+
+markdown_lint_task:
+  container:
+    image: ruby:latest
+  <<: *bundle_cache
+  rubocop_script: bundle exec mdl .

data/.editorconfig

@@ -0,0 +1,17 @@
+root = true
+
+[*]
+indent_style = tab
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.y{a,}ml]
+indent_style = space
+indent_size = 2
+
+[*.md]
+indent_style = space
+indent_size = 4

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+/coverage/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,47 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+Layout/IndentationStyle:
+  EnforcedStyle: tabs
+  IndentationWidth: 2
+Layout/IndentationWidth:
+  Width: 1
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true
+
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+    - spec/**/*.rb
+
+AllCops:
+  TargetRubyVersion: 2.5
+
+RSpec/FilePath:
+  CustomTransform:
+    TwitchOAuth2: twitch_oauth2
+RSpec/NestedGroups:
+  Max: 4

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in twitch_oauth2.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Alexander Popov
+
+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,101 @@
+# TwitchOAuth2
+
+Twitch authentication with OAuth 2.
+Result tokens can be used for API libraries, chat libraries or something else.
+
+[Twitch Authentication Documentation]
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'twitch_oauth2'
+```
+
+And then execute:
+
+```
+bundle install
+```
+
+Or install it yourself as:
+
+```
+gem install twitch_oauth2
+```
+
+## Usage
+
+### Initialization
+
+```ruby
+require 'twitch_oauth2'
+
+client = TwitchOAuth2::Client.new(
+  client_id: 'application_client_id',
+  client_secret: 'application_client_secret',
+  scopes: %w[user:read:email bits:read] # default is `nil`
+  redirect_uri: 'application_redirect_uri' # default is `http://localhost`
+)
+```
+
+### Check tokens
+
+```ruby
+tokens = previously_saved_tokens
+# => { access_token: 'abcdef', refresh_token: 'ghikjl' }
+# Can be empty.
+
+client.check_tokens **tokens
+```
+
+#### The first run
+
+You can pass nothing to `#check_tokens`, then client will generate new ones.
+You will be asked to open a Twitch link in a browser and login as user
+for whom tokens are intended.
+
+#### Reusing tokens
+
+Then, if you pass tokens, client will validate them and return themselves
+or refresh and return new ones.
+
+### Explicitly refresh tokens
+
+You can refresh tokens manually:
+
+```ruby
+client.refreshed_tokens refresh_token: 'ghikjl'
+```
+
+This is used internally in `#check_tokens`, and can be used separately
+for failed requests to API.
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies.
+Then, run `bundle exec rake spec` to run the tests.
+
+We're using [VCR](https://relishapp.com/vcr/vcr/docs) cassettes
+with filtered sensitive data, so you don't need for real credentials
+(like Twitch Client ID and Client Secret) for changing existing methods,
+but you need for them to add new requests.
+You can read how to get them [here][Twitch Authentication Documentation].
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`,
+and then run `bundle exec rake release`, which will create a git tag
+for the version, push git commits and tags, and push the `.gem` file
+to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/AlexWayfer/twitch_oauth2).
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).
+
+[Twitch Authentication Documentation]: https://dev.twitch.tv/docs/authentication

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/twitch_oauth2/client.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+require 'securerandom'
+
+module TwitchOAuth2
+	## Client for making requests
+	class Client
+		CONNECTION = Faraday.new(
+			url: 'https://id.twitch.tv/oauth2/'
+		) do |connection|
+			connection.request :json
+
+			connection.response :dates
+
+			connection.response :json,
+				content_type: /\bjson$/,
+				parser_options: { symbolize_names: true }
+		end.freeze
+
+		def initialize(
+			client_id:, client_secret:, redirect_uri: 'http://localhost', scopes: nil
+		)
+			@client_id = client_id
+			@client_secret = client_secret
+			@redirect_uri = redirect_uri
+			@scopes = scopes
+
+			@state = SecureRandom.alphanumeric(32)
+		end
+
+		def check_tokens(access_token: nil, refresh_token: nil)
+			if access_token
+				validate_result = validate access_token: access_token
+
+				if validate_result[:status] == 401
+					return refreshed_tokens(refresh_token: refresh_token)
+				end
+
+				if validate_result[:expires_in].positive?
+					return { access_token: access_token, refresh_token: refresh_token }
+				end
+			end
+
+			flow
+		end
+
+		def refreshed_tokens(refresh_token:)
+			refresh(refresh_token: refresh_token).slice(:access_token, :refresh_token)
+		end
+
+		private
+
+		def flow
+			link = authorize
+
+			puts <<~TEXT
+				1. Open URL in your browser:
+					#{link}
+				2. Login to Twitch.
+				3. Copy the `code` parameter from redirected URL.
+				4. Insert below:
+			TEXT
+
+			code = STDIN.gets.chomp
+
+			token(code: code).slice(:access_token, :refresh_token)
+		end
+
+		def authorize
+			response = CONNECTION.get(
+				'authorize',
+				client_id: @client_id,
+				redirect_uri: @redirect_uri,
+				scope: Array(@scopes).join(' '),
+				response_type: :code
+			)
+
+			location = response.headers[:location]
+			return location if location
+
+			raise Error, response.body[:message]
+		end
+
+		def token(code:)
+			response = CONNECTION.post(
+				'token',
+				client_id: @client_id,
+				client_secret: @client_secret,
+				code: code,
+				grant_type: :authorization_code,
+				redirect_uri: @redirect_uri
+			)
+
+			response.body
+		end
+
+		def validate(access_token:)
+			response = CONNECTION.get(
+				'validate', {}, { 'Authorization' => "OAuth #{access_token}" }
+			)
+
+			response.body
+		end
+
+		def refresh(refresh_token:)
+			response = CONNECTION.post(
+				'token',
+				client_id: @client_id,
+				client_secret: @client_secret,
+				grant_type: :refresh_token,
+				refresh_token: refresh_token
+			)
+
+			return response.body if response.success?
+
+			raise Error, response.body[:message]
+		end
+	end
+end

data/lib/twitch_oauth2/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module TwitchOAuth2
+	class Error < StandardError
+	end
+end

data/lib/twitch_oauth2/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TwitchOAuth2
+	VERSION = '0.1.0'
+end

data/lib/twitch_oauth2.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative 'twitch_oauth2/client'
+require_relative 'twitch_oauth2/error'
+require_relative 'twitch_oauth2/version'

data/twitch_oauth2.gemspec

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative 'lib/twitch_oauth2/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = 'twitch_oauth2'
+	spec.version       = TwitchOAuth2::VERSION
+	spec.authors       = ['Alexander Popov']
+	spec.email         = ['alex.wayfer@gmail.com']
+
+	spec.summary       = 'Twitch authentication with OAuth 2.'
+	spec.description   = <<~DESC
+		Twitch authentication with OAuth 2.
+		Result tokens can be used for API libraries, chat libraries
+		or something else.
+	DESC
+	spec.license = 'MIT'
+
+	spec.required_ruby_version = '>= 2.5'
+
+	source_code_uri = 'https://github.com/AlexWayfer/twitch_oauth2'
+
+	spec.homepage = source_code_uri
+
+	spec.metadata['source_code_uri'] = source_code_uri
+
+	spec.metadata['homepage_uri'] = spec.homepage
+
+	# TODO: Put your gem's CHANGELOG.md URL here.
+	# spec.metadata["changelog_uri"] = ""
+
+	# Specify which files should be added to the gem when it is released.
+	# The `git ls-files -z` loads the files in the RubyGem that have been added
+	# into git.
+	spec.files = Dir.chdir(__dir__) do
+		`git ls-files -z`.split("\x0").reject do |file|
+			file.match(%r{^(test|spec|features)/})
+		end
+	end
+	spec.bindir        = 'exe'
+	spec.executables   = spec.files.grep(%r{^exe/}) { |file| File.basename(file) }
+	spec.require_paths = ['lib']
+
+	spec.add_dependency 'faraday', '~> 1.0'
+	spec.add_dependency 'faraday_middleware', '~> 1.0'
+
+	spec.add_development_dependency 'codecov', '~> 0.1.0'
+	spec.add_development_dependency 'mdl', '~> 0.9.0'
+	spec.add_development_dependency 'pry-byebug', '~> 3.9'
+	spec.add_development_dependency 'rake', '~> 13.0'
+	spec.add_development_dependency 'rspec', '~> 3.9'
+	spec.add_development_dependency 'rubocop', '~> 0.83.0'
+	spec.add_development_dependency 'rubocop-performance', '~> 1.0'
+	spec.add_development_dependency 'rubocop-rspec', '~> 1.0'
+	spec.add_development_dependency 'simplecov', '~> 0.18.0'
+	spec.add_development_dependency 'vcr', '~> 5.1'
+end

metadata

@@ -0,0 +1,230 @@
+--- !ruby/object:Gem::Specification
+name: twitch_oauth2
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexander Popov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: mdl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.83.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.83.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+description: |
+  Twitch authentication with OAuth 2.
+  Result tokens can be used for API libraries, chat libraries
+  or something else.
+email:
+- alex.wayfer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".cirrus.yml"
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/twitch_oauth2.rb
+- lib/twitch_oauth2/client.rb
+- lib/twitch_oauth2/error.rb
+- lib/twitch_oauth2/version.rb
+- twitch_oauth2.gemspec
+homepage: https://github.com/AlexWayfer/twitch_oauth2
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/AlexWayfer/twitch_oauth2
+  homepage_uri: https://github.com/AlexWayfer/twitch_oauth2
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Twitch authentication with OAuth 2.
+test_files: []