myob-api 0.0.4 → 0.0.5

data/README.md

@@ -18,6 +18,33 @@ Or install it yourself as:
 
 ## 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:
+
+  class MYOBSessionController  
+    def new
+      redirect_to myob_client.get_access_code_url
+    end
+
+    def create
+      @token         = myob_client.get_access_token(params[:code])
+      @company_files = myob_client.company_file.all
+      # then show the user a view where they can log in to their company file
+    end
+
+    def myob_client
+      @api_client = Myob::Api::Client.new({
+        :consumer => {
+          :key    => YOUR_CONSUMER_KEY,
+          :secret => YOUR_CONSUMER_SECRET,
+        },
+      })
+    end
+  end
+
 ### API Client Setup
 
 Create an api_client:
@@ -30,6 +57,17 @@ Create an api_client:
       :access_token => YOUR_OAUTH_ACCESS_TOKEN,
     })
 
+If you have a refresh token (the Myob API returns one by default) you can use that too:
+
+    api_client = Myob::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 Company File you want to access too:
 
     api_client = Myob::Api::Client.new({
@@ -37,8 +75,9 @@ Or if you know which Company File you want to access too:
         :key    => YOUR_CONSUMER_KEY,
         :secret => YOUR_CONSUMER_SECRET,
       },
-      :access_token => YOUR_OAUTH_ACCESS_TOKEN,
-      :company_file => {
+      :access_token  => YOUR_OAUTH_ACCESS_TOKEN,
+      :refresh_token => YOUR_OAUTH_REFRESH_TOKEN,
+      :company_file  => {
         :name     => COMPANY_FILE_NAME,
         :username => COMPANY_FILE_USERNAME,
         :password => COMPANY_FILE_PASSWORD,
@@ -75,6 +114,12 @@ Return a list of all customers (a subset of contacts)
 
     api_client.customer.all
 
+#### Employees
+
+Return a list of all customers (a subset of contacts)
+
+    api_client.employee.all
+
 
 ## Todo
 

data/lib/myob/api.rb

@@ -6,5 +6,6 @@ require 'myob/api/models/base'
 require 'myob/api/models/company_file'
 require 'myob/api/models/contact'
 require 'myob/api/models/customer'
+require 'myob/api/models/employee'
 
 require 'myob/api/client'

data/lib/myob/api/client.rb

@@ -12,11 +12,13 @@ module Myob
         model :CompanyFile
         model :Contact
         model :Customer
+        model :Employee
 
+        @redirect_uri         = options[:redirect_uri]
         @consumer             = options[:consumer]
         @access_token         = options[:access_token]
         @refresh_token        = options[:refresh_token]
-        @current_company_file = {}
+        @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',
@@ -28,6 +30,18 @@ module Myob
         end
       end
 
+      def get_access_code_url(params = {})
+        @client.auth_code.authorize_url(params.merge(scope: 'CompanyFile', 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],

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

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

data/lib/myob/api/version.rb

@@ -1,5 +1,5 @@
 module Myob
   module Api
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: myob-api
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-14 00:00:00.000000000 Z
+date: 2013-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2
@@ -78,6 +78,7 @@ files:
 - lib/myob/api/models/company_file.rb
 - lib/myob/api/models/contact.rb
 - lib/myob/api/models/customer.rb
+- lib/myob/api/models/employee.rb
 - lib/myob/api/version.rb
 - myob-api.gemspec
 homepage: https://github.com/davidlumley/myob-api
@@ -95,7 +96,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4098228060394924892
+      hash: 593053203672766037
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -104,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4098228060394924892
+      hash: 593053203672766037
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23