quickbooks_api 0.0.2

data/lib/quickbooks/support.rb

@@ -0,0 +1,33 @@
+# namespace for dynamically gnerated schema classes
+module Quickbooks::QBXML; end
+module Quickbooks::QBPOSXML; end
+
+module Quickbooks::Support
+
+  def to_attribute_name(obj)
+    name = \
+      case obj
+      when Class
+        simple_class_name(obj)
+      when Nokogiri::XML::Element
+        obj.name
+      else
+        obj.to_s
+      end
+    inflector.underscore(name)
+  end
+
+  def simple_class_name(klass)
+    klass.to_s.split("::").last
+  end
+
+  # easily convert between CamelCase and under_score
+  def inflector
+    ActiveSupport::Inflector
+  end
+
+  def log
+    Quickbooks::API.log
+  end
+
+end

data/lib/quickbooks.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'ruby2ruby' # must be version 1.2.1 of ruby2ruby
+require 'nokogiri'
+require 'active_support'
+require 'active_support/core_ext'
+
+module Quickbooks; end
+
+require 'quickbooks/support'
+require 'quickbooks/support/api'
+require 'quickbooks/support/logger'
+require 'quickbooks/support/qbxml'
+require 'quickbooks/support/class_builder'
+require 'quickbooks/qbxml_base'
+require 'quickbooks/qbxml_parser'
+require 'quickbooks/dtd_parser'
+require 'quickbooks/api'

data/spec/quickbooks/api_spec.rb

@@ -0,0 +1,34 @@
+require File.join(File.dirname(__FILE__), "spec_helper.rb")
+
+describe Quickbooks::API do
+
+  describe "interface" do
+
+    it "should initialize" do
+    end
+
+    it "should create ruby wrapper objects for any qbxml input" do
+    end
+
+    it "should convert ruby wrapper objects back to qbxml" do
+    end
+
+  end
+
+  describe "helpers" do
+
+    it "should load the schema" do
+    end
+
+    it "should rebuild the schema" do
+    end
+
+    it "should write the schema to disk" do
+    end
+
+    it "should find a nested qbxml hash" do
+    end
+
+  end
+  
+end

data/spec/quickbooks/class_builder_spec.rb

@@ -0,0 +1,17 @@
+require File.join(File.dirname(__FILE__), "spec_helper.rb")
+
+describe Quickbooks::Support::ClassBuilder do
+
+  it "should add a type checked attribute accessor to a class" do
+  end
+
+  it "should add a casting attribute accessor to a class" do
+  end
+
+  it "should add a type accessor for an attribute" do
+  end
+
+  it "should add the appropriate xml template to each ruby wrapper object" do
+  end
+  
+end

data/spec/quickbooks/dtd_parser_spec.rb

@@ -0,0 +1,20 @@
+require File.join(File.dirname(__FILE__), "spec_helper.rb")
+
+describe Quickbooks::DtdParser do
+
+  it "should parse a dtd file and build wrapper classes" do 
+  end
+
+  it "should add a casting attribute to a leaf node class" do
+  end
+
+  it "should add a strict attribute to a non leaf node class" do
+  end
+
+  it "should should convert a commment into a data validator for the appropriate attribute" do
+  end
+
+  it "should create a new wrapper class for every xml node" do
+  end
+
+end

data/spec/quickbooks/logger_spec.rb

@@ -0,0 +1,20 @@
+require File.join(File.dirname(__FILE__), "spec_helper.rb")
+
+describe Quickbooks::Support::Logger do
+
+  it "should initialize an ActiveSupport::BufferedLogger" do
+  end
+
+  it "should log to a thread specific buffer" do
+  end
+
+  it "should print the contents of the log buffer" do
+  end
+
+  it "should indent, unindent, and reset indentation" do
+  end
+
+  it "should change the format appropriately when the formatter is changed" do
+  end
+
+end

data/spec/quickbooks/qbxml_parser_spec.rb

@@ -0,0 +1,33 @@
+require File.join(File.dirname(__FILE__), "spec_helper.rb")
+
+describe Quickbooks::QbxmlParser do
+
+  it "should set the schema type during initialization" do
+  end
+
+  it "should parse a qbxml file and build wrapper classes" do 
+  end
+
+  it "should parse a qbxml string and build wrapper classes" do
+  end
+
+  it "should process an xml document and build wrapper classes" do
+  end
+
+  it "should set the attribute value for a leaf node to a literal" do
+  end
+
+  it "should set the attribute value for a non leaf node to a nested class" do
+  end
+
+  it "should extract data from a leaf node" do
+  end
+
+  it "should fetch the wrapper instance for any qbxml node" do
+  end
+
+  it "should set an objects attribute" do
+  end
+
+end
+

data/spec/quickbooks/qbxml_spec.rb

