quick_book_gateway 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 851b66e6a5c13cda71cadd30f647ff29efd9f453
-  data.tar.gz: 981305ca194a403b00fa359ec92d8ec9e9d93e0d
+  metadata.gz: 3c8d6f892535dd7bd3d268c41b800805c5127a3b
+  data.tar.gz: 33ceb4988781d01fe856a0d034c5d5807cf51b74
 SHA512:
-  metadata.gz: 4f4b7d16a39071ff90781f9969c48b5c8c2b21ddfc75b83d71b63c4c2b8800e9f222c2da384c9d539851b307fedb11361e9cfb4d6c1b636b53376c4870aa9e4d
-  data.tar.gz: 9d203c40fd021dd5e4d9895d3477f52c7c8f0daef028eb1e10d424c13bdf1884df699e99eeaa790f5f3bcf0cc24261cb7503e68bf2b43dd49284df23da72731f
+  metadata.gz: fdedd1f3a31a592b01c8df6c127249613259d388c5a1cd76e3b187136cb43a095c6b2fd9ca4c6a6e528d23f71ebdafa0abfb88bfaf6e63b6658a042b624ccd45
+  data.tar.gz: e10c5855b3006c6a4b25b1132823ef382e458bdba28f9b9a9b98934f0f82ce6a59ab20394b1c6ffc71e085538a2ca29dfb5243591cd97bc9b62d2e28fa366e72

data/README

@@ -0,0 +1,83 @@
+## Requirements
+
+* Ruby >= 0
+* OAuth
+* Quickbook tokens
+
+
+## Installation
+
+* Execute below command 
+    gem install quick_book_gateway
+
+## How to use
+
+1.  Add line to your ruby program
+
+    require 'quick_book_gateway'
+
+
+2. Configure Quickbook by adding below line to your ruby program
+
+    Gateway::Quickbook.connect(
+            :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
+        )
+
+3.  Create classes with names provided on Quickbook website 
+
+    https://developer.intuit.com/v2/apiexplorer?apiname=V3QBO
+
+    For ex. Account, Customer, Vendor, Invoice, Item, etc
+
+
+4. Inherit all classes with Service::Record Class, class should look like below
+
+    class Customer < Service::Record
+    end
+
+    class Vendor < Service::Record
+    end
+
+    class Item < Service::Record
+    end
+
+5.  You are ready to create, fetch or modify any data on Quickbook.
+    
+    For ex.
+    Customer.find(DisplayName: "Kunal")
+    customer.CompanyName = "Kunal Lalge"
+    customer.save!
+
+6.  For attributes reference read Documentation reference for each class on Quickbook link provided above.
+
+    For ex. https://developer.intuit.com/docs/api/accounting/customer
+  
+7.  One can also use callbacks, below are list of callbacks:
+    
+    before_save         -   Executes every time before object save
+    after_save          -   Executes every time after object save
+    before_create       -   Executes only before new object save
+    after_create        -   Executes only after new object save
+    before_update       -   Executes only before existing object save
+    after_update        -   Executes only after existing object save
+    before_destroy      -   Executes every time before destroy an object
+    after_destroy       -   Executes every time after destroy an object
+
+    Ex. 
+        class Customer < Service::Record
+            def after_create
+                puts "New customer is created on QB"
+            end
+        end
+
+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 NON-INFRINGEMENT. IN NO EVENT SHALL THE
+AUTHOR 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/lib/gateway/quickbook.rb

@@ -32,11 +32,11 @@ module 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
+    #     :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)

data/lib/quick_book_gateway.rb

@@ -13,12 +13,19 @@ 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"))
 
+service_failed = []
+Dir.glob("app/services/*.rb") do|service|
+  begin
+    service_failed << service unless require "./#{service}"
+  rescue
+    service_failed << service 
+  end
+end
+
+service_failed.each{|service| require "./#{service}"}  
+
 Gateway::Quickbook.connect(Gateway::Quickbook::ENVIRONMENT::SANDBOX) if File.exist?("./config/quickbook.yml")

data/lib/service/finder.rb

@@ -47,7 +47,7 @@ module Service
     #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 = Customer.find_or_initialize({"DisplayName" => "Kunal"})
     #       kunal.Country = "India"
     #       kunal.save!
     def find_or_initialize(options)

data/lib/service/record.rb

@@ -3,10 +3,10 @@ module Service
   #QuickBook API documentation https://developer.intuit.com/v2/apiexplorer?apiname=V3QBO
   class Record
     @@quickbook_gateway
-    @@entity 
         
     extend Service::Finder
     include Service::Persistence
+    include Errors
     
     attr_accessor :attributes, :is_new_record
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quick_book_gateway
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Kunal Lalge
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-25 00:00:00.000000000 Z
+date: 2015-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
@@ -24,12 +24,14 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-description: Connect to QuickBook Online and easily synchronize data.
+description: 'Connect to QuickBook Online and easily synchronize data. Please read
+  README file to know how to use located at gems-directory/quick_book_gateway-0.0.2/README '
 email: kunallalge@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README
 - lib/core_ext/hash.rb
 - lib/core_ext/nil.rb
 - lib/core_ext/string.rb