big_machines 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzAxYWIzMjQ1YWViZjdiZDk5YjMzMjhlMWU0OGJjZGY1ODhiMGUyYw==
+  data.tar.gz: !binary |-
+    MmNkZGQ1M2QyZmU1MjRiNWFiM2I3MTE0MzhmZWEyMGVjNzBlNTI0Mg==
+SHA512:
+  metadata.gz: !binary |-
+    MzNhOTM4MzAwYjZiYjM0NzYzYTY4OTlhMDkyM2VhM2Y3OTM1MzJkYTk5NTMz
+    NzcwMmQ5NGJmMTMxZjMwNGZmNjA4YzM5OTA5MjU4ZTc2YTZhYTRkOTlkZDAx
+    MWQzNGRmOWZiNjM2MDliNDgzNWY3ZjgxMTU3OTE5ZWEzZDljMzE=
+  data.tar.gz: !binary |-
+    OTYyMWM4OGQ4NzRkNGZjZmRjZWFhODdjNTM4NDFlN2MxNzI0YTVlNmE0MTJh
+    NGUxYzhlZjQ1MjZiYTU5MzlhYjRmMDA4MDk4NTNlNWIwNTBkZTE5OTFlNmE3
+    MWU4N2M2OTAyYTE1YmVlMjIxNjAzYzc2MWI4ZGE3YzIyOTAwZDc=

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.3
+notifications:
+  email:
+    recipients:
+      - joeheth@gmail.com
+    on_success: never
+    on_failure: always

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in big_machines.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Joe Heth
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,96 @@
+# BigMachines
+
+[![Build Status](https://travis-ci.org/TinderBox/big_machines.png)](https://travis-ci.org/TinderBox/big_machines)
+
+Ruby gem for the undocumented BigMachines SOAP API
+
+### Implemented Operations
+
+* Security API - login, logout, getUserInfo, setSessionCurrency
+* Commerce API - getTransaction, updateTransaction (partial)
+
+### Services Not Implemented
+
+* Configuration, Parts, Data Tables, Users, Groups, Exchange Rates
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'big_machines'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install big_machines
+
+## Usage
+
+
+#### Create Client
+
+```ruby
+client = BigMachines::Client.new('subdomain')
+```
+
+```ruby
+# Specify process name
+client = BigMachines::Client.new('subdomain', process_name: 'quotes_process')
+```
+
+
+#### Authenticate
+
+```ruby
+client.login(:username => 'foo', :password => 'password')
+```
+
+### set_session_currency
+
+```ruby
+client.set_session_currency('USD')
+# => Hash[:status]
+```
+
+### get_user_info
+
+```ruby
+client.get_user_info
+# => Hash[:user_info]
+```
+
+### get_transaction
+
+```ruby
+# Find transaction by id
+client.get_transaction(id)
+# => BigMachines::Transaction
+```
+
+### update_transaction
+
+```ruby
+# Update transaction
+client.update_transaction(id, data={})
+# => Hash[:status]
+```
+
+
+### logout
+
+```ruby
+client.logout
+```
+
+
+## Contributing
+
+1. Fork it ( http://github.com/TinderBox/big_machines/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/big_machines.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'big_machines/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "big_machines"
+  spec.version       = BigMachines::VERSION
+  spec.authors       = ["Joe Heth"]
+  spec.email         = ["joeheth@gmail.com"]
+  spec.summary       = %q{Communicate with BigMachine's SOAP API}
+  spec.description   = %q{BigMachine's SOAP API Implementation}
+  spec.homepage      = "https://github.com/TinderBox/big_machines"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'savon', '~> 2.3.0', '>= 2.3.0'
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake', '~> 0'
+
+  spec.add_development_dependency 'rspec', '~> 2.14.0', '>= 2.14.0'
+  spec.add_development_dependency 'webmock', '~> 1.13.0', '>= 1.13.0'
+  spec.add_development_dependency 'simplecov', '~> 0.7.1', '>= 0.7.1'
+end

data/lib/big_machines/client.rb

@@ -0,0 +1,238 @@
+module BigMachines
+  class Client
+
+    attr_reader :client
+    attr_reader :headers
+
+    # The partner.wsdl is used by default but can be changed by passing in a new :wsdl option.
+    # A client_id can be
+    def initialize(site_name, options={})
+      @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"
+
+      @namespaces = {
+        "xmlns:bm" => "urn:soap.bigmachines.com"
+      }
+
+      @security_wsdl = File.dirname(__FILE__) + "/../../resources/security.wsdl.xml"
+      @commerce_wsdl = File.dirname(__FILE__) + "/../../resources/commerce.wsdl.xml"
+
+      @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
+      )
+    end
+
+    def headers(type=:security)
+      if type == :security
+        category = "Security"
+        schema = "https://#{@site_name}.bigmachines.com/bmfsweb/#{@site_name}/schema/v1_0/security/Security.xsd"
+      else
+        category = "Commerce"
+        schema = "https://#{@site_name}.bigmachines.com/bmfsweb/#{@site_name}/schema/v1_0/commerce/#{@process_var_name}.xsd"
+      end
+
+      @headers = ''
+      if @session_id
+        @headers << %Q{<bm:userInfo xmlns:bm="urn:soap.bigmachines.com">
+<bm:sessionId>#{@session_id}</bm:sessionId>
+</bm:userInfo>}
+      end
+
+      @headers << %Q{
+<bm:category xmlns:bm="urn:soap.bigmachines.com">#{category}</bm:category>
+<bm:xsdInfo xmlns:bm="urn:soap.bigmachines.com">
+<bm:schemaLocation>#{schema}</bm:schemaLocation>
+</bm:xsdInfo>}.gsub(/\n/, '')
+
+      @headers
+    end
+
+    # Public: Get the names of all wsdl operations.
+    # List all available operations from the partner.wsdl
+    def operations
+      @client.operations
+    end
+
+    # Public: Get the names of all wsdl operations.
+    #
+    # Supports a username/password (with token) combination or session_id/server_url pair.
+    #
+    # Examples
+    #
+    #   client.login(username: 'test', password: 'password_and_token')
+    #   # => {...}
+    #
+    #   client.login(session_id: 'abcd1234', server_url: 'https://na1.salesforce.com/')
+    #   # => {...}
+    #
+    # Returns Hash of login response and user info
+    def login(options={})
+      result = nil
+      if options[:username] && options[:password]
+        message = {userInfo: {username: options[:username], password: options[:password]}}
+        response = self.security_call(:login, message)
+
+        userInfo = response[:user_info]
+
+        @session_id = userInfo[:session_id]
+      else
+        raise ArgumentError.new("Must provide username/password or session_id/server_url.")
+      end
+
+      @security_client = Savon.client(
+        wsdl: @security_wsdl,
+        endpoint: @endpoint,
+        soap_header: headers(:security),
+        convert_request_keys_to: :none,
+        pretty_print_xml: true
+      )
+
+      # 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
+    end
+    alias_method :authenticate, :login
+
+    def set_session_currency(currency)
+      security_call(:set_session_currency, sessionCurrency: currency)
+    end
+
+    # Commerce API
+    #
+    # <bm:getTransaction xmlns:bm="urn:soap.bigmachines.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+    #   <bm:transaction>
+    #     <bm:id/>
+    #     <bm:return_specific_attributes>
+    #       <bm:documents>
+    #         <bm:document>
+    #           <bm:var_name>quote_process</bm:var_name>
+    #           <bm:attributes>
+    #             <bm:attribute>_document_number</bm:attribute>
+    #           </bm:attributes>
+    #         </bm:document>
+    #       </bm:documents>
+    #     </bm:return_specific_attributes>
+    #   </bm:transaction>
+    # </bm:getTransaction>
+    def get_transaction(id)
+      transaction = {
+        transaction: {
+          id: id,
+          return_specific_attributes: {
+            documents: {
+              document: {
+                var_name: "quote_process"
+              }
+            }
+          }
+        }
+      }
+
+      result = commerce_call(:get_transaction, transaction)
+      BigMachines::Transaction.new(result)
+    end
+
+    # <bm:updateTransaction xmlns:bm="urn:soap.bigmachines.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+    #   <bm:transaction>
+    #     <bm:id>26539349</bm:id>
+    #     <bm:data_xml>
+    #       <bm:quote_process bm:bs_id="26539349" bm:data_type="0" bm:document_number="1">
+    #         <bm:opportunityName_quote>Test Oppty Auto Approval TinderBox</bm:opportunityName_quote>
+    #         <bm:siteName_quote>MY DUMMY SITE</bm:siteName_quote>
+    #       </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>
+    def update_transaction(id, 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'
+            }
+          },
+          action_data: {
+            action_var_name: '_update_line_items'
+          }
+        }
+      }
+
+      commerce_call(:update_transaction, transaction)
+    end
+
+    # Supports the following No Argument methods:
+    #   get_user_info
+    #   logout
+    def method_missing(method, *args)
+      if [:get_user_info, :logout].include?(method)
+        call_soap_api(security_client, method, *args)
+      else
+        super
+      end
+    end
+
+    protected
+
+    def commerce_client
+      @commerce_client ||= client_api(@commerce_wsdl)
+    end
+
+    def security_client
+      @security_client ||= client_api(@security_wsdl)
+    end
+
+    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
+      )
+    end
+
+    def security_call(method, message_hash={})
+      call_soap_api(security_client, method, message_hash)
+    end
+
+    def commerce_call(method, message_hash={})
+      call_soap_api(commerce_client, method, message_hash)
+    end
+
+    def call_soap_api(client, method, message={})
+      response = client.call(method.to_sym, message: message)
+      # Convert SOAP XML to Hash
+      response = response.to_hash
+
+      # Get Response Body
+      response = response["#{method}_response".to_sym]
+
+      # Raise error when response contains errors
+      if response.is_a?(Hash) && response[:status] && response[:status][:success] == false
+        raise Savon::Error.new(response[:status][:message])
+      end
+
+      return response
+    end
+
+  end
+end

data/lib/big_machines/transaction.rb

@@ -0,0 +1,28 @@
+module BigMachines
+  class Transaction
+    attr_reader :raw_transaction
+
+    def initialize(response)
+      @raw_transaction = response
+      # Metadata
+      @transaction = response[:transaction]
+      # Quote
+      @quote_process = @transaction[:data_xml][:quote_process]
+      # Quote Line Items
+      @line_process = @quote_process[:sub_documents][:line_process]
+    end
+
+    def method_missing(method, *args)
+      @transaction[method]
+    end
+
+    def quote
+      @quote_process
+    end
+
+    def quote_line_items
+      @line_process
+    end
+
+  end
+end

data/lib/big_machines/version.rb

@@ -0,0 +1,3 @@
+module BigMachines
+  VERSION = "0.0.1"
+end

data/lib/big_machines.rb

@@ -0,0 +1,9 @@
+require "big_machines/version"
+
+require 'savon'
+require "big_machines/client"
+require "big_machines/transaction"
+
+module BigMachines
+  # Your code goes here...
+end