sendregning 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dc6f997dcd481f5713e113f3f10805359e10aab8
-  data.tar.gz: fc89a4e0e1262b00803aff4d348009ad8bf550b6
+SHA256:
+  metadata.gz: 8b771593610a6f4f488681d49b9779c8770dc347329f445ef53d3a376f8dd831
+  data.tar.gz: 14d3fe0461d33d1e0269b6c87deeee857bd6fe37a03165e3de5c971b6fa1b311
 SHA512:
-  metadata.gz: fce9bb3804d9194b6fa826bec419b557b0224207b8a04e5378c9492ca9b783e251bb1339d41bb0a85b8b48d4b3182d5d0c78c6d3c26328b855f8d15deceec39a
-  data.tar.gz: e97edf4f3420b455eb51d4ff8e53f7eb03a5856f3ec0071a091f539f7cf5563f980663cc72160dc67db6b6e73d3d25eccce97afe394cd6c3550b0135904efb75
+  metadata.gz: bc21bc5404eec80df91cea1657fff4d3084f08ff6e34c38ab7adb72fbf48cdc53a1b3f1f0d634e1014bce7339202f48d0c8d66f709573f160ccb0cfcc5d259e6
+  data.tar.gz: 65159551c9c6a8d8c13e6ebf86e249f99a46377d0c39f9173e6d7a80ab85e74c989967bad29536acca096c8d42548acb8a4c79f84bb141f1221ac741415b70f5

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/lib/sendregning.rb

@@ -1,18 +1,20 @@
-require 'rubygems'
-require 'builder'
-require 'httparty'
-require 'httmultiparty'
+# frozen_string_literal: true
+
+require "rubygems"
+require "builder"
+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'
+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

data/lib/sendregning/client.rb

@@ -1,7 +1,8 @@
-require 'yaml'
+# frozen_string_literal: true
 
-module Sendregning
+require "yaml"
 
+module Sendregning
   # Client for the SendRegning Web Services.
   #
   # Usage example:
@@ -11,69 +12,76 @@ module Sendregning
   class Client
     include HTTMultiParty
 
-    base_uri 'https://www.sendregning.no'
+    base_uri "https://www.sendregning.no"
     format   :xml
 
-    def initialize(username, password, options={})
-      @auth = {:username => username, :password => password}
+    def initialize(username, password, options = {})
+      @auth = { username: username, password: password }
       @test = true if options[:test]
     end
 
     # Performs a GET request
-    def get(query={})
-      self.class.get('/ws/butler.do', query_options(query))
+    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))
+    def post(query = nil)
+      self.class.post("/ws/butler.do", query_options(query))
     end
 
-    def post_xml(xml, query={})
+    def post_xml(xml, query = {})
       query[:xml] = xml_file(xml)
-      self.class.post('/ws/butler.do', query_options(query).merge(detect_mime_type: true))
+      self.class.post("/ws/butler.do",
+                      query_options(query).merge(detect_mime_type: true))
     end
 
     # Returns a list of recipients
     def recipients
-      response = get(:action => 'select', :type => 'recipient')
-      response['recipients']['recipient']
+      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}))
+    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'})
+      response = post_xml(invoice.to_xml,
+                          { action: "send", type: "invoice" })
       InvoiceParser.parse(response, 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"
+      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
+      response = post_xml(request_xml,
+                          { action: "select", type: "invoice" })
+      begin
+        InvoiceParser.parse(response)
+      rescue StandardError
+        nil
+      end
     end
 
     protected
 
     # Prepares options for a request
-    def query_options(query={})
-      query[:test] = 'true' if @test
-      {:basic_auth => @auth, :query => query}
+    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')
+      UploadIO.new(StringIO.new(xml), "text/xml", "request.xml")
     end
   end
 end

data/lib/sendregning/invoice.rb

@@ -1,5 +1,6 @@
-module Sendregning
+# frozen_string_literal: true
 
+module Sendregning
   class Invoice
     OPTIONAL_ATTRIBUTES = [
       # Request
@@ -10,29 +11,29 @@ module Sendregning
 
       # Response
       :tax, :dueDate, :dunningFee, :invoiceNo, :total, :accountNo, :orgNrSuffix, :kid, :orgNo, :interestRate, :state
-    ]
+    ].freeze
 
