quick_book_gateway 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 851b66e6a5c13cda71cadd30f647ff29efd9f453
+  data.tar.gz: 981305ca194a403b00fa359ec92d8ec9e9d93e0d
+SHA512:
+  metadata.gz: 4f4b7d16a39071ff90781f9969c48b5c8c2b21ddfc75b83d71b63c4c2b8800e9f222c2da384c9d539851b307fedb11361e9cfb4d6c1b636b53376c4870aa9e4d
+  data.tar.gz: 9d203c40fd021dd5e4d9895d3477f52c7c8f0daef028eb1e10d424c13bdf1884df699e99eeaa790f5f3bcf0cc24261cb7503e68bf2b43dd49284df23da72731f

data/lib/core_ext/hash.rb

@@ -0,0 +1,5 @@
+class Hash
+  def to_uri_query
+    return self.map{|key, value| "#{key}=#{URI.encode_www_form_component(value)}" if value}.select{|value| value if value}.join("&")
+  end
+end

data/lib/core_ext/nil.rb

@@ -0,0 +1,5 @@
+class NilClass
+  def blank?
+    return true
+  end
+end

data/lib/core_ext/string.rb

@@ -0,0 +1,7 @@
+class String
+  BLANK_REGEX	=	/\A[[:space:]]*\z/
+  
+  def blank?
+    return BLANK_REGEX === self
+  end
+end

data/lib/errors.rb

@@ -0,0 +1,19 @@
+module Errors
+  class GatewayError < StandardError
+    def initialize(msg = "Gateway error.")
+      super(msg)
+    end
+  end
+  
+  class QuickBookgatewayInvalid < GatewayError
+    def initialize(msg = "Quickbook gateway is invalid.")
+      super(msg)
+    end
+  end
+  
+  class RecordDeleteError < GatewayError
+    def initialize(msg = "Can't delete quickbook record.")
+      super(msg)
+    end
+  end
+end

data/lib/gateway/quickbook.rb

@@ -0,0 +1,95 @@
+require 'oauth'
+
+module Gateway
+  class Quickbook < Result
+  
+    attr_reader :api 
+    attr_accessor :consumer, :access_token, :company_id
+    
+    module HTTP
+      JSON = "application/json"
+    end
+    
+    module ENVIRONMENT
+      SANDBOX     = "sandbox"
+      PRODUCTION  = "production"
+    end
+    
+    module API
+      VERSION = "v3"
+      COMPANY = "company/?" #replace ? with company ID
+      
+      QUERY = "query" 
+    end
+    
+    private
+    def api=(value)
+      @api = value
+    end
+    
+    public
+    #Connect to QuickBook online API gateway
+    #Options are as follow
+    #   String: Environment ENVIRONMENT::SANDBOX or ENVIRONMENT::PRODUCTION. AutoLoad QuickBook key, secret, access token, access secret, company ID from config/quickbook.yml corresponding to environment given.
+    #   Hash: 
+    #     :qb_key       =>   QuickBook Key
+    #     :qb_secret    =>   QuickBook Secret
+    #     :token        =>   Access Token
+    #     :secret       =>   Access Sceret
+    #     :company_id   =>   QuickBook Company ID
+    #     :environment  =>   ENVIRONMENT::SANDBOX or ENVIRONMENT::PRODUCTION
+    def self.connect(options)   
+      if(options.class == String)
+        configuration = YAML.load_file("config/quickbook.yml")
+        environment = options
+        options = Hash.new
+        options[:qb_key] = configuration[environment]["key"]
+        options[:qb_secret] =   configuration[environment]["secret"]
+        options[:token] =   configuration[environment]["access_token"]
+        options[:secret] =   configuration[environment]["access_secret"]
+        options[:company_id] =   configuration[environment]["company_id"]
+        options[:environment] = environment
+      end
+      
+      gateway = new
+      gateway.consumer = OAuth::Consumer.new(options[:qb_key], options[: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"
+        })
+      
+      gateway.access_token = OAuth::AccessToken.new(gateway.consumer, options[:token], options[:secret])
+      
+      gateway.company_id = options[:company_id]
+      
+      case options[:environment]
+      when ENVIRONMENT::PRODUCTION
+        gateway.send("api=", "https://quickbooks.api.intuit.com")
+      else
+        gateway.send("api=", "https://sandbox-quickbooks.api.intuit.com")
+      end   
+      
+      Service::Record.quickbook_gateway = gateway
+    end
+    
+    private
+    def url(path, params = {})
+      url = File.join(self.api, API::VERSION, API::COMPANY.gsub("?", self.company_id.to_s), path)
+      return "#{url}?#{params.to_uri_query}"
+    end
+    
+    public
+    def get(path, parameters = {})
+      return handle_query_result(self.access_token.get(url(path, parameters), {"Accept" => HTTP::JSON}))
+    end
+    
+    def query_data(query)
+      return get(API::QUERY, {:query => query})
+    end
+    
+    def post(path, parameters, body)
+      return handle_query_result(self.access_token.post(url(path, parameters), body,  {"Content-Type" => HTTP::JSON, "Accept" => HTTP::JSON}))
+    end
+  end
+end

