orthanc 0.1.1 → 0.2.0

data/lib/orthanc/metadata.rb

@@ -0,0 +1,26 @@
+module Orthanc
+  class Metadata
+    include Response
+    attr_accessor :base_uri
+
+    def initialize(resource, id = nil)
+      self.base_uri = resource["/metadata/#{id}"]
+    end
+
+    # GET /{resourceType}/{id}/metadata/{name}
+    def fetch # Fetch API response
+      handle_response(base_uri.get)
+    end
+
+    # DELETE /{resourceType}/{id}/metadata/{name}
+    def delete
+      handle_response(base_uri.delete)
+    end
+
+    # PUT /{resourceType}/{id}/metadata/{name}
+    def modify(payload = {})
+      handle_response(base_uri.put(payload))
+    end
+
+  end
+end

data/lib/orthanc/modalities.rb

@@ -1,54 +1,56 @@
 module Orthanc
-  class Client
-    # ------------- Modalities -------------
-    # GET /modalities
-    def modalities
-      handle_response(base_uri["modalities"].get)
+  class Modality
+    include Response
+    attr_accessor :base_uri
+
+    def initialize(id = nil)
+      client = Client.new
+      self.base_uri = client.base_uri["/modalities/#{id}"]
     end
 
-    # GET /modalities/{dicom}
-    def modality(dicom)
-      handle_response(base_uri["modalities/#{dicom}"].get)
+    # GET /modalities, # GET /modalities/{id}
+    def fetch # Fetch API response
+      handle_response(base_uri.get)
     end
 
-    # DELETE /modalities/{dicom}
-    def delete_modality(dicom)
-      handle_response(base_uri["modalities/#{dicom}"].delete)
+    # DELETE /modalities/{id}
+    def delete
+      handle_response(base_uri.delete)
     end
 
     # PUT /modalities/{dicom}
-    def modify_modality(dicom, payload = {})
+    def modify(payload = {})
       handle_response(base_uri["modalities/#{dicom}"].put(payload))
     end
 
     # POST /modalities/{dicom}/echo
-    def modality_echo(dicom, payload = {}) # C-Echo SCU
-      handle_response(base_uri["modalities/#{dicom}/echo"].post(payload))
+    def echo(payload = {}) # C-Echo SCU
+      handle_response(base_uri["echo"].post(payload))
     end
 
     # POST /modalities/{dicom}/find
-    def modality_find(dicom, payload = {})
-      handle_response(base_uri["modalities/#{dicom}/find"].post(payload))
+    def find(payload = {})
+      handle_response(base_uri["find"].post(payload))
     end
 
     # POST /modalities/{dicom}/find-patient
-    def modality_find_patient(dicom, payload = {})
-      handle_response(base_uri["modalities/#{dicom}/find-patient"].post(payload))
+    def find_patient(payload = {})
+      handle_response(base_uri["find-patient"].post(payload))
     end
 
     # POST /modalities/{dicom}/find-series
-    def modality_find_series(dicom, payload = {})
-      handle_response(base_uri["modalities/#{dicom}/find-series"].post(payload))
+    def find_series(payload = {})
+      handle_response(base_uri["find-series"].post(payload))
     end
 
     # POST /modalities/{dicom}/find-study
-    def modality_find_study(dicom, payload = {})
-      handle_response(base_uri["modalities/#{dicom}/find-study"].post(payload))
+    def find_study(payload = {})
+      handle_response(base_uri["find-study"].post(payload))
     end
 
     # POST /modalities/{dicom}/store
-    def modality_store(dicom, payload = {}) # POST body = UUID series, UUID instance, or raw DICOM file
-      handle_response(base_uri["modalities/#{dicom}/store"].post(payload))
+    def store(payload = {}) # POST body = UUID series, UUID instance, or raw DICOM file
+      handle_response(base_uri["store"].post(payload))
     end
 
   end

data/lib/orthanc/patients.rb

@@ -1,153 +1,122 @@
 module Orthanc