-    SHIPMENT_ATTRIBUTES = [
-      :shipment, :emailaddresses, :copyaddresses
-    ]
+    SHIPMENT_ATTRIBUTES = %i[
+      shipment emailaddresses copyaddresses
+    ].freeze
 
     SHIPMENT_MODES = {
-      :paper           => 'PAPER',
-      :email           => 'EMAIL',
-      :paper_and_email => 'PAPER_AND_EMAIL'
-    }
+      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={})
-      self.update(attributes)
+    def initialize(attributes = {})
+      update(attributes)
       @lines = []
     end
 
-    def update(attributes={})
+    def update(attributes = {})
       @client  = attributes[:client] if attributes[:client]
       @name    = attributes[:name]   if attributes[:name]
       @zip     = attributes[:zip]    if attributes[:zip]
@@ -42,35 +43,36 @@ module Sendregning
     end
 
     def add_line(line)
-      line = Sendregning::Line.new(line) unless line.kind_of?(Sendregning::Line)
+      line = Sendregning::Line.new(line) unless line.is_a?(Sendregning::Line)
       @lines << line
       line
     end
 
     # Sends an invoice
     def send!
-      self.client.send_invoice(self)
+      client.send_invoice(self)
     end
 
     def paid?
-      state == 'paid'
+      state == "paid"
     end
 
     def shipment_mode
       mode = (@shipment[:shipment] || :paper).to_sym
-      raise 'Invalid shipment mode!' unless SHIPMENT_MODES.keys.include?(mode)
+      raise "Invalid shipment mode!" unless SHIPMENT_MODES.keys.include?(mode)
+
       SHIPMENT_MODES[mode]
     end
 
     # Renders invoice to XML
-    def to_xml(options={})
+    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) }
+      attributes.dup.delete_if { |k, _v| !filter.include?(k.to_sym) }
     end
 
     def optional=(attributes)

data/lib/sendregning/invoice_parser.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Sendregning
   class InvoiceParser
     class << self
-      def parse(response, invoice=Sendregning::Invoice.new)
-        self.new(response, invoice).parse
+      def parse(response, invoice = Sendregning::Invoice.new)
+        new(response, invoice).parse
       end
     end
 
@@ -12,21 +14,23 @@ module Sendregning
     end
 
     def parse
-      attributes = @response['invoices']['invoice']
+      attributes = @response["invoices"]["invoice"]
 
       # Flatten optional and shipment attributes
-      %w{optional shipment}.each do |section|
-        if attributes.has_key?(section)
+      %w[optional shipment].each do |section|
+        if attributes.key?(section)
           attributes = attributes.merge(attributes[section])
           attributes.delete(section)
         end
       end
 
-      lines = attributes['lines']['line']
-      attributes.delete('lines')
+      lines = attributes["lines"]["line"]
+      attributes.delete("lines")
 
       @invoice.update(stringify_hash(attributes))
-      @invoice.lines = lines.map {|l| Sendregning::Line.new(stringify_hash(l)) }
+      @invoice.lines = lines.map do |l|
+        Sendregning::Line.new(stringify_hash(l))
+      end
       @invoice
     end
 
@@ -35,9 +39,9 @@ module Sendregning
     def stringify_hash(hash)
       new_hash = {}
       hash.each do |key, value|
-        new_hash[key] = "#{value}"
+        new_hash[key] = value.to_s
       end
       new_hash
     end
   end
-end
+end

data/lib/sendregning/invoice_serializer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sendregning
   class InvoiceSerializer < Sendregning::XmlSerializer
     def build
@@ -29,7 +31,7 @@ module Sendregning
         invoice.optional do |optional|
           item.optional.each do |key, value|
             key = key.to_sym
-            if value.kind_of?(Date) || value.kind_of?(Time)
+            if value.is_a?(Date) || value.is_a?(Time)
               value = value.strftime("%d.%m.%y")
             end
             optional.tag! key, value
@@ -44,14 +46,14 @@ module Sendregning
           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
+            next if 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,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sendregning
   class Line
     # Quantity, as decimal. Example: '7,5'
@@ -20,21 +22,21 @@ module Sendregning
 
     attr_accessor :itemNo, :lineTaxAmount, :lineTotal
 
-    def initialize(new_attributes={})
+    def initialize(new_attributes = {})
       self.attributes = new_attributes
     end
 
     # Renders line to XML
-    def to_xml(options={})
+    def to_xml(options = {})
       LineSerializer.build(self, options)
     end
 
     protected
 
-    def attributes=(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)
+        set_method = "#{key}=".to_sym
+        send(set_method, value) if respond_to?(set_method)
       end
       attributes
     end

data/lib/sendregning/line_serializer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sendregning
   class LineSerializer < Sendregning::XmlSerializer
     def build
@@ -11,4 +13,4 @@ module Sendregning
       end
     end
   end
-end
+end

data/lib/sendregning/version.rb

@@ -1,5 +1,5 @@
+# frozen_string_literal: true
+
 module Sendregning
-  unless Sendregning.const_defined?('VERSION')
-    VERSION = "0.2.1"
-  end
-end
+  VERSION = "0.2.2" unless Sendregning.const_defined?("VERSION")
+end

data/lib/sendregning/xml_serializer.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Sendregning
   class XmlSerializer
     class << self
-      def build(item, options={})
+      def build(item, options = {})
         builder = options[:builder] || xml_builder
-        self.new(item, builder).build
+        new(item, builder).build
       end
 
       protected
@@ -21,17 +23,14 @@ module Sendregning
     end
 
     def build
-      raise "XmlSerializer is an abstract class, subclass and overwrite the build method"
+      raise("XmlSerializer is an abstract class, subclass and overwrite " \
+            "the build method")
     end
 
     protected
 
-    def builder
-      @builder
-    end
+    attr_reader :builder
 
-    def item
-      @item
-    end
+    attr_reader :item
   end
-end
+end

data/sendregning.gemspec

@@ -1,26 +1,29 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-$:.push File.expand_path("../lib", __FILE__)
+$LOAD_PATH.push File.expand_path("lib", __dir__)
 require "sendregning/version"
 
 Gem::Specification.new do |s|
-  s.name        = 'sendregning'
+  s.name        = "sendregning"
   s.version     = Sendregning::VERSION
-  s.date        = '2014-03-05'
   s.summary     = "Ruby client for the SendRegning Web Service"
   s.description = "Ruby client for the SendRegning Web Service"
   s.authors     = ["Inge Jørgensen"]
-  s.email       = 'inge@manualdesign.no'
-  s.homepage    = 'http://github.com/elektronaut/sendregning'
-  s.license     = 'MIT'
+  s.email       = "inge@elektronaut.no"
+  s.homepage    = "https://github.com/elektronaut/sendregning"
+  s.license     = "MIT"
   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.executables   = `git ls-files -- bin/*`.split("\n").map do |f|
+    File.basename(f)
+  end
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency 'httparty',       '~> 0.13.0'
-  s.add_runtime_dependency 'builder',        '~> 3.1'
-  s.add_runtime_dependency 'httmultiparty',  '~> 0.3'
+  s.add_runtime_dependency "builder",        "~> 3.1"
+  s.add_runtime_dependency "httmultiparty",  "~> 0.3"
+  s.add_runtime_dependency "httparty",       "~> 0.13"
+
+  s.add_development_dependency "rake"
 end

metadata

@@ -1,64 +1,82 @@
 --- !ruby/object:Gem::Specification
 name: sendregning
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Inge Jørgensen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-05 00:00:00.000000000 Z
+date: 2020-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: builder
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: builder
+  name: httmultiparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: httmultiparty
+  name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby client for the SendRegning Web Service
-email: inge@manualdesign.no
+email: inge@elektronaut.no
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - lib/sendregning.rb
@@ -71,7 +89,7 @@ files:
 - lib/sendregning/version.rb
 - lib/sendregning/xml_serializer.rb
 - sendregning.gemspec
-homepage: http://github.com/elektronaut/sendregning
+homepage: https://github.com/elektronaut/sendregning
 licenses:
 - MIT
 metadata: {}
@@ -90,10 +108,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Ruby client for the SendRegning Web Service
 test_files: []
-has_rdoc: