myob-essentials-api 0.0.1

data/spec/fixtures/businesses/168254/sale/invoices/35608735.json

@@ -0,0 +1,55 @@
+{
+    "uid": "35608735",
+    "uri": "https://api.myob.com/au/essentials/businesses/168254/sale/invoices/35608735",
+    "invoiceNumber": "IV00000000001",
+    "contact": {
+        "uid": "3604148",
+        "uri": "https://api.myob.com/au/essentials/businesses/168254/contacts/3604148",
+        "name": "Malvern Glass"
+    },
+    "issueDate": "2014-09-29",
+    "dueDate": "2014-10-29",
+    "gstInclusive": true,
+    "lines": [
+        {
+            "account": {
+                "uid": "10108111",
+                "uri": "https://api.myob.com/au/essentials/businesses/168254/generalledger/accounts/10108111",
+                "name": "Sales 1",
+                "displayId": "4-2400"
+            },
+            "item": {
+                "uid": "987815",
+                "uri": "https://api.myob.com/au/essentials/businesses/168254/inventory/items/987815",
+                "number": "AC304",
+                "name": "Pens"
+            },
+            "taxType": {
+                "uid": "10",
+                "uri": "https://api.myob.com/au/essentials/tax/types/10",
+                "code": "GST",
+                "name": "Goods & Services Tax"
+            },
+            "unitOfMeasure": "Qty",
+            "description": "ball point and gel tips",
+            "quantity": 150,
+            "unitPrice": 6.05,
+            "total": 907.5,
+            "links": []
+        }
+    ],
+    "notes": null,
+    "purchaseOrderNumber": null,
+    "total": 907.5,
+    "gst": 82.5,
+    "amountPaid": 0,
+    "amountDue": 907.5,
+    "status": "Open",
+    "displayStatus": "Overdue",
+    "_links": [
+        {
+            "rel": "self",
+            "href": "https://api.myob.com/au/essentials/businesses/168254/sale/invoices/35608735"
+        }
+    ]
+}

data/spec/fixtures/tax/types.json

@@ -0,0 +1,79 @@
+{
+    "_links": [
+        {
+            "rel": "self",
+            "href": "https://api.myob.com/au/essentials/tax/types"
+        }
+    ],
+    "items": [
+        {
+            "uid": "5",
+            "uri": null,
+            "code": "ABN",
+            "name": "ABN Not Disclosed - Withholdings",
+            "_links": []
+        },
+        {
+            "uid": "6",
+            "uri": null,
+            "code": "CAP",
+            "name": "Capital Acquisitions",
+            "_links": []
+        },
+        {
+            "uid": "7",
+            "uri": null,
+            "code": "EXP",
+            "name": "Export Sales",
+            "_links": []
+        },
+        {
+            "uid": "8",
+            "uri": null,
+            "code": "FRE",
+            "name": "GST Free",
+            "_links": []
+        },
+        {
+            "uid": "9",
+            "uri": null,
+            "code": "GNR",
+            "name": "Not Registered",
+            "_links": []
+        },
+        {
+            "uid": "10",
+            "uri": null,
+            "code": "GST",
+            "name": "Goods & Services Tax",
+            "_links": []
+        },
+        {
+            "uid": "11",
+            "uri": null,
+            "code": "INP",
+            "name": "Input Taxed Purchases",
+            "_links": []
+        },
+        {
+            "uid": "12",
+            "uri": null,
+            "code": "ITS",
+            "name": "Input Taxed Sales",
+            "_links": []
+        },
+        {
+            "uid": "13",
+            "uri": null,
+            "code": "NTR",
+            "name": "Not Reportable",
+            "_links": []
+        }
+    ],
+    "page": {
+        "size": 9,
+        "totalElements": 9,
+        "totalPages": 1,
+        "number": 1
+    }
+}

data/spec/fixtures/tax/types/5.json

@@ -0,0 +1,7 @@
+{
+    "uid": "5",
+    "uri": null,
+    "code": "ABN",
+    "name": "ABN Not Disclosed - Withholdings",
+    "_links": []
+}

data/spec/myob/essentials/api/client_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe Myob::Essentials::Api::Client do
+
+  let(:consumer) { {key: 'key', secret: 'secret'} }
+  let(:params) { {redirect_uri: 'redirect_uri', consumer: consumer, access_token: 'access_token', refresh_token: 'refresh_token'} }
+
+  subject { Myob::Essentials::Api::Client.new(params) }
+
+  describe ".get_access_code_url" do 
+    it "generates the access code url" do
+      expect(subject.get_access_code_url).to eql('https://secure.myob.com/oauth2/account/authorize?client_id=key&redirect_uri=redirect_uri&response_type=code&scope=la.global')
+    end
+  end
+
+  describe ".get_access_token" do 
+    let(:access_code) { '123' }
+
+    before { Timecop.freeze(Time.parse("2015-01-01T00:00:00")) }
+    after { Timecop.return }
+
+    it "requests the access_token" do
+      stub_request(:post, "https://secure.myob.com/oauth2/v1/authorize").
+         to_return(:status => 200, :body => { 'access_token'=>'access_code','token_type'=>'bearer','expires_in'=>1200,'refresh_token'=>'refresh_token',
+                                              'scope'=>'la.global','user'=>{'uid'=>'uid','username'=>'username'}}.to_json, 
+                                   :headers => {"content-type"=>"application/json; charset=utf-8"})
+
+      subject.get_access_token(access_code)
+      expect(subject.access_token).to eql('access_code')
+      expect(subject.refresh_token).to eql('refresh_token')
+      expect(subject.expires_at).to eql((Time.now+1200).to_i)
+    end
+  end
+
+  describe ".refresh!" do 
+    before { Timecop.freeze(Time.parse("2015-01-01T00:00:00")) }
+    after { Timecop.return }
+
+    it "refreshes the access_token" do
+      stub_request(:post, "https://secure.myob.com/oauth2/v1/authorize")
+         .with(:body => {"client_id"=>"key", "client_secret"=>"secret", "grant_type"=>"refresh_token", "refresh_token"=>"refresh_token"},
+               :headers => {'Content-Type'=>'application/x-www-form-urlencoded'})
+         .to_return(:status => 200, :body => { 'access_token'=>'new_access_code','token_type'=>'bearer','expires_in'=>1200,'refresh_token'=>'new_refresh_token',
+                                              'scope'=>'la.global','user'=>{'uid'=>'uid','username'=>'username'}}.to_json,
+                                    :headers => {"content-type"=>"application/json; charset=utf-8"})
+
+      subject.refresh!
+      expect(subject.access_token).to eql('new_access_code')
+      expect(subject.refresh_token).to eql('new_refresh_token')
+      expect(subject.expires_at).to eql((Time.now+1200).to_i)
+    end
+  end
+
+  describe ".connection" do 
+    let (:expires_in) { 1200 }
+    
+    before { stub_request(:post, "https://secure.myob.com/oauth2/v1/authorize").
+              to_return(:status => 200, :body => { 'access_token'=>'access_code','token_type'=>'bearer','expires_in'=>expires_in,'refresh_token'=>'refresh_token',
+                                              'scope'=>'la.global','user'=>{'uid'=>'uid','username'=>'username'}}.to_json, 
+                                        :headers => {"content-type"=>"application/json; charset=utf-8"}) }
+    before { subject.get_access_token('access_code') }
+
+    context "current token is valid" do
+      it "returns the current access token" do
+        expect(subject.connection).to be_a(OAuth2::AccessToken)
+      end
+    end
+
+    context "current token is expired" do
+      let (:expires_in) { -1200 }
+
+      it "returns the current access token" do
+        expect(subject).to receive(:refresh!)
+        expect(subject.connection).to be_a(OAuth2::AccessToken)
+      end
+    end
+  end
+end

data/spec/myob/essentials/api/model/account_classification_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Myob::Essentials::Api::Model::AccountClassification do
+
+  let(:consumer) { {key: 'key', secret: 'secret'} }
+  let(:params) { {consumer: consumer, access_token: 'access_token', refresh_token: 'refresh_token'} }
+
+  subject { Myob::Essentials::Api::Client.new(params) }
+  
+  describe ".account_classification.all_items" do 
+    let(:tax_types_response) { File.read('spec/fixtures/account/classifications.json') }
+
+    before { stub_request(:get, "https://api.myob.com/au/essentials/account/classifications").to_return(:status => 200, :body => tax_types_response, :headers => {}) }
+    
+    it "fetches the list of account classifications" do
+      expect(subject.account_classification.all_items).to eql(JSON.parse(tax_types_response)["items"])
+    end
+  end
+
+  describe ".account_classification.find" do 
+    let(:tax_type_uid)  { '1' }
+    let(:tax_type_response) { File.read("spec/fixtures/account/classifications/#{tax_type_uid}.json") }
+
+    before { stub_request(:get, "https://api.myob.com/au/essentials/account/classifications/#{tax_type_uid}").to_return(:status => 200, :body => tax_type_response, :headers => {}) }
+    
+    it "fetches an account classification by uid" do
+      expect(subject.account_classification.find(tax_type_uid)).to eql(JSON.parse(tax_type_response))
+    end
+  end
+
+end

data/spec/myob/essentials/api/model/account_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Myob::Essentials::Api::Model::Account do
+
+  let(:consumer) { {key: 'key', secret: 'secret'} }
+  let(:business_uid) { '168254' }
+  let(:params) { {consumer: consumer, access_token: 'access_token', refresh_token: 'refresh_token', business_uid: business_uid} }
+
+  subject { Myob::Essentials::Api::Client.new(params) }
+  
+  describe ".account.all_items" do 
+    let(:accounts_response) { File.read("spec/fixtures/businesses/#{business_uid}/generalledger/accounts.json") }
+
+    before { stub_request(:get, "https://api.myob.com/au/essentials/businesses/#{business_uid}/generalledger/accounts").to_return(:status => 200, :body => accounts_response, :headers => {}) }
+    
+    it "fetches the list of accounts" do
+      expect(subject.account.all_items).to eql(JSON.parse(accounts_response)["items"])
+    end
+  end
+
+  describe ".account.find" do 
+    let(:account_uid) { '10108109' }
+    let(:account_response) { File.read("spec/fixtures/businesses/#{business_uid}/generalledger/accounts/#{account_uid}.json") }
+
+    before { stub_request(:get, "https://api.myob.com/au/essentials/businesses/#{business_uid}/generalledger/accounts/#{account_uid}").to_return(:status => 200, :body => account_response, :headers => {}) }
+    it "fetches an account by uid" do
+      expect(subject.account.find(account_uid)).to eql(JSON.parse(account_response))
+    end
+  end
+
+end

data/spec/myob/essentials/api/model/account_type_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Myob::Essentials::Api::Model::AccountType do
+
+  let(:consumer) { {key: 'key', secret: 'secret'} }
+  let(:params) { {consumer: consumer, access_token: 'access_token', refresh_token: 'refresh_token'} }
+
+  subject { Myob::Essentials::Api::Client.new(params) }
+  
+  describe ".account_type.all_items" do 
+    let(:tax_types_response) { File.read('spec/fixtures/account/types.json') }
+
+    before { stub_request(:get, "https://api.myob.com/au/essentials/account/types").to_return(:status => 200, :body => tax_types_response, :headers => {}) }
+    
+    it "fetches the list of account types" do
+      expect(subject.account_type.all_items).to eql(JSON.parse(tax_types_response)["items"])
+    end
+  end
+
+  describe ".account_type.find" do 
+    let(:tax_type_uid)  { '1' }
+    let(:tax_type_response) { File.read("spec/fixtures/account/types/#{tax_type_uid}.json") }
+
+    before { stub_request(:get, "https://api.myob.com/au/essentials/account/types/#{tax_type_uid}").to_return(:status => 200, :body => tax_type_response, :headers => {}) }
+    
+    it "fetches an account type by uid" do
+      expect(subject.account_type.find(tax_type_uid)).to eql(JSON.parse(tax_type_response))
+    end
+  end
+
+end

data/spec/myob/essentials/api/model/base_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+describe Myob::Essentials::Api::Model::Base do
+
+	let(:consumer) { {key: 'key', secret: 'secret'} }
+  let(:endpoint) { 'au' }
+  let(:params) { {redirect_uri: 'redirect_uri', consumer: consumer, access_token: 'access_token', refresh_token: 'refresh_token', endpoint: endpoint} }
+	let(:client) { Myob::Essentials::Api::Client.new(params) }
+
+	subject { Myob::Essentials::Api::Model::Base.new(client, 'base') }
+	
+	describe ".get" do 
+    let(:response_hash) { {'key' => 'value'} }
+
+    context 'AU endpoint' do
+      let(:endpoint) { 'au' }
+      before { stub_request(:get, "https://api.myob.com/au/essentials/base").with(:headers => {'Accept'=>'application/json', 'Content-Type'=>'application/json'})
+              .to_return(:status => 200, :body => response_hash.to_json, :headers => {}) }
+
+      it "gets all the objects from AU endpoint" do
+        expect(subject.get).to eql(response_hash)
+      end
+    end
+
+    context 'NZ endpoint' do
+      let(:endpoint) { 'nz' }
+      before { stub_request(:get, "https://api.myob.com/nz/essentials/base").with(:headers => {'Accept'=>'application/json', 'Content-Type'=>'application/json'})
+              .to_return(:status => 200, :body => response_hash.to_json, :headers => {}) }
+
+      it "gets all the objects from NZ endpoint" do
+        expect(subject.get).to eql(response_hash)
+      end
+    end
+  end
+
+  describe ".find" do 
+    let(:response_hash) { {'key' => 'value'} }
+
+    before { stub_request(:get, "https://api.myob.com/au/essentials/base/1").with(:headers => {'Accept'=>'application/json', 'Content-Type'=>'application/json'})
+              .to_return(:status => 200, :body => response_hash.to_json, :headers => {}) }
+
+    it "gets the object" do
+      expect(subject.find('1')).to eql(response_hash)
+    end
+  end
+
+  describe ".save" do 
+    let(:base_hash) { {'key' => 'value'} }
+
+    context 'create a new object' do
+      before { stub_request(:post, "https://api.myob.com/au/essentials/base")
+        .with(:body => base_hash.to_json, :headers => {'Accept'=>'application/json', 'Content-Type'=>'application/json'})
+        .to_return(:status => 200, :body => {}.to_json, :headers => {}) }
+
+      it "posts the object" do
+        subject.save(base_hash)
+      end
+    end
+
+    context 'update an existing object' do
+      let(:uid) { '892341' }
+      
+      before { base_hash['uid'] = uid }
+      before { stub_request(:put, "https://api.myob.com/au/essentials/base/#{uid}")
+        .with(:body => base_hash.to_json, :headers => {'Accept'=>'application/json', 'Content-Type'=>'application/json'})
+        .to_return(:status => 200, :body => {}.to_json, :headers => {}) }
+      
+      it "puts the object" do
+        subject.save(base_hash)
+      end
+    end
+  end
+
+  describe ".all_items" do 
+    let(:page1) { File.read('spec/fixtures/base1.json') }
+    let(:page2) { File.read('spec/fixtures/base2.json') }
+    let(:page3) { File.read('spec/fixtures/base3.json') }
+
+    before do
+      stub_request(:get, "https://api.myob.com/au/essentials/base").with(:headers => {'Accept'=>'application/json', 'Content-Type'=>'application/json'})
+              .to_return(:status => 200, :body => page1, :headers => {})
+      stub_request(:get, "https://api.myob.com/au/essentials/base?page=2&size=2").with(:headers => {'Accept'=>'application/json', 'Content-Type'=>'application/json'})
+              .to_return(:status => 200, :body => page2, :headers => {})
+      stub_request(:get, "https://api.myob.com/au/essentials/base?page=3&size=2").with(:headers => {'Accept'=>'application/json', 'Content-Type'=>'application/json'})
+              .to_return(:status => 200, :body => page3, :headers => {})
+    end
+
+
+    it "fetches all the paginated objects" do
+      expect(subject.all_items).to eql([
+        {"uid"=>"1", "_links"=>[{"rel"=>"self", "href"=>"https://api.myob.com/au/essentials/base/1"}]},
+        {"uid"=>"2", "_links"=>[{"rel"=>"self", "href"=>"https://api.myob.com/au/essentials/base/2"}]},
+        {"uid"=>"3", "_links"=>[{"rel"=>"self", "href"=>"https://api.myob.com/au/essentials/base/3"}]},
+        {"uid"=>"4", "_links"=>[{"rel"=>"self", "href"=>"https://api.myob.com/au/essentials/base/4"}]},
+        {"uid"=>"5", "_links"=>[{"rel"=>"self", "href"=>"https://api.myob.com/au/essentials/base/5"}]}
+      ])
+    end
+  end
+
+end

data/spec/myob/essentials/api/model/business_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Myob::Essentials::Api::Model::Business do
+
+  let(:consumer) { {key: 'key', secret: 'secret'} }
+  let(:params) { {consumer: consumer, access_token: 'access_token', refresh_token: 'refresh_token'} }
+
+  subject { Myob::Essentials::Api::Client.new(params) }
+  
+  describe ".business.all_items" do 
+    let(:businesses_response) { File.read('spec/fixtures/businesses.json') }
+
+    before { stub_request(:get, "https://api.myob.com/au/essentials/businesses").to_return(:status => 200, :body => businesses_response, :headers => {}) }
+    
+    it "fetches the list of businesses" do
+      expect(subject.business.all_items).to eql(JSON.parse(businesses_response)["items"])
+    end
+  end
+
+  describe ".business.find" do 
+    let(:business_uid)  { '168254' }
+    let(:business_response) { File.read("spec/fixtures/businesses/#{business_uid}.json") }
+
+    before { stub_request(:get, "https://api.myob.com/au/essentials/businesses/#{business_uid}").to_return(:status => 200, :body => business_response, :headers => {}) }
+    
+    it "fetches a business by uid" do
+      expect(subject.business.find(business_uid)).to eql(JSON.parse(business_response))
+    end
+  end
+
+end