-  class Client
-    # ------------- Patients -------------
-    # GET /patients
-    def all_patients
-      handle_response(base_uri["patients"].get)
+  class Patient
+    include Response
+    attr_accessor :base_uri
+
+    def initialize(id = nil)
+      client = Client.new
+      self.base_uri = client.base_uri["/patients/#{id}"]
     end
 
-    # GET /patients/{id}
-    def patient(id)
-      handle_response(base_uri["patients/#{id}"].get)
+    # GET /patients, # GET /patients/{id}
+    def fetch # Fetch API response
+      handle_response(base_uri.get)
     end
 
     # DELETE /patients/{id}
-    def delete_patient(id)
-      handle_response(base_uri["patients/#{id}"].delete)
+    def delete
+      handle_response(base_uri.delete)
     end
 
     # POST /patients/{id}/anonymize
-    def anonymize_patient(id, payload = {}) # https://code.google.com/p/orthanc/wiki/Anonymization
-      handle_response(base_uri["patients/#{id}/anonymize"].post(payload.to_s))
+    def anonymize(payload = {}) # https://code.google.com/p/orthanc/wiki/Anonymization
+      handle_response(base_uri["anonymize"].post(payload.to_s))
     end
 
     # GET /patients/{id}/archive
-    def archive_patient(id) # Create ZIP
-      base_uri["patients/#{id}/archive"].get # CAREFUL! Returns the whole zipfile
+    def archive # Create ZIP
+      base_uri["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
-      handle_response(base_uri["patients/#{id}/instances"].get)
+    def instances # Retrieve all the instances of this patient in a single REST call
+      handle_response(base_uri["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
+    def media # Create a ZIP archive for media storage with DICOMDIR
+      base_uri["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
-      handle_response(base_uri["patients/#{id}/modify"].post(payload.to_s))
+    def modify(payload = {}) # https://code.google.com/p/orthanc/wiki/Anonymization
+      handle_response(base_uri["modify"].post(payload.to_s))
     end
 
     # GET /patients/{id}/module
-    def patient_module(id)
-      handle_response(base_uri["patients/#{id}/module"].get)
+    def module
+      handle_response(base_uri["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)
+    def protected? # Protection against recycling: "0" means unprotected, "1" protected
+      num_to_bool(base_uri["protected"].get)
     end
 
     # PUT /patients/{id}/protected
-    def set_patient_protected(id, boolstatus = true) # Protection against recycling: "0" means unprotected, "1" protected
+    def protected(boolstatus = true) # Protection against recycling: "0" means unprotected, "1" protected
       status = bool_to_num(boolstatus)
-      base_uri["patients/#{id}/protected"].put("#{status}")
+      base_uri["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
-      handle_response(base_uri["patients/#{id}/series"].get)
+    def series # Retrieve all the series of this patient in a single REST call
+      handle_response(base_uri["series"].get)
     end
 
     # GET /patients/{id}/shared-tags
-    def patient_shared_tags(id) # "?simplify" argument to simplify output
-      handle_response(base_uri["patients/#{id}/shared-tags"].get)
+    def shared_tags(params = {}) # "?simplify" argument to simplify output
+      handle_response(base_uri["shared-tags"].get({params: params}))
     end
 
     # GET /patients/{id}/statistics
-    def patient_statistics(id)
-      handle_response(base_uri["patients/#{id}/statistics"].get)
+    def statistics
+      handle_response(base_uri["statistics"].get)
     end
 
     # GET /patients/{id}/studies
-    def patient_studies(id) # Retrieve all the studies of this patient in a single REST call
-      handle_response(base_uri["patients/#{id}/studies"].get)
+    def studies # Retrieve all the studies of this patient in a single REST call
+      handle_response(base_uri["studies"].get)
     end
 
-    # TODO: Polymorphic resourceType resources. Repetitive. must refactor
+    # ---------- Polymorphic resources ----------
+    # Attachments
 
     # GET /{resourceType}/{id}/attachments
-    def patient_attachments(id)
-      handle_response(base_uri["patients/#{id}/attachments"].get)
-    end
-
-    # DELETE /{resourceType}/{id}/attachments/{name}
-    def delete_patient_attachment(id, name)
-      handle_response(base_uri["patients/#{id}/attachments/#{name}"].delete)
-    end
-
-    # PUT /{resourceType}/{id}/attachments/{name}
-    def patient_attachment(id, name, payload = {})
-      handle_response(base_uri["patients/#{id}/attachments/#{name}"].put(payload))
-    end
-
-    # GET /{resourceType}/{id}/attachments/{name}/compressed-data
-    def patient_attachment_compressed_data(id, name)
-      handle_response(base_uri["patients/#{id}/attachments/#{name}/compressed-data"].get)
-    end
-
-    # GET /{resourceType}/{id}/attachments/{name}/compressed-md5
-    def patient_attachment_compressed_md5(id, name)
-      handle_response(base_uri["patients/#{id}/attachments/#{name}/compressed-md5"].get)
-    end
-
-    # GET /{resourceType}/{id}/attachments/{name}/compressed-size
-    def patient_attachment_compressed_size(id, name)
-      handle_response(base_uri["patients/#{id}/attachments/#{name}/compressed-size"].get)
+    def attachments_list # Orthanc endpoint response
+      handle_response(base_uri["attachments"].get)
     end
 
-    # GET /{resourceType}/{id}/attachments/{name}/data
-    def patient_attachment_data(id, name)
-      handle_response(base_uri["patients/#{id}/attachments/#{name}/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}/md5
-    def patient_attachment_md5(id, name)
-      handle_response(base_uri["patients/#{id}/attachments/#{name}/md5"].get)
-    end
-
-    # GET /{resourceType}/{id}/attachments/{name}/size
-    def patient_attachment_size(id, name)
-      handle_response(base_uri["patients/#{id}/attachments/#{name}/size"].get)
-    end
-
-    # POST /{resourceType}/{id}/attachments/{name}/verify-md5
-    def patient_attachment_verify_md5(id, name)
-      handle_response(base_uri["patients/#{id}/attachments/#{name}/verify-md5"].get)
-    end
+    # Metadata
 
     # GET /{resourceType}/{id}/metadata
-    def patient_all_metadata(id)
-      handle_response(base_uri["patients/#{id}/metadata"].get)
-    end
-
-    # GET /{resourceType}/{id}/metadata/{name}
-    def patient_metadata(id, name)
-      handle_response(base_uri["patients/#{id}/metadata/#{name}"].get)
-    end
-
-    # DELETE /{resourceType}/{id}/metadata/{name}
-    def patient_delete_metadata(id, name)
-      handle_response(base_uri["patients/#{id}/metadata/#{name}"].delete)
-    end
-
-    # PUT /{resourceType}/{id}/metadata/{name}
-    def patient_update_metadata(id, name, payload = {})
-      handle_response(base_uri["patients/#{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

data/lib/orthanc/peers.rb

@@ -1,29 +1,31 @@
 module Orthanc
-  class Client
-    # ------------- Peers -------------
-    # GET /peers
-    def peers # Get the list of all the registered plugins
-      handle_response(base_uri["peers"].get)
+  class Peer
+    include Response
+    attr_accessor :base_uri
+
+    def initialize(id = nil)
+      client = Client.new
+      self.base_uri = client.base_uri["/peers/#{id}"]
     end
 
-    # GET /peers/{peer}
-    def peer(peer)
-      handle_response(base_uri["peers/#{peer}"].get)
+    # GET /peers, # GET /peers/{id}
+    def fetch # Fetch API response
+      handle_response(base_uri.get)
     end
 
-    # DELETE /peers/{peer}
-    def delete_peer(peer)
-      handle_response(base_uri["peers/#{peer}"].delete)
+    # DELETE /peers/{id}
+    def delete
+      handle_response(base_uri.delete)
     end
 
     # PUT /peers/{peer}
-    def modify_peer(peer, payload = {})
-      handle_response(base_uri["peers/#{peer}"].put(payload))
+    def modify(payload = {})
+      handle_response(base_uri.put(payload))
     end
 
     # GET /peers/{peer}/store
-    def peer_store(peer, payload = {}) # POST body = UUID series, UUID instance, or raw DICOM file
-      handle_response(base_uri["peers/#{peer}/store"].post(payload))
+    def store(payload = {}) # POST body = UUID series, UUID instance, or raw DICOM file
+      handle_response(base_uri["store"].post(payload))
     end
 
   end

data/lib/orthanc/plugins.rb

@@ -1,19 +1,21 @@
 module Orthanc
-  class Client
-    # ------------- Plugins -------------
-    # GET /plugins
-    def plugins # Get the list of all the registered plugins
-      handle_response(base_uri["plugins"].get)
+  class Plugin
+    include Response
+    attr_accessor :base_uri
+
+    def initialize(id = nil)
+      client = Client.new
+      self.base_uri = client.base_uri["/plugins/#{id}"]
     end
 
     # GET /plugins/explorer.js
-    def plugins_explorerjs # Get the JavaScript code that is injected by plugins into Orthanc Explorer
-      handle_response(base_uri["plugins/explorer.js"].get)
+    def explorerjs # Get the JavaScript code that is injected by plugins into Orthanc Explorer
+      handle_response(base_uri["explorer.js"].get)
     end
 
     # GET /plugins/{id}
-    def plugin(id) # Get information about some plugin
-      handle_response(base_uri["plugins/#{id}"].get)
+    def fetch  # Fetch API response
+      handle_response(base_uri.get)
     end
 
   end

data/lib/orthanc/response.rb

@@ -0,0 +1,30 @@
+module Response
+
+    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 handle_response(response)
+      begin
+        # Try to parse response
+        parsed_response = JSON.parse(response)
+
+        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
+        end
+      rescue JSON::ParserError => e # If JSON parse fails, return original response
+        return response
+      end
+    end
+
+end

data/lib/orthanc/series.rb

@@ -1,141 +1,110 @@
 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?
-      handle_response(base_uri["series"].get)
+  class Series
+    include Response
+    attr_accessor :base_uri
+
+    def initialize(id = nil)
+      client = Client.new
+      self.base_uri = client.base_uri["/series/#{id}"]
     end
 
-    # GET /series/{id}
-    def series(id)
-      handle_response(base_uri["series/#{id}"].get)
+    # GET /series, # GET /series/{id}
+    def fetch # Fetch API response
+      handle_response(base_uri.get)
     end
 
     # DELETE /series/{id}
-    def delete_series(id)
-      handle_response(base_uri["series/#{id}"].delete)
+    def delete
+      handle_response(base_uri.delete)
     end
 
     # POST /series/{id}/anonymize
-    def anonymize_series(id, payload = {}) # https://code.google.com/p/orthanc/wiki/Anonymization
-      handle_response(base_uri["series/#{id}/anonymize"].post(payload.to_s))
+    def anonymize(payload = {}) # https://code.google.com/p/orthanc/wiki/Anonymization
+      handle_response(base_uri["anonymize"].post(payload.to_s))
     end
 
     # GET /series/{id}/archive
-    def archive_series(id) # Create ZIP
-      base_uri["series/#{id}/archive"].get # CAREFUL! Returns the whole zipfile
+    def archive # Create ZIP
+      base_uri["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
-      handle_response(base_uri["series/#{id}/instances"].get)
+    def instances # Retrieve all the instances of this patient in a single REST call
+      handle_response(base_uri["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
+    def media # Create a ZIP archive for media storage with DICOMDIR
+      base_uri["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
-      handle_response(base_uri["series/#{id}/modify"].post(payload.to_s))
+    def modify(payload = {}) # https://code.google.com/p/orthanc/wiki/Anonymization
+      handle_response(base_uri["modify"].post(payload.to_s))
     end
 
     # GET /series/{id}/module
-    def series_module(id)
-      handle_response(base_uri["series/#{id}/module"].get)
+    def module
+      handle_response(base_uri["module"].get)
     end
 
     # GET /series/{id}/patient
-    def series_patient(id)
-      handle_response(base_uri["series/#{id}/patient"].get)
+    def patient
+      handle_response(base_uri["patient"].get)
     end
 
     # GET /series/{id}/shared-tags
-    def series_shared_tags(id) # "?simplify" argument to simplify output
-      handle_response(base_uri["series/#{id}/shared-tags"].get)
+    def shared_tags(params = {}) # "?simplify" argument to simplify output
+      handle_response(base_uri["shared-tags"].get({params: params}))
     end
 
     # GET /series/{id}/statistics
-    def series_statistics(id)
-      handle_response(base_uri["series/#{id}/statistics"].get)
+    def statistics
+      handle_response(base_uri["statistics"].get)
     end
 
     # GET /series/{id}/study
-    def series_study(id)
-      handle_response(base_uri["series/#{id}/study"].get)
+    def study
+      handle_response(base_uri["study"].get)
     end
 
-    # TODO: Polymorphic resourceType resources. Repetitive. must refactor
+    # ---------- Polymorphic resources ----------
+    # Attachments
 
     # GET /{resourceType}/{id}/attachments
-    def series_attachments(id)
-      handle_response(base_uri["series/#{id}/attachments"].get)
-    end
-
-    # DELETE /{resourceType}/{id}/attachments/{name}
-    def delete_series_attachment(id, name)
-      handle_response(base_uri["series/#{id}/attachments/#{name}"].delete)
-    end
-
-    # PUT /{resourceType}/{id}/attachments/{name}
-    def series_attachment(id, name, payload = {})
-      handle_response(base_uri["series/#{id}/attachments/#{name}"].put(payload))
-    end
-
-    # GET /{resourceType}/{id}/attachments/{name}/compressed-data
-    def series_attachment_compressed_data(id, name)
-      handle_response(base_uri["series/#{id}/attachments/#{name}/compressed-data"].get)
-    end
-
-    # GET /{resourceType}/{id}/attachments/{name}/compressed-md5
-    def series_attachment_compressed_md5(id, name)
-      handle_response(base_uri["series/#{id}/attachments/#{name}/compressed-md5"].get)
-    end
-
-    # GET /{resourceType}/{id}/attachments/{name}/compressed-size
-    def series_attachment_compressed_size(id, name)
-      handle_response(base_uri["series/#{id}/attachments/#{name}/compressed-size"].get)
+    def attachments_list # Orthanc endpoint response
+      handle_response(base_uri["attachments"].get)
     end
 
-    # GET /{resourceType}/{id}/attachments/{name}/data
-    def series_attachment_data(id, name)
-      handle_response(base_uri["series/#{id}/attachments/#{name}/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}/md5
-    def series_attachment_md5(id, name)
-      handle_response(base_uri["series/#{id}/attachments/#{name}/md5"].get)
-    end
-
-    # GET /{resourceType}/{id}/attachments/{name}/size
-    def series_attachment_size(id, name)
-      handle_response(base_uri["series/#{id}/attachments/#{name}/size"].get)
-    end
-
-    # POST /{resourceType}/{id}/attachments/{name}/verify-md5
-    def series_attachment_verify_md5(id, name)
-      handle_response(base_uri["series/#{id}/attachments/#{name}/verify-md5"].get)
-    end
+    # Metadata
 
     # GET /{resourceType}/{id}/metadata
-    def series_all_metadata(id)
-      handle_response(base_uri["series/#{id}/metadata"].get)
-    end
-
-    # GET /{resourceType}/{id}/metadata/{name}
-    def series_metadata(id, name)
-      handle_response(base_uri["series/#{id}/metadata/#{name}"].get)
-    end
-
-    # DELETE /{resourceType}/{id}/metadata/{name}
-    def series_delete_metadata(id, name)
-      handle_response(base_uri["series/#{id}/metadata/#{name}"].delete)
-    end
-
-    # GET /{resourceType}/{id}/metadata/{name}
-    def series_update_metadata(id, name, payload = {})
-      handle_response(base_uri["series/#{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