myob-api 0.9.4 → 0.10.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 322445a11ec26fbcc878ad5c417a38cb10e78bda
-  data.tar.gz: 4800957550d60047804db64ffac5fea6ce8cce54
+SHA256:
+  metadata.gz: 81720ec02c3dfcd7ff3dede4268209ee3120d197476f762254854d4e0cc64d89
+  data.tar.gz: f02098c6ebd1507cd4926fb6abe9deb8e496e7ab67dc3f71ad0f7984ae979288
 SHA512:
-  metadata.gz: fedbf3d214d38ad2462461294615784edf23566dec87de7bf9ca0b9d58f327e33e66a5c11c6b88bc1a2aa5a39f8b0b906a20a2ab2475c32bdf1af9291e257bf2
-  data.tar.gz: fb330bdecc8a8fe85cdfeae199992d1957b1fb6500f1c7b73c14970ee2ccf246c57708edfd758456bae10072e8e23b53a43ea3d20ae873351137a714f1ab74b2
+  metadata.gz: cd9df8a0f7a85253839347d0ed56c1c643b957e211f0012f7694866ac9d1092e91d9c1a4dc24292dcf027ca40e0a02afee20c9bbadce210295bb21866b4c1a86
+  data.tar.gz: a4c41aa14138db802caab5769b82e5f6374d243ebd3756e9660c9ed2b3e8feceec8f42f1623d0146317b1bd9af265f221ea3c536fdf3a04d21a5818c35406016

data/README.md

@@ -84,6 +84,8 @@ Or if you know which Company File you want to access too:
       },
     })
 
+If you provide a company file, the gem will attempt to connect to MYOB to get the base API subdomain to use for future requests ([learn more](http://developer.myob.com/api/accountright/best-practice-guides/hypermedia-and-uris/)).
+
 ### API Methods
 
 #### Company Files

data/lib/myob-api.rb

@@ -7,21 +7,25 @@ require 'myob/api/models/company_file'
 require 'myob/api/models/company'
 
 require 'myob/api/models/current_user'
+require 'myob/api/models/superannuation_fund'
 
 require 'myob/api/models/contact'
 require 'myob/api/models/customer'
 require 'myob/api/models/employee'
+require 'myob/api/models/employee_payment_details'
 require 'myob/api/models/employee_payroll_details'
 require 'myob/api/models/employee_standard_pay'
 
 require 'myob/api/models/employee_payroll_advice'
 
+require 'myob/api/models/customer_payment'
 require 'myob/api/models/invoice'
 require 'myob/api/models/invoice_item'
 
 require 'myob/api/models/payroll_category'
 require 'myob/api/models/wage'
 require 'myob/api/models/entitlement'
+require 'myob/api/models/tax_table'
 
 require 'myob/api/models/timesheet'
 

data/lib/myob/api/client.rb

@@ -6,7 +6,7 @@ module Myob
     class Client
       include Myob::Api::Helpers
 
-      attr_reader :current_company_file, :client
+      attr_reader :current_company_file, :client, :current_company_file_url
 
       def initialize(options)
         Myob::Api::Model::Base.subclasses.each {|c| model(c.name.split("::").last)}
@@ -15,16 +15,17 @@ module Myob
         @consumer             = options[:consumer]
         @access_token         = options[:access_token]
         @refresh_token        = options[:refresh_token]
-        @current_company_file = options[:selected_company_file] || {}
+
         @client               = OAuth2::Client.new(@consumer[:key], @consumer[:secret], {
           :site          => 'https://secure.myob.com',
           :authorize_url => '/oauth2/account/authorize',
           :token_url     => '/oauth2/v1/authorize',
         })
 
-        if options[:company_file]
-          @current_company_file = select_company_file(options[:company_file])
-        end
+        # on client init, if we have a company file already, get the appropriate base URL for this company file from MYOB
+        provided_company_file = options[:selected_company_file] || options[:company_file]
+        select_company_file(provided_company_file) if provided_company_file
+        @current_company_file ||= {}
       end
 
       def get_access_code_url(params = {})
@@ -40,7 +41,7 @@ module Myob
       end
 
       def headers
-        token = @current_company_file[:token]
+        token = (@current_company_file || {})[:token]
         if token.nil? || token == ''
           # if token is blank assume we are using federated login - http://myobapi.tumblr.com/post/109848079164/2015-1-release-notes
           {
@@ -58,18 +59,39 @@ module Myob
         end
       end
 
+      # given some company file credentials, connect to MYOB and get the appropriate company file object.
+      # store its ID and token for auth'ing requests, and its URL to ensure we talk to the right MYOB server.
+      #
+      # `company_file` should be hash. accepted forms:
+      #
+      # {name: String, username: String, password: String}
+      # {id: String, token: String}
       def select_company_file(company_file)
-        company_file_id = (company_files.find {|file| file['Name'] == company_file[:name]} || [])['Id']
-        if company_file_id
+        # store the provided company file as an ivar so we can use it for subsequent requests
+        # we need the token from it to make the initial request to get company files
+        @current_company_file ||= company_file if company_file[:token]
+
+        selected_company_file = company_files.find {|file|
+          if company_file[:name]
+            file['Name'] == company_file[:name]
+          elsif company_file[:id]
+            file['Id'] == company_file[:id]
+          end
+        }
+
+        if selected_company_file
           token = company_file[:token]
           if (token.nil? || token == '') && !company_file[:username].nil? && company_file[:username] != '' && !company_file[:password].nil?
             # if we have been given login details, encode them into a token
             token = Base64.encode64("#{company_file[:username]}:#{company_file[:password]}")
           end
           @current_company_file = {
-            :id    => company_file_id,
+            :id    => selected_company_file['Id'],
             :token => token
           }
+          @current_company_file_url = selected_company_file['Uri']
+        else
+          @current_company_file = {}
         end
       end
 

data/lib/myob/api/helpers.rb

@@ -1,16 +1,21 @@
-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 Api
+
+    module RefinedString
+      refine String do
+        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
+    end
+
     module Helpers
+      using RefinedString
+
       def model(model_name)
         method_name = model_name.to_s.underscore
         variable_name = "@#{method_name}_model".to_sym
@@ -23,5 +28,6 @@ module Myob
         instance_variable_get(variable_name)
       end
     end
+
   end
 end

data/lib/myob/api/models/base.rb

@@ -3,7 +3,7 @@ module Myob
     module Model
       class Base
 
-        API_URL = 'https://api.myob.com/accountright/'
+        API_URL = 'https://api.myob.com/accountright/' # deprecated except for initial requests - should read from API instead - http://myobapi.tumblr.com/post/141169146113/important-update-accountright-live-cloud-api
         QUERY_OPTIONS = [:orderby, :top, :skip, :filter]
 
         def initialize(client, model_name)
@@ -61,9 +61,13 @@ module Myob
 
         def url(object = nil, params = nil)
           url = if self.model_route == ''
-            "#{API_URL}"
+            API_URL
           else
-            "#{API_URL}#{@client.current_company_file[:id]}/#{self.model_route}#{"/#{object['UID']}" if object && object['UID']}"
+            if @client && @client.current_company_file_url
+              "#{@client.current_company_file_url}/#{self.model_route}#{"/#{object['UID']}" if object && object['UID']}"
+            else
+              "#{API_URL}#{@client.current_company_file[:id]}/#{self.model_route}#{"/#{object['UID']}" if object && object['UID']}"
+            end
           end
 
           if params.is_a?(Hash)
@@ -106,7 +110,11 @@ module Myob
         end
         
         def resource_url
-          "#{API_URL}#{@client.current_company_file[:id]}/#{self.model_route}"
+          if @client && @client.current_company_file_url
+            "#{@client.current_company_file_url}/#{self.model_route}"
+          else
+            "#{API_URL}#{@client.current_company_file[:id]}/#{self.model_route}"
+          end
         end
         
         def perform_request(url)

data/lib/myob/api/models/customer_payment.rb

@@ -0,0 +1,11 @@
+module Myob
+  module Api
+    module Model
+      class CustomerPayment < Base
+        def model_route
+          'Sale/CustomerPayment'
+        end
+      end
+    end
+  end
+end

data/lib/myob/api/models/employee_payment_details.rb

@@ -0,0 +1,11 @@
+module Myob
+  module Api
+    module Model
+      class EmployeePaymentDetail < Base
+        def model_route
+          'Contact/EmployeePaymentDetails'
+        end
+      end
+    end
+  end
+end

data/lib/myob/api/models/entitlement.rb

@@ -0,0 +1,11 @@
+module Myob
+  module Api
+    module Model
+      class Entitlement < Base
+        def model_route
+          'Payroll/PayrollCategory/Entitlement'
+        end
+      end
+    end
+  end
+end

data/lib/myob/api/models/superannuation.rb

@@ -0,0 +1,11 @@
+module Myob
+  module Api
+    module Model
+      class SuperannuationFund < Base
+        def model_route
+          '/Payroll/SuperannuationFund'
+        end
+      end
+    end
+  end
+end

data/lib/myob/api/models/tax_table.rb

@@ -0,0 +1,11 @@
+module Myob
+  module Api
+    module Model
+      class TaxTable < Base
+        def model_route
+          'Payroll/PayrollCategory/TaxTable'
+        end
+      end
+    end
+  end
+end

data/lib/myob/api/version.rb

@@ -1,5 +1,5 @@
 module Myob
   module Api
-    VERSION = "0.9.4"
+    VERSION = "0.10.4"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: myob-api
 version: !ruby/object:Gem::Version
-  version: 0.9.4
+  version: 0.10.4
 platform: ruby
 authors:
 - David Lumley
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-10-20 00:00:00.000000000 Z
+date: 2020-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -74,14 +74,19 @@ files:
 - lib/myob/api/models/contact.rb
 - lib/myob/api/models/current_user.rb
 - lib/myob/api/models/customer.rb
+- lib/myob/api/models/customer_payment.rb
 - lib/myob/api/models/employee.rb
+- lib/myob/api/models/employee_payment_details.rb
 - lib/myob/api/models/employee_payroll_advice.rb
 - lib/myob/api/models/employee_payroll_details.rb
 - lib/myob/api/models/employee_standard_pay.rb
+- lib/myob/api/models/entitlement.rb
 - lib/myob/api/models/general_ledger.rb
 - lib/myob/api/models/invoice.rb
 - lib/myob/api/models/invoice_item.rb
 - lib/myob/api/models/payroll_category.rb
+- lib/myob/api/models/superannuation.rb
+- lib/myob/api/models/tax_table.rb
 - lib/myob/api/models/timesheet.rb
 - lib/myob/api/models/wage.rb
 - lib/myob/api/version.rb
@@ -90,7 +95,7 @@ homepage: https://github.com/davidlumley/myob-api
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -105,10 +110,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.5
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: MYOB AccountRight Live API V2
 test_files: []
-has_rdoc: