netsuite 0.5.7 → 0.5.8

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NDQwMWNkMzVjNmRhNGMxODE4MTdkODQyMmQ4OWNlYTFjNzNiZDA0Nw==
-  data.tar.gz: !binary |-
-    YWMzMjc0NTgwYWQ1MzY2NDExMWI4YmVhYjE0NTNkOGIzZWRmNjJiMA==
+SHA1:
+  metadata.gz: 63eeb2f2515c54bab1663a2683ed3f234f978d44
+  data.tar.gz: 6aaf5ad5cb70cdfb433a4a9c6c9798f2cf6c29ba
 SHA512:
-  metadata.gz: !binary |-
-    OWM2NTA4ZjQ0ZjJlMjRlNWI0NmJjNjhlZjNiYjMwM2QxNTE3NmI5NTRiZjc2
-    YTJiZWIxM2Q3NmEyMTU4M2YwNDFlYTgzNWU1ZjQ0ZDkzZWNkM2UzZjI1Yzc5
-    OWY2ZDZlNTMxY2E2ZTZhMjRkMjQ5ZjEzNWY2YWI3MmJjY2VlNmM=
-  data.tar.gz: !binary |-
-    MmJlMjIxOWY4MDIyYzI4MTJmMjExYmFhYTU3MmIzZjc1NGYwOGZmZTU3NDdh
-    YzU0OTM2NjFiZTU4Yzg2NmQ0ZjA4ZjlmZmY4ZWViYmY3NjU5ZTZlY2YzMmE1
-    NTAyMWNiODM5ZDcyMmMyZjQ5NjY2YTIzYmI0YWU2MWRjOTc1Nzk=
+  metadata.gz: 16405b1ce41bc3b287eebfa347316998d66507bfa6b6dfa6c2bb0c7a9d6ef158adef44bd19ec229d235e7fb7abca7013369450c5c038fdc4b17392cc1c671893
+  data.tar.gz: 1b214d4f1f23e608920b6556f7440286db57fcf8925d0bf9f3af4dd1bf6b28f5a7839bb19c7fe4767b6c62c22b0dee5c4b0a2da3e2b9fc1b931a4dddc0f7e780

data/lib/netsuite.rb

@@ -128,6 +128,7 @@ module NetSuite
     autoload :Duration,                         'netsuite/records/duration'
     autoload :Employee,                         'netsuite/records/employee'
     autoload :File,                             'netsuite/records/file'
+    autoload :Folder,                           'netsuite/records/folder'
     autoload :InventoryAssignment,              'netsuite/records/inventory_assignment'
     autoload :InventoryAssignmentList,          'netsuite/records/inventory_assignment_list'
     autoload :InventoryDetail,                  'netsuite/records/inventory_detail'
@@ -206,6 +207,11 @@ module NetSuite
     autoload :WorkOrderItemList,                'netsuite/records/work_order_item_list'
   end
 
+  module Passports
+    autoload :User,  'netsuite/passports/user'
+    autoload :Token, 'netsuite/passports/token'
+  end
+
   def self.configure(&block)
     NetSuite::Configuration.instance_eval(&block)
   end

data/lib/netsuite/configuration.rb

@@ -59,17 +59,19 @@ module NetSuite
       if wsdl
         self.wsdl = wsdl
       else
-        if sandbox
-          wsdl_path = "https://webservices.sandbox.netsuite.com/wsdl/v#{api_version}_0/netsuite.wsdl"
-        else
-          wsdl_path = File.expand_path("../../../wsdl/#{api_version}.wsdl", __FILE__)
+        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
 
-          unless File.exists? wsdl_path
-            wsdl_path = "https://#{wsdl_domain}/wsdl/v#{api_version}_0/netsuite.wsdl"
+            wsdl_path
           end
         end
-
-        attributes[:wsdl] ||= wsdl_path
       end
     end
 
@@ -103,14 +105,30 @@ module NetSuite
     end
 
     def auth_header(credentials={})
-      {
-        'platformMsgs:passport' => {
-          'platformCore:email'    => credentials[:email] || email,
-          'platformCore:password' => credentials[:password] || password,
-          'platformCore:account'  => credentials[:account] || account.to_s,
-          'platformCore:role'     => { :@internalId => credentials[:role] || role }
-        }
-      }
+      if !credentials[:consumer_key].blank? || !consumer_key.blank?
+        token_auth(credentials)
+      else
+        user_auth(credentials)
+      end
+    end
+
+    def user_auth(credentials)
+      NetSuite::Passports::User.new(
+        credentials[:account] || account,
+        credentials[:email] || email,
+        credentials[:password] || password,
+        credentials[:role] || role
+      ).passport
+    end
+
+    def token_auth(credentials)
+      NetSuite::Passports::Token.new(
+        credentials[:account] || account,
+        credentials[:consumer_key] || consumer_key,
+        credentials[:consumer_secret] || consumer_secret,
+        credentials[:token_id] || token_id,
+        credentials[:token_secret] || token_secret
+      ).passport
     end
 
     def namespaces
@@ -185,6 +203,54 @@ module NetSuite
       end
     end
 
+    def consumer_key=(consumer_key)
+      attributes[:consumer_key] = consumer_key
+    end
+
+    def consumer_key(consumer_key = nil)
+      if consumer_key
+        self.consumer_key = consumer_key
+      else
+        attributes[:consumer_key]
+      end
+    end
+
+    def consumer_secret=(consumer_secret)
+      attributes[:consumer_secret] = consumer_secret
+    end
+
+    def consumer_secret(consumer_secret = nil)
+      if consumer_secret
+        self.consumer_secret = consumer_secret
+      else
+        attributes[:consumer_secret]
+      end
+    end
+
+    def token_id=(token_id)
+      attributes[:token_id] = token_id
+    end
+
+    def token_id(token_id = nil)
+      if token_id
+        self.token_id = token_id
+      else
+        attributes[:token_id]
+      end
+    end
+
+    def token_secret=(token_secret)
+      attributes[:token_secret] = token_secret
+    end
+
+    def token_secret(token_secret = nil)
+      if token_secret
+        self.token_secret = token_secret
+      else
+        attributes[:token_secret]
+      end
+    end
+
     def read_timeout=(timeout)
       attributes[:read_timeout] = timeout
     end

data/lib/netsuite/passports/token.rb

@@ -0,0 +1,55 @@
+module NetSuite
+  module Passports
+    class Token
+      attr_reader :account, :consumer_key, :consumer_secret, :token_id, :token_secret
+
+      def initialize(account, consumer_key, consumer_secret, token_id, token_secret)
+        @account = account.to_s
+        @consumer_key = consumer_key
+        @consumer_secret = consumer_secret
+        @token_id = token_id
+        @token_secret = token_secret
+      end
+
+      def passport
+        {
+          'platformMsgs:tokenPassport' => {
+            'platformCore:account' => account,
+            'platformCore:consumerKey' => consumer_key,
+            'platformCore:token' => token_id,
+            'platformCore:nonce' => nonce,
+            'platformCore:timestamp' => timestamp,
+            'platformCore:signature' => signature,
+            :attributes! => { 'platformCore:signature' => { 'algorithm' => 'HMAC-SHA256' } }
+          }
+        }
+      end
+
+      private
+
+      def signature
+        Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'), signature_key, signature_data))
+      end
+
+      def signature_key
+        "#{consumer_secret}&#{token_secret}"
+      end
+
+      def signature_data
+        "#{account}&#{consumer_key}&#{token_id}&#{nonce}&#{timestamp}"
+      end
+
+      def nonce
+        @nonce ||= Array.new(20) { alphanumerics.sample }.join
+      end
+
+      def alphanumerics
+        [*'0'..'9',*'A'..'Z',*'a'..'z']
+      end
+
+      def timestamp
+        @timestamp ||= Time.now.to_i
+      end
+    end
+  end
+end

data/lib/netsuite/passports/user.rb

