pe_accounting 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cde00eb1f7da6b0b3273b8b44988b292a68e96ff
-  data.tar.gz: 6d63ce0048c516e31b6f2faa0040c0b07f5ba215
+  metadata.gz: 9e00ed4390664edd42dc6632f828685e513e9aa3
+  data.tar.gz: 5f2178a5bf64abe498c1c3f4e672c7fa5404f156
 SHA512:
-  metadata.gz: afd51489f1f8dc8b6fee09036985af1412faa0acb205c47e24b3483e3d27a01263d6080582a1eeba215cbe743f1f61eab7507b5f248b10f594c4619f7a3e5ac6
-  data.tar.gz: b7554759568b140c0ff0c142d6a9ba5a1d0278b1d91aa38ad74aeaee7206a9e87443d3b9769b5c5a005e3a188b4c43e81ea89de5f6d3a186a04d0832c0c19758
+  metadata.gz: 4644a4ac41f9f839b59e55624305275b7f53e7b418df4effa836faa536e34aaaf7d44c0e40bbb2390bd05d02756473f40b7b1d589a351320901eb45a30724f33
+  data.tar.gz: b8a94ea6b35f72d51c2768ffa5cc45bbb76988952c0dc87f8046358cb1692c967fafc06d874d0e1d7cca6e66d6d56085917b2f55a09d777f88d009ab1918383d

data/README.md

@@ -1,6 +1,10 @@
-# PeAccounting::Client
+# PE Accounting Ruby Client
+
+[![Gem](https://img.shields.io/gem/v/pe_accounting.svg?style=flat-square)](https://rubygems.org/gems/pe_accounting)
 
 A simple low-level wrapper for PE Accounting's public API.
+It's publicly available at https://my.accounting.pe/api/v1/doc
+ 
 
 
 ## Installation
@@ -21,7 +25,31 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require 'pe_accounting'
+
+# Initialize the API
+api = PeAccounting::Client.new('your-api-token')
+
+# Fetch a list of all the given company's clients. Returns a ruby Array or Hash, depending on the ressource's specifications
+clients = api.get(company_id: 123, request: 'client')
+
+puts clients
+
+##
+# [
+# {"id"=>12345, "foreign-id"=>"", "name"=>"fdsmfkls", "contact"=>"fslmdkfsdmlkf", "address"=>{"address1"=>"sdfmsdlmfksdm", "address2"=>"", "zip-code"=>"12345", "state"=>"msdlfkdsmlk", "country"=>"sdflkdslkfj"}, "email"=>"sdflkjsfs@fdsd.fr", "country-code"=>"FR", "accountnr"=>0, "payment-days"=>14, "orgno"=>"123456-1234", "phone"=>"+33123456789", "user"=>{"id"=>12345}, "delivery-type"=>"Email", "vat-nr"=>"", "template"=>{"id"=>1234}, "active"=>true},
+# {"id"=>9876, "foreign-id"=>"", "name"=>"fdsmfkls", "contact"=>"fslmdkfsdmlkf", "address"=>{"address1"=>"sdfmsdlmfksdm", "address2"=>"", "zip-code"=>"12345", "state"=>"msdlfkdsmlk", "country"=>"sdflkdslkfj"}, "email"=>"sdflkjsfs@fdsd.fr", "country-code"=>"FR", "accountnr"=>0, "payment-days"=>14, "orgno"=>"123456-1235", "phone"=>"+33123456789", "user"=>{"id"=>9875}, "delivery-type"=>"Email", "vat-nr"=>"", "template"=>{"id"=>1234}, "active"=>true}
+# ]
+
+john = clients.first
+john["name"] = "John Doe"
+
+## Updates a client with the new name
+api.post(company_id: 123, request: "client/#{john["id"]}", payload: john)
+
+```
+Accepted methods: `get`, `put`, `post`, `delete`. Only `put` and `post` accept a payload.
 
 ## Development
 

data/lib/pe_accounting/client.rb

@@ -1,15 +1,30 @@
 require 'rest-client'
 require 'multi_json'
+require 'gyoku'
+require 'nori'
 
 module PeAccounting
   class PeAccouningError < StandardError; end
 
   class Client
-    def initialize(token, endpoint = 'https://my.accounting.pe/api/v1/')
+
+
+    # Initializes the API Client
+    #
+    # @param [String] token - API token
+    # @param [Symbol] format - :xml or :json - :xml by default
+    # @param [Type] endpoint = 'https://my.accounting.pe/api/v1/'. This shouldn't change
+    # @return [PeAccounting::Client] A PeAccounting::Client object
+    def initialize(token, format = :xml, endpoint = 'https://my.accounting.pe/api/v1/')
+      unless [:xml,:json].include?(format)
+        raise PeAccouningError, 'You must specify a Company ID and a request'
+      end
+      @format = format
       @token = token
       @endpoint = endpoint
     end
 
+
     def get(kwargs = {})
       unless kwargs[:company_id] && kwargs[:request]
         raise PeAccouningError, 'You must specify a Company ID and a request'
@@ -48,13 +63,32 @@ module PeAccounting
       "#{@endpoint}company/#{company_id}/#{path}"
     end
 
+    def generate_payload(payload)
+      if payload
+        if @format == xml
+          Gyoku.xml(payload)
+        else
+          MultiJson.dump(payload)
+        end
+      end
+    end
+
+    def handle_body(body)
+      if @format == :xml
+        parser = Nori.new
+        parser.parse(body)
+      else
+        hash = MultiJson.load(body)
+        hash.length == 1 ? hash.values.first : hash
+      end
+    end
+
     def request(method, url, payload = nil)
       res = RestClient::Request.execute(method: method, url: url,
-                                        payload: MultiJson.dump(payload),
-                                        headers: { content_type: :json,
+                                        payload: generate_payload(payload),
+                                        headers: { content_type: @format,
                                                    x_token: @token })
-      hash = MultiJson.load(res.body)
-      hash.length == 1 ? hash.values.first : hash
+      handle_body(res.body)
     end
 
     def file_to_json(file)

data/lib/pe_accounting/version.rb

@@ -1,3 +1,3 @@
 module PeAccounting
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/pe_accounting.gemspec

@@ -26,4 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_runtime_dependency 'multi_json', '~> 1.3', '>= 1.3.0'
   spec.add_runtime_dependency 'rest-client', '~> 2.0'
+  spec.add_runtime_dependency 'gyoku', '~> 1.0'
+  spec.add_runtime_dependency 'nori', '~> 2.0'
+  spec.add_runtime_dependency 'nokogiri', '>= 1.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pe_accounting
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mehdi Rejraji
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-31 00:00:00.000000000 Z
+date: 2017-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,6 +72,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: gyoku
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: nori
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
 description: 
 email: mehdi.rejraji@gmail.com
 executables: []