omniauth-beam 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a93616647610037f3519d2324275b7bb6165aeb4
-  data.tar.gz: 5dd4b43b19ab16d033cee38620ad2738ce8f6300
+  metadata.gz: 04f2317efcd80fed535e8e03b2c60e18f224b40b
+  data.tar.gz: fa48ba501a105646cb80cadaf04d9e92d43ffd65
 SHA512:
-  metadata.gz: 7e46738397034a9a39fd00ebdee8fa63130fe504a3287bef1e83f3af4f12b979a360373fc8d06917b63a3b73e1ab8a0f0da0c5f04448718b11b1305c7537717f
-  data.tar.gz: e54e154171794259a48498abcf2675c9bc73e0d9b3219d757c25e0647abb63858d2e8cb44c2e8792fc058802a9646676167264e6d876a2ac5b7c53ef23f6fcf2
+  metadata.gz: 29f3dff16e1948ecc871d22a6ab77142cecd1b34f13a586042547f5bb5a5799ecd5c8c16c12e759fcbe2c0685f0549bdbd0d61fe74a346026e298780495d34bb
+  data.tar.gz: f147f73c27693c91dfd86d5b4e0360c8fcb0bfc3a46c8818801a92f5352cf4d67eadf0753a514bb8f08c90883ba481d38714e0fd8732f278af6d91e4ba0a1d4b

data/README.md

@@ -1,2 +1,77 @@
-# omniauth-beam
+[![Gem Version](https://badge.fury.io/rb/omniauth-beam.svg)](https://badge.fury.io/rb/omniauth-beam)
+
+# OmniAuth::Beam
 OmniAuth strategy for Beam.pro
+
+## Installation
+Add this line to your application's Gemfile:
+
+    gem 'omniauth-beam'
+
+Then run `bundle install`
+
+Or install it yourself with `gem install omniauth-beam`
+
+### Using Directly
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :beam, ENV['BEAM_CLIENT_ID'], ENV['BEAM_SECRET_ID']
+end
+```
+
+### Using With Devise
+Add to `config/initializers/devise.rb`
+```ruby
+  config.omniauth :beam, ENV['BEAM_CLIENT_ID'], ENV['BEAM_SECRET_ID']
+```
+
+And apply it to your Devise user model:
+```ruby
+class User < ApplicationRecord
+  devise :database_authenticatable, :registerable, :recoverable, :rememberable,
+         :trackable, :validatable, :omniauthable,
+         omniauth_providers: %i(beam)
+
+  def self.from_omniauth(auth)
+    user = where(provider: auth.provider, uid: auth.uid).first_or_create do |u|
+      u.password = Devise.friendly_token[0, 20]
+      u.provider = auth.provider
+      u.uid      = auth.uid
+    end
+    user.update avatar_url: auth.info.image,
+                email:      auth.info.email,
+                name:       auth.info.name
+    user
+  end
+end
+```
+
+## Default Scope
+
+The default scope is set to _user:details:self_, making this hash available in `request.env['omniauth.auth']`:
+```ruby
+{
+  provider:    'beam',
+  uid:         123456789,
+  info:        {
+    name:        'JohnDoe',
+    email:       'johndoe@example.com',
+    description: 'My channel.',
+    image:       'https://uploads.beam.pro/avatar/12345678-1234.jpg',
+    social:      {
+      discord:  'johndoe#12345',
+      facebook: 'https://facebook.com/John.Doe'
+      player:   'https://player.me/johndoe',
+      twitter:  'https://twitter.com/johndoe',
+      youtube:  'https://youtube.com/user/johndoe'
+    },
+    urls:        { Beam: 'https://beam.pro/johndoe' }
+  },
+  credentials: {
+    token:         'asdfghjklasdfghjklasdfghjkl',
+    refresh_token: 'qwertyuiopqwertyuiopqwertyuiop',
+    expires_at:    1477577799,
+    expires:       true
+  }
+}
+```

data/lib/omniauth/beam/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module Beam
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.1.1'.freeze
   end
 end

data/lib/omniauth/strategies/beam.rb

@@ -7,6 +7,7 @@ module OmniAuth
       BLANK_PARAMS  = [nil, ''].freeze
       DEFAULT_SCOPE = 'user:details:self'.freeze
       RAW_INFO_URL  = '/api/v1/users/current'.freeze
+      SOCIAL_KEYS   = %w(facebook discord player twitter youtube).freeze
 
       option :name, 'beam'
 
@@ -29,7 +30,8 @@ module OmniAuth
           email:       raw_info['email'],
           description: raw_info['bio'],
           image:       raw_info['avatarUrl'],
-          urls:        { Beam: "http://beam.pro/#{raw_info['name']}" }
+          social:      social_info,
+          urls:        urls_info
         }
       end
 
@@ -63,6 +65,20 @@ module OmniAuth
       def raw_info
         @raw_info ||= access_token.get(RAW_INFO_URL).parsed
       end
+
+      def social_info
+        raw_social = raw_info['social']
+        SOCIAL_KEYS.each_with_object({}) do |key, hsh|
+          hsh[key.to_sym] = raw_social[key] if raw_social.key? key
+          hsh
+        end
+      end
+
+      def urls_info
+        {
+          Beam: "http://beam.pro/#{raw_info['channel']['token']}"
+        }
+      end
     end # Beam
   end # Strategies
 end # OmniAuth

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-beam
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Christopher Nicholson-Sauls "charmquark"