netsuite 0.0.2 → 0.0.3

data/.autotest

@@ -1,10 +1,9 @@
 Autotest.add_hook :initialize do |at|
   at.clear_mappings
 
-  at.add_mapping %r%/^lib/(.*)\.rb$% do |_, m|
-    possible = File.basename(m[1])
-    files_matching %r%^spec/.*(#{possible}_spec)\.rb$%
+  at.add_mapping(%r%^lib/(.*)\.rb$%) do |_, m|
+    at.files_matching %r%^spec/#{m[1]}_spec\.rb$%
   end
 
-  at.add_mapping(%r%^spec/.*\_spec.rb$%) {|filename, _| filename }
+  at.add_mapping(%r%^spec/.*\_spec\.rb$%) { |filename, _| filename }
 end

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ree-1.8.7-2010.02@netsuite

data/README.md

@@ -1,6 +1,8 @@
 # Netsuite
 
-TODO: Write a gem description
+* This gem will act as a wrapper around the NetSuite SuiteTalk WebServices API. Wow, that is a mouthful.
+* The gem does not cover the entire API, only the subset that we have found useful to cover so far.
+* [Extending the wrapper](#extending) is pretty simple. See below for an example.
 
 ## Installation
 
@@ -18,7 +20,70 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Customer
+
+* Initializing a customer can be done using a hash of attributes.
+
+#### Get
+
+* Retrieves the customer by internalId.
+
+    ```Ruby
+    customer = NetSuite::Customer.get(4) # => #<NetSuite::Customer:0x1042f59b8>
+    customer.is_person                   # => true
+    ```
+
+<a name='extending'>
+## Additions
+
+* Please submit a pull request for any models or actions that you would like to be included. The API is quite large and so we will necessarily not cover all of it.
+* Models should go into the `lib/netsuite/models/` directory.
+* Actions should be placed in their respective subdirectory under `lib/netsuite/actions`.
+* Example:
+
+    ```Ruby
+    # lib/netsuite/actions/customer/add.rb
+
+    module NetSuite
+      module Actions
+        module Customer
+          class Add
+
+            def initialize(attributes = {})
+              @attributes = attributes
+            end
+
+            def self.call(attributes)
+              new(attributes).call
+            end
+
+            def call
+              response = NetSuite::Configuration.connection.request :add do
+                soap.header =  NetSuite::Configuration.auth_header
+                soap.body = {
+                  :entityId    => @attributes[:entity_id],
+                  :companyName => @attributes[:company_name],
+                  :unsubscribe => @attributes[:unsubscribe]
+                }
+              end
+              success = response.to_hash[:add_response][:write_response][:status][:@is_success] == 'true'
+              body    = response.to_hash[:add_response][:write_response][:base_ref]
+              NetSuite::Response.new(:success => success, :body => body)
+            end
+
+          end
+        end
+      end
+    end
+
+    response = NetSuite::Actions::Customer::Add.call(
+      :entity_id    => 'Shutter Fly',
+      :company_name => 'Shutter Fly, Inc.',
+      :unsubscribe  => false
+    )                 # => #<NetSuite::Response:0x1041f64b5>
+    response.success? # => true
+    response.body     # => { :internal_id => '979', :type => 'customer' }
+    ```
 
 ## Contributing
 

data/lib/netsuite.rb

@@ -4,7 +4,9 @@ require 'netsuite/response'
 require 'netsuite/version'
 
 # ACTIONS
-require 'netsuite/actions/customer/get'
+require 'netsuite/actions/support'
+require 'netsuite/actions/add'
+require 'netsuite/actions/get'
 
 # MODELS
 require 'netsuite/models/customer'

data/lib/netsuite/actions/add.rb

@@ -0,0 +1,58 @@
+module NetSuite
+  module Actions
+    class Add
+      include Support
+
+      def initialize(attributes = {})
+        @attributes = attributes
+      end
+
+      private
+
+      def request
+        connection.request :platformMsgs, :add do
+          soap.namespaces['xmlns:platformMsgs'] = 'urn:messages_2011_2.platform.webservices.netsuite.com'
+          soap.namespaces['xmlns:platformCore'] = 'urn:core_2011_2.platform.webservices.netsuite.com'
+          soap.namespaces['xmlns:listRel']      = 'urn:relationships_2011_2.lists.webservices.netsuite.com'
+          soap.header = auth_header
+          soap.body   = request_body
+        end
+      end
+
+      # <soap:Body>
+      #   <platformMsgs:add>
+      #     <platformMsgs:record xsi:type="listRel:Customer">
+      #       <listRel:entityId>Shutter Fly</listRel:entityId>
+      #       <listRel:companyName>Shutter Fly, Inc</listRel:companyName>
+      #     </platformMsgs:record>
+      #   </platformMsgs:add>
+      # </soap:Body>
+      def request_body
+        {
+          'platformMsgs:record' => {
+            'listRel:entityId'    => @attributes[:entity_id],
+            'listRel:companyName' => @attributes[:company_name]
+          },
+          :attributes! => {
+            'platformMsgs:record' => {
+              'xsi:type' => 'listRel:Customer'
+            }
+          }
+        }
+      end
+
+      def success?
+        @success ||= response_hash[:status][:@is_success] == 'true'
+      end
+
+      def response_body
+        @response_body ||= response_hash[:base_ref]
+      end
+
+      def response_hash
+        @response_hash ||= @response.to_hash[:add_response][:write_response]
+      end
+
+    end
+  end
+end

data/lib/netsuite/actions/get.rb

@@ -0,0 +1,55 @@
+module NetSuite
+  module Actions
+    class Get
+      include Support
+
+      def initialize(id)
+        @id = id
+      end
+
+      private
+
+      def request
+        connection.request :platformMsgs, :get do
+          soap.namespaces['xmlns:platformMsgs'] = 'urn:messages_2011_2.platform.webservices.netsuite.com'
+          soap.namespaces['xmlns:platformCore'] = 'urn:core_2011_2.platform.webservices.netsuite.com'
+          soap.header = auth_header
+          soap.body   = request_body
+        end
+      end
+
+      # <soap:Body>
+      #   <platformMsgs:get>
+      #     <platformMsgs:baseRef internalId="983" type="customer" xsi:type="platformCore:RecordRef">
+      #       <platformCore:name/>
+      #     </platformMsgs:baseRef>
+      #   </platformMsgs:get>
+      # </soap:Body>
+      def request_body
+        {
+          'platformMsgs:baseRef' => {},
+          :attributes! => {
+            'platformMsgs:baseRef' => {
+              :internalId => @id,
+              :type       => 'customer',
+              'xsi:type'  => 'platformCore:RecordRef'
+            }
+          }
+        }
+      end
+
+      def success?
+        @success ||= response_hash[:status][:@is_success] == 'true'
+      end
+
+      def response_body
+        @response_body ||= response_hash[:record]
+      end
+
+      def response_hash
+        @response_hash = @response[:get_response][:read_response]
+      end
+
+    end
+  end
+end

data/lib/netsuite/actions/support.rb

@@ -0,0 +1,50 @@
+module NetSuite
+  module Actions
+    module Support
+
+      def self.included(base)
+        base.send(:extend, ClassMethods)
+      end
+
+      module ClassMethods
+
+        def call(*args)
+          new(*args).call
+        end
+
+      end
+
+      def call
+        @response = request
+        build_response
+      end
+
+      private
+
+      def request
+        raise NotImplementedError
+      end
+
+      def connection
+        NetSuite::Configuration.connection
+      end
+
+      def auth_header
+        NetSuite::Configuration.auth_header
+      end
+
+      def build_response
+        NetSuite::Response.new(:success => success?, :body => response_body)
+      end
+
+      def success?
+        raise NotImplementedError
+      end
+
+      def response_body
+        raise NotImplementedError
+      end
+
+    end
+  end
+end

data/lib/netsuite/configuration.rb

@@ -14,8 +14,16 @@ module NetSuite
       attributes[:connection] ||= Savon::Client.new(self.wsdl)
     end
 
-    def wsdl
-      attributes[:wsdl] ||= File.expand_path('../../../wsdl/2011_02.wsdl', __FILE__)
+    def wsdl=(wsdl)
+      attributes[:wsdl] = wsdl
+    end
+
+    def wsdl(wsdl = nil)
+      if wsdl
+        self.wsdl = wsdl
+      else
+        attributes[:wsdl] ||= File.expand_path('../../../wsdl/2011_02.wsdl', __FILE__)
+      end
     end
 
     def auth_header

data/lib/netsuite/models/customer.rb

@@ -6,7 +6,7 @@ module NetSuite
     end
 
     def self.get(id)
-      response = NetSuite::Actions::Customer::Get.call(id)
+      response = NetSuite::Actions::Get.call(id)
       if response.success?
         new(response.body)
       else
@@ -14,8 +14,17 @@ module NetSuite
       end
     end
 
-    def is_person
-      @attributes[:is_person]
+    def add
+      response = NetSuite::Actions::Add.call(@attributes)
+      response.success?
+    end
+
+    def method_missing(m, *args, &block)
+      if @attributes.keys.include?(m.to_sym)
+        @attributes[m.to_sym]
+      else
+        super
+      end
     end
 
   end

data/lib/netsuite/version.rb

@@ -1,3 +1,3 @@
 module Netsuite
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/netsuite/actions/add_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe NetSuite::Actions::Add do
+
+  context 'Customer' do
+    let(:attributes) do
+      {
+        :entity_id    => 'Shutter Fly',
+        :company_name => 'Shutter Fly, Inc.'
+      }
+    end
+
+    before do
+      savon.expects(:add).with({
+        'platformMsgs:record' => {
+          'listRel:entityId'    => 'Shutter Fly',
+          'listRel:companyName' => 'Shutter Fly, Inc.'
+        },
+        :attributes! => {
+          'platformMsgs:baseRef' => {
+            'xsi:type' => 'listRel:Customer'
+          }
+        }
+      }).returns(:add_customer)
+    end
+
+    it 'makes a valid request to the NetSuite API' do
+      NetSuite::Actions::Add.call(attributes)
+    end
+
+    it 'returns a valid Response object' do
+      response = NetSuite::Actions::Add.call(attributes)
+      response.should be_kind_of(NetSuite::Response)
+    end
+  end
+
+end

data/spec/netsuite/actions/{customer/get_spec.rb → get_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe NetSuite::Actions::Customer::Get do
+describe NetSuite::Actions::Get do
 
   before do
     savon.expects(:get).with({
@@ -16,11 +16,11 @@ describe NetSuite::Actions::Customer::Get do
   end
 
   it 'makes a valid request to the NetSuite API' do
-    NetSuite::Actions::Customer::Get.call(1)
+    NetSuite::Actions::Get.call(1)
   end
 
   it 'returns a valid Response object' do
-    response = NetSuite::Actions::Customer::Get.call(1)
+    response = NetSuite::Actions::Get.call(1)
     response.should be_kind_of(NetSuite::Response)
   end
 

data/spec/netsuite/actions/support_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe NetSuite::Actions::Support do
+  let(:instance) do
+    obj = Object.new
+    obj.extend(NetSuite::Actions::Support)
+    obj
+  end
+
+  describe '#call' do
+    before do
+      instance.stub(:request)
+      instance.stub(:success?)
+      instance.stub(:response_body)
+    end
+
+    it 'calls #request' do
+      instance.should_receive(:request)
+      instance.call
+    end
+
+    it 'calls #build_response' do
+      instance.should_receive(:build_response)
+      instance.call
+    end
+
+    it 'returns a NetSuite::Response object' do
+      response = instance.call
+      response.should be_kind_of(NetSuite::Response)
+    end
+  end
+
+end

data/spec/netsuite/configuration_spec.rb

@@ -23,8 +23,20 @@ describe NetSuite::Configuration do
   end
 
   describe '#wsdl' do
-    it 'returns a path to the WSDL to use for the API' do
-      config.wsdl.should match(/.*\/netsuite\/wsdl\/2011_02\.wsdl/)
+    context 'when the wsdl has been set' do
+      before do
+        config.wsdl = 'https://system.sandbox.netsuite.com/wsdl/v2011_2_0/netsuite.wsdl'
+      end
+
+      it 'returns a path to the WSDL to use for the API' do
+        config.wsdl.should eql('https://system.sandbox.netsuite.com/wsdl/v2011_2_0/netsuite.wsdl')
+      end
+    end
+
+    context 'when the wsdl has not been set' do
+      it 'returns a path to the WSDL to use for the API' do
+        config.wsdl.should match(/.*\/netsuite\/wsdl\/2011_02\.wsdl/)
+      end
     end
   end
 

data/spec/netsuite/models/customer_spec.rb

@@ -8,7 +8,7 @@ describe NetSuite::Customer do
       let(:response) { NetSuite::Response.new(:success => true, :body => { :is_person => true }) }
 
       it 'returns a Customer instance populated with the data from the response object' do
-        NetSuite::Actions::Customer::Get.should_receive(:call).with(1).and_return(response)
+        NetSuite::Actions::Get.should_receive(:call).with(1).and_return(response)
         customer = NetSuite::Customer.get(1)
         customer.should be_kind_of(NetSuite::Customer)
         customer.is_person.should be_true
@@ -19,7 +19,7 @@ describe NetSuite::Customer do
       let(:response) { NetSuite::Response.new(:success => false, :body => {}) }
 
       it 'returns a Customer instance populated with the data from the response object' do
-        NetSuite::Actions::Customer::Get.should_receive(:call).with(1).and_return(response)
+        NetSuite::Actions::Get.should_receive(:call).with(1).and_return(response)
         lambda {
           NetSuite::Customer.get(1)
         }.should raise_error(NetSuite::RecordNotFound, 'NetSuite::Customer with ID=1 could not be found')
@@ -27,11 +27,46 @@ describe NetSuite::Customer do
     end
   end
 
-  describe '#is_person' do
-    context 'when the customer is a person' do
+  describe '#add' do
+    let(:test_data) { { :entity_name => 'TEST CUSTOMER', :is_person => true } }
+
+    context 'when the response is successful' do
+      let(:response) { NetSuite::Response.new(:success => true, :body => { :internal_id => '1' }) }
+
       it 'returns true' do
-        customer = NetSuite::Customer.new(:is_person => true)
-        customer.is_person.should be_true
+        NetSuite::Actions::Add.should_receive(:call).
+            with(test_data).
+            and_return(response)
+        customer = NetSuite::Customer.new(test_data)
+        customer.add.should be_true
+      end
+    end
+
+    context 'when the response is unsuccessful' do
+      let(:response) { NetSuite::Response.new(:success => false, :body => {}) }
+      it 'returns false' do
+        NetSuite::Actions::Add.should_receive(:call).
+            with(test_data).
+            and_return(response)
+        customer = NetSuite::Customer.new(test_data)
+        customer.add.should be_false
+      end
+    end
+  end
+
+  describe '#method_missing' do
+    context 'when calling a method that exists as an attribute' do
+      it 'returns the right value from the attributes hash' do
+        customer = NetSuite::Customer.new(:name => 'Mr. Banana')
+        customer.name.should eql('Mr. Banana')
+      end
+    end
+
+    context 'when calling a method that does not exist in the attributes hash' do
+      it 'raises a NoMethodError' do
+        lambda {
+          customer.banana
+        }.should raise_error(NoMethodError)
       end
     end
   end

data/spec/netsuite_spec.rb

@@ -8,27 +8,34 @@ describe NetSuite do
   end
 
   describe '#configure' do
-    it 'allows the Configuration #email= instance method to be called with instance eval' do
+    it 'allows the Configuration #email instance method to be called with instance eval' do
       NetSuite.configure do
         email 'me@example.com'
       end
       config.email.should eql('me@example.com')
     end
 
-    it 'allows the Configuration #password= instance method to be called with instance eval' do
+    it 'allows the Configuration #password instance method to be called with instance eval' do
       NetSuite.configure do
         password 'myPassword'
       end
       config.password.should eql('myPassword')
     end
 
-    it 'allows the Configuration #account= instance method to be called with instance eval' do
+    it 'allows the Configuration #account instance method to be called with instance eval' do
       NetSuite.configure do
         account 1234
       end
       config.account.should eql(1234)
     end
 
+    it 'allows the Configuration #wsdl instance method to be called with instance_eval' do
+      NetSuite.configure do
+        wsdl 'https://system.sandbox.netsuite.com/wsdl/v2011_2_0/netsuite.wsdl'
+      end
+      config.wsdl.should eql('https://system.sandbox.netsuite.com/wsdl/v2011_2_0/netsuite.wsdl')
+    end
+
   end
 
 end

data/spec/support/configuration.rb

@@ -1,6 +1,7 @@
 RSpec.configure do |config|
   config.before do
     NetSuite.configure do
+      reset!
       email    'me@example.com'
       password 'myPassword'
       account  1234

data/spec/support/fixtures/add/add_customer.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <soapenv:Header>
+    <platformMsgs:documentInfo xmlns:platformMsgs="urn:messages_2011_2.platform.webservices.netsuite.com">
+      <platformMsgs:nsId>WEBSERVICES_3392464_1220201115821392011296470399_67055c545d0</platformMsgs:nsId>
+    </platformMsgs:documentInfo>
+  </soapenv:Header>
+  <soapenv:Body>
+    <addResponse xmlns="urn:messages_2_5.platform.webservices.netsuite.com">
+      <writeResponse xmlns="urn:messages_2_5.platform.webservices.netsuite.com">
+        <ns1:status isSuccess="true" xmlns:ns1="urn:core_2_5.platform.webservices.netsuite.com"/>
+        <baseRef internalId="979" type="customer" xsi:type="ns2:RecordRef" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns2="urn:core_2_5.platform.webservices.netsuite.com"/>
+      </writeResponse>
+    </addResponse>
+  </soapenv:Body>
+</soapenv:Envelope>

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: netsuite
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Ryan Moran
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-21 00:00:00 -08:00
+date: 2011-12-22 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -95,25 +95,31 @@ files:
 - .autotest
 - .gitignore
 - .rspec
+- .rvmrc
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/netsuite.rb
-- lib/netsuite/actions/customer/get.rb
+- lib/netsuite/actions/add.rb
+- lib/netsuite/actions/get.rb
+- lib/netsuite/actions/support.rb
 - lib/netsuite/configuration.rb
 - lib/netsuite/errors.rb
 - lib/netsuite/models/customer.rb
 - lib/netsuite/response.rb
 - lib/netsuite/version.rb
 - netsuite.gemspec
-- spec/netsuite/actions/customer/get_spec.rb
+- spec/netsuite/actions/add_spec.rb
+- spec/netsuite/actions/get_spec.rb
+- spec/netsuite/actions/support_spec.rb
 - spec/netsuite/configuration_spec.rb
 - spec/netsuite/models/customer_spec.rb
 - spec/netsuite/response_spec.rb
 - spec/netsuite_spec.rb
 - spec/spec_helper.rb
 - spec/support/configuration.rb
+- spec/support/fixtures/add/add_customer.xml
 - spec/support/fixtures/get/get_customer.xml
 - spec/support/savon.rb
 - wsdl/2011_02.wsdl
@@ -152,12 +158,15 @@ signing_key:
 specification_version: 3
 summary: NetSuite SuiteTalk API Wrapper
 test_files: 
-- spec/netsuite/actions/customer/get_spec.rb
+- spec/netsuite/actions/add_spec.rb
+- spec/netsuite/actions/get_spec.rb
+- spec/netsuite/actions/support_spec.rb
 - spec/netsuite/configuration_spec.rb
 - spec/netsuite/models/customer_spec.rb
 - spec/netsuite/response_spec.rb
 - spec/netsuite_spec.rb
 - spec/spec_helper.rb
 - spec/support/configuration.rb
+- spec/support/fixtures/add/add_customer.xml
 - spec/support/fixtures/get/get_customer.xml
 - spec/support/savon.rb

data/lib/netsuite/actions/customer/get.rb

@@ -1,70 +0,0 @@
-module NetSuite
-  module Actions
-    module Customer
-      class Get
-
-        def initialize(id)
-          @id = id
-        end
-
-        def self.call(id)
-          new(id).call
-        end
-
-        def call
-          @response = request
-          build_response
-        end
-
-        private
-
-        def request
-          connection.request :platformMsgs, :get do
-            soap.namespaces['xmlns:platformMsgs'] = 'urn:messages_2011_2.platform.webservices.netsuite.com'
-            soap.namespaces['xmlns:platformCore'] = 'urn:core_2011_2.platform.webservices.netsuite.com'
-            soap.header = auth_header
-            soap.body   = request_body
-          end
-        end
-
-        def connection
-          NetSuite::Configuration.connection
-        end
-
-        def auth_header
-          NetSuite::Configuration.auth_header
-        end
-
-        def request_body
-          {
-            'platformMsgs:baseRef' => {},
-            :attributes! => {
-              'platformMsgs:baseRef' => {
-                :internalId => @id,
-                :type       => 'customer',
-                'xsi:type'  => 'platformCore:RecordRef'
-              }
-            }
-          }
-        end
-
-        def build_response
-          NetSuite::Response.new(:success => success?, :body => response_body)
-        end
-
-        def success?
-          @success ||= response_hash[:status][:@is_success] == 'true'
-        end
-
-        def response_body
-          @response_body ||= response_hash[:record]
-        end
-
-        def response_hash
-          @response_hash = @response[:get_response][:read_response]
-        end
-
-      end
-    end
-  end
-end