@@ -0,0 +1,23 @@
+require File.join(File.dirname(__FILE__), "spec_helper.rb")
+
+describe Quickbooks::QbxmlBase do
+
+  it "should have a type conversion map with all qb types" do
+  end
+
+  it "should build up a wrapper object given an attribute hash" do
+  end
+
+  it "should convert a wrapper object to its equivalent qbxml" do
+  end
+
+  it "should return the attribute values of the wrapper object" do
+  end
+
+  it "should return the attribute names of the wrapper class" do
+  end
+
+  it "should return the type map of the wrapper class" do
+  end
+
+end

data/spec/quickbooks/spec_helper.rb

@@ -0,0 +1,3 @@
+$: << File.join(File.dirname(__FILE__), "../lib")
+require 'rspec'
+require 'quickbooks'

data/spec/quickbooks/support_spec.rb

@@ -0,0 +1,118 @@
+require File.join(File.dirname(__FILE__), "spec_helper.rb")
+
+include Quickbooks::Support
+include Quickbooks::Support::QBXML
+
+describe Quickbooks::Support do
+
+  describe "configuration helpers" do
+
+    it "should return the supported schema types" do
+      valid_schema_types.should be_an_instance_of(Array)
+      valid_schema_types.include?(:qb).should be_true 
+      valid_schema_types.include?(:qbpos).should be_true 
+    end
+
+    it "should check if a particular schema type is supported" do
+      self.stub!(:schema_type => :qb)
+      valid_schema_type?.should be_true
+      self.stub!(:schema_type => :qbpos)
+      valid_schema_type?.should be_true
+      self.stub!(:schema_type => :doesntexist)
+      valid_schema_type?.should == false
+    end
+    
+    it "should determine the dtd file path for any supported schema type" do
+      self.stub!(:schema_type => :qb)
+      File.exists?(get_dtd_file).should be_true
+      self.stub!(:schema_type => :qbpos)
+      File.exists?(get_dtd_file).should be_true
+    end
+
+    it "should determine the namespace for any supported schema type" do
+      self.stub!(:schema_type => :qb)
+      get_schema_namespace.should be_a_kind_of(Module)
+      self.stub!(:schema_type => :qbpos)
+      get_schema_namespace.should be_a_kind_of(Module)
+    end
+
+    it "should determine the container class for any supported schema type" do
+    end
+
+    it "should return the disk cache path" do
+      self.stub!(:schema_type => :qb)
+      File.exists?(get_disk_cache_path).should be_true
+    end
+
+  end
+
+  describe "other helpers" do
+    
+    before :all do
+      @qb_api = Quickbooks::API.new(:qb)
+      @qbpos_api = Quickbooks::API.new(:qbpos)
+    end
+
+    it "should return all the cached classes" do
+      self.stub!(:schema_type => :qb)
+      cached_classes.should be_an_instance_of(Array)
+      cached_classes.empty?.should be_false
+      self.stub!(:schema_type => :qbpos)
+      cached_classes.should be_an_instance_of(Array)
+      cached_classes.empty?.should be_false
+    end
+
+    it "should check if a particular class is cached" do
+      self.stub!(:schema_type => :qb)
+      is_cached_class?(Quickbooks::QBXML::QBXML).should be_true
+      self.stub!(:schema_type => :qbpos)
+      is_cached_class?(Quickbooks::QBPOSXML::QBPOSXML).should be_true
+    end
+
+  end
+
+end
+
+describe Quickbooks::Support::QBXML do
+
+  it "should set useful parsing constants" do
+    XML_DOCUMENT.should == Nokogiri::XML::Document
+    XML_NODE_SET.should == Nokogiri::XML::NodeSet
+    XML_NODE.should == Nokogiri::XML::Node
+    XML_ELEMENT.should == Nokogiri::XML::Element
+    XML_COMMENT= Nokogiri::XML::Comment
+    XML_TEXT.should == Nokogiri::XML::Text
+  end
+
+  describe "xml parsing helpers" do
+
+    before :each do
+      @klass = Nokogiri::XML::NodeSet
+      stub_child = stub(:class => XML_TEXT)
+      @stub_xml_node = stub(:name => "SomeNodeName", :children => [stub_child])
+      @stub_xml_node.stub!(:is_a?).with(anything).and_return(false)
+      @stub_xml_node.stub!(:is_a?).with(XML_ELEMENT).and_return(true)
+    end
+
+    it "should check if a node is a leaf node" do
+      is_leaf_node?(@stub_xml_node).should be_true
+    end
+    
+    it "should convert a class or xml element name to underscored" do
+      to_attribute_name(@klass).should == 'node_set'
+      to_attribute_name(@stub_xml_node).should == 'some_node_name'
+    end
+
+    it "should convert a full class name to a simple class name" do
+      simple_class_name(@klass).should == 'NodeSet'
+    end
+
+  end
+
+  it "should check if a class is already defined in a particular namespace" do
+  end
+
+  it "should cleanup qbxml" do
+  end
+  
+end