omniauth-cgtrader 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a471de6fd6e55dda0c2ebd647eecccdbcfe66d0ff52e4366e965fcbd357f4eb
-  data.tar.gz: 9c22a71ab57370527abb4b96ade0868023304a89938ef80b6da611be6bf58798
+  metadata.gz: 93139450e38378ddc160a928958213fb43435b4e39aab767e97831a00c3191e9
+  data.tar.gz: 72d863bfe4805bf3ed5f883637fc032843a823cef7104e20b634b20e6cba7399
 SHA512:
-  metadata.gz: d2c33c8bbe56145773cc57492cc73005a35f09ae73ccfa3e7c0bc4e06b8f36214ee1e5940a926421640c8690afb9d0980ffe91501a12fe8cfad0a51275c870ca
-  data.tar.gz: c5a82277784913468177283104a8097d10aeb07ec64cfccf04be0dbb561a0c415ca943e165cc0089f12a67fe85cf299c4e63c82ef1ab55b29a636225b991e081
+  metadata.gz: 1d41a08ac2b764c1cbee75ca4a64f86f57e742d08e909ab6ed097c0cfd5a6cdc9cba0bc4a952c901cd39a2029e646e151774c85136da74a7a1cc7eb3eb561d2d
+  data.tar.gz: daeb2bc330ab1911ba81215f2588a82af13cafdb7b6c9307d7d91c5448c7cda6a954a8c160875ad4303ea2c2addfd1db063b6fa74b45b827babc1d78c21e9c80

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [2.0.1] - 2023-07-24
+
+### Chore
+
+- Updated README.md ([commit](https://github.com/CGTrader/omniauth-cgtrader/commit/b1b7850b66661be3b9e13fa2ec39b629b8f259af)).
+
 ## [2.0.0] - 2023-06-13
 
 ### Changed

data/Gemfile

@@ -4,4 +4,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in omniauth-cgtrader.gemspec
 gemspec
-gem "rake", "~> 13.0"

data/README.md

@@ -4,21 +4,19 @@ Cgtrader OAuth2 Strategy for OmniAuth.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add to your `Gemfile`:
 
 ```ruby
 gem 'omniauth-cgtrader'
 ```
 
-And then execute:
+Then `bundle install`.
 
-    $ bundle
-
-Or install it yourself as:
+## Usage
 
-    $ gem install omniauth-cgtrader
+`OmniAuth::Strategies::Cgtrader` is simply a Rack middleware. Read the OmniAuth docs for detailed instructions: https://github.com/intridea/omniauth.
 
-## Usage
+Here's a quick example, adding the middleware to a Rails app in `config/initializers/omniauth.rb`:
 
 ```ruby
 Rails.application.config.middleware.use OmniAuth::Builder do
@@ -26,6 +24,26 @@ Rails.application.config.middleware.use OmniAuth::Builder do
 end
 ```
 
-## Auth hash
+## Auth Hash
+
+Here's an example *Auth Hash* available in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  provider: 'cgtrader',
+  uid: '1234567',
+  info: {
+    id: '123',
+    email: 'joe@bloggs.com',
+    username: 'joe_bloggs',
+    is_admin: false,
+    avatar_url: 'https://upload.wikimedia.org/wikipedia/commons/8/89/Portrait_Placeholder.png'
+  },
+}
+```
 
 ## Devise
+
+See these on how to use this gem with Devise, replacing Google / Facebook with Cgtrader:
+* https://github.com/zquestz/omniauth-google-oauth2/blob/master/README.md#devise
+* https://github.com/heartcombo/devise/wiki/OmniAuth:-Overview

data/lib/cgtrader/version.rb

@@ -2,6 +2,6 @@
 
 module Omniauth
   module Cgtrader
-    VERSION = '2.0.0'
+    VERSION = '2.0.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-cgtrader
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - devaudrius, mihkelal