qbo-sandbox 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f8f44d9da2d869cddbfbd1deef375987615efc1
+  data.tar.gz: 9ac1f9d22f019b8e78e81b2daf821b1e9fce662a
+SHA512:
+  metadata.gz: fbfb63682e57d1f59db199d2b72e3e447a3be258f92330c4c2b65110873ebe7a8e5f3cee269b8a7875968894cc76bd3d63b5d5879d536245d779047db78d3414
+  data.tar.gz: 82e6f4f0d509240e56ae0ddc752d31c98ec4cefa903aa0d1944f459918342087c4ed3e7ae48384b80d0a4f4d31273a546233df1ac50828e0de54d58bf25196f9

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.13.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in qbo-sandbox.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Christian
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# Qbo::Sandbox
+
+Copy QuickBooks Online production entities to a sandbox in a single command
+
+## Requirements
+
+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`
+    ```
+    # ~/.qbo-sandbox.env
+    QBO_SANDBOX_PROD_TOKEN=prod_token_xxxxx
+    QBO_SANDBOX_PROD_SECRET=prod_secret_xxxx
+    QBO_SANDBOX_PROD_REALM_ID=100000000
+    QBO_SANDBOX_PROD_CONSUMER_KEY=prod_consumer_key_ddddddd
+    QBO_SANDBOX_PROD_CONSUMER_SECRET=prod_consumer_secret_dddddd
+    QBO_SANDBOX_TOKEN=token_gggggg
+    QBO_SANDBOX_SECRET=secret_ggggg
+    QBO_SANDBOX_CONSUMER_KEY=consumer_key_yyyyyy
+    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.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/qbo-sandbox.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "qbo/sandbox"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/qbo-sandbox

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+require 'qbo/sandbox'
+require 'optparse'
+
+opt_parser = OptionParser.new do |opt|
+  opt.banner = "Usage: qbo-sandbox entity"
+  opt.separator  ""
+  opt.separator  "Options"
+
+  opt.on("-v", "--version", "print the version") do
+    $stdout.puts 'qbo-sandbox version ' + Qbo::Sandbox::VERSION
+    Kernel.exit
+  end
+end
+
+opt_parser.parse!
+
+unless ARGV.count == 1
+  $stdout.puts opt_parser
+  exit 1
+end
+
+begin
+  entity = ARGV.at(0)
+  preview = Qbo::Sandbox.new.send(entity)
+  $stdout.puts "Done"
+rescue => e
+  $stderr.puts e
+  exit 1
+end
+
+$stdout.flush

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/qbo/sandbox.rb

@@ -0,0 +1,85 @@
+require "qbo/sandbox/version"
+require "dotenv"
+require "qbo_api"
+
+module Qbo
+  class Sandbox
+    attr_reader :prod, :sandbox
+    def initialize(**args)
+      load_env!
+      keyword_args.merge(args).each do |key, val|
+        unless val
+          args[key] = get_env(key)
+        end
+      end
+      init_sandbox(args)
+      init_prod(args)
+    end
+
+    def get_env(key)
+      env_var = 'QBO_SANDBOX_' + key.to_s.upcase
+      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" => [] }
+      QboApi.production = true
+      #@prod.query(select)
+      @prod.all(entity, max: max, select: select, inactive: inactive) do |e|
+        payload["BatchItemRequest"] << build_single_batch(e, entity)
+      end
+      QboApi.production = false
+      @sandbox.batch payload
+    end
+
+    private
+
+    def keyword_args
+      {
+        token: nil,
+        secret: nil,
+        realm_id: nil,
+        consumer_key: nil,
+        consumer_secret: nil,
+        prod_token: nil,
+        prod_secret: nil,
+        prod_realm_id: nil,
+        prod_consumer_key: nil,
+        prod_consumer_secret: nil
+      }
+    end
+
+    def init_sandbox(args)
+      @sandbox = QboApi.new(token: args[:token], 
+                            token_secret: args[:secret], 
+                            realm_id: args[:realm_id],
+                            consumer_key: args[:consumer_key], 
+                            consumer_secret: args[:consumer_secret])
+    end
+    
+    def init_prod(args)
+      @prod = QboApi.new(token: args[:prod_token], 
+                         token_secret: args[:prod_secret], 
+                         realm_id: args[:prod_realm_id],
+                         consumer_key: args[:prod_consumer_key], 
+                         consumer_secret: args[:prod_consumer_secret])
+      
+    end
+
+    def build_single_batch(e, entity)
+      {
+        "bId" => "bid#{e.delete('Id')}",
+        "operation" => "create",
+        @prod.singular(entity) => e
+      }
+    end
+
+    def load_env!
+      if ENV.has_key?('QBO_SANDBOX_ENV_FILE')
+        Dotenv.load(ENV['QBO_SANDBOX_ENV_FILE'])
+      else
+        Dotenv.load
+      end
+    end
+  end
+end

data/lib/qbo/sandbox/version.rb

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

data/qbo-sandbox.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'qbo/sandbox/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "qbo-sandbox"
+  spec.version       = Qbo::Sandbox::VERSION
+  spec.authors       = ["Christian Pelczarski"]
+  spec.email         = ["christian@minimul.com"]
+
+  spec.summary       = %q{Copy production QuickBooks Online resources to a sandbox}
+  spec.homepage      = "https://github.com/minimul/qbo-sandbox"
+  spec.license       = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 2.0"
+  spec.add_development_dependency "awesome_print"
+  spec.add_runtime_dependency "dotenv"
+  spec.add_runtime_dependency "qbo_api"
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: qbo-sandbox
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christian Pelczarski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: qbo_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- christian@minimul.com
+executables:
+- console
+- qbo-sandbox
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/qbo-sandbox
+- bin/setup
+- lib/qbo/sandbox.rb
+- lib/qbo/sandbox/version.rb
+- qbo-sandbox.gemspec
+homepage: https://github.com/minimul/qbo-sandbox
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Copy production QuickBooks Online resources to a sandbox
+test_files: []