nuncium 0.13.0

data/Guardfile

@@ -0,0 +1,7 @@
+require 'guard/rspec'
+
+guard :rspec, cmd: 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Andrej Antas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,281 @@
+# Work in Progress
+
+# Nuncium [![wercker status](https://app.wercker.com/status/04043d3ae16228db7dc8d9d3ae51d1e6/s/master "wercker status")](https://app.wercker.com/project/byKey/04043d3ae16228db7dc8d9d3ae51d1e6) [![Maintainability](https://api.codeclimate.com/v1/badges/eb20cde530fb8d1690cd/maintainability)](https://codeclimate.com/github/redrick/nuncium/maintainability)
+
+Wrapper for API love [ISDS](https://www.datoveschranky.info/) shares with us through this XML API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nuncium'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nuncium
+
+## Usage
+
+Before usage please add config (for rails initializer) with one of supported
+auth strategies:
+
+### Username + password
+
+```ruby
+Nuncium.configure do |c|
+  c.data_box = 'data_box_id'
+  c.username = 'somebody'
+  c.password = 'data_box_password'
+  c.env = :development
+end
+```
+### Server side system certificate
+
+```ruby
+Nuncium.configure do |c|
+  c.data_box = 'data_box_id'
+  c.cert_file = 'spec/factories/files/certifikat.pem'
+  c.key_file = 'spec/factories/files/test-key.key'
+  c.pass_phrase = 'andrej'
+  c.env = :development
+end
+```
+here `data_box_id` if id of databox you will be accessing, you do not really
+need id of databox used as point from where you access
+
+you do not have to provide `env` in setup unless you go to production, gem
+defaults to `:development` anyway...
+
+This gem provides you with 2 basic classes and those are:
+- `Nuncium::DataBox` (operations and manipulation around data box itself)
+- `Nuncium::DataMessage` (operations and manipulation with message)
+
+Kinda important to mention is that results of calls are trying to be the same each time of course and in form of neat object that looks like this:
+
+```ruby
+=> #<Nuncium::WebServices::DbSearch::Response:0x00007fd3d44f0fd8
+ @body=#<Nuncium::Responses::Db::Body:0x00007fd3d449b808 @ciRecords=nil, @currentCredit="596400", @notifEmail=nil>,
+ @response=
+  {"Envelope"=>
+    {"xmlns:SOAP_ENV"=>"http://schemas.xmlsoap.org/soap/envelope/",
+     "xmlns:xsd"=>"http://www.w3.org/2001/XMLSchema",
+     "Body"=>{"DataBoxCreditInfoResponse"=>{"xmlns:p"=>"http://isds.czechpoint.cz/v20", "xmlns:xsi"=>"http://www.w3.org/2001/XMLSchema-instance", "currentCredit"=>"596400", "notifEmail"=>{"xsi:nil"=>"true"}, "ciRecords"=>nil, "dbStatus"=>{"dbStatusCode"=>"0000", "dbStatusMessage"=>"Provedeno úspěšně."}}}}},
+ @status=#<Nuncium::Responses::Db::Status:0x00007fd3d449be48 @code="0000", @message="Provedeno úspěšně.">>
+```
+
+To take it apart consist of:
+- `body` -> in case of request for messages will be `messages` is parsed body taking original attribute names and their values
+  - inspect and use like so:
+  ```ruby
+  > result.body.currentCredit
+  => "596400"
+  ```
+- `status` -> always contains status information in form of `code` and `messsage`
+- `response` -> simply whole original XML response parsed into Hash for better usage
+
+Public API looks like so:
+
+### Nuncium::DataBox
+
+#### .check
+
+checking the status
+
+```ruby
+> Nuncium::DataBox.check
+
+=> #<Nuncium::WebServices::DbSearch::Response:0x00007fd3d68487d8
+ @body=#<Nuncium::Responses::Db::Body:0x00007fd3d41ad2e0 @dbState="1">,
+ @response=
+  {"Envelope"=>
+    {"xmlns:SOAP_ENV"=>"http://schemas.xmlsoap.org/soap/envelope/",
+     "xmlns:xsd"=>"http://www.w3.org/2001/XMLSchema",
+     "Body"=>{"CheckDataBoxResponse"=>{"xmlns:p"=>"http://isds.czechpoint.cz/v20", "xmlns:xsi"=>"http://www.w3.org/2001/XMLSchema-instance", "dbState"=>"1", "dbStatus"=>{"dbStatusCode"=>"0000", "dbStatusMessage"=>"Provedeno úspěšně."}}}}},
+ @status=#<Nuncium::Responses::Db::Status:0x00007fd3d41ae280 @code="0000", @message="Provedeno úspěšně.">>
+```
+
+
+#### .find_by
+
+You can find any data box by searching like so:
+
+```ruby
+> Nuncium::DataBox.find_by(dbType: 'FO', pnLastName: 'Anta')
+
+=> #<Nuncium::WebServices::DbSearch::Response:0x00007f9986b4c090
+ @body=#<Nuncium::Responses::Db::Body:0x00007f9987823f98 @dbResults=false>,
+ @response=
+  {"Envelope"=>
+    {"xmlns:SOAP_ENV"=>"http://schemas.xmlsoap.org/soap/envelope/",
+     "xmlns:xsd"=>"http://www.w3.org/2001/XMLSchema",
+     "Body"=>
+      {"FindDataBoxResponse"=>
+        {"xmlns:p"=>"http://isds.czechpoint.cz/v20",
+         "xmlns:xsi"=>"http://www.w3.org/2001/XMLSchema-instance",
+         "dbResults"=>
+          {"dbOwnerInfo"=>
+            {"dbID"=>"mxbf8u6",
+             "dbType"=>"FO",
+             "ic"=>{"xsi:nil"=>"true"},
+             "pnFirstName"=>"Andrej",
+             "pnMiddleName"=>{"xsi:nil"=>"true"},
+             "pnLastName"=>"Antaš",
+             "pnLastNameAtBirth"=>{"xsi:nil"=>"true"},
+             "firmName"=>{"xsi:nil"=>"true"},
+             "biDate"=>"1990-01-16",
+             "biCity"=>"*",
+             "biCounty"=>"*",
+             "biState"=>"*",
+             "adCity"=>"Praha 5",
+             "adStreet"=>"Pekařská",
+             "adNumberInStreet"=>"10a",
+             "adNumberInMunicipality"=>"695",
+             "adZipCode"=>"15500",
+             "adState"=>"CZ",
+             "nationality"=>"*",
+             "identifier"=>{"xsi:nil"=>"true"},
+             "registryCode"=>{"xsi:nil"=>"true"},
+             "dbState"=>"1",
+             "dbEffectiveOVM"=>"false",
+             "dbOpenAddressing"=>"true"}},
+         "dbStatus"=>{"dbStatusCode"=>"0000", "dbStatusMessage"=>"Provedeno úspěšně."}}}}},
+ @status=#<Nuncium::Responses::Db::Status:0x00007f9987828c50 @code="0000", @message="Provedeno úspěšně.">>
+ ```
+
+#### .credit_info
+
+For checking your balance (post messages need payments), so you can make sure you have enough before sending a message:
+
+```ruby
+> Nuncium::DataBox.credit_info
+
+=> #<Nuncium::WebServices::DbSearch::Response:0x00007f8dd69b6e08
+ @body=#<Nuncium::Responses::Db::Body:0x00007f8dd699c1e8 @ciRecords=nil, @currentCredit="596400", @notifEmail=nil>,
+ @response=
+  {"Envelope"=>
+    {"xmlns:SOAP_ENV"=>"http://schemas.xmlsoap.org/soap/envelope/",
+     "xmlns:xsd"=>"http://www.w3.org/2001/XMLSchema",
+     "Body"=>{"DataBoxCreditInfoResponse"=>{"xmlns:p"=>"http://isds.czechpoint.cz/v20", "xmlns:xsi"=>"http://www.w3.org/2001/XMLSchema-instance", "currentCredit"=>"596400", "notifEmail"=>{"xsi:nil"=>"true"}, "ciRecords"=>nil, "dbStatus"=>{"dbStatusCode"=>"0000", "dbStatusMessage"=>"Provedeno úspěšně."}}}}},
+ @status=#<Nuncium::Responses::Db::Status:0x00007f8dd699c3a0 @code="0000", @message="Provedeno úspěšně.">>
+```
+
+#### .received
+
+Listing all received messages:
+
+```ruby
+> Nuncium::DataBox.received
+
+=> #<Nuncium::Responses::Messages::Collection:0x00007f99882e6048
+ @messages=
+  [
+  ...
+  ],
+ @status=#<Nuncium::Responses::Dm::Status:0x00007f9986c26718 @code="0000", @message="Provedeno úspěšně.">>
+```
+
+Message responses are stubbed here in response, will be explain down in DataMessage docs
+
+#### .sent
+
+
+Listing all received messages:
+
+```ruby
+> Nuncium::DataBox.sent
+
+=> #<Nuncium::Responses::Messages::Collection:0x00007f99882e6048
+ @messages=
+  [
+  ...
+  ],
+ @status=#<Nuncium::Responses::Dm::Status:0x00007f9986c26718 @code="0000", @message="Provedeno úspěšně.">>
+```
+
+Message responses are stubbed here in response, will be explain down in DataMessage docs
+
+#### .state_changes
+
+TODO
+
+### Nuncium::DataMessage
+
+#### .find
+
+#### #download
+
+#### #verify
+
+#### #authenticate
+
+#### #signed
+
+#### #author
+
+#### #delivery_info
+
+#### #envelope
+
+#### #confirm_delivery
+
+#### #mark_as_downloaded
+
+#### #destroy
+
+#### #sent?
+
+#### #received?
+
+### Help
+
+If in doubt, or my so called 'README' seems not that helpful, please refer to [ISDS provozni rad](https://www.datoveschranky.info/dulezite-informace/provozni-rad-isds)
+
+#### Certificates
+
+Just some helpfull information when you want to use certificate to access
+databoxes:
+
+How to setup and what not in ISDS: [https://www.czebox.cz/static/ISDS/help/page8.html#8_4](https://www.czebox.cz/static/ISDS/help/page8.html#8_4)
+
+Working with DER/PEM and what not around the keys: [https://knowledge.digicert.com/solution/SO26449.html](https://knowledge.digicert.com/solution/SO26449.html)
+
+How to convert windows pfx file exported from keychain into key you need here: [https://www.markbrilman.nl/2011/08/howto-convert-a-pfx-to-a-seperate-key-crt-file/](https://www.markbrilman.nl/2011/08/howto-convert-a-pfx-to-a-seperate-key-crt-file/)
+
+Jus to note here, certificate accepted should be in PEM format and you have to add the private.key with the password to it.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/nuncium. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## TODO
+
+Still WIP although we test it already how this is going to turn out, so fingers
+crossed... we still need to finish:
+- massive portion of specs
+- refactoring (a lot of same code and misused inheritance)
+- sending messages...
+- better documentation
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Thanks
+
+Many thanks to Petr Písař <petr.pisar@atlas.cz> for writing awesome libisds C library and compiling many usefull information around ISDS :)
+
+## Code of Conduct
+
+Everyone interacting in the Nuncium project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/nuncium/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-modernist

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'nuncium'
+
+require 'pry'
+Pry.start

data/lib/nuncium.rb

@@ -0,0 +1,87 @@
+require 'net/http'
+require 'net/https'
+require 'base64'
+require 'nokogiri'
+require 'active_support/core_ext/hash'
+
+require 'nuncium/utils/errors'
+
+require 'nuncium/version'
+require 'nuncium/configuration'
+require 'nuncium/request'
+require 'nuncium/response'
+
+require 'nuncium/data_box'
+require 'nuncium/data_message'
+
+require 'nuncium/responses/body'
+require 'nuncium/responses/status'
+require 'nuncium/responses/db/status'
+require 'nuncium/responses/dm/status'
+require 'nuncium/responses/dm/body'
+require 'nuncium/responses/db/body'
+require 'nuncium/responses/message'
+require 'nuncium/responses/messages/event'
+require 'nuncium/responses/messages/envelope'
+require 'nuncium/responses/messages/attachment'
+require 'nuncium/responses/messages/collection'
+require 'nuncium/responses/messages/delivery_info'
+
+require 'nuncium/web_services/db_search/response'
+require 'nuncium/web_services/db_search/request'
+require 'nuncium/web_services/db_search/find_data_box'
+require 'nuncium/web_services/db_search/d_t_info'
+require 'nuncium/web_services/db_search/get_data_box_activity_status'
+require 'nuncium/web_services/db_search/check_data_box'
+require 'nuncium/web_services/db_search/data_box_credit_info'
+require 'nuncium/web_services/db_search/find_personal_data_box'
+require 'nuncium/web_services/db_search/get_data_box_list'
+require 'nuncium/web_services/db_search/isds_search_2'
+require 'nuncium/web_services/db_search/p_d_z_info'
+require 'nuncium/web_services/db_search/p_d_z_send_info'
+
+require 'nuncium/web_services/db_access/change_isds_password'
+require 'nuncium/web_services/db_access/get_owner_info_from_login'
+
+require 'nuncium/web_services/dm_info/request'
+require 'nuncium/web_services/dm_info/response'
+require 'nuncium/web_services/dm_info/confirm_delivery'
+require 'nuncium/web_services/dm_info/erase_message'
+require 'nuncium/web_services/dm_info/get_delivery_info'
+require 'nuncium/web_services/dm_info/get_list_of_received_messages'
+require 'nuncium/web_services/dm_info/get_list_of_sent_messages'
+require 'nuncium/web_services/dm_info/get_message_author'
+require 'nuncium/web_services/dm_info/get_message_state_changes'
+require 'nuncium/web_services/dm_info/get_signed_delivery_info'
+require 'nuncium/web_services/dm_info/mark_message_as_downloaded'
+require 'nuncium/web_services/dm_info/message_envelope_download'
+require 'nuncium/web_services/dm_info/verify_message'
+
+require 'nuncium/web_services/dm_operations/request'
+require 'nuncium/web_services/dm_operations/response'
+require 'nuncium/web_services/dm_operations/authenticate_message'
+require 'nuncium/web_services/dm_operations/create_message'
+require 'nuncium/web_services/dm_operations/create_multiple_messages'
+require 'nuncium/web_services/dm_operations/message_download'
+require 'nuncium/web_services/dm_operations/ping'
+require 'nuncium/web_services/dm_operations/resign_isds_document'
+require 'nuncium/web_services/dm_operations/signed_message_download'
+require 'nuncium/web_services/dm_operations/signed_sent_message_download'
+
+module Nuncium
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.ping
+    ::Nuncium::WebServices::DmOperations::Ping.new.call
+  end
+end

data/lib/nuncium/configuration.rb

@@ -0,0 +1,82 @@
+module Nuncium
+  class Configuration
+    attr_writer :data_box, :username, :password, :env, :api_url,
+                :cert_file, :key_file, :pass_phrase
+    attr_reader :pass_phrase
+
+    ALLOWED_PRODUCTION_SYNTAX = [:production, 'production'].freeze
+
+    def initialize
+      @username = nil
+      @password = nil
+      @data_box = nil
+      @env = nil
+      @cert_file = nil
+      @key_file = nil
+      @pass_phrase = nil
+    end
+
+    def data_box
+      raise ConfigNotSet, 'data_box' unless @data_box
+      @data_box
+    end
+
+    def username
+      raise ConfigNotSet, 'username' unless @username
+      @username
+    end
+
+    def password
+      raise ConfigNotSet, 'password' unless @password
+      @password
+    end
+
+    def cert_file
+      if @cert_file && (!@key_file && !@pass_phrase)
+        raise ConfigNotSet, 'pass_phrase and key_file'
+      end
+      return unless @cert_file
+      OpenSSL::X509::Certificate.new(File.read(@cert_file))
+    end
+
+    def key_file
+      return nil unless @key_file
+      File.read(@key_file)
+    end
+
+    def private_key
+      raise ConfigNotSet, 'pass_phrase' if @key_file && !@pass_phrase
+      raise ConfigNotSet, 'key_file' if !@key_file && @pass_phrase
+      OpenSSL::PKey::RSA.new(File.read(@key_file), @pass_phrase)
+    end
+
+    ##
+    # env values:
+    #   :development (default)
+    #   :production
+    #
+    def env
+      return :development unless @env
+      @env
+    end
+
+    def api_domain
+      if production?
+        return 'https://ws1c.mojedatovaschranka.cz/cert' if @cert_file
+        'https://ws1.mojedatovaschranka.cz'
+      else
+        return 'https://ws1c.czebox.cz/hspis' if @cert_file
+        'https://ws1.czebox.cz'
+      end
+    end
+
+    def xml_url
+      return 'mojedatovaschranka.cz' if production?
+      'czechpoint.cz'
+    end
+
+    def production?
+      ALLOWED_PRODUCTION_SYNTAX.include?(@env)
+    end
+  end
+end