myob-essentials-api 0.0.1

data/lib/myob/essentials/api/helper.rb

@@ -0,0 +1,29 @@
+class String
+  def underscore
+    self.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("-", "_").
+    downcase
+  end
+end
+
+module Myob
+  module Essentials
+    module Api
+      module Helpers
+        def model(model_name)
+          method_name = model_name.to_s.underscore
+          variable_name = "@#{method_name}_model".to_sym
+          unless instance_variable_defined?(variable_name)
+            instance_variable_set(variable_name, Myob::Essentials::Api::Model.const_get("#{model_name}".to_sym).new(self, model_name.to_s))
+            self.define_singleton_method(method_name.to_sym) do
+              instance_variable_get(variable_name)
+            end
+          end
+          instance_variable_get(variable_name)
+        end
+      end
+    end
+  end
+end

data/lib/myob/essentials/api/model/account.rb

@@ -0,0 +1,13 @@
+module Myob
+  module Essentials
+    module Api
+      module Model
+        class Account < Base
+          def model_route
+            'businesses/:business_uid/generalledger/accounts'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/myob/essentials/api/model/account_balance.rb

@@ -0,0 +1,13 @@
+module Myob
+  module Essentials
+    module Api
+      module Model
+        class AccountBalance < Base
+          def model_route
+            'businesses/:business_uid/generalledger/accounts/balances'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/myob/essentials/api/model/account_classification.rb

@@ -0,0 +1,13 @@
+module Myob
+  module Essentials
+    module Api
+      module Model
+        class AccountClassification < Base
+          def model_route
+            'account/classifications'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/myob/essentials/api/model/account_type.rb

@@ -0,0 +1,13 @@
+module Myob
+  module Essentials
+    module Api
+      module Model
+        class AccountType < Base
+          def model_route
+            'account/types'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/myob/essentials/api/model/base.rb

@@ -0,0 +1,114 @@
+module Myob
+  module Essentials
+    module Api
+      module Model
+        class Base
+
+          def initialize(client, model_name=nil)
+            @client          = client
+            @model_name      = model_name || 'Base'
+            
+            @links = nil
+          end
+
+          def model_route
+            @model_name.to_s.downcase
+          end
+
+          def get
+            perform_request(url)
+          end
+
+          def find(id)
+            object = { 'uid' => id }
+            perform_request(url(object))
+          end
+
+          def save(object)
+            new_record?(object) ? create(object) : update(object)
+          end
+
+          def destroy(object)
+            @client.connection.delete(url(object), :headers => @client.headers)
+          end
+
+          def all_items
+            results = get["items"]
+            while link('next')
+              results += next_page["items"] || []
+            end
+            results
+          end
+          
+          def next_page
+            perform_request(link('next')) if link('next')
+          end
+
+          def previous_page
+            perform_request(link('previous')) if link('previous')
+          end
+
+protected
+          def url(object = nil)
+            if model_route == ''
+              "https://api.myob.com/#{@client.endpoint}/essentials"
+            elsif object && object['uid']
+              "#{resource_url}/#{object['uid']}"
+            else
+              resource_url
+            end
+          end
+
+          def new_record?(object)
+            object["uid"].nil? || object["uid"] == ""
+          end
+
+          def create(object)
+            object = typecast(object)
+            @client.connection.post(url, {:headers => @client.headers, :body => object.to_json})
+          end
+
+          def update(object)
+            object = typecast(object)
+            @client.connection.put(url(object), {:headers => @client.headers, :body => object.to_json})
+          end
+
+          def typecast(object)
+            returned_object = object.dup # don't change the original object
+
+            returned_object.each do |key, value|
+              if value.respond_to?(:strftime)
+                returned_object[key] = value.strftime(date_formatter)
+              end
+            end
+
+            returned_object
+          end
+
+          def link(name)
+            return nil unless @links
+            link_hash = @links.select{|link_hash| link_hash['rel'] == name}.first
+            link_hash ? link_hash['href'] : nil
+          end
+
+          def date_formatter
+            "%Y-%m-%dT%H:%M:%S"
+          end
+          
+          def resource_url
+            url = "https://api.myob.com/#{@client.endpoint}/essentials/#{model_route}"
+            url.gsub!(':business_uid', @client.business_uid) if @client.business_uid
+            url
+          end
+          
+          def perform_request(url)
+            response = @client.connection.get(url, {:headers => @client.headers})
+            hash = JSON.parse(response.body)
+            @links = hash['_links']
+            hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/myob/essentials/api/model/business.rb

@@ -0,0 +1,13 @@
+module Myob
+  module Essentials
+    module Api
+      module Model
+        class Business < Base
+        	def model_route
+            'businesses'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/myob/essentials/api/model/contact.rb

@@ -0,0 +1,13 @@
+module Myob
+  module Essentials
+    module Api
+      module Model
+        class Contact < Base
+          def model_route
+            'businesses/:business_uid/contacts'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/myob/essentials/api/model/inventory_item.rb

@@ -0,0 +1,13 @@
+module Myob
+  module Essentials
+    module Api
+      module Model
+        class InventoryItem < Base
+          def model_route
+            'businesses/:business_uid/inventory/items'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/myob/essentials/api/model/sale_invoice.rb

@@ -0,0 +1,13 @@
+module Myob
+  module Essentials
+    module Api
+      module Model
+        class SaleInvoice < Base
+          def model_route
+            'businesses/:business_uid/sale/invoices'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/myob/essentials/api/model/sale_payment.rb

@@ -0,0 +1,13 @@
+module Myob
+  module Essentials
+    module Api
+      module Model
+        class SalePayment < Base
+          def model_route
+            'businesses/:business_uid/sale/payments'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/myob/essentials/api/model/tax_type.rb

@@ -0,0 +1,13 @@
+module Myob
+  module Essentials
+    module Api
+      module Model
+        class TaxType < Base
+          def model_route
+            'tax/types'
+          end
+        end
+      end
+    end
+  end
+end

data/myob-essentials-api.gemspec

@@ -0,0 +1,102 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: myob-essentials-api 0.0.1 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "myob-essentials-api"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["BrunoChauvet"]
+  s.date = "2015-01-27"
+  s.description = "Integrate with MYOB Essentials Accounting"
+  s.email = "it@maestrano.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".ruby-version",
+    ".travis.yml",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/myob-essentials-api.rb",
+    "lib/myob/essentials/api/client.rb",
+    "lib/myob/essentials/api/helper.rb",
+    "lib/myob/essentials/api/model/account.rb",
+    "lib/myob/essentials/api/model/account_balance.rb",
+    "lib/myob/essentials/api/model/account_classification.rb",
+    "lib/myob/essentials/api/model/account_type.rb",
+    "lib/myob/essentials/api/model/base.rb",
+    "lib/myob/essentials/api/model/business.rb",
+    "lib/myob/essentials/api/model/contact.rb",
+    "lib/myob/essentials/api/model/inventory_item.rb",
+    "lib/myob/essentials/api/model/sale_invoice.rb",
+    "lib/myob/essentials/api/model/sale_payment.rb",
+    "lib/myob/essentials/api/model/tax_type.rb",
+    "myob-essentials-api.gemspec",
+    "spec/fixtures/account/classifications.json",
+    "spec/fixtures/account/classifications/1.json",
+    "spec/fixtures/account/types.json",
+    "spec/fixtures/account/types/1.json",
+    "spec/fixtures/base1.json",
+    "spec/fixtures/base2.json",
+    "spec/fixtures/base3.json",
+    "spec/fixtures/businesses.json",
+    "spec/fixtures/businesses/168254.json",
+    "spec/fixtures/businesses/168254/contacts.json",
+    "spec/fixtures/businesses/168254/contacts/3604150.json",
+    "spec/fixtures/businesses/168254/generalledger/accounts.json",
+    "spec/fixtures/businesses/168254/generalledger/accounts/10108109.json",
+    "spec/fixtures/businesses/168254/inventory/items.json",
+    "spec/fixtures/businesses/168254/inventory/items/987816.json",
+    "spec/fixtures/businesses/168254/sale/invoices.json",
+    "spec/fixtures/businesses/168254/sale/invoices/35608735.json",
+    "spec/fixtures/tax/types.json",
+    "spec/fixtures/tax/types/5.json",
+    "spec/myob/essentials/api/client_spec.rb",
+    "spec/myob/essentials/api/model/account_classification_spec.rb",
+    "spec/myob/essentials/api/model/account_spec.rb",
+    "spec/myob/essentials/api/model/account_type_spec.rb",
+    "spec/myob/essentials/api/model/base_spec.rb",
+    "spec/myob/essentials/api/model/business_spec.rb",
+    "spec/myob/essentials/api/model/contact_spec.rb",
+    "spec/myob/essentials/api/model/inventory_item_spec.rb",
+    "spec/myob/essentials/api/model/sale_invoice_spec.rb",
+    "spec/myob/essentials/api/model/sale_payment_spec.rb",
+    "spec/myob/essentials/api/model/tax_type_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/BrunoChauvet/myob-essentials-api"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.5"
+  s.summary = "Integrate with MYOB Essentials Accounting"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<oauth2>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<oauth2>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<oauth2>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/spec/fixtures/account/classifications.json

