RubyGems - quickbooks_web_connector - Versions diffs - 0.0.1 - Mend

quickbooks_web_connector 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (66) hide show

data/MIT-LICENSE +20 -0
data/README.md +109 -0
data/Rakefile +28 -0
data/app/assets/javascripts/quickbooks_web_connector/application.js +15 -0
data/app/assets/stylesheets/quickbooks_web_connector/application.css +13 -0
data/app/controllers/quickbooks_web_connector/application_controller.rb +5 -0
data/app/controllers/quickbooks_web_connector/qwc_controller.rb +12 -0
data/app/controllers/quickbooks_web_connector/soap_controller.rb +10 -0
data/app/helpers/quickbooks_web_connector/application_helper.rb +4 -0
data/app/views/layouts/quickbooks_web_connector/application.html.erb +14 -0
data/app/views/quickbooks_web_connector/qwc/qwc.xml.builder +12 -0
data/config/routes.rb +6 -0
data/lib/quickbooks_web_connector/config.rb +35 -0
data/lib/quickbooks_web_connector/engine.rb +5 -0
data/lib/quickbooks_web_connector/job.rb +61 -0
data/lib/quickbooks_web_connector/json_coder.rb +23 -0
data/lib/quickbooks_web_connector/soap_wrapper/QBWebConnectorSvc.rb +72 -0
data/lib/quickbooks_web_connector/soap_wrapper/default.rb +204 -0
data/lib/quickbooks_web_connector/soap_wrapper/defaultMappingRegistry.rb +166 -0
data/lib/quickbooks_web_connector/soap_wrapper/defaultServant.rb +140 -0
data/lib/quickbooks_web_connector/soap_wrapper.rb +30 -0
data/lib/quickbooks_web_connector/version.rb +3 -0
data/lib/quickbooks_web_connector.rb +127 -0
data/lib/tasks/quickbooks_web_connector_tasks.rake +4 -0
data/spec/config/config_spec.rb +83 -0
data/spec/controllers/quickbooks_web_connector/qwc_controller_spec.rb +29 -0
data/spec/controllers/quickbooks_web_connector/soap_controller_spec.rb +306 -0
data/spec/dummy/README.rdoc +261 -0
data/spec/dummy/Rakefile +7 -0
data/spec/dummy/app/assets/javascripts/application.js +15 -0
data/spec/dummy/app/assets/stylesheets/application.css +13 -0
data/spec/dummy/app/controllers/application_controller.rb +3 -0
data/spec/dummy/app/helpers/application_helper.rb +2 -0
data/spec/dummy/app/views/layouts/application.html.erb +14 -0
data/spec/dummy/config/application.rb +59 -0
data/spec/dummy/config/boot.rb +10 -0
data/spec/dummy/config/database.yml +25 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +37 -0
data/spec/dummy/config/environments/production.rb +67 -0
data/spec/dummy/config/environments/test.rb +37 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/inflections.rb +15 -0
data/spec/dummy/config/initializers/mime_types.rb +5 -0
data/spec/dummy/config/initializers/secret_token.rb +7 -0
data/spec/dummy/config/initializers/session_store.rb +8 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
data/spec/dummy/config/locales/en.yml +5 -0
data/spec/dummy/config/routes.rb +6 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/db/test.sqlite3 +0 -0
data/spec/dummy/log/development.log +0 -0
data/spec/dummy/log/test.log +26009 -0
data/spec/dummy/public/404.html +26 -0
data/spec/dummy/public/422.html +26 -0
data/spec/dummy/public/500.html +25 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/dummy/script/rails +6 -0
data/spec/quickbooks_web_connector/soap_wrapper/defaultServant_spec.rb +150 -0
data/spec/quickbooks_web_connector_spec.rb +47 -0
data/spec/routing/quickbooks_web_connector_spec.rb +17 -0
data/spec/spec_helper.rb +50 -0
data/spec/support/redis/dump.rdb +1 -0
data/spec/support/redis/redis-test.conf +115 -0
data/spec/views/quickbooks_web_connector/qwc/qwc.xml.builder_spec.rb +56 -0
metadata +232 -0

data/spec/dummy/public/404.html ADDED Viewed

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/422.html ADDED Viewed

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/500.html ADDED Viewed

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+  </div>
+</body>
+</html>

data/spec/dummy/public/favicon.ico ADDED Viewed

File without changes

data/spec/dummy/script/rails ADDED Viewed

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/quickbooks_web_connector/soap_wrapper/defaultServant_spec.rb ADDED Viewed

@@ -0,0 +1,150 @@
+require 'spec_helper'
+describe QuickbooksWebConnector::SoapWrapper::QBWebConnectorSvcSoap do
+  let(:servant) { described_class.new }
+  describe 'serverVersion' do
+    subject(:response) { servant.serverVersion(stub :parameters) }
+    before { QuickbooksWebConnector.configure { |c| c.server_version = '1.2.3' } }
+    it { should be_a QuickbooksWebConnector::SoapWrapper::ServerVersionResponse }
+    its(:serverVersionResult) { should eq '1.2.3' }
+    after { QuickbooksWebConnector.configure { |c| c.server_version = '1.0.0' } }
+  end
+  describe 'clientVersion' do
+    subject(:response) { servant.clientVersion(stub :parameters, strVersion: '2.1.0.30') }
+    context 'no minimum version set' do
+      before { QuickbooksWebConnector.configure { |c| c.minimum_web_connector_client_version = nil } }
+      it { should be_a QuickbooksWebConnector::SoapWrapper::ClientVersionResponse }
+      its(:clientVersionResult) { should be_nil }
+      after { QuickbooksWebConnector.configure { |c| c.minimum_web_connector_client_version = nil } }
+    end
+    context 'current version passes minimum version check' do
+      before { QuickbooksWebConnector.configure { |c| c.minimum_web_connector_client_version = '1.0.0' } }
+      it { should be_a QuickbooksWebConnector::SoapWrapper::ClientVersionResponse }
+      its(:clientVersionResult) { should be_nil }
+      after { QuickbooksWebConnector.configure { |c| c.minimum_web_connector_client_version = nil } }
+    end
+    context 'current version fails minimum version check' do
+      before { QuickbooksWebConnector.configure { |c| c.minimum_web_connector_client_version = '3.0.0' } }
+      it { should be_a QuickbooksWebConnector::SoapWrapper::ClientVersionResponse }
+      its(:clientVersionResult) { should eq 'E:This version of QuickBooks Web Connector is outdated. Version 3.0.0 or greater is required.' }
+      after { QuickbooksWebConnector.configure { |c| c.minimum_web_connector_client_version = nil } }
+    end
+  end
+  describe 'authenticate' do
+    subject(:response) { servant.authenticate(stub :parameters, strUserName: 'foo', strPassword: 'bar') }
+    context 'unauthorized' do
+      it { should be_a QuickbooksWebConnector::SoapWrapper::AuthenticateResponse }
+      it 'returns "nvu" with an invalid user' do
+        expect(response.authenticateResult[1]).to eq('nvu')
+      end
+    end
+    context 'authorized' do
+      before do
+        QuickbooksWebConnector.configure do |c|
+          c.username = 'foo'
+          c.password = 'bar'
+        end
+      end
+      after do
+        QuickbooksWebConnector.configure do |c|
+          c.username = 'web_connector'
+          c.password = 'secret'
+        end
+      end
+      context 'has no data to send' do
+        it 'is "none" for having no data' do
+          expect(response.authenticateResult[1]).to eq('none')
+        end
+      end
+      context 'has work to do' do
+        before do
+          QuickbooksWebConnector.enqueue '<some><xml></xml></some>', SomeHandler
+          QuickbooksWebConnector.configure { |c| c.company_file_path = '/path/to/company.qbw' }
+          SecureRandom.stub uuid: '71f1f9d9-8012-487c-af33-c84bab4d4ded'
+        end
+        after { QuickbooksWebConnector.configure { |c| c.company_file_path = '' } }
+        it { should be_a QuickbooksWebConnector::SoapWrapper::AuthenticateResponse }
+        it 'is a token for future requests' do
+          expect(response.authenticateResult[0]).to eq('71f1f9d9-8012-487c-af33-c84bab4d4ded')
+        end
+        it 'returns the path to the company file' do
+          expect(response.authenticateResult[1]).to eq('/path/to/company.qbw')
+        end
+        it 'is nil for delay' do
+          expect(response.authenticateResult[2]).to be_nil
+        end
+        it 'is nil for the new MinimumRunEveryNSeconds' do
+          expect(response.authenticateResult[3]).to be_nil
+        end
+      end
+    end
+  end
+  describe 'sendRequestXML' do
+    subject(:response) { servant.sendRequestXML(stub :parameters) }
+    before { QuickbooksWebConnector.enqueue '<some><xml></xml></some>', SomeHandler, 1 }
+    it { should be_a QuickbooksWebConnector::SoapWrapper::SendRequestXMLResponse }
+    its(:sendRequestXMLResult) { should eq '<some><xml></xml></some>' }
+  end
+  describe 'receiveResponseXML' do
+    subject(:response) { servant.receiveResponseXML(stub :parameters, response: '<response><xml></xml></response>') }
+    before do
+      QuickbooksWebConnector.enqueue '<request><xml></xml></request>', SomeHandler, 1
+      SomeHandler.should_receive(:perform).with('<response><xml></xml></response>', 1)
+    end
+    context 'last job' do
+      it { should be_a QuickbooksWebConnector::SoapWrapper::ReceiveResponseXMLResponse }
+      its(:receiveResponseXMLResult) { should eq 100 }
+    end
+    context 'additional jobs' do
+      before { QuickbooksWebConnector.enqueue '<other><xml></xml></other>', SomeHandler, 2 }
+      it { should be_a QuickbooksWebConnector::SoapWrapper::ReceiveResponseXMLResponse }
+      its(:receiveResponseXMLResult) { should eq 1 }
+    end
+  end
+  describe 'closeConnection' do
+    subject(:response) { servant.closeConnection(stub :parameters) }
+    it { should be_a QuickbooksWebConnector::SoapWrapper::CloseConnectionResponse }
+  end
+end

data/spec/quickbooks_web_connector_spec.rb ADDED Viewed

@@ -0,0 +1,47 @@
+require 'spec_helper'
+describe QuickbooksWebConnector do
+  before do
+    @original_redis = described_class.redis
+  end
+  after do
+    described_class.redis = @original_redis
+  end
+  it 'can set a namespace through a url-like string' do
+    expect(described_class.redis.namespace).to eq(:qwc)
+    described_class.redis = 'localhost:9736/namespace'
+    expect(described_class.redis.namespace).to eq('namespace')
+  end
+  it 'can set a namespace with a Redis::Namespace argument' do
+    new_redis = Redis.new(host: 'localhost', port: 9736)
+    new_namespace = Redis::Namespace.new('namespace', redis: new_redis)
+    described_class.redis = new_namespace
+    expect(described_class.redis).to eq(new_namespace)
+  end
+  it 'can enqueue jobs' do
+    expect(described_class.size).to eq(0)
+    described_class.enqueue '<some><xml></xml></some>', SomeHandler, 1, '/tmp'
+    job = described_class.reserve
+    expect(job).to be_a_kind_of(described_class::Job)
+    expect(job.payload_class).to eq(SomeHandler)
+    expect(job.args[0]).to eq 1
+    expect(job.args[1]).to eq '/tmp'
+    expect(described_class.reserve).to be_nil
+  end
+  it 'can peek at the queue' do
+    described_class.push('name' => 'chris')
+    expect(described_class.size).to eq(1)
+    expect(described_class.peek).to eq('name' => 'chris')
+    expect(described_class.size).to eq(1)
+  end
+end

data/spec/routing/quickbooks_web_connector_spec.rb ADDED Viewed

@@ -0,0 +1,17 @@
+require 'spec_helper'
+describe 'QuickbooksWebConnector routing' do
+  before do
+    @routes = QuickbooksWebConnector::Engine.routes
+  end
+  it 'defaults to XML for downloading QWC' do
+    expect(get: '/qwc').to route_to(controller: 'quickbooks_web_connector/qwc', action: 'download', format: :xml)
+  end
+  it 'routes the SOAP endpoint' do
+    expect(post: '/soap').to route_to(controller: 'quickbooks_web_connector/soap', action: 'endpoint')
+  end
+end

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,50 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+require File.expand_path("../dummy/config/environment.rb", __FILE__)
+$dir = File.dirname(File.expand_path(__FILE__))
+require 'rspec/rails'
+require 'rexml/document'
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support and it's subdirectories
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+  config.before(:suite) do
+    # Make sure we can run redis
+    if !system("which redis-server")
+      puts '', "** can't find `redis-server` in your path"
+      abort ''
+    end
+    # Start redis
+    puts "Starting redis for testing at localhost:9736"
+    `redis-server #{$dir}/support/redis/redis-test.conf`
+    QuickbooksWebConnector.redis = 'localhost:9736'
+  end
+  config.before(:each) do
+    QuickbooksWebConnector.redis.flushall
+  end
+  # Kill our own redis we started
+  config.after(:suite) do
+    processes = `ps -A -o pid,command | grep [r]edis-test`.split($/)
+    pids = processes.map { |process| process.split(" ")[0] }
+    puts "Killing test redis server..."
+    pids.each { |pid| Process.kill("TERM", pid.to_i) }
+    system("rm -f #{$dir}/support/redis/dump.rdb")
+  end
+end
+# fixture classes
+class SomeHandler
+  def self.perform(response_xml, *args)
+  end
+end

data/spec/support/redis/dump.rdb ADDED Viewed

	@@ -0,0 +1 @@
1	+ REDIS0006�ܳC�Z��V

data/spec/support/redis/redis-test.conf ADDED Viewed

