fiscalizer 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b43870b32c90984a5db5c7583c2f70df01916d8d
-  data.tar.gz: ead8268033ac53e50d2a898d346b0ea94f4fed33
+  metadata.gz: a28f77e9a2a9ab8611c8b9115ec048cf8380bbe2
+  data.tar.gz: ed956c0403bf6066779ec8176f4e1da2944693fe
 SHA512:
-  metadata.gz: 5678038340e62778d4541a91494311be302d4ef8e56ca69de343b34d95ce3b0b330f04dfad7d3192b298b5bc1a52e89f7f07436fe798ffc22fc2beed846bf373
-  data.tar.gz: 5dc37bd0a1437c40a445a4039f6595fec9fe21711bdc0c3c59a9cd571430cd31564910f419814288657dd8b4c661a5cdad11ac94aed0d0efebc20233b9c9e416
+  metadata.gz: 27c61c79639ff2642f62f91f7781d9d1553f9a78dc1b34ab60ce559e677374d3975c64de3873df32de0bcd446dd3ea914472ae0450ad397aed074dd40c8cb031
+  data.tar.gz: 55369a83446b63c7788ab86b1afb54e85558a3f01a6bb8f016731ec922a7b9d60db5f1f8a3b2b3efa532cc9b38b999f226bd86b3c7bcfb7b8385c3952efcb11b

data/Gemfile

@@ -3,5 +3,5 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in fiscalizer_ruby.gemspec
 gemspec
 gem 'nokogiri'
-gem 'xmldsig', github: 'infinum/xmldsig', branch: 'allcase-reference-id'
+gem 'xmldsig-fiscalizer'
 #gem 'pry-debugger'

data/doc/README.md

@@ -0,0 +1,3 @@
+# Documentation
+
+Here are all the files that describe the fiscalization API. The Gem is based on the API described in these files.

data/example/README.md

@@ -0,0 +1,25 @@
+# Examples
+
+### echo_12
+
+Demonstrates how to create a Fiscalizer object with a P12 certificate. How to make an echo request and check for, and print, errors.
+
+### echo_public_and_private_keys
+
+Demonstrates how to create a Fiscalizer object from public and private keys and a certificate.
+
+### invoice_fiscalization_passing_object
+
+Demonstrates how to ceate an Invoice object and fiscalize it. It also demonstrates how to create tax and fee objects and add them to the invoice object.
+
+### invoice_fiscalization_passing_arguments
+
+Demonstrates how to create an invoice object and fiscalize ti by passing argumentst to the fiscalize_invoice method.
+
+### fiscalize_office
+
+Demonstrates how to create and fiscalize an office object.
+
+### fiscalize_office
+
+Demonstrates how to create and fiscalize an office space, by passing arguments.

data/example/{invoice_fiscalization_with_arguments.rb → invoice_fiscalization_passing_arguments.rb}

@@ -24,21 +24,21 @@ end
 	taxes_other << tax
 end
 # Generate invoice
-invoice_response = fiscal.invoice 	uuid: UUID,
-									time_sent: Time.now,
-									pin: PIN,
-									in_vat_system: true,
-									time_issued: Time.now - 3600,
-									consistance_mark: "P",
-									issued_number: "1",
-									issued_office: "Pm2",
-									issued_machine: "3",
-									tax_vat: taxes_vat,
-									tax_spending: taxes_spending,
-									tax_other: taxes_other,
-									payment_method: "g",
-									operator_pin: PIN_OPERATOR,
-									subsequent_delivery: false,
-									value_non_taxable: 200.0
+invoice_response = fiscal.fiscalize_invoice 	uuid: UUID,
+												time_sent: Time.now,
+												pin: "00123456789",
+												in_vat_system: true,
+												time_issued: Time.now - 3600,
+												consistance_mark: "P",
+												issued_number: "1",
+												issued_office: "Pm2",
+												issued_machine: "3",
+												tax_vat: taxes_vat,
+												tax_spending: taxes_spending,
+												tax_other: taxes_other,
+												payment_method: "g",
+												operator_pin: "12345678900",
+												subsequent_delivery: false,
+												value_non_taxable: 200.0
 
 puts "The server returned the following JIR: " + invoice_response.unique_identifier if !invoice_response.errors?

data/example/invoice_fiscalization_passing_object.rb

@@ -0,0 +1,48 @@
+fiscal = Fiscalizer.new certificate_p12_path: "/path/to/FISKAL 1.p12",
+						password: "12345678"
+
+# Generate Invoice
+invoice = Fiscalizer::Invoice.new
+invoice.uuid = UUID
+invoice.time_sent = Time.now
+invoice.pin = "00123456789"
+invoice.in_vat_system = true
+invoice.time_issued = Time.now - 3600
+invoice.consistance_mark = "P"
+invoice.issued_number = "1"
+invoice.issued_office = "Pm2"
+invoice.issued_machine = "3"
+invoice.payment_method = "g"
+invoice.operator_pin = "12345678900"
+invoice.subsequent_delivery = false
+invoice.value_non_taxable = 200.0
+
+# Generate taxes
+(0..5).each do |i|
+	tax = Fiscalizer::Tax.new
+	tax.base = rand(10000 * 100).to_f / 100.0
+	tax.rate = rand(100 * 100).to_f / 100.0
+	invoice.add_tax_vat tax
+end
+(0..5).each do |i|
+	tax = Fiscalizer::Tax.new
+	tax.base = rand(10000 * 100).to_f / 100.0
+	tax.rate = rand(100 * 100).to_f / 100.0
+	invoice.add_tax_other base: base, rate: rate, name: "Other tax #{i}" 
+end
+(0..5).each do |i|
+	fee = Fiscalizer::Fee.new
+	fee.value = rand(10000 * 100).to_f / 100.0
+	fee.name = "My Test Fee #{i}"
+	invoice.add_fee fee
+end
+(0..5).each do |i|
+	fee = Fiscalizer::Fee.new
+	fee.value = rand(10000 * 100).to_f / 100.0
+	fee.name = "My Test Fee #{i}"
+	invoice.add_fee value: value, name: name
+end
+# Generate invoice
+invoice_response = fiscal.fiscalize_invoice invoice
+
+puts "The server returned the following JIR: " + invoice_response.unique_identifier if !invoice_response.errors?

data/example/office_fiscalization_passing_arguments.rb

@@ -0,0 +1,22 @@
+fiscal = Fiscalizer.new certificate_p12_path: "/path/to/FISKAL 1.p12",
+						password: "12345678"
+
+# Generate office
+office_response = fiscal.office 	uuid: "ca996cc7-fcc3-4c50-961b-40c8b875a5e8",
+									time_sent: Time.now,
+									pin: "00123456789",
+									office_label: "Poslovnica1",
+									adress_street_name: "Somewhere",
+									adress_house_num: "42",
+									adress_house_num_addendum: "AD",
+									adress_post_num: "10000",
+									adress_settlement: "Block 25-C",
+									adress_township: "Vogsphere",
+									adress_other: nil,
+									office_time: "Pon-Pet: 8:00-16:00",
+									take_effect_date: Time.now + 3600 * 24 * 7,
+									closure_mark: nil,
+									specific_purpose: nil
+
+puts "The server returned the following UUID: " + office_response.uuid if !office_response.errors?
+puts "Office space fiscalization was successful!" if !office_response.errors?

data/example/office_fiscalization_passing_object.rb

@@ -0,0 +1,26 @@
+fiscal = Fiscalizer.new certificate_p12_path: "/path/to/FISKAL 1.p12",
+						password: "12345678"
+
+# Generate office
+office = Fiscalizer::Office.new
+office.uuid = "ca996cc7-fcc3-4c50-961b-40c8b875a5e8"
+office.time_sent = Time.now
+office.pin = "00123456789"
+office.office_label = "Poslovnica1"
+office.adress_street_name = "Somewhere"
+office.adress_house_num = "42"
+office.adress_house_num_addendum = "AD"
+office.adress_post_num = "10000"
+office.adress_settlement = "Block 25-C"
+office.adress_township = "Vogsphere"
+office.adress_other = nil
+office.office_time = "Pon-Pet: 8:00-16:00"
+office.take_effect_date = Time.now + 3600 * 24 * 7
+office.closure_mark = nil
+office.specific_purpose = nil
+
+# Generate office
+office_response = fiscal.fiscalize_office office
+
+puts "The server returned the following UUID: " + office_response.uuid if !office_response.errors?
+puts "Office space fiscalization was successful!" if !office_response.errors?

data/lib/fiscalizer/communication.rb

@@ -135,7 +135,7 @@ class Fiscalizer
 				end
 
 				body = soap_envelope(office_request_xml)
-				unsigned_document = Xmldsig::SignedDocument.new(body.doc.root.to_xml)
+				unsigned_document = Xmldsig_fiscalizer::SignedDocument.new(body.doc.root.to_xml)
 				signed_xml = unsigned_document.sign(@key_private)
 				signed_xml.sub! '<?xml version="1.0"?>', ''
 				signed_xml = signed_xml.gsub /^$\n/, ''
@@ -255,7 +255,7 @@ class Fiscalizer
 				end
 
 				body = soap_envelope(invoice_request_xml)
-				unsigned_document = Xmldsig::SignedDocument.new(body.doc.root.to_xml)
+				unsigned_document = Xmldsig_fiscalizer::SignedDocument.new(body.doc.root.to_xml)
 				signed_xml = unsigned_document.sign(@key_private)
 				signed_xml.sub! '<?xml version="1.0"?>', ''
 				signed_xml = signed_xml.gsub /^$\n/, ''

data/lib/fiscalizer/invoice.rb

@@ -53,26 +53,26 @@ class Fiscalizer
 			end # initialize
 
 			# Add taxes
-			def add_tax_vat base: 0.0, rate: 0.0, name: "", tax: nil
+			def add_tax_vat tax=nil, base: 0.0, rate: 0.0, name: ""
 				tax = Fiscalizer::Tax.new base: base, rate: rate, name: name if tax == nil
 				@tax_vat = Array.new if @tax_vat.class != Array
 				@tax_vat << tax
 			end # add_tax_vat
 
-			def add_tax_spending base: 0.0, rate: 0.0, name: "", tax: nil
+			def add_tax_spending tax=nil, base: 0.0, rate: 0.0, name: ""
 				tax = Fiscalizer::Tax.new base: base, rate: rate, name: name if tax == nil
 				@tax_spending = Array.new if @tax_spending.class != Array
 				@tax_spending << tax
 			end # add_tax_spending
 
-			def add_tax_other base: 0.0, rate: 0.0, name: "", tax: nil
+			def add_tax_other tax=nil, base: 0.0, rate: 0.0, name: ""
 				tax = Fiscalizer::Tax.new base: base, rate: rate, name: name if tax == nil
 				@tax_other = Array.new if @tax_other.class != Array
 				@tax_other << tax
 			end # add_tax_spending
 
 			# Add fees
-			def add_fee name: "", value: 0.0, fee: nil
+			def add_fee fee=nil, name: "", value: 0.0
 				fee = Fiscalizer::Fee.new name: base, value: rate if fee == nil
 				@fee << fee
 			end # add_fee

data/lib/fiscalizer/version.rb

@@ -1,3 +1,3 @@
 class Fiscalizer
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/fiscalizer.rb

@@ -5,4 +5,4 @@ require 'uri'
 require 'net/http'
 require 'openssl'
 require 'nokogiri'
-require 'xmldsig'
+require 'xmldsig_fiscalizer'

data/test/README.md

@@ -0,0 +1,13 @@
+# Test
+
+## Setup
+
+It is important that in test enviroments both a P12 certificate (`certificate_p12_path`) and a signing certificate are passed to the Fiscalizer object (`certificate_path`). This is important because the test P12 certificates (suffixed with `.pfx`) don't contain signing certificates in them!
+
+Don't forget to configutre all static variables in `test_fiscalizer.rb`
+
+`EXPORTED_KEYS` specifies weather to initialize a Fiscalizer object with a P12 key or to use public and private kays instead.
+
+__Note:__ If `EXPORTED_KEYS` is set to `true` than `KEY_PUBLIC_PATH` and `KEY_PRIVATE_PATH` have to be set.
+
+__Note:__ On some machines the path to the certificates has to be an absolut path

data/test/test_fiscalizer.rb

@@ -5,10 +5,10 @@ require 'openssl'
 
 class FiscalizerTest < Test::Unit::TestCase
 	# Configure 
-	KEY_PUBLIC_PATH = "/path/to/fiskal1.cert"
-	KEY_PRIVATE_PATH = "/path/to/privateKey.key"
-	CERTIFICATE_PATH = "/path/to/democacert.pem"
-	CERTIFICATE_P12_PATH = "/path/to/fiskal1.pfx"
+	KEY_PUBLIC_PATH = "/test/assets/fiskal1.cert"
+	KEY_PRIVATE_PATH = "/test/assets/privateKey.key"
+	CERTIFICATE_PATH = "/test/assets/democacert.pem"
+	CERTIFICATE_P12_PATH = "/test/assets/fiskal1.pfx"
 	URL_FISKAL = "https://cistest.apis-it.hr:8449/FiskalizacijaServiceTest"
 	CER_ISSUED = "OU=DEMO,O=FINA,C=HR"
 	PASSWORD = "12345678"
@@ -18,7 +18,7 @@ class FiscalizerTest < Test::Unit::TestCase
 	UUID = "ca996cc7-fcc3-4c50-961b-40c8b875a5e8"
 	ECHO = "This is a simple test..."
 	# Personal information
-	PIN = "00000000000" 
+	PIN = "00123456789" 
 	PIN_OPERATOR = "00000000000"
 
 	def test_initialization
@@ -48,22 +48,29 @@ class FiscalizerTest < Test::Unit::TestCase
 	end # fiscal_ruby_test
 
 	def test_echo
-		fiscal = Fiscalizer.new url: URL_FISKAL, 
-								key_public_path: KEY_PUBLIC_PATH,
-								key_private_path: KEY_PRIVATE_PATH,
-								certificate_path: CERTIFICATE_PATH,
-								certificate_issued_by: CER_ISSUED
+		fiscal = nil
+		if EXPORTED_KEYS
+			fiscal = Fiscalizer.new url: URL_FISKAL, 
+									key_public_path: KEY_PUBLIC_PATH,
+									key_private_path: KEY_PRIVATE_PATH,
+									certificate_path: CERTIFICATE_PATH,
+									certificate_issued_by: CER_ISSUED
+		else
+			fiscal = Fiscalizer.new url: URL_FISKAL,
+									certificate_path: CERTIFICATE_PATH,
+									certificate_p12_path: CERTIFICATE_P12_PATH,
+									certificate_issued_by: CER_ISSUED,
+									password: PASSWORD
+		end
 		echo = fiscal.echo text: ECHO
 		assert_equal ECHO, echo.response, "Echo response message does not match sent message"
 		assert echo.echo?, "Automatic echo check failed"
 	end # test_echo
 
 	def test_office
-		# Configuration
-		use_exported_keys = true
 		# -- Here Be Dragons --
 		fiscal = nil
-		if use_exported_keys
+		if EXPORTED_KEYS
 			fiscal = Fiscalizer.new url: URL_FISKAL, 
 									key_public_path: KEY_PUBLIC_PATH,
 									key_private_path: KEY_PRIVATE_PATH,
@@ -99,11 +106,60 @@ class FiscalizerTest < Test::Unit::TestCase
 		assert office.processed_at != nil, "'Processed at' was not returned"
 	end # test_office
 
+	def test_office_object
+		# -- Here Be Dragons --
+		fiscal = nil
+		if EXPORTED_KEYS
+			fiscal = Fiscalizer.new url: URL_FISKAL, 
+									key_public_path: KEY_PUBLIC_PATH,
+									key_private_path: KEY_PRIVATE_PATH,
+									certificate_path: CERTIFICATE_PATH,
+									certificate_issued_by: CER_ISSUED
+		else
+			fiscal = Fiscalizer.new url: URL_FISKAL,
+									certificate_path: CERTIFICATE_PATH,
+									certificate_p12_path: CERTIFICATE_P12_PATH,
+									certificate_issued_by: CER_ISSUED,
+									password: PASSWORD
+		end
+
+		# Generate office
+		office = Fiscalizer::Office.new
+		office.uuid = UUID
+		office.time_sent = Time.now
+		office.pin = PIN
+		office.office_label = "Poslovnica1"
+		office.adress_street_name = "Somewhere"
+		office.adress_house_num = "42"
+		office.adress_house_num_addendum = "AD"
+		office.adress_post_num = "10000"
+		office.adress_settlement = "Block 25-C"
+		office.adress_township = "Vogsphere"
+		office.adress_other = nil
+		office.office_time = "Pon-Pet: 8:00-16:00"
+		office.take_effect_date = Time.now + 3600 * 24 * 7
+		office.closure_mark = nil
+		office.specific_purpose = nil
+
+		# Generate office
+		office_response = fiscal.fiscalize_office office
+
+		if office_response.errors?
+			puts "There were some nasty errors!"
+			office_response.errors.each do |error_code, error_message|
+				puts "	" + error_code + " : " + error_message
+			end
+		end
+
+		assert !office_response.errors?, "Returned an error"
+		assert office_response.uuid != nil, "'UUID' was not returned"
+		assert office_response.processed_at != nil, "'Processed at' was not returned"
+	end # test_office_object
+
 	def test_invoice
-		use_exported_keys = true
 		# -- Here Be Dragons --
 		fiscal = nil
-		if use_exported_keys
+		if EXPORTED_KEYS
 			fiscal = Fiscalizer.new url: URL_FISKAL, 
 									key_public_path: KEY_PUBLIC_PATH,
 									key_private_path: KEY_PRIVATE_PATH,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fiscalizer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Stanko Krtalić Rusendić
@@ -79,12 +79,16 @@ files:
 - README.md
 - Rakefile
 - doc/FiskalizacijaSchema.xsd
+- doc/README.md
 - doc/Tehnicka_specifikacija_za_korisnike_1.2.pdf
 - doc/fiskalizacija_faq_v2.1_objava.pdf
+- example/README.md
 - example/echo_P12.rb
 - example/echo_public_and_private_keys.rb
+- example/invoice_fiscalization_passing_arguments.rb
 - example/invoice_fiscalization_passing_object.rb
-- example/invoice_fiscalization_with_arguments.rb
+- example/office_fiscalization_passing_arguments.rb
+- example/office_fiscalization_passing_object.rb
 - fiscalizer.gemspec
 - lib/README.md
 - lib/fiscalizer.rb
@@ -98,6 +102,7 @@ files:
 - lib/fiscalizer/response.rb
 - lib/fiscalizer/tax.rb
 - lib/fiscalizer/version.rb
+- test/README.md
 - test/test_echo.rb
 - test/test_fee
 - test/test_fiscalizer.rb
@@ -130,6 +135,7 @@ signing_key:
 specification_version: 4
 summary: A gem that automatically handles fiscalization
 test_files:
+- test/README.md
 - test/test_echo.rb
 - test/test_fee
 - test/test_fiscalizer.rb