myob-api 0.9.5 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a697621522acb62c1242ba5ccdec10372b9e950
-  data.tar.gz: 61b3ca85bf3824c07f209bd5b164514e0dc898e2
+  metadata.gz: a5e048f96fb5846bce047fe559ef780bbad33602
+  data.tar.gz: ef9f5324aaf724ccf29f85fe865bec18bbfe4ac6
 SHA512:
-  metadata.gz: d855db5829da5bf1d73b7f8a5aff3797261c8d68e93b10952c314782d6ab6b292754b1027e6b37f4fb7f2d2edc8188c3f177dff2b2ad0f4929bda0a7a5d932e5
-  data.tar.gz: d994ded4f98afc2e716fa67f7e03cdfaaccb1d6927bea7e74e5253286087bbb510a8e33efea80c904a982b3b3b1d0133346c9c98f4ea6db1e17fb9392e887e49
+  metadata.gz: 35941ab08da89b63a24c8ec10d04c3c76e007e6c2c12860d16343e80a38adcce7026f0e426a76bf8ddb804bd6c7a695d0fe106e5a6d1c0d19fb75e2de4d9d116
+  data.tar.gz: 1ceee23871eadc95c7a9223f30fa24027d31733c7b61f1f247f2c49c9a49ced7f515e41750f399a502c0b586c27a2ffb587ff7a7597839eb25d15d7f1c333706

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

@@ -16,6 +16,7 @@ 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'
 

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/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/version.rb

@@ -1,5 +1,5 @@
 module Myob
   module Api
-    VERSION = "0.9.5"
+    VERSION = "0.10.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: myob-api
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.10.1
 platform: ruby
 authors:
 - David Lumley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-20 00:00:00.000000000 Z
+date: 2016-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -74,6 +74,7 @@ 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_payroll_advice.rb
 - lib/myob/api/models/employee_payroll_details.rb
@@ -107,9 +108,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: MYOB AccountRight Live API V2
 test_files: []
-has_rdoc: