pagopa-soap 0.1.0

data/lib/soap/string.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Soap; end
+
+module Soap::String
+  def self.snakecase(str)
+    str = str.dup
+    str.gsub!(/::/, "/")
+    str.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+    str.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+    str.tr!(".", "_")
+    str.tr!("-", "_")
+    str.downcase!
+    str
+  end
+
+  def self.camelcase(str)
+    str.split("_").collect(&:capitalize).join
+  end
+
+  def self.wsdl_camelcase(str)
+    str_split = str.split("_")
+    return str_split.first if str_split.count == 1
+    first_split = str_split.delete_at(0)
+    last_split = str_split.delete_at(str_split.count - 1)
+    if last_split.length <= 3
+      last_split.upcase!
+    else
+      last_split.capitalize!
+    end
+    "#{first_split}#{str_split.collect(&:capitalize).join}#{last_split}"
+  end
+end

data/lib/soap/webservice.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+module Soap; end
+module Soap::Webservice; end

data/lib/soap/webservice/client.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "savon"
+
+module Soap; end
+module Soap::Webservice; end
+
+class Soap::Webservice::Client
+  class << self
+    def endpoint
+      "#{namespace}#{action}"
+    end
+  end
+
+  def client
+    @client ||=
+      Savon.client(
+        endpoint: self.class.endpoint,
+        namespace: self.class.namespace,
+        convert_request_keys_to: :none,
+        pretty_print_xml: true,
+        follow_redirects: true,
+        headers: {
+          "User-Agent" =>
+            "Ruby Wrapper for pagoPA (#{PagoPA::SOAP::VERSION})",
+          "Cache-Control" => "no-cache",
+          "Accept-Encoding" => "gzip, deflate"
+        }
+      )
+  end
+
+  def send(request)
+    response.new(
+      client.call(Soap.to_snakecase(self.class.action), request.to_message)
+    )
+  end
+end

data/lib/soap/webservice/error.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Soap; end
+module Soap::Webservice; end
+
+class Soap::Webservice::Error < StandardError
+  attr_reader :response
+
+  def initialize(response)
+    @reseponse = response
+  end
+end
+
+class Soap::Webservice::GenericError < StandardError
+  def initialize
+  end
+end

data/lib/soap/webservice/fault_error.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Soap; end
+module Soap::Webservice; end
+
+class Soap::Webservice::FaultError
+  attr_reader :response
+
+  def initialize(response)
+    @response = response
+  end
+end

data/lib/soap/webservice/request.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module Soap; end
+module Soap::Webservice; end
+
+class Soap::Webservice::Request
+  class << self
+    def header_attributes; {} end
+
+    def body_attributes; {} end
+  end
+
+  attr_reader :attributes
+
+  def initialize(attributes = {})
+    @attributes = attributes
+    validate_header_attrs!
+    validate_body_attrs!
+  end
+
+  def validate_header_attrs!
+    return if required_header.empty?
+    if !required_header.empty? && attributes.empty?
+      raise "Required attributes are missing: #{required_header}"
+    end
+
+    if !(required_header - attributes.keys).empty?
+      raise "Attribute #{required_header - attributes.keys} must be present"
+    end
+  end
+
+  def validate_body_attrs!
+    return if required_body.empty?
+    if !required_body.empty? && attributes.empty?
+      raise "Required attributes are missing: #{required_body}"
+    end
+
+    if !(required_body - attributes.keys).empty?
+      raise "Attribute #{required_body - attributes.keys} must be present"
+    end
+  end
+
+  def body_params
+    return {} if self.class.body_attributes.nil?
+    self.class.body_attributes.each.with_object({}) do |attr, attrs|
+      name = Soap.to_snakecase(attr[:name]).to_sym
+      value = attributes[name]
+      attrs[name] = value if value
+    end
+  end
+
+  def header_params
+    return {} if self.class.header_attributes.nil?
+    self.class.header_attributes.each.with_object({}) do |attr, attrs|
+      name = Soap.to_snakecase(attr[:name]).to_sym
+      value = attributes[name]
+      attrs[name] = value if value
+    end
+  end
+
+  def to_message
+    {
+      soap_header: header_params,
+      message: body_params
+    }
+  end
+
+  def to_xml
+    Gyoku.xml(
+      to_message,
+      key_converter: lambda { |key| Soap.to_camelcase(key) }
+    )
+  end
+
+  private
+
+  def list_header_attrs
+    return {} if self.class.header_attributes.nil?
+    self.class.header_attributes.each.with_object(
+      required: [],
+      optional: []
+    ) do |attr, attrs|
+      name = Soap.to_snakecase(attr[:name]).to_sym
+      if attr[:attributes].empty?
+        attrs[:required] << name
+      else
+        attrs[:optional] << name
+      end
+    end
+  end
+
+  def list_body_attrs
+    return {} if self.class.body_attributes.nil?
+    self.class.body_attributes.each.with_object(
+      required: [],
+      optional: []
+    ) do |attr, attrs|
+      name = Soap.to_snakecase(attr[:name]).to_sym
+      if attr[:attributes].empty?
+        attrs[:required] << name
+      else
+        attrs[:optional] << name
+      end
+    end
+  end
+
+  def required_header
+    list_header_attrs[:required] || []
+  end
+
+  def required_body
+    list_body_attrs[:required] || []
+  end
+
+  def required_attrs
+    required_header + required_body
+  end
+end

