sendregning 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c1f7147849c41ef8793153b66a1f58da22c94f1
-  data.tar.gz: d57d452f433f69185e4358b7b2b37919b51e60ba
+  metadata.gz: ac9aebbc32da82e3b79fe52e4383f3e86502bf66
+  data.tar.gz: c481e3697c7d335562b515f938e09bb264216ef1
 SHA512:
-  metadata.gz: 60e9a23fa2e5494d5238938aa0e631e19729a74cedfbbbb2aa865ae8f12f98a8a6bac61ec1b9540db764c68aa122c2f29d8cd79ac69f87a11e852793c6caa26e
-  data.tar.gz: b21f77225dd948ad1514af54317e737586a2c420e6a49682f196fc4015c1c72cc321984f7beb8e39f61bb1feb34acdd79f14e3634cfb08aa0bdb17999b34321c
+  metadata.gz: 1bb8c3a1194f57636a9f6c4d075c065db6c886d4bef8567e7d11fc4167c4e0e3381f1e39d552fa7f811143fad7a8f122e71efefacf85c591f4b7ad4925be80aa
+  data.tar.gz: 608b5eb4805de3d086083891abaed6b2aeb8b4014ad9e0e1671ad849e8615244e0675d6ee993281074ab253efa652c2db11f7f33b49daffd0b412a582079c355

data/lib/sendregning.rb

@@ -1,13 +1,17 @@
 require 'rubygems'
 require 'builder'
-require 'net/http/post/multipart'
 require 'httparty'
+require 'httmultiparty'
 
 dir = Pathname(__FILE__).dirname.expand_path
 
+require dir + 'sendregning/xml_serializer'
 require dir + 'sendregning/client'
 require dir + 'sendregning/invoice'
+require dir + 'sendregning/invoice_parser'
+require dir + 'sendregning/invoice_serializer'
 require dir + 'sendregning/line'
+require dir + 'sendregning/line_serializer'
 require dir + 'sendregning/version'
 
 module Sendregning

data/lib/sendregning/client.rb

@@ -7,9 +7,9 @@ module Sendregning
   # Usage example:
   #
   #  client = SendRegning::Client.new(my_username, my_password)
-  
+
   class Client
-    include HTTParty
+    include HTTMultiParty
 
     base_uri 'https://www.sendregning.no'
     format   :xml
@@ -18,101 +18,62 @@ module Sendregning
       @auth = {:username => username, :password => password}
       @test = true if options[:test]
     end
-    
-    public
 
-      # Performs a GET request
-      def get(query={})
-        self.class.get('/ws/butler.do', query_options(query))
-      end
+    # Performs a GET request
+    def get(query={})
+      self.class.get('/ws/butler.do', query_options(query))
+    end
 
-      # Performs a POST request
-      def post(query=nil)
-        self.class.post('/ws/butler.do', query_options(query))
-      end
-      
-      # Performs a POST request with an XML payload
-      def post_xml(xml, body={})
-        # Prepare the request
-        url = URI.parse("#{self.class.base_uri}/ws/butler.do")
-        body[:xml] = UploadIO.new(StringIO.new(xml), 'text/xml', 'request.xml')
-        body[:test] = true if @test
-        request = Net::HTTP::Post::Multipart.new(url.path, body)
-        request.basic_auth @auth[:username], @auth[:password]
-        
-        # Perform request
-        http = Net::HTTP.new(url.host, url.port)
-        http.use_ssl = true
-            http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-        res = http.start{|http| http.request(request)}
+    # Performs a POST request
+    def post(query=nil)
+      self.class.post('/ws/butler.do', query_options(query))
+    end
 
-        # Parse the response
-        response = Response.new(res, self.class.parser.call(res.body, :xml))
-      end
-    
-      # Returns a list of recipients
-      def recipients
-        response = get(:action => 'select', :type => 'recipient')
-        response['recipients']['recipient']
-      end
-      
-      # Instances a new invoice
-      def new_invoice(attributes={})
-        Sendregning::Invoice.new(attributes.merge({:client => self}))
-      end
-      
-      # Sends an invoice
-      def send_invoice(invoice)
-        response = post_xml(invoice.to_xml, {:action => 'send', :type => 'invoice'})
-        parse_invoice(response['invoices']['invoice'], invoice)
-      end
-      
-      # Finds an invoice by invoice number
-      def find_invoice(invoice_id)
-        builder = Builder::XmlMarkup.new(:indent=>2)
-        builder.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
-        request_xml = builder.select do |select|
-          select.invoiceNumbers do |numbers| 
-            numbers.invoiceNumber invoice_id
-          end
-        end
-        response = post_xml(request_xml, {:action => 'select', :type => 'invoice'})
-        parse_invoice(response['invoices']['invoice']) rescue nil
-      end
-      
+    def post_xml(xml, query={})
+      query[:xml] = xml_file(xml)
+      self.class.post('/ws/butler.do', query_options(query).merge(detect_mime_type: true))
+    end
 
-    protected
+    # Returns a list of recipients
+    def recipients
+      response = get(:action => 'select', :type => 'recipient')
+      response['recipients']['recipient']
+    end
 
-      def flatten_xml_hash(hash)
-        new_hash = {}
-        hash.each do |key, value|
-          new_hash[key] = "#{value}"
-        end
-        new_hash
-      end
+    # Instances a new invoice
+    def new_invoice(attributes={})
+      Sendregning::Invoice.new(attributes.merge({:client => self}))
+    end
 
-      def parse_invoice(response, invoice=Sendregning::Invoice.new)
-        attributes = response.dup
-        if attributes['optional']
-          attributes = attributes.merge(attributes['optional'])
-          attributes.delete('optional')
-        end
-        if attributes['shipment']
-          attributes = attributes.merge(attributes['shipment'])
-          attributes.delete('shipment')
-        end
-        lines = attributes['lines']['line']; attributes.delete('lines')
+    # Sends an invoice
+    def send_invoice(invoice)
+      response = post_xml(invoice.to_xml, {:action => 'send', :type => 'invoice'})
+      InvoiceParser.parse(response, invoice)
+    end
 
-        invoice.update(flatten_xml_hash(attributes))
-        invoice.lines = lines.map{|l| Sendregning::Line.new(flatten_xml_hash(l))}
-        invoice
+    # Finds an invoice by invoice number
+    def find_invoice(invoice_id)
+      builder = Builder::XmlMarkup.new(:indent=>2)
+      builder.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
+      request_xml = builder.select do |select|
+        select.invoiceNumbers do |numbers|
+          numbers.invoiceNumber invoice_id
+        end
       end
+      response = post_xml(request_xml, {:action => 'select', :type => 'invoice'})
+      InvoiceParser.parse(response) rescue nil
+    end
 
-      # Prepares options for a request
-      def query_options(query={})
-        query[:test] = 'true' if @test
-        {:basic_auth => @auth, :query => query}
-      end
+    protected
 
+    # Prepares options for a request
+    def query_options(query={})
+      query[:test] = 'true' if @test
+      {:basic_auth => @auth, :query => query}
+    end
+
+    def xml_file(xml)
+      UploadIO.new(StringIO.new(xml), 'text/xml', 'request.xml')
+    end
   end
 end

data/lib/sendregning/invoice.rb

@@ -1,7 +1,6 @@
 module Sendregning
 
   class Invoice
