Class: ZohoHub::Auth
- Inherits:
-
Object
- Object
- ZohoHub::Auth
- Extended by:
- Forwardable
- Defined in:
- lib/zoho_hub/auth.rb
Overview
Class that takes care of authentication using Oauth2 workflow as described here: www.zoho.com/crm/help/api/v2/#oauth-request.
Constant Summary collapse
- TOKEN_PATH =
'/oauth/v2/token'
- 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
- .auth_url(access_type: DEFAULT_ACCESS_TYPE, scopes: DEFAULT_SCOPES) ⇒ Object
- .get_token(grant_token) ⇒ Object
- .refresh_token(refresh_token) ⇒ Object
Instance Method Summary collapse
- #auth_full_uri ⇒ Object
- #auth_url ⇒ Object
- #get_token(grant_token) ⇒ Object
-
#initialize(access_type: DEFAULT_ACCESS_TYPE, scopes: DEFAULT_SCOPES) ⇒ 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
- #token_full_uri ⇒ Object
- #token_url(grant_token) ⇒ Object
Constructor Details
#initialize(access_type: DEFAULT_ACCESS_TYPE, scopes: DEFAULT_SCOPES) ⇒ Auth
Returns a new instance of Auth.
28 29 30 31 32 |
# File 'lib/zoho_hub/auth.rb', line 28 def initialize(access_type: DEFAULT_ACCESS_TYPE, scopes: DEFAULT_SCOPES) @configuration = ZohoHub.configuration @access_type = access_type @scopes = scopes end |
Class Method Details
.auth_url(access_type: DEFAULT_ACCESS_TYPE, scopes: DEFAULT_SCOPES) ⇒ Object
42 43 44 |
# File 'lib/zoho_hub/auth.rb', line 42 def self.auth_url(access_type: DEFAULT_ACCESS_TYPE, scopes: DEFAULT_SCOPES) new(access_type: access_type, scopes: scopes).auth_url end |
.get_token(grant_token) ⇒ Object
110 111 112 |
# File 'lib/zoho_hub/auth.rb', line 110 def self.get_token(grant_token) new.get_token(grant_token) end |
.refresh_token(refresh_token) ⇒ Object
87 88 89 |
# File 'lib/zoho_hub/auth.rb', line 87 def self.refresh_token(refresh_token) new.refresh_token(refresh_token) end |
Instance Method Details
#auth_full_uri ⇒ Object
38 39 40 |
# File 'lib/zoho_hub/auth.rb', line 38 def auth_full_uri Addressable::URI.join(api_domain, AUTH_PATH) end |
#auth_url ⇒ Object
46 47 48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/zoho_hub/auth.rb', line 46 def auth_url uri = auth_full_uri uri.query_values = { client_id: client_id, scope: @scopes.join(','), access_type: @access_type, redirect_uri: redirect_uri, response_type: 'code' } Addressable::URI.unencode(uri.to_s) end |
#get_token(grant_token) ⇒ Object
114 115 116 117 118 |
# File 'lib/zoho_hub/auth.rb', line 114 def get_token(grant_token) result = Faraday.post(token_url(grant_token)) parse(result.body) end |
#parse(body) ⇒ Object
120 121 122 |
# File 'lib/zoho_hub/auth.rb', line 120 def parse(body) MultiJson.load(body, symbolize_keys: true) end |
#refresh_token(refresh_token) ⇒ Object
91 92 93 94 95 96 |
# File 'lib/zoho_hub/auth.rb', line 91 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
74 75 76 77 78 79 80 81 82 83 84 85 |
# File 'lib/zoho_hub/auth.rb', line 74 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
98 99 100 101 102 103 104 105 106 107 108 |
# File 'lib/zoho_hub/auth.rb', line 98 def revoke_refresh_token(refresh_token) uri = token_full_uri uri.query_values = { token: refresh_token } url = Addressable::URI.unencode(uri.to_s) result = Faraday.post(url) parse(result.body) end |
#token_full_uri ⇒ Object
34 35 36 |
# File 'lib/zoho_hub/auth.rb', line 34 def token_full_uri Addressable::URI.join(api_domain, TOKEN_PATH) end |
#token_url(grant_token) ⇒ Object
60 61 62 63 64 65 66 67 68 69 70 71 72 |
# File 'lib/zoho_hub/auth.rb', line 60 def token_url(grant_token) uri = token_full_uri uri.query_values = { client_id: client_id, client_secret: secret, code: grant_token, redirect_uri: redirect_uri, grant_type: 'authorization_code' } Addressable::URI.unencode(uri.to_s) end |