quickbooks_api 0.0.7 → 0.1.0

data/lib/quickbooks/support/monkey_patches.rb

@@ -0,0 +1,48 @@
+class Hash
+
+  def path_to_nested_key(key)
+    self.each do |k,v|
+      path = [k]
+      if k == key
+        return path
+      elsif v.is_a? Hash
+        nested_path = v.path_to_nested_key(key)
+        nested_path ? (return path + nested_path) : nil
+      end
+    end
+    return nil
+  end
+
+  def self.nest(path, value)
+    hash_constructor = lambda { |h, k| h[k] = Hash.new(&hash_constructor) }
+    nested_hash = Hash.new(&hash_constructor)
+
+    last_key = path.last
+    path.inject(nested_hash) { |h, k| (k == last_key) ? h[k] = value : h[k] }
+    nested_hash
+  end
+
+end
+
+class Class
+  def simple_name
+    self.to_s.split("::").last
+  end
+end
+
+class Object
+  def not_blank?
+    !self.blank?
+  end
+end
+
+class File
+  def self.read_from_unknown(file)
+    case file
+    when String
+      File.read(file)
+    when IO
+      file.read
+    end
+  end
+end

data/spec/quickbooks/api_spec.rb

@@ -4,29 +4,32 @@ describe Quickbooks::API do
 
   describe "interface" do
 
-    it "should initialize" do
+    it "should initialize api instance" do
     end
 
-    it "should create ruby wrapper objects for any qbxml input" do
+    it "should return cached instance for consecutive api requests" do
     end
 
-    it "should convert ruby wrapper objects back to qbxml" do
+    it "should create qbxml object from qbxml input" do
     end
 
-  end
-
-  describe "helpers" do
+    it "should create qbxml object from hash input" do
+    end
 
-    it "should load the schema" do
+    it "should convert qbxml input to hash output" do
     end
 
-    it "should rebuild the schema" do
+    it "should convert hash input to qbxml output" do
     end
 
-    it "should write the schema to disk" do
+  end
+
+  describe "helpers" do
+
+    it "should load the schema into memory during initialization" do
     end
 
-    it "should find a nested qbxml hash" do
+    it "should load the container template into memory before initialization" do
     end
 
   end

data/spec/quickbooks/class_builder_spec.rb

@@ -1,6 +1,6 @@
 require File.join(File.dirname(__FILE__), "spec_helper.rb")
 
-describe Quickbooks::Support::ClassBuilder do
+describe Quickbooks::Parser::ClassBuilder do
 
   it "should add a type checked attribute accessor to a class" do
   end

data/spec/quickbooks/config_spec.rb

@@ -0,0 +1,72 @@
+require File.join(File.dirname(__FILE__), "spec_helper.rb")
+
+describe Quickbooks::Config 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?(dtd_file).should be_true
+      #self.stub!(:schema_type => :qbpos)
+      #File.exists?(dtd_file).should be_true
+    #end
+
+    #it "should determine the namespace for any supported schema type" do
+      #self.stub!(:schema_type => :qb)
+      #schema_namespace.should be_a_kind_of(Module)
+      #self.stub!(:schema_type => :qbpos)
+      #schema_namespace.should be_a_kind_of(Module)
+    #end
+
+    #it "should determine the container class for any supported schema type" do
+      #self.stub!(:schema_type => :qb)
+      #container_class.should == 'QBXML'
+      #self.stub!(:schema_type => :qbpos)
+      #schema_namespace.should == 'QBPOSXML'
+    #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
+      #cached_classes.include?(container_class).should be_true
+      #self.stub!(:schema_type => :qbpos)
+      #cached_classes.should be_an_instance_of(Array)
+      #cached_classes.empty?.should be_false
+      #cached_classes.include?(container_class).should be_true
+    #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

data/spec/quickbooks/inflection_spec.rb

@@ -0,0 +1,18 @@
+require File.join(File.dirname(__FILE__), "spec_helper.rb")
+
+describe Quickbooks::Support::Inflection 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 convert a class or xml element name to underscored" do
+      #underscore(@klass).should == 'node_set'
+      #underscore(@stub_xml_node).should == 'some_node_name'
+    #end
+
+end

data/spec/quickbooks/logger_spec.rb

@@ -1,20 +1,8 @@
 require File.join(File.dirname(__FILE__), "spec_helper.rb")
 
-describe Quickbooks::Support::Logger do
+describe Quickbooks::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/monkey_patches_spec.rb

@@ -0,0 +1,11 @@
+require File.join(File.dirname(__FILE__), "spec_helper.rb")
+
+describe "Monkey Patches" do
+
+    before :each do
+    end
+
+    #it "should convert a full class name to a simple class name" do
+      #@klass.simple_name.should == 'NodeSet'
+    #end
+end

data/spec/quickbooks/qbxml_base_spec.rb

@@ -0,0 +1,23 @@
+require File.join(File.dirname(__FILE__), "spec_helper.rb")
+
+describe Quickbooks::Parser::QbxmlBase do
+
+  it "should have a type conversion map with all qb types" do
+  end
+
+  it "should initialize a qbxml object given an attribute hash" do
+  end
+
+  it "should generate qbxml from a qbxml object" do
+  end
+
+  it "should a hash of attributes for the qbxml object" do
+  end
+
+  it "should return the attribute names of the qbxml class" do
+  end
+
+  it "should return the type map of the qbxml class" do
+  end
+
+end

data/spec/quickbooks/xml_generation_spec.rb

@@ -0,0 +1,5 @@
+require File.join(File.dirname(__FILE__), "spec_helper.rb")
+
+describe Quickbooks::Parser::XMLGeneration do
+
+end

data/spec/quickbooks/xml_parsing_spec.rb

@@ -0,0 +1,36 @@
+require File.join(File.dirname(__FILE__), "spec_helper.rb")
+
+describe Quickbooks::Parser::XMLParsing 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
+    
+  #end
+
+  #it "should check if a class is already defined in a particular namespace" do
+  #end
+
+  #it "should cleanup qbxml" do
+  #end
+  
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: quickbooks_api
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 27
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 7
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors: 
 - Alex Skryl
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-27 00:00:00 -05:00
+date: 2011-06-30 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,22 +46,6 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: ruby2ruby
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 29
-        segments: 
-        - 1
-        - 2
-        - 1
-        version: 1.2.1
-  type: :runtime
-  version_requirements: *id003
 description: A QuickBooks QBXML wrapper for Ruby
 email: rut216@gmail.com
 executables: []
@@ -72,27 +56,33 @@ extra_rdoc_files: []
 
 files: 
 - lib/quickbooks/api.rb
+- lib/quickbooks/config.rb
 - lib/quickbooks/dtd_parser.rb
-- lib/quickbooks/qbxml_base.rb
+- lib/quickbooks/logger.rb
+- lib/quickbooks/parser/class_builder.rb
+- lib/quickbooks/parser/qbxml_base.rb
+- lib/quickbooks/parser/xml_generation.rb
+- lib/quickbooks/parser/xml_parsing.rb
 - lib/quickbooks/qbxml_parser.rb
-- lib/quickbooks/support/api.rb
-- lib/quickbooks/support/class_builder.rb
-- lib/quickbooks/support/logger.rb
-- lib/quickbooks/support/qbxml.rb
-- lib/quickbooks/support.rb
+- lib/quickbooks/support/inflection.rb
+- lib/quickbooks/support/monkey_patches.rb
 - lib/quickbooks.rb
 - spec/quickbooks/api_spec.rb
 - spec/quickbooks/class_builder_spec.rb
+- spec/quickbooks/config_spec.rb
 - spec/quickbooks/dtd_parser_spec.rb
+- spec/quickbooks/inflection_spec.rb
 - spec/quickbooks/logger_spec.rb
+- spec/quickbooks/monkey_patches_spec.rb
+- spec/quickbooks/qbxml_base_spec.rb
 - spec/quickbooks/qbxml_parser_spec.rb
-- spec/quickbooks/qbxml_spec.rb
 - spec/quickbooks/spec_helper.rb
-- spec/quickbooks/support_spec.rb
+- spec/quickbooks/xml_generation_spec.rb
+- spec/quickbooks/xml_parsing_spec.rb
 - xml_schema/qbposxmlops30.xml
 - xml_schema/qbxmlops70.xml
-- ruby_schema/qb/templates/.placeholder
-- ruby_schema/qbpos/templates/.placeholder
+- README
+- TODO
 has_rdoc: true
 homepage: http://github.com/skryl
 licenses: []

data/lib/quickbooks/qbxml_base.rb

@@ -1,212 +0,0 @@
-# inheritance base for schema classes
-class Quickbooks::QbxmlBase
-  include Quickbooks::Support
-  include Quickbooks::Support::QBXML
-
-  extend  Quickbooks::Support
-  extend  Quickbooks::Support::API
-
-QB_TYPE_CONVERSION_MAP= {
-  "AMTTYPE"          => lambda {|d| d ? Float(d) : 0.0 },
-  #"BOOLTYPE"         => lambda {|d| d ? (d == 'True' ? true : false) : false },
-  "BOOLTYPE"         => lambda {|d| d ? String(d) : '' },
-  "DATETIMETYPE"     => lambda {|d| d ? Time.parse(d).xmlschema : Time.now.xmlschema },
-  "DATETYPE"         => lambda {|d| d ? Date.parse(d).xmlschema : Date.today.xmlschema },
-  "ENUMTYPE"         => lambda {|d| d ? String(d) : ''},
-  "FLOATTYPE"        => lambda {|d| d ? Float(d) : 0.0},
-  "GUIDTYPE"         => lambda {|d| d ? String(d) : ''},
-  "IDTYPE"           => lambda {|d| d ? String(d) : ''},
-  "INTTYPE"          => lambda {|d| d ? Integer(d) : 0 },
-  "PERCENTTYPE"      => lambda {|d| d ? Float(d) : 0.0 },
-  "PRICETYPE"        => lambda {|d| d ? Float(d) : 0.0 },
-  "QUANTYPE"         => lambda {|d| d ? Integer(d.to_i) : 0 },
-  "STRTYPE"          => lambda {|d| d ? String(d) : ''},
-  "TIMEINTERVALTYPE" => lambda {|d| d ? String(d) : ''}
-}
-
-
-def initialize(params = nil)
-  return unless params.is_a?(Hash)
-  params.each do |k,v|
-    if self.respond_to?(k)
-      expected_type = self.class.send("#{k}_type")
-      v = \
-        case v
-        when Hash
-          expected_type.new(v)
-        when Array
-          v.inject([]) { |a,i| a << expected_type.new(i) }
-        else v
-        end
-      self.send("#{k}=", v)
-    end
-  end
-end
-
-
-def to_qbxml
-  xml_doc = Nokogiri::XML(self.class.xml_template)
-  root = xml_doc.root
-  log.debug "to_qbxml#nodes_size: #{root.children.size}"
-
-  # replace all children nodes of the template with populated data nodes
-  xml_nodes = []
-  root.children.each do |xml_template|
-    next unless xml_template.is_a? XML_ELEMENT
-    attr_name = to_attribute_name(xml_template)
-    log.debug "to_qbxml#attr_name: #{attr_name}"
-
-    val = self.send(attr_name)
-    next unless val && !val.blank?
-
-    case val
-    when Array
-      xml_nodes += build_qbxml_nodes(xml_template, val)
-    else
-      xml_nodes << build_qbxml_node(xml_template, val)
-    end
-    log.debug "to_qbxml#val: #{val}"
-  end
-
-  log.debug "to_qbxml#xml_nodes_size: #{xml_nodes.size}"
-  root.children = xml_nodes.join('')
-  root.to_s
-end
-
-
-def self.template(recursive = false, use_disk_cache = false, reload = false)
-  if recursive
-    @template = (!reload && @template) || load_template(true, use_disk_cache)
-  else build_template(false)
-  end
-end
-
-
-def self.attribute_names
-  instance_methods(false).reject { |m| m[-1..-1] == '=' || m =~ /_xml_class/} 
-end
-
-
-def inner_attributes(parent = nil)
-  attrs = attributes(false)
-  values = attrs.values.compact
-
-  if values.empty?
-    {}
-  elsif values.first.is_a?(Array)
-    attributes
-  elsif values.size > 1
-    parent.attributes
-  else
-    first_val = values.first
-    if first_val.respond_to?(:inner_attributes)
-      first_val.inner_attributes(self)
-    else
-      parent.attributes
-    end
-  end
-end
-
-
-def attributes(recursive = true)
-  self.class.attribute_names.inject({}) do |h, m|
-    val = self.send(m)
-    if val
-      unless recursive
-        h[m] = val
-      else
-        h[m] = nested_attributes(val)
-      end
-    end; h
-  end
-end
-
-
-private
-
-# qbxml conversion
-
-def nested_attributes(val)
-  case val
-  when Quickbooks::QbxmlBase
-    val.attributes
-  when Array
-    val.inject([]) do |a, obj| 
-      case obj
-      when Quickbooks::QbxmlBase
-        a << obj.attributes 
-      else a << obj
-      end
-    end
-  else val
-  end
-end
-
-def build_qbxml_node(node, val)
-  case val
-  when Quickbooks::QbxmlBase
-    val.to_qbxml
-  else
-    node.children = val.to_s
-    node
-  end
-end
-
-def build_qbxml_nodes(node, val)
-  val.inject([]) do |a, v|
-    n = \
-      case v
-      when Quickbooks::QbxmlBase
-        v.to_qbxml
-      else
-        clone_qbxml_node(node,v)
-      end
-    a << n
-  end
-end
-
-def clone_qbxml_node(node, val)
-  n = node.clone
-  n.children = val.to_s
-  n
-end
-
-# qbxml class templates
-
-def self.load_template(recursive = false, use_disk_cache = false)
-  if use_disk_cache && File.exist?(template_cache_path)
-    YAML.load(File.read(template_cache_path))
-  else
-    log.info "Warning: on disk template is missing, rebuilding..." if use_disk_cache
-    template = build_template(recursive)
-    dump_template(template) if use_disk_cache
-    template
-  end
-end
-
-def self.build_template(recursive = false)
-  attribute_names.inject({}) do |h, a|
-    attr_type = self.send("#{a}_type") 
-    h[a] = (is_cached_class?(attr_type) && recursive) ? attr_type.build_template(true): attr_type.to_s; h
-  end
-end
-
-def self.dump_template(template)
-  File.open(template_cache_path, 'w') do |f|
-    f << template.to_yaml
-  end
-end
-
-def self.template_cache_path
-  "#{get_template_cache_path}/#{to_attribute_name(self)}.yml"
-end
-
-def self.schema_type
-  namespace = self.to_s.split("::")[1]
-  API::SCHEMA_MAP.find do |k,v|
-    simple_class_name(v[:namespace]) == namespace
-  end.first
-end
-
-
-end