omniauth-streamlabs 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: efc3e2d0ab4e64c225d4f77ed8432331e35b5b79
-  data.tar.gz: a1c53c61be87b9db4e23710e989a2f6f02dc4375
+  metadata.gz: 83d9dfa18426ce2234b81e8c10e0496cd0c38738
+  data.tar.gz: 92c0ed7685c23480331f74ebf1c5b2ff8e999cf4
 SHA512:
-  metadata.gz: 4911d9ba97994da9366fd079f9997d0a7575fc34a488a93db82acfd197ebddce327b427408f0ac56d2aa98e3ff97a895736f618bdcd265984c5ca92d9fdcc9d9
-  data.tar.gz: ba64ce507488bbcf03d1e6d2144f79511e4662bec8cc49539d23cf802a7672d374fb1e39e6d7a068db9fcf3173f32a25b33cc711ca543eeb0bebbf9167c4953d
+  metadata.gz: a779a89689278d5bbcac6cb44276918de50a0e0d2cdc95ab3d7a33214d224c0e6ad5e306b5ed23d94396d1af932d033474728cd57d1539410576de90412ad725
+  data.tar.gz: 59e6c679663f07cc960488f4e1c79dc8bb159fcecdb653713146d4cfa8b334436188f0366fc5f996246f672bea70b09f0c3fa21ac16be9aa5c23ad8df848825e

data/README.md

@@ -1,5 +1,7 @@
 # Omniauth::Streamlabs
 
+An Omniauth strategy for Streamlabs
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,19 +20,43 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+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 :twitch, ENV["STREAMLABS_CLIENT_ID"], ENV["STREAMLABS_CLIENT_SECRET"]
+end
+```
 
-## Development
+## Auth Hash
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Here's an example *Auth Hash* available in `request.env['omniauth.auth']`:
 
-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).
+```ruby
+{
+  provider: 'streamlabs',
+  uid: 12345678,
+  info: {
+    display_name: 'johndoe',
+    name: 'JohnDoe',
+  },
+  credentials: {
+    token: 'asdfghjklasdfghjklasdfghjkl', # OAuth 2.0 access_token, which you may wish to store
+    expires: false # this will always be false
+  },
+  extra: {
+    raw_info: {
+      display_name: 'johndoe',
+      name: 'JohnDoe',
+      _id: 12345678,
+    }
+  }
+}
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/prognostikos/omniauth-streamlabs. 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/lib/omniauth/streamlabs/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module Streamlabs
-    VERSION = "0.2.0"
+    VERSION = "0.2.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-streamlabs
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Matt Rohrer