Class: QboApi

Inherits:
Object
  • Object
show all
Extended by:
Configuration
Includes:
Entity
Defined in:
lib/qbo_api/error.rb,
lib/qbo_api.rb,
lib/qbo_api/entity.rb,
lib/qbo_api/version.rb,
lib/qbo_api/configuration.rb

Overview

200 OK The request succeeded. However, the response body may contain a <Fault> element, indicating an error. 400 Bad request Generally, the request cannot be fulfilled due to bad syntax. In some cases, this response code is returned for a request with bad authorization data.

401 Unauthorized Authentication or authorization has failed. 403 Forbidden The resource is forbidden. 404 Not Found The resource is not found. 500 Internal Server Error An error occured on the server while processing the request. Resubmit request once; if it persists, contact developer support. 503 Service Unavailable The service is temporarily unavailable. Custom error class for rescuing from all QuickBooks Online errors

Defined Under Namespace

Modules: Configuration, Entity Classes: BadRequest, Error, Forbidden, InternalServerError, NotFound, NotImplementedError, ServiceUnavailable, Unauthorized

Constant Summary collapse

REQUEST_TOKEN_URL = 
'https://oauth.intuit.com/oauth/v1/get_request_token'
ACCESS_TOKEN_URL = 
'https://oauth.intuit.com/oauth/v1/get_access_token'
APP_CENTER_BASE = 
'https://appcenter.intuit.com'
APP_CENTER_URL = 
APP_CENTER_BASE + '/Connect/Begin?oauth_token='
V3_ENDPOINT_BASE_URL = 
'https://sandbox-quickbooks.api.intuit.com/v3/company/'
PAYMENTS_API_BASE_URL = 
'https://sandbox.api.intuit.com/quickbooks/v4/payments'
APP_CONNECTION_URL = 
APP_CENTER_BASE + '/api/v1/connection'
VERSION = 
"1.0.0"

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Configuration

log, log=, logger, logger=, production, production=

Methods included from Entity

#extract_entity_from_query, #is_name_list_entity?, #is_transaction_entity?, #name_list_entities, #singular, #snake_to_camel, #supporting_entities, #transaction_entities

Constructor Details

#initialize(token:, token_secret:, realm_id:, consumer_key: CONSUMER_KEY, consumer_secret: CONSUMER_SECRET, endpoint: :accounting) ⇒ QboApi

Returns a new instance of QboApi.



26
27
28
29
30
31
32
33
34
 
# File 'lib/qbo_api.rb', line 26

def initialize(token:, token_secret:, realm_id:, consumer_key: CONSUMER_KEY, 
               consumer_secret: CONSUMER_SECRET, endpoint: :accounting)
  @consumer_key = consumer_key
  @consumer_secret = consumer_secret
  @token = token
  @token_secret = token_secret
  @realm_id = realm_id
  @endpoint = endpoint
end

Instance Attribute Details

#realm_id ⇒ Object (readonly)

Returns the value of attribute realm_id.



16
17
18
 
# File 'lib/qbo_api.rb', line 16

def realm_id
  @realm_id
end

Instance Method Details

#all(entity, max: 1000, select: nil, &block) ⇒ Object 



87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/qbo_api.rb', line 87

def all(entity, max: 1000, select: nil, &block)
  select ||= "SELECT * FROM #{singular(entity)}"
  pos = 0
  begin
    pos = pos == 0 ? pos + 1 : pos + max
    results = query("#{select} MAXRESULTS #{max} STARTPOSITION #{pos}")
    results.each do |entry|
      yield(entry)
    end if results
  end while (results ? results.size == max : false)
end

#connection(url: get_endpoint) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/qbo_api.rb', line 36

def connection(url: get_endpoint)
  Faraday.new(url: url) do |faraday|
    faraday.headers['Content-Type'] = 'application/json;charset=UTF-8'
    faraday.headers['Accept'] = "application/json"
    faraday.request :oauth, oauth_data 
    faraday.request :url_encoded
    faraday.use FaradayMiddleware::RaiseHttpException
    faraday.response :detailed_logger, QboApi.logger if QboApi.log
    faraday.adapter  Faraday.default_adapter
  end
end

#create(entity, payload:) ⇒ Object 



59
60
61
62
 
# File 'lib/qbo_api.rb', line 59

def create(entity, payload:)
  path = "#{realm_id}/#{entity}"
  request(:post, entity: entity, path: path, payload: payload)
end

#delete(entity, id:) ⇒ Object

Raises:



70
71
72
73
74
75
 
# File 'lib/qbo_api.rb', line 70

def delete(entity, id:)
  raise QboApi::NotImplementedError unless is_transaction_entity?(entity)
  path = "#{realm_id}/#{entity}?operation=delete"
  payload = set_update(entity, id)
  request(:post, entity: entity, path: path, payload: payload)
end

#disconnect ⇒ Object

TODO: Need specs for disconnect and reconnect developer.intuit.com/docs/0100_accounting/0060_authentication_and_authorization/oauth_management_api



79
80
81
 
# File 'lib/qbo_api.rb', line 79

def disconnect
  response = connection(url: APP_CONNECTION_URL).get('/disconnect')
end

#esc(query) ⇒ Object 



128
129
130
 
# File 'lib/qbo_api.rb', line 128

def esc(query)
  query.gsub("'", "\\\\'")
end

#get(entity, id) ⇒ Object 



54
55
56
57
 
# File 'lib/qbo_api.rb', line 54

def get(entity, id)
  path = "#{realm_id}/#{entity.to_s}/#{id}"
  request(:get, entity: entity, path: path)
end

#query(query) ⇒ Object 



48
49
50
51
52
 
# File 'lib/qbo_api.rb', line 48

def query(query)
  path = "#{realm_id}/query?query=#{query}"
  entity = extract_entity_from_query(query, to_sym: true)
  request(:get, entity: entity, path: path)
end

#reconnect ⇒ Object 



83
84
85
 
# File 'lib/qbo_api.rb', line 83

def reconnect
  response = connection(url: APP_CONNECTION_URL).get('/reconnect')
end

#request(method, entity:, path:, payload: nil) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/qbo_api.rb', line 99

def request(method, entity:, path:, payload: nil)
  raw_response = connection.send(method) do |req|
    case method
    when :get, :delete
      req.url URI.encode(path)
    when :post, :put
      req.url path
      req.body = JSON.generate(payload)
    end
  end
  response(raw_response, entity: entity)
end

#response(resp, entity: nil) ⇒ Object 



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/qbo_api.rb', line 112

def response(resp, entity: nil)
  j = JSON.parse(resp.body)
  if entity
    if qr = j['QueryResponse']
      qr.empty? ? nil : qr.fetch(singular(entity))
    else
      j.fetch(singular(entity))
    end
  else
    j
  end
rescue => e
  # Catch fetch key errors and just return JSON
  j
end

#update(entity, id:, payload:) ⇒ Object 



64
65
66
67
68
 
# File 'lib/qbo_api.rb', line 64

def update(entity, id:, payload:)
  path = "#{realm_id}/#{entity}"
  payload.merge!(set_update(entity, id))
  request(:post, entity: entity, path: path, payload: payload)
end