@@ -0,0 +1,25 @@
+module NetSuite
+  module Passports
+    class User
+      attr_reader :account, :email, :password, :role
+
+      def initialize(account, email, password, role)
+        @account = account.to_s
+        @email = email
+        @password = password
+        @role = role
+      end
+
+      def passport
+        {
+          'platformMsgs:passport' => {
+            'platformCore:account'  => account,
+            'platformCore:email'    => email,
+            'platformCore:password' => password,
+            'platformCore:role'     => { :@internalId => role }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/netsuite/records/file.rb

@@ -11,7 +11,7 @@ module NetSuite
 
       fields :content, :description, :name, :media_type_name, :file_type, :text_file_encoding
 
-      record_refs :klass
+      record_refs :folder, :klass
 
       read_only_fields :url
 

data/lib/netsuite/records/folder.rb

@@ -0,0 +1,26 @@
+module NetSuite
+  module Records
+    class Folder
+      include Support::Fields
+      include Support::RecordRefs
+      include Support::Records
+      include Support::Actions
+      include Namespaces::FileCabinet
+
+      actions :add
+
+      fields :name
+
+      record_refs :parent
+
+      attr_reader :internal_id
+      attr_accessor :external_id
+
+      def initialize(attributes = {})
+        @internal_id = attributes.delete(:internal_id) || attributes.delete(:@internal_id)
+        @external_id = attributes.delete(:external_id) || attributes.delete(:@external_id)
+        initialize_from_attributes_hash(attributes)
+      end
+    end
+  end
+end

data/lib/netsuite/support/country.rb

@@ -261,6 +261,12 @@ module NetSuite
         end
       end
 
+      def ==(other)
+        other.class == self.class && other.to_iso == self.to_iso
+      end
+
+      alias :eql? :==
+
       def to_iso
         ISO_TO_NETSUITE.key(@id)
       end

data/lib/netsuite/version.rb

@@ -1,3 +1,3 @@
 module Netsuite
-  VERSION = '0.5.7'
+  VERSION = '0.5.8'
 end

data/spec/netsuite/configuration_spec.rb

@@ -64,21 +64,48 @@ describe NetSuite::Configuration do
   end
 
   describe '#auth_header' do
-    before do
-      config.email    = 'user@example.com'
-      config.password = 'myPassword'
-      config.account  = 1234
+    context 'when doing user authentication' do
+      before do
+        config.account  = 1234
+        config.email    = 'user@example.com'
+        config.password = 'myPassword'
+      end
+
+      it 'returns a hash representation of the authentication header' do
+        expect(config.auth_header).to eql({
+          'platformMsgs:passport' => {
+            'platformCore:account'  => '1234',
+            'platformCore:email'    => 'user@example.com',
+            'platformCore:password' => 'myPassword',
+            'platformCore:role'     => { :@internalId => '3' },
+          }
+        })
+      end
     end
 
-    it 'returns a hash representation of the authentication header' do
-      expect(config.auth_header).to eql({
-        'platformMsgs:passport' => {
-          'platformCore:email'    => 'user@example.com',
-          'platformCore:password' => 'myPassword',
-          'platformCore:account'  => '1234',
-          'platformCore:role'     => { :@internalId => '3' },
-        }
-      })
+    context 'when doing token authentication' do
+      before do
+        config.account         = 1234
+        config.consumer_key    = 'consumer_key'
+        config.consumer_secret = 'consumer_secret'
+        config.token_id        = 'token_id'
+        config.token_secret    = 'token_secret'
+      end
+
+      it 'returns tokenPassport object' do
+        expect(config.auth_header.has_key?('platformMsgs:tokenPassport')).to be_truthy
+      end
+
+      it 'returns proper elements of tokenPassport' do
+        expect(config.auth_header['platformMsgs:tokenPassport']['platformCore:account']).to eql('1234')
+        expect(config.auth_header['platformMsgs:tokenPassport']['platformCore:consumerKey']).to eql('consumer_key')
+        expect(config.auth_header['platformMsgs:tokenPassport']['platformCore:token']).to eql('token_id')
+        expect(config.auth_header['platformMsgs:tokenPassport'][:attributes!]).to eql({ 'platformCore:signature' => { 'algorithm' => 'HMAC-SHA256' } })
+
+        expect(config.auth_header['platformMsgs:tokenPassport'].has_key?('platformCore:nonce')).to be_truthy
+        expect(config.auth_header['platformMsgs:tokenPassport'].has_key?('platformCore:timestamp')).to be_truthy
+        expect(config.auth_header['platformMsgs:tokenPassport'].has_key?('platformCore:signature')).to be_truthy
+      end
     end
   end
 

data/spec/netsuite/records/address_spec.rb

@@ -16,7 +16,7 @@ describe NetSuite::Records::Address do
       :state        => 'CA',
       :zip          => '90007'
     }
-  end      
+  end
   let(:list) { NetSuite::Records::Address.new(attributes) }
 
   it 'has all the right fields' do
@@ -26,7 +26,7 @@ describe NetSuite::Records::Address do
       expect(list).to have_field(field)
     end
   end
-  
+
   it 'has all the right read_only_fields' do
     [
       :addr_text
@@ -104,6 +104,13 @@ describe NetSuite::Records::Address do
         addressbook = NetSuite::Records::Address.new country: "US"
         expect(addressbook.to_record["platformCommon:country"]).to eql "_unitedStates"
       end
+
+      it 'properly evaluates equality against another country of the same ISO code' do
+        addressbook = NetSuite::Records::Address.new country: "US"
+        addressbook_2 = NetSuite::Records::Address.new country: "US"
+
+        expect(addressbook.country == addressbook_2.country).to eq(true)
+      end
     end
 
     context "when the country code is a YAML reserved word (NO)" do

data/spec/netsuite/records/basic_record_spec.rb

@@ -22,6 +22,7 @@ describe 'basic records' do
       NetSuite::Records::NonInventoryPurchaseItem,
       NetSuite::Records::NonInventoryResaleItem,
       NetSuite::Records::TaxGroup,
+      NetSuite::Records::Folder,
     ]
   }
 

data/spec/netsuite/records/file_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe NetSuite::Records::File do
+  let(:file) { NetSuite::Records::File.new }
+
+  it 'has all the right record refs' do
+    [:folder, :klass].each do |record_ref|
+      expect(file).to have_record_ref(record_ref)
+    end
+  end
+end

data/spec/netsuite/records/folder_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe NetSuite::Records::Folder do
+  let(:folder) { NetSuite::Records::Folder.new }
+
+  it 'has all the right fields' do
+    [:name].each do |field|
+      expect(folder).to have_field(field)
+    end
+  end
+
+  it 'has all the right record refs' do
+    [:parent].each do |record_ref|
+      expect(folder).to have_record_ref(record_ref)
+    end
+  end
+
+  describe '#add' do
+    let(:test_data) { { :name => 'foo' } }
+
+    context 'when the response is successful' do
+      let(:response) { NetSuite::Response.new(:success => true, :body => { :internal_id => '1' }) }
+
+      it 'returns true' do
+        folder = NetSuite::Records::Folder.new(test_data)
+        expect(NetSuite::Actions::Add).to receive(:call).
+          with([folder], {}).
+          and_return(response)
+        expect(folder.add).to be_truthy
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: netsuite
 version: !ruby/object:Gem::Version
-  version: 0.5.7
+  version: 0.5.8
 platform: ruby
 authors:
 - Ryan Moran
@@ -9,34 +9,34 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-11 00:00:00.000000000 Z
+date: 2016-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.0
 description: NetSuite SuiteTalk API Wrapper
@@ -47,8 +47,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE
 - README.md
@@ -89,6 +89,8 @@ files:
 - lib/netsuite/namespaces/tran_invt.rb
 - lib/netsuite/namespaces/tran_purch.rb
 - lib/netsuite/namespaces/tran_sales.rb
+- lib/netsuite/passports/token.rb
+- lib/netsuite/passports/user.rb
 - lib/netsuite/records/account.rb
 - lib/netsuite/records/accounting_period.rb
 - lib/netsuite/records/address.rb
@@ -157,6 +159,7 @@ files:
 - lib/netsuite/records/duration.rb
 - lib/netsuite/records/employee.rb
 - lib/netsuite/records/file.rb
+- lib/netsuite/records/folder.rb
 - lib/netsuite/records/inventory_assignment.rb
 - lib/netsuite/records/inventory_assignment_list.rb
 - lib/netsuite/records/inventory_detail.rb
@@ -305,6 +308,8 @@ files:
 - spec/netsuite/records/discount_item_spec.rb
 - spec/netsuite/records/duration_spec.rb
 - spec/netsuite/records/employee_spec.rb
+- spec/netsuite/records/file_spec.rb
+- spec/netsuite/records/folder_spec.rb
 - spec/netsuite/records/inventory_assignment_list_spec.rb
 - spec/netsuite/records/inventory_assignment_spec.rb
 - spec/netsuite/records/inventory_detail_spec.rb
@@ -405,17 +410,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: NetSuite SuiteTalk API (SOAP) Wrapper
@@ -479,6 +484,8 @@ test_files:
 - spec/netsuite/records/discount_item_spec.rb
 - spec/netsuite/records/duration_spec.rb
 - spec/netsuite/records/employee_spec.rb
+- spec/netsuite/records/file_spec.rb
+- spec/netsuite/records/folder_spec.rb
 - spec/netsuite/records/inventory_assignment_list_spec.rb
 - spec/netsuite/records/inventory_assignment_spec.rb
 - spec/netsuite/records/inventory_detail_spec.rb