Class: Inbox::API

Inherits:
Object
  • Object
show all
Defined in:
lib/inbox.rb,
lib/nylas.rb

Constant Summary collapse

OBJECTS_TABLE = 
{
  "account" => Inbox::Account,
  "calendar" => Inbox::Calendar,
  "draft" => Inbox::Draft,
  "thread" => Inbox::Thread,
  "contact" => Inbox::Contact,
  "event" => Inbox::Event,
  "file" => Inbox::File,
  "message" => Inbox::Message,
  "folder" => Inbox::Folder,
  "label" => Inbox::Label,
}
EXPANDED_OBJECTS_TABLE =

It’s possible to ask the API to expand objects. In this case, we do the right thing and return an expanded object.

{
  "message" => Inbox::ExpandedMessage,
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(app_id, app_secret, access_token = nil, api_server = 'https://api.nylas.com', service_domain = 'api.nylas.com') ⇒ API

Returns a new instance of API.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/inbox.rb', line 92

def initialize(app_id, app_secret, access_token = nil, api_server = 'https://api.nylas.com',
               service_domain = 'api.nylas.com')
  raise "When overriding the Inbox API server address, you must include https://" unless api_server.include?('://')
  @api_server = api_server
  @access_token = access_token
  @app_secret = app_secret
  @app_id = app_id
  @service_domain = service_domain
  @version = Inbox::VERSION

  if ::RestClient.before_execution_procs.empty?
    ::RestClient.add_before_execution_proc do |req, params|
      req.add_field('X-Inbox-API-Wrapper', 'ruby')
      req['User-Agent'] = "Nylas Ruby SDK #{@version} - #{RUBY_VERSION}"
    end
  end
end

Instance Attribute Details

#access_token ⇒ Object (readonly)

Returns the value of attribute access_token.



88
89
90
 
# File 'lib/inbox.rb', line 88

def access_token
  @access_token
end

#api_server ⇒ Object

Returns the value of attribute api_server.



87
88
89
 
# File 'lib/inbox.rb', line 87

def api_server
  @api_server
end

#app_id ⇒ Object (readonly)

Returns the value of attribute app_id.



89
90
91
 
# File 'lib/inbox.rb', line 89

def app_id
  @app_id
end

#app_secret ⇒ Object (readonly)

Returns the value of attribute app_secret.



90
91
92
 
# File 'lib/inbox.rb', line 90

def app_secret
  @app_secret
end

Instance Method Details

#_build_exclude_types(exclude_types) ⇒ Object 



250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/inbox.rb', line 250

def _build_exclude_types(exclude_types)
  exclude_string = "&exclude_types="

  exclude_types.each do |value|
    count = 0
    if OBJECTS_TABLE.has_value?(value)
      param_name = OBJECTS_TABLE.key(value)
      exclude_string += "#{param_name},"
    end
  end

  exclude_string = exclude_string[0..-2]
end

#account ⇒ Object 



193
194
195
196
197
198
199
200
201
202
 
# File 'lib/inbox.rb', line 193

def 
  path = self.url_for_path("/account")

  RestClient.get(path, {}) do |response,request,result|
    json = Inbox.interpret_response(result, response, {:expected_class => Object})
    model = APIAccount.new(self)
    model.inflate(json)
    model
  end
end

#accounts ⇒ Object 



208
209
210
211
212
213
214
 
# File 'lib/inbox.rb', line 208

def accounts
      if self.using_hosted_api?
           @accounts ||= ManagementModelCollection.new(Account, self)
      else
           @accounts ||= RestfulModelCollection.new(APIAccount, self)
      end
end

#calendars ⇒ Object 



177
178
179
 
# File 'lib/inbox.rb', line 177

def calendars
  @calendars ||= RestfulModelCollection.new(Calendar, self)
end

#contacts ⇒ Object 



173
174
175
 
# File 'lib/inbox.rb', line 173

def contacts
  @contacts ||= RestfulModelCollection.new(Contact, self)
end

#delta_stream(cursor, exclude_types = [], timeout = 0, expanded_view = false) ⇒ Object 



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/inbox.rb', line 318

def delta_stream(cursor, exclude_types=[], timeout=0, expanded_view=false)
  raise 'Please provide a block for receiving the delta objects' if !block_given?

  exclude_string = ""

  if exclude_types.any?
    exclude_string = _build_exclude_types(exclude_types)
  end

  # loop and yield deltas indefinitely.
  path = self.url_for_path("/delta/streaming?exclude_folders=false&cursor=#{cursor}#{exclude_string}")
  if expanded_view
    path += '&view=expanded'
  end

  parser = Yajl::Parser.new(:symbolize_keys => false)
  parser.on_parse_complete = proc do |data|
    delta = Inbox.interpret_response(OpenStruct.new(:code => '200'), data, {:expected_class => Object, :result_parsed => true})

    if not OBJECTS_TABLE.has_key?(delta['object'])
      next
    end

    cls = OBJECTS_TABLE[delta['object']]
    if EXPANDED_OBJECTS_TABLE.has_key?(delta['object']) and expanded_view
      cls = EXPANDED_OBJECTS_TABLE[delta['object']]
    end

    obj = cls.new(self)

    case delta["event"]
      when 'create', 'modify'
        obj.inflate(delta['attributes'])
        obj.cursor = delta["cursor"]
        yield delta["event"], obj
      when 'delete'
        obj.id = delta["id"]
        obj.cursor = delta["cursor"]
        yield delta["event"], obj
    end
  end

  http = EventMachine::HttpRequest.new(path, :connect_timeout => 0, :inactivity_timeout => timeout).get(:keepalive => true)

  # set a callback on the HTTP stream that parses incoming chunks as they come in
  http.stream do |chunk|
    parser << chunk
  end

  http.errback do
    raise UnexpectedResponse.new http.error
  end

end

#deltas(cursor, exclude_types = [], expanded_view = false) ⇒ Object 



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/inbox.rb', line 264

def deltas(cursor, exclude_types=[], expanded_view=false)
  return enum_for(:deltas, cursor, exclude_types, expanded_view) unless block_given?

  exclude_string = ""

  if exclude_types.any?
    exclude_string = _build_exclude_types(exclude_types)
  end

  # loop and yield deltas until we've come to the end.
  loop do
    path = self.url_for_path("/delta?exclude_folders=false&cursor=#{cursor}#{exclude_string}")
    if expanded_view
      path += '&view=expanded'
    end

    json = nil

    RestClient.get(path) do |response,request,result|
      json = Inbox.interpret_response(result, response, {:expected_class => Object})
    end

    start_cursor = json["cursor_start"]
    end_cursor = json["cursor_end"]

    json["deltas"].each do |delta|
      if not OBJECTS_TABLE.has_key?(delta['object'])
        next
      end

      cls = OBJECTS_TABLE[delta['object']]
      if EXPANDED_OBJECTS_TABLE.has_key?(delta['object']) and expanded_view
        cls = EXPANDED_OBJECTS_TABLE[delta['object']]
      end

      obj = cls.new(self)

      case delta["event"]
      when 'create', 'modify'
          obj.inflate(delta['attributes'])
          obj.cursor = delta["cursor"]
          yield delta["event"], obj
      when 'delete'
          obj.id = delta["id"]
          obj.cursor = delta["cursor"]
          yield delta["event"], obj
      end
    end

    break if start_cursor == end_cursor
    cursor = end_cursor
  end
end

#drafts ⇒ Object 



169
170
171
 
# File 'lib/inbox.rb', line 169

def drafts
  @drafts ||= RestfulModelCollection.new(Draft, self)
end

#events ⇒ Object 



181
182
183
 
# File 'lib/inbox.rb', line 181

def events
  @events ||= RestfulModelCollection.new(Event, self)
end

#files ⇒ Object 



165
166
167
 
# File 'lib/inbox.rb', line 165

def files
  @files ||= RestfulModelCollection.new(File, self)
end

#folders ⇒ Object 



185
186
187
 
# File 'lib/inbox.rb', line 185

def folders
  @folders ||= RestfulModelCollection.new(Folder, self)
end

#labels ⇒ Object 



189
190
191
 
# File 'lib/inbox.rb', line 189

def labels
  @labels ||= RestfulModelCollection.new(Label, self)
end

#latest_cursor ⇒ Object 



216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/inbox.rb', line 216

def latest_cursor
  # Get the cursor corresponding to a specific timestamp.
  path = self.url_for_path("/delta/latest_cursor")

  cursor = nil

  RestClient.post(path, :content_type => :json) do |response,request,result|
    json = Inbox.interpret_response(result, response, {:expected_class => Object})
    cursor = json["cursor"]
  end

  cursor
end

#messages ⇒ Object 



161
162
163
 
# File 'lib/inbox.rb', line 161

def messages
  @messages ||= RestfulModelCollection.new(Message, self)
end

#set_access_token(token) ⇒ Object 



138
139
140
 
# File 'lib/inbox.rb', line 138

def set_access_token(token)
  @access_token = token
end

#threads ⇒ Object

API Methods



157
158
159
 
# File 'lib/inbox.rb', line 157

def threads
  @threads ||= RestfulModelCollection.new(Thread, self)
end

#token_for_code(code) ⇒ Object 



142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/inbox.rb', line 142

def token_for_code(code)
  data = {
      'client_id' => app_id,
      'client_secret' => app_secret,
      'grant_type' => 'authorization_code',
      'code' => code
  }

  ::RestClient.post("https://#{@service_domain}/oauth/token", data) do |response, request, result|
    json = Inbox.interpret_response(result, response, :expected_class => Object)
    return json['access_token']
  end
end

#url_for_authentication(redirect_uri, login_hint = '', options = {}) ⇒ Object 



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/inbox.rb', line 116

def url_for_authentication(redirect_uri,  = '', options = {})
  params = {
    :client_id => @app_id,
    :trial => options.fetch(:trial, false),
    :response_type => 'code',
    :scope => 'email',
    :login_hint => ,
    :redirect_uri => redirect_uri,
  }

  if options.has_key?(:state) then
    params[:state] = options[:state]
  end

  "https://#{@service_domain}/oauth/authorize?" + params.to_query
end

#url_for_management ⇒ Object 



133
134
135
136
 
# File 'lib/inbox.rb', line 133

def url_for_management
  protocol, domain = @api_server.split('//')
  accounts_path = "#{protocol}//#{@app_secret}:@#{domain}/a/#{@app_id}/accounts"
end

#url_for_path(path) ⇒ Object

Raises:



110
111
112
113
114
 
# File 'lib/inbox.rb', line 110

def url_for_path(path)
  raise NoAuthToken.new if @access_token == nil and (@app_secret != nil or @app_id != nil)
  protocol, domain = @api_server.split('//')
  "#{protocol}//#{@access_token}:@#{domain}#{path}"
end

#using_hosted_api? ⇒ Boolean

Returns:

  • (Boolean) 


204
205
206
 
# File 'lib/inbox.rb', line 204

def using_hosted_api?
   return !@app_id.nil?
end