myob-api 0.3 → 0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ac11e5a23f2d2df24d84b7660709d67dfbf8933
-  data.tar.gz: e59ceb0ea7323fec46b0c10f3f1d5ba10e1373b0
+  metadata.gz: 8df0abcdeb32b2e03172cdd5ab88157f11d05885
+  data.tar.gz: 438f9ad29d1121dd988230b511bfe583fab71916
 SHA512:
-  metadata.gz: 5435894b9ce6f54f1aa3d033efb97753ae04816b5d408275f2685e8624989529d86e6bc08ecc2bb73f050c8b28db078cbc41be965bc55a3f38b8dcd64a332216
-  data.tar.gz: 2401af76812005926e9dcf7700d85ecee107aba06545d4ab4ec9dfde601aebd4225b8e67e873b07a20c8eb4ae360c4ad37d132fd8371f320edb0937498dc7c2c
+  metadata.gz: 50264fb983d752d308b22906dd8cb6687eb206a2e6851764cdbbb5c63c747c8d7f99548cd1cb02893f16f94b845ec674a8766ba58a3c4fdb376d00efee50f4bd
+  data.tar.gz: e8f920988346d2d0038b3462bdeabfd060a3d46c1f235d33e8c2a71fa61b664a75126d03504c16f830ddb26012b27b088223fa21f1d0f25147bade06bde16e11

data/README.md

@@ -126,6 +126,23 @@ Return a list of all invoices
 
     api_client.invoice.all
 
+#### Pagination
+
+Basic pagination based on `NextPageLink` parameter returned via [API](http://developer.myob.com/api/accountright/api-overview/retrieving-data/)
+
+    first_page = api_client.contact.all
+    second_page = api_client.contact.next_page if api_client.contact.next_page?
+
+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
+
+#### Fetching one entity
+
+Return an entity with given `UID`:
+
+    contact = api_client.contact.find(contact_uid)
+
 #### Creating an entity
 
 To create a new entity, call #save on its model, passing through a hash that represents the entity. Refer to the MYOB API documentation for required fields.

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

@@ -6,8 +6,9 @@ module Myob
         API_URL = 'https://api.myob.com/accountright/'
 
         def initialize(client, model_name)
-          @client     = client
-          @model_name = model_name || 'Base'
+          @client          = client
+          @model_name      = model_name || 'Base'
+          @next_page_link  = nil
         end
 
         def model_route
@@ -15,18 +16,34 @@ module Myob
         end
 
         def all(query = nil)
-          model_data = parse_response(@client.connection.get(self.url, {:headers => @client.headers}))
-          if query
-            return process_query(model_data, query)
-          else
-            return model_data
+          perform_request(self.url, query)
+        end
+        
+        def next_page?
+          !!@next_page_link
+        end
+        
+        def next_page(query = nil)
+          perform_request(@next_page_link, query)
+        end
+
+        def all_items(query = nil)
+          results = all(query)["Items"]
+          while next_page?
+            results += next_page(query)["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
@@ -43,8 +60,10 @@ module Myob
         def url(object = nil)
           if self.model_route == ''
             "#{API_URL}"
+          elsif object && object['UID']
+            "#{resource_url}/#{object['UID']}"
           else
-            "#{API_URL}#{@client.current_company_file[:id]}/#{self.model_route}#{"/#{object['UID']}" if object && object['UID']}"
+            resource_url
           end
         end
 
@@ -78,6 +97,21 @@ module Myob
         def date_formatter
           "%Y-%m-%dT%H:%M:%S"
         end
+        
+        def resource_url
+          "#{API_URL}#{@client.current_company_file[:id]}/#{self.model_route}"
+        end
+        
+        def perform_request(url, query = nil)
+          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
+        end
 
         def parse_response(response)
           JSON.parse(response.body)

data/lib/myob/api/version.rb

@@ -1,5 +1,5 @@
 module Myob
   module Api
-    VERSION = "0.3"
+    VERSION = "0.4"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: myob-api
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '0.4'
 platform: ruby
 authors:
 - David Lumley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-27 00:00:00.000000000 Z
+date: 2014-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2