orthanc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fdfad2aeeae25d4ff088160e28a91ea86b64fa01
+  data.tar.gz: d87077c820484914845e550b003562b5cb19b6b7
+SHA512:
+  metadata.gz: dbe6ececc0c65bc59f7da9f6dc76ebc06227dab0cad6b2af44cb7f259a742f225d9e6d91dc1daee4d45cc3bbaa76c10de30186e093976d0bb69cb4bf8133eeb3
+  data.tar.gz: 7f5ac39bbe99b695cce5c3099c954144bbaf12914fd46f9463bc337881d072bf8a34f8d040739903c48c91395975fe8ac2faf1ae1fc1b4578202862ecc50627a

data/.gitignore

@@ -0,0 +1,12 @@
+lib/.DS_Store
+lib/orthanc/.DS_Store
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

data/Gemfile

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

data/README.md

@@ -0,0 +1,52 @@
+# Orthanc-ruby
+
+##### A Ruby implementation of the [Orthanc](http://orthanc-server.com) DICOM server v0.8.6 REST API
+
+##### Extremely Alpha!! Not ready for production. Anything may change, including resource nesting and naming schemes.
+
+(This is my first API client gem, experienced help or advice would be most appreciated) :)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'orthanc'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install orthanc
+
+## Usage
+The gem tries to follow the Orthanc API naming scheme as closely as possible, converting methods and response items to snake case to make the experience more ruby-like.
+
+  api=Orthanc::Client.new("localhost", "8042")
+  api.all_patients
+  api.all_patients.first
+  api.system.database_version => 5
+  api.statistics.count_studies => 14
+
+You get the picture. 
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/orthanc/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
+
+## License
+
+MIT License

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "orthanc"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/orthanc.rb

@@ -0,0 +1,9 @@
+require "orthanc/version"
+
+require 'rest-client'
+require 'recursive-open-struct'
+require 'plissken'
+require 'orthanc/client'
+
+module Orthanc
+end

data/lib/orthanc/client.rb

@@ -0,0 +1,72 @@
+require 'orthanc/tools'
+require 'orthanc/plugins'
+require 'orthanc/modalities'
+require 'orthanc/peers'
+require 'orthanc/patients'
+require 'orthanc/studies'
+require 'orthanc/series'
+require 'orthanc/instances'
+
+module Orthanc
+  class Client
+
+    attr_accessor :base_uri
+
+    def initialize(host,port = 8042)
+      self.base_uri = RestClient::Resource.new("http://#{host}:#{port}")
+    end
+
+    # ------------- General -------------
+    def system
+      objectify(base_uri["system"].get)
+    end
+
+    def statistics
+      objectify(base_uri["statistics"].get)
+    end
+
+    def changes(params = {}) # "last", "limit" and "since" arguments
+      objectify(base_uri["changes"].get({params: params}))
+    end
+
+    def delete_changes(params = {}) # "last", "limit" and "since" arguments
+      objectify(base_uri["changes"].delete({params: params}))
+    end
+
+    def exports(params = {}) # "last", "limit" and "since" arguments
+      objectify(base_uri["exports"].get({params: params}))
+    end
+
+    def delete_exports(params = {}) # "last", "limit" and "since" arguments
+      objectify(base_uri["exports"].delete({params: params}))
+    end
+
+
+    private
+
+    def bool_to_num(bool)
+      return 0 if bool == false
+      return 1 if bool == true
+    end
+
+    def num_to_bool(num)
+      return false if num == "0"
+      return true if num == "1"
+    end
+
+    def lowkey(h)
+      Hash[h.map{|k,v| v.class == Array ? [k,v.map{|r| f r}.to_a] : [k.downcase,v]}]
+    end
+
+    def objectify(response)
+      if JSON.parse(response).class == Array
+        return JSON.parse(response)
+      elsif JSON.parse(response).class == Hash
+        return RecursiveOpenStruct.new(JSON.parse(response).to_snake_keys, recurse_over_arrays: true )
+      else
+        return response
+      end
+    end
+
+  end
+end

data/lib/orthanc/instances.rb

@@ -0,0 +1,223 @@
+module Orthanc
+  class Client
+    # ------------- Instances -------------
+
+    # GET /instances
+    def all_instances
+      objectify(base_uri["instances"].get)
+    end
+
+    # POST /instances
+    def instances(dicom_file) # POST = Add the new DICOM file given in the POST body
+      objectify(base_uri["instances"].post(dicom_file))
+    end
+
+    # GET /instances/{id}
+    def instance(id)
+      objectify(base_uri["instances/#{id}"].get)
+    end
+
+    # DELETE /instances/{id}
+    def delete_instance(id)
+      objectify(base_uri["instances/#{id}"].delete)
+    end
+
+    # POST /instances/{id}/anonymize
+    def anonymize_instance(id, payload = {}) # https://code.google.com/p/orthanc/wiki/Anonymization
+      objectify(base_uri["instances/#{id}/anonymize"].post(payload))
+    end
+
+    # GET /instances/{id}/content/
+    def instance_content(id) # List the first-level DICOM tags
+      objectify(base_uri["instances/#{id}/frames"].get)
+    end
+
+    # GET /instances/{id}/content/{group}-{element}
+    def instance_content_tag(id, group, element) # Raw access to the value of DICOM tags (comprising the padding character)
+      objectify(base_uri["instances/#{id}/content/#{group}-#{element}"].get)
+    end
+
+    # GET /instances/{id}/content/{group}-{element}/{index}/...
+    def instance_content_sequence(id, group, element, index) # Raw access to the content of DICOM sequences
+      objectify(base_uri["instances/#{id}/content/#{group}-#{element}/#{index}"].get)
+    end
+
+    # POST /instances/{id}/export
+    def instance_export(id) # Write the DICOM file in the filesystem where Orthanc is running
+      objectify(base_uri["instances/#{id}/export"].post)
+    end   
+
+    # GET /instances/{id}/file
+    def instance_file(id)
+      objectify(base_uri["instances/#{id}/file"].get)
+    end 
+
+    # GET /instances/{id}/frames
+    def instance_frames(id) # Instance frames array
+      objectify(base_uri["instances/#{id}/frames"].get)
+    end    
+
+    # GET /instances/{id}/frames/{frameNumber}/image-int16
+    def instance_frame_image_int16(id, frame_number) # Truncated image to the [-32768;32767] range
+      objectify(base_uri["instances/#{id}/frames/#{frame_number}/image-int16"].get)
+    end
+
+    # GET /instances/{id}/frames/{frameNumber}/image-uint16
+    def instance_frame_image_uint16(id, frame_number) # Truncated image to the [0;65535] range
+      objectify(base_uri["instances/#{id}/frames/#{frame_number}/image-uint16"].get)
+    end
+
+    # GET /instances/{id}/frames/{frameNumber}/image-uint8
+    def instance_frame_image_uint8(id, frame_number) # Truncated image to the [0;255] range
+      objectify(base_uri["instances/#{id}/frames/#{frame_number}/image-uint8"].get)
+    end
+
+    # GET /instances/{id}/frames/{frameNumber}/matlab
+    def instance_frame_matlab(id, frame_number) # a = eval(urlread('http://localhost:8042/instances/.../matlab'))
+      objectify(base_uri["instances/#{id}/frames/#{frame_number}/matlab"].get)
+    end
+
+    # GET /instances/{id}/frames/{frameNumber}/preview
+    def instance_preview(id, frame_number) # Rescaled image (so that all the range [0;255] is used)
+      objectify(base_uri["instances/#{id}/frames/#{frame_number}/preview"].get)
+    end
+
+    # GET /instances/{id}/image-int16
+    def instance_image_int16(id) # Truncated image to the [-32768;32767] range
+      objectify(base_uri["instances/#{id}/image-int16"].get)
+    end
+
+    # GET /instances/{id}/image-uint16
+    def instance_image_uint16(id) # Truncated image to the [0;65535] range
+      objectify(base_uri["instances/#{id}/image-uint16"].get)
+    end
+
+    # GET /instances/{id}/image-uint8
+    def instance_image_uint8(id) # Truncated image to the [0;255] range
+      objectify(base_uri["instances/#{id}/image-uint8"].get)
+    end
+
+    # GET /instances/{id}/matlab
+    def instance_matlab(id) # a = eval(urlread('http://localhost:8042/instances/.../matlab'))
+      objectify(base_uri["instances/#{id}/matlab"].get)
+    end
+
+    # POST /instances/{id}/modify
+    def modify_instance(id, payload = {}) # https://code.google.com/p/orthanc/wiki/Anonymization
+      objectify(base_uri["instances/#{id}/modify"].post(payload))
+    end
+
+    # GET /instances/{id}/module
+    def instance_module(id)
+      objectify(base_uri["instances/#{id}/module"].get)
+    end
+
+    # GET /instances/{id}/patient
+    def instance_patient(id)
+      objectify(base_uri["instances/#{id}/patient"].get)
+    end
+
+    # GET /instances/{id}/preview
+    def instance_preview(id) # Rescaled image (so that all the range [0;255] is used)
+      objectify(base_uri["instances/#{id}/preview"].get)
+    end
+
+    # GET /instances/{id}/series
+    def instance_series(id)
+      objectify(base_uri["instances/#{id}/series"].get)
+    end
+
+    # GET /instances/{id}/simplified-tags
+    def instance_shared_tags(id) # "?simplify" argument to simplify output
+      objectify(base_uri["instances/#{id}/shared-tags"].get)
+    end
+
+    # GET /instances/{id}/statistics
+    def instance_statistics(id)
+      objectify(base_uri["instances/#{id}/statistics"].get)
+    end
+
+    # GET /instances/{id}/study
+    def instance_study(id)
+      objectify(base_uri["instances/#{id}/study"].get)
+    end
+
+    # GET /instances/{id}/tags
+    def instance_tags(id) # TODO: "?simplify" argument to simplify output (same as "simplified-tags")
+      objectify(base_uri["instances/#{id}/tags"].get)
+    end
+
+    # TODO: Polymorphic resourceType resources. Repetitive. must refactor
+
+    # GET /{resourceType}/{id}/attachments
+    def instance_attachments(id)
+      objectify(base_uri["instances/#{id}/attachments"].get)
+    end
+
+    # DELETE /{resourceType}/{id}/attachments/{name}
+    def delete_instance_attachment(id, name)
+      objectify(base_uri["instances/#{id}/attachments/#{name}"].delete)
+    end
+
+    # PUT /{resourceType}/{id}/attachments/{name}
+    def instance_attachment(id, name, payload = {})
+      objectify(base_uri["instances/#{id}/attachments/#{name}"].put(payload))
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/compressed-data
+    def instance_attachment_compressed_data(id, name)
+      objectify(base_uri["instances/#{id}/attachments/#{name}/compressed-data"].get)
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/compressed-md5
+    def instance_attachment_compressed_md5(id, name)
+      objectify(base_uri["instances/#{id}/attachments/#{name}/compressed-md5"].get)
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/compressed-size
+    def instance_attachment_compressed_size(id, name)
+      objectify(base_uri["instances/#{id}/attachments/#{name}/compressed-size"].get)
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/data
+    def instance_attachment_data(id, name)
+      objectify(base_uri["instances/#{id}/attachments/#{name}/data"].get)
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/md5
+    def instance_attachment_md5(id, name)
+      objectify(base_uri["instances/#{id}/attachments/#{name}/md5"].get)
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/size
+    def instance_attachment_size(id, name)
+      objectify(base_uri["instances/#{id}/attachments/#{name}/size"].get)
+    end
+
+    # POST /{resourceType}/{id}/attachments/{name}/verify-md5
+    def instance_attachment_verify_md5(id, name)
+      objectify(base_uri["instances/#{id}/attachments/#{name}/verify-md5"].get)
+    end
+
+    # GET /{resourceType}/{id}/metadata
+    def instance_all_metadata(id)
+      objectify(base_uri["instances/#{id}/metadata"].get)
+    end
+
+    # GET /{resourceType}/{id}/metadata/{name}
+    def instance_metadata(id, name)
+      objectify(base_uri["instances/#{id}/metadata/#{name}"].get)
+    end
+
+    # DELETE /{resourceType}/{id}/metadata/{name}
+    def instance_delete_metadata(id, name)
+      objectify(base_uri["instances/#{id}/metadata/#{name}"].delete)
+    end
+
+    # PUT /{resourceType}/{id}/metadata/{name}
+    def instance_update_metadata(id, name, payload = {})
+      objectify(base_uri["instances/#{id}/metadata/#{name}"].put(payload))
+    end
+
+  end
+end

data/lib/orthanc/modalities.rb

@@ -0,0 +1,55 @@
+module Orthanc
+  class Client
+    # ------------- Modalities -------------
+    # GET /modalities
+    def modalities
+      objectify(base_uri["modalities"].get)
+    end
+
+    # GET /modalities/{dicom}
+    def modality(dicom)
+      objectify(base_uri["modalities/#{dicom}"].get)
+    end
+
+    # DELETE /modalities/{dicom}
+    def delete_modality(dicom)
+      objectify(base_uri["modalities/#{dicom}"].delete)
+    end
+
+    # PUT /modalities/{dicom}
+    def modify_modality(dicom)
+      objectify(base_uri["modalities/#{dicom}"].put)
+    end
+
+    # POST /modalities/{dicom}/echo
+    def modality_echo(dicom, payload = {}) # C-Echo SCU
+      objectify(base_uri["modalities/#{dicom}/echo"].post(payload))
+    end
+
+    # POST /modalities/{dicom}/find
+    def modality_find(dicom, payload = {})
+      objectify(base_uri["modalities/#{dicom}/find"].post(payload))
+    end
+
+    # POST /modalities/{dicom}/find-patient
+    def modality_find_patient(dicom, payload = {})
+      objectify(base_uri["modalities/#{dicom}/find-patient"].post(payload))
+    end
+
+    # POST /modalities/{dicom}/find-series
+    def modality_find_series(dicom, payload = {})
+      objectify(base_uri["modalities/#{dicom}/find-series"].post(payload))
+    end
+
+    # POST /modalities/{dicom}/find-study
+    def modality_find_study(dicom, payload = {})
+      objectify(base_uri["modalities/#{dicom}/find-study"].post(payload))
+    end
+
+    # POST /modalities/{dicom}/store
+    def modality_store(dicom, payload = {}) # POST body = UUID series, UUID instance, or raw DICOM file
+      objectify(base_uri["modalities/#{dicom}/store"].post(payload))
+    end
+
+  end
+end

