netsuite_api 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 007d3e8a1e0314c293ea7be440ec1565a58442402f783416ec6c62977424773d
-  data.tar.gz: 72420ff8f2a764d7eb5278e76ddfee5ed1f17eb3039277cdeb166f25503a88a9
+  metadata.gz: b861b814e33ac144071c716dddf8521a841f93b326bb6fd7e5f8ebb8080adfac
+  data.tar.gz: c94c8a38c727d9bad116b7191e518e95c5651a2c675d308b45ccc7c798599846
 SHA512:
-  metadata.gz: fa6d2859d5376a90bb0a5808e902dcbd5c3dd77c0cb89f1c1b2df1a56c1edf743f5a4a8b37e77ee4a43d2c97bba829a96f9baf297e85feec51c3563ca4a0a346
-  data.tar.gz: 74aeef7a92fa667dc3a10fdd2594fa827d5a8b8d73db536899f0079dbac80ec9b61b168031a7d1fd9d99a671f32be28f0666f85474e4fdff1f459544548ce87c
+  metadata.gz: d1d3d8c063ad9d921f83d18a5c63d06b69337a6b57561c731c3c79675f9e22c32ee484be749a61e9c621c5498a15bb369e479329c688a386c06234d98fd4b2f8
+  data.tar.gz: 793115ac5a261d39fd397793fee6beda66be7c89d98e923db73c8e0a368cbc0200da8d3e621cc18af4f79406c09a8fcfcb34d08c2a5555af376c07b6440bd11d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    netsuite_api (0.1.2)
+    netsuite_api (0.1.4)
       activesupport
       faraday
       securerandom
@@ -9,38 +9,58 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.7.10)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+    activesupport (8.0.1)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
     base64 (0.2.0)
-    bigdecimal (3.1.8)
-    concurrent-ruby (1.3.4)
+    benchmark (0.4.0)
+    bigdecimal (3.1.9)
+    coderay (1.1.3)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.0)
     crack (1.0.0)
       bigdecimal
       rexml
-    diff-lcs (1.5.1)
-    faraday (2.8.1)
-      base64
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.2)
-    hashdiff (1.1.1)
-    i18n (1.14.6)
+    diff-lcs (1.6.0)
+    drb (2.2.1)
+    faraday (2.12.2)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-net_http (3.4.0)
+      net-http (>= 0.5.0)
+    hashdiff (1.1.2)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    minitest (5.25.1)
-    public_suffix (5.1.1)
+    json (2.10.1)
+    logger (1.6.6)
+    method_source (1.1.0)
+    minitest (5.25.4)
+    net-http (0.6.0)
+      uri
+    pry (0.15.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (6.0.1)
     rake (10.5.0)
-    rexml (3.3.9)
+    rexml (3.4.1)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.2)
+    rspec-core (3.13.3)
       rspec-support (~> 3.13.0)
     rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -48,26 +68,27 @@ GEM
     rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
