omniauth-gitbook 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03ec192ce62502ee32acf3208e75967a4c12551c
-  data.tar.gz: 743591d69227924f045040262cddbb8fa2f80a94
+  metadata.gz: ee583cbf4ff6b57a2097f9c9de4699c600a3350d
+  data.tar.gz: 062f4ee514935ee18bf0709a15107bc10020f7bf
 SHA512:
-  metadata.gz: 9700390f8f898435748e048c94cb3f3c1a58f0ee389b1064cc8afc85ec8ee976d9bd07959d7a4a4b95e9a554a1188eb4e78dd3d58d16cc5fd3465e7c1671c59b
-  data.tar.gz: 49d2099169d38938b1ff9cebb534d82ed7efc4f4ea970e8047ad7e9db2a20ef5ce558691df97ec3bb7d81efb327fdf85ef1e3785a06bfe1e34a9b6d6bf531644
+  metadata.gz: b2a0cadc2b47c8e8de432ee9985c9b39124ff8a3905e82f962203e17e7f13af6f43546c68bba563157c4daaa481a8fc5a341a2ce3a6f65291c266dabfd5cfa06
+  data.tar.gz: 52d58116143cd438a18873078cb65dbbc704a9e8622d32453268620a319264b36475450a134a820fe36593bddc4f7dbcd4948ba68100a75981d9087aa694bce0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm: 2.3.1
+
+script: bundle exec rspec spec

data/README.md

@@ -1,2 +1,239 @@
-# omniauth-gitbook
+# omniauth-gitbook ![](https://travis-ci.org/Calvin-Huang/omniauth-gitbook.svg?branch=master) ![gem](https://img.shields.io/badge/gem-1.0.0-red.svg)
 Gitbook Oauth2 strategy for Omniauth.
