myob-api 0.6 → 0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0589b034162107e25124c705d7d3c56f583333c6
-  data.tar.gz: cb6242b832c5c83c7cbce02046dbb22d266c52ba
+  metadata.gz: cff71416241b80eabc277970013de629ce7d7aee
+  data.tar.gz: d6cf941b41a1b49b7451b9a937f5ed5e37d44f2d
 SHA512:
-  metadata.gz: ed42a4380bea398bcfb01699f5e3fb2cfabd76edd8b0a4a8daed59177e3e6d9dc0c101d5a67cefd9ff8c20a875b80119cb5b3be87e0d91039c6e38338160e974
-  data.tar.gz: 3c8ed3b9c3e079a664c462d83fdfbf27e39d5ef1158d91b4e6fc4ceee70e3867d5af0069bd7fe5fdd645a6741d3b346d1f4c150cc4785427e020441be0f58650
+  metadata.gz: 899b86fd32a9205f323bdbba03981018e9d235a2005be16dde0ed611b8bce49db34d8b01ed475b5c719250e83eac249b6086679458adfcea4b5271d89a2f0bde
+  data.tar.gz: cca7bce1c7195aa774f089fd8672458ff8c044c5e0d9a6f3afc133e9b6e3918de7680a36f5db740624d960dc311c4078d72c536de8d80c09b358de1ffb4be795

data/README.md

@@ -135,7 +135,15 @@ Basic pagination based on `NextPageLink` parameter returned via [API](http://dev
 
 You can also get an array of all items (which may make several API calls in the background):
 
-    api_client.contact.all_items # note this returns an array, *not* a hash the way `api_client.contact.all` does
+    api_client.contact.all_items # note this returns an array, *not* a hash the way `api_client.contact.all` does - use it if you only need data, without metadata
+
+#### Filtering
+
+You can use oData filters:
+
+    api_client.employee.all(filter: "IsActive eq true")
+
+See http://www.odata.org/documentation/odata-version-2-0/uri-conventions/ and http://developer.myob.com/api/accountright/api-overview/retrieving-data/ for information on oData filtering.
 
 #### Fetching one entity
 

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

@@ -4,6 +4,7 @@ module Myob
       class Base
 
         API_URL = 'https://api.myob.com/accountright/'
+        QUERY_OPTIONS = [:orderby, :top, :skip, :filter]
 
         def initialize(client, model_name)
           @client          = client
@@ -15,38 +16,39 @@ module Myob
           @model_name.to_s
         end
 
-        def all(query = nil)
-          perform_request(self.url, query)
+        def all(params = nil)
+          perform_request(self.url(nil, params))
+        end
+        alias_method :get, :all
+
+        def records(params = nil)
+          response = all(params)
+          response.is_a?(Hash) && response.key?('Items') ? response['Items'] : response
         end
         
         def next_page?
           !!@next_page_link
         end
         
-        def next_page(query = nil)
-          perform_request(@next_page_link, query)
+        def next_page(params = nil)
+          perform_request(@next_page_link, params)
         end
 
-        def all_items(query = nil)
-          results = all(query)["Items"]
+        def all_items(params = nil)
+          results = all(params)["Items"]
           while next_page?
-            results += next_page(query)["Items"] || []
+            results += next_page(params)["Items"] || []
           end
           results
         end
-
-        def get(query = nil)
-          all(query)
-        end
         
         def find(id)
           object = { 'UID' => id }
           perform_request(self.url(object))
         end
         
-        def first(query = nil)
-          model_data = self.all(query)
-          model_data[0] if model_data.length > 0
+        def first(params = nil)
+          all(params).first
         end
 
         def save(object)
@@ -57,14 +59,19 @@ module Myob
           @client.connection.delete(self.url(object), :headers => @client.headers)
         end
 
-        def url(object = nil)
-          if self.model_route == ''
+        def url(object = nil, params = nil)
+          url = if self.model_route == ''
             "#{API_URL}"
-          elsif object && object['UID']
-            "#{resource_url}/#{object['UID']}"
           else
-            resource_url
+            "#{API_URL}#{@client.current_company_file[:id]}/#{self.model_route}#{"/#{object['UID']}" if object && object['UID']}"
           end
+
+          if params.is_a?(Hash)
+            query = query_string(params)
+            url += "?#{query}" if !query.nil? && query.length > 0
+          end
+
+          url
         end
 
         def new_record?(object)
@@ -102,15 +109,27 @@ module Myob
           "#{API_URL}#{@client.current_company_file[:id]}/#{self.model_route}"
         end
         
-        def perform_request(url, query = nil)
+        def perform_request(url)
           model_data = parse_response(@client.connection.get(url, {:headers => @client.headers}))
           @next_page_link = model_data['NextPageLink'] if self.model_route != ''
-          
-          if query
-            process_query(model_data, query)
-          else
-            model_data
-          end
+          model_data
+        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)
+
+          value.map { |key, value| "#{key} eq '#{value.to_s.gsub("'", %q(\\\'))}'" }.join(' and ')
         end
 
         def parse_response(response)

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

@@ -14,7 +14,7 @@ module Myob
 
         # a timesheet is identified based on an employee UID as well as its start and end date
         # it does not have a UID of its own
-        def url(object = nil)
+        def url(object = nil, params = nil)
           if object
             "#{super()}/#{object['Employee']['UID']}?StartDate=#{object['StartDate']}&EndDate=#{object['EndDate']}"
           else

data/lib/myob/api/version.rb

@@ -1,5 +1,5 @@
 module Myob
   module Api
-    VERSION = "0.6"
+    VERSION = "0.7"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: myob-api
 version: !ruby/object:Gem::Version
-  version: '0.6'
+  version: '0.7'
 platform: ruby
 authors:
 - David Lumley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-04 00:00:00.000000000 Z
+date: 2015-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2