data/lib/soap/webservice/response.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Soap; end
+module Soap::Webservice; end
+
+class Soap::Webservice::Response
+  class << self
+    def header_attributes; {} end
+
+    def body_attributes; {} end
+  end
+
+  attr_reader :response
+  attr_reader :errors
+
+  def initialize(response)
+    @response = response
+    @errors = []
+
+    validate_errors!
+    validate_body_attrs!
+  end
+
+  # rubocop:disable all
+  def validate_errors!
+    case response.http.code
+    when 200
+      errors << Soap::Webservice::FaultError.new(response)
+    when 500
+      errors << Soap::Webservice::Error.new(response)
+    else
+      errors << Soap::Webservice::GenericError.new(response)
+    end
+  end
+  # rubocop:enable all
+
+  def validate_body_attrs!
+    return if required_body.empty?
+    if !required_body.empty? && attributes.empty?
+      raise "Required attributes are missing #{required_body}"
+    end
+
+    if !(required_body - attributes.keys).empty?
+      raise "Attribute #{required_body - attributes.keys} must be present"
+    end
+  end
+
+  def header
+    response.header
+  end
+
+  def body
+    response.body
+  end
+
+  def decoded_body
+    response.body
+  end
+
+  def to_xml
+    response.to_xml
+  end
+
+  private
+
+  def list_body_attrs
+    return {} if self.class.body_attributes.nil?
+    self.class.body_attributes.each.with_object(
+      required: [],
+      optional: []
+    ) do |attr, attrs|
+      name = Soap.to_snakecase(attr[:name]).to_sym
+      if attr[:attributes].empty?
+        attrs[:required] << name
+      else
+        attrs[:optional] << name
+      end
+    end
+  end
+
+  def required_body
+    list_body_attrs[:required] || []
+  end
+
+  def required_attrs
+    required_body
+  end
+end

data/pagopa-soap.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pago_pa/soap/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pagopa-soap"
+  spec.version       = PagoPA::SOAP::VERSION
+  spec.authors       = ["Damiano Giacomello"]
+  spec.email         = ["giacomello.damiano@gmail.com"]
+
+  spec.summary       = "Ruby Wrapper for pagoPA SOAP API"
+  spec.description   = "Ruby Wrapper for pagoPA SOAP API based on Savon"
+  spec.homepage      = "https://github.com/italia/pagopa-soap-ruby"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.required_ruby_version = ">= 2.3.0"
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "gyoku", "~> 1.3.1"
+  spec.add_dependency "nori", "~> 2.6"
+  spec.add_dependency "savon", "~> 2.12.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "coveralls", "~> 0"
+  spec.add_development_dependency "pry", "~> 0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "0.57.2"
+  spec.add_development_dependency "rubocop-rspec", "1.27.0"
+  spec.add_development_dependency "webmock", ">= 3.4.2"
+end

data/resources/PaPerNodo.wsdl

@@ -0,0 +1,214 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Questo WSDL rappresenta l'interfaccia esposta dalla PAA
+  per la ricezione delle Ricevute Telematiche
+-->
+<wsdl:definitions 
+	xmlns:wsam="http://www.w3.org/2007/05/addressing/metadata" 
+	xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" 
+	xmlns:ppt="http://ws.pagamenti.telematici.gov/" 
+	xmlns:ppthead="http://ws.pagamenti.telematici.gov/ppthead" 
+	xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
+	xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" 
+	xmlns:tns="http://NodoPagamentiSPC.spcoop.gov.it/servizi/PagamentiTelematiciRT"
+	name="PPT" 
+	targetNamespace="http://NodoPagamentiSPC.spcoop.gov.it/servizi/PagamentiTelematiciRT">
+	<wsdl:types>
+		<xsd:schema version="2.1" targetNamespace="http://ws.pagamenti.telematici.gov/ppthead">
+			<xsd:simpleType name="stText35">
+				<xsd:restriction base="xsd:string">
+					<xsd:minLength value="1" />
+					<xsd:maxLength value="35" />
+				</xsd:restriction>
+			</xsd:simpleType>
+			<xsd:element name="intestazionePPT">
+				<xsd:complexType>
+					<xsd:sequence>
+						<xsd:element name="identificativoIntermediarioPA" type="ppthead:stText35" />
+						<xsd:element name="identificativoStazioneIntermediarioPA" type="ppthead:stText35" />
+						<xsd:element name="identificativoDominio" type="ppthead:stText35" />
+						<xsd:element name="identificativoUnivocoVersamento" type="ppthead:stText35" />
+						<xsd:element name="codiceContestoPagamento" type="ppthead:stText35" />
+					</xsd:sequence>
+				</xsd:complexType>
+			</xsd:element>
+		</xsd:schema>
+		<xsd:schema version="1.0" targetNamespace="http://ws.pagamenti.telematici.gov/">
+			<xsd:simpleType name="stText35">
+				<xsd:restriction base="xsd:string">
+					<xsd:minLength value="1" />
+					<xsd:maxLength value="35" />
+				</xsd:restriction>
+			</xsd:simpleType>
+			<!-- Wrapper Elements -->
+			<xsd:element name="paaInviaRT" type="ppt:paaInviaRT" />
+			<xsd:element name="paaInviaRTRisposta" type="ppt:paaInviaRTRisposta" />
+			
+			<xsd:element name="paaInviaEsitoStorno" type="ppt:paaInviaEsitoStorno" />
+			<xsd:element name="paaInviaEsitoStornoRisposta" type="ppt:paaInviaEsitoStornoRisposta" />
+			
+			<xsd:element name="paaInviaRichiestaRevoca" type="ppt:paaInviaRichiestaRevoca" />
+			<xsd:element name="paaInviaRichiestaRevocaRisposta" type="ppt:paaInviaRichiestaRevocaRisposta" />
+			
+			<!-- Element Definition -->
+			<xsd:complexType name="paaInviaRT">
+				<xsd:sequence>
+					<xsd:element name="tipoFirma" type="xsd:string" />
+					<xsd:element name="rt" type="xsd:base64Binary" />
+				</xsd:sequence>
+			</xsd:complexType>
+			<xsd:complexType name="paaInviaRTRisposta">
+				<xsd:sequence>
+					<xsd:element name="paaInviaRTRisposta" type="ppt:esitoPaaInviaRT" />
+				</xsd:sequence>
+			</xsd:complexType>
+			<xsd:complexType name="esitoPaaInviaRT">
+				<xsd:complexContent>
+					<xsd:extension base="ppt:risposta">
+						<xsd:sequence>
+							<xsd:element name="esito" type="xsd:string" minOccurs="0" />
+						</xsd:sequence>
+					</xsd:extension>
+				</xsd:complexContent>
+			</xsd:complexType>
+			<xsd:complexType name="risposta">
+				<xsd:sequence>
+					<xsd:element name="fault" type="ppt:faultBean" minOccurs="0" />
+				</xsd:sequence>
+			</xsd:complexType>
+			<xsd:complexType name="faultBean">
+				<xsd:sequence>
+					<xsd:element name="faultCode" type="xsd:string" />
+					<xsd:element name="faultString" type="xsd:string" />
+					<xsd:element name="id" type="xsd:string" />
+					<xsd:element name="description" type="xsd:string" minOccurs="0" />
+					<xsd:element name="serial" type="xsd:int" minOccurs="0" />
+					<xsd:element name="originalFaultCode" type="xsd:string"  minOccurs="0"  />
+					<xsd:element name="originalFaultString" type="xsd:string"  minOccurs="0"  />
+					<xsd:element name="originalDescription" type="xsd:string" minOccurs="0" />
+				</xsd:sequence>
+			</xsd:complexType>
+			
+			<xsd:complexType name="paaInviaEsitoStorno">
+				<xsd:sequence>
+					<xsd:element name="identificativoIntermediarioPA" type="ppt:stText35" />
+					<xsd:element name="identificativoStazioneIntermediarioPA" type="ppt:stText35" />
+					<xsd:element name="identificativoDominio" type="ppt:stText35" />
+					<xsd:element name="identificativoUnivocoVersamento" type="ppt:stText35" />
+					<xsd:element name="codiceContestoPagamento" type="ppt:stText35" />
+					<xsd:element name="er" type="xsd:base64Binary" />
+				</xsd:sequence>
+			</xsd:complexType>
+			
+			<xsd:complexType name="paaInviaEsitoStornoRisposta">
+				<xsd:sequence>
+					<xsd:element name="paaInviaEsitoStornoRisposta" type="ppt:tipoInviaEsitoStornoRisposta" />
+				</xsd:sequence>
+			</xsd:complexType>
+			
+			<xsd:complexType name="tipoInviaEsitoStornoRisposta">
+				<xsd:complexContent>
+					<xsd:extension base="ppt:risposta">
+						<xsd:sequence>
+							<xsd:element name="esito" type="xsd:string" minOccurs="0" />
+						</xsd:sequence>
+					</xsd:extension>
+				</xsd:complexContent>
+			</xsd:complexType>
+			
+			<xsd:complexType name="paaInviaRichiestaRevoca">
+				<xsd:sequence>
+					<xsd:element name="identificativoDominio" type="ppt:stText35" />
+					<xsd:element name="identificativoUnivocoVersamento" type="ppt:stText35" />
+					<xsd:element name="codiceContestoPagamento" type="ppt:stText35" />
+					<xsd:element name="rr" type="xsd:base64Binary" />
+				</xsd:sequence>
+			</xsd:complexType>
+			
+			<xsd:complexType name="paaInviaRichiestaRevocaRisposta">
+				<xsd:sequence>
+					<xsd:element name="paaInviaRichiestaRevocaRisposta" type="ppt:tipoInviaRichiestaRevocaRisposta" />
+				</xsd:sequence>
+			</xsd:complexType>
+			
+			<xsd:complexType name="tipoInviaRichiestaRevocaRisposta">
+				<xsd:complexContent>
+					<xsd:extension base="ppt:risposta">
+						<xsd:sequence>
+							<xsd:element name="esito" type="xsd:string" minOccurs="0" />
+						</xsd:sequence>
+					</xsd:extension>
+				</xsd:complexContent>
+			</xsd:complexType>
+		</xsd:schema>
+    </wsdl:types>
+	<wsdl:message name="paaInviaRT">
+		<wsdl:part name="bodyrichiesta" element="ppt:paaInviaRT" />
+		<wsdl:part name="header" element="ppthead:intestazionePPT" />
+	</wsdl:message>
+	<wsdl:message name="paaInviaRTResponse">
+		<wsdl:part name="bodyrisposta" element="ppt:paaInviaRTRisposta" />
+	</wsdl:message>
+	<wsdl:message name="paaInviaEsitoStorno">
+		<wsdl:part name="bodyrichiesta" element="ppt:paaInviaEsitoStorno" />
+	</wsdl:message>
+	<wsdl:message name="paaInviaEsitoStornoResponse">
+		<wsdl:part name="bodyrisposta" element="ppt:paaInviaEsitoStornoRisposta" />
+	</wsdl:message>
+	<wsdl:message name="paaInviaRichiestaRevoca">
+		<wsdl:part name="bodyrichiesta" element="ppt:paaInviaRichiestaRevoca" />
+	</wsdl:message>
+	<wsdl:message name="paaInviaRichiestaRevocaResponse">
+		<wsdl:part name="bodyrisposta" element="ppt:paaInviaRichiestaRevocaRisposta" />
+	</wsdl:message>
+	<wsdl:portType name="PagamentiTelematiciRT">
+		<wsdl:operation name="paaInviaRT">
+			<wsdl:input message="tns:paaInviaRT" wsam:Action="http://ws.pagamenti.telematici.gov/PPT/paaInviaRTRichiesta" />
+			<wsdl:output message="tns:paaInviaRTResponse" wsam:Action="http://ws.pagamenti.telematici.gov/PPT/paaInviaRTRisposta" />
+		</wsdl:operation>
+		<wsdl:operation name="paaInviaEsitoStorno">
+			<wsdl:input message="tns:paaInviaEsitoStorno" wsam:Action="http://ws.pagamenti.telematici.gov/PPT/paaInviaEsitoStornoRichiesta" />
+			<wsdl:output message="tns:paaInviaEsitoStornoResponse" wsam:Action="http://ws.pagamenti.telematici.gov/PPT/paaInviaEsitoStornoRisposta" />
+		</wsdl:operation>
+		<wsdl:operation name="paaInviaRichiestaRevoca">
+			<wsdl:input message="tns:paaInviaRichiestaRevoca" wsam:Action="http://ws.pagamenti.telematici.gov/PPT/paaInviaRichiestaRevocaRichiesta" />
+			<wsdl:output message="tns:paaInviaRichiestaRevocaResponse" wsam:Action="http://ws.pagamenti.telematici.gov/PPT/paaInviaRichiestaRevocaRisposta" />
+		</wsdl:operation>
+	</wsdl:portType>
+	<wsdl:binding name="PagamentiTelematiciRTbinding" type="tns:PagamentiTelematiciRT">
+		<soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http" />
+		<wsdl:operation name="paaInviaRT">
+			<soap:operation soapAction="paaInviaRT" />
+			<wsdl:input>
+				<soap:body parts="bodyrichiesta" use="literal" />
+				<soap:header message="tns:paaInviaRT" part="header" use="literal" />
+			</wsdl:input>
+			<wsdl:output>
+				<soap:body use="literal" />
+			</wsdl:output>
+		</wsdl:operation>
+		<wsdl:operation name="paaInviaEsitoStorno">
+			<soap:operation soapAction="paaInviaEsitoStorno" />
+			<wsdl:input>
+				<soap:body use="literal" />
+			</wsdl:input>
+			<wsdl:output>
+				<soap:body use="literal" />
+			</wsdl:output>
+		</wsdl:operation>
+		<wsdl:operation name="paaInviaRichiestaRevoca">
+			<soap:operation soapAction="paaInviaRichiestaRevoca" />
+			<wsdl:input>
+				<soap:body use="literal" />
+			</wsdl:input>
+			<wsdl:output>
+				<soap:body use="literal" />
+			</wsdl:output>
+		</wsdl:operation>
+	</wsdl:binding>
+	<wsdl:service name="PagamentiTelematiciRTservice">
+		<wsdl:port name="PPTPort" binding="tns:PagamentiTelematiciRTbinding">
+			<soap:address location="http://NodoPagamentiSPC.spcoop.gov.it/" />
+		</wsdl:port>
+	</wsdl:service>
+</wsdl:definitions>