myob-api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b370acb331a1b9161cedebced417265b558b137b
-  data.tar.gz: 6fb248ba9b4fcc05087079bd30065519cd22c5c4
+  metadata.gz: df2831ae79d4a7fe595b41d880ae810a3056661e
+  data.tar.gz: a2f14d8e44951ef9299b967eb326d82658a92e23
 SHA512:
-  metadata.gz: 7a3a9cd31720a5c71e803c9b576c51c75a042f8aa9525f3b87eeeb6d1222b0e7aec4077f8fd648cce61e26d8be2d608b9620cd8488c0335a62de30e1a5e3d971
-  data.tar.gz: 338e562661aa6fe09b8f8266d3ef145c331dbd17b7fb2bdc8b0437452446d61a793b49538a82eb7206ea957a11b01bc63f29b8cfdc3a2d9c673fcc8c5c9afe3d
+  metadata.gz: 24bf1a9394ab64e65d8b261d2469af77a97dcdc9648dfe9b38a83e7caa68d053a2eeefc9e5d2751d1263e6c625e7084cbf838d991f287db81fb429a6bb64e896
+  data.tar.gz: f0ed4e36b247ecebf5abdddcfd02d69f70683aa35a3e50002c8c05f94683cbb1216db2b5d1621014e07240b88cdff1d78322d2b0cd78bc8bb8db316cd5695032

data/README.md

@@ -86,11 +86,11 @@ Or if you know which Company File you want to access too:
 
 ### 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
+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.
+
+Return a list of company files:
 
     api_client.company_file.all
 
@@ -120,6 +120,20 @@ Return a list of all employees
 
     api_client.employee.all
 
+#### 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.
+
+    api_client.employee.save({'FirstName' => 'John', 'LastName' => 'Smith', 'IsIndividual' => true})
+
+#### Updating an entity
+
+To update an existing entity, call #save on its model, passing through a hash you got from the API. This hash should include a `UID` parameter (which is included by default when you get the data).
+  
+    user = api_client.employee.all["Items"].last
+    user['FirstName'] = 'New First Name'
+    api_client.employee.save(user)
+
 
 ## Todo
 

data/lib/myob/api/client.rb

@@ -54,6 +54,7 @@ module Myob
           'x-myobapi-key'     => @consumer[:key],
           'x-myobapi-version' => 'v2',
           'x-myobapi-cftoken' => @current_company_file[:token] || '',
+          'Content-Type'      => 'application/json'
         }
       end
 

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

@@ -32,15 +32,50 @@ module Myob
           model_data[0] if model_data.length > 0
         end
 
-        def url
+        def save(object)
+          new_record?(object) ? create(object) : update(object)
+        end
+
+        def url(object = nil)
           if self.model_route == ''
             "#{API_URL}"
           else
-            "#{API_URL}#{@client.current_company_file[:id]}/#{self.model_route}"
+            "#{API_URL}#{@client.current_company_file[:id]}/#{self.model_route}#{"/#{object['UID']}" if object && object['UID']}"
           end
         end
 
+        def new_record?(object)
+          object["UID"].nil? || object["UID"] == ""
+        end
+
         private
+        def create(object)
+          object = typecast(object)
+          response = @client.connection.post(self.url, {:headers => @client.headers, :body => object.to_json})
+          response.status == 201
+        end
+
+        def update(object)
+          object = typecast(object)
+          response = @client.connection.put(self.url(object), {:headers => @client.headers, :body => object.to_json})
+          response.status == 200
+        end
+
+        def typecast(object)
+          returned_object = object.dup # don't change the original object
+
+          returned_object.each do |key, value|
+            if value.respond_to?(:strftime)
+              returned_object[key] = value.strftime(date_formatter)
+            end
+          end
+
+          returned_object
+        end
+
+        def date_formatter
+          "%Y-%m-%dT%H:%M:%S"
+        end
 
         def parse_response(response)
           JSON.parse(response.body)
@@ -48,7 +83,7 @@ module Myob
 
         def process_query(data, query)
           query.each do |property, value|
-            data.select!{|x| x[property] == value}
+            data.select! {|x| x[property] == value}
           end
           data
         end

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

@@ -5,6 +5,22 @@ module Myob
         def model_route
           'Payroll/Timesheet'
         end
+
+        # http://developer.myob.com/api/accountright/v2/payroll/timesheet/
+        # we always want to PUT timesheets, so they are never a "new" record
+        def new_record?(object)
+          false
+        end
+
+        # 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)
+          if object
+            "#{super()}/#{object['Employee']['UID']}?StartDate=#{object['StartDate']}&EndDate=#{object['EndDate']}"
+          else
+            super
+          end
+        end
       end
     end
   end

data/lib/myob/api/version.rb

@@ -1,5 +1,5 @@
 module Myob
   module Api
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: myob-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - David Lumley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-26 00:00:00.000000000 Z
+date: 2014-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2