pe_accounting 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e00ed4390664edd42dc6632f828685e513e9aa3
-  data.tar.gz: 5f2178a5bf64abe498c1c3f4e672c7fa5404f156
+  metadata.gz: 846d79de6e9ca386cd4a9b42099687a158865524
+  data.tar.gz: 7c78c8124ffdf7c3964538dacb6fe76d1c60a4c9
 SHA512:
-  metadata.gz: 4644a4ac41f9f839b59e55624305275b7f53e7b418df4effa836faa536e34aaaf7d44c0e40bbb2390bd05d02756473f40b7b1d589a351320901eb45a30724f33
-  data.tar.gz: b8a94ea6b35f72d51c2768ffa5cc45bbb76988952c0dc87f8046358cb1692c967fafc06d874d0e1d7cca6e66d6d56085917b2f55a09d777f88d009ab1918383d
+  metadata.gz: 3d2ad909081085b647d2f8b75bb0dd10359cd14efa900ede39c6a6d4b286616e80e3ff9ee0fa34a998410c6370b48c8aba524b66f8229323cc2fb473703abd51
+  data.tar.gz: aed1983fa8f54c2f19189e8dbafca3641246a4c81671cfb539ae84138003dbe659508ba33c698d59e2cf3821758541809a26e95f96d6988fc8fba5443f5d5ad2

data/README.md

@@ -4,7 +4,7 @@
 
 A simple low-level wrapper for PE Accounting's public API.
 It's publicly available at https://my.accounting.pe/api/v1/doc
- 
+
 
 
 ## Installation
@@ -28,25 +28,19 @@ Or install it yourself as:
 ```ruby
 require 'pe_accounting'
 
-# Initialize the API
-api = PeAccounting::Client.new('your-api-token')
+# Initialize the API, the 3rd parameter is one of (:json, :xml) and sets how the wrapper will interact with the API.
+>> api = PeAccounting::Client.new('your-api-token', 123)
+=> <PeAccounting::Client:0x007fd6b7ac74d0 @company_id=123, @format=:json, @token="your-api-token", @endpoint="https://my.accounting.pe/api/v1/">
 
 # 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}
-# ]
+>> clients = api.get('client')
+=> [ {"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)
+api.post("client/#{john['id']}", john)
 
 ```
 Accepted methods: `get`, `put`, `post`, `delete`. Only `put` and `post` accept a payload.

data/lib/pe_accounting/client.rb

@@ -1,98 +1,152 @@
-require 'rest-client'
 require 'multi_json'
 require 'gyoku'
 require 'nori'
+require 'uri'
+require 'net/http'
 
 module PeAccounting
   class PeAccouningError < StandardError; end
 
   class Client
 
-
-    # Initializes the API Client
+    # Initializes an 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
+    # @param token [String] The API token
+    # @param company_id [Integer] The company ID
+    # @param format [Symbol] The format by which the wrapper will interact with the API.
+    #   `:xml` or `:json - leave empty for :json by default
+    # @param endpoint [String] 'https://my.accounting.pe/api/v1/' by default. 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
+    #
+    # @example
+    #   api = PeAccounting::Client.new("your-api-token", 123)
+    def initialize(token, company_id, format = :json, endpoint = 'https://my.accounting.pe/api/v1/')
+      @company_id = company_id
       @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'
+    # Performs a GET request
+    #
+    # @param request [String] The endpoint to perform the request to, e.g. `client`
+    # @return [Hash, Array] A hash or an array, depending on the specs
+    #
+    # @example
+    #   api.get('client')
+    def get(request)
+      unless request
+        raise PeAccouningError, 'You must specify a request'
       end
 
-      request(:get, url(kwargs[:company_id], kwargs[:request]))
+      request(:get, uri(request))
     end
 
-    def put(kwargs = {})
-      unless kwargs[:company_id] && kwargs[:request] && kwargs[:payload]
-        raise PeAccouningError, 'You must specify a company_id, a request, and a payload'
+    # Performs a PUT request
+    #
+    # @param request [String] opts = {} The options to pass to the method
+    # @param payload [Hash] A native Ruby hash describing the data to send
+    # @param root [String] The enclosing root of the object (useful for xml)
+    # @return [Hash] A hash containing the result of the request
+    #
+    # @example
+    #   api.put('client', {name: "John Doe"})
+    def put(request, payload = {}, root = nil)
+      unless request
+        raise PeAccouningError, 'You must specify a request'
       end
-      request(:put, url(kwargs[:company_id], kwargs[:request]),
-              kwargs[:payload])
+      payload = (root ? {root => payload} : payload)
+      request(:put, uri(request), payload)
     end
 
-    def post(kwargs = {})
-      unless kwargs[:company_id] && kwargs[:request] && kwargs[:payload]
-        raise PeAccouningError, 'You must specify a company_id, a request, and a payload'
+    # Performs a POST request
+    #
+    # (see #put)
+    #
+    # @example
+    #   api.post('client/123', {name: "John Doe"})
+    def post(request, payload = {}, root = nil)
+      unless request
+        raise PeAccouningError, 'You must specify a request'
       end
-
-      request(:post, url(kwargs[:company_id], kwargs[:request]),
-              kwargs[:payload])
+      payload = (root ? {root => payload} : payload)
+      request(:post, uri(request), payload)
     end
 
-    def delete(kwargs = {})
-      unless kwargs[:company_id] && kwargs[:request]
-        raise PeAccouningError, 'You must specify a Company ID and a request'
+    # Performs a DELETE request
+    #
+    # (see #get)
+    #
+    # @example
+    #   api.delete('client/123')
+    def delete(request)
+      unless request
+        raise PeAccouningError, 'You must specify a request'
       end
-      request(:delete, url(kwargs[:company_id], kwargs[:request]))
+      request(:delete, uri(request))
     end
 
     private
 
-    def url(company_id, path)
-      "#{@endpoint}company/#{company_id}/#{path}"
+    def uri(path)
+      URI.parse("#{@endpoint}company/#{@company_id}/#{path}")
+    end
+
+    def denilize(h)
+      h.each_with_object({}) { |(k,v),g|
+        g[k] = (Hash === v) ?  denilize(v) : v ? v : '' }
     end
 
     def generate_payload(payload)
-      if payload
-        if @format == xml
-          Gyoku.xml(payload)
-        else
-          MultiJson.dump(payload)
-        end
+      if @format == :xml
+        Gyoku.xml(payload)
+      else
+        MultiJson.dump(payload)
       end
     end
 
     def handle_body(body)
       if @format == :xml
-        parser = Nori.new
-        parser.parse(body)
+        parser = Nori.new(convert_dashes_to_underscores: false,
+        empty_tag_value: "")
+        hash = parser.parse(body)
       else
         hash = MultiJson.load(body)
-        hash.length == 1 ? hash.values.first : hash
       end
+
+      while hash.is_a?(Hash) && hash.length == 1
+        hash = hash.values.first
+      end
+      hash
+
     end
 
-    def request(method, url, payload = nil)
-      res = RestClient::Request.execute(method: method, url: url,
-                                        payload: generate_payload(payload),
-                                        headers: { content_type: @format,
-                                                   x_token: @token })
-      handle_body(res.body)
+    def request(method, uri, payload = nil)
+      req = Net::HTTP.const_get(method.capitalize, false).new(uri)
+      req.content_type = "application/#{@format.downcase}"
+      req['X-Token'] = @token
+      req.body = generate_payload(payload) if payload
+
+      res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+        http.request(req)
+      end
+
+      case res
+      when Net::HTTPSuccess
+        return handle_body(res.body)
+      else
+        raise PeAccouningError, (res.read_body ? handle_body(res.body) : res)
+      end
     end
 
-    def file_to_json(file)
-      file.read.each_byte.map { |b| b.to_s(16) }.to_json
+    # Converts a File to its hexadecimal representation
+    #
+    # @param f [File] A binary file.
+    # @return [String] A string representing the file in hexadecimal form.
+    def file_to_hex(f)
+      f.read.unpack('H*').first
     end
+
   end
 end

data/lib/pe_accounting/version.rb

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

data/pe_accounting.gemspec

@@ -22,10 +22,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.has_rdoc = 'yard'
+
   spec.add_development_dependency 'bundler', '~> 1.14'
   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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pe_accounting
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mehdi Rejraji
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-01 00:00:00.000000000 Z
+date: 2017-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,20 +58,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.0
-- !ruby/object:Gem::Dependency
-  name: rest-client
-  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: gyoku
   requirement: !ruby/object:Gem::Requirement