myob-advanced-api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: adead9767a1fc9b00e63a9f79d33249b9ea993652881b612bd8d35ea863a4663
+  data.tar.gz: 30c9d78d02bec44dbe5ed4d8054651aa0d780b9c35fe074df88c50cfd9a7a81f
+SHA512:
+  metadata.gz: 29e8c436c6cd7287d0fcca4748d49911d6af232d76f3d3c611fe95e9c7f411a4ef7b755fb983938d906d26cfe15c9b2762470727b689a18af722ca11cd69e0d2
+  data.tar.gz: fce5283cad4e403486a6dc7e8bc6211b13ffa3e0579f7bef0c438497d3cf58271cf4b81a83700e77041a66f4c983597069c4ccbdb2c021508adf58d39046a16b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rbenv-gemsets

@@ -0,0 +1 @@
+myob-advanced-api

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in myob-advanced-api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2020 Van Nguyen
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,26 @@
+# MYOB Advanced API
+
+[MYOB Advanced Api](https://github.com/vannguyenvietnam/myob-advanced-api) inherited the structure of [MYOB Api](https://github.com/davidlumley/myob-api) is an interface for accessing [MYOB](https://developer.myob.com/api/advanced/)'s  Advanced instance.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'myob-advanced-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install myob-advanced-api
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/myob-advanced-api.rb

@@ -0,0 +1,24 @@
+require 'myob_advanced/api/version'
+require 'myob_advanced/api/helpers'
+
+require 'myob_advanced/api/models/base'
+require 'myob_advanced/api/models/custom'
+
+require 'myob_advanced/api/models/account'
+require 'myob_advanced/api/models/payment_method'
+
+require 'myob_advanced/api/models/customer'
+require 'myob_advanced/api/models/customer_class'
+require 'myob_advanced/api/models/contact'
+require 'myob_advanced/api/models/customer_payment_method'
+
+require 'myob_advanced/api/models/invoice'
+require 'myob_advanced/api/models/sales_invoice'
+require 'myob_advanced/api/models/payment'
+
+require 'myob_advanced/api/models/vendor'
+require 'myob_advanced/api/models/vendor_class'
+require 'myob_advanced/api/models/bill'
+require 'myob_advanced/api/models/check'
+
+require 'myob_advanced/api/client'

data/lib/myob_advanced/api/client.rb

@@ -0,0 +1,81 @@
+require 'base64'
+require 'oauth2'
+
+module MyobAdvanced
+  module Api
+    class Client
+      include MyobAdvanced::Api::Helpers
+
+      attr_reader :client
+
+      def initialize(options)
+        @redirect_uri         = options[:redirect_uri]
+        @consumer             = options[:consumer]
+        @access_token         = options[:access_token]
+        @refresh_token        = options[:refresh_token]
+        @site_url             = options[:site_url]
+        @default_version      = options[:default_version] # Default web servive enpoint version
+
+        # Init model methods
+        MyobAdvanced::Api::Model::Base.subclasses.each {|c| model(c.name.split("::").last)}
+
+        @client               = OAuth2::Client.new(@consumer[:key], @consumer[:secret], {
+          :site          => @site_url,
+          :authorize_url => '/identity/connect/authorize',
+          :token_url     => '/identity/connect/token',
+        })
+      end
+
+      def default_api_url
+        "#{@site_url}/entity/Default/#{@default_version}"
+      end
+
+      def site_url
+        @site_url
+      end
+
+      def get_access_code_url(params = {})
+        scope = params[:scope] || 'api offline_access'
+        @client.auth_code.authorize_url(params.merge(scope: scope, redirect_uri: @redirect_uri))
+      end
+
+      def get_access_token(access_code)
+        @token         = @client.auth_code.get_token(access_code, redirect_uri: @redirect_uri)
+        @access_token  = @token.token
+        @expires_at    = @token.expires_at
+        @refresh_token = @token.refresh_token
+        @token
+      end
+      
+      def refresh_access_token!
+        @token         = OAuth2::AccessToken.new(@client, @access_token, {
+          :refresh_token => @refresh_token
+        }).refresh!
+
+        @access_token  = @token.token
+        @expires_at    = @token.expires_at
+        @refresh_token = @token.refresh_token
+        @token
+      end
+
+      def headers
+        {
+          'Accept'            => 'application/json',
+          'Content-Type'      => 'application/json'
+        }
+      end
+
+      def connection
+        @auth_connection ||= OAuth2::AccessToken.new(@client, @access_token)
+      end
+
+      def enpoints
+        url = "#{@site_url}/entity"
+        response = connection.get(url, { headers: headers })
+        JSON.parse(response.body)
+      end
+
+      private
+    end
+  end
+end

data/lib/myob_advanced/api/helpers.rb

@@ -0,0 +1,36 @@
+module MyobAdvanced
+  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
+
+        unless instance_variable_defined?(variable_name)
+          instance_variable_set(variable_name, MyobAdvanced::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

data/lib/myob_advanced/api/models/account.rb

@@ -0,0 +1,11 @@
+module MyobAdvanced
+    module Api
+      module Model
+        class Account < Base
+          def model_route
+            'Account'
+          end
+        end
+      end
+    end
+  end

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

@@ -0,0 +1,160 @@
+module MyobAdvanced
+  module Api
+    module Model
+      class Base
+        QUERY_OPTIONS = [:top, :skip, :filter, :expand, :select, :custom]
+
+        def initialize(client, model_name)
+          @client          = client
+          @api_url         = client.default_api_url
+          @model_name      = model_name || 'Base'
+        end
+
+        def model_route
+          @model_name.to_s
+        end
+
+        def all(options = {})
+          perform_request(self.url(nil, options[:params]), options)
+        end
+        alias_method :get, :all
+
+        def find(id, options = {})
+          object = { 'ID' => id }
+          perform_request(self.url(object, options[:params]), options)
+        end
+
+        def find_by_path(sub_path, options = {})
+          object = { 'sub_path' => sub_path }
+          perform_request(self.url(object, options[:params]), options)
+        end
+        
+        def first(options = {})
+          all(options).first
+        end
+
+        def destroy(id)
+          object = { 'ID' => id }
+          @client.connection.delete(self.url(object), :headers => @client.headers)
+        end
+
+        def destroy_by_path(sub_path)
+          object = { 'sub_path' => sub_path }
+          @client.connection.delete(self.url(object), :headers => @client.headers)
+        end
+
+        def exec_action(action, options = {})
+          options[:method] = 'post'
+          object = { 'sub_path' => action }
+          perform_request(self.url(object, options[:params]), options)
+        end
+
+        def put_attach(options = {})
+          options[:method] = 'put'
+          object = nil
+          object = { 'sub_path' => options[:sub_path] } if options[:sub_path]
+          perform_request(self.url(object, options[:params]), options)
+        end
+
+        def get_attach(options = {})
+          object = nil
+          object = { 'sub_path' => options[:sub_path] } if options[:sub_path]
+          perform_request(self.url(object, options[:params]), options)
+        end
+
+        def create(object, options = {})
+          object = typecast(object)
+          request_options = { body: object, method: 'put' }
+          perform_request(self.url(nil, options[:params]), request_options)
+        end
+
+        def update(object, options = {})
+          object = typecast(object)
+          request_options = { body: object, method: 'put' }
+          perform_request(self.url(nil, options[:params]), request_options)
+        end
+
+        def url(object = nil, params = nil)
+          @model_route ||= model_route
+          url =  @api_url
+
+          if @model_route.present?
+            sub_path = nil
+            sub_path = "/#{object['ID']}" if object && object['ID']
+            sub_path = "/#{object['sub_path']}" if object && object['sub_path']
+            # Init url
+            url = "#{@api_url}/#{@model_route}#{sub_path}"
+          end
+
+          if params.is_a?(Hash)
+            query = query_string(params)
+            url += "?#{query}" if !query.nil? && query.length > 0
+          end
+
+          url
+        end
+
+        private
+
+        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 date_formatter
+          "%Y-%m-%dT%H:%M:%S"
+        end
+        
+        def resource_url
+          "#{@api_url}/#{self.model_route}"
+        end
+        
+        def perform_request(url, options = {})
+          request_options = { headers: @client.headers }
+          request_options[:body] = options[:body].to_json if options[:body]
+          method = options[:method] || 'get'
+          parse_response(@client.connection.send(method, url, request_options))
+        end
+
+        def query_string(params)
+          params.map do |key, value|
+            if QUERY_OPTIONS.include?(key)
+              value = build_filter(value) if key == :filter
+              key = "$#{key}"
+            end
+
+            "#{key}=#{CGI.escape(value.to_s)}"
+          end.join('&')
+        end
+
+        def build_filter(value)
+          return value unless value.is_a?(Hash)
+
+          temp = "\\\\'"
+          value.map { |key, value| "#{key} eq '#{value.to_s.gsub("'", temp)}'" }.join(' and ')
+        end
+
+        def parse_response(response)
+          return response.body unless response.body.present?
+
+          JSON.parse(response.body) rescue {}
+        end
+
+        def process_query(data, query)
+          query.each do |property, value|
+            data.select! {|x| x[property] == value}
+          end
+
+          data
+        end
+      end
+    end
+  end
+end

data/lib/myob_advanced/api/models/bill.rb

@@ -0,0 +1,11 @@
+module MyobAdvanced
+    module Api
+      module Model
+        class Bill < Base
+          def model_route
+            'Bill'
+          end
+        end
+      end
+    end
+  end

data/lib/myob_advanced/api/models/check.rb

@@ -0,0 +1,11 @@
+module MyobAdvanced
+    module Api
+      module Model
+        class Check < Base
+          def model_route
+            'Check'
+          end
+        end
+      end
+    end
+  end

data/lib/myob_advanced/api/models/contact.rb

@@ -0,0 +1,11 @@
+module MyobAdvanced
+    module Api
+      module Model
+        class Contact < Base
+          def model_route
+            'Contact'
+          end
+        end
+      end
+    end
+  end

data/lib/myob_advanced/api/models/custom.rb

@@ -0,0 +1,12 @@
+module MyobAdvanced
+    module Api
+      module Model
+        # This model will be used to get data from custom enpoint
+        class Custom < Base
+          def model_route
+            ''
+          end
+        end
+      end
+    end
+  end

data/lib/myob_advanced/api/models/customer.rb

@@ -0,0 +1,11 @@
+module MyobAdvanced
+    module Api
+      module Model
+        class Customer < Base
+          def model_route
+            'Customer'
+          end
+        end
+      end
+    end
+  end

data/lib/myob_advanced/api/models/customer_class.rb

@@ -0,0 +1,11 @@
+module MyobAdvanced
+    module Api
+      module Model
+        class CustomerClass < Base
+          def model_route
+            'CustomerClass'
+          end
+        end
+      end
+    end
+  end

data/lib/myob_advanced/api/models/customer_payment_method.rb

@@ -0,0 +1,11 @@
+module MyobAdvanced
+    module Api
+      module Model
+        class CustomerPaymentMethod < Base
+          def model_route
+            'CustomerPaymentMethod'
+          end
+        end
+      end
+    end
+  end

data/lib/myob_advanced/api/models/invoice.rb

@@ -0,0 +1,11 @@
+module MyobAdvanced
+  module Api
+    module Model
+      class Invoice < Base
+        def model_route
+          'Invoice'
+        end
+      end
+    end
+  end
+end

data/lib/myob_advanced/api/models/payment.rb

@@ -0,0 +1,11 @@
+module MyobAdvanced
+    module Api
+      module Model
+        class Payment < Base
+          def model_route
+            'Payment'
+          end
+        end
+      end
+    end
+  end

data/lib/myob_advanced/api/models/payment_method.rb

@@ -0,0 +1,11 @@
+module MyobAdvanced
+    module Api
+      module Model
+        class PaymentMethod < Base
+          def model_route
+            'PaymentMethod'
+          end
+        end
+      end
+    end
+  end

data/lib/myob_advanced/api/models/sales_invoice.rb

@@ -0,0 +1,11 @@
+module MyobAdvanced
+    module Api
+      module Model
+        class SalesInvoice < Base
+          def model_route
+            'SalesInvoice'
+          end
+        end
+      end
+    end
+  end

data/lib/myob_advanced/api/models/vendor.rb

@@ -0,0 +1,11 @@
+module MyobAdvanced
+    module Api
+      module Model
+        class Vendor < Base
+          def model_route
+            'Vendor'
+          end
+        end
+      end
+    end
+  end

data/lib/myob_advanced/api/models/vendor_class.rb

@@ -0,0 +1,11 @@
+module MyobAdvanced
+    module Api
+      module Model
+        class VendorClass < Base
+          def model_route
+            'VendorClass'
+          end
+        end
+      end
+    end
+  end

data/lib/myob_advanced/api/version.rb

@@ -0,0 +1,5 @@
+module MyobAdvanced
+  module Api
+    VERSION = "1.0.0"
+  end
+end

data/myob-advanced-api.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'myob_advanced/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "myob-advanced-api"
+  spec.version       = MyobAdvanced::Api::VERSION
+  spec.authors       = ["Van Nguyen"]
+  spec.email         = ["bichvannguyenvnn@gmail.com"]
+  spec.description   = %q{MYOB Advanced API}
+  spec.summary       = %q{MYOB Advanced API}
+  spec.homepage      = "https://github.com/vannguyenvietnam/myob-advanced-api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "oauth2", "~> 1.4"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: myob-advanced-api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Van Nguyen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: MYOB Advanced API
+email:
+- bichvannguyenvnn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rbenv-gemsets"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/myob-advanced-api.rb
+- lib/myob_advanced/api/client.rb
+- lib/myob_advanced/api/helpers.rb
+- lib/myob_advanced/api/models/account.rb
+- lib/myob_advanced/api/models/base.rb
+- lib/myob_advanced/api/models/bill.rb
+- lib/myob_advanced/api/models/check.rb
+- lib/myob_advanced/api/models/contact.rb
+- lib/myob_advanced/api/models/custom.rb
+- lib/myob_advanced/api/models/customer.rb
+- lib/myob_advanced/api/models/customer_class.rb
+- lib/myob_advanced/api/models/customer_payment_method.rb
+- lib/myob_advanced/api/models/invoice.rb
+- lib/myob_advanced/api/models/payment.rb
+- lib/myob_advanced/api/models/payment_method.rb
+- lib/myob_advanced/api/models/sales_invoice.rb
+- lib/myob_advanced/api/models/vendor.rb
+- lib/myob_advanced/api/models/vendor_class.rb
+- lib/myob_advanced/api/version.rb
+- myob-advanced-api.gemspec
+homepage: https://github.com/vannguyenvietnam/myob-advanced-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: MYOB Advanced API
+test_files: []