sendregning 0.1.1 → 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8b771593610a6f4f488681d49b9779c8770dc347329f445ef53d3a376f8dd831
+  data.tar.gz: 14d3fe0461d33d1e0269b6c87deeee857bd6fe37a03165e3de5c971b6fa1b311
+SHA512:
+  metadata.gz: bc21bc5404eec80df91cea1657fff4d3084f08ff6e34c38ab7adb72fbf48cdc53a1b3f1f0d634e1014bce7339202f48d0c8d66f709573f160ccb0cfcc5d259e6
+  data.tar.gz: 65159551c9c6a8d8c13e6ebf86e249f99a46377d0c39f9173e6d7a80ab85e74c989967bad29536acca096c8d42548acb8a4c79f84bb141f1221ac741415b70f5

data/.gitignore

@@ -1,21 +1 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC
+*.gem

data/.rubocop.yml

@@ -0,0 +1,23 @@
+require: rubocop-rspec
+
+inherit_from:
+  - .rubocop_todo.yml
+
+AllCops:
+  NewCops: enable
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  AutoCorrect: true
+  Max: 80
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: aligned

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+group :development, :test do
+  gem "pry"
+  gem "pry-stack_explorer"
+  gem "rubocop"
+  gem "rubocop-rails"
+  gem "rubocop-rspec"
+end

data/Gemfile.lock

@@ -0,0 +1,93 @@
+PATH
+  remote: .
+  specs:
+    sendregning (0.2.2)
+      builder (~> 3.1)
+      httmultiparty (~> 0.3)
+      httparty (~> 0.13)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.0)
+    binding_of_caller (0.8.0)
+      debug_inspector (>= 0.0.1)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.6)
+    debug_inspector (0.0.3)
+    httmultiparty (0.3.16)
+      httparty (>= 0.7.3)
+      mimemagic
+      multipart-post
+    httparty (0.18.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.0512)
+    mimemagic (0.3.5)
+    minitest (5.14.1)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    parallel (1.19.1)
+    parser (2.7.1.3)
+      ast (~> 2.4.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-stack_explorer (0.5.1)
+      binding_of_caller (~> 0.7)
+      pry (~> 0.13)
+    rack (2.2.2)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (1.7.0)
+    rexml (3.2.4)
+    rubocop (0.85.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    rubocop-rails (2.5.2)
+      activesupport
+      rack (>= 1.1)
+      rubocop (>= 0.72.0)
+    rubocop-rspec (1.39.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  pry-stack_explorer
+  rake
+  rubocop
+  rubocop-rails
+  rubocop-rspec
+  sendregning!
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,49 @@
+# Sendregning
+
+[![Code Climate](https://codeclimate.com/github/elektronaut/sendregning.png)](https://codeclimate.com/github/elektronaut/sendregning)
+
+Ruby client for the SendRegning Web Service.
+
+## Getting started
+
+Install with RubyGems:
+
+    gem install sendregning
+
+Now start sending invoices:
+
+    # Create a new client
+    client = Sendregning::Client.new('my@email.com', 'myawesomepassword')
+
+    # Start a new email invoice
+    invoice = client.new_invoice(
+      name:           'My Client',
+      zip:            '0123',
+      city:           'Oslo',
+      shipment:       :email,
+      emailaddresses: 'my@email.com'
+    )
+
+    # Add an item
+    invoice.add_line qty: 1, desc: 'Bananaphone', unitPrice: '500,00'
+
+    # Send it away!
+    invoice.send!
+
+    # Get the invoice number for future reference
+    id = invoice.invoiceNo
+
+Let's check how we're doing!
+
+    invoice = client.find_invoice(id)
+    invoice.paid? # => true
+
+Pass `test: true` to the constructor to use the test API
+
+    # Create a new client
+    client = Sendregning::Client.new('my@email.com', 'myawesomepassword', test: true)
+
+
+## Copyright
+
+Copyright (c) 2010 Inge Jørgensen. See LICENSE for details.

data/lib/sendregning.rb

@@ -1,13 +1,20 @@
-require 'rubygems'
-require 'builder'
-require 'net/http/post/multipart'
-require 'httparty'
+# frozen_string_literal: true
+
+require "rubygems"
+require "builder"
+require "httparty"
+require "httmultiparty"
 
 dir = Pathname(__FILE__).dirname.expand_path
 
-require dir + 'sendregning/client'
-require dir + 'sendregning/invoice'
-require dir + 'sendregning/line'
+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
-end
+end

data/lib/sendregning/client.rb

@@ -1,118 +1,87 @@
-require 'yaml'
+# frozen_string_literal: true
+
+require "yaml"
 
 module Sendregning
+  # Client for the SendRegning Web Services.
+  #
+  # Usage example:
+  #
+  #  client = SendRegning::Client.new(my_username, my_password)
+
+  class Client
+    include HTTMultiParty
 
-	# Client for the SendRegning Web Services.
-	#
-	# Usage example:
-	#
-	#  client = SendRegning::Client.new(my_username, my_password)
-	
-	class Client
-		include HTTParty
+    base_uri "https://www.sendregning.no"
+    format   :xml
 
-		base_uri 'https://www.sendregning.no'
-		format   :xml
+    def initialize(username, password, options = {})
+      @auth = { username: username, password: password }
+      @test = true if options[:test]
+    end
 
-		def initialize(username, password, options={})
-			@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
-			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)}
+    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
 
-				# 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
-			
+    # Returns a list of recipients
+    def recipients
+      response = get(action: "select", type: "recipient")
+      response["recipients"]["recipient"]
+    end
 
-		protected
+    # Instances a new invoice
+    def new_invoice(attributes = {})
+      Sendregning::Invoice.new(attributes.merge({ client: self }))
+    end
 
-			def flatten_xml_hash(hash)
-				new_hash = {}
-				hash.each do |key, value|
-					new_hash[key] = "#{value}"
-				end
-				new_hash
-			end
+    # Sends an invoice
+    def send_invoice(invoice)
+      response = post_xml(invoice.to_xml,
+                          { action: "send", type: "invoice" })
+      InvoiceParser.parse(response, invoice)
+    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')
+    # 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" })
+      begin
+        InvoiceParser.parse(response)
+      rescue StandardError
+        nil
+      end
+    end
 
-				invoice.update(flatten_xml_hash(attributes))
-				invoice.lines = lines.map{|l| Sendregning::Line.new(flatten_xml_hash(l))}
-				invoice
-			end
+    protected
 
-			# Prepares options for a request
-			def query_options(query={})
-				query[:test] = 'true' if @test
-				{:basic_auth => @auth, :query => query}
-			end
+    # Prepares options for a request
+    def query_options(query = {})
+      query[:test] = "true" if @test
+      { basic_auth: @auth, query: query }
+    end
 
-	end
-end
+    def xml_file(xml)
+      UploadIO.new(StringIO.new(xml), "text/xml", "request.xml")
+    end
+  end
+end

data/lib/sendregning/invoice.rb

@@ -1,147 +1,98 @@
+# frozen_string_literal: true
+
 module Sendregning
+  class Invoice
+    OPTIONAL_ATTRIBUTES = [
+      # Request
+      :invoiceType, :creditedId, :orderNo, :invoiceDate, :orderNo,
+      :invoiceDate, :dueDate, :orderDate, :recipientNo, :address1, :address2,
+      :country, :email, :ourRef, :yourRef, :comment, :invoiceText, :printDunningInfo,
+      :itemTaxInclude,
+
+      # Response
+      :tax, :dueDate, :dunningFee, :invoiceNo, :total, :accountNo, :orgNrSuffix, :kid, :orgNo, :interestRate, :state
+    ].freeze
+
+    SHIPMENT_ATTRIBUTES = %i[
+      shipment emailaddresses copyaddresses
+    ].freeze
+
+    SHIPMENT_MODES = {
+      paper: "PAPER",
+      email: "EMAIL",
+      paper_and_email: "PAPER_AND_EMAIL"
+    }.freeze
+
+    attr_accessor :client
+    attr_accessor :name, :zip, :city
+    attr_accessor :optional, :shipment
+    attr_accessor :lines
+
+    def initialize(attributes = {})
+      update(attributes)
+      @lines = []
+    end
+
+    def update(attributes = {})
+      @client  = attributes[:client] if attributes[:client]
+      @name    = attributes[:name]   if attributes[:name]
+      @zip     = attributes[:zip]    if attributes[:zip]
+      @city    = attributes[:city]   if attributes[:city]
+      self.optional = attributes
+      self.shipment = attributes
+    end
+
+    def add_line(line)
+      line = Sendregning::Line.new(line) unless line.is_a?(Sendregning::Line)
+      @lines << line
+      line
+    end
+
+    # Sends an invoice
+    def send!
+      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 = {})
+      InvoiceSerializer.build(self, options)
+    end
+
+    protected
+
+    def filter_attributes(attributes, filter)
+      attributes.dup.delete_if { |k, _v| !filter.include?(k.to_sym) }
+    end
+
+    def optional=(attributes)
+      @optional ||= {}
+      @optional.merge!(filter_attributes(attributes, OPTIONAL_ATTRIBUTES))
+    end
+
+    def shipment=(attributes)
+      @shipment ||= {}
+      @shipment.merge!(filter_attributes(attributes, SHIPMENT_ATTRIBUTES))
+    end
 
-	class Invoice
-
-		OPTIONAL_ATTRIBUTES = [
-			# Request
-			:invoiceType, :creditedId, :orderNo, :invoiceDate, :orderNo,
-			:invoiceDate, :dueDate, :orderDate, :recipientNo, :address1, :address2,
-			:country, :email, :ourRef, :yourRef, :comment, :invoiceText, :printDunningInfo,
-			:itemTaxInclude,
-
-			# Response
-			:tax, :dueDate, :dunningFee, :invoiceNo, :total, :accountNo, :orgNrSuffix, :kid, :orgNo, :interestRate, :state
-		]
-
-		SHIPMENT_ATTRIBUTES = [
-			:shipment, :emailaddresses, :copyaddresses
-		]
-		
-		SHIPMENT_MODES = {
-			:paper           => 'PAPER',
-			:email           => 'EMAIL',
-			:paper_and_email => 'PAPER_AND_EMAIL'
-		}
-
-		attr_accessor :client
-		attr_accessor :name, :zip, :city
-		attr_accessor :optional, :shipment
-		attr_accessor :lines
-
-		def initialize(attributes={})
-			self.update(attributes)
-			@lines = []
-		end
-		
-		def update(attributes={})
-			@client  = attributes[:client] if attributes[:client]
-			@name    = attributes[:name]   if attributes[:name]
-			@zip     = attributes[:zip]    if attributes[:zip]
-			@city    = attributes[:city]   if attributes[:city]
-			self.optional = attributes
-			self.shipment = attributes
-		end
-
-		def add_line(line)
-			line = Sendregning::Line.new(line) unless line.kind_of?(Sendregning::Line)
-			@lines << line
-			line
-		end
-		
-		# Sends an invoice
-		def send!
-			self.client.send_invoice(self)
-		end
-		
-		def paid?
-			state == 'paid'
-		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
-		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
-			end
-		
-			def shipment=(attributes)
-				@shipment ||= {}
-				attributes.each do |key, value|
-					@shipment[key.to_sym] = value if SHIPMENT_ATTRIBUTES.include?(key.to_sym)
-				end
-				@shipment
-			end
-			
-			def method_missing(method, *args)
-				if OPTIONAL_ATTRIBUTES.include?(method)
-					@optional[method]
-				elsif SHIPPING_ATTRIBUTES.include?(method)
-					@shipping[method]
-				else
-					super
-				end
-			end
-		
-	end
-
-end
+    def method_missing(method, *args)
+      if OPTIONAL_ATTRIBUTES.include?(method)
+        @optional[method]
+      elsif SHIPMENT_ATTRIBUTES.include?(method)
+        @shipment[method]
+      else
+        super
+      end
+    end
+  end
+end