myob-essentials-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11e3b86876568aa61bff577a0843a04ab3ef3595
+  data.tar.gz: d394f5559b06038a4a2d65cc9f965e529469e040
+SHA512:
+  metadata.gz: e7d96c886395485c5ae9abf13ab644a720834114f3eeb13219ba55942fcbe3ff74301f5e834f19d336363d51018686f2149a0a732450f5b2fff3b230ddfa03a6
+  data.tar.gz: 19e4075bc5bf100903a4d79d8a32f9814baf43311fa11e5448ed08fd9913e91d7b929f826a1434d9de6fc7bbf27c235abda4eb4863de87d56668411f2b63440d

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.0@myob-essentials-api

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+
+language: ruby
+
+cache: bundler
+
+rvm:
+  - 2.2.0
+  - 2.1.3
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem "oauth2"
+
+group :development do
+  gem "jeweler"
+  gem "simplecov"
+end
+
+group :test do
+  gem "rspec"
+  gem "webmock"
+  gem "timecop"
+end

data/Gemfile.lock

@@ -0,0 +1,86 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    builder (3.2.2)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.9.1)
+    github_api (0.12.2)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.3)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.3)
+      oauth2
+    hashie (3.3.2)
+    highline (1.6.21)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    jwt (1.2.1)
+    mini_portile (0.6.2)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    nokogiri (1.6.6.2-java)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.6.0)
+    rake (10.4.2)
+    rdoc (4.2.0)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    safe_yaml (1.0.4)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    thread_safe (0.3.4)
+    thread_safe (0.3.4-java)
+    timecop (0.7.1)
+    webmock (1.20.4)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  jeweler
+  oauth2
+  rspec
+  simplecov
+  timecop
+  webmock

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Bruno
+
+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,188 @@
+myob-essentials-api
+===============
+
+[![Build Status](https://secure.travis-ci.org/BrunoChauvet/myob-essentials-api.png?branch=master)](http://travis-ci.org/BrunoChauvet/myob-essentials-api)
+
+## MYOB Essentials Accounting
+
+Integrate with ![MYOB Essentials Accounting](http://developer.myob.com/api/essentials-accounting/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+`gem 'myob-essentials-api'`
+
+And then execute:
+
+`bundle`
+
+Or install it yourself as:
+
+`gem install myob-essentials-api`
+
+## Usage
+
+### OAuth Authentication
+
+If you've already got an OAuth access token, feel free to skip to API Client Setup.
+
+The MYOB API uses 3 legged OAuth2. If you don't want to roll your own, or use the [OmniAuth strategy](https://github.com/davidlumley/omniauth-myob) you can authenticate using the `get_access_code_url` and `get_access_token` methods that [ghiculescu](https://github.com/ghiculescu) has provided like so:
+
+
+``` ruby
+    class MYOBSessionController  
+      def new
+        redirect_to myob_client.get_access_code_url
+      end
+
+      def create
+        @token         = myob_client.get_access_token(params[:code])
+        @businesses    = myob_client.business.all_items
+        # then show the user a view of their available businesses
+      end
+
+      def myob_client
+        @api_client = Myob::Essentials::Api::Client.new({
+          consumer: {
+            key:    YOUR_CONSUMER_KEY,
+            secret: YOUR_CONSUMER_SECRET,
+          },
+          redirect_uri: callback_create_url
+        })
+      end
+    end
+```
+
+### API Client Setup
+
+#### Create an api_client
+
+``` ruby
+    api_client = Myob::Essentials::Api::Client.new({
+      consumer: {
+        key:    YOUR_CONSUMER_KEY,
+        secret: YOUR_CONSUMER_SECRET,
+      },
+      access_token: YOUR_OAUTH_ACCESS_TOKEN
+    })
+```
+
+If you have a refresh token (the Myob API returns one by default) you can use that too:
+
+``` ruby
+    api_client = Myob::Essentials::Api::Client.new({
+      consumer: {
+        key:    YOUR_CONSUMER_KEY,
+        secret: YOUR_CONSUMER_SECRET,
+      },
+      access_token:  YOUR_OAUTH_ACCESS_TOKEN,
+      refresh_token: YOUR_OAUTH_REFRESH_TOKEN
+    })
+```
+
+Or if you know which Business UID you want to access too:
+
+``` ruby
+    api_client = Myob::Essentials::Api::Client.new({
+      consumer: {
+        key:    YOUR_CONSUMER_KEY,
+        secret: YOUR_CONSUMER_SECRET,
+      },
+      access_token:  YOUR_OAUTH_ACCESS_TOKEN,
+      refresh_token: YOUR_OAUTH_REFRESH_TOKEN,
+      business_uid:  BUSINESS_UID
+    })
+```
+
+The available options when creating the MYOB Essentials API client are
+
+* redirect_uri: URI to redirect the user to after OAuth authentication
+* consumer: Hash containing your OAuth key and secret
+* access_token: Previously fetched access token
+* refresh_token: Previously fetched refresh token
+* business_uid: Previously selected business uid
+* auto_refresh: Automatically refresh the access_token if expired (default `true`)
+* endpoint: `au` or `nz` (default `au` for https://api.myob.com/au/essentials)
+
+#### Refresh access token
+
+The OAuth access token can be refreshed at any time by calling
+`client.refresh!`
+
+### API Methods
+
+#### get
+
+Retrieves the first page of specified collection
+
+```ruby
+  contacts = api_client.contact.get
+```
+
+#### next_page / previous_page
+
+Retrieves the next/previous page of specified collection. A call to `get` must have been performed first
+
+```ruby
+  contacts = api_client.contact.get
+  next_contacts = api_client.contact.next_page
+  previous_contacts = api_client.contact.previous_page
+```
+
+#### find
+
+Retrieves a single element by uid
+
+```ruby
+  contact = api_client.contact.find('123')
+```
+
+#### save
+
+Saves a resource. The resource is `created` if no `uid` is specified, otherwise it is `updated`
+
+```ruby
+  contact = api_client.contact.save({'uid' => '123', 'key' => 'value'})
+```
+
+#### all_items
+
+Fetches the entire collection of elements
+
+```ruby
+  contact = api_client.contact.all_items
+```
+
+### API Resources
+
+#### Businesses
+Before using the majority of API methods you will need to have selected a Business UID. If you've already selected one when creating the client, feel free to ignore this.
+```ruby
+  businesses = api_client.business.all_items
+  api_client.business_uid = businesses[0]['uid']
+```
+
+####  Account Classifications
+`api_client.account_classification.get`
+
+####  Account Types
+`api_client.account_type.get`
+
+####  Tax Types
+`api_client.tax_type.get`
+
+####  Contacts
+`api_client.contact.get`
+
+####  Accounts
+`api_client.account.get`
+
+####  Inventory Items
+`api_client.inventory_item.get`
+
+####  Sale Invoices
+`api_client.sale_invoice.get`
+
+####  Sale Payments
+`api_client.sale_payment.get`

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "myob-essentials-api"
+  gem.homepage = "http://github.com/BrunoChauvet/myob-essentials-api"
+  gem.license = "MIT"
+  gem.summary = %Q{Integrate with MYOB Essentials Accounting}
+  gem.description = %Q{Integrate with MYOB Essentials Accounting}
+  gem.email = "it@maestrano.com"
+  gem.authors = ["BrunoChauvet"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "myob-essentials-api #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/myob-essentials-api.rb

@@ -0,0 +1,13 @@
+require 'myob/essentials/api/helper.rb'
+require 'myob/essentials/api/client.rb'
+require 'myob/essentials/api/model/base.rb'
+require 'myob/essentials/api/model/business.rb'
+require 'myob/essentials/api/model/tax_type.rb'
+require 'myob/essentials/api/model/account_type.rb'
+require 'myob/essentials/api/model/account_classification.rb'
+require 'myob/essentials/api/model/contact.rb'
+require 'myob/essentials/api/model/inventory_item.rb'
+require 'myob/essentials/api/model/account.rb'
+require 'myob/essentials/api/model/account_balance.rb'
+require 'myob/essentials/api/model/sale_invoice.rb'
+require 'myob/essentials/api/model/sale_payment.rb'

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

@@ -0,0 +1,86 @@
+require 'base64'
+require 'oauth2'
+
+module Myob
+  module Essentials
+    module Api
+      class Client
+        include Myob::Essentials::Api::Helpers
+
+        attr_reader :client, :access_token, :refresh_token, :expires_at, :endpoint
+        attr_accessor :business_uid
+
+        def initialize(options)
+          model :Business
+          model :TaxType
+          model :AccountType
+          model :AccountClassification
+          model :Contact
+          model :InventoryItem
+          model :Account
+          model :AccountBalance
+          model :SaleInvoice
+          model :SalePayment
+          
+          @redirect_uri         = options[:redirect_uri]
+          @consumer             = options[:consumer]
+          @access_token         = options[:access_token]
+          @refresh_token        = options[:refresh_token]
+          @auto_refresh         = options[:auto_refresh] || true
+          @endpoint             = options[:endpoint] || 'au'
+          @business_uid         = options[:business_uid]
+          
+          @client               = OAuth2::Client.new(@consumer[:key], @consumer[:secret], {
+            :site          => 'https://secure.myob.com',
+            :authorize_url => '/oauth2/account/authorize',
+            :token_url     => '/oauth2/v1/authorize',
+          })
+        end
+
+        def get_access_code_url(params = {})
+          @client.auth_code.authorize_url(params.merge(scope: 'la.global', 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 headers
+          {
+            'x-myobapi-key'     => @consumer[:key],
+            'x-myobapi-version' => 'v0',
+            'Accept'            => 'application/json',
+            'Content-Type'      => 'application/json'
+          }
+        end
+
+        def refresh!
+          @auth_connection ||= OAuth2::AccessToken.new(@client, @access_token, {refresh_token: @refresh_token})
+
+          @token         = @auth_connection.refresh!
+          @access_token  = @token.token
+          @expires_at    = @token.expires_at
+          @refresh_token = @token.refresh_token
+          @token
+        end
+
+        def connection
+          @auth_connection ||= begin
+            if @refresh_token
+              OAuth2::AccessToken.new(@client, @access_token, {refresh_token: @refresh_token})
+            else
+              OAuth2::AccessToken.new(@client, @access_token)
+            end
+          end
+          refresh! if @auto_refresh && @expires_at && @expires_at < Time.now.to_i
+          @auth_connection
+        end
+
+      end
+    end
+  end
+end