Completed
Push — master ( 06da27...dcbb75 )
by John
01:30
created

Client.token()   A

Complexity

Conditions 2

Size

Total Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 2
dl 0
loc 3
rs 10
c 0
b 0
f 0
1
require 'base64'
2
require 'faraday'
3
require 'faraday_middleware'
4
require 'faraday_middleware/oauth2_refresh'
5
require 'oauth2'
6
7
require 'pp'
8
9
module RingCentralSdk::REST
10
  class Client
11
    ACCESS_TOKEN_TTL  = 600             # 10 minutes
12
    REFRESH_TOKEN_TTL = 36000           # 10 hours
13
    REFRESH_TOKEN_TTL_REMEMBER = 604800 # 1 week
14
    ACCOUNT_PREFIX    = '/account/'
15
    ACCOUNT_ID        = '~'
16
    AUTHZ_ENDPOINT    = '/restapi/oauth/authorize'
17
    TOKEN_ENDPOINT    = '/restapi/oauth/token'
18
    REVOKE_ENDPOINT   = '/restapi/oauth/revoke'
19
    API_VERSION       = 'v1.0'
20
    URL_PREFIX        = '/restapi'
21
    DEFAULT_LANGUAGE  = 'en-us'
22
23
    attr_reader :app_config
24
    attr_reader :http
25
    attr_reader :oauth2client
26
    attr_reader :user_agent
27
    attr_reader :messages
28
29
    attr_reader :instance_headers
30
31
    def initialize(app_key='', app_secret='', server_url=RingCentralSdk::RC_SERVER_SANDBOX, opts={})
32
      init_attributes()
33
      self.set_app_config( RingCentralSdk::REST::ConfigApp.new(
34
        app_key, app_secret, server_url, opts) )
35
36
      if opts.key?(:username) && opts.key?(:password)
37
        extension = opts.key?(:extension) ? opts[:extension] : ''
38
        authorize_password(opts[:username], extension, opts[:password])
39
      end
40
41
      @instance_headers = opts[:headers] || {}
42
43
      @messages = RingCentralSdk::REST::Messages.new self
44
    end
45
46
    def set_app_config(new_app_config)
47
      @app_config = new_app_config
48
      @oauth2client = new_oauth2_client()
49
    end
50
51
    def init_attributes()
52
      @http = nil
53
      @user_agent = get_user_agent()
54
    end
55
56
    def api_version_url()
57
      return @app_config.server_url + URL_PREFIX + '/' + API_VERSION 
58
    end
59
60
    def create_url(url, add_server=false, add_method=nil, add_token=false)
61
      built_url = ''
62
      has_http = !url.index('http://').nil? && !url.index('https://').nil?
63
64
      if add_server && ! has_http
65
        built_url += @app_config.server_url
66
      end
67
68
      if url.index(URL_PREFIX).nil? && ! has_http
69
        built_url += URL_PREFIX + '/' + API_VERSION + '/'
70
      end
71
72
      if url.index('/') == 0
73
        if built_url =~ /\/$/
