atna 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NGIyMmIwYmZiMGFhMzVlMWEwMDEyYmU2Y2Y2MWM5NzY1ODg5NmRlNQ==
+  data.tar.gz: !binary |-
+    MDkwZDg3MGViMmY2NTg0MmM5ZWM0OTZkMzU5OTY1YzIxZTRlOTYwZQ==
+SHA512:
+  metadata.gz: !binary |-
+    YmU1MmQxNTg5NWY2MDMwMTBmNWY3NDcxNmQzMmIyZDM0OTUxMWVlNjVjNjMy
+    NmVjZTY1NmI1YjJkNmY1MjM1ZGIxMjg3MTg4MjZhMWEwYzg0OTgwYmVjMjc2
+    MWYwOWQwZWIxOGUxZjZmOTVlNDlkZGRhYWZjZTE2OGZmNzg3YmE=
+  data.tar.gz: !binary |-
+    YWNkMDcxYzg2OWQzNjBlMDZmODJlZDI0N2U0Y2RhYTc1NzFiMWIxMmExM2Jj
+    ZWMwYzdiMTBkYmQxNjhiY2ZhNzNjZGY3ODBjZjIwYjhhM2Q2ZWZiZDFmNzg3
+    NTNlNDEyODYxNDNiMzBhYzNkYmI4YmZjNWQ5NTQ3YWEzYjYwODE=

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in atna.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Tetsuhisa MAKINO
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Tetsuhisa MAKINO
+
+MIT License
+
+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,29 @@
+# Atna
+
+IHE ITI ATNA Udp socket logger with RFC3881 Message builder.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'atna'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install atna
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/maki-tetsu/atna/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/atna.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8 -*- mode: ruby -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'atna/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "atna"
+  spec.version       = Atna::VERSION
+  spec.authors       = ["Tetsuhisa MAKINO"]
+  spec.email         = ["tim.makino@gmail.com"]
+  spec.summary       = %q{IHE ITI ATNA Udp socket logger with RFC3881 Message builder.}
+  # spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  # for Development
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+
+  # for production
+  spec.add_dependency "nokogiri"
+end

data/lib/atna.rb

@@ -0,0 +1,8 @@
+require "atna/version"
+require "atna/logger"
+require "atna/udp_sender"
+require "atna/rfc3881"
+
+module Atna
+  # Your code goes here...
+end

data/lib/atna/logger.rb

@@ -0,0 +1,94 @@
+# -*- coding: utf-8 -*-
+require "socket"
+
+# ATNA 監査証跡対応版ライブラリ
+#
+# ログの送信にのみ利用します。
+# 監査メッセージ本体は別途対応
+module ATNA
+  class Logger
+    # ATNA メッセージ構築用パラメータ
+    VALID_OPTIONS = [:pri, :version, :timestamp, :hostname, :app_name, :procid, :msgid, :structured_data]
+    # ATNA 用の UTF-8 BOMB
+    UTF8_BOMB = 0xEFBBBF
+    # PRI の値
+    PRI = "<85>"
+    # MSGID の値(ATNA では固定値)
+    MSGID = "IHE+RFC-3881"
+
+    def initialize(host = 'localhost', port = 514, default_options = { })
+      @host, @port = host, port
+      @default_options = default_options
+    end
+
+    # メッセージを送信
+    #
+    # xmlmsg :: 送信すべき XML メッセージ本体
+    # options ::
+    #   :version :: バージョン番号
+    #   :timestamp :: Time インスタンス(未指定時は現在時刻を利用)
+    #   :hostname :: メッセージ発信元 hostname(未指定時はホスト名を取得:localhost時は - を設定)
+    #   :app_name :: アプリケーション名(未指定時は - を設定)
+    #   :procid :: プロセスID(未指定時は - を設定)
+    #   :msgid :: メッセージID(未指定時は - を設定)
+    #   :structured_data :: 構造化データ
+    def notify!(xmlmsg, options = { })
+      options = @default_options.merge(options)
+      validate_options(options)
+      update_blank_options(options)
+
+      sender = UdpSender.new(@host, @port)
+      datagram = serialize_message(xmlmsg, options)
+      sender.send(datagram)
+    end
+
+    private
+
+    def validate_options(options)
+      unless (unknown_options = options.keys - VALID_OPTIONS).empty?
+        raise ArgumentError, "Unknown option keys(#{unknown_options.join(", ")})"
+      end
+    end
+
+    def update_blank_options(options)
+      VALID_OPTIONS.each do |key|
+        if options[key].nil? || options[key].empty?
+          case key
+          when :pri
+            options[key] = PRI
+          when :timestamp
+            options[key] = Time.now
+          when :hostname
+            options[key] = Socket.gethostname
+            options[key] = "-" if options[key] == "localhost"
+          when :msgid
+            options[key] = MSGID
+          else
+            options[key] = "-"
+          end
+        end
+      end
+    end
+
+    def serialize_message(xmlmsg, options)
+      buf = StringIO.new("wb")
+      # HEADER
+      buf.write("#{options[:pri]}#{options[:version]} #{options[:timestamp].utc.iso8601} ")
+      buf.write("#{options[:hostname]} #{options[:app_name]} #{options[:procid]} ")
+      buf.write("#{options[:msgid]}")
+      buf.write(" ")
+
+      # 構造化データ
+      buf.write("#{options[:structured_data]}")
+      buf.write(" ")
+
+      # MSG
+      buf.write(UTF8_BOMB)
+      buf.write(xmlmsg)
+
+      # 巻き戻し
+      buf.rewind
+      return buf.string
+    end
+  end
+end

data/lib/atna/rfc3881.rb

@@ -0,0 +1,188 @@
+require "nokogiri"
+require "atna/utils"
+
+module ATNA
+  # ATNA::RFC3881
+  #
+  # Build RFC 3881 Message(xml) Builder.
+  # Message building by +ATNA::RFC3881::AuditMessage.new+ and add child element +<<+ or
+  # +add_child+ method.
+  #
+  # Example:
+  #   include ATNA::RFC3881
+  #
+  #   msg = AuditMessage.new
+  #   msg << AuditMessage::EventParticipant.new(:UserID => "user1",
+  #                                             "RoleIDCode" => [{ :code => "1" }, { :code => "2" }])
+  #   msg << AuditMessage::EventIdentification.new(:EventActionCode => AuditMessage::EventIdentification::EVENT_ACTION_CODE["Create"],
+  #                                                :EventDateTime => Time.now.utc.iso8601,
+  #                                                :EventOutcomeIndicator => AuditMessage::EventIdentification::EVENT_OUTCOME_INDICATOR["Success"],
+  #                                                "EventID" => { :code => "1" },
+  #                                                "EventTypeCode" => [{ :code => "2" }, { :code => "3" }])
+  #   msg << AuditMessage::ActiveParticipant.new(:UserID => "user2",
+  #                                              "RoleIDCode" => [{ :code => "1" }, { :code => "2" }])
+  #   # ...
+  module RFC3881
+    class AuditMessage < ATNA::Utils::XmlBuilder::Base
+      class EventIdentification < ATNA::Utils::XmlBuilder::Base
+        EVENT_ACTION_CODE = {
+          "Create"  => "C",
+          "Read"    => "R",
+          "Update"  => "U",
+          "Delete"  => "D",
+          "Execute" => "E",
+        }
+
+        EVENT_OUTCOME_INDICATOR = {
+          "Success"                                => 0,
+          "Minor failure"                          => 4,
+          "Serious failure"                        => 8,
+          "Major failure; action mode unavailable" => 12,
+        }
+
+        attributes :EventActionCode, :EventDateTime, :EventOutcomeIndicator
+
+        class EventID < ATNA::Utils::XmlBuilder::Base
+          attributes :code, :codeSystem, :codeSystemName, :displayName, :originalText
+        end
+
+        class EventTypeCode < ATNA::Utils::XmlBuilder::Base
+          attributes :code, :codeSystem, :codeSystemName, :displayName, :originalText
+        end
+
+        children_order EventID, EventTypeCode
+      end
+
+      class ActiveParticipant < ATNA::Utils::XmlBuilder::Base
+        NETWORK_ACCESS_POINT_TYPE_CODE = {
+          "Machine Name, including DNS namee" => 1,
+          "IP Address"                        => 2,
+          "Telephone Number"                  => 3,
+        }
+
+        attributes :UserID, :AlternativeUserID, :UserName, :UserIsRequester
+        attributes :NetworkAccessPointID, :NetworkAccessPointTypeCode
+
+        class RoleIDCode < ATNA::Utils::XmlBuilder::Base
+          attributes :code, :codeSystem, :codeSystemName, :displayName, :originalText
+        end
+
+        children_order RoleIDCode
+      end
+
+      class AuditSourceIdentification < ATNA::Utils::XmlBuilder::Base
+        attributes :AuditEnterpriseSiteID, :AuditSourceID
+
+        class AuditSourceTypeCode < ATNA::Utils::XmlBuilder::Base
+          AUDIT_SOURCE_TYPE_CODE = {
+            "End-user display device, diagnostic display" => "1",
+            "Data acquisition device or instrument"       => "2",
+            "Web server process"                          => "3",
+            "Application server process"                  => "4",
+            "Database server process"                     => "5",
+            "Security server, e.g., a domain controller"  => "6",
+            "ISO level 1-3 network component"             => "7",
+            "ISO level 4-6 operating software"            => "8",
+            "External source, other or unknown type"      => "9",
+          }
+
+          attributes :code, :codeSystem, :codeSystemName, :displayName, :originalText
+        end
+
+        children_order AuditSourceTypeCode
+      end
+
+      class ParticipantObjectIdentification < ATNA::Utils::XmlBuilder::Base
+        PARTICIPANT_OBJECT_ID_TYPE_CODE = {
+          "Medical Record Number"  => "1",
+          "Patient Number"         => "2",
+          "Encounter Number"       => "3",
+          "Enrollee Number"        => "4",
+          "Social Security Number" => "5",
+          "Account Number"         => "6",
+          "Guarantor Number"       => "7",
+          "Report Name"            => "8",
+          "Report Number"          => "9",
+          "Search Criteria"        => "10",
+          "User Identifier"        => "11",
+          "URI"                    => "12",
+          ""                       => "",
+        }
+
+        PARTICIPANT_OBJECT_TYPE_CODE = {
+          "Person"        => 1,
+          "System object" => 2,
+          "Organization"  => 3,
+          "Other"         => 4,
+        }
+
+        PARTICIPANT_OBJECT_TYPE_CODE_ROLE = {
+          "Patient"                          => 1,
+          "Location"                         => 2,
+          "Report"                           => 3,
+          "Resource"                         => 4,
+          "Master file"                      => 5,
+          "User"                             => 6,
+          "List"                             => 7,
+          "Doctor"                           => 8,
+          "Subscriber"                       => 9,
+          "Guarantor"                        => 10,
+          "Security User Entity"             => 11,
+          "Security User Group"              => 12,
+          "Security Resource"                => 13,
+          "Security Granualarity Definition" => 14,
+          "Provider"                         => 15,
+          "Report Destination"               => 16,
+          "Report Library"                   => 17,
+          "Schedule"                         => 18,
+          "Customer"                         => 19,
+          "Job"                              => 20,
+          "Job Stream"                       => 21,
+          "Table"                            => 22,
+          "Routing Criteria"                 => 23,
+          "Query"                            => 24,
+        }
+
+        PARTICIPANT_OBJECT_DATA_LIFE_CYCLE = {
+          "Origination / Creation"                   => 1,
+          "Import / Copy from original"              => 2,
+          "Amendment"                                => 3,
+          "Verification"                             => 4,
+          "Translation"                              => 5,
+          "Access / Use"                             => 6,
+          "De-identification"                        => 7,
+          "Aggregation, summarization, derivation"   => 8,
+          "Report"                                   => 9,
+          "Export / Copy to target"                  => 10,
+          "Disclosure"                               => 11,
+          "Receipt of disclosure"                    => 12,
+          "Archiving"                                => 13,
+          "Logical deletion"                         => 14,
+          "Permanent erasure / Physical destruction" => 15,
+        }
+
+        attributes :ParticipantObjectID, :ParticipantObjectTypeCode
+        attributes :ParticipantObjectTypeCodeRole, :ParticipantObjectDataLifeCycle
+        attributes :ParticipantObjectSensitivity
+
+        class ParticipantObjectIDTypeCode < ATNA::Utils::XmlBuilder::Base
+          attributes :code, :codeSystem, :codeSystemName, :displayName, :originalText
+        end
+
+        class ParticipantObjectName < ATNA::Utils::XmlBuilder::Base
+        end
+
+        class ParticipantObjectQuery < ATNA::Utils::XmlBuilder::Base
+        end
+
+        class ParticipantObjectDetail < ATNA::Utils::XmlBuilder::Base
+          attributes :type, :value
+        end
+
+        children_order ParticipantObjectIDTypeCode, ParticipantObjectName, ParticipantObjectQuery, ParticipantObjectDetail
+      end
+
+      children_order EventIdentification, ActiveParticipant, AuditSourceIdentification, ParticipantObjectIdentification
+    end
+  end
+end

data/lib/atna/udp_sender.rb

@@ -0,0 +1,12 @@
+module ATNA
+  class UdpSender
+    def initialize(host, port)
+      @host, @port = host, port
+      @socket = UDPSocket.open
+    end
+
+    def send(datagram)
+      @socket.send(datagram, 0, @host, @port)
+    end
+  end
+end

data/lib/atna/utils.rb

@@ -0,0 +1 @@
+require "atna/utils/xml_builder"

data/lib/atna/utils/xml_builder.rb

@@ -0,0 +1,136 @@
+# coding: utf-8
+module ATNA
+  module Utils
+    module XmlBuilder
+      class Base
+        def self.attributes(*names)
+          self.instance_eval do
+            @attribute_names ||= []
+            names.each do |name|
+              @attribute_names << name.to_s.to_sym
+            end
+
+            next @attribute_names.dup
+          end
+        end
+
+        def self.children_order(*klasses)
+          self.instance_eval do
+            @children ||= []
+            klasses.each do |klass|
+              raise "Unkown Element class [#{klass}]" unless self.node_class.include?(klass)
+              @children << klass
+            end
+
+            next @children.dup
+          end
+        end
+
+        def self.valid_attribute?(name)
+          attributes.include?(name.to_s.to_sym)
+        end
+
+        def self.node_class(string = false)
+          classes = self.constants.map { |c|
+            if eval("::#{self.name}::#{c}.kind_of?(Class)")
+              next eval("::#{self.name}::#{c} < ATNA::Utils::XmlBuilder::Base ? ::#{self.name}::#{c} : nil")
+            end
+            next nil
+          }.compact
+          classes.map! { |c| c.name.split("::").pop.to_s } if string
+
+          return classes
+        end
+
+        def self.find_element_class(node_name)
+          unless idx = node_class(true).index(node_name)
+            raise "Unknown Element [#{node_name}]"
+          end
+
+          return node_class[idx]
+        end
+
+        def initialize(values = { })
+          @children = []
+          @attributes = self.class.attributes.inject({ }) { |h,n| h[n] = nil; next h }
+
+          values.each do |key, value|
+            case key
+            when Symbol # Attribute
+              if self.class.valid_attribute?(key)
+                @attributes[key] = value # TODO value class check
+              else
+                raise "Unknown attribute [#{key}]"
+              end
+            when String # Element
+              element_class = self.class.find_element_class(key)
+
+              case value
+              when Array
+                value.each do |v|
+                  add_child(element_class.new(v))
+                end
+              when Hash
+                add_child(element_class.new(value))
+              end
+            else
+              raise "Unknown key [#{key.inspect}]"
+            end
+          end
+        end
+
+        # Add children(element)
+        def <<(element)
+          @children << element
+
+          return self
+        end
+
+        alias_method :add_child, :<<
+
+          # Convert XML
+          #
+          # xml ::
+          def to_xml(xml = nil)
+            if xml
+              build_xml(xml)
+              return
+            else
+              builder = Nokogiri::XML::Builder.new(:encoding => "UTF-8") do |xml|
+                build_xml(xml)
+              end
+
+              return builder.doc.to_xml
+            end
+          end
+
+          def element_name
+            self.class.name.split("::").last.to_sym
+          end
+
+          def sorted_children
+            children_order = self.class.children_order
+            @children.sort do |a,b|
+              children_order.index(a.class) <=> children_order.index(b.class)
+            end
+          end
+
+          # Build xml by Nokogiri
+          def build_xml(xml)
+            xml.send(element_name, attributes) do
+              sorted_children.each do |element|
+                element.to_xml(xml)
+              end
+            end
+          end
+          private :build_xml
+
+          # Delete nil attributes on copy
+          def attributes
+            @attributes.dup.delete_if { |k,v| v.nil? }
+          end
+          private :attributes
+        end
+      end
+    end
+  end

data/lib/atna/version.rb

@@ -0,0 +1,3 @@
+module Atna
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: atna
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tetsuhisa MAKINO
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- tim.makino@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- atna.gemspec
+- lib/atna.rb
+- lib/atna/logger.rb
+- lib/atna/rfc3881.rb
+- lib/atna/udp_sender.rb
+- lib/atna/utils.rb
+- lib/atna/utils/xml_builder.rb
+- lib/atna/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: IHE ITI ATNA Udp socket logger with RFC3881 Message builder.
+test_files: []