Class: ZohoHub::Auth
- Inherits:
-
Object
- Object
- ZohoHub::Auth
- Extended by:
- Forwardable
- Defined in:
- lib/zoho_hub/auth.rb
Constant Summary collapse
- TOKEN_PATH =
'/oauth/v2/token'
- REVOKE_TOKEN_PATH =
'/oauth/v2/token/revoke'
- AUTH_PATH =
'/oauth/v2/auth'
- DEFAULT_SCOPES =
%w[ ZohoCRM.modules.custom.all ZohoCRM.settings.all ZohoCRM.modules.contacts.all ZohoCRM.modules.all ].freeze
- DEFAULT_ACCESS_TYPE =
'offline'
Class Method Summary collapse
Instance Method Summary collapse
- #auth_full_uri ⇒ Object
- #auth_url ⇒ Object
- #get_token(grant_token) ⇒ Object
-
#initialize(access_type: nil, scopes: nil) ⇒ Auth
constructor
A new instance of Auth.
- #parse(body) ⇒ Object
- #refresh_token(refresh_token) ⇒ Object
- #refresh_url(refresh_token) ⇒ Object
- #revoke_refresh_token(refresh_token) ⇒ Object
- #revoke_token_full_uri ⇒ Object
- #token_full_uri ⇒ Object
- #token_url(grant_token) ⇒ Object
Constructor Details
#initialize(access_type: nil, scopes: nil) ⇒ Auth
Returns a new instance of Auth.
26 27 28 29 30 |
# File 'lib/zoho_hub/auth.rb', line 26 def initialize(access_type: nil, scopes: nil) @configuration = ZohoHub.configuration @access_type = access_type || ZohoHub.configuration.access_type @scopes = scopes || DEFAULT_SCOPES end |
Class Method Details
.auth_url ⇒ Object
32 33 34 |
# File 'lib/zoho_hub/auth.rb', line 32 def self.auth_url new.auth_url end |
.get_token(grant_token) ⇒ Object
107 108 109 |
# File 'lib/zoho_hub/auth.rb', line 107 def self.get_token(grant_token) new.get_token(grant_token) end |
.refresh_token(refresh_token) ⇒ Object
59 60 61 |
# File 'lib/zoho_hub/auth.rb', line 59 def self.refresh_token(refresh_token) new.refresh_token(refresh_token) end |
Instance Method Details
#auth_full_uri ⇒ Object
55 56 57 |
# File 'lib/zoho_hub/auth.rb', line 55 def auth_full_uri Addressable::URI.join(@configuration.base_url, AUTH_PATH) end |
#auth_url ⇒ Object
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
# File 'lib/zoho_hub/auth.rb', line 36 def auth_url uri = auth_full_uri query = { client_id: client_id, scope: @scopes.join(','), access_type: @access_type, redirect_uri: redirect_uri, response_type: 'code' } # The consent page must be presented otherwise we don't get the refresh token back. query[:prompt] = 'consent' if @access_type == DEFAULT_ACCESS_TYPE uri.query_values = query Addressable::URI.unencode(uri.to_s) end |
#get_token(grant_token) ⇒ Object
111 112 113 114 115 |
# File 'lib/zoho_hub/auth.rb', line 111 def get_token(grant_token) result = Faraday.post(token_url(grant_token)) parse(result.body) end |
#parse(body) ⇒ Object
83 84 85 |
# File 'lib/zoho_hub/auth.rb', line 83 def parse(body) MultiJson.load(body, symbolize_keys: true) end |
#refresh_token(refresh_token) ⇒ Object
63 64 65 66 67 68 |
# File 'lib/zoho_hub/auth.rb', line 63 def refresh_token(refresh_token) result = Faraday.post(refresh_url(refresh_token)) json = parse(result.body) json.merge(refresh_token: refresh_token) end |
#refresh_url(refresh_token) ⇒ Object
70 71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/zoho_hub/auth.rb', line 70 def refresh_url(refresh_token) uri = token_full_uri uri.query_values = { client_id: client_id, client_secret: secret, refresh_token: refresh_token, grant_type: 'refresh_token' } Addressable::URI.unencode(uri.to_s) end |
#revoke_refresh_token(refresh_token) ⇒ Object
91 92 93 94 95 96 97 98 99 100 101 |
# File 'lib/zoho_hub/auth.rb', line 91 def revoke_refresh_token(refresh_token) uri = revoke_token_full_uri uri.query_values = { token: refresh_token } url = Addressable::URI.unencode(uri.to_s) result = Faraday.post(url) parse(result.body) end |
#revoke_token_full_uri ⇒ Object
103 104 105 |
# File 'lib/zoho_hub/auth.rb', line 103 def revoke_token_full_uri Addressable::URI.join(@configuration.base_url, REVOKE_TOKEN_PATH) end |
#token_full_uri ⇒ Object
87 88 89 |
# File 'lib/zoho_hub/auth.rb', line 87 def token_full_uri Addressable::URI.join(@configuration.base_url, TOKEN_PATH) end |
#token_url(grant_token) ⇒ Object
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'lib/zoho_hub/auth.rb', line 117 def token_url(grant_token) uri = token_full_uri query = { client_id: client_id, client_secret: secret, code: grant_token, redirect_uri: redirect_uri, grant_type: 'authorization_code' } uri.query_values = query Addressable::URI.unencode(uri.to_s) end |