qbo-sandbox 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f8f44d9da2d869cddbfbd1deef375987615efc1
-  data.tar.gz: 9ac1f9d22f019b8e78e81b2daf821b1e9fce662a
+  metadata.gz: d11d75386598e9ae8b966771fa61304da3eab1b1
+  data.tar.gz: dbc172dee6b93df31d5315446b9ec99dd7e7556e
 SHA512:
-  metadata.gz: fbfb63682e57d1f59db199d2b72e3e447a3be258f92330c4c2b65110873ebe7a8e5f3cee269b8a7875968894cc76bd3d63b5d5879d536245d779047db78d3414
-  data.tar.gz: 82e6f4f0d509240e56ae0ddc752d31c98ec4cefa903aa0d1944f459918342087c4ed3e7ae48384b80d0a4f4d31273a546233df1ac50828e0de54d58bf25196f9
+  metadata.gz: 2adc4f957559b691bb47b6d123809900ca0adce4096f36c4fcd0657c71adf715865ef447606c5d92627f56fcb0c288275a17dcba068a0cfca11e90a73540b718
+  data.tar.gz: affd114bc6bdfa183f9e25abaab6066dc061799819ea1dcbf8a8c406c2606ec030a007575d364c4e06f897cf5f61ebf05c786e1e2f33451473e730af14b422c1

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 .env
+README.md.html

data/README.md

@@ -9,8 +9,13 @@ Ruby 2.2.2 or greater
 ## Usage
 
 1. [Clean out](https://developer.intuit.com/hub/blog/2015/12/14/deleting-data-from-your-developer-sandbox-environment) your sandbox.
+
 2. `gem install qbo-sandbox`
-3. Put your production and development/sandbox credentials in an .env file. For example `vim ~/qbo-sandbox.env`
+
+3. Enter in your production and sandbox credentials into a .env file of your choosing. 
+
+   For example, here is a .env file at `~/qbo-sandbox.env`
+
     ```
     # ~/.qbo-sandbox.env
     QBO_SANDBOX_PROD_TOKEN=prod_token_xxxxx
@@ -24,9 +29,26 @@ Ruby 2.2.2 or greater
     QBO_SANDBOX_CONSUMER_SECRET=consumer_secret_sssssss
     QBO_SANDBOX_REALM_ID=2000000000000
     ```
-4. `QBO_SANDBOX_ENV_FILE=~/qbo-sandbox.env qbo_sandbox customers`
 
-5. Important: Only tested with QuickBooks Online Name List Resources Customer and Vendor.
+    All variables need to filled in. The `PROD` variables are your QuickBooks Online production credentials
+
+4. **`QBO_SANDBOX_ENV_FILE=~/qbo-sandbox.env qbo-sandbox customers`**
+
+5. That's it!
+
+## FAQ
+
+- What if I set they wrong credentials and copy entities from the sandbox to the production QuickBooks Online account?
+
+    There is a bit of protection against [this] (https://github.com/minimul/qbo-sandbox/blob/master/lib/qbo/sandbox.rb#L31) but use of this library is at your own risk so be careful to set your credentials correctly.
+
+- Will this library generate a ton of requests and hit API throttle requirements?
+
+    No, to create the sandbox entities this library uses [batch requests](https://developer.intuit.com/docs/api/accounting/batch).
+
+- My QBO Sub-customers, certain Items, etc. are not copying over to the sandbox?
+
+    Name list and transaction entities that have references are going to fail because the reference id is not going to be available on the sandbox. This library is not going to support references anytime soon but pull requests are very welcome. This library is only tested with QuickBooks Online Customer, Vendor, and Items. Sub-customers and inventory items that have required references to accounts will not be copied to your sandbox.
 
 ## Development
 
@@ -34,9 +56,15 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+To run the command locally:
+
+```
+bundle exec ./bin/qbo-sandbox vendors
+```
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/qbo-sandbox.
+Bug reports and pull requests are welcome on GitHub at https://github.com/minimul/qbo-sandbox.
 
 
 ## License

data/bin/qbo-sandbox

@@ -22,7 +22,7 @@ end
 
 begin
   entity = ARGV.at(0)
-  preview = Qbo::Sandbox.new.send(entity)
+  preview = Qbo::Sandbox.new.copy(entity)
   $stdout.puts "Done"
 rescue => e
   $stderr.puts e

data/lib/qbo/sandbox.rb

@@ -21,19 +21,27 @@ module Qbo
       ENV.fetch(env_var) { |k| raise "Missing value for either ENV['#{k}'] or keyword argument #{key}" }
     end
 
-    def copy(entity, max: 1000, select: nil, inactive: false)
-      payload = { "BatchItemRequest" => [] }
+    def copy(entity, max: 1000, select: nil, inactive: false, batch_size: 30)
+      batch = []
       QboApi.production = true
-      #@prod.query(select)
       @prod.all(entity, max: max, select: select, inactive: inactive) do |e|
-        payload["BatchItemRequest"] << build_single_batch(e, entity)
+        batch << build_single_batch(e, entity)
       end
-      QboApi.production = false
-      @sandbox.batch payload
+      submit_batch(batch, batch_size)
     end
 
     private
 
+    def submit_batch(batch, batch_size)
+      QboApi.production = false
+      collect_responses = []
+      batch.each_slice(batch_size) do |b|
+        payload = { "BatchItemRequest" => b }
+        collect_responses << @sandbox.batch(payload)
+      end
+      collect_responses
+    end
+
     def keyword_args
       {
         token: nil,

data/lib/qbo/sandbox/version.rb

@@ -1,5 +1,5 @@
 module Qbo
   class Sandbox
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qbo-sandbox
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Christian Pelczarski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-19 00:00:00.000000000 Z
+date: 2016-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler