sagekit 0.1.0

data/docs/style.css

@@ -0,0 +1,82 @@
+/* Read the Org custom CSS */
+
+/* Body andHeaders */
+h4,h5,h6 {
+    color:#6272a4;
+    font-weight:300;
+}
+
+body{
+    background:#282A36;
+    color:#404040;
+    font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;
+    font-weight:normal;
+    margin:0;
+    min-height:100%;
+    overflow-x:hidden;
+}
+
+/* Code block */
+.codeblock,pre.src,#content .literal-block{
+    border:1px solid #e1e4e5;
+    padding:12px;
+    overflow-x:auto;
+    background:#282A36;
+    margin:1px 0 24px 0;
+    color: #F8F8F2;
+}
+
+/* Links */
+a{
+    color:#6272a4;
+    text-decoration:none;
+    cursor:pointer}
+
+a:hover,a:active{
+    outline:0;
+}
+
+a:hover{
+    color:#bd93f9}
+
+a:visited{
+    color:#9B59B6}
+
+/* Table of Content */
+#table-of-contents{
+    position:fixed;
+    top:0;
+    left:0;
+    width:300px;
+    overflow-x:hidden;
+    overflow-y:scroll;
+    height:100%;
+    background:#44475A;
+    z-index:200;
+    scrollbar-base-color: #1F1D1D;
+    scrollbar-arrow-color: #b3b3b3;
+    scrollbar-shadow-color: #1F1D1D;
+    scrollbar-track-color : #343131;
+}
+
+#table-of-contents h2{
+    z-index:200;
+    background-color:#282A36;
+    text-align:center;
+    padding:0.809em;
+    display:block;
+    color:#fcfcfc;
+    font-size: 100%;
+    margin-bottom:0.809em}
+
+/* Footer */
+#postamble .author {
+    font-size: 100%;
+    margin-bottom: 0px;
+}
+
+#postamble .date {
+    font-size: 90%;
+    margin-bottom: 0px;
+    color: #00f769;
+}

data/lib/sagekit/client.rb

@@ -0,0 +1,97 @@
+require "faraday"
+require "faraday_middleware"
+
+module Sagekit
+  class Client
+    DEFAULT_TIMEOUT = 120
+
+    attr_reader :auth, :base_url, :adapter
+
+    def initialize(auth:, base_url:, adapter: Faraday.default_adapter)
+      @auth = auth
+      @base_url = base_url
+      @adapter = adapter
+    end
+
+    def sales_orders
+      SalesOrdersResource.new(self)
+    end
+
+    def invoices
+      InvoicesResource.new(self)
+    end
+
+    def sales_history
+      SalesHistoryResource.new(self)
+    end
+
+    def purchase_orders
+      PurchaseOrdersResource.new(self)
+    end
+
+    def receipts
+      ReceiptsResource.new(self)
+    end
+
+    def vendor_contract_cost
+      VendorContractCostsResource.new(self)
+    end
+
+    def customers
+      CustomersResource.new(self)
+    end
+
+    def customer_groups
+      CustomerGroupsResource.new(self)
+    end
+
+    def customer_terms
+      CustomerTermsResource.new(self)
+    end
+
+    def account_sets
+      AccountSetsResource.new(self)
+    end
+
+    def credit_notes
+      CreditNotesResource.new(self)
+    end
+
+    def sales_persons
+      SalesPersonsResource.new(self)
+    end
+
+    def vendors
+      VendorsResource.new(self)
+    end
+
+    def vendor_groups
+      VendorGroupsResource.new(self)
+    end
+
+    def vendor_terms
+      VendorTermsResource.new(self)
+    end
+
+    def items
+      ItemsResource.new(self)
+    end
+
+    def categories
+      CategoriesResource.new(self)
+    end
+
+    def locations
+      LocationsResource.new(self)
+    end
+
+    def connection
+      @connection ||= Faraday.new do |con|
+        con.url_prefix = base_url
+        con.request :json
+        con.response :json, content_type: "application/json"
+        con.adapter adapter
+      end
+    end
+  end
+end

data/lib/sagekit/error.rb

@@ -0,0 +1,3 @@
+module Sagekit
+  class Error < StandardError; end
+end

data/lib/sagekit/object.rb

@@ -0,0 +1,18 @@
+require "ostruct"
+
+module Sagekit
+  class Object
+    def initialize(attributes)
+      @attributes = OpenStruct.new(attributes)
+    end
+
+    def method_missing(method, *args, &block)
+      attribute = @attributes.send(method, *args, &block)
+      attribute.is_a?(Hash) ? Object.new(attribute) : attribute
+    end
+
+    def respond_to_missing?(method, inlcude_private = false)
+      true
+    end
+  end
+end

data/lib/sagekit/objects/account_set.rb

@@ -0,0 +1,4 @@
+module Sagekit
+  class AccountSet < Object
+  end
+end

data/lib/sagekit/objects/category.rb

@@ -0,0 +1,4 @@
+module Sagekit
+  class Category < Object
+  end
+end

data/lib/sagekit/objects/credit_note.rb

@@ -0,0 +1,4 @@
+module Sagekit
+  class CreditNote < Object
+  end
+end

data/lib/sagekit/objects/customer.rb

@@ -0,0 +1,4 @@
+module Sagekit
+  class Customer < Object
+  end
+end

data/lib/sagekit/objects/invoice.rb

@@ -0,0 +1,4 @@
+module Sagekit
+  class Invoice < Object
+  end
+end

data/lib/sagekit/objects/item.rb

@@ -0,0 +1,4 @@
+module Sagekit
+  class Item < Object
+  end
+end

data/lib/sagekit/objects/location.rb

@@ -0,0 +1,4 @@
+module Sagekit
+  class Location < Object
+  end
+end

data/lib/sagekit/objects/purchase_order.rb

@@ -0,0 +1,4 @@
+module Sagekit
+  class PurchaseOrder < Object
+  end
+end

data/lib/sagekit/objects/receipt.rb

@@ -0,0 +1,4 @@
+module Sagekit
+  class Receipt < Object
+  end
+end

data/lib/sagekit/objects/sales_history.rb

@@ -0,0 +1,4 @@
+module Sagekit
+  class SalesHistory < Object
+  end
+end

data/lib/sagekit/objects/sales_order.rb

@@ -0,0 +1,4 @@
+module Sagekit
+  class SalesOrder < Object
+  end
+end

data/lib/sagekit/objects/sales_person.rb

@@ -0,0 +1,4 @@
+module Sagekit
+  class SalesPerson < Object
+  end
+end

data/lib/sagekit/objects/vendor.rb

@@ -0,0 +1,4 @@
+module Sagekit
+  class Vendor < Object
+  end
+end

data/lib/sagekit/objects/vendor_contract_cost.rb

@@ -0,0 +1,4 @@
+module Sagekit
+  class VendorContractCost < Object
+  end
+end

data/lib/sagekit/resource.rb

@@ -0,0 +1,55 @@
+module Sagekit
+  class Resource
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def get_request(url, params: {}, headers: {})
+      handle_response client.connection.get(url, params, default_headers.merge(headers))
+    end
+
+    def post_request(url, body:, headers: {})
+      handle_response client.connection.post(url, body, default_headers.merge(headers))
+    end
+
+    def patch_request(url, body:, headers: {})
+      handle_response client.connection.patch(url, body, default_headers.merge(headers))
+    end
+
+    def put_request(url, body:, headers: {})
+      handle_response client.connection.put(url, body, default_headers.merge(headers))
+    end
+
+    def delete_request(url, params: {}, headers: {})
+      handle_response client.connection.delete(url, params, default_headers.merge(headers))
+    end
+
+    def default_headers
+      { Authorization: client.auth }
+    end
+
+    def handle_response(response)
+      case response.status
+      when 400
+        raise Error, "#{response.body}"
+      when 401
+        raise Error, "#{response.body}"
+      when 403
+        raise Error, "#{response.body}"
+      when 404
+        raise Error, "#{response.body}"
+      when 429
+        raise Error, "#{response.body}"
+      when 500
+        raise Error, "#{response.body}"
+      when 503
+        raise Error, "#{response.body}"
+      end
+
+      response
+    end
+
+  end
+end

data/lib/sagekit/resources/account_sets.rb

@@ -0,0 +1,27 @@
+module Sagekit
+  class AccountSetsResource < Resource
+
+    def list(company, **params)
+      AccountSet.new get_request("#{company}/AR/ARAccountSets", params: params).body
+    end
+
+    def retreive(company, id, **params)
+      AccountSet.new get_request("#{company}/AR/ARAccountSets('#{id}')", params: params).body
+    end
+
+    def create(company, **attributes)
+      AccountSet.new post_request("#{company}/AR/ARAccountSets", body: attributes).body
+    end
+
+    def update(company, id, **attributes)
+      patch_request("#{company}/AR/ARAccountSets('#{id}')", body: attributes)
+      true
+    end
+
+    def delete(company, id)
+      delete_request("#{company}/AR/ARAccountSets('#{id}')")
+      true
+    end
+
+  end
+end

data/lib/sagekit/resources/categories.rb

@@ -0,0 +1,26 @@
+module Sagekit
+  class CategoriesResource < Resource
+
+    def list(company, **params)
+        Category.new get_request("#{company}/IC/ICCategories", params: params).body
+    end
+
+    def retreive(company, cat_id, **params)
+        Category.new get_request("#{company}/IC/ICCategories('#{cat_id}')", params: params).body
+    end
+
+    def create(company, **attributes)
+        Category.new post_request("#{company}/IC/ICCategories", body: attributes).body
+    end
+
+    def update(company, cat_id, **attributes)
+      patch_request("#{company}/IC/ICCategories('#{cat_id}')", body: attributes)
+      true
+    end
+
+    def delete(company, item_id)
+      delete_request("#{company}/IC/ICCategories('#{item_id}')")
+      true
+    end
+  end
+end

data/lib/sagekit/resources/credit_notes.rb

@@ -0,0 +1,17 @@
+module Sagekit
+  class CreditNotesResource < Resource
+
+    def list(company, **params)
+      CreditNote.new get_request("#{company}/OE/OECreditDebitNotes", params: params).body
+    end
+
+    def retreive(company, id, **params)
+      CreditNote.new get_request("#{company}/OE/OECreditDebitNotes('#{id}')", params: params).body
+    end
+
+    def create(company, **attributes)
+      CreditNote.new post_request("#{company}/OE/OECreditDebitNotes", body: attributes).body
+    end
+
+  end
+end

data/lib/sagekit/resources/customer_groups.rb

@@ -0,0 +1,26 @@
+module Sagekit
+  class CustomerGroupsResource < Resource
+
+    def list(company, **params)
+      Customer.new get_request("#{company}/AR/ARCustomerGroups", params: params).body
+    end
+
+    def retreive(company, id, **params)
+      Customer.new get_request("#{company}/AR/ARCustomerGroups('#{id}')", params: params).body
+    end
+
+    def create(company, **attributes)
+      Customer.new post_request("#{company}/AR/ARCustomerGroups", body: attributes).body
+    end
+
+    def update(company, id, **attributes)
+      patch_request("#{company}/AR/ARCustomerGroups('#{id}')", body: attributes)
+      true
+    end
+
+    def delete(company, id)
+      delete_request("#{company}/AR/ARCustomerGroups('#{id}')")
+      true
+    end
+  end
+end

data/lib/sagekit/resources/customer_terms.rb

@@ -0,0 +1,26 @@
+module Sagekit
+  class CustomerTermsResource < Resource
+
+    def list(company, **params)
+      Customer.new get_request("#{company}/AR/ARTerms", params: params).body
+    end
+
+    def retreive(company, terms_code, **params)
+      Customer.new get_request("#{company}/AR/ARTerms('#{terms_code}')", params: params).body
+    end
+
+    def create(company, **attributes)
+      Customer.new post_request("#{company}/AR/ARTerms", body: attributes).body
+    end
+
+    def update(company, terms_code, **attributes)
+      patch_request("#{company}/AR/ARTerms('#{terms_code}')", body: attributes)
+      true
+    end
+
+    def delete(company, terms_code)
+      delete_request("#{company}/AR/ARTerms('#{terms_code}')")
+      true
+    end
+  end
+end

data/lib/sagekit/resources/customers.rb

@@ -0,0 +1,26 @@
+module Sagekit
+  class CustomersResource < Resource
+
+    def list(company, **params)
+      Customer.new get_request("#{company}/AR/ARCustomers", params: params).body
+    end
+
+    def retreive(company, customer_id, **params)
+      Customer.new get_request("#{company}/AR/ARCustomers('#{customer_id}')", params: params).body
+    end
+
+    def create(company, **attributes)
+      Customer.new post_request("#{company}/AR/ARCustomers", body: attributes).body
+    end
+
+    def update(company, customer_id, **attributes)
+      patch_request("#{company}/AR/ARCustomers('#{customer_id}')", body: attributes)
+      true
+    end
+
+    def delete(company, customer_id)
+      delete_request("#{company}/AR/ARCustomers('#{customer_id}')")
+      true
+    end
+  end
+end

data/lib/sagekit/resources/invoices.rb

@@ -0,0 +1,12 @@
+module Sagekit
+  class InvoicesResource < Resource
+
+    def list(company, **params)
+      Invoice.new get_request("#{company}/OE/OEOrders", params: params).body
+    end
+
+    def retreive(invoice_id, **params)
+      Invoice.new get_request("#{company}/OE/OEOrders(#{order_id})", params: params).body
+    end
+  end
+end

data/lib/sagekit/resources/items.rb

@@ -0,0 +1,27 @@
+module Sagekit
+  class ItemsResource < Resource
+
+    def list(company, **params)
+        Item.new get_request("#{company}/IC/ICItems", params: params).body
+    end
+
+    def retreive(company, item_id, **params)
+        Item.new get_request("#{company}/IC/ICItems('#{item_id}')", params: params).body
+    end
+
+    def create(company, **attributes)
+        Item.new post_request("#{company}/IC/ICItems", body: attributes).body
+    end
+
+    def update(company, item_id, **attributes)
+      patch_request("#{company}/IC/ICItems('#{item_id}')", body: attributes)
+      true
+    end
+
+    # Delete record
+    def delete(company, item_id)
+      delete_request("#{company}/IC/ICItems('#{item_id}')")
+      true
+    end
+  end
+end

data/lib/sagekit/resources/locations.rb

@@ -0,0 +1,26 @@
+module Sagekit
+  class LocationsResource < Resource
+
+    def list(company, **params)
+        Location.new get_request("#{company}/IC/ICLocations", params: params).body
+    end
+
+    def retreive(company, location_id, **params)
+        Location.new get_request("#{company}/IC/ICLocations('#{locations_id}')", params: params).body
+    end
+
+    def create(company, **attributes)
+        Location.new post_request("#{company}/IC/ICLocations", body: attributes).body
+    end
+
+    def update(company, location_id, **attributes)
+      patch_request("#{company}/IC/ICLocations('#{location_id}')", body: attributes)
+      true
+    end
+
+    def delete(company, location_id)
+      delete_request("#{company}/IC/ICLocations('#{location_id}')")
+      true
+    end
+  end
+end

data/lib/sagekit/resources/purchase_orders.rb

@@ -0,0 +1,16 @@
+module Sagekit
+  class PurchaseOrdersResource < Resource
+
+    def list(company, **params)
+      PurchaseOrder.new get_request("#{company}/PO/POPurchaseOrders", params: params).body
+    end
+
+    def retreive(company, order_id, **params)
+      PurchaseOrder.new get_request("#{company}/PO/POPurchaseOrders(#{order_id})", params: params).body
+    end
+
+    def create(company, **attributes)
+      PurchaseOrder.new post_request("#{company}/PO/POPurchaseOrders", body: attributes).body
+    end
+  end
+end

data/lib/sagekit/resources/receipts.rb

@@ -0,0 +1,16 @@
+module Sagekit
+  class ReceiptsResource < Resource
+
+    def list(company, **params)
+      Receipt.new get_request("#{company}/PO/POReceipts", params: params).body
+    end
+
+    def retreive(company, receipt_id, **params)
+      Receipt.new get_request("#{company}/PO/POReceipts(#{receipt_id})", params: params).body
+    end
+
+    def create(company, **attributes)
+      Receipt.new post_request("#{company}/PO/POReceipts", body: attributes).body
+    end
+  end
+end

data/lib/sagekit/resources/sales_history.rb

@@ -0,0 +1,16 @@
+module Sagekit
+  class SalesHistoryResource < Resource
+
+    def list(company, **params)
+      SalesHistory.new get_request("#{company}/OE/OESalesHistory", params: params).body
+    end
+
+    def details(company, **params)
+      SalesHistory.new get_request("#{company}/OE/OESalesHistoryDetails", params: params).body
+    end
+
+    def stats(company, **params)
+      SalesHistory.new get_request("#{company}/OE/OESalesStatistics", params: params).body
+    end
+  end
+end

data/lib/sagekit/resources/sales_orders.rb

@@ -0,0 +1,40 @@
+module Sagekit
+  class SalesOrdersResource < Resource
+
+    def list(company, **params)
+      SalesOrder.new get_request("#{company}/OE/OEOrders", params: params).body
+    end
+
+    def retreive(company, order_id, **params)
+      SalesOrder.new get_request("#{company}/OE/OEOrders(#{order_id})", params: params).body
+    end
+
+    # Create new record:
+    # body: json
+    # client.sales_orders.create(
+    #   "ACCLTD",
+    #   {
+    #    "CustomerNumber":"33016L",
+    #        "OrderReference":"26",
+    #        "OrderDescription":"Ship via: Delivery",
+    #        "OrderComment":"Ordered form ERP: 26. Testing UOM!",
+    #        "OrderDetails":
+    #        [
+    #            {
+    #               "Item":"0-005-39-00100",
+    #               "StockItem":true,
+    #               "QuantityOrdered":55.12
+    #            },
+    #            {
+    #               "Item":"0-005-19-00200",
+    #               "StockItem":true,
+    #               "QuantityOrdered":101.05
+    #            }
+    #        ]
+    #    }
+    #)
+    def create(company, **attributes)
+      SalesOrder.new post_request("#{company}/OE/OEOrders", body: attributes).body
+    end
+  end
+end