quickbooks_web_connector 0.0.1

data/lib/quickbooks_web_connector/soap_wrapper/defaultMappingRegistry.rb

@@ -0,0 +1,166 @@
+require 'soap/mapping'
+
+module QuickbooksWebConnector
+  module SoapWrapper
+    module DefaultMappingRegistry
+      EncodedRegistry = ::SOAP::Mapping::EncodedRegistry.new
+      LiteralRegistry = ::SOAP::Mapping::LiteralRegistry.new
+      NsDeveloperIntuitCom = "http://developer.intuit.com/"
+
+      EncodedRegistry.register(
+        :class => ArrayOfString,
+        :schema_type => XSD::QName.new(NsDeveloperIntuitCom, "ArrayOfString"),
+        :schema_element => [
+          ["string", "SOAP::SOAPString[]", [0, nil]]
+        ]
+      )
+
+      LiteralRegistry.register(
+        :class => ArrayOfString,
+        :schema_type => XSD::QName.new(NsDeveloperIntuitCom, "ArrayOfString"),
+        :schema_element => [
+          ["string", "SOAP::SOAPString[]", [0, nil]]
+        ]
+      )
+
+      LiteralRegistry.register(
+        :class => Authenticate,
+        :schema_name => XSD::QName.new(NsDeveloperIntuitCom, "authenticate"),
+        :schema_element => [
+          ["strUserName", "SOAP::SOAPString", [0, 1]],
+          ["strPassword", "SOAP::SOAPString", [0, 1]]
+        ]
+      )
+
+      LiteralRegistry.register(
+        :class => AuthenticateResponse,
+        :schema_name => XSD::QName.new(NsDeveloperIntuitCom, "authenticateResponse"),
+        :schema_element => [
+          ["authenticateResult", "ArrayOfString", [0, 1]]
+        ]
+      )
+
+      LiteralRegistry.register(
+        :class => ServerVersion,
+        :schema_name => XSD::QName.new(NsDeveloperIntuitCom, "serverVersion"),
+        :schema_element => [
+          ["strVersion", "SOAP::SOAPString", [0, 1]]
+        ]
+      )
+
+      LiteralRegistry.register(
+        :class => ServerVersionResponse,
+        :schema_name => XSD::QName.new(NsDeveloperIntuitCom, "serverVersionResponse"),
+        :schema_element => [
+          ["serverVersionResult", "SOAP::SOAPString", [0, 1]]
+        ]
+      )
+
+      LiteralRegistry.register(
+        :class => ClientVersion,
+        :schema_name => XSD::QName.new(NsDeveloperIntuitCom, "clientVersion"),
+        :schema_element => [
+          ["strVersion", "SOAP::SOAPString", [0, 1]]
+        ]
+      )
+
+      LiteralRegistry.register(
+        :class => ClientVersionResponse,
+        :schema_name => XSD::QName.new(NsDeveloperIntuitCom, "clientVersionResponse"),
+        :schema_element => [
+          ["clientVersionResult", "SOAP::SOAPString", [0, 1]]
+        ]
+      )
+
+      LiteralRegistry.register(
+        :class => SendRequestXML,
+        :schema_name => XSD::QName.new(NsDeveloperIntuitCom, "sendRequestXML"),
+        :schema_element => [
+          ["ticket", "SOAP::SOAPString", [0, 1]],
+          ["strHCPResponse", "SOAP::SOAPString", [0, 1]],
+          ["strCompanyFileName", "SOAP::SOAPString", [0, 1]],
+          ["qbXMLCountry", "SOAP::SOAPString", [0, 1]],
+          ["qbXMLMajorVers", "SOAP::SOAPInt"],
+          ["qbXMLMinorVers", "SOAP::SOAPInt"]
+        ]
+      )
+
+      LiteralRegistry.register(
+        :class => SendRequestXMLResponse,
+        :schema_name => XSD::QName.new(NsDeveloperIntuitCom, "sendRequestXMLResponse"),
+        :schema_element => [
+          ["sendRequestXMLResult", "SOAP::SOAPString", [0, 1]]
+        ]
+      )
+
+      LiteralRegistry.register(
+        :class => ReceiveResponseXML,
+        :schema_name => XSD::QName.new(NsDeveloperIntuitCom, "receiveResponseXML"),
+        :schema_element => [
+          ["ticket", "SOAP::SOAPString", [0, 1]],
+          ["response", "SOAP::SOAPString", [0, 1]],
+          ["hresult", "SOAP::SOAPString", [0, 1]],
+          ["message", "SOAP::SOAPString", [0, 1]]
+        ]
+      )
+
+      LiteralRegistry.register(
+        :class => ReceiveResponseXMLResponse,
+        :schema_name => XSD::QName.new(NsDeveloperIntuitCom, "receiveResponseXMLResponse"),
+        :schema_element => [
+          ["receiveResponseXMLResult", "SOAP::SOAPInt"]
+        ]
+      )
+
+      LiteralRegistry.register(
+        :class => ConnectionError,
+        :schema_name => XSD::QName.new(NsDeveloperIntuitCom, "connectionError"),
+        :schema_element => [
+          ["ticket", "SOAP::SOAPString", [0, 1]],
+          ["hresult", "SOAP::SOAPString", [0, 1]],
+          ["message", "SOAP::SOAPString", [0, 1]]
+        ]
+      )
+
+      LiteralRegistry.register(
+        :class => ConnectionErrorResponse,
+        :schema_name => XSD::QName.new(NsDeveloperIntuitCom, "connectionErrorResponse"),
+        :schema_element => [
+          ["connectionErrorResult", "SOAP::SOAPString", [0, 1]]
+        ]
+      )
+
+      LiteralRegistry.register(
+        :class => GetLastError,
+        :schema_name => XSD::QName.new(NsDeveloperIntuitCom, "getLastError"),
+        :schema_element => [
+          ["ticket", "SOAP::SOAPString", [0, 1]]
+        ]
+      )
+
+      LiteralRegistry.register(
+        :class => GetLastErrorResponse,
+        :schema_name => XSD::QName.new(NsDeveloperIntuitCom, "getLastErrorResponse"),
+        :schema_element => [
+          ["getLastErrorResult", "SOAP::SOAPString", [0, 1]]
+        ]
+      )
+
+      LiteralRegistry.register(
+        :class => CloseConnection,
+        :schema_name => XSD::QName.new(NsDeveloperIntuitCom, "closeConnection"),
+        :schema_element => [
+          ["ticket", "SOAP::SOAPString", [0, 1]]
+        ]
+      )
+
+      LiteralRegistry.register(
+        :class => CloseConnectionResponse,
+        :schema_name => XSD::QName.new(NsDeveloperIntuitCom, "closeConnectionResponse"),
+        :schema_element => [
+          ["closeConnectionResult", "SOAP::SOAPString", [0, 1]]
+        ]
+      )
+    end
+  end
+end

data/lib/quickbooks_web_connector/soap_wrapper/defaultServant.rb

@@ -0,0 +1,140 @@
+module QuickbooksWebConnector
+  module SoapWrapper
+
+    class QBWebConnectorSvcSoap
+      # SYNOPSIS
+      #   serverVersion(parameters)
+      #
+      # ARGS
+      #   parameters      ServerVersion - {http://developer.intuit.com/}serverVersion
+      #
+      # RETURNS
+      #   parameters      ServerVersionResponse - {http://developer.intuit.com/}serverVersionResponse
+      #
+      def serverVersion(parameters)
+        ServerVersionResponse.new(QuickbooksWebConnector.config.server_version)
+      end
+
+      # SYNOPSIS
+      #   clientVersion(parameters)
+      #
+      # ARGS
+      #   parameters      ClientVersion - {http://developer.intuit.com/}clientVersion
+      #
+      # RETURNS
+      #   parameters      ClientVersionResponse - {http://developer.intuit.com/}clientVersionResponse
+      #
+      def clientVersion(parameters)
+        clientVersionResult = nil
+
+        if QuickbooksWebConnector.config.minimum_web_connector_client_version && QuickbooksWebConnector.config.minimum_web_connector_client_version.to_s > parameters.strVersion
+          clientVersionResult = "E:This version of QuickBooks Web Connector is outdated. Version #{QuickbooksWebConnector.config.minimum_web_connector_client_version} or greater is required."
+        end
+
+        ClientVersionResponse.new(clientVersionResult)
+      end
+
+      # SYNOPSIS
+      #   authenticate(parameters)
+      #
+      # ARGS
+      #   parameters      Authenticate - {http://developer.intuit.com/}authenticate
+      #
+      # RETURNS
+      #   parameters      AuthenticateResponse - {http://developer.intuit.com/}authenticateResponse
+      #
+      def authenticate(parameters)
+        token = SecureRandom.uuid
+        result = if parameters.strUserName == QuickbooksWebConnector.config.username && parameters.strPassword == QuickbooksWebConnector.config.password
+          if QuickbooksWebConnector.size > 0
+            QuickbooksWebConnector.config.company_file_path
+          else
+            'none'
+          end
+        else
+          'nvu'
+        end
+
+        AuthenticateResponse.new([token, result, nil, nil])
+      end
+
+      # SYNOPSIS
+      #   sendRequestXML(parameters)
+      #
+      # ARGS
+      #   parameters      SendRequestXML - {http://developer.intuit.com/}sendRequestXML
+      #
+      # RETURNS
+      #   parameters      SendRequestXMLResponse - {http://developer.intuit.com/}sendRequestXMLResponse
+      #
+      def sendRequestXML(parameters)
+        job = QuickbooksWebConnector::Job.peek
+        request_xml = job ? job.request_xml : nil
+
+        SendRequestXMLResponse.new request_xml
+      end
+
+      # SYNOPSIS
+      #   receiveResponseXML(parameters)
+      #
+      # ARGS
+      #   parameters      ReceiveResponseXML - {http://developer.intuit.com/}receiveResponseXML
+      #
+      # RETURNS
+      #   parameters      ReceiveResponseXMLResponse - {http://developer.intuit.com/}receiveResponseXMLResponse
+      #
+      def receiveResponseXML(parameters)
+        job = QuickbooksWebConnector::Job.reserve
+        job.response_xml = parameters.response
+        job.perform
+
+        # TODO: This just returns 1% by default. Need a way to determine the actual percentage done.
+        progress = QuickbooksWebConnector.size == 0 ? 100 : 1
+
+        ReceiveResponseXMLResponse.new(progress)
+      end
+
+      # SYNOPSIS
+      #   connectionError(parameters)
+      #
+      # ARGS
+      #   parameters      ConnectionError - {http://developer.intuit.com/}connectionError
+      #
+      # RETURNS
+      #   parameters      ConnectionErrorResponse - {http://developer.intuit.com/}connectionErrorResponse
+      #
+      def connectionError(parameters)
+        p [parameters]
+        raise NotImplementedError.new
+      end
+
+      # SYNOPSIS
+      #   getLastError(parameters)
+      #
+      # ARGS
+      #   parameters      GetLastError - {http://developer.intuit.com/}getLastError
+      #
+      # RETURNS
+      #   parameters      GetLastErrorResponse - {http://developer.intuit.com/}getLastErrorResponse
+      #
+      def getLastError(parameters)
+        p [parameters]
+        raise NotImplementedError.new
+      end
+
+      # SYNOPSIS
+      #   closeConnection(parameters)
+      #
+      # ARGS
+      #   parameters      CloseConnection - {http://developer.intuit.com/}closeConnection
+      #
+      # RETURNS
+      #   parameters      CloseConnectionResponse - {http://developer.intuit.com/}closeConnectionResponse
+      #
+      def closeConnection(parameters)
+        CloseConnectionResponse.new
+      end
+    end
+
+  end
+end