data/lib/gateway/result.rb

@@ -0,0 +1,29 @@
+require 'json'
+
+module Gateway
+  class Result
+    
+    include Errors
+    
+    def handle_query_result(response)
+      if(response.code == "200")
+        result = JSON.parse(response.body)
+        
+        if result["Fault"]
+          error_message = ""
+          result["Fault"]["Error"].each{|error|
+            error_message = "#{error["Message"]}. #{error["Detail"]}" 
+          }
+          
+          raise GatewayError, error_message
+        end
+        
+        return result["QueryResponse"] if result["QueryResponse"]
+        
+        return result
+      else
+        raise GatewayError, response.body
+      end
+    end
+  end
+end

data/lib/quick_book_gateway.rb

@@ -0,0 +1,24 @@
+require 'errors'
+
+require 'core_ext/string'
+require 'core_ext/nil'
+require 'core_ext/hash'
+
+require 'gateway/result'
+require 'gateway/quickbook'
+
+require 'service/query'
+require 'service/finder'
+require 'service/callback'
+require 'service/persistence'
+require 'service/record'
+
+Dir.glob("app/services/*.rb") do|service|
+  require "./#{service}"
+end
+
+Dir.glob("quick_book_lib/*.rb") do|library|
+  require "./#{library}"
+end if(File.exists?("quick_book_lib"))
+
+Gateway::Quickbook.connect(Gateway::Quickbook::ENVIRONMENT::SANDBOX) if File.exist?("./config/quickbook.yml")

data/lib/service/callback.rb

@@ -0,0 +1,27 @@
+module Service
+  module Callback
+    def before_save
+    end
+    
+    def after_save
+    end
+    
+    def before_create
+    end
+    
+    def after_create
+    end
+    
+    def before_update
+    end
+    
+    def after_update
+    end
+    
+    def before_destroy
+    end
+    
+    def after_destroy      
+    end
+  end
+end

data/lib/service/finder.rb

@@ -0,0 +1,71 @@
+module Service
+  module Finder
+    def self.extended(base)
+      base.send :extend, Query
+    end
+  
+    #Find All records related to options provided
+    #Options are as below
+    #   :conditions => where clause. Default is NOTHING
+    #               For example, if you want to fetch customer with DisplayName 'Kunal' then :conditions => ["DisplayName = ?", "Kunal"]
+    #
+    #   :select => Needed column list. Default is ALL
+    #           For ex. if you want Id, DisplayName of all customers then :select => "Id, DisplayName"
+    def find_all(options = {})
+      raise QuickBookgatewayInvalid unless quickbook_gateway
+      
+      records = Array.new
+      
+      qb_data = quickbook_gateway.query_data(create_query(options))[entity]
+      
+      qb_data.each{|qb_record|
+        model = self.new(qb_record)
+        model.is_new_record = false
+        
+        records << model
+      } if qb_data
+      
+      return records
+    end
+    
+    #Only fetch first record as per options provided
+    #Options are as below
+    #   Same as Find All
+    #     Or you can directly provide Id of record.
+    #     For ex. if you want to fetch customer with Id 1, then Customer.find(1)
+    def find(options = {})
+      if(options.class == Fixnum)
+        model = self.new(quickbook_gateway.get("#{entity.downcase}/#{options}")[entity]) 
+        model.is_new_record = false
+        return model
+      end
+      
+      options[:top] = 1
+      return self.find_all(options)[0]
+    end
+    
+    #Try to find record on QuickBook Online as per options provided else create instance of new
+    #Options should be an Hash contains columns and values to find record.
+    #   For ex. if you want to update customer(Kunal) country to India if exist or create new:
+    #       kunal = Customer.find_or_initialize({"DisplayName" => "Kunal")
+    #       kunal.Country = "India"
+    #       kunal.save!
+    def find_or_initialize(options)
+      return new() if(options.keys.length == 0)
+      
+      conditions = [""]
+      options.keys.each{|column|
+        conditions[0] += "AND #{column}=?"
+        conditions << options[column]
+      }
+      
+      conditions[0] = conditions[0][4..conditions[0].length].to_s
+      
+      qb_record = find({:conditions => conditions})
+      
+      qb_record = new(options) unless qb_record
+      
+      return qb_record
+    end
+  end
+end

data/lib/service/persistence.rb

@@ -0,0 +1,57 @@
+module Service
+  module Persistence
+    
+    def self.included(base)
+      base.send :include, Callback
+    end
+    
+    private
+    def qb_entity
+      return case self.class.to_s
+      when 'TaxRate' then 'TaxService'
+      else entity.downcase
+      end
+    end
+    
+    public
+    #Create or Update current instance to QuickBook
+    def save!
+      new_record = self.is_new_record
+      
+      before_save
+      before_create if new_record
+      before_update unless new_record
+      
+      params = {}
+      params[:operation] = :update unless(self.is_new_record)
+      
+      self.attributes = quickbook_gateway.post(qb_entity, params , self.attributes.to_json())[qb_entity]
+      
+      after_update unless new_record
+      after_create if new_record
+      after_save
+    end
+    
+    #Delete QuickBook record, require Id attribute
+    #This will delete or make record Inactive based on object class.
+    #For Invoice it will delete record from server else make record Active false.
+    def destroy
+      before_destroy
+      
+      entities_for_delete = ["INVOICE"]
+      
+      raise RecordDeleteError, "Can't delete record without ID" if self["Id"].to_i == 0
+      if(entities_for_delete.index(qb_entity.upcase))
+        raise RecordDeleteError, "Can't delete new record" if self.is_new_record 
+        quickbook_gateway.post(qb_entity.downcase, {:operation => :delete} , {"Id" => self["Id"]}.to_json())
+        self.attributes = {}
+        self.is_new_record = true
+      else
+        self.Active = "false"
+        self.save!
+      end
+      
+      after_destroy
+    end
+  end
+end

data/lib/service/query.rb

@@ -0,0 +1,25 @@
+module Service
+  module Query
+    
+    def sanitize_sql(ary)
+      return ary if ary.class != Array
+      
+      statement, *values = ary
+      
+      return statement.gsub('?') do
+        "'" + values[0].to_s.gsub("'", "\\\\'") +"'"
+      end
+    end
+    
+    def create_query(options = {})
+      columns = "*"
+      
+      condition = "WHERE #{sanitize_sql(options[:conditions])}" unless(options[:conditions].to_s.blank?)
+      columns = options[:select] unless(options[:select].to_s.blank?)      
+      
+      max_result = "STARTPOSITION 1 MAXRESULTS #{options[:top]}" if(options[:top].to_i > 0)
+        
+      return "SELECT #{columns} FROM #{entity} #{condition} #{max_result}"
+    end
+  end
+end

data/lib/service/record.rb

@@ -0,0 +1,60 @@
+module Service
+  #Base class use to map QuickBook record with Ruby instance
+  #QuickBook API documentation https://developer.intuit.com/v2/apiexplorer?apiname=V3QBO
+  class Record
+    @@quickbook_gateway
+    @@entity 
+        
+    extend Service::Finder
+    include Service::Persistence
+    
+    attr_accessor :attributes, :is_new_record
+
+    #Set instance of Gateway::QuickBook
+    def self.quickbook_gateway=(gateway)
+      @@quickbook_gateway = gateway
+    end
+    
+    def self.quickbook_gateway
+      return @@quickbook_gateway
+    end
+    
+    def quickbook_gateway
+      return @@quickbook_gateway
+    end
+    
+    def initialize(attributes = {})
+      self.is_new_record = true
+      self.attributes = attributes
+    end
+    
+    private 
+    def self.entity
+      self.name.split("::").last
+    end
+    
+    def entity
+      self.class.entity
+    end
+    
+    public
+    def [](key)
+      return self.attributes[key.to_s]
+    end
+
+    def []=(key, value)
+      self.attributes[key.to_s] = value
+    end
+    
+    def method_missing(method_sym, *args, &block)
+      attribute = method_sym.to_s
+      if (args.length == 1 and method_sym.to_s[-1, 1] == "=")
+        self[attribute[(0..method_sym.length - 2)].to_s] = args[0]
+      elsif (self.attributes.keys.index(attribute))
+        return self[attribute]
+      else
+        super
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: quick_book_gateway
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kunal Lalge
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth
+  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: Connect to QuickBook Online and easily synchronize data.
+email: kunallalge@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/core_ext/hash.rb
+- lib/core_ext/nil.rb
+- lib/core_ext/string.rb
+- lib/errors.rb
+- lib/gateway/quickbook.rb
+- lib/gateway/result.rb
+- lib/quick_book_gateway.rb
+- lib/service/callback.rb
+- lib/service/finder.rb
+- lib/service/persistence.rb
+- lib/service/query.rb
+- lib/service/record.rb
+homepage: https://rubygems.org/gems/quick_book_gateway
+licenses: []
+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: QuickBook Online Gateway
+test_files: []