myob-api 0.0.1

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 David Lumley
+
+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,92 @@
+# MYOB Api
+
+[MYOB Api](https://github.com/davidlumley/myob-api) is an interface for accessing [MYOB](http://developer.myob.com/api/accountright/v2/)'s  AccountRight Live API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'myob-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install myob-api
+
+## Usage
+
+### API Client Setup
+
+Create an api_client:
+
+    api_client = Myob::Api::Client.new({
+      :consumer => {
+        :key    => YOUR_CONSUMER_KEY,
+        :secret => YOUR_CONSUMER_SECRET,
+      },
+      :access_token => YOUR_OAUTH_ACCESS_TOKEN,
+    })
+
+Or if you know which Company File you want to access too:
+
+  api_client = Myob::Api::Client.new({
+      :consumer => {
+        :key    => YOUR_CONSUMER_KEY,
+        :secret => YOUR_CONSUMER_SECRET,
+      },
+      :access_token => YOUR_OAUTH_ACCESS_TOKEN,
+      :company_file => {
+        :id       => COMPANY_FILE_ID,
+        :username => COMPANY_FILE_USERNAME,
+        :password => COMPANY_FILE_PASSWORD,
+      },
+    })
+
+### API Methods
+
+Before using the majority of API methods you will need to have selected a Company File. If you've already selected one when creating the client, feel free to ignore this.
+
+#### Company Files
+
+Return a list of company files
+
+    api_client.company_file.all
+
+Select a company file to work with
+
+    api_client.select_company_file({
+      :id       => COMPANY_FILE_ID,
+      :username => COMPANY_FILE_USERNAME,
+      :password => COMPANY_FILE_PASSWORD,
+    })
+
+####  Contacts
+
+Return a list of all contacts
+
+    api_client.contact.all
+
+#### Customers
+
+Return a list of all customers (a subset of contacts)
+
+    api_client.customer.all
+
+
+## Todo
+
+* Expand API methods
+* Refactor client factory architecture
+* Tests
+
+
+## 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/api.rb

@@ -0,0 +1,10 @@
+require 'myob/api/version'
+
+require 'myob/api/helpers'
+
+require 'myob/api/models/base'
+require 'myob/api/models/company_file'
+require 'myob/api/models/contact'
+require 'myob/api/models/customer'
+
+require 'myob/api/client'

data/lib/myob/api/client.rb

@@ -0,0 +1,45 @@
+require 'Base64'
+
+module Myob
+  module Api
+    class Client
+      include Myob::Api::Helpers
+
+      attr_reader :current_company_file
+
+      def initialize(options)
+        model :CompanyFile
+        model :Contact
+        model :Customer
+
+        @consumer     = options[:consumer]
+        @access_token = options[:access_token]
+        if options[:company_file]
+          @current_company_file = select_company_file(options[:company_file])
+        else
+          @current_company_file = {}
+        end
+        @client       = OAuth2::Client.new(@consumer[:key], @consumer[:secret])
+      end
+
+      def headers
+        {
+          'x-myobapi-key'     => @consumer[:key],
+          'x-myobapi-version' => 'v2',
+          'x-myobapi-cftoken' => @current_company_file[:token] || '',
+        }
+      end
+
+      def select_company_file(company_file)
+        @current_company_file = {
+          :id    => company_file[:id],
+          :token => Base64.encode64("#{company_file[:username]}:#{company_file[:password]}"),
+        }
+      end
+
+      def connection
+        @auth_connection ||= OAuth2::AccessToken.new(@client, @access_token)
+      end
+    end
+  end
+end

data/lib/myob/api/helpers.rb

@@ -0,0 +1,26 @@
+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 Helpers
+      def model(model_name)
+        variable_name = "@#{model_name.to_s.underscore}_model".to_sym
+        unless instance_variable_defined?(variable_name)
+          instance_variable_set(variable_name, Myob::Api::Model.const_get("#{model_name}".to_sym).new(self, model_name.to_s))
+          self.define_singleton_method("#{model_name.to_s.underscore}".to_sym) do
+            instance_variable_get(variable_name)
+          end
+        end
+        instance_variable_get(variable_name)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module Myob
+  module Api
+    module Model
+      class Base
+
+        API_URL = 'https://api.myob.com/accountright/'
+
+        def initialize(client, model_name)
+          @client     = client
+          @model_name = model_name || 'Base'
+        end
+
+        def model_route
+          @model_name.to_s
+        end
+
+        def all
+          parse_response(@client.connection.get(self.url, {:headers => @client.headers}))
+        end
+
+        def url
+          if self.model_route == ''
+            "#{API_URL}"
+          else
+            "#{API_URL}#{@client.current_company_file[:id]}/#{self.model_route}"
+          end
+        end
+
+        private
+
+        def parse_response(response)
+          JSON.parse(response.body)
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Myob
+  module Api
+    module Model
+      class CompanyFile < Myob::Api::Model::Base
+        def model_route
+          ''
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module Myob
+  module Api
+    module Model
+      class Contact < Myob::Api::Model::Base
+      end
+    end
+  end
+end

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

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

data/lib/myob/api/version.rb

@@ -0,0 +1,5 @@
+module Myob
+  module Api
+    VERSION = "0.0.1"
+  end
+end

data/myob-api.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'myob/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "myob-api"
+  spec.version       = Myob::Api::VERSION
+  spec.authors       = ["David Lumley"]
+  spec.email         = ["david@davidlumley.com.au"]
+  spec.description   = %q{MYOB AccountRight Live API V2}
+  spec.summary       = %q{MYOB AccountRight Live API V2}
+  spec.homepage      = "https://github.com/davidlumley/myob-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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: myob-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Lumley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: MYOB AccountRight Live API V2
+email:
+- david@davidlumley.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/myob/api.rb
+- lib/myob/api/client.rb
+- lib/myob/api/helpers.rb
+- lib/myob/api/models/base.rb
+- lib/myob/api/models/company_file.rb
+- lib/myob/api/models/contact.rb
+- lib/myob/api/models/customer.rb
+- lib/myob/api/version.rb
+- myob-api.gemspec
+homepage: https://github.com/davidlumley/myob-api
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 601466071620978750
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 601466071620978750
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: MYOB AccountRight Live API V2
+test_files: []