qube_sync 0.1.3 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f34c269c2f1e3291ae88d68036b9d02eda39da5cc6d5601afba689a2630f8321
-  data.tar.gz: 2c0c06fffbd1291b0e397365e9e0ac44fe899b47c75f8394f28ffca0ca97db23
+  metadata.gz: b2c9e1ca88def822a5954628f1b5d336eab0f3e8ba210871c91abc29cc626b93
+  data.tar.gz: eb86ac186eeba798fe0eeeb18179bedf4e83eedca1906a359f5a6ee17d1f0940
 SHA512:
-  metadata.gz: acfd00b12f982fcf9f49fd794a94fd8be728e3c72a0e45495823c91527f44e1dfe996df3e70afe7d0221dff632222fb3ea17d14492f2dceaa4d2e548f2060675
-  data.tar.gz: 722d0eb8f1f40347bab42953104c8f58cc090b3c464ff25b07ea239d766c0871376c3bb3a45417251d982cec997f688e44e67b9ee002c15b0c91c054e46b9664
+  metadata.gz: b50b747fff6d9ccfeb7914e63d689fe62479166e71cbe8fed086da10b973e5a96427d54a432513bbd6b3a05f923897c11e29108c9493458fd31a0210d1e2b571
+  data.tar.gz: 74486d4d0f6ca5da0c3521bcb01407d4fc9b32a7e76dce69784bccc5b8dc96ed966d13e0ccb12366d1ff1a78608587a09f5d33877fd48320c0f65b349ad2550a

data/README.md

@@ -27,10 +27,6 @@ require 'qube_sync'
 connection_id = QubeSync.create_connection # creates a connection in QUBE on behalf of your user
 #=> "636d4750-0b07-45f6-a030-e3919c5741ff"
 
-# You can also pass a block to create_connection as a success callback
-QubeSync.create_connection do |connection_id|
-  QubeConnection.create!(qube_id: connection_id) # save the connection_id to your database
-end
 
 QubeSync.delete_connection("asdf-qwer-asdf-zxcv") # deletes the connection in QUBE
 #=> true
@@ -44,8 +40,20 @@ QubeSync.generate_password(connection_id)
 QubeSync.get_qwc(connection_id)
 # "<?xml version=\"1.0\"?>\n<QBWCXML>...</QBWCXML>\n"
 
+# Using the RequestBuilder to build a Quickbooks Request (generates JSON for QubeSync to translate)
+request_json = QubeSync::RequestBuilder.new do |b|
+  b.QBXML {
+    b.QBXMLMsgsRq(onError: "stopOnError") {
+      b.CustomerQueryRq(requestID: 1) {
+        b.MaxReturned(10)
+      }
+    }
+  }
+end
 
+QubeSync.queue_request(connection_id, {request_json: request_json, webhook_url: "myapp.com/webhook"})
 
+# Using XML directly
 request_xml = <<~XML
   <?xml version="1.0"?>
   <?qbxml version="16.0"?>
@@ -58,7 +66,7 @@ request_xml = <<~XML
   </QBXML>
 XML
 
-QubeSync.queue_request(connection_id, request_xml, webhook_url = "myapp.com/webhook")
+QubeSync.queue_request(connection_id, {request_xml: request_xml, webhook_url: "myapp.com/webhook"})
 #=> {"id"=>"d401228f-06d4-4981-95d8-bb735c0a2c76",
 #    "state"=>"waiting",
 #    "response_xml"=>nil,
@@ -69,13 +77,25 @@ QubeSync.queue_request(connection_id, request_xml, webhook_url = "myapp.com/webh
 request_id = _.fetch("id")
 
 QubeSync.get_request(request_id)
-#=> {"id"=>"d401228f-06d4-4981-95d8-bb735c0a2c76",
-#    "state"=>"webhook_succeeded",
-#    "response_xml"=>
-#     "<?xml version=\"1.0\" ?> <QBXML> <QBXMLMsgsRs> ... </QBXMLMsgsRs> </QBXML>",
-#    "webhook_url"=>"myapp.com/webhook",
-#    "request_xml"=>
-#     "<?xml version=\"1.0\"?><?qbxml version=\"16.0\"?><QBXML>  ...  </QBXMLMsgsRq></QBXML>"}}
+#=> {"id" => "d401228f-06d4-4981-95d8-bb735c0a2c76",
+#    "state" => "webhook_succeeded",
+#    "response_xml" =>
+#      "<?xml version=\"1.0\" ?> <QBXML> <QBXMLMsgsRs> ... </QBXMLMsgsRs> </QBXML>",
+#    "response_json" => [
+#      "CustomerQueryRs" => {
+#        "requestID"=>"1",
+#        "statusCode"=>"0",
+#        "statusSeverity"=>"Info",
+#        "statusMessage"=>"Status Message",
+#        "Results" => [
+#          {"Name"=>"Customer 1", "ListID"=>"123"},
+#          {"Name"=>"Customer 2", "ListID"=>"456"}
+#         ]
+#       },
+#    ],
+#    "webhook_url" => "myapp.com/webhook",
+#    "request_xml" =>
+#      "<?xml version=\"1.0\"?><?qbxml version=\"16.0\"?><QBXML>  ...  </QBXMLMsgsRq></QBXML>"}}
 
 QubeSync.get_requests(connection_id)
 #=> [{"id"=>"d401228f-06d4-4981-95d8-bb735c0a2c76",
@@ -93,6 +113,7 @@ QubeSync.verify_and_build_webhook!(request.body.read, request.headers['X-Qube-Si
 #=> {
 #  "id"=>"dd8db40a-5169-477a-b9d5-f1a6e5cc96f9",
 #  "timestamp"=>1738620998,
+#  "response_json"=> {...},
 #  "response_xml"=>
 #   "<?xml version=\"1.0\" ?> <QBXML> <QBXMLMsgsRs> ... </QBXMLMsgsRs> </QBXML>" 
 # }

data/lib/qube_sync/request_builder.rb

@@ -0,0 +1,49 @@
+module QubeSync
+  class RequestBuilder
+    attr_reader :version, :root
+
+    def initialize(version:, &block)
+      @version = version
+      @stack = []
+      instance_eval(&block) if block_given?
+    end
+
+    def method_missing(tag_name, *args, &block)
+      attributes = args.first.is_a?(Hash) ? args.first : {}
+      text = args.first unless args.first.is_a?(Hash)
+      
+      element = {
+        "name" => tag_name.to_s,
+      }
+      element["attributes"] = attributes unless attributes.empty?
+      element["text"] = text if text.is_a?(String) || text.is_a?(Numeric)
+
+      if block_given?
+        element["children"] = []
+        @stack.push(element)
+        instance_eval(&block)
+        @stack.pop
+      end
+
+      if @stack.empty?
+        @root ||= []
+        @root << element
+      else
+        @stack.last["children"] << element
+      end
+    end
+
+    def as_json
+      {
+        "version" => version,
+        "request" => root
+      }
+    end
+
+    private
+
+    def root
+      @root || []
+    end
+  end
+end

data/lib/qube_sync/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module QubeSync
-  VERSION = "0.1.3"
+  VERSION = "0.2.1"
 end

data/lib/qube_sync.rb

@@ -1,4 +1,5 @@
 require_relative "qube_sync/version"
+require_relative "qube_sync/request_builder"
 require "faraday"
 
 module QubeSync
@@ -121,12 +122,15 @@ module QubeSync
   
   
     def extract_signature_meta(header)
-      header.split(',') => [ts, *signatures]
+      parts = header.split(',')
+      ts = parts.first
+      signatures = parts[1..-1]
       {
         timestamp: ts.split("=").last.to_i,
         signatures: signatures
       }
     end
+
   
     def default_headers
       {
@@ -152,13 +156,13 @@ module QubeSync
     end
   
     def verify_and_build_webhook!(body, signature, max_age: 500)
-      extract_signature_meta(signature) => { timestamp:, signatures:}
+      meta = extract_signature_meta(signature)
   
-      if timestamp < Time.now.to_i - max_age
+      if meta[:timestamp] < Time.now.to_i - max_age
         raise StaleWebhookError.new('Timestamp more than #{max_age}ms old. To increase this, pass a different value for max_age.')
       end
       
-      if signatures.detect { |sig| sign_payload(body) == sig }
+      if meta[:signatures].detect { |sig| sign_payload(body) == sig }
         JSON.parse(body)
       else
         raise InvalidWebhookSignatureError.new("Webhook signature mismatch")

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: qube_sync
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.1
 platform: ruby
 authors:
 - Garrett Lancaster
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-19 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,6 +37,7 @@ files:
 - README.md
 - Rakefile
 - lib/qube_sync.rb
+- lib/qube_sync/request_builder.rb
 - lib/qube_sync/version.rb
 - qube_sync.gemspec
 - sig/qube_sync.rbs
@@ -47,7 +47,6 @@ metadata:
   homepage_uri: https://github.com/qubeintegrations/qube_sync_rb
   source_code_uri: https://github.com/qubeintegrations/qube_sync_rb
   changelog_uri: https://github.com/qubeintegrations/qube_sync_rb/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -62,8 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby library for the QUBE Sync API
 test_files: []