@@ -0,0 +1,104 @@
+{
+    "_links": [
+        {
+            "rel": "self",
+            "href": "https://api.myob.com/au/essentials/account/classifications"
+        }
+    ],
+    "items": [
+        {
+            "uid": "1",
+            "uri": "https://api.myob.com/au/essentials/account/classifications/1",
+            "name": "Asset",
+            "_links": [
+                {
+                    "rel": "self",
+                    "href": "https://api.myob.com/au/essentials/account/classifications/1"
+                }
+            ]
+        },
+        {
+            "uid": "2",
+            "uri": "https://api.myob.com/au/essentials/account/classifications/2",
+            "name": "Liability",
+            "_links": [
+                {
+                    "rel": "self",
+                    "href": "https://api.myob.com/au/essentials/account/classifications/2"
+                }
+            ]
+        },
+        {
+            "uid": "3",
+            "uri": "https://api.myob.com/au/essentials/account/classifications/3",
+            "name": "Equity",
+            "_links": [
+                {
+                    "rel": "self",
+                    "href": "https://api.myob.com/au/essentials/account/classifications/3"
+                }
+            ]
+        },
+        {
+            "uid": "4",
+            "uri": "https://api.myob.com/au/essentials/account/classifications/4",
+            "name": "Income",
+            "_links": [
+                {
+                    "rel": "self",
+                    "href": "https://api.myob.com/au/essentials/account/classifications/4"
+                }
+            ]
+        },
+        {
+            "uid": "5",
+            "uri": "https://api.myob.com/au/essentials/account/classifications/5",
+            "name": "Cost Of Goods Sold",
+            "_links": [
+                {
+                    "rel": "self",
+                    "href": "https://api.myob.com/au/essentials/account/classifications/5"
+                }
+            ]
+        },
+        {
+            "uid": "6",
+            "uri": "https://api.myob.com/au/essentials/account/classifications/6",
+            "name": "Expense",
+            "_links": [
+                {
+                    "rel": "self",
+                    "href": "https://api.myob.com/au/essentials/account/classifications/6"
+                }
+            ]
+        },
+        {
+            "uid": "8",
+            "uri": "https://api.myob.com/au/essentials/account/classifications/8",
+            "name": "Other Income",
+            "_links": [
+                {
+                    "rel": "self",
+                    "href": "https://api.myob.com/au/essentials/account/classifications/8"
+                }
+            ]
+        },
+        {
+            "uid": "9",
+            "uri": "https://api.myob.com/au/essentials/account/classifications/9",
+            "name": "Other Expenses",
+            "_links": [
+                {
+                    "rel": "self",
+                    "href": "https://api.myob.com/au/essentials/account/classifications/9"
+                }
+            ]
+        }
+    ],
+    "page": {
+        "size": 8,
+        "totalElements": 8,
+        "totalPages": 1,
+        "number": 1
+    }
+}