data/lib/quickbooks_web_connector/soap_wrapper.rb

@@ -0,0 +1,30 @@
+module QuickbooksWebConnector
+  module SoapWrapper
+
+    def self.route(request)
+      @router = ::SOAP::RPC::Router.new('QBWebConnectorSvcSoap')
+      @router.mapping_registry = DefaultMappingRegistry::EncodedRegistry
+      @router.literal_mapping_registry = DefaultMappingRegistry::LiteralRegistry
+
+      servant = QBWebConnectorSvcSoap.new
+      QBWebConnectorSvcSoap::Methods.each do |definitions|
+        opt = definitions.last
+        if opt[:request_style] == :document
+          @router.add_document_operation(servant, *definitions)
+        else
+          @router.add_rpc_operation(servant, *definitions)
+        end
+      end
+
+      @connection_data = ::SOAP::StreamHandler::ConnectionData.new
+      @connection_data.receive_string = request.raw_post
+      @connection_data.receive_contenttype = request.content_type
+      @connection_data.soapaction = nil
+
+      @router.external_ces = nil
+      response_data = @router.route(@connection_data)
+      response_data.send_string
+    end
+
+  end
+end

data/lib/quickbooks_web_connector/version.rb

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

data/lib/quickbooks_web_connector.rb

@@ -0,0 +1,127 @@
+require 'redis/namespace'
+require 'securerandom'
+require 'soap/rpc/standaloneServer'
+
+require 'quickbooks_web_connector/config'
+require 'quickbooks_web_connector/job'
+require 'quickbooks_web_connector/json_coder'
+
+require 'quickbooks_web_connector/soap_wrapper/default'
+require 'quickbooks_web_connector/soap_wrapper/defaultMappingRegistry'
+require 'quickbooks_web_connector/soap_wrapper/defaultServant'
+require 'quickbooks_web_connector/soap_wrapper/QBWebConnectorSvc'
+require "quickbooks_web_connector/soap_wrapper"
+
+require "quickbooks_web_connector/engine"
+
+module QuickbooksWebConnector
+  extend self
+
+  # Accepts:
+  #   1. A 'hostname:port' String
+  #   2. A 'hostname:port:db' String (to select the Redis db)
+  #   3. A 'hostname:port/namespace' String (to set the Redis namespace)
+  #   4. A Redis URL String 'redis://host:port'
+  #   5. An instance of `Redis`, `Redis::Client`, `Redis::DistRedis`,
+  #      or `Redis::Namespace`.
+  def redis=(server)
+    case server
+    when String
+      if server['redis://']
+        redis = Redis.connect(:url => server, :thread_safe => true)
+      else
+        server, namespace = server.split('/', 2)
+        host, port, db = server.split(':')
+        redis = Redis.new(:host => host, :port => port,
+          :thread_safe => true, :db => db)
+      end
+      namespace ||= :qwc
+
+      @redis = Redis::Namespace.new(namespace, :redis => redis)
+    when Redis::Namespace
+      @redis = server
+    else
+      @redis = Redis::Namespace.new(:qwc, :redis => server)
+    end
+  end
+
+  # Returns the current Redis connection. If none has been created, will
+  # create a new one.
+  def redis
+    return @redis if @redis
+    self.redis = Redis.respond_to?(:connect) ? Redis.connect(:thread_safe => true) : "localhost:6379"
+    self.redis
+  end
+
+  # Encapsulation of encode/decode. Overwrite this to use it across QuickbooksWebConnector.
+  # This defaults to JSON for backwards compatibilty.
+  def coder
+    @coder ||= JsonCoder.new
+  end
+  attr_writer :coder
+
+  #
+  # job shortcuts
+  #
+
+  # This method can be used to conveniently add a job to the queue.
+  # It assumes the class you're passing it is a real Ruby class (not
+  # a string or reference).
+  def enqueue(xml, klass, *args)
+    Job.create(xml, klass, *args)
+  end
+
+  # This method will return a `QuickbooksWebConnector::Job` object or
+  # a non-true value depending on whether a job can be obtained.
+  def reserve
+    Job.reserve
+  end
+
+  #
+  # queue manipulation
+  #
+
+  # Pushes a job onto the queue. The item should be any JSON-able Ruby object.
+
+  # The `item` is expected to be a hash with the following keys:
+  #
+  #     xml - The XML to send to Quickbooks as a String.
+  #   class - The String name of the response handler.
+  #    args - An Array of arguments to pass the handler. Usually passed
+  #           via `class.to_class.perform(*args)`.
+  #
+  # Example
+  #
+  #   QuickbooksWebConnector.push('xml' => '<some><xml></xml></some>', class' => 'CustomerAddResponseHandler', 'args' => [ 35 ])
+  #
+  # Returns nothing
+  def push(item)
+    redis.rpush :queue, encode(item)
+  end
+
+  # Pops a job off the queue.
+  #
+  # Returns a Ruby object.
+  def pop
+    decode @redis.lpop(:queue)
+  end
+
+  # Returns an integer representing the size of the queue.
+  def size
+    redis.llen :queue
+  end
+
+  # Returns the next item currently queued, without removing it.
+  def peek
+    decode redis.lindex :queue, 0
+  end
+
+  def encode(object)
+    coder.encode object
+  end
+
+  def decode(object)
+    coder.decode object
+  end
+
+end