data/lib/orthanc/patients.rb

@@ -0,0 +1,154 @@
+module Orthanc
+  class Client
+    # ------------- Patients -------------
+    # GET /patients
+    def all_patients
+      objectify(base_uri["patients"].get)
+    end
+
+    # GET /patients/{id}
+    def patient(id)
+      objectify(base_uri["patients/#{id}"].get)
+    end
+
+    # DELETE /patients/{id} 
+    def delete_patient(id)
+      objectify(base_uri["patients/#{id}"].delete)
+    end
+
+    # POST /patients/{id}/anonymize
+    def anonymize_patient(id, payload = {}) # https://code.google.com/p/orthanc/wiki/Anonymization
+      objectify(base_uri["patients/#{id}/anonymize"].post(payload))
+    end
+
+    # GET /patients/{id}/archive
+    def archive_patient(id) # Create ZIP
+      base_uri["patients/#{id}/archive"].get # CAREFUL! Returns the whole zipfile
+    end
+
+    # GET /patients/{id}/instances
+    def patient_instances(id) # Retrieve all the instances of this patient in a single REST call
+      objectify(base_uri["patients/#{id}/instances"].get)
+    end
+
+    # GET /patients/{id}/media
+    def patient_media(id) # Create a ZIP archive for media storage with DICOMDIR
+      base_uri["patients/#{id}/media"].get # CAREFUL! Returns the whole zipfile
+    end
+
+    # POST /patients/{id}/modify
+    def modify_patient(id, payload = {}) # https://code.google.com/p/orthanc/wiki/Anonymization
+      objectify(base_uri["patients/#{id}/modify"].post(payload))
+    end
+
+    # GET /patients/{id}/module
+    def patient_module(id)
+      objectify(base_uri["patients/#{id}/module"].get)
+    end
+
+    # GET /patients/{id}/protected
+    def is_patient_protected?(id) # Protection against recycling: "0" means unprotected, "1" protected
+      num_to_bool(base_uri["patients/#{id}/protected"].get)
+    end
+
+    # PUT /patients/{id}/protected
+    def set_patient_protected(id, boolstatus = true) # Protection against recycling: "0" means unprotected, "1" protected
+      status = bool_to_num(boolstatus)
+      base_uri["patients/#{id}/protected"].put("#{status}")
+      return nil # API returns ""
+    end
+
+    # GET /patients/{id}/series
+    def patient_series(id) # Retrieve all the series of this patient in a single REST call
+      objectify(base_uri["patients/#{id}/series"].get)
+    end
+
+    # GET /patients/{id}/shared-tags
+    def patient_shared_tags(id) # "?simplify" argument to simplify output
+      objectify(base_uri["patients/#{id}/shared-tags"].get)
+    end
+
+    # GET /patients/{id}/statistics
+    def patient_statistics(id)
+      objectify(base_uri["patients/#{id}/statistics"].get)
+    end
+
+    # GET /patients/{id}/studies
+    def patient_studies(id) # Retrieve all the studies of this patient in a single REST call
+      objectify(base_uri["patients/#{id}/studies"].get)
+    end
+
+    # TODO: Polymorphic resourceType resources. Repetitive. must refactor
+
+    # GET /{resourceType}/{id}/attachments
+    def patient_attachments(id)
+      objectify(base_uri["patients/#{id}/attachments"].get)
+    end
+
+    # DELETE /{resourceType}/{id}/attachments/{name}
+    def delete_patient_attachment(id, name)
+      objectify(base_uri["patients/#{id}/attachments/#{name}"].delete)
+    end
+
+    # PUT /{resourceType}/{id}/attachments/{name}
+    def patient_attachment(id, name, payload = {})
+      objectify(base_uri["patients/#{id}/attachments/#{name}"].put(payload))
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/compressed-data
+    def patient_attachment_compressed_data(id, name)
+      objectify(base_uri["patients/#{id}/attachments/#{name}/compressed-data"].get)
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/compressed-md5
+    def patient_attachment_compressed_md5(id, name)
+      objectify(base_uri["patients/#{id}/attachments/#{name}/compressed-md5"].get)
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/compressed-size
+    def patient_attachment_compressed_size(id, name)
+      objectify(base_uri["patients/#{id}/attachments/#{name}/compressed-size"].get)
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/data
+    def patient_attachment_data(id, name)
+      objectify(base_uri["patients/#{id}/attachments/#{name}/data"].get)
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/md5
+    def patient_attachment_md5(id, name)
+      objectify(base_uri["patients/#{id}/attachments/#{name}/md5"].get)
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/size
+    def patient_attachment_size(id, name)
+      objectify(base_uri["patients/#{id}/attachments/#{name}/size"].get)
+    end
+
+    # POST /{resourceType}/{id}/attachments/{name}/verify-md5
+    def patient_attachment_verify_md5(id, name)
+      objectify(base_uri["patients/#{id}/attachments/#{name}/verify-md5"].get)
+    end
+
+    # GET /{resourceType}/{id}/metadata
+    def patient_all_metadata(id)
+      objectify(base_uri["patients/#{id}/metadata"].get)
+    end
+
+    # GET /{resourceType}/{id}/metadata/{name}
+    def patient_metadata(id, name)
+      objectify(base_uri["patients/#{id}/metadata/#{name}"].get)
+    end
+
+    # DELETE /{resourceType}/{id}/metadata/{name}
+    def patient_delete_metadata(id, name)
+      objectify(base_uri["patients/#{id}/metadata/#{name}"].delete)
+    end
+
+    # PUT /{resourceType}/{id}/metadata/{name}
+    def patient_update_metadata(id, name, payload = {})
+      objectify(base_uri["patients/#{id}/metadata/#{name}"].put(payload))
+    end
+    
+  end
+end

data/lib/orthanc/peers.rb

@@ -0,0 +1,30 @@
+module Orthanc
+  class Client
+    # ------------- Peers -------------
+    # GET /peers
+    def peers # Get the list of all the registered plugins
+      objectify(base_uri["peers"].get)
+    end
+
+    # GET /peers/{peer}
+    def peer(peer)
+      objectify(base_uri["peers/#{peer}"].get)
+    end
+
+    # DELETE /peers/{peer}
+    def delete_peer(peer)
+      objectify(base_uri["peers/#{peer}"].delete)
+    end
+
+    # PUT /peers/{peer}
+    def modify_peer(peer, payload = {})
+      objectify(base_uri["peers/#{peer}"].put(payload))
+    end
+
+    # GET /peers/{peer}/store
+    def peer_store(peer, payload = {}) # POST body = UUID series, UUID instance, or raw DICOM file
+      objectify(base_uri["peers/#{peer}/store"].post(payload))
+    end   
+
+  end
+end

data/lib/orthanc/plugins.rb

@@ -0,0 +1,20 @@
+module Orthanc
+  class Client
+    # ------------- Plugins -------------
+    # GET /plugins
+    def plugins # Get the list of all the registered plugins
+      objectify(base_uri["plugins"].get)
+    end
+
+    # GET /plugins/explorer.js
+    def plugins_explorerjs # Get the JavaScript code that is injected by plugins into Orthanc Explorer
+      objectify(base_uri["plugins/explorer.js"].get) 
+    end
+
+    # GET /plugins/{id}
+    def plugin(id) # Get information about some plugin
+      objectify(base_uri["plugins/#{id}"].get)
+    end    
+
+  end
+end

data/lib/orthanc/series.rb

@@ -0,0 +1,142 @@
+module Orthanc
+  class Client
+    # ------------- Series -------------
+    # GET /series
+    def all_series # Darn DICOM, why did you have to call them something that's spelled the same singular and plural?
+      objectify(base_uri["series"].get)
+    end
+
+    # GET /series/{id}
+    def series(id)
+      objectify(base_uri["series/#{id}"].get)
+    end
+
+    # DELETE /series/{id}
+    def delete_series(id)
+      objectify(base_uri["series/#{id}"].delete)
+    end
+
+    # POST /series/{id}/anonymize
+    def anonymize_series(id, payload = {}) # https://code.google.com/p/orthanc/wiki/Anonymization
+      objectify(base_uri["series/#{id}/anonymize"].post(payload))
+    end
+
+    # GET /series/{id}/archive
+    def archive_series(id) # Create ZIP
+      base_uri["series/#{id}/archive"].get # CAREFUL! Returns the whole zipfile
+    end
+
+    # GET /series/{id}/instances
+    def series_instances(id) # Retrieve all the instances of this patient in a single REST call
+      objectify(base_uri["series/#{id}/instances"].get)
+    end
+
+    # GET /series/{id}/media
+    def series_media(id) # Create a ZIP archive for media storage with DICOMDIR
+      base_uri["series/#{id}/media"].get # CAREFUL! Returns the whole zipfile
+    end
+
+    # POST /series/{id}/modify
+    def modify_series(id, payload = {}) # https://code.google.com/p/orthanc/wiki/Anonymization
+      objectify(base_uri["series/#{id}/modify"].post(payload))
+    end
+
+    # GET /series/{id}/module
+    def series_module(id)
+      objectify(base_uri["series/#{id}/module"].get)
+    end
+
+    # GET /series/{id}/patient
+    def series_patient(id)
+      objectify(base_uri["series/#{id}/patient"].get)
+    end
+
+    # GET /series/{id}/shared-tags
+    def series_shared_tags(id) # "?simplify" argument to simplify output
+      objectify(base_uri["series/#{id}/shared-tags"].get)
+    end
+
+    # GET /series/{id}/statistics
+    def series_statistics(id)
+      objectify(base_uri["series/#{id}/statistics"].get)
+    end
+
+    # GET /series/{id}/study
+    def series_study(id)
+      objectify(base_uri["series/#{id}/study"].get)
+    end
+
+    # TODO: Polymorphic resourceType resources. Repetitive. must refactor
+
+    # GET /{resourceType}/{id}/attachments
+    def series_attachments(id)
+      objectify(base_uri["series/#{id}/attachments"].get)
+    end
+
+    # DELETE /{resourceType}/{id}/attachments/{name}
+    def delete_series_attachment(id, name)
+      objectify(base_uri["series/#{id}/attachments/#{name}"].delete)
+    end
+
+    # PUT /{resourceType}/{id}/attachments/{name}
+    def series_attachment(id, name, payload = {})
+      objectify(base_uri["series/#{id}/attachments/#{name}"].put(payload))
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/compressed-data
+    def series_attachment_compressed_data(id, name)
+      objectify(base_uri["series/#{id}/attachments/#{name}/compressed-data"].get)
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/compressed-md5
+    def series_attachment_compressed_md5(id, name)
+      objectify(base_uri["series/#{id}/attachments/#{name}/compressed-md5"].get)
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/compressed-size
+    def series_attachment_compressed_size(id, name)
+      objectify(base_uri["series/#{id}/attachments/#{name}/compressed-size"].get)
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/data
+    def series_attachment_data(id, name)
+      objectify(base_uri["series/#{id}/attachments/#{name}/data"].get)
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/md5
+    def series_attachment_md5(id, name)
+      objectify(base_uri["series/#{id}/attachments/#{name}/md5"].get)
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/size
+    def series_attachment_size(id, name)
+      objectify(base_uri["series/#{id}/attachments/#{name}/size"].get)
+    end
+
+    # POST /{resourceType}/{id}/attachments/{name}/verify-md5
+    def series_attachment_verify_md5(id, name)
+      objectify(base_uri["series/#{id}/attachments/#{name}/verify-md5"].get)
+    end
+
+    # GET /{resourceType}/{id}/metadata
+    def series_all_metadata(id)
+      objectify(base_uri["series/#{id}/metadata"].get)
+    end
+
+    # GET /{resourceType}/{id}/metadata/{name}
+    def series_metadata(id, name)
+      objectify(base_uri["series/#{id}/metadata/#{name}"].get)
+    end
+
+    # DELETE /{resourceType}/{id}/metadata/{name}
+    def series_delete_metadata(id, name)
+      objectify(base_uri["series/#{id}/metadata/#{name}"].delete)
+    end
+
+    # GET /{resourceType}/{id}/metadata/{name}
+    def series_update_metadata(id, name, payload = {})
+      objectify(base_uri["series/#{id}/metadata/#{name}"].put(payload))
+    end
+    
+  end
+end