-
     OPTIONAL_ATTRIBUTES = [
       # Request
       :invoiceType, :creditedId, :orderNo, :invoiceDate, :orderNo,
@@ -16,7 +15,7 @@ module Sendregning
     SHIPMENT_ATTRIBUTES = [
       :shipment, :emailaddresses, :copyaddresses
     ]
-    
+
     SHIPMENT_MODES = {
       :paper           => 'PAPER',
       :email           => 'EMAIL',
@@ -32,7 +31,7 @@ module Sendregning
       self.update(attributes)
       @lines = []
     end
-    
+
     def update(attributes={})
       @client  = attributes[:client] if attributes[:client]
       @name    = attributes[:name]   if attributes[:name]
@@ -47,101 +46,59 @@ module Sendregning
       @lines << line
       line
     end
-    
+
     # Sends an invoice
     def send!
       self.client.send_invoice(self)
     end
-    
+
     def paid?
       state == 'paid'
     end
 
+    def shipment_mode
+      mode = (@shipment[:shipment] || :paper).to_sym
+      raise 'Invalid shipment mode!' unless SHIPMENT_MODES.keys.include?(mode)
+      SHIPMENT_MODES[mode]
+    end
+
     # Renders invoice to XML
     def to_xml(options={})
-      if options[:builder]
-        xml = options[:builder]
-      else
-        xml = Builder::XmlMarkup.new(:indent=>2)
-        xml.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
-      end
-      xml.invoices do |invoices|
-        invoices.invoice do |invoice|
-          invoice.name @name
-          invoice.zip  @zip
-          invoice.city @city
-          
-          # Lines
-          if @lines.length > 0
-            invoice.lines do |line_builder|
-              @lines.each{|l| l.to_xml(:builder => line_builder)}
-            end
-          end
-
-          # Optional attributes
-          if @optional.length > 0
-            invoice.optional do |optional|
-              @optional.each do |key, value|
-                key = key.to_sym
-                if value.kind_of?(Date) || value.kind_of?(Time)
-                  value = value.strftime("%d.%m.%y")
-                end
-                optional.tag! key, value
-              end
-            end
-          end
-
-          # Shipment attributes
-          if @shipment.length > 0
-            invoice.shipment do |shipment|
-              shipment_mode = (@shipment[:shipment] || :paper).to_sym
-              raise 'Invalid shipment mode!' unless SHIPMENT_MODES.keys.include?(shipment_mode)
-              shipment_mode = SHIPMENT_MODES[shipment_mode]
-
-              shipment.text! shipment_mode
-              @shipment.each do |key, values|
-                key = key.to_sym
-                unless key == :shipment
-                  values = [values] unless values.kind_of?(Enumerable)
-                  shipment.tag! key do |emails|
-                    values.each{|v| emails.email v}
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
+      InvoiceSerializer.build(self, options)
     end
 
     protected
-    
-      def optional=(attributes)
-        @optional ||= {}
-        attributes.each do |key, value|
-          @optional[key.to_sym] = value if OPTIONAL_ATTRIBUTES.include?(key.to_sym)
-        end
-        @optional
+
+    def optional=(attributes)
+      @optional ||= {}
+      attributes.each do |key, value|
+        @optional[key.to_sym] = value if OPTIONAL_ATTRIBUTES.include?(key.to_sym)
       end
-    
-      def shipment=(attributes)
-        @shipment ||= {}
-        attributes.each do |key, value|
-          @shipment[key.to_sym] = value if SHIPMENT_ATTRIBUTES.include?(key.to_sym)
-        end
-        @shipment
+      @optional
+    end
+
+    def shipment=(attributes)
+      @shipment ||= {}
+      attributes.each do |key, value|
+        @shipment[key.to_sym] = value if SHIPMENT_ATTRIBUTES.include?(key.to_sym)
       end
-      
-      def method_missing(method, *args)
-        if OPTIONAL_ATTRIBUTES.include?(method)
-          @optional[method]
-        elsif SHIPPING_ATTRIBUTES.include?(method)
-          @shipping[method]
-        else
-          super
-        end
+      @shipment
+    end
+
+    def method_missing(method, *args)
+      if OPTIONAL_ATTRIBUTES.include?(method)
+        @optional[method]
+      elsif SHIPMENT_ATTRIBUTES.include?(method)
+        @shipping[method]
+      else
+        super
       end
-    
-  end
+    end
 
+    def xml_builder
+      xml = Builder::XmlMarkup.new(:indent=>2)
+      xml.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
+      xml
+    end
+  end
 end

data/lib/sendregning/invoice_parser.rb

@@ -0,0 +1,43 @@
+module Sendregning
+  class InvoiceParser
+    class << self
+      def parse(response, invoice=Sendregning::Invoice.new)
+        self.new(response, invoice).parse
+      end
+    end
+
+    def initialize(response, invoice)
+      @response = response
+      @invoice = invoice
+    end
+
+    def parse
+      attributes = @response['invoices']['invoice']
+
+      # Flatten optional and shipment attributes
+      %w{optional shipment}.each do |section|
+        if attributes.has_key?(section)
+          attributes = attributes.merge(attributes[section])
+          attributes.delete(section)
+        end
+      end
+
+      lines = attributes['lines']['line']
+      attributes.delete('lines')
+
+      @invoice.update(stringify_hash(attributes))
+      @invoice.lines = lines.map {|l| Sendregning::Line.new(stringify_hash(l)) }
+      @invoice
+    end
+
+    protected
+
+    def stringify_hash(hash)
+      new_hash = {}
+      hash.each do |key, value|
+        new_hash[key] = "#{value}"
+      end
+      new_hash
+    end
+  end
+end

data/lib/sendregning/invoice_serializer.rb

@@ -0,0 +1,57 @@
+module Sendregning
+  class InvoiceSerializer < Sendregning::XmlSerializer
+    def build
+      builder.invoices do |invoices|
+        invoices.invoice do |invoice|
+          invoice.name item.name
+          invoice.zip  item.zip
+          invoice.city item.city
+
+          lines(invoice)
+          optional_attributes(invoice)
+          shipment_attributes(invoice)
+        end
+      end
+    end
+
+    protected
+
+    def lines(invoice)
+      if item.lines.any?
+        invoice.lines do |line_builder|
+          item.lines.each { |l| l.to_xml(builder: line_builder) }
+        end
+      end
+    end
+
+    def optional_attributes(invoice)
+      if item.optional.any?
+        invoice.optional do |optional|
+          item.optional.each do |key, value|
+            key = key.to_sym
+            if value.kind_of?(Date) || value.kind_of?(Time)
+              value = value.strftime("%d.%m.%y")
+            end
+            optional.tag! key, value
+          end
+        end
+      end
+    end
+
+    def shipment_attributes(invoice)
+      if item.shipment.any?
+        invoice.shipment do |shipment|
+          shipment.text! item.shipment_mode
+          item.shipment.each do |key, values|
+            key = key.to_sym
+            unless key == :shipment
+              shipment.tag! key do |emails|
+                Array(values).each { |v| emails.email v }
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sendregning/line.rb

@@ -1,59 +1,42 @@
 module Sendregning
-
   class Line
-
     # Quantity, as decimal. Example: '7,5'
     attr_accessor :qty
-    
+
     # Product code. String, max length: 9
     attr_accessor :prodCode
-    
+
     # Description. String, max length: 75
     attr_accessor :desc
-    
+
     # Price per unit in decimal. Example: '250,00'
     attr_accessor :unitPrice
-    
+
     # Discount in percentage as decimal. Optional, defaults to 0
     attr_accessor :discount
 
     # Tax rate. Valid rates are: '0', '8', '13' and '25'. Default: '25'
     attr_accessor :tax
-    
+
     attr_accessor :itemNo, :lineTaxAmount, :lineTotal
 
     def initialize(new_attributes={})
       self.attributes = new_attributes
     end
-    
+
     # Renders line to XML
     def to_xml(options={})
-      if options[:builder]
-        xml = options[:builder]
-      else
-        xml = Builder::XmlMarkup.new(:indent=>2)
-        xml.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
-      end
-      xml.line do |line|
-        line.qty       self.qty       if @qty
-        line.prodCode  self.prodCode  if @prodCode
-        line.desc      self.desc      if @desc
-        line.unitPrice self.unitPrice if @unitPrice
-        line.discount  self.discount  if @discount
-        line.tax       self.tax       if @tax
-      end
+      LineSerializer.build(self, options)
     end
 
     protected
 
-      def attributes=(attributes={})
-        attributes.each do |key, value|
-          set_method = "#{key.to_s}=".to_sym
-          self.send(set_method, value) if self.respond_to?(set_method)
-        end
-        attributes
+    def attributes=(attributes={})
+      attributes.each do |key, value|
+        set_method = "#{key.to_s}=".to_sym
+        self.send(set_method, value) if self.respond_to?(set_method)
       end
-
+      attributes
+    end
   end
-  
 end

data/lib/sendregning/line_serializer.rb

@@ -0,0 +1,14 @@
+module Sendregning
+  class LineSerializer < Sendregning::XmlSerializer
+    def build
+      builder.line do |line|
+        line.qty       item.qty       if item.qty
+        line.prodCode  item.prodCode  if item.prodCode
+        line.desc      item.desc      if item.desc
+        line.unitPrice item.unitPrice if item.unitPrice
+        line.discount  item.discount  if item.discount
+        line.tax       item.tax       if item.tax
+      end
+    end
+  end
+end

data/lib/sendregning/version.rb

@@ -1,5 +1,5 @@
 module Sendregning
   unless Sendregning.const_defined?('VERSION')
-    VERSION = "0.1.3"
+    VERSION = "0.2.0"
   end
 end

data/lib/sendregning/xml_serializer.rb

@@ -0,0 +1,37 @@
+module Sendregning
+  class XmlSerializer
+    class << self
+      def build(item, options={})
+        builder = options[:builder] || xml_builder
+        self.new(item, builder).build
+      end
+
+      protected
+
+      def xml_builder
+        xml = Builder::XmlMarkup.new(indent: 2)
+        xml.instruct! :xml, version: "1.0", encoding: "UTF-8"
+        xml
+      end
+    end
+
+    def initialize(item, builder)
+      @item = item
+      @builder = builder
+    end
+
+    def build
+      raise "XmlSerializer is an abstract class, subclass and overwrite the build method"
+    end
+
+    protected
+
+    def builder
+      @builder
+    end
+
+    def item
+      @item
+    end
+  end
+end

data/sendregning.gemspec

@@ -13,14 +13,14 @@ Gem::Specification.new do |s|
   s.email       = 'inge@manualdesign.no'
   s.homepage    = 'http://github.com/elektronaut/sendregning'
   s.license     = 'MIT'
-  s.required_ruby_version = Gem::Requirement.new(">= 1.8.7")
+  s.required_ruby_version = Gem::Requirement.new(">= 1.9.3")
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency 'httparty',       '0.6.1'
-  s.add_runtime_dependency 'builder',        '~> 2.1'
-  s.add_runtime_dependency 'multipart-post', '~> 1.0'
+  s.add_runtime_dependency 'httparty',       '~> 0.13.0'
+  s.add_runtime_dependency 'builder',        '~> 3.1'
+  s.add_runtime_dependency 'httmultiparty',  '~> 0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sendregning
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Inge Jørgensen
@@ -14,44 +14,44 @@ dependencies:
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: 0.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: multipart-post
+  name: httmultiparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.3'
 description: Ruby client for the SendRegning Web Service
 email: inge@manualdesign.no
 executables: []
@@ -64,8 +64,12 @@ files:
 - lib/sendregning.rb
 - lib/sendregning/client.rb
 - lib/sendregning/invoice.rb
+- lib/sendregning/invoice_parser.rb
+- lib/sendregning/invoice_serializer.rb
 - lib/sendregning/line.rb
+- lib/sendregning/line_serializer.rb
 - lib/sendregning/version.rb
+- lib/sendregning/xml_serializer.rb
 - sendregning.gemspec
 homepage: http://github.com/elektronaut/sendregning
 licenses:
@@ -79,7 +83,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="