big_machines 0.0.2 → 0.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MWFhYjZmYzgxNzg5NTIxNjU2NDBjNWM0MjM2ODU2NzU3ODI2YWUxYQ==
-  data.tar.gz: !binary |-
-    YmVmZTliYzM4N2VkNTBlZjljYjI3ZjZjNGZiODk1MzkyNWEyMjBiOA==
+SHA1:
+  metadata.gz: 3f3c7d06d716ea3d6e8dadf02eeae6701cdca7ba
+  data.tar.gz: 0f780d198d87cfd98a59fcaa3ce169adb98a4f68
 SHA512:
-  metadata.gz: !binary |-
-    YmRhOGRiZWI3N2YzNjJjZjZhMjUxMmNkZmIwZjFkYjlmOGQzOTU1OWI5N2Nm
-    ZTQ2YjhiZGU1NDVkZDQwZmIxZjkwY2M0MDY2MTg2ZGM0MGFmZTU0MmQ1Mzc5
-    MGRjNDI0NjM5OGE1NTg4ZTkxMmNlZWY5MjJiNjVkOTMyZTY0OWQ=
-  data.tar.gz: !binary |-
-    YjUzNGYzMDE4ZjdiNjFjYTAzM2U0MDU4MTU3MmQ4YzNmMmE3NjA5MzdhODJm
-    Y2VkN2FjNDViNzVlY2JkNmE3ODg1MDUxYmY5NTA4ZjdiZmU1YjRjZmIzZWM5
-    NGQ5OWMyMTI0Njc3MGZjNmYzM2RkY2ZjMTFmOGUwNTNhYmE3MzA=
+  metadata.gz: 965d70d90c979a70ac511236e521cb9d179b6a88ce93e6db7512e6fce524ad535d142b3160b9f9c5027e97b9be4534c327568c6badc80e58b7732fac15f23254
+  data.tar.gz: 5994b8395ed66c170325cefa9d82a9647ae981225dfb65af350f440bc2590541c689fa68a00be01a35cf04c163d5cc821eb380324d42c507f91d41123ed6e9ca

data/README.md

@@ -46,7 +46,7 @@ client = BigMachines::Client.new('subdomain', process_name: 'quotes_process')
 #### Authenticate
 
 ```ruby
-client.login(:username => 'foo', :password => 'password')
+client.login('foo', 'password')
 ```
 
 ### set_session_currency
@@ -74,8 +74,8 @@ client.get_transaction(id)
 ### update_transaction
 
 ```ruby
-# Update transaction
-client.update_transaction(id, data={})
+# Update transaction (quote_process)
+client.update_transaction(id, data={notesCMPM_es: "Sample Notes"})
 # => Hash[:status]
 ```
 

data/lib/big_machines/client.rb

@@ -10,6 +10,7 @@ module BigMachines
       @site_name = site_name
       raise "Valid Site Name must be provided" if @site_name.nil? || @site_name.empty?
       @process_var_name = options[:process_name] || "quotes_process"
+      @logger = options[:logger] || false
 
       @namespaces = {
         "xmlns:bm" => "urn:soap.bigmachines.com"
@@ -20,13 +21,7 @@ module BigMachines
 
       @endpoint = "https://#{@site_name}.bigmachines.com/v1_0/receiver"
 
-      @client = Savon.client(
-        wsdl: @security_wsdl,
-        endpoint: @endpoint,
-        soap_header: headers(:security),
-        convert_request_keys_to: :none,
-        pretty_print_xml: true
-      )
+      @client = Savon.client(configuration)
     end
 
     def headers(type=:security)
@@ -60,45 +55,26 @@ module BigMachines
       @client.operations
     end
 
-    # Public: Get the names of all wsdl operations.
-    #
-    # Supports a username/password (with token) combination or session_id/server_url pair.
+    # Public: login
     #
     # Examples
     #
-    #   client.login(username: 'test', password: 'password_and_token')
-    #   # => {...}
-    #
-    #   client.login(session_id: 'abcd1234', server_url: 'https://na1.salesforce.com/')
+    #   client.login(username, password)
     #   # => {...}
     #
     # Returns Hash of login response and user info
-    def login(options={})
+    def login(username, password)
       result = nil
-      if options[:username] && options[:password]
-        message = {userInfo: {username: options[:username], password: options[:password]}}
-        response = self.security_call(:login, message)
+      message = {userInfo: {username: username, password: password}}
+      response = self.security_call(:login, message)
 
-        userInfo = response[:user_info]
+      userInfo = response[:user_info]
 
-        @session_id = userInfo[:session_id]
-      else
-        raise ArgumentError.new("Must provide username/password or session_id/server_url.")
-      end
+      @session_id = userInfo[:session_id]
 
-      @security_client = Savon.client(
-        wsdl: @security_wsdl,
-        endpoint: @endpoint,
-        soap_header: headers(:security),
-        convert_request_keys_to: :none,
-        pretty_print_xml: true
-      )
+      @security_client = Savon.client(configuration)
 
-      # If a session_id/server_url were passed in then invoke get_user_info for confirmation.
-      # Method missing to call_soap_api
-      result = self.get_user_info if options[:session_id]
-
-      result
+      response[:status][:success]
     end
     alias_method :authenticate, :login
 
@@ -123,14 +99,14 @@ module BigMachines
     #     </bm:return_specific_attributes>
     #   </bm:transaction>
     # </bm:getTransaction>
-    def get_transaction(id)
+    def get_transaction(id, document_var_name='quote_process')
       transaction = {
         transaction: {
           id: id,
           return_specific_attributes: {
             documents: {
               document: {
-                var_name: "quote_process"
+                var_name: document_var_name
               }
             }
           }
@@ -156,17 +132,20 @@ module BigMachines
     #   </bm:transaction>
     # </bm:updateTransaction>
     def update_transaction(id, data={})
+
+      # :opportunityName_quote => 'Test Oppty Auto Approval TinderBox 12',
+      # :siteName_quote => 'My Dummy Site'
+      quote_process_data = {
+        :"@bs_id" => id,
+        :"@data_type" => 0,
+        :"@document_number" => 1
+      }.merge(data)
+
       transaction = {
         transaction: {
           id: id,
           data_xml: {
-            quote_process: {
-              :"@bs_id" => id,
-              :"@data_type" => 0,
-              :"@document_number" => 1,
-              :opportunityName_quote => 'Test Oppty Auto Approval TinderBox 12',
-              :siteName_quote => 'My Dummy Site'
-            }
+            quote_process: quote_process_data
           },
           action_data: {
             action_var_name: '_update_line_items'
@@ -190,6 +169,19 @@ module BigMachines
 
     protected
 
+    def configuration(custom={})
+      {
+        wsdl: @security_wsdl,
+        endpoint: @endpoint,
+        soap_header: headers(:security),
+        filters: [:password],
+        convert_request_keys_to: :none,
+        pretty_print_xml: true,
+        logger: @logger,
+        log: @logger != false
+      }.merge(custom)
+    end
+
     def commerce_client
       @commerce_client ||= client_api(@commerce_wsdl)
     end
@@ -200,14 +192,7 @@ module BigMachines
 
     def client_api(wsdl)
       category = wsdl.include?('security') ? :security : :commerce
-
-      client = Savon.client(
-        wsdl: wsdl,
-        endpoint: @endpoint,
-        soap_header: headers(category),
-        convert_request_keys_to: :none,
-        pretty_print_xml: true
-      )
+      client = Savon.client(configuration(wsdl: wsdl, soap_header: headers(category)))
     end
 
     def security_call(method, message_hash={})

data/lib/big_machines/version.rb

@@ -1,3 +1,3 @@
 module BigMachines
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/fixtures/get_transaction_not_found_response.xml

@@ -0,0 +1,14 @@
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
+  <soapenv:Body>
+    <soapenv:Fault>
+      <faultcode>soapenv:Server</faultcode>
+      <faultstring>COMMERCE-ERR:No transactions were found for the given ID, 266898199</faultstring>
+      <detail xmlns:bm="urn:soap.bigmachines.com">
+        <bm:fault>
+          <bm:exceptionCode>COMMERCE-ERR</bm:exceptionCode>
+          <bm:exceptionMessage>No transactions were found for the given ID, 266898199</bm:exceptionMessage>
+        </bm:fault>
+      </detail>
+    </soapenv:Fault>
+  </soapenv:Body>
+</soapenv:Envelope>

data/spec/fixtures/update_transaction_response.xml

@@ -0,0 +1,10 @@
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
+  <soapenv:Body>
+    <bm:updateTransactionResponse xmlns:bm="urn:soap.bigmachines.com">
+      <bm:status>
+        <bm:success>true</bm:success>
+        <bm:message>Successfully processed API for newtempge at Sat Sep 20 11:23:05 CDT 2014</bm:message>
+      </bm:status>
+    </bm:updateTransactionResponse>
+  </soapenv:Body>
+</soapenv:Envelope>

data/spec/lib/client_spec.rb

@@ -24,7 +24,7 @@ describe BigMachines::Client do
       stub = stub_login_request({with_body: login_body})
       stub.to_return(:status => 200, :body => fixture("login_response"))
 
-      subject.login(username: 'jheth', password: 'changeme')
+      subject.login('jheth', 'changeme')
     end
   end
 
@@ -66,6 +66,8 @@ describe BigMachines::Client do
     describe "getTransaction" do
       it "returns transaction with specific attributes" do
 
+        # NOTE: return_specific_attributes is optional
+        # All attributes are returned when not defined.
         body = %Q{
   <bm:getTransaction>
     <bm:transaction>
@@ -98,6 +100,67 @@ describe BigMachines::Client do
         expect(quote_line_items.length).to eq(109)
         expect(quote_line_items.first[:_model_id]).to eq("17400975")
       end
+
+  it "returns not found error" do
+
+        # NOTE: return_specific_attributes is optional
+        # All attributes are returned when not defined.
+        body = %Q{
+  <bm:getTransaction>
+    <bm:transaction>
+      <bm:id>265393499</bm:id>
+      <bm:return_specific_attributes>
+        <bm:documents>
+          <bm:document>
+            <bm:var_name>quote_process</bm:var_name>
+          </bm:document>
+        </bm:documents>
+      </bm:return_specific_attributes>
+    </bm:transaction>
+  </bm:getTransaction>
+        }.gsub(/^\s+/, '').gsub(/[\n]/, '').gsub("bm:", "targetNamespace:")
+
+        stub = stub_commerce_request({with_body: body, fixture: 'get_transaction_not_found_response'})
+
+        expect {
+          subject.get_transaction(265393499)
+        }.to raise_error(Savon::SOAPFault)
+      end
+
+    end
+
+    describe "updateTransaction" do
+      it "confirms that transaction was updated" do
+
+        body = %Q{
+  <bm:updateTransaction>
+    <bm:transaction>
+      <bm:id>26539349</bm:id>
+        <bm:data_xml>
+          <bm:quote_process bs_id="26539349" data_type="0" document_number="1">
+            <bm:opportunityName_quote>Test Oppty Auto Approval TinderBox</bm:opportunityName_quote>
+            <bm:siteName_quote>MY DUMMY SITE</bm:siteName_quote>
+            <bm:notesCMPM_es>http://subdomain.mytinder.com/view/X2Y58?version=1</bm:notesCMPM_es>
+          </bm:quote_process>
+        </bm:data_xml>
+        <bm:action_data>
+          <bm:action_var_name>_update_line_items</bm:action_var_name>
+        </bm:action_data>
+    </bm:transaction>
+  </bm:updateTransaction>
+        }.gsub(/^\s+/, '').gsub(/[\n]/, '').gsub("bm:", "targetNamespace:")
+
+        stub = stub_commerce_request({with_body: body, fixture: 'update_transaction_response'})
+
+        data = {
+          opportunityName_quote: "Test Oppty Auto Approval TinderBox",
+          siteName_quote: "MY DUMMY SITE",
+          notesCMPM_es: "http://subdomain.mytinder.com/view/X2Y58?version=1"
+        }
+        response = subject.update_transaction(26539349, data)
+
+        expect(response[:status][:success]).to eq(true)
+      end
     end
   end
 

data/spec/support/fixture_helpers.rb

@@ -6,11 +6,6 @@ module FixtureHelpers
       stub_api_request(options)
     end
 
-    def stub_security_request(options={})
-      options = options.merge({headers: {service: :security}})
-      stub_api_request(options)
-    end
-
     def stub_api_request(options={})
       options = {
         :method => :post,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: big_machines
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Joe Heth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-17 00:00:00.000000000 Z
+date: 2014-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: savon
@@ -17,7 +17,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.3.0
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.3.0
   type: :runtime
@@ -27,7 +27,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.3.0
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.3.0
 - !ruby/object:Gem::Dependency
@@ -51,7 +51,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.14.0
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.14.0
   type: :development
@@ -61,7 +61,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.14.0
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.14.0
 - !ruby/object:Gem::Dependency
@@ -71,7 +71,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.13.0
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.13.0
   type: :development
@@ -81,7 +81,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.13.0
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.13.0
 - !ruby/object:Gem::Dependency
@@ -91,7 +91,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.7.1
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.7.1
   type: :development
@@ -101,7 +101,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.7.1
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.7.1
 description: BigMachine's SOAP API Implementation
@@ -124,12 +124,14 @@ files:
 - lib/big_machines/version.rb
 - resources/commerce.wsdl.xml
 - resources/security.wsdl.xml
+- spec/fixtures/get_transaction_not_found_response.xml
 - spec/fixtures/get_transaction_response.xml
 - spec/fixtures/get_transaction_response_full.xml
 - spec/fixtures/get_user_info_response.xml
 - spec/fixtures/login_response.xml
 - spec/fixtures/logout_response.xml
 - spec/fixtures/set_session_currency_response.xml
+- spec/fixtures/update_transaction_response.xml
 - spec/lib/client_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixture_helpers.rb
@@ -143,27 +145,29 @@ 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.2.2
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Communicate with BigMachine's SOAP API
 test_files:
+- spec/fixtures/get_transaction_not_found_response.xml
 - spec/fixtures/get_transaction_response.xml
 - spec/fixtures/get_transaction_response_full.xml
 - spec/fixtures/get_user_info_response.xml
 - spec/fixtures/login_response.xml
 - spec/fixtures/logout_response.xml
 - spec/fixtures/set_session_currency_response.xml
+- spec/fixtures/update_transaction_response.xml
 - spec/lib/client_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixture_helpers.rb