+ 
+ ## Usage - OmniAuth
+ If you only integrate OmniAuth to your project, follows to [OmniAuth offical document](https://github.com/omniauth/omniauth), you have to add callback route and have a controller to handle data from oauth exchange.
+ 
+ Before all, add configuration for omniauth-gotbook at `config/initializers/omniauth.rb`.
+ ```ruby
+ Rails.application.config.middleware.use OmniAuth::Builder do
+   provider :developer unless Rails.env.production?
+   provider :gitbook, ENV['CLIENT_ID'], ENV['CLIENT_SECRET']
+ end
+ ```
+ 
+ Add callback route to `route.rb`.
+ ```ruby
+ get '/auth/:provider/callback', to: 'sessions#create'
+ ```
+ 
+ Handle json data in controller.
+ ```ruby
+ class SessionsController < ApplicationController
+   def create
+     @user = User.find_or_create_from_auth_hash(auth_hash)
+     self.current_user = @user
+     redirect_to '/'
+   end
+ 
+   protected
+ 
+   def auth_hash
+     request.env['omniauth.auth']
+   end
+ end
+ ```
+ 
+ ## Usage - Devise
+ If you integrate Devise to your rails project, follows to [Devise - OmniAuth: Overview](https://github.com/plataformatec/devise/wiki/OmniAuth:-Overview), here are some steps.
+ 
+ If you have no `config/initializers/devise.rb`, run the generator.
+ ```
+ rails g devise:install
+ ```
+ 
+ Add configuration to `config/initializers/devise.rb` for omniauth-gitbook.
+ ```ruby
+ Devise.setup do |config|
+   config.omniauth :gitbook, [CLIENT_ID], [CLIENT_SECRET]
+ end
+ ```
+ 
+ And if your devise model named `User`, add callback route to `route.rb`.
+ ```ruby
+ devise_for :users, controllers: { omniauth_callbacks: 'users/omniauth_callbacks' }
+ ```
+
+ Then you can get user's data in controller.
+ ```ruby
+ class Users::OmniauthCallbacksController < Devise::OmniauthCallbacksController
+   def gitbook
+     @user = User.find_or_create_by_oauth2(request.env[omniauth.auth])
+     
+     if @user.persisted?
+       sign_in_and_redirect_to root_path, event: :authentication
+     end
+   end
+ end
+ ```
+ 
+ ## What data exactly you retrieved from `omniauth-gitbook`
+ Here is the json structure.
+ ```json
+ {  
+    "provider":"gitbook",
+    "uid":"[UID]",
+    "info":{  
+       "username":"calvinhuang",
+       "name":"Calvin-Huang",
+       "website":"https://github.com/Calvin-Huang",
+       "urls":{  
+          "profile":"https://www.gitbook.com/@calvin-huang",
+          "stars":"https://www.gitbook.com/@calvin-huang/starred",
+          "avatar":"https://avatars0.githubusercontent.com/Calvin-Huang"
+       },
+       "auth":{  
+          "token":"[TOKEN]",
+          "password":false,
+          "verified":false
+       },
+       "token":"[TOKEN]"
+    },
+    "credentials":{  
+       "token":"[TOKEN]",
+       "expires":false
+    },
+    "extra":{  
+       "raw_info":{  
+          "id":"[UID]",
+          "type":"User",
+          "username":"calvinhuang",
+          "name":"Calvin-Huang",
+          "location":"",
+          "website":"https://github.com/Calvin-Huang",
+          "verified":false,
+          "locked":false,
+          "site_admin":false,
+          "urls":{  
+             "profile":"https://www.gitbook.com/@calvin-huang",
+             "stars":"https://www.gitbook.com/@calvin-huang/starred",
+             "avatar":"https://avatars0.githubusercontent.com/calvin-huang"
+          },
+          "permissions":{  
+             "edit":true,
+             "admin":true
+          },
+          "dates":{  
+             "created":"2016-10-01T08:51:37.391Z"
+          },
+          "counts":{  
+ 
+          },
+          "github":{  
+             "username":"Calvin-Huang",
+             "scopes":[  
+                ""
+             ],
+             "required":true
+          },
+          "plan":{  
+             "id":"free"
+          },
+          "auth":{  
+             "token":"[TOKEN]",
+             "password":false,
+             "verified":false
+          },
+          "token":"[TOKEN]"
+       }
+    },
+    "books":{  
+       "list":[  
+          {  
+             "id":"calvinhuang/test",
+             "status":"published",
+             "name":"test",
+             "title":"test",
+             "description":"",
+             "public":true,
+             "topics":[  
+    
+             ],
+             "license":"nolicense",
+             "language":"en",
+             "locked":false,
+             "cover":{  
+                "large":"[URL]",
+                "small":"[URL]"
+             },
+             "urls":{  
+                "git":"https://git.gitbook.com/calvinhuang/test.git",
+                "access":"https://www.gitbook.com/book/calvinhuang/test",
+                "homepage":"https://calvinhuang.gitbooks.io/test/",
+                "read":"https://www.gitbook.com/read/book/calvinhuang/test",
+                "edit":"https://www.gitbook.com/book/calvinhuang/test/edit",
+                "content":"https://fennyliang.gitbooks.io/test/content/",
+                "download":{  
+                   "epub":"https://www.gitbook.com/download/epub/book/calvinhuang/test",
+                   "mobi":"https://www.gitbook.com/download/mobi/book/calvinhuang/test",
+                   "pdf":"https://www.gitbook.com/download/pdf/book/calvinhuang/test"
+                }
+             },
+             "counts":{  
+                "stars":0,
+                "subscriptions":1,
+                "updates":1,
+                "discussions":0,
+                "collaborators":0
+             },
+             "dates":{  
+                "build":"2016-10-03T05:29:17.696Z",
+                "created":"2016-10-03T05:28:37.865Z"
+             },
+             "permissions":{  
+                "edit":true,
+                "admin":true,
+                "important":true
+             },
+             "publish":{  
+                "defaultBranch":"master",
+                "builder":"default"
+             },
+             "author":{  
+                "id":"[UID]",
+                "type":"User",
+                "username":"calvinhuang",
+                "name":"Calvin-Huang",
+                "location":"",
+                "website":"https://github.com/Calvin-Huang",
+                "verified":false,
+                "locked":false,
+                "site_admin":false,
+                "urls":{  
+                   "profile":"https://www.gitbook.com/@calvinhuang",
+                   "stars":"https://www.gitbook.com/@calvinhuang/starred",
+                   "avatar":"https://avatars0.githubusercontent.com/Calvin-Huang"
+                },
+                "permissions":{  
+                   "edit":null,
+                   "admin":null
+                },
+                "dates":{  
+                   "created":"2016-10-01T08:51:37.391Z"
+                },
+                "counts":{  
+    
+                },
+                "github":{  
+                   "username":"Calvin-Huang"
+                }
+             }
+          }
+       ],
+       "total":1,
+       "limit":50,
+       "page":0,
+       "pages":1
+    }
+ }
+ ```
+ 
+ ## TO-DO
+ - [ ] Paginate books.
+ - [ ] Provide Gem to interact with GitBook API.
+ 
+ ## Contribution
+ I'm appreciate at any improvement, please feel free to open PR / Issue to this repo or you can contact [me](https://github.com/Calvin-Huang).
+ 
+ ## License
+ Copyright (c) [Calvin Huang](https://github.com/Calvin-Huang). This software is licensed under the [MIT License](https://github.com/Calvin-Huang/CHRealHideUIView/blob/master/LICENSE).

data/lib/gitbook/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module GitBook
-    VERSION = '0.0.4'
+    VERSION = '1.0.0'
   end
 end

data/lib/omniauth/strategies/gitbook.rb

@@ -11,10 +11,6 @@ module OmniAuth
           token_url: "#{base_url}/oauth/access_token",
       }
 
-      option :token_params, {
-          grant_type: 'authorization_code'
-      }
-
       uid { raw_info['id'].to_s }
 
       info do
@@ -29,14 +25,17 @@ module OmniAuth
       end
 
       extra do
-        { raw_info: raw_info }
+        { raw_info: raw_info, books: books }
       end
 
       def raw_info
-        access_token.options[:mode] = :query
         @raw_info ||= access_token.get('account').parsed
       end
 
+      def books
+        @books ||= access_token.get('books').parsed
+      end
+
       def authorize_params
         super.tap do |params|
           %w[response_type].each do |v|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-gitbook
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Calvin Huang
@@ -109,6 +109,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE