orthanc 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd7892469761f2610ebec1e93d457212a0231f4a
-  data.tar.gz: 6b5a8cbd7aac358337ca577e914997479473d97a
+  metadata.gz: 509d31ee74414e383409a5189892149d32457ce2
+  data.tar.gz: 9867650b3e71e828cc86ae3c1096b1220fb0d792
 SHA512:
-  metadata.gz: 1c6b7a5e8a156cf63bc64e80847d5f319dd3c9a197aec2622d49223feb451d2765d12d2a6e4410959c8815387bcaba61004ae77144a914701054a8ff0c257a50
-  data.tar.gz: 3541b04589e433c39e98cc8c56b1490efa2e843d98bc92e5b329d8cd6516eeb69b59afb3ef8d2ba88ce6694539894d60c9fb827ffd47195799a111a776d18208
+  metadata.gz: 2fc432f1593ad9c8a64c8042de72fc93360b36873f909fee6841977bdb533cb65ecd4db6b375f37a782a4e4a7a9a6cf279d4d5422f3355c4124b93955d653e0f
+  data.tar.gz: eda048fbf6e437af42013473290af66fd1234efc4d1f344372ad83a460f1f3e15d7d08294135e8230de03d43214237e6a731d3577a1cd44cf6d93ea78daacc96

data/README.md

@@ -1,10 +1,17 @@
 # Orthanc-ruby
 
-##### A Ruby implementation of the [Orthanc](http://orthanc-server.com) DICOM server v0.8.6 REST API
+#### 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.
+---
+
+**Alpha!! Not ready for production. Anything may change, including resource nesting and naming schemes.**
+
+---
+
+###Attention: The gem now implements the orthanc resources as multilevel methods, to make it more Ruby-like
+
+_(This is my first API client gem, experienced help or advice would be most appreciated)_ :)
 
-(This is my first API client gem, experienced help or advice would be most appreciated) :)
 
 ## Installation
 
@@ -28,8 +35,12 @@ Or install it yourself as:
 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.patients # All patients as instances for method chaining
+    api.patients_list # Patient array, from Orthanc response
+    pat = api.patients.first # First patient (instance)
+
+  pat.shared_tags(simplify:true) # Patient's shared tags (simplified)
+
     api.system.database_version => 5
     api.statistics.count_studies => 14
 
