dcm4chee 0.1.0

data/README.md

@@ -0,0 +1,45 @@
+## Dcm4chee
+
+[![Build Status](https://secure.travis-ci.org/menglifang/dcm4chee?branch=develop)](http://travis-ci.org/menglifang/dcm4chee)
+[![Dependency Status](https://gemnasium.com/menglifang/dcm4chee.png)](https://gemnasium.com/menglifang/dcm4chee)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/menglifang/dcm4chee)
+
+dcm4chee is a [rails
+engine](http://api.rubyonrails.org/classes/Rails/Engine.html) 
+which provides RESTful APIs for the most famous
+[dcm4chee](http://www.dcm4che.org).
+
+### Installation
+
+The engine interfaces with the dcm4chee archive through Jolokia (http://www.jolokia.org/), which provides a JMX interface with JSON over HTTP. To install Jolokia, simply download the .war and drop it in your archive's /server/default/deploy directory.
+
+Add the dcm4chee to your Gemfile.
+
+```ruby
+gem 'dcm4chee'
+```
+
+And then, run `bundle install` to install. That's it.
+
+### Development
+
+#### Check the docs
+
+```bash
+# Generated the docs
+yardoc
+
+# Start a web server for serving the docs
+yard server
+
+# Visit http://localhost:8808
+```
+
+#### Tests
+
+```bash
+bundle exec rspec
+
+# Or
+bundle exec rake spec
+```

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+

data/app/controllers/dcm4chee/api/v1/application_entities_controller.rb

@@ -0,0 +1,178 @@
+# -*- encoding: utf-8 -*-
+module Dcm4chee
+  module Api
+    module V1
+      class ApplicationEntitiesController < BaseController
+        respond_to :json
+
+        # List the application entities
+        #
+        # @example
+        #   # Request
+        #   GET /api/application_entities HTTP/1.1
+        #   Accept: application/vnd.menglifang.org; version=1
+        #
+        #   # Response
+        #   HTTP/1.1 200 OK
+        #   {
+        #     "application_entities": [{
+        #       "id": ...,
+        #       "title": ...,
+        #       "host": ...,
+        #       "port": ...,
+        #       "cipher_suites": ...,
+        #       "patient_id_issuer": ...,
+        #       "accession_number_issuer": ...,
+        #       "username": ...,
+        #       "password": ...,
+        #       "fs_group": ...,
+        #       "group": ...,
+        #       "description": ...,
+        #       "wado_url": ...,
+        #       "station_name": ...,
+        #       "institution": ...,
+        #       "department": ...,
+        #       "installed": ...,
+        #       "check_host": ...
+        #     }, ...]
+        #   }
+        def index
+          entities = Dcm4chee::ApplicationEntity.all(order: [:id.desc])
+
+          respond_with application_entities: entities
+        end
+
+        # Create a new application entity
+        #
+        # @example
+        #   # Request
+        #   POST /api/application_entities HTTP/1.1
+        #   Accept: application/vnd.menglifang.org; version=1
+        #   Content-Type: application/json
+        #
+        #   {
+        #     "application_entity": {
+        #       "title": ...,
+        #       "host": ...,
+        #       "port": ...,
+        #       "cipher_suites": ...,
+        #       "patient_id_issuer": ...,
+        #       "accession_number_issuer": ...,
+        #       "username": ...,
+        #       "password": ...,
+        #       "fs_group": ...,
+        #       "group": ...,
+        #       "description": ...,
+        #       "wado_url": ...,
+        #       "station_name": ...,
+        #       "institution": ...,
+        #       "department": ...,
+        #       "installed": ...
+        #     }
+        #   }
+        #
+        #   # Response
+        #   HTTP/1.1 201 Created
+        #
+        #   {
+        #     "id": ...,
+        #     "title": ...,
+        #     "host": ...,
+        #     "port": ...,
+        #     "cipher_suites": ...,
+        #     "patient_id_issuer": ...,
+        #     "accession_number_issuer": ...,
+        #     "username": ...,
+        #     "password": ...,
+        #     "fs_group": ...,
+        #     "group": ...,
+        #     "description": ...,
+        #     "wado_url": ...,
+        #     "station_name": ...,
+        #     "institution": ...,
+        #     "department": ...,
+        #     "installed": ...
+        #   }
+        def create
+          entity = Dcm4chee::ApplicationEntity.create_by_service(params[:application_entity])
+
+          render json: entity, status: :created
+        end
+
+        # Update an application entity
+        #
+        # @example
+        #   # Request
+        #   PUT /api/application_entities/... HTTP/1.1
+        #   Accept: application/vnd.menglifang.org; version=1
+        #   Content-Type: application/json
+        #
+        #   {
+        #     "application_entity": {
+        #       "title": ...,
+        #       "host": ...,
+        #       "port": ...,
+        #       "cipher_suites": ...,
+        #       "patient_id_issuer": ...,
+        #       "accession_number_issuer": ...,
+        #       "username": ...,
+        #       "password": ...,
+        #       "fs_group": ...,
+        #       "group": ...,
+        #       "description": ...,
+        #       "wado_url": ...,
+        #       "station_name": ...,
+        #       "institution": ...,
+        #       "department": ...,
+        #       "installed": ...
+        #     }
+        #   }
+        #
+        #   # Response
+        #   HTTP/1.1 200 OK
+        #
+        #   {
+        #     "id": ...,
+        #     "title": ...,
+        #     "host": ...,
+        #     "port": ...,
+        #     "cipher_suites": ...,
+        #     "patient_id_issuer": ...,
+        #     "accession_number_issuer": ...,
+        #     "username": ...,
+        #     "password": ...,
+        #     "fs_group": ...,
+        #     "group": ...,
+        #     "description": ...,
+        #     "wado_url": ...,
+        #     "station_name": ...,
+        #     "institution": ...,
+        #     "department": ...,
+        #     "installed": ...
+        #   }
+        def update
+          entity = Dcm4chee::ApplicationEntity.get!(params[:id])
+          entity.update_by_service(params[:application_entity])
+
+          render json: entity, status: :ok
+        end
+
+        # Delete an application entity
+        #
+        # @example
+        #   # Request
+        #   DELETE /api/application_entities/... HTTP/1.1
+        #   Accept: application/vnd.menglifang.org; version=1
+        #
+        #   # Response
+        #   HTTP/1.1 200 OK
+        def destroy
+          entity = Dcm4chee::ApplicationEntity.get!(params[:id])
+          entity.destroy_by_service
+
+          head :ok
+        end
+      end
+    end
+  end
+end

data/app/controllers/dcm4chee/api/v1/base_controller.rb

@@ -0,0 +1,15 @@
+module Dcm4chee
+  module Api
+    module V1
+      class BaseController < ApplicationController
+        before_filter :fill_param_q, only: :index
+
+        private
+
+        def fill_param_q
+          params[:q] ||= {}
+        end
+      end
+    end
+  end
+end

data/app/controllers/dcm4chee/api/v1/dicom_objects_controller.rb

@@ -0,0 +1,58 @@
+# -*- encoding: utf-8 -*-
+module Dcm4chee
+  module Api
+    module V1
+      class DicomObjectsController < BaseController
+        respond_to :json
+
+        # Move dicom objects
+        #
+        # Arguments:
+        #   destination_aet: The application entity which the dicom objects will be moved to.
+        #   study_iuids:     The studies will be moved.
+        #   series_iuids:    The series will be moved.
+        #   instance_iuids： The instances will be moved.
+        #
+        # @example
+        #   # Request
+        #   POST /api/dicom_objects/move HTTP/1.1
+        #   Accept: application/vnd.menglifang.org; version=1
+        #
+        #   {
+        #     "destination_aet": ...,
+        #     "study_iuids": [...],
+        #     "series_iuids": {
+        #       "...": [...],
+        #       ...
+        #     },
+        #     "instance_iuids": {
+        #       "...": {
+        #         "...": [...],
+        #         ...
+        #       },
+        #       ...
+        #     }
+        #   }
+        #
+        #   # Response
+        #   HTTP/1.1 200 OK
+        def move
+          dicom_object_manager.move(
+            params[:destination_aet],
+            params[:study_iuids],
+            params[:series_iuids],
+            params[:instance_iuids]
+          )
+
+          head :ok
+        end
+
+        private
+
+        def dicom_object_manager
+          @manager ||= DicomObjectManager.new
+        end
+      end
+    end
+  end
+end

data/app/controllers/dcm4chee/api/v1/file_systems_controller.rb

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+module Dcm4chee
+  module Api
+    module V1
+      class FileSystemsController < BaseController
+        respond_to :json
+
+        # List the file systems including the status of them.
+        #
+        # @example
+        #   # Request
+        #   GET /api/file_systems HTTP/1.1
+        #   Accept: application/vnd.menglifang.org; version=1
+        #
+        #   # 响应
+        #   HTTP/1.1 200 OK
+        #   {
+        #     "file_systems": [{
+        #       "id": ...,
+        #       "path": ...,
+        #       "total_space": ...,
+        #       "free_space": ...,
+        #       "used_space": ...,
+        #       "min_free_space": ...,
+        #       "expected_space_per_day": ...,
+        #       "remaining_days": ...
+        #     }, ...]
+        #   }
+        def index
+          file_systems = FileSystem.online
+
+          respond_with file_systems: file_systems
+        end
+      end
+    end
+  end
+end

data/app/controllers/dcm4chee/api/v1/instances_controller.rb

@@ -0,0 +1,68 @@
+# -*- encoding: utf-8 -*-
+module Dcm4chee
+  module Api
+    module V1
+      class InstancesController < BaseController
+        respond_to :json
+
+        # Search for instances. Supported querying conditions:
+        #   series_id     ID of a series
+        #
+        # Check {DataMapper::Searcher::ClassMethods} for supported
+        # querying operators.
+        #
+        # @example
+        #   # Request
+        #   GET /api/instances?q[series_id]=... HTTP/1.1
+        #   Accept: application/vnd.menglifang.org; version=1
+        #
+        #   # Response
+        #   HTTP/1.1 200 OK
+        #   {
+        #     "instances": [{
+        #       "id": ...,
+        #       "series_id": ...,
+        #       "created_at": ...,
+        #       "instance_no": ...,
+        #       "sop_cuid": ...,
+        #       "sop_iuid": ...,
+        #       "series_iuid": ...,
+        #       "study_iuid": ...,
+        #       "availability": ...,
+        #       "dcm_elements": [{
+        #         "name": ...,
+        #         "value": ...,
+        #         "tag": ...,
+        #         "value_representation": ...,
+        #         "length": ...
+        #       }, ...]
+        #     }, ...]
+        #   }
+        def index
+          instances = Instance.search(params[:q])
+
+          respond_with instances: instances
+        end
+
+        # Restore an instance from the trash.
+        #
+        # @example
+        #   # Request
+        #   POST /api/instances HTTP/1.1
+        #   Accept: application/vnd.menglifang.org; version=1
+        #   Content-Type: application/json
+        #
+        #   { "trashed_instance_id": ... }
+        #
+        #   # Response
+        #   HTTP/1.1 201 Created
+        def create
+          trashed_instance = TrashedInstance.get!(params[:trashed_instance_id])
+          trashed_instance.restore_from_trash
+
+          head :created
+        end
+      end
+    end
+  end
+end

data/app/controllers/dcm4chee/api/v1/modalities_controller.rb

@@ -0,0 +1,29 @@
+module Dcm4chee
+  module Api
+    module V1
+      class ModalitiesController < BaseController
+        respond_to :json
+
+        # List modalities
+        #
+        # @example
+        #   # Request
+        #   GET /api/modalities HTTP/1.1
+        #   Accept: application/vnd.menglifang.org; version=1
+        #
+        #   # Response
+        #   HTTP/1.1 200 OK
+        #   {
+        #     "modalities": [{
+        #       "name": ...
+        #     }, ...]
+        #   }
+        def index
+          modalities = Modality.all
+
+          render json: { modalities: modalities }
+        end
+      end
+    end
+  end
+end