fortnox-api 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a174ee3cf9c8f2a5ee1a43ce636806e017e1462263eddfdd5e91968025144fb4
-  data.tar.gz: d5f3c46c81e25009be272bee9bdfafe64e657f4ff5b7a131c272a49b8f9382f5
+  metadata.gz: 2a553a96a17c448e49472e1b41e703382defbda6a54427709145b8d60e02f34f
+  data.tar.gz: d7b3e147ad14c689c1fd24c7cf3529d3f951281c16d22bcbbf3c641ef2191d6e
 SHA512:
-  metadata.gz: 942b59f8380781117425fbcdb713bbf05c3e4651779e517c89b1c1cd339bc521a19a79ca2df9c02098a472eabc31a5b9ae9f1b69945bd21c54e727075d4c66f9
-  data.tar.gz: 598dd75a8a6d7f8af1b84e70a331192df243ebddad2174b09f43161767ab84b0e4c08dc8c020e55b9fa8928d8d3419f6ba7a99e2b5c6d21d541691d0eaacda17
+  metadata.gz: cef6687c30dca772585b966158dd94b17983c6393ca7e96fe619c154c0c312d7b4982978310a70469f0a4ddda0db2306a2fc6e9fc62ac31f45c2eb85930eb12f
+  data.tar.gz: 597a1bbf5704b5a020d6add724ac1a7e375ab610d19ab0c2ca342148a4727a1fe22ca75de82d69581366d5bc345259c211570f5a93b019ded657c11a73ba8ffc

data/CHANGELOG.md

@@ -4,15 +4,30 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.7.1]
+### Fixed
+- Invalid validation for Customer's country attributes
+
 ## [0.7.0]
 ### Added
-- Adds build test for Ruby 2.6.0, 2.6.3 and 2.7.0-preview.
+- Adds build test for Ruby `2.6.0`, `2.6.3` and `2.7.0-preview`.
 
 ### Removed
-- Drops support for Ruby < 2.4.0 since they are deprecated
+- Drops support for Ruby < `2.4.0` since they are deprecated
 
 ### Fixed
-- Country attribute for Invoice and Order is now validated correctly.
+- Country attribute for `Invoice` and `Order` is now validated correctly.
 - Fixes deprecation warnings
+- Unlocks pinned `HTTParty` version
+- Invalid email validation
+
+## [0.6.3]
+### Changed
+- Pins `dry-types` to `< 0.13.0` due to breaking changes
+
+### Fixed
+- Model attribute `url` is no longer null
 
-[0.7.0]: https://github.com/accodeing/fortnox-api/compare/v0.7.0...v0.6.3
+[0.7.1]: https://github.com/accodeing/fortnox-api/compare/v0.7.0...v0.7.1
+[0.7.0]: https://github.com/accodeing/fortnox-api/compare/v0.6.3...v0.7.0
+[0.6.3]: https://github.com/accodeing/fortnox-api/compare/v0.6.2...v0.6.3

data/fortnox-api.gemspec

@@ -9,13 +9,13 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.name          = 'fortnox-api'
   spec.version       = Fortnox::API::VERSION
   spec.authors       = ['Jonas Schubert Erlandsson', 'Hannes Elvemyr', 'Felix Holmgren']
-  spec.email         = ['info@my-codeworks.com']
+  spec.email         = ['info@accodeing.com']
   spec.summary       = 'Gem to use Fortnox REST API in Ruby.'
   spec.description   = 'This gem uses the HTTParty library to abstract away the REST calls. It gives you access to a '\
                        'number of objects that behave a lot like ActiveRecord instances, giving you access to methods '\
                        'like `all`, `find`, `find_by_...` and so on. And each individual instance can be easily'\
                        'persistable to Fortnox again using the `save` method.'
-  spec.homepage      = 'http://github.com/my-codeworks/fortnox-api'
+  spec.homepage      = 'http://github.com/accodeing/fortnox-api'
   spec.license       = 'LGPL-3.0'
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/fortnox/api/mappers.rb

@@ -3,7 +3,7 @@
 require 'fortnox/api/types'
 
 require 'fortnox/api/mappers/value/array'
-require 'fortnox/api/mappers/value/country_code_string'
+require 'fortnox/api/mappers/value/country_string'
 require 'fortnox/api/mappers/value/date'
 require 'fortnox/api/mappers/value/hash'
 require 'fortnox/api/mappers/value/identity'

data/lib/fortnox/api/mappers/value/{country_code_string.rb → country_string.rb}

@@ -5,10 +5,10 @@ require 'fortnox/api/mappers/base/canonical_name_sym'
 module Fortnox
   module API
     module Mapper
-      class CountryCodeString
+      class CountryString
         extend CanonicalNameSym
 
-        CountryCodeMapper = lambda do |code|
+        CountryMapper = lambda do |code|
           next code if code.nil? || code == ''
 
           # Fortnox only supports Swedish country name for Sweden
@@ -17,7 +17,7 @@ module Fortnox
           ::ISO3166::Country[code].translations['en']
         end
 
-        Registry.register(canonical_name_sym, CountryCodeMapper)
+        Registry.register(canonical_name_sym, CountryMapper)
       end
     end
   end

data/lib/fortnox/api/models/document.rb

@@ -44,7 +44,7 @@ module Fortnox
         attribute :contribution_value, Types::Nullable::Float.is(:read_only)
 
         # Country Country for the document address.
-        attribute :country, Types::CountryCode
+        attribute :country, Types::Country
 
         # CostCenter Code of the cost center.
         attribute :cost_center, Types::Nullable::String
@@ -74,7 +74,7 @@ module Fortnox
         attribute :delivery_city, Types::Sized::String[1024]
 
         # DeliveryCountry Country for the document delivery address.
-        attribute :delivery_country, Types::CountryCode
+        attribute :delivery_country, Types::Country
 
         # DeliveryDate Date of delivery.
         attribute :delivery_date, Types::Nullable::Date

data/lib/fortnox/api/types.rb

@@ -3,7 +3,7 @@
 require 'dry-struct'
 require 'dry-types'
 require 'countries'
-require 'fortnox/api/types/shim/country_code_string'
+require 'fortnox/api/types/shim/country_string'
 
 module Dry
   module Types
@@ -47,21 +47,33 @@ module Fortnox
                     .optional
                     .constructor(EnumConstructors.default)
 
+      Country = Strict::String
+                .optional
+                .constructor do |value|
+                  next value if value.nil? || value == ''
+
+                  # Fortnox only supports Swedish translation of Sweden
+                  next CountryString.new('SE') if value =~ /^s(e$|we|ve)/i
+
+                  country = ::ISO3166::Country[value] ||
+                            ::ISO3166::Country.find_country_by_name(value) ||
+                            ::ISO3166::Country.find_country_by_translated_names(value)
+
+                  raise Dry::Types::ConstraintError.new('value violates constraints', value) if country.nil?
+
+                  CountryString.new(country.alpha2)
+                end
+
       CountryCode = Strict::String
                     .optional
                     .constructor do |value|
                       next value if value.nil? || value == ''
 
-                      # Fortnox only supports Swedish translation of Sweden
-                      next CountryCodeString.new('SE') if value =~ /^s(e$|we|ve)/i
-
-                      country = ::ISO3166::Country[value] ||
-                                ::ISO3166::Country.find_country_by_name(value) ||
-                                ::ISO3166::Country.find_country_by_translated_names(value)
+                      country = ::ISO3166::Country[value]
 
                       raise Dry::Types::ConstraintError.new('value violates constraints', value) if country.nil?
 
-                      CountryCodeString.new(country.alpha2)
+                      country.alpha2
                     end
 
       Currency = Strict::String

data/lib/fortnox/api/types/shim/{country_code_string.rb → country_string.rb}

@@ -3,7 +3,7 @@
 module Fortnox
   module API
     module Types
-      class CountryCodeString < String
+      class CountryString < String
       end
     end
   end

data/lib/fortnox/api/version.rb

@@ -2,6 +2,6 @@
 
 module Fortnox
   module API
-    VERSION = '0.7.0'
+    VERSION = '0.7.1'
   end
 end

data/spec/fortnox/api/mappers/base_spec.rb

@@ -117,10 +117,10 @@ describe Fortnox::API::Mapper::Base do
     end
   end
 
-  describe 'CountryCode' do
+  describe 'Country' do
     subject { mapper.call('GB') }
 
-    let(:mapper) { Fortnox::API::Registry[:countrycodestring] }
+    let(:mapper) { Fortnox::API::Registry[:countrystring] }
 
     it { is_expected.to eq('United Kingdom') }
 

data/spec/fortnox/api/repositories/customer_spec.rb

@@ -40,4 +40,31 @@ describe Fortnox::API::Repository::Customer, order: :defined, integration: true
 
   # When recording new VCR casettes, expected matches must be increased
   include_examples '.search', :name, 'Test', 30
+
+  describe 'country reference' do
+    describe 'with valid country code \'SE\'' do
+      subject(:customer) do
+        VCR.use_cassette("#{vcr_dir}/save_new_with_country_code_SE") do
+          repository.save(
+            described_class::MODEL.new(
+              name: 'Customer with Swedish country code',
+              country_code: 'SE'
+            )
+          )
+        end
+      end
+
+      describe 'country code' do
+        subject { customer.country_code }
+
+        it { is_expected.to eq('SE') }
+      end
+
+      describe 'country' do
+        subject { customer.country }
+
+        it { is_expected.to eq('Sverige') }
+      end
+    end
+  end
 end

data/spec/fortnox/api/types/country_code_spec.rb

@@ -2,7 +2,6 @@
 
 require 'spec_helper'
 require 'fortnox/api/types'
-require 'fortnox/api/types/examples/types'
 
 describe Fortnox::API::Types::CountryCode do
   context 'with nil' do
@@ -21,54 +20,21 @@ describe Fortnox::API::Types::CountryCode do
     it 'accepts country codes' do
       expect(described_class['NO']).to eq 'NO'
     end
-
-    it 'accepts nil' do
-      expect(described_class[nil]).to eq nil
-    end
-
-    it 'accepts empty string' do
-      expect(described_class['']).to eq ''
-    end
-
-    it 'translates English country names to country code' do
-      expect(described_class['Norway']).to eq 'NO'
-    end
-
-    it 'translates Swedish country names to country code' do
-      expect(described_class['Norge']).to eq 'NO'
-    end
-
-    describe 'special cases' do
-      valid_sweden_inputs = [
-        'SE', 'se', 'Sweden', 'sweden', 'Sverige', 'sverige',
-        :SE, :se, :Sweden, :sweden, :Sverige, :sverige
-      ].freeze
-
-      valid_sweden_inputs.each do |sweden_input|
-        it "converts \"#{sweden_input}\" to \"SE\"" do
-          expect(described_class[sweden_input]).to eq 'SE'
-        end
-      end
-
-      it 'accepts country code for El Salvador' do
-        expect(described_class['SV']).to eq 'SV'
-      end
-
-      it 'translated Switzerland to ' do
-        expect(described_class['Switzerland']).to eq 'CH'
-      end
-    end
   end
 
   context 'with invalid input' do
-    invalid_inputs = [
-      'SEA', 'S', 'nonsense', :s
-    ].freeze
+    describe 'valid country name' do
+      it do
+        expect do
+          described_class['Norway']
+        end.to raise_error(Dry::Types::ConstraintError)
+      end
+    end
 
-    invalid_inputs.each do |invalid_input|
-      it "#{invalid_input} raises Dry::Types::ConstraintError" do
+    describe 'invalid country code' do
+      it do
         expect do
-          described_class[invalid_input]
+          described_class['XX']
         end.to raise_error(Dry::Types::ConstraintError)
       end
     end

data/spec/fortnox/api/types/country_spec.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'fortnox/api/types'
+
+describe Fortnox::API::Types::Country do
+  context 'with nil' do
+    subject { described_class[nil] }
+
+    it { is_expected.to be_nil }
+  end
+
+  context 'with empty string' do
+    subject { described_class[''] }
+
+    it { is_expected.to eq('') }
+  end
+
+  context 'with valid input' do
+    it 'accepts country codes' do
+      expect(described_class['NO']).to eq 'NO'
+    end
+
+    it 'translates English country names to country code' do
+      expect(described_class['Norway']).to eq 'NO'
+    end
+
+    it 'translates Swedish country names to country code' do
+      expect(described_class['Norge']).to eq 'NO'
+    end
+
+    describe 'special cases' do
+      valid_sweden_inputs = [
+        'SE', 'se', 'Sweden', 'sweden', 'Sverige', 'sverige',
+        :SE, :se, :Sweden, :sweden, :Sverige, :sverige
+      ].freeze
+
+      valid_sweden_inputs.each do |sweden_input|
+        it "converts \"#{sweden_input}\" to \"SE\"" do
+          expect(described_class[sweden_input]).to eq 'SE'
+        end
+      end
+
+      it 'accepts country code for El Salvador' do
+        expect(described_class['SV']).to eq 'SV'
+      end
+
+      it 'translated Switzerland to ' do
+        expect(described_class['Switzerland']).to eq 'CH'
+      end
+    end
+  end
+
+  context 'with invalid input' do
+    invalid_inputs = [
+      'SEA', 'S', 'nonsense', :s
+    ].freeze
+
+    invalid_inputs.each do |invalid_input|
+      it "#{invalid_input} raises Dry::Types::ConstraintError" do
+        expect do
+          described_class[invalid_input]
+        end.to raise_error(Dry::Types::ConstraintError)
+      end
+    end
+  end
+end

data/spec/vcr_cassettes/customers/save_new_with_country_code_SE.yml

@@ -0,0 +1,56 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.fortnox.se/3/customers/
+    body:
+      encoding: UTF-8
+      string: '{"Customer":{"CountryCode":"SE","Name":"Customer with Swedish country
+        code"}}'
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+      Client-Secret:
+      - 9aBA8ZgsvR
+      Access-Token:
+      - ccaef817-d5d8-4b1c-a316-54f3e55c5c54
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Sat, 31 Aug 2019 18:40:48 GMT
+      Content-Type:
+      - application/json
+      Connection:
+      - close
+      Location:
+      - customers
+      X-Rack-Responsetime:
+      - '1007'
+      X-Uid:
+      - d8955922
+      X-Build:
+      - b1e7c74853
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubdomains
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - sameorigin
+      Referrer-Policy:
+      - strict-origin-when-cross-origin
+    body:
+      encoding: UTF-8
+      string: '{"Customer":{"@url":"https:\/\/api.fortnox.se\/3\/customers\/230","Address1":null,"Address2":null,"City":null,"Country":"Sverige","Comments":null,"Currency":"SEK","CostCenter":null,"CountryCode":"SE","Active":true,"CustomerNumber":"230","DefaultDeliveryTypes":{"Invoice":"PRINT","Order":"PRINT","Offer":"PRINT"},"DefaultTemplates":{"Order":"DEFAULTTEMPLATE","Offer":"DEFAULTTEMPLATE","Invoice":"DEFAULTTEMPLATE","CashInvoice":"DEFAULTTEMPLATE"},"DeliveryAddress1":null,"DeliveryAddress2":null,"DeliveryCity":null,"DeliveryCountry":null,"DeliveryCountryCode":null,"DeliveryFax":null,"DeliveryName":null,"DeliveryPhone1":null,"DeliveryPhone2":null,"DeliveryZipCode":null,"Email":"","EmailInvoice":"","EmailInvoiceBCC":"","EmailInvoiceCC":"","EmailOffer":"","EmailOfferBCC":"","EmailOfferCC":"","EmailOrder":"","EmailOrderBCC":"","EmailOrderCC":"","ExternalReference":null,"Fax":null,"GLN":null,"GLNDelivery":null,"InvoiceAdministrationFee":null,"InvoiceDiscount":null,"InvoiceFreight":null,"InvoiceRemark":"","Name":"Customer
+        with Swedish country code","OrganisationNumber":"","OurReference":"","Phone1":null,"Phone2":null,"PriceList":"A","Project":"","SalesAccount":null,"ShowPriceVATIncluded":false,"TermsOfDelivery":"","TermsOfPayment":"","Type":"COMPANY","VATNumber":"","VATType":"SEVAT","VisitingAddress":null,"VisitingCity":null,"VisitingCountry":null,"VisitingCountryCode":null,"VisitingZipCode":null,"WayOfDelivery":"","WWW":"","YourReference":"","ZipCode":null}}'
+    http_version: 
+  recorded_at: Sat, 31 Aug 2019 18:40:48 GMT
+recorded_with: VCR 4.0.0

data/spec/vcr_cassettes/invoices/save_new_with_country.yml

@@ -23,7 +23,7 @@ http_interactions:
       Server:
       - nginx
       Date:
-      - Mon, 03 Jun 2019 09:59:14 GMT
+      - Sun, 01 Sep 2019 07:02:19 GMT
       Content-Type:
       - application/json
       Connection:
@@ -31,16 +31,26 @@ http_interactions:
       Location:
       - invoices
       X-Rack-Responsetime:
-      - '337'
+      - '87'
       X-Uid:
-      - 651ea5d2
+      - 6b4d3446
       X-Build:
-      - e930a91c78
+      - b1e7c74853
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubdomains
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - sameorigin
+      Referrer-Policy:
+      - strict-origin-when-cross-origin
     body:
       encoding: UTF-8
-      string: '{"Invoice":{"@url":"https:\/\/api.fortnox.se\/3\/invoices\/134","@urlTaxReductionList":"https:\/\/api.fortnox.se\/3\/taxreductions?filter=invoices&referencenumber=134","AdministrationFee":0,"AdministrationFeeVAT":0,"Address1":"","Address2":"","Balance":0,"BasisTaxReduction":0,"Booked":false,"Cancelled":false,"City":"","Comments":"","ContractReference":0,"ContributionPercent":0,"ContributionValue":0,"Country":"Sverige","CostCenter":"","Credit":"false","CreditInvoiceReference":0,"Currency":"SEK","CurrencyRate":1,"CurrencyUnit":1,"CustomerName":"Old
-        name","CustomerNumber":"1","DeliveryAddress1":"","DeliveryAddress2":"","DeliveryCity":"","DeliveryCountry":"","DeliveryDate":null,"DeliveryName":"","DeliveryZipCode":"","DocumentNumber":"134","DueDate":"2019-06-03","EDIInformation":{"EDIGlobalLocationNumber":"","EDIGlobalLocationNumberDelivery":"","EDIInvoiceExtra1":"","EDIInvoiceExtra2":"","EDIOurElectronicReference":"","EDIYourElectronicReference":""},"EmailInformation":{"EmailAddressFrom":null,"EmailAddressTo":"","EmailAddressCC":null,"EmailAddressBCC":null,"EmailSubject":"Faktura
-        {no} bifogas","EmailBody":" "},"EUQuarterlyReport":false,"ExternalInvoiceReference1":"","ExternalInvoiceReference2":"","Freight":0,"FreightVAT":0,"Gross":0,"HouseWork":false,"InvoiceDate":"2019-06-03","InvoicePeriodStart":"","InvoicePeriodEnd":"","InvoiceReference":0,"InvoiceRows":[],"InvoiceType":"INVOICE","Labels":[],"Language":"SV","LastRemindDate":null,"Net":0,"NotCompleted":false,"NoxFinans":false,"OCR":"13458","OfferReference":0,"OrderReference":0,"OrganisationNumber":"860101-8735","OurReference":"","PaymentWay":"","Phone1":"","Phone2":"","PriceList":"A","PrintTemplate":"st","Project":"","WarehouseReady":true,"OutboundDate":"2019-06-03","Remarks":"","Reminders":0,"RoundOff":0,"Sent":false,"TaxReduction":null,"TermsOfDelivery":"","TermsOfPayment":0,"Total":0,"TotalToPay":0,"TotalVAT":0,"VATIncluded":false,"VoucherNumber":null,"VoucherSeries":null,"VoucherYear":null,"WayOfDelivery":"","YourOrderNumber":"","YourReference":"","ZipCode":"","AccountingMethod":"ACCRUAL","FinalPayDate":null}}'
+      string: '{"Invoice":{"@url":"https:\/\/api.fortnox.se\/3\/invoices\/144","@urlTaxReductionList":"https:\/\/api.fortnox.se\/3\/taxreductions?filter=invoices&referencenumber=144","AdministrationFee":0,"AdministrationFeeVAT":0,"Address1":"","Address2":"","Balance":0,"BasisTaxReduction":0,"Booked":false,"Cancelled":false,"City":"","Comments":"","ContractReference":0,"ContributionPercent":0,"ContributionValue":0,"Country":"Sverige","CostCenter":"","Credit":"false","CreditInvoiceReference":0,"Currency":"SEK","CurrencyRate":1,"CurrencyUnit":1,"CustomerName":"Old
+        name","CustomerNumber":"1","DeliveryAddress1":"","DeliveryAddress2":"","DeliveryCity":"","DeliveryCountry":"","DeliveryDate":null,"DeliveryName":"","DeliveryZipCode":"","DocumentNumber":"144","DueDate":"2019-09-01","EDIInformation":{"EDIGlobalLocationNumber":"","EDIGlobalLocationNumberDelivery":"","EDIInvoiceExtra1":"","EDIInvoiceExtra2":"","EDIOurElectronicReference":"","EDIYourElectronicReference":""},"EmailInformation":{"EmailAddressFrom":null,"EmailAddressTo":"","EmailAddressCC":null,"EmailAddressBCC":null,"EmailSubject":"Faktura
+        {no} bifogas","EmailBody":" "},"EUQuarterlyReport":false,"ExternalInvoiceReference1":"","ExternalInvoiceReference2":"","Freight":0,"FreightVAT":0,"Gross":0,"HouseWork":false,"InvoiceDate":"2019-09-01","InvoicePeriodStart":"","InvoicePeriodEnd":"","InvoiceReference":0,"InvoiceRows":[],"InvoiceType":"INVOICE","Labels":[],"Language":"SV","LastRemindDate":null,"Net":0,"NotCompleted":false,"NoxFinans":false,"OCR":"14456","OfferReference":0,"OrderReference":0,"OrganisationNumber":"860101-8735","OurReference":"","PaymentWay":"","Phone1":"","Phone2":"","PriceList":"A","PrintTemplate":"st","Project":"","WarehouseReady":true,"OutboundDate":"2019-09-01","Remarks":"","Reminders":0,"RoundOff":0,"Sent":false,"TaxReduction":null,"TermsOfDelivery":"","TermsOfPayment":0,"Total":0,"TotalToPay":0,"TotalVAT":0,"VATIncluded":false,"VoucherNumber":null,"VoucherSeries":null,"VoucherYear":null,"WayOfDelivery":"","YourOrderNumber":"","YourReference":"","ZipCode":"","AccountingMethod":"ACCRUAL","FinalPayDate":null}}'
     http_version: 
-  recorded_at: Mon, 03 Jun 2019 09:59:15 GMT
+  recorded_at: Sun, 01 Sep 2019 07:02:19 GMT
 recorded_with: VCR 4.0.0