-    ruby2_keywords (0.0.5)
-    securerandom (0.3.1)
+    rspec-support (3.13.2)
+    securerandom (0.4.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    webmock (3.24.0)
+    uri (1.0.2)
+    webmock (3.25.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.6.18)
 
 PLATFORMS
+  arm64-darwin-22
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  bundler
   netsuite_api!
+  pry
   rake (~> 10.0)
   rspec (~> 3.0)
   webmock (~> 3.0)
 
 BUNDLED WITH
-   1.17.2
+   2.5.9

data/README.md

@@ -1,14 +1,17 @@
 # NetsuiteApi
 
 This library is designed to help ruby/rails based applications communicate with the publicly available REST API for NetSuite.
+
 If you are unfamiliar with the NetSuite REST API, you should first read the documentation located at [SuiteTalk REST Web Services API Guide](https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/book_1559132836.html).
 
+The NetSuite REST API document could be found at [NetSuite REST API Browser: Record API v1](https://system.netsuite.com/help/helpcenter/en_US/APIs/REST_API_Browser/record/v1/2024.1/index.html#tag-account)
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'netsuite_api'
+gem 'netsuite_api', '0.1.4'
 ```
 
 And then execute:
@@ -19,9 +22,106 @@ Or install it yourself as:
 
     $ gem install netsuite_api
 
-## Usage
+## Basic Usage
+
+### Setup Credential Information
+
+Set All the credential information in your project .env file
+```
+NETSUITE_HOST = ""
+NETSUITE_ACCOUNT_ID = ""
+NETSUITE_CONSUMER_KEY = ""
+NETSUITE_CONSUMER_SECRET = ""
+NETSUITE_TOKEN = ""
+NETSUITE_TOKEN_SECRET = ""
+NETSUITE_PDF_HOST =
+```
+
+or pass those information when initialize NetsuiteApi instance, for example, initializing NetsuiteApi::Invoice
+```
+NetsuiteApi::Invoice.new(netsuite_host: "", netsuite_pdf_host: "", account_id: "", consumer_key: "", token: "", token_secret: "", consumer_secret: "")
+```
+
+## NetsuiteApi Object Usage
+
+There are 7 objects could be used: `NetsuiteApi::Invoice`, `NetsuiteApi::CreditMemo`, `NetsuiteApi::Payment`, `NetsuiteApi::Customer`, `NetsuiteApi::Contact`, `NetsuiteApi::Vendor`, `NetsuiteApi::VendorBill`. 
+
+More information about the objects could be found in `lib/netsuite_api`.
+
+All the objects have method to get record, create data, update data, delete data in NetSuite through Netsuite REST API. 
+
+Following section shows an example of using `NetsuiteApi::Invoice`. The way to use other objects is similar.
+
+### Get data
+
+* Get a specific invoice data. 
+```
+service = NetsuiteApi::Invoice.new
+service.get(netsuite_invoice_id)
+```
+
+* Query some invoice data.
+```
+# query invoices which entity is 12
+
+service = NetsuiteApi::Invoice.new
+query_params = { "q" => "entity EQUAL 12" }
+service.query(query_params)
+```
+More information about the query parameters could be found in [Record Collection Filtering](https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_1545222128.html#Record-Collection-Filtering)
+
+
+### Create data
+
+* Create an invoice
+```
+service = NetsuiteApi::Invoice.new
+params = {
+    "entity" => {
+        "id" => "12"
+    },
+    "postingperiod" => "121",
+    "item" => {
+        "items" => [
+            {
+                "amount" => 100.0,
+                "item" => {
+                    "id" => "26"
+                }
+            }
+        ]
+    },
+    "subsidiary" => {
+        "id" => "8"
+    },
+    "currency" => {
+        "id": "2"
+    }
+}
+service.create(invoice_params)
+```
+
+
+### Update data
+
+* Update an invoice
+```
+service = NetsuiteApi::Invoice.new
+update_params = { "otherRefNum": "1234" }
+invoice_id = 1
+service.update(invoice_id, update_params)
+```
+
+
+### Delete data
+
+* Delete an invoice
+```
+service = NetsuiteApi::Invoice.new
+invoice_id = 1
+service.delete(invoice_id)
+```
 
-TODO: Write usage instructions here
 
 ## Development
 
@@ -31,7 +131,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/netsuite_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/iceland101113/netsuite_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/lib/netsuite_api/base.rb

@@ -1,7 +1,8 @@
 require 'faraday'
 require 'securerandom'
 require 'active_support/core_ext/object'
-require "pry"
+require 'base64'
+# require "pry"
 
 module NetsuiteApi
   class Base
@@ -31,8 +32,12 @@ module NetsuiteApi
     private
 
     def connection(host)
-      conn = Faraday.new(url: host) do |faraday|
+      Faraday.new(url: host) do |faraday|
+        faraday.request :json # handle JSON payload
+        faraday.response :logger, NetsuiteApi.logger if NetsuiteApi.logger
         faraday.adapter Faraday.default_adapter
+        faraday.options.timeout = 10 # 10 seconds timeout
+        faraday.options.open_timeout = 5 # 5 seconds open timeout
         faraday.ssl.verify = true # You can set this to false if you have SSL verification issues
       end
     end
@@ -42,15 +47,10 @@ module NetsuiteApi
     end
 
     def authorization_header(url, method, query_params, host:)
-      "OAuth realm=\"#{account_id}\",oauth_consumer_key=\"#{consumer_key}\",oauth_token=\"#{token}\",oauth_signature_method=\"HMAC-SHA256\",oauth_timestamp=\"#{oauth_timestamp}\",oauth_nonce=\"#{oauth_nonce}\",oauth_version=\"1.0\",oauth_signature=\"#{generate_oauth_signature(url, method, query_params, host: host)}\""
-    end
+      timestamp = Time.now.to_i
+      nonce = SecureRandom.hex(16)
 
-    def oauth_nonce
-      @oauth_nonce = SecureRandom.hex(16)
-    end
-  
-    def oauth_timestamp
-      @oauth_timestamp = Time.now.to_i
+      "OAuth realm=\"#{account_id}\",oauth_consumer_key=\"#{consumer_key}\",oauth_token=\"#{token}\",oauth_signature_method=\"HMAC-SHA256\",oauth_timestamp=\"#{timestamp}\",oauth_nonce=\"#{nonce}\",oauth_version=\"1.0\",oauth_signature=\"#{generate_oauth_signature(url, method, query_params, host: host, timestamp: timestamp, nonce: nonce)}\""
     end
   
     def full_url(url, query_params)
@@ -65,14 +65,14 @@ module NetsuiteApi
       CGI.escape(url)
     end
   
-    def generate_oauth_signature(url, http_method, query_params, host:)
+    def generate_oauth_signature(url, http_method, query_params, host:, timestamp:, nonce:)
       # Step 1: Combine parameters
       all_params = {
         'oauth_consumer_key' => consumer_key,
         'oauth_token' => token,
         'oauth_signature_method' => 'HMAC-SHA256',
-        'oauth_timestamp' => @oauth_timestamp,
-        'oauth_nonce' => @oauth_nonce, # Generate a random nonce
+        'oauth_timestamp' => timestamp,
+        'oauth_nonce' => nonce, # Generate a random nonce
         'oauth_version' => '1.0'
       }
       all_params.merge!(query_params) if query_params
@@ -90,7 +90,7 @@ module NetsuiteApi
       digest = OpenSSL::Digest.new('sha256')
       hmac = OpenSSL::HMAC.digest(digest, signing_key, sbs)
       
-      oauth_signature = CGI.escape(Base64.encode64(hmac).chomp.gsub('\n', ''))
+      oauth_signature = CGI.escape(::Base64.encode64(hmac).chomp.gsub('\n', ''))
     
       oauth_signature
     end

data/lib/netsuite_api/concerns/response_handler.rb

@@ -1,11 +1,14 @@
+require 'pry'
+
 module NetsuiteApi
   module Concerns
     module ResponseHandler
       class NetSuiteApiError < StandardError
         attr_reader :title, :details
-        def initialize(msg, title, details)
+        def initialize(title, details)
           @title = title
           @details = details
+          msg = "#{title}: #{details}"
           super(msg)
         end
       end
@@ -20,7 +23,13 @@ module NetsuiteApi
     
       def post_and_patch_response_handler(response)
         if response.success?
-          response.headers["location"].split('/').last
+          location = response.headers["location"]
+          if location
+            location.split('/').last
+          else
+            NetsuiteApi.logger.error("NetSuite API Error: No location header in response")
+            nil
+          end
         else
           error_handler(response)
         end
@@ -35,8 +44,17 @@ module NetsuiteApi
       end
 
       def error_handler(response)
-        response_body = JSON.parse(response.body)
-        raise NetSuiteApiError.new(response_body["title"], response_body["title"], response_body["o:errorDetails"])
+        begin
+          response_body = JSON.parse(response.body)
+          title = response_body["title"] || "NetSuite API Error"
+          details = response_body["o:errorDetails"] || "No additional details provided."
+        rescue JSON::ParserError
+          title = "Invalid API Response"
+          details = response.body.to_s.strip.empty? ? "Empty response body" : response.body
+        end
+
+        NetsuiteApi.logger.error("NetSuite API Error: #{title} - #{details}")
+        raise NetSuiteApiError.new(title, details)
       end
     end
   end

data/lib/netsuite_api/version.rb

@@ -1,3 +1,3 @@
 module NetsuiteApi
-  VERSION = "0.1.3"
+  VERSION = "0.1.5"
 end

data/lib/netsuite_api.rb

@@ -6,11 +6,16 @@ require "netsuite_api/contact"
 require "netsuite_api/payment"
 require "netsuite_api/vendor"
 require "netsuite_api/vendor_bill"
-require "pry"
+require "logger"
+# require "pry"
 
 module NetsuiteApi
-  # class Error < StandardError; end
-  # Your code goes here...
+  class << self
+    attr_accessor :logger
+  end
+
+  # 預設 Logger 為 STDOUT
+  self.logger = Logger.new(STDOUT)
 
   def self.hi
     "Hello World!"

data/netsuite_api.gemspec

@@ -34,11 +34,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "webmock", "~> 3.0"
-  # spec.add_development_dependency "pry", 
+  spec.add_development_dependency "pry"
   spec.add_dependency "faraday"
   spec.add_dependency "activesupport"
   spec.add_dependency "securerandom"

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: netsuite_api
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - HueiYi Lucy Cheng
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-07 00:00:00.000000000 Z
+date: 2025-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -147,7 +161,7 @@ metadata:
   homepage_uri: https://github.com/iceland101113/netsuite_api
   source_code_uri: https://github.com/iceland101113/netsuite_api
   changelog_uri: https://github.com/iceland101113/netsuite_api
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -162,8 +176,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.5.9
+signing_key:
 specification_version: 4
 summary: Ruby Library for NetSuite REST API.
 test_files: []