ruby_isds 0.9.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,160 @@
+# Work in Progress
+
+# RubyIsds [![wercker status](https://app.wercker.com/status/04043d3ae16228db7dc8d9d3ae51d1e6/s/master "wercker status")](https://app.wercker.com/project/byKey/04043d3ae16228db7dc8d9d3ae51d1e6)
+
+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 'ruby_isds'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby_isds
+
+## Usage
+
+Before usage please add config (for rails initializer) with following:
+
+```ruby
+RubyIsds.configure do |c|
+  c.data_box = 'data_box_id'
+  c.username = 'somebody'
+  c.password = 'data_box_password'
+  c.env = :development
+end
+```
+
+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:
+- `RubyIsds::DataBox` (operations and manipulation around data box itself)
+- `RubyIsds::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
+=> #<RubyIsds::WebServices::DbSearch::Response:0x00007fd3d44f0fd8
+ @body=#<RubyIsds::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=#<RubyIsds::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:
+
+### RubyIsds::DataBox
+
+#### .check
+
+checking the status
+
+```ruby
+> RubyIsds::DataBox.check
+
+=> #<RubyIsds::WebServices::DbSearch::Response:0x00007fd3d68487d8
+ @body=#<RubyIsds::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=#<RubyIsds::Responses::Db::Status:0x00007fd3d41ae280 @code="0000", @message="Provedeno úspěšně.">>
+```
+
+
+#### .find
+
+#### .credit_info
+
+#### .received
+
+#### .sent
+
+#### .state_changes
+
+
+### RubyIsds::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)
+
+## 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]/ruby_isds. 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 RubyIsds project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ruby_isds/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 'ruby_isds'
+
+require 'pry'
+Pry.start

data/lib/ruby_isds.rb

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

data/lib/ruby_isds/configuration.rb

@@ -0,0 +1,51 @@
+module RubyIsds
+  class Configuration
+    attr_writer :data_box, :username, :password, :env, :api_url
+
+    def initialize
+      @username = nil
+      @password = nil
+      @data_box = nil
+      @env = 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
+
+    ##
+    # env values:
+    #   :development (default)
+    #   :production
+    #
+    def env
+      return :development unless @env
+      @env
+    end
+
+    def api_domain
+      case @env
+      when :production then 'https://ws1c.mojedatovaschranka.cz'
+      else 'https://ws1.czebox.cz'
+      end
+    end
+
+    def xml_url
+      case @env
+      when :production then 'mojedatovaschranka.cz'
+      else 'czechpoint.cz'
+      end
+    end
+  end
+end

data/lib/ruby_isds/data_box.rb

@@ -0,0 +1,33 @@
+module RubyIsds
+  class DataBox
+    def self.check(options = {})
+      ::RubyIsds::WebServices::DbSearch::CheckDataBox
+        .call(options.merge(dbID: ::RubyIsds.configuration.data_box))
+    end
+
+    def self.find_by(options = {})
+      ::RubyIsds::WebServices::DbSearch::FindDataBox
+        .call(options)
+    end
+
+    def self.credit_info(options = {})
+      ::RubyIsds::WebServices::DbSearch::DataBoxCreditInfo
+        .call(options.merge(dbID: ::RubyIsds.configuration.data_box))
+    end
+
+    def self.received(options = {})
+      RubyIsds::WebServices::DmInfo::GetListOfReceivedMessages
+        .call(options)
+    end
+
+    def self.sent(options = {})
+      RubyIsds::WebServices::DmInfo::GetListOfSentMessages
+        .call(options)
+    end
+
+    def self.state_changes(options = {})
+      RubyIsds::WebServices::DmInfo::GetMessageStateChanges
+        .call(options)
+    end
+  end
+end

data/lib/ruby_isds/data_message.rb

@@ -0,0 +1,129 @@
+# rubocop:disable Metrics/ClassLength
+module RubyIsds
+  class DataMessage
+    ATTRIBUTES = %w[dmType dmOrdinal dmID dbIDSender dmSender
+                    dmSenderAddress dmSenderType dmRecipient dmRecipientAddress
+                    dmSenderOrgUnit dmSenderOrgUnitNum dbIDRecipient dmRecipientOrgUnit
+                    dmRecipientOrgUnitNum dmToHands dmAnnotation dmRecipientRefNumber
+                    dmSenderRefNumber dmRecipientIdent dmSenderIdent dmLegalTitleLaw
+                    dmLegalTitleYear dmLegalTitleSect dmLegalTitlePar dmLegalTitlePoint
+                    dmPersonalDelivery dmAllowSubstDelivery dmMessageStatus
+                    dmAttachmentSize dmDeliveryTime dmAcceptanceTime dmHash
+                    dmQTimestamp dmAttachments dmAmbiguousRecipient].freeze
+
+    attr_accessor(*ATTRIBUTES)
+
+    def self.find(dmID)
+      RubyIsds::WebServices::DmOperations::MessageDownload
+        .call(dmID: dmID)
+    end
+
+    def download(destination = '/tmp')
+      File.open("#{destination}/#{dmID}.zfo", 'wb') do |f|
+        f.write(Base64.decode64(signed.body.dmSignature))
+      end
+    end
+
+    def initialize(params = {})
+      @params = params.dup
+      status_info = @params.delete('dmDm')
+      @dmAttachments = load_attachments
+      @dmEvents = load_events
+      unified_params = status_info ? status_info.merge(@params) : params
+      unified_params.each do |key, value|
+        raise "Not valid attribute of DataMessage #{key}" unless ATTRIBUTES.include?(key)
+        instance_variable_set("@#{key}", parsed_value(value))
+      end
+    end
+
+    def verify
+      RubyIsds::WebServices::DmInfo::VerifyMessage
+        .call(dmID: dmID)
+    end
+
+    def authenticate
+      RubyIsds::WebServices::DmOperations::AuthenticateMessage
+        .call(dmMessage: signed.body.dmSignature)
+    end
+
+    def signed
+      RubyIsds::WebServices::DmOperations::SignedMessageDownload
+        .call(dmID: dmID)
+    end
+
+    def author
+      RubyIsds::WebServices::DmInfo::GetMessageAuthor
+        .call(dmID: dmID)
+    end
+
+    def delivery_info
+      RubyIsds::WebServices::DmInfo::GetDeliveryInfo
+        .call(dmID: dmID)
+    end
+
+    def envelope
+      RubyIsds::WebServices::DmInfo::MessageEnvelopeDownload
+        .call(dmID: dmID)
+    end
+
+    def confirm_delivery
+      RubyIsds::WebServices::DmInfo::ConfirmDelivery
+        .call(dmID: dmID)
+    end
+
+    def mark_as_downloaded
+      RubyIsds::WebServices::DmInfo::MarkMessageAsDownloaded
+        .call(dmID: dmID)
+    end
+
+    def destroy(options = {})
+      RubyIsds::WebServices::DmInfo::EraseMessage
+        .call(options.merge(dmID: dmID))
+    end
+
+    def sent?
+      dbIDSender == ::RubyIsds.configuration.data_box
+    end
+
+    def received?
+      dbIDSender != ::RubyIsds.configuration.data_box
+    end
+
+    private
+
+    def load_events
+      return {} if @params['dmEvents'].blank?
+      events_hash = @params.delete('dmEvents')['dmEvent']
+      if events_hash.is_a?(Array)
+        events_hash.map do |event|
+          ::RubyIsds::Responses::Messages::Event.new(event)
+        end
+      else
+        ::RubyIsds::Responses::Messages::Event.new(events_hash)
+      end
+    end
+
+    def load_attachments
+      return {} if @params['dmFiles'].blank?
+      attachments_hash = @params.delete('dmFiles')['dmFile']
+      if attachments_hash.is_a?(Array)
+        attachments_hash.map do |attachment|
+          ::RubyIsds::Responses::Messages::Attachment.new(attachment)
+        end
+      else
+        ::RubyIsds::Responses::Messages::Attachment.new(attachments_hash)
+      end
+    end
+
+    def parsed_value(value)
+      return value unless value.is_a?(Hash)
+      raise "Missing parse rule for #{value}" if value.keys.size > 1
+      if value.keys.first == 'xsi:nil' && value.values.first == 'true'
+        nil
+      else
+        false
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/ClassLength