omniauth-streamelements 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a6851adac907891a2363dd87689cdb71abd7795656232c4bb744e756814367cb
+  data.tar.gz: 8657fe4c6c31b272d5345c71896a29714e8130abe9a65976d750e674b1cd2533
+SHA512:
+  metadata.gz: b3695030a9523dc2a763f93df4fb52b3d9c4d01f66cf5ff5fcde847795da3a3dd24d4a013bfee4bfaf4e8f62ce1335aa8fd0aeb88a0375626b13b4b6a57c30b7
+  data.tar.gz: c22d3cdcabde79ef6bcd8d8293ea81e056fc80655ebb507a3532784d6e32073ffdd5e1cf5cec0927735e1bec7c0fd282d27695f4b0d52cdc931168527683bafe

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at matt@prognostikos.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Matt Rohrer
+
+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,56 @@
+# Omniauth::Streamelements
+
+An Omniauth strategy for Streamelements
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-streamelements', github: "krtschmr/omniauth-streamelements"
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Here's an example for adding the middleware to a Rails app in `config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :streamelements, ENV["STREAMELEMENTS_CLIENT_ID"], ENV["STREAMELEMENTS_CLIENT_SECRET"]
+end
+```
+
+## Auth Hash
+
+Here's an example *Auth Hash* available in `request.env['omniauth.auth']`:
+
+```ruby
+{"provider"=>"streamelements",
+ "uid"=>"5d2....",
+ "info"=>{"display_name"=>"MyHero", "name"=>"MyHero"},
+ "credentials"=>{"token"=>"CvsQp....", "refresh_token"=>"e8N...", "expires_at"=>1578133337, "expires"=>true},
+ "extra"=>
+  {"raw_info"=>
+    {"streamelements"=>
+      {"profile"=>{"headerImage"=>"....", "title"=>"...'s profile"},
+       "provider"=>"twitch",
+       "broadcasterType"=>"affiliate",
+       "suspended"=>false,
+       "providerId"=>"1337",
+       ...       
+       "geo"=>"TH",
+       "id"=>"5d29bb4406f75d15ac92a9c3"}}}}
+
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/krtschmr/omniauth-streamelements. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "omniauth/streamelements"
+
+# 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

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/lib/omniauth/strategies/streamelements.rb

@@ -0,0 +1,77 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class Streamelements < OmniAuth::Strategies::OAuth2
+      DEFAULT_SCOPE = 'tips:write'.freeze
+
+      option :name, "streamelements"
+
+      option :client_options, {
+        site: 'https://api.streamelements.com',
+        authorize_url: '/oauth2/authorize',
+        token_url: '/oauth2/token'
+      }
+
+      option :access_token_options, {
+        header_format: 'Bearer %s',
+        param_name: 'access_token'
+      }
+
+      option :authorize_options, [:scope]
+
+      uid do
+        raw_info['streamelements']['id']
+      end
+
+      info do
+        {
+          display_name: raw_info['streamelements']['username'],
+          name: raw_info['streamelements']['displayName']
+        }
+      end
+
+      extra do
+        { raw_info: raw_info }
+      end
+
+      def raw_info
+        @raw_info ||= get_raw_info
+      end
+
+      def get_raw_info
+        uri = URI("https://api.streamelements.com/kappa/v2/channels/me")
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        resp = http.get(uri.path, {'Authorization'=>"OAuth #{access_token.token}"})
+        data = JSON.parse(resp.body)
+        data["id"] = data.delete("_id")
+        {"streamelements" => data}
+      end
+
+      def build_access_token
+        super.tap do |token|
+          token.options.merge!(access_token_options)
+        end
+      end
+
+      def access_token_options
+        options.access_token_options.inject({}) { |h,(k,v)| h[k.to_sym] = v; h }
+      end
+
+      def callback_url
+        return options[:redirect_uri] unless options[:redirect_uri].nil?
+        full_host + script_name + callback_path
+      end
+
+      def authorize_params
+        super.tap do |params|
+          options[:authorize_options].each do |k|
+            params[k] = request.params[k.to_s] unless [nil, ''].include?(request.params[k.to_s])
+          end
+          params[:scope] = params[:scope] || DEFAULT_SCOPE
+        end
+      end
+    end
+  end
+end

data/lib/omniauth/streamelements/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Streamelements
+    VERSION = "0.1.1"
+  end
+end

data/lib/omniauth/streamelements.rb

@@ -0,0 +1,2 @@
+require "omniauth/streamelements/version"
+require "omniauth/strategies/streamelements"

data/lib/omniauth-streamelements.rb

@@ -0,0 +1 @@
+require "omniauth/streamelements"

data/omniauth-streamelements.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth/streamelements/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-streamelements"
+  spec.version       = OmniAuth::Streamelements::VERSION
+  spec.authors       = ["Tim Kretschmer"]
+  spec.email         = ["tim@krtschmr.de"]
+
+  spec.summary       = %q{Streamelements OAuth2 strategy for OmniAuth}
+  spec.homepage      = "https://github.com/krtschmr/omniauth-streamelements"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'omniauth-oauth2', '~> 1.6'
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-streamelements
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Tim Kretschmer
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description:
+email:
+- tim@krtschmr.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/omniauth-streamelements.rb
+- lib/omniauth/strategies/streamelements.rb
+- lib/omniauth/streamelements.rb
+- lib/omniauth/streamelements/version.rb
+- omniauth-streamelements.gemspec
+homepage: https://github.com/krtschmr/omniauth-streamelements
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Streamelements OAuth2 strategy for OmniAuth
+test_files: []