horizon_client 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fbc26ad88c7153d70742da5e36297418d331f3f
-  data.tar.gz: e9f1341564048999b61e9f2859a39c8b6e7f890c
+  metadata.gz: 06b84f8009e74940b022cfb6c7feb583e068d51c
+  data.tar.gz: b2670e249a5646c5b68c23343ff62b0f2beaf6d7
 SHA512:
-  metadata.gz: 3bb0e9929ca4a976310477392f598cc5fba4d1d683315ac829b152f92c161eecf1713f75e1cbede84ad1815ba819001be19b453f2cd2e05ff06a15c2d913be86
-  data.tar.gz: 8fb6742b74ce1ccbac74011c8b13bc9a8713626e91bdb61028d2e593c139780ab8c5944502201ece53752f3c51e32dc02f0a9db0807310539ed2c52c20e48e41
+  metadata.gz: 00ca8cad1ed53bf68bb309a446adcaff7dfddd124b572b3c8a6dbbb38e496ba9fdd984cb7036419fa79f2a8562ecc257ca88d52bce774835c830d8124dba47d7
+  data.tar.gz: 1cd29b3ef83dfd52158d679dd1693cd84a14cc296499ac7320ff89415959e36715fbcd078b609d2e8e645b456b4cc696d486bd42291730100caaba13332cb0d8

data/README.md

@@ -7,12 +7,53 @@ Client to use with Horizon REST xml API.
 ```ruby
 client = HorizonClient.new
 
-get_response = client.get('example')
+# incoming xml:
+# <?xml version="1.0" encoding="UTF-8" standalone="no"?>
+# <resource>
+#   <entity>
+#     <name>Jack</name>
+#     <foo><bar>Jill</bar></foo>
+#   </entity>
+#   <collection>
+#     <row>
+#     </row>
+#     <row>
+#     </row>
+#   </collection>
+# </resource>
 
-post_response = client.post('example', 'post body')
-```
+# returns and expects HorizonClient::Resource object
+resource = client.get('path')
+return_resource = client.post('path', resource)
+
+# get entity:
+entity = resource.entity
+
+# get and set object values
+entity['name'] # => 'Jack'
+entity['name'] = 'Jane'
+entity['foo/bar'] # => 'Jill'
+entity['foo/baz'] = 'Joe' # => <foo><bar>Jill</bar><baz>Joe</baz></foo>
 
-`get_response` will be parsed from xml to hash.
+# get or set collection with specified name inside entity
+col = entity.get_collection('col')
+row = col.build # => #<HorizonClient::Entity>
+# result:
+# <entity>
+#   ...
+#   <col>
+#     <row></row>
+#   </col>
+# </entity>
+
+# get first level collection.
+collection = resource.collection
+entity_array = collection.rows # => [ #<HorizonClient::Entity> ]
+entity_array.each do |entity|
+  entity['foo'] = 'test'
+end
+
+```
 
 
 ### Necessary environment variables

data/horizon_client.gemspec

@@ -28,6 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "webmock", "~> 2.0"
 
   spec.add_dependency 'faraday', '~> 0.11'
-  spec.add_dependency 'multi_xml', '~> 0.6'
-  spec.add_dependency 'faraday_middleware', '~> 0.11'
+  spec.add_dependency 'ox', '~> 2.4'
 end

data/lib/horizon_client/collection.rb

@@ -0,0 +1,30 @@
+module HorizonClient
+  class Collection
+    include Enumerable
+
+    attr_reader :node
+
+    def initialize(node)
+      @node = node
+      @rows = @node.locate('row').map do |row|
+        Entity.new(row)
+      end
+    end
+
+    def build
+      row = Ox::Element.new('row')
+      node << row
+      entity = Entity.new(row)
+      @rows.push(entity)
+      entity
+    end
+
+    def rows
+      @rows
+    end
+
+    def each(&block)
+      @rows.each(&block)
+    end
+  end
+end

data/lib/horizon_client/entity.rb

@@ -0,0 +1,45 @@
+module HorizonClient
+  class Entity
+    attr_reader :node
+
+    def initialize(node)
+      @node = node
+    end
+
+    def [](name)
+      attr_node = node.locate(name).first
+      get_value attr_node
+    end
+
+    def []=(name, value)
+      elem = find_or_build_attribute(name.split('/'), node)
+      elem.replace_text(value)
+    end
+
+    def get_collection(name)
+      collection_node = find_or_build_attribute(name.split('/'), node)
+      Collection.new(collection_node)
+    end
+
+    private
+
+    def find_or_build_attribute(path, parent)
+      name = path.shift
+      unless child = parent.locate(name).first
+        child = Ox::Element.new(name)
+        parent << child
+      end
+      find_or_build_attribute(path, child) unless path.empty?
+
+      child
+    end
+
+    def get_value(node)
+      if node.respond_to?('href')
+        node.href.text
+      else
+        node.text
+      end
+    end
+  end
+end

data/lib/horizon_client/request/encode_xml.rb

@@ -0,0 +1,14 @@
+module HorizonClient
+  module Request
+    class EncodeXml < Faraday::Middleware
+      def call(env)
+        env[:body] = encode env[:body]
+        @app.call env
+      end
+
+      def encode(payload)
+        payload.is_a?(Resource) ? Ox.dump(payload.document, with_xml: true) : payload
+      end
+    end
+  end
+end

data/lib/horizon_client/resource.rb

@@ -0,0 +1,25 @@
+module HorizonClient
+  class Resource
+    attr_reader :document
+
+    def initialize(xml)
+      @document = Ox.parse(xml)
+    end
+
+    def entity
+      node = @document.resource.entity
+      Entity.new(node)
+    end
+
+    def collection
+      node = @document.resource.collection
+      @collection ||= Collection.new(node)
+    end
+
+    def error
+      if document.respond_to?('error')
+        document.error.message.text
+      end
+    end
+  end
+end

data/lib/horizon_client/response/parse_xml.rb

@@ -0,0 +1,17 @@
+module HorizonClient
+  module Response
+
+    class ResourceError < StandardError
+    end
+
+    class ParseXml < Faraday::Response::Middleware
+      def parse(body)
+        resource = Resource.new(body)
+
+        raise ResourceError.new(resource.error) if resource.error
+
+        resource
+      end
+    end
+  end
+end

data/lib/horizon_client/version.rb

@@ -1,3 +1,3 @@
 module HorizonClient
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/horizon_client.rb

@@ -1,36 +1,27 @@
 require "horizon_client/version"
 require "faraday"
-require "multi_xml"
-require "faraday_middleware"
+require "ox"
+
+require 'horizon_client/response/parse_xml'
+require 'horizon_client/request/encode_xml'
+
+require "horizon_client/resource"
+require "horizon_client/collection"
+require "horizon_client/entity"
 
 module HorizonClient
   def self.new(*args)
     Connection.new(*args)
   end
 
-  class ClientError < Faraday::ClientError
-    def initialize(e)
-      message = e.message
-      if e.response.is_a?(Hash)
-        body = e.response[:body]
-        if body.is_a?(Hash)
-          error = body['error']
-          if error.is_a?(Hash)
-            message += ": #{error['message']}"
-          end
-        end
-      end
-      super message
-    end
-  end
-
   class Connection
     def initialize(url = nil)
       url ||=  ENV['HORIZON_REST_URL']
 
       @connection = Faraday.new url do |conn|
         conn.response :raise_error
-        conn.response :xml,  :content_type => /\bxml$/
+        conn.use HorizonClient::Response::ParseXml
+        conn.use HorizonClient::Request::EncodeXml
 
         conn.adapter Faraday.default_adapter
       end
@@ -43,9 +34,6 @@ module HorizonClient
     def get(path = '', params = {})
       response = @connection.get path, params
       response.body
-
-    rescue Faraday::ClientError => e
-      raise ClientError.new(e)
     end
 
     def post(path = '', body)
@@ -56,8 +44,6 @@ module HorizonClient
       end
 
       response.body
-    rescue Faraday::ClientError => e
-      raise ClientError.new(e)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: horizon_client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - MAK IT
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-14 00:00:00.000000000 Z
+date: 2017-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,33 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.11'
 - !ruby/object:Gem::Dependency
-  name: multi_xml
+  name: ox
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '2.4'
 description: Client for Horizon by VISMA accounting REST xml API.
 email:
 - martins.lapsa@makit.lv
@@ -125,6 +111,11 @@ files:
 - bin/setup
 - horizon_client.gemspec
 - lib/horizon_client.rb
+- lib/horizon_client/collection.rb
+- lib/horizon_client/entity.rb
+- lib/horizon_client/request/encode_xml.rb
+- lib/horizon_client/resource.rb
+- lib/horizon_client/response/parse_xml.rb
 - lib/horizon_client/version.rb
 homepage: http://rubygems.org/gems/horizon_client
 licenses: