kono_epp_client 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a4bd5d2aace0903e87fdb0dfa0e5c0b6d6c5252bc174536eeae420c07334197
-  data.tar.gz: e40f8a2a045e31022ab9dcf011e9a5b6eb03f89f798054e9b6d096263583cce8
+  metadata.gz: 2c14b24f2b061e44d80192c0e9612382f6f3f2f159bb3266c3750968dc56640d
+  data.tar.gz: bb38b49904a2b3205a270fb0d308cab943a710c54879cc193d2bacc868d16c95
 SHA512:
-  metadata.gz: c13b257e76b8e742e42f6636e00c9b138ccedabedb26f96dfadcc68ab9b3b7f535258c27789aaa5a803e2265dec08ace2ad9bd4abf2791dbfb4080207c4fd393
-  data.tar.gz: e782dd2e967c202cc9e85c37e0ecc7befc605d4a77f3b83c86878dc3a002433c99cb70441a5cf81e15b631fa8433bf9e534f60a86f4c06bacb7679b14a57ce66
+  metadata.gz: 4361d5610d860fd4d1bcadebe2dfb68eb19f52a12bd7e49eff016eec4ca756229efc69a3fc4473d9be7a4a622e7d993c52a8befb6bf0d7342e4c2fb28fbeee1d
+  data.tar.gz: 84f087306f9ce8b5fb2f16dc50e5022063e588b9535847e8edd85b6ad3fadc1d3f6e4d40815ff44e344a745101b4ec42ffb9377479ff0a8a240c801dc2fa6841

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+All notable changes to this project will be documented in this file. See [conventional commits](https://www.conventionalcommits.org/) for commit guidelines.
+
+- - -
+## 0.1.1 - 2024-05-23
+#### Continuous Integration
+- Cog typo - (f91c1b9) - Marino Bonetti
+#### Features
+- Add configuration options for transport - (d83d723) - Marino Bonetti
+#### Miscellaneous Chores
+- Configuration for development and deploy - (563edac) - Marino Bonetti
+#### Tests
+- Fix methods non present in std - (e0393ff) - Marino Bonetti
+
+- - -
+
+Changelog generated by [cocogitto](https://github.com/cocogitto/cocogitto).

data/README.md

@@ -1,2 +1,18 @@
 # kono_epp_client
 A simple EPP Client
+
+
+
+## Development
+Build dell'immagine di docker
+```shell
+docker compose build
+```
+Installazione dipendenze
+```shell
+docker compose run app bundle
+```
+Run rspec
+```shell
+docker compose run app bundle exec rspec
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/kono_epp_client.gemspec

@@ -0,0 +1,39 @@
+require_relative "lib/kono_epp_client/version"
+
+Gem::Specification.new do |s|
+  s.name = 'kono_epp_client'
+  s.version = KonoEppClient::VERSION
+  s.date = '2019-10-08'
+  s.summary = "Kono Epp client"
+  s.description = "A simple EPP Client"
+  s.authors = ["Fabio Bonelli", "Jury Ghidinelli", "Marino Bonetti"]
+  s.email = ['jury@archimedianet.it', 'marinobonetti@gmail.com']
+  s.files = ["lib/kono_epp_client.rb"]
+  s.homepage = 'https://github.com/ArchimediaZerogroup/kono_epp_client'
+  s.license = 'MIT'
+
+  s.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*[
+          "bin/", "test/", "spec/", "features/",
+          ".git", ".gitlab-ci.yml", "appveyor", "Gemfile",
+          "cog.toml", "docker-compose.yml", "Dockerfile",
+          ".rspec", ".rubocop.yml"
+        ])
+    end
+  end
+
+  files = `git ls-files -z`.split("\x0")
+  s.test_files = files.grep(%r{^(spec)/})
+
+  s.add_dependency 'activesupport', '>= 5.2'
+  s.add_dependency 'rexml'
+  s.add_dependency 'nokogiri', '>= 1.10'
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "super_diff"
+  s.add_development_dependency "rspec-html-matchers"
+  s.add_development_dependency 'rspec-snapshot'
+
+end

data/lib/epp/server.rb

@@ -5,7 +5,9 @@ module KonoEppClient #:nodoc:
 
     require 'nokogiri'
 
-    attr_accessor :tag, :password, :server, :port, :ssl_version, :old_server, :services, :lang, :extensions, :version, :credit, :timeout
+    attr_accessor :tag, :password, :server, :port, :ssl_version, :old_server,
+                  :services, :lang, :extensions, :version, :credit, :timeout,
+                  :transport, :transport_options
 
     # ==== Required Attrbiutes
     #
@@ -23,6 +25,7 @@ module KonoEppClient #:nodoc:
     # * <tt>:extensions</tt> - URLs to custom extensions to standard EPP. Use these to extend the standard EPP (e.g., Nominet uses extensions). Defaults to none.
     # * <tt>:version</tt> - Set the EPP version. Defaults to "1.0".
     # * <tt>:transport</tt> - Type of connection (http or tcp). Default to "tcp"
+    # * <tt>:transport_options</tt> - Overrides for transport configurations. Default to {}
     # * <tt>:timeout</tt> - Timeou for connections in seconds. Default to "30"
     # * <tt>:ssl_version</tt> - Version of the ssl protocol versione. Default to TLSv1
     # * <tt>:ssl_version</tt> - Version of the ssl protocol versione. Default to TLSv1
@@ -30,20 +33,21 @@ module KonoEppClient #:nodoc:
     def initialize(attributes = {})
       requires!(attributes, :tag, :password, :server)
 
-      @tag          = attributes[:tag]
-      @password     = attributes[:password]
-      @server       = attributes[:server]
-      @port         = attributes[:port]        || 700
-      @old_server   = attributes[:old_server]  || false
-      @lang         = attributes[:lang]        || "en"
-      @services     = attributes[:services]    || ["urn:ietf:params:xml:ns:domain-1.0", "urn:ietf:params:xml:ns:contact-1.0", "urn:ietf:params:xml:ns:host-1.0"]
-      @extensions   = attributes[:extensions]  || []
-      @version      = attributes[:version]     || "1.0"
-      @transport    = attributes[:transport]   || :tcp
-      @timeout      = attributes[:timeout]     || 30
-      @ssl_version  = attributes[:ssl_version] || :TLSv1
-
-      @logged_in  = false
+      @tag = attributes[:tag]
+      @password = attributes[:password]
+      @server = attributes[:server]
+      @port = attributes[:port] || 700
+      @old_server = attributes[:old_server] || false
+      @lang = attributes[:lang] || "en"
+      @services = attributes[:services] || ["urn:ietf:params:xml:ns:domain-1.0", "urn:ietf:params:xml:ns:contact-1.0", "urn:ietf:params:xml:ns:host-1.0"]
+      @extensions = attributes[:extensions] || []
+      @version = attributes[:version] || "1.0"
+      @transport = attributes[:transport] || :tcp
+      @transport_options = attributes[:transport_options] || {}
+      @timeout = attributes[:timeout] || 30
+      @ssl_version = attributes[:ssl_version] || :TLSv1
+
+      @logged_in = false
     end
 
     def connect_and_hello
@@ -61,13 +65,13 @@ module KonoEppClient #:nodoc:
     # <tt><login></tt> and <tt><logout></tt> requests are also wrapped
     # around the request, so we can close the socket immediately after
     # the request is made.
-    def request( xml )
+    def request(xml)
       # open_connection
 
       # @logged_in = true if login
 
       begin
-        @response = send_request( xml )
+        @response = send_request(xml)
       ensure
         if @logged_in && !old_server
           @logged_in = false if logout
@@ -79,7 +83,7 @@ module KonoEppClient #:nodoc:
 
     # Sends a standard login request to the EPP server.
     def login
-      login = KonoEppLogin.new( tag, password )
+      login = KonoEppLogin.new(tag, password)
 
       # FIXME: Order matters
       login.version = version
@@ -88,11 +92,11 @@ module KonoEppClient #:nodoc:
       login.services = services
       login.extensions = extensions
 
-      send_command( login )
+      send_command(login)
     end
 
-    def change_password( new_password )
-      login = KonoEppLogin.new( tag, password )
+    def change_password(new_password)
+      login = KonoEppLogin.new(tag, password)
 
       # FIXME: Order matters
       login.new_password = new_password
@@ -103,7 +107,7 @@ module KonoEppClient #:nodoc:
       login.services = services
       login.extensions = extensions
 
-      send_command( login )
+      send_command(login)
     end
 
     def logged_in?
@@ -118,145 +122,145 @@ module KonoEppClient #:nodoc:
 
     # FIXME: Remove command wrappers?
     def hello
-      send_request( KonoEppHello.new.to_s )
+      send_request(KonoEppHello.new.to_s)
     end
 
-    def poll( id = nil )
-      poll = KonoEppPoll.new( id ? :ack : :req )
+    def poll(id = nil)
+      poll = KonoEppPoll.new(id ? :ack : :req)
 
       poll.ack_id = id if id
 
-      send_command( poll )
+      send_command(poll)
     end
 
-    def create_contact( options )
+    def create_contact(options)
       contact = KonoEppCreateContact.new options
-      send_command( contact )
+      send_command(contact)
     end
 
     def check_contacts(ids)
-      send_command( KonoEppCheckContacts.new(ids) )
+      send_command(KonoEppCheckContacts.new(ids))
     end
 
-    def delete_contact( id )
+    def delete_contact(id)
       contact = KonoEppDeleteContact.new id
-      send_command( contact )
+      send_command(contact)
     end
 
-    def update_contact( options )
+    def update_contact(options)
       contact = KonoEppUpdateContact.new options
-      send_command( contact )
+      send_command(contact)
     end
 
-    def create_domain( options )
+    def create_domain(options)
       domain = KonoEppCreateDomain.new options
-      send_command( domain )
+      send_command(domain)
     end
 
-    def check_domains( *domains )
-      send_command( KonoEppCheckDomains.new *domains )
+    def check_domains(*domains)
+      send_command(KonoEppCheckDomains.new *domains)
     end
 
-    def update_domain( options )
+    def update_domain(options)
       domain = KonoEppUpdateDomain.new options
-      send_command( domain )
+      send_command(domain)
     end
 
-    def delete_domain( name )
+    def delete_domain(name)
       domain = KonoEppDeleteDomain.new name
-      send_command( domain )
+      send_command(domain)
     end
 
-    def info_contact( id )
+    def info_contact(id)
       contact = KonoEppInfoContact.new id
-      send_command( contact )
+      send_command(contact)
     end
 
-    def info_domain( name )
+    def info_domain(name)
       info = KonoEppInfoDomain.new name
-      send_command( info )
+      send_command(info)
     end
 
     def transfer_domain(name, authinfo, op, extension: nil)
-      send_command(KonoEppTransferDomain.new( name, authinfo, op, extension: extension))
+      send_command(KonoEppTransferDomain.new(name, authinfo, op, extension: extension))
     end
 
     # Sends a standard logout request to the EPP server.
     def logout
-      send_command( KonoEppLogout.new, 1500 )
+      send_command(KonoEppLogout.new, 1500)
     end
 
-# private
+    # private
     # Wrapper which sends XML to the server, and receives
     # the response in return.
-    def send_request( xml )
-      write( xml )
+    def send_request(xml)
+      write(xml)
       read
     end
 
-    def send_command( command, expected_result = 1000..1999 )
-      namespaces = { 'extepp' => 'http://www.nic.it/ITNIC-EPP/extepp-2.0',
-                     'xmlns' => "urn:ietf:params:xml:ns:epp-1.0" }
+    def send_command(command, expected_result = 1000..1999)
+      namespaces = {'extepp' => 'http://www.nic.it/ITNIC-EPP/extepp-2.0',
+                    'xmlns' => "urn:ietf:params:xml:ns:epp-1.0"}
 
-      xml = Nokogiri.XML( send_request( command.to_s ) )
+      xml = Nokogiri.XML(send_request(command.to_s))
 
       # TODO: multiple <response> RFC 3730 §2.6
-      result = xml.at_xpath( "/xmlns:epp/xmlns:response[1]/xmlns:result",
-                             namespaces )
-      raise KonoEppErrorResponse.new( :message => 'Malformed response' ) if result.nil?
+      result = xml.at_xpath("/xmlns:epp/xmlns:response[1]/xmlns:result",
+                            namespaces)
+      raise KonoEppErrorResponse.new(:message => 'Malformed response') if result.nil?
 
-      xmlns_code = result.at_xpath( "@code" )
-      raise KonoEppErrorResponse.new( :message => 'Malformed response' ) if xmlns_code.nil?
+      xmlns_code = result.at_xpath("@code")
+      raise KonoEppErrorResponse.new(:message => 'Malformed response') if xmlns_code.nil?
 
       response_code = xmlns_code.value.to_i
 
-      xmlns_msg = result.xpath( "xmlns:msg/text ()",
-                                namespaces )
-      raise KonoEppErrorResponse.new( :message => 'Malformed response' ) if xmlns_msg.empty?
+      xmlns_msg = result.xpath("xmlns:msg/text ()",
+                               namespaces)
+      raise KonoEppErrorResponse.new(:message => 'Malformed response') if xmlns_msg.empty?
 
       result_message = xmlns_msg.text.strip
 
       # TODO: value
 
-      xmlns_ext_reason = result.xpath( "xmlns:extValue/xmlns:reason",
-                                       namespaces)
+      xmlns_ext_reason = result.xpath("xmlns:extValue/xmlns:reason",
+                                      namespaces)
       result_message += ": #{xmlns_ext_reason.text.strip}" unless xmlns_ext_reason.empty?
 
-      xmlns_reason_code = result.xpath( "xmlns:extValue/xmlns:value/extepp:reasonCode",
-                                        namespaces )
+      xmlns_reason_code = result.xpath("xmlns:extValue/xmlns:value/extepp:reasonCode",
+                                       namespaces)
       reason_code = xmlns_reason_code.text.strip.to_i unless xmlns_reason_code.empty?
 
-      credit_msg = xml.xpath( "//extepp:credit/text ()",
-                              namespaces )
+      credit_msg = xml.xpath("//extepp:credit/text ()",
+                             namespaces)
       @credit = credit_msg.text.to_f unless credit_msg.empty?
 
       if expected_result === response_code
         return xml
       end
 
-      args = { :xml           => xml,
-               :response_code => response_code,
-               :reason_code   => reason_code,
-               :message       => result_message }
-
-      case [ response_code, reason_code ]
-        when [2200, 6004]
-          raise KonoEppAuthenticationPasswordExpired.new( args )
-        when [2002, 4015]
-          raise KonoEppLoginNeeded.new( args )
-        when [2304, 9022]
-          raise KonoEppDomainHasStatusCliTransProhibited.new(args)
-        when [2304, 9026]
-          raise KonoEppDomainHasStatusClientUpdateProhibited.new(args)
-        else
-          raise KonoEppErrorResponse.new( args )
+      args = {:xml => xml,
+              :response_code => response_code,
+              :reason_code => reason_code,
+              :message => result_message}
+
+      case [response_code, reason_code]
+      when [2200, 6004]
+        raise KonoEppAuthenticationPasswordExpired.new(args)
+      when [2002, 4015]
+        raise KonoEppLoginNeeded.new(args)
+      when [2304, 9022]
+        raise KonoEppDomainHasStatusCliTransProhibited.new(args)
+      when [2304, 9026]
+        raise KonoEppDomainHasStatusClientUpdateProhibited.new(args)
+      else
+        raise KonoEppErrorResponse.new(args)
       end
     end
 
     # Establishes the connection to the server. If the connection is
-		# established, then this method will call read and return
-		# the EPP <tt><greeting></tt> which is sent by the
-		# server upon connection.
+    # established, then this method will call read and return
+    # the EPP <tt><greeting></tt> which is sent by the
+    # server upon connection.
     def open_connection
       # FIXME il timeout serve solamente nella versione tcp
       # FIXME perchè utilizzare un'istanza di classe? non sarebbe meglio avere un metodo che genera il transport
@@ -266,10 +270,14 @@ module KonoEppClient #:nodoc:
         when :tcp
           @connection = KonoEppClient::Transport::TcpTransport.new(server, port)
         when :http
-          @connection = KonoEppClient::Transport::HttpTransport.new(server, port,
-                                                                    ssl_version: ssl_version,
-                                                                    cookie_file: "#{@tag.downcase}.cookies.pstore"
-          )
+
+          options = {
+            ssl_version: ssl_version,
+            cookie_file: "#{@tag.downcase}.cookies.pstore"
+          }.merge(@transport_options)
+
+          @connection = KonoEppClient::Transport::HttpTransport.new(server, port, **options)
+
         end
       end
     end
@@ -286,9 +294,9 @@ module KonoEppClient #:nodoc:
 
     # Send XML to the server. If the socket returns EOF,
     # the connection has closed and a SocketError is raised.
-    def write( xml )
+    def write(xml)
       Timeout.timeout @timeout do
-        @connection.write( xml )
+        @connection.write(xml)
       end
     end
   end

data/lib/kono_epp_client/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/kono_epp_client/version.rb

@@ -0,0 +1,3 @@
+module KonoEppClient
+  VERSION = File.read(File.join(File.dirname(__FILE__), "./VERSION")).strip
+end

data/spec/epp/server_spec.rb

@@ -0,0 +1,69 @@
+RSpec.describe KonoEppClient::Server do
+
+  let(:params) {
+    {
+      tag: "abc",
+      password: "123123",
+      server: "epp.pubtest.nic.it"
+    }
+  }
+
+  let(:instance) { described_class.new(params) }
+
+  describe "initialization" do
+
+    it "base" do
+      expect(instance).to have_attributes(
+                            **params,
+                            port: 700,
+                            old_server: false,
+                            lang: "en",
+                            services: ["urn:ietf:params:xml:ns:domain-1.0", "urn:ietf:params:xml:ns:contact-1.0", "urn:ietf:params:xml:ns:host-1.0"],
+                            extensions: [],
+                            version: "1.0",
+                            transport: :tcp,
+                            transport_options: {},
+                            timeout: 30,
+                            ssl_version: :TLSv1
+                          )
+    end
+  end
+
+  describe "#open_connection" do
+
+    it "default transport" do
+
+      double = instance_double(KonoEppClient::Transport::TcpTransport)
+
+      expect(KonoEppClient::Transport::TcpTransport).to receive(:new).with(params[:server], 700).and_return(double)
+
+      expect { instance.open_connection }.to change { instance.instance_variable_get(:@connection) }.
+        to(double)
+    end
+
+    context "transport http" do
+
+      let(:params) {
+        super().merge(
+          transport: :http,
+          transport_options: {cookie_file: "file_to_coockies"},
+        )
+      }
+
+      it "use http transport" do
+        double = instance_double(KonoEppClient::Transport::HttpTransport)
+
+        expect(KonoEppClient::Transport::HttpTransport).to receive(:new).with(
+          params[:server],
+          700, ssl_version: :TLSv1, cookie_file: "file_to_coockies").and_return(double)
+
+        expect { instance.open_connection }.to change { instance.instance_variable_get(:@connection) }.
+          to(double)
+
+      end
+
+    end
+
+  end
+
+end

data/spec/support/snapshot.rb

@@ -9,7 +9,7 @@ RSpec.configure do |config|
     extension = ".#{example.metadata[:snapshot]}" unless example.metadata[:snapshot] === true
     class_name = example.metadata[:described_class].name.underscore
     test_name = example.metadata[:full_description].gsub(example.metadata[:described_class].name, "").tr(" ", "_")
-    raise "component snapshot has no content" if raw_rendered_content.blank?
+    raise "component snapshot has no content" if raw_rendered_content.nil? or raw_rendered_content.empty?
     str_content = raw_rendered_content
     if extension == ".xml"
       str_content = Nokogiri.XML(str_content).to_xml

data/spec/support/superdiff.rb

@@ -0,0 +1 @@
+require "super_diff/rspec"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kono_epp_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Fabio Bonelli
@@ -68,6 +68,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: super_diff
+  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'
 - !ruby/object:Gem::Dependency
   name: rspec-html-matchers
   requirement: !ruby/object:Gem::Requirement
@@ -104,7 +118,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - README.md
+- Rakefile
+- kono_epp_client.gemspec
 - lib/epp/epp_command.rb
 - lib/epp/epp_command/check_contacts.rb
 - lib/epp/epp_command/create_contact.rb
@@ -127,6 +144,8 @@ files:
 - lib/epp/transport/http.rb
 - lib/epp/transport/tcp.rb
 - lib/kono_epp_client.rb
+- lib/kono_epp_client/VERSION
+- lib/kono_epp_client/version.rb
 - lib/require_parameters.rb
 - spec/epp/epp_command/kono_epp_check_contacts_spec.rb
 - spec/epp/epp_command/kono_epp_check_domains_spec.rb
@@ -134,6 +153,7 @@ files:
 - spec/epp/epp_command/kono_epp_transfer_domain_spec.rb
 - spec/epp/epp_command/kono_epp_update_domain_spec.rb
 - spec/epp/kono_epp_command_spec.rb
+- spec/epp/server_spec.rb
 - spec/fixtures/snapshots/kono_epp_check_contacts/_construct.xml.snap
 - spec/fixtures/snapshots/kono_epp_check_domains/_construct.xml.snap
 - spec/fixtures/snapshots/kono_epp_create_domain/_create.xml.snap
@@ -149,6 +169,7 @@ files:
 - spec/support/context.rb
 - spec/support/matchers.rb
 - spec/support/snapshot.rb
+- spec/support/superdiff.rb
 homepage: https://github.com/ArchimediaZerogroup/kono_epp_client
 licenses:
 - MIT
@@ -179,6 +200,7 @@ test_files:
 - spec/epp/epp_command/kono_epp_transfer_domain_spec.rb
 - spec/epp/epp_command/kono_epp_update_domain_spec.rb
 - spec/epp/kono_epp_command_spec.rb
+- spec/epp/server_spec.rb
 - spec/fixtures/snapshots/kono_epp_check_contacts/_construct.xml.snap
 - spec/fixtures/snapshots/kono_epp_check_domains/_construct.xml.snap
 - spec/fixtures/snapshots/kono_epp_create_domain/_create.xml.snap
@@ -194,3 +216,4 @@ test_files:
 - spec/support/context.rb
 - spec/support/matchers.rb
 - spec/support/snapshot.rb
+- spec/support/superdiff.rb