qbo_rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c4789a72cda5576a533ca48cc89c098f5552ef63
+  data.tar.gz: a7a5fb31c24f07dc2795c40aa2b33aae284ce18d
+SHA512:
+  metadata.gz: 3dad384c0da81655114194358205e33296a52b28ad1665ffa386a2061587633ab6d7eb44b3316008fd0d61feb9537467c372f24860ca5e85cdcfc91f86556d81
+  data.tar.gz: 0928f1615572dd845e5be490f09623598849c8e26760ac4c9df348a777f77aa12b8567b737a4f22a2bad23b1205546bde9a083f8767414e3073ea3290e9d5671

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 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/Rakefile

@@ -0,0 +1,23 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'QboRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/generators/qbo_rails/install/install_generator.rb

@@ -0,0 +1,32 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+class QboRails
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      extend Rails::Generators::Migration
+
+      namespace "qbo_rails:install"
+      desc "Copy QboRails default files"
+      source_root File.expand_path('../templates', __FILE__)
+      
+      def copy_config
+         template('config/qbo_rails.rb', "config/initializers/qbo_rails.rb")
+      end
+
+      def copy_model
+         template('models/qbo_error.rb', "app/models/qbo_error.rb")
+      end
+
+      def active_record
+        migration_template 'db/migrate/create_qbo_errors.rb', 'db/migrate/create_qbo_errors.rb'
+      end
+
+      def self.next_migration_number(dirname)
+        ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+
+    end
+  end
+end

data/lib/generators/qbo_rails/install/templates/config/qbo_rails.rb

@@ -0,0 +1,17 @@
+QB_KEY = Rails.application.secrets.qbo_app_consumer_key
+QB_SECRET = Rails.application.secrets.qbo_app_consumer_secret
+
+$qb_oauth_consumer = OAuth::Consumer.new(QB_KEY, QB_SECRET, {
+    :site                 => "https://oauth.intuit.com",
+    :request_token_path   => "/oauth/v1/get_request_token",
+    :authorize_url        => "https://appcenter.intuit.com/Connect/Begin",
+    :access_token_path    => "/oauth/v1/get_access_token"
+})
+
+Quickbooks.sandbox_mode = true unless Rails.env.production?
+
+Quickbooks::Base.configure do |c|
+  c.persistent_token = 'qb_token'
+  c.persistent_secret = 'qb_secret'
+  c.persistent_company_id = 'qb_company_id'
+end

data/lib/generators/qbo_rails/install/templates/db/migrate/create_qbo_errors.rb

@@ -0,0 +1,12 @@
+class CreateQboErrors < ActiveRecord::Migration
+  def change
+    create_table :qbo_errors, force: true do |t|
+      t.string :message
+      t.text :body
+      t.string :resource_type, limit: 100 
+      t.integer :resource_id
+      t.text :request_xml
+      t.timestamps :null => false
+    end
+  end
+end

data/lib/generators/qbo_rails/install/templates/models/qbo_error.rb

@@ -0,0 +1,3 @@
+class QboError < ActiveRecord::Base
+  belongs_to :resource, polymorphic: true
+end

data/lib/generators/qbo_rails/install/usage.md

@@ -0,0 +1,3 @@
+To copy a QboRails initializer to your Rails App, with some configuration values, just do:
+
+    rails generate qbo_rails:install

data/lib/qbo_rails.rb

@@ -0,0 +1,106 @@
+require 'quickbooks-ruby'
+require 'quickbooks-ruby-base'
+require_relative 'qbo_rails/error_handler'
+class QboRails
+  attr_accessor :error, :only_run_once
+  attr_reader   :result, :base
+  cattr_accessor(:foreign_key) { "qbo_id" }
+
+  include ActiveSupport::Rescuable
+  include ErrorHandler
+  rescue_from Quickbooks::IntuitRequestException, 
+              Quickbooks::InvalidModelException, 
+              Quickbooks::AuthorizationFailure, 
+              Quickbooks::Forbidden, 
+              Quickbooks::MissingRealmError, with: :record_error
+
+  def initialize(account, type = nil)
+    @base = Quickbooks::Base.new(account, type) 
+  end
+
+  def create(qb_record)
+    with_rescued_exception do
+      @qb_record = qb_record
+      @result = @base.service.create(@qb_record)
+      @result
+    end
+  end
+
+  def create_or_update(record, qb_record)
+    with_rescued_exception do
+      @record = record
+      @qb_record = qb_record
+      if id = @record.send(foreign_key)
+        prepare_update(id, qb_record)
+        @result = @base.service.update(qb_record)
+      else
+        @result = @base.service.create(@qb_record)
+        set_qbo_id
+      end
+    end
+  end
+
+  def delete(record_or_qbo_id)
+    with_rescued_exception do
+      id = record_or_qbo_id.try(foreign_key) || record_or_qbo_id
+      @qb_record = @base.find_by_id(id)
+      @result = @base.service.delete(@qb_record)
+    end
+  end
+
+  protected
+
+  def with_rescued_exception
+    yield
+  rescue => e
+    if @only_run_once
+      rescue_with_handler(e) || raise
+    else
+      unless run_error_handlers(e)
+        rescue_with_handler(e) || raise
+      end
+    end
+  end
+
+  def run_error_handlers(e)
+    methods.detect do |method|
+      if method =~ /^handle_error_/
+        send(method, e)
+      end
+    end
+  end
+
+  def qbo_error_params(exception)
+    @error = {
+      message: exception.message[0..250],
+      body: "#{exception}\n\n#{exception.message}\n\n#{exception.backtrace}",
+      resource_type: @record.try(:class).try(:name),
+      resource_id: @record.try(:id),
+      request_xml: request_xml(exception)
+    }    
+  end
+
+  def record_error(exception)
+    QboError.create!(qbo_error_params(exception))
+  end
+
+  def request_xml(exception)
+    if exception.respond_to?(:request_xml)
+      exception.request_xml
+    elsif defined?(@qb_record)
+      @qb_record.to_xml.to_s
+    end
+  end
+
+  def prepare_update(id, qb_record)
+    result = @base.find_by_id(id)
+    qb_record.id = result.id
+    qb_record.sync_token = result.sync_token
+    qb_record
+  end
+
+  def set_qbo_id
+    @record.update(self.foreign_key => @result.id)
+    @record
+  end
+end

data/lib/qbo_rails/error_handler.rb

@@ -0,0 +1,4 @@
+class QboRails
+  module ErrorHandler
+  end
+end

data/lib/qbo_rails/version.rb

@@ -0,0 +1,3 @@
+class QboRails
+  VERSION = "1.0.0"
+end

data/lib/tasks/qbo_rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :qbo_rails do
+#   # Task goes here
+# end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/settings_controller.rb

@@ -0,0 +1,33 @@
+class SettingsController < ApplicationController
+
+  def oauth_start
+    token = $qb_oauth_consumer.get_request_token(oauth_callback: oauth_callback_url)
+    cache_token(token)
+    redirect_to("https://appcenter.intuit.com/Connect/Begin?oauth_token=#{token.token}") and return
+  end
+
+  def oauth_callback
+    at = cache_token.get_access_token(:oauth_verifier => params[:oauth_verifier])
+    @url = root_url
+    session[:at] = { token: at.token, secret: at.secret, companyid: params['realmId'] }
+    msg = "Your QuickBooks account has been successfully linked."
+    flash[:notice] = msg
+    render 'close_and_redirect'
+  rescue => e
+    flash[:alert] = "There was a problem linking Your QuickBooks account with error: #{e.message}"
+    render 'close_and_redirect'
+  end
+
+  private
+
+  def cache_token(value = nil)
+    key = "token"
+    unless value
+      Rails.cache.read(key)
+    else
+      Rails.cache.write(key, value, expire_in: 1.hour)
+    end
+  end
+end
+
+  

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/models/account.rb

@@ -0,0 +1,2 @@
+class Account < ActiveRecord::Base
+end

data/spec/dummy/app/models/customer.rb

@@ -0,0 +1,2 @@
+class Customer < ActiveRecord::Base
+end

data/spec/dummy/app/models/qbo_error.rb

@@ -0,0 +1,3 @@
+class QboError < ActiveRecord::Base
+  belongs_to :resource, polymorphic: true
+end

data/spec/dummy/app/services/qbo_rails.rb

@@ -0,0 +1,15 @@
+#cass QboRails
+#  #module ErrorHandler
+#    put 'HIX'
+#    def handle_error_no_line_items(exception)
+#      puts 'HI'
+#      if exception.message =~ /Forbidden/
+#        @only_run_once = true
+#        puts 'hi'
+#        true
+#      else
+#        false
+#      end
+#    end
+#  #end
+#end

data/spec/dummy/app/services/qbo_rails/error_handler.rb

@@ -0,0 +1,32 @@
+class QboRails
+  module ErrorHandler
+
+    def handle_error_name_entity_already_exists(exception)
+      if exception.message =~ /Duplicate Name Exists Error.*Another (customer|vendor|employee)/m
+        display_name = Nokogiri::XML(exception.request_xml).at('DisplayName').content
+        result = @base.find_by_display_name(display_name)
+        if result.entries.size == 1
+          @record.update_column(foreign_key, result.entries.first.id)
+          @only_run_once = true
+          @record.reload
+          create_or_update(@record, @qb_record)
+          true
+        else
+          false
+        end
+      else
+        false
+      end
+    end
+
+    def handle_error_no_line_items(exception)
+      if exception.message =~ /Forbidden/
+        @only_run_once = true
+        create(@qb_record)
+        true
+      else
+        false
+      end
+    end
+  end
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>QboRails dummy app</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+  <%= yield :head %>
+</head>
+<body>
+
+<% flash.each do |name, msg| %>
+  <% if msg.is_a?(String) && name.to_s =~ /^(notice|alert)$/ %>
+    <div class="alert alert-<%= name.to_s == 'notice' ? 'success' : 'danger' %>">
+      <%= content_tag :div, msg, :id => "flash_#{name}" %>
+    </div>
+  <% end %>
+<% end %>
+
+<%= yield %>
+
+</body>
+<script>
+<%= yield :script %>
+</script>
+</html>