Module: NetSuite::Configuration

Extended by:
Configuration
Included in:
Configuration
Defined in:
lib/netsuite/configuration.rb

Instance Method Summary collapse

Instance Method Details

#account(account = nil) ⇒ Object 



217
218
219
220
221
222
223
 
# File 'lib/netsuite/configuration.rb', line 217

def ( = nil)
  if 
    self. = 
  else
    attributes[:account]
  end
end

#account=(account) ⇒ Object 



213
214
215
 
# File 'lib/netsuite/configuration.rb', line 213

def account=()
  attributes[:account] = 
end

#api_version(version = nil) ⇒ Object 



44
45
46
47
48
49
50
 
# File 'lib/netsuite/configuration.rb', line 44

def api_version(version = nil)
  if version
    self.api_version = version
  else
    attributes[:api_version] ||= '2011_2'
  end
end

#api_version=(version) ⇒ Object 



52
53
54
 
# File 'lib/netsuite/configuration.rb', line 52

def api_version=(version)
  attributes[:api_version] = version
end

#attributes ⇒ Object 



9
10
11
 
# File 'lib/netsuite/configuration.rb', line 9

def attributes
  @attributes ||= {}
end

#auth_header(credentials = {}) ⇒ Object 



125
126
127
128
129
130
131
 
# File 'lib/netsuite/configuration.rb', line 125

def auth_header(credentials={})
  if !credentials[:consumer_key].blank? || !consumer_key.blank?
    token_auth(credentials)
  else
    user_auth(credentials)
  end
end

#connection(params = {}, credentials = {}) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/netsuite/configuration.rb', line 13

def connection(params={}, credentials={})
  Savon.client({
    wsdl: wsdl,
    read_timeout: read_timeout,
    namespaces: namespaces,
    soap_header: auth_header(credentials).update(soap_header),
    pretty_print_xml: true,
    filters: filters,
    logger: logger,
    log_level: log_level,
    log: !silent, # turn off logging entirely if configured
  }.update(params))
end

#consumer_key(consumer_key = nil) ⇒ Object 



229
230
231
232
233
234
235
 
# File 'lib/netsuite/configuration.rb', line 229

def consumer_key(consumer_key = nil)
  if consumer_key
    self.consumer_key = consumer_key
  else
    attributes[:consumer_key]
  end
end

#consumer_key=(consumer_key) ⇒ Object 



225
226
227
 
# File 'lib/netsuite/configuration.rb', line 225

def consumer_key=(consumer_key)
  attributes[:consumer_key] = consumer_key
end

#consumer_secret(consumer_secret = nil) ⇒ Object 



241
242
243
244
245
246
247
 
# File 'lib/netsuite/configuration.rb', line 241

def consumer_secret(consumer_secret = nil)
  if consumer_secret
    self.consumer_secret = consumer_secret
  else
    attributes[:consumer_secret]
  end
end

#consumer_secret=(consumer_secret) ⇒ Object 



237
238
239
 
# File 'lib/netsuite/configuration.rb', line 237

def consumer_secret=(consumer_secret)
  attributes[:consumer_secret] = consumer_secret
end

#email(email = nil) ⇒ Object 



193
194
195
196
197
198
199
 
# File 'lib/netsuite/configuration.rb', line 193

def email(email = nil)
  if email
    self.email = email
  else
    attributes[:email]
  end
end

#email=(email) ⇒ Object 



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

def email=(email)
  attributes[:email] = email
end

#filters(list = nil) ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/netsuite/configuration.rb', line 27

def filters(list = nil)
  if list
    self.filters = list
  else
    attributes[:filters] ||= [
      :password,
      :email,
      :consumerKey,
      :token
    ]
  end
end

#filters=(list) ⇒ Object 



40
41
42
 
# File 'lib/netsuite/configuration.rb', line 40

def filters=(list)
  attributes[:filters] = list
end

#log(path = nil) ⇒ Object 



289
290
291
292
 
# File 'lib/netsuite/configuration.rb', line 289

def log(path = nil)
  self.log = path if path
  attributes[:log]
end

#log=(path) ⇒ Object 



285
286
287
 
# File 'lib/netsuite/configuration.rb', line 285

def log=(path)
  attributes[:log] = path
end

#log_level(value = nil) ⇒ Object 



311
312
313
314
 
# File 'lib/netsuite/configuration.rb', line 311

def log_level(value = nil)
  self.log_level = value || :debug
  attributes[:log_level]
end

#log_level=(value) ⇒ Object 



316
317
318
 
# File 'lib/netsuite/configuration.rb', line 316

def log_level=(value)
  attributes[:log_level] ||= value
end

#logger(value = nil) ⇒ Object 



294
295
296
297
298
299
300
 
# File 'lib/netsuite/configuration.rb', line 294

def logger(value = nil)
  attributes[:logger] = if value.nil?
    ::Logger.new((log && !log.empty?) ? log : $stdout)
  else
    value
  end
end

#namespaces ⇒ Object 



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/netsuite/configuration.rb', line 152

def namespaces
  {
    'xmlns:platformMsgs'   => "urn:messages_#{api_version}.platform.webservices.netsuite.com",
    'xmlns:platformCore'   => "urn:core_#{api_version}.platform.webservices.netsuite.com",
    'xmlns:platformCommon' => "urn:common_#{api_version}.platform.webservices.netsuite.com",
    'xmlns:listRel'        => "urn:relationships_#{api_version}.lists.webservices.netsuite.com",
    'xmlns:tranSales'      => "urn:sales_#{api_version}.transactions.webservices.netsuite.com",
    'xmlns:tranPurch'      => "urn:purchases_#{api_version}.transactions.webservices.netsuite.com",
    'xmlns:actSched'       => "urn:scheduling_#{api_version}.activities.webservices.netsuite.com",
    'xmlns:setupCustom'    => "urn:customization_#{api_version}.setup.webservices.netsuite.com",
    'xmlns:listAcct'       => "urn:accounting_#{api_version}.lists.webservices.netsuite.com",
    'xmlns:tranBank'       => "urn:bank_#{api_version}.transactions.webservices.netsuite.com",
    'xmlns:tranCust'       => "urn:customers_#{api_version}.transactions.webservices.netsuite.com",
    'xmlns:tranEmp'        => "urn:employees_#{api_version}.transactions.webservices.netsuite.com",
    'xmlns:tranInvt'       => "urn:inventory_#{api_version}.transactions.webservices.netsuite.com",
    'xmlns:listSupport'    => "urn:support_#{api_version}.lists.webservices.netsuite.com",
    'xmlns:tranGeneral'    => "urn:general_#{api_version}.transactions.webservices.netsuite.com",
    'xmlns:commGeneral'    => "urn:communication_#{api_version}.general.webservices.netsuite.com",
    'xmlns:listMkt'        => "urn:marketing_#{api_version}.lists.webservices.netsuite.com",
    'xmlns:listWebsite'    => "urn:website_#{api_version}.lists.webservices.netsuite.com",
    'xmlns:fileCabinet'    => "urn:filecabinet_#{api_version}.documents.webservices.netsuite.com",
    'xmlns:listEmp'        => "urn:employees_#{api_version}.lists.webservices.netsuite.com"
  }
end

#password(password = nil) ⇒ Object 



205
206
207
208
209
210
211
 
# File 'lib/netsuite/configuration.rb', line 205

def password(password = nil)
  if password
    self.password = password
  else
    attributes[:password]
  end
end

#password=(password) ⇒ Object 



201
202
203
 
# File 'lib/netsuite/configuration.rb', line 201

def password=(password)
  attributes[:password] = password
end

#read_timeout(timeout = nil) ⇒ Object 



277
278
279
280
281
282
283
 
# File 'lib/netsuite/configuration.rb', line 277

def read_timeout(timeout = nil)
  if timeout
    self.read_timeout = timeout
  else
    attributes[:read_timeout] ||= 60
  end
end

#read_timeout=(timeout) ⇒ Object 



273
274
275
 
# File 'lib/netsuite/configuration.rb', line 273

def read_timeout=(timeout)
  attributes[:read_timeout] = timeout
end

#reset! ⇒ Object 



5
6
7
 
# File 'lib/netsuite/configuration.rb', line 5

def reset!
  attributes.clear
end

#role(role = nil) ⇒ Object 



181
182
183
184
185
186
187
 
# File 'lib/netsuite/configuration.rb', line 181

def role(role = nil)
  if role
    self.role = role
  else
    attributes[:role] ||= '3'
  end
end

#role=(role) ⇒ Object 



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

def role=(role)
  attributes[:role] = role
end

#sandbox(flag = nil) ⇒ Object 



60
61
62
63
64
65
66
 
# File 'lib/netsuite/configuration.rb', line 60

def sandbox(flag = nil)
  if flag.nil?
    attributes[:flag] ||= false
  else
    self.sandbox = flag
  end
end

#sandbox=(flag) ⇒ Object 



56
57
58
 
# File 'lib/netsuite/configuration.rb', line 56