data/lib/orthanc/studies.rb

@@ -0,0 +1,147 @@
+module Orthanc
+  class Client
+    # ------------- Studies -------------
+    # GET /studies
+    def all_studies
+      objectify(base_uri["studies"].get)
+    end
+
+    # GET /studies/{id}
+    def study(id)
+      objectify(base_uri["studies/#{id}"].get)
+    end
+
+    # DELETE /studies/{id}
+    def delete_study(id)
+      objectify(base_uri["studies/#{id}"].delete)
+    end
+
+    # POST /studies/{id}/anonymize
+    def anonymize_study(id, payload = {}) # https://code.google.com/p/orthanc/wiki/Anonymization
+      objectify(base_uri["studies/#{id}/anonymize"].post(payload))
+    end
+
+    # GET /studies/{id}/archive
+    def archive_study(id) # Create ZIP
+      base_uri["studies/#{id}/archive"].get # CAREFUL! Returns the whole zipfile
+    end
+
+    # GET /studies/{id}/instances
+    def study_instances(id) # Retrieve all the instances of this patient in a single REST call
+      objectify(base_uri["studies/#{id}/instances"].get)
+    end
+
+    # GET /studies/{id}/media
+    def study_media(id) # Create a ZIP archive for media storage with DICOMDIR
+      base_uri["studies/#{id}/media"].get # CAREFUL! Returns the whole zipfile
+    end
+
+    # POST /studies/{id}/modify
+    def modify_study(id, payload = {}) # https://code.google.com/p/orthanc/wiki/Anonymization
+      objectify(base_uri["studies/#{id}/modify"].post(payload))
+    end
+
+    # GET /studies/{id}/module
+    def study_module(id)
+      objectify(base_uri["studies/#{id}/module"].get)
+    end
+
+    # GET /studies/{id}/module-patient
+    def study_module_patient(id)
+      objectify(base_uri["studies/#{id}/module-patient"].get)
+    end
+
+    # GET /studies/{id}/patient
+    def study_patient(id)
+      objectify(base_uri["studies/#{id}/patient"].get)
+    end
+
+    # GET /studies/{id}/series
+    def study_series(id) # Retrieve all the series of this patient in a single REST call
+      objectify(base_uri["studies/#{id}/series"].get)
+    end
+
+    # GET /studies/{id}/shared-tags
+    def study_shared_tags(id) # "?simplify" argument to simplify output
+      objectify(base_uri["studies/#{id}/shared-tags"].get)
+    end
+
+    # GET /studies/{id}/statistics
+    def study_statistics(id)
+      objectify(base_uri["studies/#{id}/statistics"].get)
+    end
+
+    # TODO: Polymorphic resourceType resources. Repetitive. must refactor
+
+    # GET /{resourceType}/{id}/attachments
+    def study_attachments(id)
+      objectify(base_uri["studies/#{id}/attachments"].get)
+    end
+
+    # DELETE /{resourceType}/{id}/attachments/{name}
+    def delete_study_attachment(id, name)
+      objectify(base_uri["studies/#{id}/attachments/#{name}"].delete)
+    end
+
+    # PUT /{resourceType}/{id}/attachments/{name}
+    def study_attachment(id, name, payload = {})
+      objectify(base_uri["studies/#{id}/attachments/#{name}"].put(payload))
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/compressed-data
+    def study_attachment_compressed_data(id, name)
+      objectify(base_uri["studies/#{id}/attachments/#{name}/compressed-data"].get)
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/compressed-md5
+    def study_attachment_compressed_md5(id, name)
+      objectify(base_uri["studies/#{id}/attachments/#{name}/compressed-md5"].get)
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/compressed-size
+    def study_attachment_compressed_size(id, name)
+      objectify(base_uri["studies/#{id}/attachments/#{name}/compressed-size"].get)
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/data
+    def study_attachment_data(id, name)
+      objectify(base_uri["studies/#{id}/attachments/#{name}/data"].get)
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/md5
+    def study_attachment_md5(id, name)
+      objectify(base_uri["studies/#{id}/attachments/#{name}/md5"].get)
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/size
+    def study_attachment_size(id, name)
+      objectify(base_uri["studies/#{id}/attachments/#{name}/size"].get)
+    end
+
+    # POST /{resourceType}/{id}/attachments/{name}/verify-md5
+    def study_attachment_verify_md5(id, name)
+      objectify(base_uri["studies/#{id}/attachments/#{name}/verify-md5"].get)
+    end
+
+    # GET /{resourceType}/{id}/metadata
+    def study_all_metadata(id)
+      objectify(base_uri["studies/#{id}/metadata"].get)
+    end
+
+    # GET /{resourceType}/{id}/metadata/{name}
+    def study_metadata(id, name)
+      objectify(base_uri["studies/#{id}/metadata/#{name}"].get)
+    end
+
+    # DELETE /{resourceType}/{id}/metadata/{name}
+    def study_delete_metadata(id, name)
+      objectify(base_uri["studies/#{id}/metadata/#{name}"].delete)
+    end
+
+    # PUT /{resourceType}/{id}/metadata/{name}
+    def study_update_metadata(id, name, payload = {})
+      objectify(base_uri["studies/#{id}/metadata/#{name}"].put(payload))
+    end
+    
+  end
+end