@@ -39,7 +50,13 @@ You can see what Orthanc API resources have been mapped in the gem, and their st
 
 Basic documentation can be found in [here](http://www.rubydoc.info/github/simonmd/orthanc-ruby/master/Orthanc/Client)
 
+## Backlog
 
+ - Methods that return a file should be handled by ruby
+ - Test attachments (not sure how they are implemented in Orthanc)
+ - Handle network errors, return false if 500 Server error? (eg. echo)
+ - Test peers
+ - Write automated tests
 
 ## Contributing
 

data/lib/orthanc/attachments.rb

@@ -0,0 +1,57 @@
+module Orthanc
+  class Attachment
+    include Response
+    attr_accessor :base_uri
+
+    def initialize(resource, id = nil)
+      self.base_uri = resource["/attachments/#{id}"]
+    end
+
+
+    # DELETE /{resourceType}/{id}/attachments/{name}
+    def delete_attachment
+      handle_response(base_uri["attachments/#{name}"].delete)
+    end
+
+    # PUT /{resourceType}/{id}/attachments/{name}
+    def modify(payload = {})
+      handle_response(base_uri["attachments/#{name}"].put(payload))
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/compressed-data
+    def compressed_data
+      handle_response(base_uri["compressed-data"].get)
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/compressed-md5
+    def compressed_md5
+      handle_response(base_uri["compressed-md5"].get)
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/compressed-size
+    def compressed_size
+      handle_response(base_uri["compressed-size"].get)
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/data
+    def data
+      handle_response(base_uri["data"].get)
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/md5
+    def md5
+      handle_response(base_uri["md5"].get)
+    end
+
+    # GET /{resourceType}/{id}/attachments/{name}/size
+    def size
+      handle_response(base_uri["size"].get)
+    end
+
+    # POST /{resourceType}/{id}/attachments/{name}/verify-md5
+    def verify_md5
+      handle_response(base_uri["verify-md5"].get)
+    end
+
+  end
+end

data/lib/orthanc/client.rb

@@ -1,3 +1,5 @@
+require 'orthanc/response'
+
 require 'orthanc/tools'
 require 'orthanc/plugins'
 require 'orthanc/modalities'
@@ -6,68 +8,191 @@ require 'orthanc/patients'
 require 'orthanc/studies'
 require 'orthanc/series'
 require 'orthanc/instances'
+require 'orthanc/attachments'
+require 'orthanc/metadata'
 
 module Orthanc
   class Client
 
+    include Response
     attr_accessor :base_uri
 
-    def initialize(host,port = 8042)
+    def initialize(host = "localhost", port = 8042)
       self.base_uri = RestClient::Resource.new("http://#{host}:#{port}")
     end
 
     # ------------- General -------------
+
+    # GET /system
     def system
       handle_response(base_uri["system"].get)
     end
 
+    # GET /statistics
     def statistics
       handle_response(base_uri["statistics"].get)
     end
 
+    # GET /changes
     def changes(params = {}) # "last", "limit" and "since" arguments
       handle_response(base_uri["changes"].get({params: params}))
     end
 
+    # DELETE /changes
     def delete_changes(params = {}) # "last", "limit" and "since" arguments
       handle_response(base_uri["changes"].delete({params: params}))
     end
 
+    # GET /exports
     def exports(params = {}) # "last", "limit" and "since" arguments
       handle_response(base_uri["exports"].get({params: params}))
     end
 
+    # DELETE /exports
     def delete_exports(params = {}) # "last", "limit" and "since" arguments
       handle_response(base_uri["exports"].delete({params: params}))
     end
 
 
-    private
+    # ------------- Plugins -------------
+
+    # GET /plugins
+    def plugins_list # Orthanc endpoint response
+      handle_response(base_uri["plugins"].get)
+    end
+
+    # GET /plugins
+    def plugins(id = nil) # As class instances, for method chaining
+      if id
+        return Plugin.new(id)
+      else
+        a = []
+        handle_response(base_uri["plugins"].get).each do |id|
+          a << Plugin.new(id)
+        end
+        return a
+      end
+    end
+
+
+    # ------------- Tools -------------
+
+    # GET /tools
+    def tools
+      Tool.new
+    end
+
+
+    # ------------- Modalities -------------
 
-    def bool_to_num(bool)
-      return 0 if bool == false
-      return 1 if bool == true
+    def modalities_list # Orthanc endpoint response
+      handle_response(base_uri["modalities"].get)
     end
 
-    def num_to_bool(num)
-      return false if num == "0"
-      return true if num == "1"
+    def modalities(dicom = nil) # As class instances, for method chaining
+      if dicom
+        return Modality.new(dicom)
+      else
+        a = []
+        handle_response(base_uri["modalities"].get).each do |dicom|
+          a << Modality.new(dicom)
+        end
+        return a
+      end
+    end
+
+
+    # ------------- Modalities -------------
+
+    def peers_list # Orthanc endpoint response
+      handle_response(base_uri["peers"].get)
     end
 
-    def handle_response(response)
-      begin
-        # Try to parse response
-        parsed_response = JSON.parse(response)
+    def peers(peer = nil) # As class instances, for method chaining
+      if peer
+        return Peer.new(peer)
+      else
+        a = []
+        handle_response(base_uri["peers"].get).each do |peer|
+          a << Peer.new(peer)
+        end
+        return a
+      end
+    end
+
+
+    # ------------- Patients -------------
+
+    def patients_list # Orthanc endpoint response
+      handle_response(base_uri["patients"].get)
+    end
+
+    def patients(id = nil) # As class instances, for method chaining
+      if id
+        return Patient.new(id)
+      else
+        a = []
+        handle_response(base_uri["patients"].get).each do |id|
+          a << Patient.new(id)
+        end
+        return a
+      end
+    end
+
+
+    # ------------- Studies -------------
+
+    def studies_list # Orthanc endpoint response
+      handle_response(base_uri["studies"].get)
+    end
+
+    def studies(id = nil) # As class instances, for method chaining
+      if id
+        return Study.new(id)
+      else
+        a = []
+        handle_response(base_uri["studies"].get).each do |id|
+          a << Study.new(id)
+        end
+        return a
+      end
+    end
+
+
+    # ------------- Series -------------
+
+    def series_list # Orthanc endpoint response
+      handle_response(base_uri["series"].get)
+    end
+
+    def series(id = nil) # As class instances, for method chaining
+      if id
+        return Series.new(id)
+      else
+        a = []
+        handle_response(base_uri["series"].get).each do |id|
+          a << Series.new(id)
+        end
+        return a
+      end
+    end
+
+
+    # ------------- Instances -------------
+
+    def instances_list # Orthanc endpoint response
+      handle_response(base_uri["instances"].get)
+    end
 
-        if parsed_response.class == Array
-          return parsed_response
-        elsif parsed_response.class == Hash
-          return RecursiveOpenStruct.new(parsed_response.to_snake_keys, recurse_over_arrays: true )
-        else
-          return response
+    def instances(id = nil) # As class instances, for method chaining
+      if id
+        return Instance.new(id)
+      else
+        a = []
+        handle_response(base_uri["instances"].get).each do |id|
+          a << Instance.new(id)
         end
-      rescue JSON::ParserError => e # If JSON parse fails, return original response
-        return response
+        return a
       end
     end
 

data/lib/orthanc/instances.rb

@@ -1,222 +1,185 @@
 module Orthanc
-  class Client
-    # ------------- Instances -------------
+  class Instance
+    include Response
+    attr_accessor :base_uri
 
-    # GET /instances
-    def all_instances
-      handle_response(base_uri["instances"].get)
+    def initialize(id = nil)
+      client = Client.new
+      self.base_uri = client.base_uri["/instances/#{id}"]
     end
 
-    # POST /instances
-    def instances(dicom_file) # POST = Add the new DICOM file given in the POST body
-      handle_response(base_uri["instances"].post(dicom_file))
-    end
-
-    # GET /instances/{id}
-    def instance(id)
-      handle_response(base_uri["instances/#{id}"].get)
+    # GET /instances, # GET /instances/{id}
+    def fetch # Fetch API response
+      handle_response(base_uri.get)
     end
 
     # DELETE /instances/{id}
-    def delete_instance(id)
-      handle_response(base_uri["instances/#{id}"].delete)
+    def delete
+      handle_response(base_uri.delete)
     end
 
     # POST /instances/{id}/anonymize
-    def anonymize_instance(id, payload = {}) # https://code.google.com/p/orthanc/wiki/Anonymization
-      base_uri["instances/#{id}/anonymize"].post(payload.to_s)
+    def anonymize(payload = {}) # https://code.google.com/p/orthanc/wiki/Anonymization
+      base_uri["anonymize"].post(payload.to_s)
     end
 
     # GET /instances/{id}/content/
-    def instance_content(id) # List the first-level DICOM tags
-      handle_response(base_uri["instances/#{id}/frames"].get)
+    def content # List the first-level DICOM tags
+      handle_response(base_uri["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)
-      handle_response(base_uri["instances/#{id}/content/#{group}-#{element}"].get)
+    def content_tag(group, element) # Raw access to the value of DICOM tags (comprising the padding character)
+      handle_response(base_uri["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
-      handle_response(base_uri["instances/#{id}/content/#{group}-#{element}/#{index}"].get)
+    def content_sequence(group, element, index) # Raw access to the content of DICOM sequences
+      handle_response(base_uri["content/#{group}-#{element}/#{index}"].get)
     end
 
     # POST /instances/{id}/export
-    def instance_export(id, payload = {}) # Write the DICOM file in the filesystem where Orthanc is running
-      base_uri["instances/#{id}/export"].post(payload)
+    def export(payload = {}) # Write the DICOM file in the filesystem where Orthanc is running
+      base_uri["export"].post(payload)
     end
 
     # GET /instances/{id}/file
-    def instance_file(id)
-      base_uri["instances/#{id}/file"].get
+    def file
+      base_uri["file"].get
     end
 
     # GET /instances/{id}/frames
-    def instance_frames(id) # Instance frames array
-      handle_response(base_uri["instances/#{id}/frames"].get)
+    def frames # Instance frames array
+      handle_response(base_uri["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
-      base_uri["instances/#{id}/frames/#{frame_number}/image-int16"].get
+    def frame_image_int16(frame_number) # Truncated image to the [-32768;32767] range
+      base_uri["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
-      base_uri["instances/#{id}/frames/#{frame_number}/image-uint16"].get
+    def frame_image_uint16(frame_number) # Truncated image to the [0;65535] range
+      base_uri["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
-      base_uri["instances/#{id}/frames/#{frame_number}/image-uint8"].get
+    def frame_image_uint8(frame_number) # Truncated image to the [0;255] range
+      base_uri["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'))
-      base_uri["instances/#{id}/frames/#{frame_number}/matlab"].get
+    def frame_matlab(frame_number) # a = eval(urlread('http://localhost:8042/instances/.../matlab'))
+      base_uri["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)
-      base_uri["instances/#{id}/frames/#{frame_number}/preview"].get
+    def preview(frame_number) # Rescaled image (so that all the range [0;255] is used)
+      base_uri["frames/#{frame_number}/preview"].get
     end
 
     # GET /instances/{id}/image-int16
-    def instance_image_int16(id) # Truncated image to the [-32768;32767] range
-      base_uri["instances/#{id}/image-int16"].get
+    def image_int16 # Truncated image to the [-32768;32767] range
+      base_uri["image-int16"].get
     end
 
     # GET /instances/{id}/image-uint16
-    def instance_image_uint16(id) # Truncated image to the [0;65535] range
-      base_uri["instances/#{id}/image-uint16"].get
+    def image_uint16 # Truncated image to the [0;65535] range
+      base_uri["image-uint16"].get
     end
 
     # GET /instances/{id}/image-uint8
-    def instance_image_uint8(id) # Truncated image to the [0;255] range
-      base_uri["instances/#{id}/image-uint8"].get
+    def image_uint8 # Truncated image to the [0;255] range
+      base_uri["image-uint8"].get
     end
 
     # GET /instances/{id}/matlab
-    def instance_matlab(id) # a = eval(urlread('http://localhost:8042/instances/.../matlab'))
-      base_uri["instances/#{id}/matlab"].get
+    def matlab # a = eval(urlread('http://localhost:8042/instances/.../matlab'))
+      base_uri["matlab"].get
     end
 
     # POST /instances/{id}/modify
-    def modify_instance(id, payload = {}) # https://code.google.com/p/orthanc/wiki/Anonymization
-      base_uri["instances/#{id}/modify"].post(payload.to_s)
+    def modify(payload = {}) # https://code.google.com/p/orthanc/wiki/Anonymization
+      base_uri["modify"].post(payload.to_s)
     end
 
     # GET /instances/{id}/module
-    def instance_module(id)
-      handle_response(base_uri["instances/#{id}/module"].get)
+    def module
+      handle_response(base_uri["module"].get)
     end
 
     # GET /instances/{id}/patient
-    def instance_patient(id)
-      handle_response(base_uri["instances/#{id}/patient"].get)
+    def patient
+      handle_response(base_uri["patient"].get)
     end
 
     # GET /instances/{id}/preview
-    def instance_preview(id) # Rescaled image (so that all the range [0;255] is used)
-      handle_response(base_uri["instances/#{id}/preview"].get)
+    def preview # Rescaled image (so that all the range [0;255] is used)
+      handle_response(base_uri["preview"].get)
     end
 
     # GET /instances/{id}/series
-    def instance_series(id)
-      handle_response(base_uri["instances/#{id}/series"].get)
+    def series
+      handle_response(base_uri["series"].get)
     end
 
     # GET /instances/{id}/simplified-tags
-    def instance_simplified_tags(id) # "?simplify" argument to simplify output
-      handle_response(base_uri["instances/#{id}/simplified-tags"].get)
+    def simplified_tags(params = {}) # "?simplify" argument to simplify output
+      handle_response(base_uri["simplified-tags"].get({params: params}))
     end
 
     # GET /instances/{id}/statistics
-    def instance_statistics(id)
-      handle_response(base_uri["instances/#{id}/statistics"].get)
+    def statistics
+      handle_response(base_uri["statistics"].get)
     end
 
     # GET /instances/{id}/study
-    def instance_study(id)
-      handle_response(base_uri["instances/#{id}/study"].get)
+    def study
+      handle_response(base_uri["study"].get)
     end
 
     # GET /instances/{id}/tags
-    def instance_tags(id) # TODO: "?simplify" argument to simplify output (same as "simplified-tags")
-      handle_response(base_uri["instances/#{id}/tags"].get)
+    def tags(params = {}) # TODO: "?simplify" argument to simplify output (same as "simplified-tags")
+      handle_response(base_uri["tags"].get({params: params}))
     end
 
-    # TODO: Polymorphic resourceType resources. Repetitive. must refactor
+    # ---------- Polymorphic resources ----------
+    # Attachments
 
     # GET /{resourceType}/{id}/attachments
-    def instance_attachments(id)
-      handle_response(base_uri["instances/#{id}/attachments"].get)
-    end
-
-    # DELETE /{resourceType}/{id}/attachments/{name}
-    def delete_instance_attachment(id, name)
-      handle_response(base_uri["instances/#{id}/attachments/#{name}"].delete)
-    end
-
-    # PUT /{resourceType}/{id}/attachments/{name}
-    def instance_attachment(id, name, payload = {})
-      handle_response(base_uri["instances/#{id}/attachments/#{name}"].put(payload))
+    def attachments_list # Orthanc endpoint response
+      handle_response(base_uri["attachments"].get)
     end
 
-    # GET /{resourceType}/{id}/attachments/{name}/compressed-data
-    def instance_attachment_compressed_data(id, name)
-      handle_response(base_uri["instances/#{id}/attachments/#{name}/compressed-data"].get)
+    def attachments(id = nil)
+      if id
+        return Attachment.new(base_uri, id)
+      else
+        a = []
+        handle_response(base_uri["attachments"].get).each do |id|
+          a << Attachment.new(base_uri, id)
+        end
+        return a
+      end
     end
 
-    # GET /{resourceType}/{id}/attachments/{name}/compressed-md5
-    def instance_attachment_compressed_md5(id, name)
-      handle_response(base_uri["instances/#{id}/attachments/#{name}/compressed-md5"].get)
-    end
-
-    # GET /{resourceType}/{id}/attachments/{name}/compressed-size
-    def instance_attachment_compressed_size(id, name)
-      handle_response(base_uri["instances/#{id}/attachments/#{name}/compressed-size"].get)
-    end
-
-    # GET /{resourceType}/{id}/attachments/{name}/data
-    def instance_attachment_data(id, name)
-      handle_response(base_uri["instances/#{id}/attachments/#{name}/data"].get)
-    end
-
-    # GET /{resourceType}/{id}/attachments/{name}/md5
-    def instance_attachment_md5(id, name)
-      handle_response(base_uri["instances/#{id}/attachments/#{name}/md5"].get)
-    end
-
-    # GET /{resourceType}/{id}/attachments/{name}/size
-    def instance_attachment_size(id, name)
-      handle_response(base_uri["instances/#{id}/attachments/#{name}/size"].get)
-    end
-
-    # POST /{resourceType}/{id}/attachments/{name}/verify-md5
-    def instance_attachment_verify_md5(id, name)
-      handle_response(base_uri["instances/#{id}/attachments/#{name}/verify-md5"].get)
-    end
+    # Metadata
 
     # GET /{resourceType}/{id}/metadata
-    def instance_all_metadata(id)
-      handle_response(base_uri["instances/#{id}/metadata"].get)
-    end
-
-    # GET /{resourceType}/{id}/metadata/{name}
-    def instance_metadata(id, name)
-      handle_response(base_uri["instances/#{id}/metadata/#{name}"].get)
-    end
-
-    # DELETE /{resourceType}/{id}/metadata/{name}
-    def instance_delete_metadata(id, name)
-      handle_response(base_uri["instances/#{id}/metadata/#{name}"].delete)
-    end
-
-    # PUT /{resourceType}/{id}/metadata/{name}
-    def instance_update_metadata(id, name, payload = {})
-      handle_response(base_uri["instances/#{id}/metadata/#{name}"].put(payload))
+    def metadata_list # Orthanc endpoint response
+      handle_response(base_uri["metadata"].get)
+    end
+
+    def metadata(name = nil) # As class instances, for method chaining
+      if name
+        return Metadata.new(base_uri, name)
+      else
+        a = []
+        handle_response(base_uri["metadata"].get).each do |name|
+          a << Metadata.new(base_uri, name)
+        end
+        return a
+      end
     end
 
   end