def sandbox=(flag)
  attributes[:flag] = flag
end

#sandbox? ⇒ Boolean

Returns:

  • (Boolean) 


68
69
70
 
# File 'lib/netsuite/configuration.rb', line 68

def sandbox?
  !!sandbox
end

#silent(value = nil) ⇒ Object 



302
303
304
305
 
# File 'lib/netsuite/configuration.rb', line 302

def silent(value=nil)
  self.silent = value if !value.nil?
  attributes[:silent]
end

#silent=(value) ⇒ Object 



307
308
309
 
# File 'lib/netsuite/configuration.rb', line 307

def silent=(value)
  attributes[:silent] ||= value
end

#soap_header(headers = nil) ⇒ Object 



117
118
119
120
121
122
123
 
# File 'lib/netsuite/configuration.rb', line 117

def soap_header(headers = nil)
  if headers
    self.soap_header = headers
  else
    attributes[:soap_header] ||= {}
  end
end

#soap_header=(headers) ⇒ Object 



113
114
115
 
# File 'lib/netsuite/configuration.rb', line 113

def soap_header=(headers)
  attributes[:soap_header] = headers
end

#token_auth(credentials) ⇒ Object 



142
143
144
145
146
147
148
149
150
 
# File 'lib/netsuite/configuration.rb', line 142

def token_auth(credentials)
  NetSuite::Passports::Token.new(
    credentials[:account] || ,
    credentials[:consumer_key] || consumer_key,
    credentials[:consumer_secret] || consumer_secret,
    credentials[:token_id] || token_id,
    credentials[:token_secret] || token_secret
  ).passport
end

#token_id(token_id = nil) ⇒ Object 



253
254
255
256
257
258
259
 
# File 'lib/netsuite/configuration.rb', line 253

def token_id(token_id = nil)
  if token_id
    self.token_id = token_id
  else
    attributes[:token_id]
  end
end

#token_id=(token_id) ⇒ Object 



249
250
251
 
# File 'lib/netsuite/configuration.rb', line 249

def token_id=(token_id)
  attributes[:token_id] = token_id
end

#token_secret(token_secret = nil) ⇒ Object 



265
266
267
268
269
270
271
 
# File 'lib/netsuite/configuration.rb', line 265

def token_secret(token_secret = nil)
  if token_secret
    self.token_secret = token_secret
  else
    attributes[:token_secret]
  end
end

#token_secret=(token_secret) ⇒ Object 



261
262
263
 
# File 'lib/netsuite/configuration.rb', line 261

def token_secret=(token_secret)
  attributes[:token_secret] = token_secret
end

#user_auth(credentials) ⇒ Object 



133
134
135
136
137
138
139
140
 
# File 'lib/netsuite/configuration.rb', line 133

def user_auth(credentials)
  NetSuite::Passports::User.new(
    credentials[:account] || ,
    credentials[:email] || email,
    credentials[:password] || password,
    credentials[:role] || role
  ).passport
end

#wsdl(wsdl = nil) ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/netsuite/configuration.rb', line 76

def wsdl(wsdl = nil)
  if wsdl
    self.wsdl = wsdl
  else
    attributes[:wsdl] ||= begin
      if sandbox
        "https://webservices.sandbox.netsuite.com/wsdl/v#{api_version}_0/netsuite.wsdl"
      else
        wsdl_path = File.expand_path("../../../wsdl/#{api_version}.wsdl", __FILE__)

        unless File.exists? wsdl_path
          wsdl_path = "https://#{wsdl_domain}/wsdl/v#{api_version}_0/netsuite.wsdl"
        end

        wsdl_path
      end
    end
  end
end

#wsdl=(wsdl) ⇒ Object 



72
73
74
 
# File 'lib/netsuite/configuration.rb', line 72

def wsdl=(wsdl)
  attributes[:wsdl] = wsdl
end

#wsdl_domain(wsdl_domain = nil) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/netsuite/configuration.rb', line 96

def wsdl_domain(wsdl_domain = nil)
  if wsdl_domain
    self.wsdl_domain = wsdl_domain
  else
    # if sandbox, this parameter is ignored
    if sandbox
      'webservices.sandbox.netsuite.com'
    else
      attributes[:wsdl_domain] ||= 'webservices.netsuite.com'
    end
  end
end

#wsdl_domain=(wsdl_domain) ⇒ Object 



109
110
111
 
# File 'lib/netsuite/configuration.rb', line 109

def wsdl_domain=(wsdl_domain)
  attributes[:wsdl_domain] = wsdl_domain
end