Class: QboApi

Inherits:
Object
  • Object
show all
Extended by:
Configuration
Includes:
Entity, Supporting, Util
Defined in:
lib/qbo_api/error.rb,
lib/qbo_api.rb,
lib/qbo_api/util.rb,
lib/qbo_api/entity.rb,
lib/qbo_api/version.rb,
lib/qbo_api/supporting.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. 429 Too Many Requests API Throttling/ Rate limiting 500 Internal Server Error An error occurred 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, Supporting, Util Classes: BadRequest, Error, Forbidden, InternalServerError, NotFound, NotImplementedError, ServiceUnavailable, TooManyRequests, 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.3.0"

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Configuration

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

Methods included from Util

#add_params_to_path, #add_request_id_to, #build_all_query, #cdc_time, #esc, #join_or_start_where_clause!, #uuid

Methods included from Entity

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

Methods included from Supporting

#batch, #cdc, #reports

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.



31
32
33
34
35
36
37
38
39
 
# File 'lib/qbo_api.rb', line 31

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.



21
22
23
 
# File 'lib/qbo_api.rb', line 21

def realm_id
  @realm_id
end

Instance Method Details

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



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

def all(entity, max: 1000, select: nil, inactive: false, &block)
  select = build_all_query(entity, select: select, inactive: inactive)
  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 



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/qbo_api.rb', line 41

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 



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

def create(entity, payload:)
  request(:post, entity: entity, path: entity_path(entity), payload: payload)
end

#deactivate(entity, id:) ⇒ Object

Raises:



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

def deactivate(entity, id:)
  err_msg = "Deactivate is only for name list entities. Use .delete instead"
  raise QboApi::NotImplementedError.new, err_msg unless is_name_list_entity?(entity)
  payload = set_update(entity, id).merge('sparse': true, 'Active': false)
  request(:post, entity: entity, path: entity_path(entity), payload: payload)
end

#delete(entity, id:) ⇒ Object

Raises:



73
74
75
76
77
78
79
 
# File 'lib/qbo_api.rb', line 73

def delete(entity, id:)
  err_msg = "Delete is only for transaction entities. Use .deactivate instead"
  raise QboApi::NotImplementedError.new, err_msg unless is_transaction_entity?(entity)
  path = add_params_to_path(path: entity_path(entity), params: { 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_quickbooks_online/0100_essentials/0085_develop_quickbooks_apps/0004_authentication_and_authorization/oauth_management_api#/Reconnect



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

def disconnect
  path = "#{APP_CONNECTION_URL}/disconnect"
  request(:get, path: path)
end

#get(entity, id) ⇒ Object 



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

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

#query(query) ⇒ Object 



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

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

#reconnect ⇒ Object 



95
96
97
98
 
# File 'lib/qbo_api.rb', line 95

def reconnect
  path = "#{APP_CONNECTION_URL}/reconnect"
  request(:get, path: path)
end

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



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

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

#response(resp, entity: nil) ⇒ Object 



125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/qbo_api.rb', line 125

def response(resp, entity: nil)
  data = JSON.parse(resp.body)
  if entity
    entity_response(data, entity)
  else
    data
  end
rescue => e
  # Catch fetch key errors and just return JSON
  data
end

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



68
69
70
71
 
# File 'lib/qbo_api.rb', line 68

def update(entity, id:, payload:)
  payload.merge!(set_update(entity, id))
  request(:post, entity: entity, path: entity_path(entity), payload: payload)
end