@@ -0,0 +1,115 @@
+# Redis configuration file example
+# By default Redis does not run as a daemon. Use 'yes' if you need it.
+# Note that Redis will write a pid file in /var/run/redis.pid when daemonized.
+daemonize yes
+# When run as a daemon, Redis write a pid file in /var/run/redis.pid by default.
+# You can specify a custom pid file location here.
+pidfile ./spec/support/redis/redis-test.pid
+# Accept connections on the specified port, default is 6379
+port 9736
+# If you want you can bind a single interface, if the bind option is not
+# specified all the interfaces will listen for connections.
+#
+# bind 127.0.0.1
+# Close the connection after a client is idle for N seconds (0 to disable)
+timeout 300
+# Save the DB on disk:
+#
+#   save <seconds> <changes>
+#
+#   Will save the DB if both the given number of seconds and the given
+#   number of write operations against the DB occurred.
+#
+#   In the example below the behaviour will be to save:
+#   after 900 sec (15 min) if at least 1 key changed
+#   after 300 sec (5 min) if at least 10 keys changed
+#   after 60 sec if at least 10000 keys changed
+save 900 1
+save 300 10
+save 60 10000
+# The filename where to dump the DB
+dbfilename dump.rdb
+# For default save/load DB in/from the working directory
+# Note that you must specify a directory not a file name.
+dir ./spec/support/redis/
+# Set server verbosity to 'debug'
+# it can be one of:
+# debug (a lot of information, useful for development/testing)
+# notice (moderately verbose, what you want in production probably)
+# warning (only very important / critical messages are logged)
+loglevel debug
+# Specify the log file name. Also 'stdout' can be used to force
+# the demon to log on the standard output. Note that if you use standard
+# output for logging but daemonize, logs will be sent to /dev/null
+logfile stdout
+# Set the number of databases. The default database is DB 0, you can select
+# a different one on a per-connection basis using SELECT <dbid> where
+# dbid is a number between 0 and 'databases'-1
+databases 16
+################################# REPLICATION #################################
+# Master-Slave replication. Use slaveof to make a Redis instance a copy of
+# another Redis server. Note that the configuration is local to the slave
+# so for example it is possible to configure the slave to save the DB with a
+# different interval, or to listen to another port, and so on.
+# slaveof <masterip> <masterport>
+################################## SECURITY ###################################
+# Require clients to issue AUTH <PASSWORD> before processing any other
+# commands.  This might be useful in environments in which you do not trust
+# others with access to the host running redis-server.
+#
+# This should stay commented out for backward compatibility and because most
+# people do not need auth (e.g. they run their own servers).
+# requirepass foobared
+################################### LIMITS ####################################
+# Set the max number of connected clients at the same time. By default there
+# is no limit, and it's up to the number of file descriptors the Redis process
+# is able to open. The special value '0' means no limts.
+# Once the limit is reached Redis will close all the new connections sending
+# an error 'max number of clients reached'.
+# maxclients 128
+# Don't use more memory than the specified amount of bytes.
+# When the memory limit is reached Redis will try to remove keys with an
+# EXPIRE set. It will try to start freeing keys that are going to expire
+# in little time and preserve keys with a longer time to live.
+# Redis will also try to remove objects from free lists if possible.
+#
+# If all this fails, Redis will start to reply with errors to commands
+# that will use more memory, like SET, LPUSH, and so on, and will continue
+# to reply to most read-only commands like GET.
+#
+# WARNING: maxmemory can be a good idea mainly if you want to use Redis as a
+# 'state' server or cache, not as a real DB. When Redis is used as a real
+# database the memory usage will grow over the weeks, it will be obvious if
+# it is going to use too much memory in the long run, and you'll have the time
+# to upgrade. With maxmemory after the limit is reached you'll start to get
+# errors for write operations, and this may even lead to DB inconsistency.
+# maxmemory <bytes>
+############################### ADVANCED CONFIG ###############################
+# Glue small output buffers together in order to send small replies in a
+# single TCP packet. Uses a bit more CPU but most of the times it is a win
+# in terms of number of queries per second. Use 'yes' if unsure.
+# glueoutputbuf yes

data/spec/views/quickbooks_web_connector/qwc/qwc.xml.builder_spec.rb ADDED Viewed

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'rexml/document'
+describe 'quickbooks_web_connector/qwc/qwc' do
+  before do
+    QuickbooksWebConnector.configure { |c| c.username = 'jsmith' }
+    render
+  end
+  after { QuickbooksWebConnector.configure { |c| c.username = 'web_connector' } }
+  let(:root) { REXML::Document.new(rendered).root }
+  it 'wraps everything in a QBWCXML element' do
+    expect(root.name).to eq('QBWCXML')
+  end
+  it 'includes the app name' do
+    expect(root.text('AppName')).to eq('My QBWC App')
+  end
+  it 'includes the app ID' do
+    expect(root.text('AppID')).to be_nil
+  end
+  it 'includes the endpoint url' do
+    expect(root.text('AppURL')).to eq('http://test.host/quickbooks_web_connector/soap')
+  end
+  it 'includes the description' do
+    expect(root.text('AppDescription')).to eq('My QBWC App Description')
+  end
+  it 'includes the support url' do
+    expect(root.text('AppSupport')).to eq('http://test.host/')
+  end
+  it 'includes the username' do
+    expect(root.text('UserName')).to eq('jsmith')
+  end
+  it 'includes the owner id' do
+    expect(root.text('OwnerID')).to eq('{d69682e6-4436-44bc-bd19-d6bfbd11778d}')
+  end
+  it 'includes the file id' do
+    expect(root.text('FileID')).to eq('{916222f3-c574-4c70-8c9d-e3cec2634e49}')
+  end
+  it 'sets the type to QBFS' do
+    expect(root.text('QBType')).to eq('QBFS')
+  end
+end