data/lib/orthanc/tools.rb

@@ -0,0 +1,41 @@
+module Orthanc
+  class Client
+    # ------------- Tools -------------
+
+    # POST /tools/create-dicom
+    def tools_create_dicom(payload = {}) # Create and store a new DICOM instance (experimental)
+      objectify(base_uri["tools/create-dicom"].post(payload))
+    end
+
+    # GET /tools/dicom-conformance
+    def tools_dicom_conformance # DICOM conformance statement of this version of Orthanc
+      base_uri["tools/dicom-conformance"].get
+    end
+
+    # POST /tools/execute-script
+    def tools_execute_script(payload = {}) # Execute the Lua script in the POST body (experimental)
+      objectify(base_uri["tools/execute-script"].post(payload))
+    end
+
+    # GET /tools/generate-uid
+    def tools_generate_uid(level) # "level" argument among "patient", "study", "series" and "instance"
+      objectify(base_uri["tools/generate-uid"].get({params: {level: level}}))
+    end
+
+    # POST /tools/lookup
+    def tools_lookup(payload = {}) # Map DICOM UIDs to Orthanc identifiers
+      objectify(base_uri["tools/lookup"].post(payload))
+    end
+
+    # GET /tools/now
+    def tools_now # Returns the current datetime in the ISO 8601 format
+      base_uri["tools/now"].get
+    end
+
+    # POST /tools/reset
+    def tools_reset(payload = {}) # Hot restart of Orthanc, the configuration file will be read again
+      objectify(base_uri["tools/reset"].post(payload))
+    end
+
+  end
+end

data/lib/orthanc/version.rb

@@ -0,0 +1,3 @@
+module Orthanc
+  VERSION = "0.1.0"
+end

data/orthanc.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'orthanc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "orthanc"
+  spec.version       = Orthanc::VERSION
+  spec.authors       = ["Simon Rascovsky"]
+  spec.email         = ["simonmd@gmail.com"]
+
+  spec.summary       = "Client for the Orthanc DICOM server API"
+  spec.description   = "Client for the Orthanc DICOM server REST API"
+  spec.homepage      = "https://github.com/simonmd/orthanc-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+
+  spec.add_dependency 'rest-client', "~> 1.8"
+  spec.add_dependency 'recursive-open-struct', "~> 0.6.3"
+  spec.add_dependency 'plissken', "~> 0.2.0"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: orthanc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Simon Rascovsky
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: recursive-open-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+- !ruby/object:Gem::Dependency
+  name: plissken
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: Client for the Orthanc DICOM server REST API
+email:
+- simonmd@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/orthanc.rb
+- lib/orthanc/client.rb
+- lib/orthanc/instances.rb
+- lib/orthanc/modalities.rb
+- lib/orthanc/patients.rb
+- lib/orthanc/peers.rb
+- lib/orthanc/plugins.rb
+- lib/orthanc/series.rb
+- lib/orthanc/studies.rb
+- lib/orthanc/tools.rb
+- lib/orthanc/version.rb
+- orthanc.gemspec
+homepage: https://github.com/simonmd/orthanc-ruby
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Client for the Orthanc DICOM server API
+test_files: []