data/lib/tasks/quickbooks_web_connector_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :quickbooks_web_connector do
+#   # Task goes here
+# end

data/spec/config/config_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe QuickbooksWebConnector::Configuration do
+  subject { QuickbooksWebConnector.config }
+
+  describe 'server_version' do
+
+    context 'by default' do
+      its(:server_version) { should eq '1.0.0' }
+    end
+
+    context 'configured via config block' do
+      before { QuickbooksWebConnector.configure { |c| c.server_version = '1.2.3' } }
+
+      its(:server_version) { should eq '1.2.3' }
+
+      after { QuickbooksWebConnector.configure { |c| c.server_version = '1.0.0' } }
+    end
+
+  end
+
+  describe 'minimum_web_connector_client_version' do
+
+    context 'by default' do
+      its(:minimum_web_connector_client_version) { should be_nil }
+    end
+
+    context 'configured via config block' do
+      before { QuickbooksWebConnector.configure { |c| c.minimum_web_connector_client_version = '2.1.0.30' } }
+
+      its(:minimum_web_connector_client_version) { should eq '2.1.0.30' }
+
+      after { QuickbooksWebConnector.configure { |c| c.minimum_web_connector_client_version = nil } }
+    end
+
+  end
+
+  context 'username' do
+
+    context 'by default' do
+      its(:username) { should eq 'web_connector' }
+    end
+
+    context 'configured via a config block' do
+      before { QuickbooksWebConnector.configure { |c| c.username = 'jsmith' } }
+
+      its(:username) { should eq 'jsmith' }
+
+      after { QuickbooksWebConnector.configure { |c| c.username = 'web_connector' } }
+    end
+  end
+
+  context 'password' do
+
+    context 'by default' do
+      its(:password) { should eq 'secret' }
+    end
+
+    context 'configured via a config block' do
+      before { QuickbooksWebConnector.configure { |c| c.password = 'quickbooks' } }
+
+      its(:password) { should eq 'quickbooks' }
+
+      after { QuickbooksWebConnector.configure { |c| c.password = 'secret' } }
+    end
+  end
+
+  context 'company_file_path' do
+
+    context 'by default' do
+      its(:company_file_path) { should eq '' }
+    end
+
+    context 'configured via a config block' do
+      before { QuickbooksWebConnector.configure { |c| c.company_file_path = '/path/to/company.qbw' } }
+
+      its(:company_file_path) { should eq '/path/to/company.qbw' }
+
+      after { QuickbooksWebConnector.configure { |c| c.company_file_path = '' } }
+    end
+  end
+
+end

data/spec/controllers/quickbooks_web_connector/qwc_controller_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe QuickbooksWebConnector::QwcController do
+
+  describe 'GET :download' do
+    before { get :download, format: :xml, use_route: 'quickbooks_web_connector' }
+
+    it 'responds with success' do
+      expect(response).to be_success
+    end
+
+    it 'responds as XML' do
+      expect(response.header['Content-Type']).to match(/application\/xml/)
+    end
+
+    it 'sends the file as an attachment' do
+      expect(response.header['Content-Disposition']).to match(/attachment/)
+    end
+
+    it 'names the file' do
+      expect(response.header['Content-Disposition']).to match(/qbwc\.qwc/)
+    end
+
+    it 'renders the qwc template' do
+      assert_template :qwc
+    end
+  end
+
+end