74
          built_url += url.gsub(/^\//, '')
75
        else
76
          built_url += url
77
        end
78
      else # no /
79
        if built_url =~ /\/$/
80
          built_url += url
81
        else
82
          built_url += '/' + url
83
        end
84
      end
85
86
      return built_url
87
    end
88
89
    def create_urls(urls, add_server=false, add_method=nil, add_token=false)
90
      unless urls.is_a?(Array)
91
        raise "URLs is not an array"
92
      end
93
      built_urls = []
94
      urls.each do |url|
95
        built_urls.push(create_url(url, add_server, add_method, add_token))
96
      end
97
      return built_urls
98
    end
99
100
    def authorize_url(opts = {})
101
      @oauth2client.auth_code.authorize_url(_add_redirect_uri(opts))
102
    end
103
104
    def authorize_code(code, params = {})
105
      token = @oauth2client.auth_code.get_token(code, _add_redirect_uri(params))
106
      set_token(token)
107
      return token
108
    end
109
110
    def _add_redirect_uri(opts = {})
111
      if !opts.key?(:redirect_uri) && @app_config.redirect_url.to_s.length > 0
112
        opts[:redirect_uri] = @app_config.redirect_url.to_s
113
      end
114
      return opts
115
    end
116
117
    def authorize_password(username, extension = '', password = '', params = {})
118
      token = @oauth2client.password.get_token(username, password, {
119
        extension: extension,
120
        headers: {'Authorization' => 'Basic ' + get_api_key()}}.merge(params))
121
      set_token(token)
122
      return token
123
    end
124
125
    def authorize_user(user, params = {})
126
      authorize_password(user.username, user.extension, user.password, params)
127
    end
128
129
    def token
130
      return @http ? @http.builder.app.oauth2_token : nil
131
    end
132
133
    def set_token(token)
134
      if token.is_a? Hash
135
        token = OAuth2::AccessToken::from_hash(@oauth2client, token)
136
      end
137
138
      unless token.is_a? OAuth2::AccessToken
139
        raise "Token is not a OAuth2::AccessToken"
140
      end
141
142
      @http = Faraday.new(url: api_version_url()) do |conn|
143
        conn.request :oauth2_refresh, token
144
        conn.request :multipart
145
        conn.request :url_encoded
146
        conn.request :json
147
        conn.headers['User-Agent'] = @user_agent
148
        if @instance_headers.is_a? Hash 
149
          @instance_headers.each do |k,v|
150
            conn.headers[k] = v
151
          end
152
        end
153
        conn.headers['RC-User-Agent'] = @user_agent
154
        conn.headers['SDK-User-Agent'] = @user_agent
155
        conn.response :json, content_type: /\bjson$/
156
        conn.response :logger
157
        conn.adapter Faraday.default_adapter
158
      end
159
    end
160
161
    def new_oauth2_client()
162
      return OAuth2::Client.new(@app_config.key, @app_config.secret,
163
        site: @app_config.server_url,
164
        authorize_url: AUTHZ_ENDPOINT,
165
        token_url: TOKEN_ENDPOINT)
166
    end
167
168
    def set_oauth2_client(client=nil)
169
      if client.nil?
170
        @oauth2client = new_oauth2_client()
171
      elsif client.is_a? OAuth2::Client
172
        @oauth2client = client
173
      else
174
        fail "client is not an OAuth2::Client"
175
      end
176
    end
177
178
    def get_api_key()
179
      api_key = (@app_config.key.is_a?(String) && @app_config.secret.is_a?(String)) \
180
        ? Base64.encode64("#{@app_config.key}:#{@app_config.secret}").gsub(/\s/,'') : ''
181
      return api_key
182
    end
183
184
    def send_request(request_sdk = {})
185
      if request_sdk.is_a? Hash
186
        request_sdk = RingCentralSdk::REST::Request::Simple.new(request_sdk)
187
      elsif !request_sdk.is_a? RingCentralSdk::REST::Request::Base
188
        fail 'Request is not a RingCentralSdk::REST::Request::Base'
189
      end
190
191
      method = request_sdk.method.to_s.downcase
192
      method = 'get' if method.empty?
193
194
      res = nil
195
196
      case method
197
      when 'delete'
198
        res = @http.delete { |req| req = inflate_request(req, request_sdk) }
199
      when 'get'
200
        res = @http.get { |req| req = inflate_request(req, request_sdk) }
201
      when 'post'
202
        res = @http.post { |req| req = inflate_request(req, request_sdk) }
203
      when 'put'
204
        res = @http.put { |req| req = inflate_request(req, request_sdk) }
205
      else
206
        fail "method [#{method}] not supported"
207
      end
208
      return res
209
    end
210
211
    def inflate_request(req_faraday, req_sdk)
212
      req_faraday.url req_sdk.url
213
      req_faraday.body = req_sdk.body if req_sdk.body
214
      if req_sdk.params.is_a? Hash 
215
        req_sdk.params.each { |k,v| req_faraday.params[k] = v }
216
      end
217
      if req_sdk.headers.is_a? Hash 
218
        req_sdk.headers.each { |k,v| req_faraday.headers[k] = v }
219
      end
220
221
      ct = req_sdk.content_type
222
      if !ct.nil? && ct.to_s.length > 0
223
        req_faraday.headers['Content-Type'] = ct.to_s
224
      end
225
      return req_faraday
226
    end
227
228
    def get_user_agent()
229
      ua = "ringcentral-sdk-ruby/#{RingCentralSdk::VERSION} %s/%s %s" % [
230
        (RUBY_ENGINE rescue nil or "ruby"),
231
        RUBY_VERSION,
232
        RUBY_PLATFORM
233
      ]
234
      return ua.strip
235
    end
236
237
    def create_subscription()
238
      return RingCentralSdk::REST::Subscription.new(self)
239
    end
240
241
    alias_method :authorize, :authorize_password
242
    alias_method :login, :authorize_password
243
    private :api_version_url
244
  end
245
end
246