quickbooks_web_connector 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,109 @@
+QuickbooksWebConnector
+======================
+
+QuickbooksWebConnector is a Redis-backed library for queueing up requests for the Quickbooks Web Connector software to fetch and perform. Responses from the Quickbooks Web Connector can also be handled if you need to take some action with the result.
+
+QuickbooksWebConnector is heavily inspired by [QBWC](https://github.com/skryl/qbwc) and [Resque](https://github.com/defunkt/resque), so many thanks to the great people behind those gems.
+
+Requirements
+------------
+
+QuickbooksWebConnector has only been tested on Rails 3.2.9
+
+Overview
+--------
+
+QuickbooksWebConnector allows you to create requests and place them on the queue for the Quickbooks Web Connector to fetch, with a response handler to handle the Quickbooks response.
+
+A response handler is a Ruby class than responds to the `perform` method that receives the response XML as a string and any additional arguments you specified when enqueueing the request. Here's an example:
+
+```ruby
+require 'rexml/document'
+
+class AddCustomerHandler
+
+  def self.perform(response_xml, customer_id)
+    customer = Customer.find(customer_id)
+    customer.quickbooks_list_id = REXML::Document.new(response_xml).root.text('QBXMLMsgsRs/CustomerAddRs/CustomerRet/ListID')
+    customer.save!
+  end
+
+end
+```
+
+To enqueue a request, you might add this to your model as an `after_create` callback, or maybe your controller's create action:
+
+```ruby
+class Customer
+
+  after_create :add_to_quickbooks
+
+  def add_to_quickbooks
+    request_xml = <<-EOT
+      <?xml version="1.0" encoding="UTF-8"?>
+      <?qbxml version="6.0"?>
+      <QBXML>
+        <QBXMLMsgsRq onError="stopOnError">
+          <CustomerAddRq>
+            <CustomerAdd>
+              <Name>FooBar Inc</Name>
+            </CustomerAdd>
+          </CustomerAddRq>
+        </QBXMLMsgsRq>
+      </QBXML>
+    EOT
+
+    QuickbooksWebConnector.enqueue request_xml, AddCustomerHandler, id
+  end
+
+end
+```
+
+Once Quickbooks Web Connector received your request and processed it, it would return a response, and your handler will get called like:
+
+```ruby
+AddCustomerHandler.perform response_xml, 1
+```
+
+Installing QuickbooksWebConnector
+=================================
+
+First include it in your Gemfile:
+
+```
+$ cat Gemfile
+...
+gem 'quickbooks_web_connector'
+...
+```
+
+Next install it with Bundler:
+
+```
+$ bundle install
+```
+
+Mount the engine in your routes.rb
+
+```
+mount QuickbooksWebConnector::Engine => "/quickbooks_web_connector"
+```
+
+TODO: Add note about config in initializer
+
+Now start your application:
+
+```
+$ rails server
+```
+
+Contributing
+============
+
+Once you've made your great commits:
+
+1. [Fork](https://help.github.com/forking/) QuickbooksWebConnector
+2. Create a topic branch: `git checkout -b my_feature`
+3. Push to your branch: `git push origin my_feature`
+4. Create a [Pull Request](https://help.github.com/pull-requests/) from your branch
+5. That's it!

data/Rakefile

@@ -0,0 +1,28 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'QuickbooksWebConnector'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks

data/app/assets/javascripts/quickbooks_web_connector/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/quickbooks_web_connector/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/quickbooks_web_connector/application_controller.rb

@@ -0,0 +1,5 @@
+module QuickbooksWebConnector
+  class ApplicationController < ActionController::Base
+    skip_before_filter :verify_authenticity_token
+  end
+end

data/app/controllers/quickbooks_web_connector/qwc_controller.rb

@@ -0,0 +1,12 @@
+module QuickbooksWebConnector
+  class QwcController < ApplicationController
+
+    def download
+      send_data render_to_string(:qwc),
+                disposition: 'attachment',
+                filename: 'qbwc.qwc',
+                type: :xml
+    end
+
+  end
+end

data/app/controllers/quickbooks_web_connector/soap_controller.rb

@@ -0,0 +1,10 @@
+module QuickbooksWebConnector
+  class SoapController < ApplicationController
+
+    def endpoint
+      response = SoapWrapper.route(request)
+      render xml: response, content_type: 'text/xml'
+    end
+
+  end
+end

data/app/helpers/quickbooks_web_connector/application_helper.rb

@@ -0,0 +1,4 @@
+module QuickbooksWebConnector
+  module ApplicationHelper
+  end
+end

data/app/views/layouts/quickbooks_web_connector/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>QuickbooksWebConnector</title>
+  <%= stylesheet_link_tag    "quickbooks_web_connector/application", :media => "all" %>
+  <%= javascript_include_tag "quickbooks_web_connector/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/quickbooks_web_connector/qwc/qwc.xml.builder

@@ -0,0 +1,12 @@
+xml.instruct!
+xml.QBWCXML do
+  xml.AppName 'My QBWC App'
+  xml.AppID
+  xml.AppURL quickbooks_web_connector.soap_url
+  xml.AppDescription 'My QBWC App Description'
+  xml.AppSupport main_app.root_url
+  xml.UserName QuickbooksWebConnector.config.username
+  xml.OwnerID '{d69682e6-4436-44bc-bd19-d6bfbd11778d}'
+  xml.FileID '{916222f3-c574-4c70-8c9d-e3cec2634e49}'
+  xml.QBType 'QBFS'
+end

data/config/routes.rb

@@ -0,0 +1,6 @@
+QuickbooksWebConnector::Engine.routes.draw do
+
+  get 'qwc' => 'qwc#download', defaults: { format: :xml }
+  post 'soap' => 'soap#endpoint'
+
+end

data/lib/quickbooks_web_connector/config.rb

@@ -0,0 +1,35 @@
+require 'active_support/configurable'
+
+module QuickbooksWebConnector
+  # Configure global settings for QuickbooksWebConnector
+  #   QuickbooksWebConnector.configure do |config|
+  #     config.server_version
+  #   end
+  def self.configure(&block)
+    yield @config ||= QuickbooksWebConnector::Configuration.new
+  end
+
+  # Global settings for QuickbooksWebConnector
+  def self.config
+    @config
+  end
+
+  class Configuration
+    include ActiveSupport::Configurable
+
+    config_accessor :server_version
+    config_accessor :minimum_web_connector_client_version
+    config_accessor :username
+    config_accessor :password
+    config_accessor :company_file_path
+  end
+
+  configure do |config|
+    config.server_version = '1.0.0'
+    config.minimum_web_connector_client_version = nil
+    config.username = 'web_connector'
+    config.password = 'secret'
+    config.company_file_path = ''
+  end
+
+end

data/lib/quickbooks_web_connector/engine.rb

@@ -0,0 +1,5 @@
+module QuickbooksWebConnector
+  class Engine < ::Rails::Engine
+    isolate_namespace QuickbooksWebConnector
+  end
+end

data/lib/quickbooks_web_connector/job.rb

@@ -0,0 +1,61 @@
+module QuickbooksWebConnector
+  class Job
+
+    attr_accessor :response_xml
+
+    def initialize(payload)
+      @payload = payload
+    end
+
+    # Creates a job by placing it on the queue. Expects XML as a string,
+    # a string class name, and an optional array of arguments to
+    # pass to the class' `perform` method.
+    #
+    # Raises an exception if no class is given.
+    def self.create(request_xml, klass, *args)
+      QuickbooksWebConnector.push('request_xml' => request_xml, 'class' => klass.to_s, 'args' => args)
+    end
+
+    # Returns an instance of QuickbooksWebConnector::Job
+    # if any jobs are available. If not, returns nil.
+    def self.reserve
+      return unless payload = QuickbooksWebConnector.pop
+      new(payload)
+    end
+
+    # Return an instance of QuickbooksWebConnector::job if any jobs are
+    # available, without removing the job from the queue
+    def self.peek
+      return unless payload = QuickbooksWebConnector.peek
+      new(payload)
+    end
+
+    # Attempts to perform the work represented by this job instance.
+    # Calls #perform on the class given in the payload with the
+    # Quickbooks response and the arguments given in the payload..
+    def perform
+      job = payload_class
+      job_args = args || []
+      job_args.prepend response_xml
+
+      # Execute the job.
+      job.perform(*job_args)
+    end
+
+    # Returns the request XML from the payload.
+    def request_xml
+      @payload['request_xml']
+    end
+
+    # Returns the actual class constant represented in this job's payload.
+    def payload_class
+      @payload_class ||= @payload['class'].constantize
+    end
+
+    # Returns an array of args represented in this job's payload.
+    def args
+      @payload['args']
+    end
+
+  end
+end

data/lib/quickbooks_web_connector/json_coder.rb

@@ -0,0 +1,23 @@
+module QuickbooksWebConnector
+  class EncodeException < StandardError; end
+  class DecodeException < StandardError; end
+
+  class JsonCoder
+    # Given a Ruby object, returns a string suitable for storage in the
+    # queue.
+    def encode(object)
+      JSON.dump object
+    end
+
+    # Given a string, returns a Ruby object.
+    def decode(object)
+      return unless object
+
+      begin
+        JSON.load object
+      rescue JSON::ParserError => e
+        raise DecodeException, e.message, e.backtrace
+      end
+    end
+  end
+end

data/lib/quickbooks_web_connector/soap_wrapper/QBWebConnectorSvc.rb

@@ -0,0 +1,72 @@
+module QuickbooksWebConnector
+  module SoapWrapper
+    class QBWebConnectorSvcSoap
+      Methods = [
+        [ "http://developer.intuit.com/serverVersion",
+          "serverVersion",
+          [ [:in, "parameters", ["::SOAP::SOAPElement", "http://developer.intuit.com/", "serverVersion"]],
+            [:out, "parameters", ["::SOAP::SOAPElement", "http://developer.intuit.com/", "serverVersionResponse"]] ],
+          { :request_style =>  :document, :request_use =>  :literal,
+            :response_style => :document, :response_use => :literal,
+            :faults => {} }
+        ],
+        [ "http://developer.intuit.com/clientVersion",
+          "clientVersion",
+          [ [:in, "parameters", ["::SOAP::SOAPElement", "http://developer.intuit.com/", "clientVersion"]],
+            [:out, "parameters", ["::SOAP::SOAPElement", "http://developer.intuit.com/", "clientVersionResponse"]] ],
+          { :request_style =>  :document, :request_use =>  :literal,
+            :response_style => :document, :response_use => :literal,
+            :faults => {} }
+        ],
+        [ "http://developer.intuit.com/authenticate",
+          "authenticate",
+          [ [:in, "parameters", ["::SOAP::SOAPElement", "http://developer.intuit.com/", "authenticate"]],
+            [:out, "parameters", ["::SOAP::SOAPElement", "http://developer.intuit.com/", "authenticateResponse"]] ],
+          { :request_style =>  :document, :request_use =>  :literal,
+            :response_style => :document, :response_use => :literal,
+            :faults => {} }
+        ],
+        [ "http://developer.intuit.com/sendRequestXML",
+          "sendRequestXML",
+          [ [:in, "parameters", ["::SOAP::SOAPElement", "http://developer.intuit.com/", "sendRequestXML"]],
+            [:out, "parameters", ["::SOAP::SOAPElement", "http://developer.intuit.com/", "sendRequestXMLResponse"]] ],
+          { :request_style =>  :document, :request_use =>  :literal,
+            :response_style => :document, :response_use => :literal,
+            :faults => {} }
+        ],
+        [ "http://developer.intuit.com/receiveResponseXML",
+          "receiveResponseXML",
+          [ [:in, "parameters", ["::SOAP::SOAPElement", "http://developer.intuit.com/", "receiveResponseXML"]],
+            [:out, "parameters", ["::SOAP::SOAPElement", "http://developer.intuit.com/", "receiveResponseXMLResponse"]] ],
+          { :request_style =>  :document, :request_use =>  :literal,
+            :response_style => :document, :response_use => :literal,
+            :faults => {} }
+        ],
+        [ "http://developer.intuit.com/connectionError",
+          "connectionError",
+          [ [:in, "parameters", ["::SOAP::SOAPElement", "http://developer.intuit.com/", "connectionError"]],
+            [:out, "parameters", ["::SOAP::SOAPElement", "http://developer.intuit.com/", "connectionErrorResponse"]] ],
+          { :request_style =>  :document, :request_use =>  :literal,
+            :response_style => :document, :response_use => :literal,
+            :faults => {} }
+        ],
+        [ "http://developer.intuit.com/getLastError",
+          "getLastError",
+          [ [:in, "parameters", ["::SOAP::SOAPElement", "http://developer.intuit.com/", "getLastError"]],
+            [:out, "parameters", ["::SOAP::SOAPElement", "http://developer.intuit.com/", "getLastErrorResponse"]] ],
+          { :request_style =>  :document, :request_use =>  :literal,
+            :response_style => :document, :response_use => :literal,
+            :faults => {} }
+        ],
+        [ "http://developer.intuit.com/closeConnection",
+          "closeConnection",
+          [ [:in, "parameters", ["::SOAP::SOAPElement", "http://developer.intuit.com/", "closeConnection"]],
+            [:out, "parameters", ["::SOAP::SOAPElement", "http://developer.intuit.com/", "closeConnectionResponse"]] ],
+          { :request_style =>  :document, :request_use =>  :literal,
+            :response_style => :document, :response_use => :literal,
+            :faults => {} }
+        ]
+      ]
+    end
+  end
+end

data/lib/quickbooks_web_connector/soap_wrapper/default.rb

@@ -0,0 +1,204 @@
+require 'xsd/qname'
+
+# {http://developer.intuit.com/}ArrayOfString
+class ArrayOfString < ::Array
+end
+
+module QuickbooksWebConnector
+  module SoapWrapper
+
+    # {http://developer.intuit.com/}authenticate
+    #   strUserName - SOAP::SOAPString
+    #   strPassword - SOAP::SOAPString
+    class Authenticate
+      attr_accessor :strUserName
+      attr_accessor :strPassword
+
+      def initialize(strUserName = nil, strPassword = nil)
+        @strUserName = strUserName
+        @strPassword = strPassword
+      end
+    end
+
+    # {http://developer.intuit.com/}authenticateResponse
+    #   authenticateResult - ArrayOfString
+    class AuthenticateResponse
+      attr_accessor :authenticateResult
+
+      def initialize(authenticateResult = nil)
+        @authenticateResult = authenticateResult
+      end
+    end
+
+    # {http://developer.intuit.com/}serverVersion
+    #   strVersion - SOAP::SOAPString
+    class ServerVersion
+      attr_accessor :strVersion
+
+      def initialize(strVersion = nil)
+        @strVersion = strVersion
+      end
+    end
+
+    # {http://developer.intuit.com/}serverVersionResponse
+    #   serverVersionResult - SOAP::SOAPString
+    class ServerVersionResponse
+      attr_accessor :serverVersionResult
+
+      def initialize(serverVersionResult = nil)
+        @serverVersionResult = serverVersionResult
+      end
+    end
+
+    # {http://developer.intuit.com/}clientVersion
+    #   strVersion - SOAP::SOAPString
+    class ClientVersion
+      attr_accessor :strVersion
+
+      def initialize(strVersion = nil)
+        @strVersion = strVersion
+      end
+    end
+
+    # {http://developer.intuit.com/}clientVersionResponse
+    #   clientVersionResult - SOAP::SOAPString
+    class ClientVersionResponse
+      attr_accessor :clientVersionResult
+
+      def initialize(clientVersionResult = nil)
+        @clientVersionResult = clientVersionResult
+      end
+    end
+
+    # {http://developer.intuit.com/}sendRequestXML
+    #   ticket - SOAP::SOAPString
+    #   strHCPResponse - SOAP::SOAPString
+    #   strCompanyFileName - SOAP::SOAPString
+    #   qbXMLCountry - SOAP::SOAPString
+    #   qbXMLMajorVers - SOAP::SOAPInt
+    #   qbXMLMinorVers - SOAP::SOAPInt
+    class SendRequestXML
+      attr_accessor :ticket
+      attr_accessor :strHCPResponse
+      attr_accessor :strCompanyFileName
+      attr_accessor :qbXMLCountry
+      attr_accessor :qbXMLMajorVers
+      attr_accessor :qbXMLMinorVers
+
+      def initialize(ticket = nil, strHCPResponse = nil, strCompanyFileName = nil, qbXMLCountry = nil, qbXMLMajorVers = nil, qbXMLMinorVers = nil)
+        @ticket = ticket
+        @strHCPResponse = strHCPResponse
+        @strCompanyFileName = strCompanyFileName
+        @qbXMLCountry = qbXMLCountry
+        @qbXMLMajorVers = qbXMLMajorVers
+        @qbXMLMinorVers = qbXMLMinorVers
+      end
+    end
+
+    # {http://developer.intuit.com/}sendRequestXMLResponse
+    #   sendRequestXMLResult - SOAP::SOAPString
+    class SendRequestXMLResponse
+      attr_accessor :sendRequestXMLResult
+
+      def initialize(sendRequestXMLResult = nil)
+        @sendRequestXMLResult = sendRequestXMLResult
+      end
+    end
+
+    # {http://developer.intuit.com/}receiveResponseXML
+    #   ticket - SOAP::SOAPString
+    #   response - SOAP::SOAPString
+    #   hresult - SOAP::SOAPString
+    #   message - SOAP::SOAPString
+    class ReceiveResponseXML
+      attr_accessor :ticket
+      attr_accessor :response
+      attr_accessor :hresult
+      attr_accessor :message
+
+      def initialize(ticket = nil, response = nil, hresult = nil, message = nil)
+        @ticket = ticket
+        @response = response
+        @hresult = hresult
+        @message = message
+      end
+    end
+
+    # {http://developer.intuit.com/}receiveResponseXMLResponse
+    #   receiveResponseXMLResult - SOAP::SOAPInt
+    class ReceiveResponseXMLResponse
+      attr_accessor :receiveResponseXMLResult
+
+      def initialize(receiveResponseXMLResult = nil)
+        @receiveResponseXMLResult = receiveResponseXMLResult
+      end
+    end
+
+    # {http://developer.intuit.com/}connectionError
+    #   ticket - SOAP::SOAPString
+    #   hresult - SOAP::SOAPString
+    #   message - SOAP::SOAPString
+    class ConnectionError
+      attr_accessor :ticket
+      attr_accessor :hresult
+      attr_accessor :message
+
+      def initialize(ticket = nil, hresult = nil, message = nil)
+        @ticket = ticket
+        @hresult = hresult
+        @message = message
+      end
+    end
+
+    # {http://developer.intuit.com/}connectionErrorResponse
+    #   connectionErrorResult - SOAP::SOAPString
+    class ConnectionErrorResponse
+      attr_accessor :connectionErrorResult
+
+      def initialize(connectionErrorResult = nil)
+        @connectionErrorResult = connectionErrorResult
+      end
+    end
+
+    # {http://developer.intuit.com/}getLastError
+    #   ticket - SOAP::SOAPString
+    class GetLastError
+      attr_accessor :ticket
+
+      def initialize(ticket = nil)
+        @ticket = ticket
+      end
+    end
+
+    # {http://developer.intuit.com/}getLastErrorResponse
+    #   getLastErrorResult - SOAP::SOAPString
+    class GetLastErrorResponse
+      attr_accessor :getLastErrorResult
+
+      def initialize(getLastErrorResult = nil)
+        @getLastErrorResult = getLastErrorResult
+      end
+    end
+
+    # {http://developer.intuit.com/}closeConnection
+    #   ticket - SOAP::SOAPString
+    class CloseConnection
+      attr_accessor :ticket
+
+      def initialize(ticket = nil)
+        @ticket = ticket
+      end
+    end
+
+    # {http://developer.intuit.com/}closeConnectionResponse
+    #   closeConnectionResult - SOAP::SOAPString
+    class CloseConnectionResponse
+      attr_accessor :closeConnectionResult
+
+      def initialize(closeConnectionResult = nil)
+        @closeConnectionResult = closeConnectionResult
+      end
+    end
+
+  end
+end