orthanc 0.1.1 → 0.2.0

data/lib/orthanc/studies.rb

@@ -1,146 +1,115 @@
 module Orthanc
-  class Client
-    # ------------- Studies -------------
-    # GET /studies
-    def all_studies
-      handle_response(base_uri["studies"].get)
+  class Study
+    include Response
+    attr_accessor :base_uri
+
+    def initialize(id = nil)
+      client = Client.new
+      self.base_uri = client.base_uri["/studies/#{id}"]
     end
 
-    # GET /studies/{id}
-    def study(id)
-      handle_response(base_uri["studies/#{id}"].get)
+    # GET /studies, # GET /studies/{id}
+    def fetch # Fetch API response
+      handle_response(base_uri.get)
     end
 
     # DELETE /studies/{id}
-    def delete_study(id)
-      handle_response(base_uri["studies/#{id}"].delete)
+    def delete
+      handle_response(base_uri.delete)
     end
 
     # POST /studies/{id}/anonymize
-    def anonymize_study(id, payload = {}) # https://code.google.com/p/orthanc/wiki/Anonymization
-      handle_response(base_uri["studies/#{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 /studies/{id}/archive
-    def archive_study(id) # Create ZIP
-      base_uri["studies/#{id}/archive"].get # CAREFUL! Returns the whole zipfile
+    def archive # Create ZIP
+      base_uri["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
-      handle_response(base_uri["studies/#{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 /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
+    def media # Create a ZIP archive for media storage with DICOMDIR
+      base_uri["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
-      handle_response(base_uri["studies/#{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 /studies/{id}/module
-    def study_module(id)
-      handle_response(base_uri["studies/#{id}/module"].get)
+    def module
+      handle_response(base_uri["module"].get)
     end
 
     # GET /studies/{id}/module-patient
-    def study_module_patient(id)
-      handle_response(base_uri["studies/#{id}/module-patient"].get)
+    def module_patient
+      handle_response(base_uri["module-patient"].get)
     end
 
     # GET /studies/{id}/patient
-    def study_patient(id)
-      handle_response(base_uri["studies/#{id}/patient"].get)
+    def patient
+      handle_response(base_uri["patient"].get)
     end
 
     # GET /studies/{id}/series
-    def study_series(id) # Retrieve all the series of this patient in a single REST call
-      handle_response(base_uri["studies/#{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 /studies/{id}/shared-tags
-    def study_shared_tags(id) # "?simplify" argument to simplify output
-      handle_response(base_uri["studies/#{id}/shared-tags"].get)
+    def shared_tags(params = {}) # "?simplify" argument to simplify output
+      handle_response(base_uri["shared-tags"].get({params: params}))
     end
 
     # GET /studies/{id}/statistics
-    def study_statistics(id)
-      handle_response(base_uri["studies/#{id}/statistics"].get)
+    def statistics
+      handle_response(base_uri["statistics"].get)
     end
 
-    # TODO: Polymorphic resourceType resources. Repetitive. must refactor
+    # ---------- Polymorphic resources ----------
+    # Attachments
 
     # GET /{resourceType}/{id}/attachments
-    def study_attachments(id)
-      handle_response(base_uri["studies/#{id}/attachments"].get)
-    end
-
-    # DELETE /{resourceType}/{id}/attachments/{name}
-    def delete_study_attachment(id, name)
-      handle_response(base_uri["studies/#{id}/attachments/#{name}"].delete)
-    end
-
-    # PUT /{resourceType}/{id}/attachments/{name}
-    def study_attachment(id, name, payload = {})
-      handle_response(base_uri["studies/#{id}/attachments/#{name}"].put(payload))
-    end
-
-    # GET /{resourceType}/{id}/attachments/{name}/compressed-data
-    def study_attachment_compressed_data(id, name)
-      handle_response(base_uri["studies/#{id}/attachments/#{name}/compressed-data"].get)
-    end
-
-    # GET /{resourceType}/{id}/attachments/{name}/compressed-md5
-    def study_attachment_compressed_md5(id, name)
-      handle_response(base_uri["studies/#{id}/attachments/#{name}/compressed-md5"].get)
-    end
-
-    # GET /{resourceType}/{id}/attachments/{name}/compressed-size
-    def study_attachment_compressed_size(id, name)
-      handle_response(base_uri["studies/#{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 study_attachment_data(id, name)
-      handle_response(base_uri["studies/#{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 study_attachment_md5(id, name)
-      handle_response(base_uri["studies/#{id}/attachments/#{name}/md5"].get)
-    end
-
-    # GET /{resourceType}/{id}/attachments/{name}/size
-    def study_attachment_size(id, name)
-      handle_response(base_uri["studies/#{id}/attachments/#{name}/size"].get)
-    end
-
-    # POST /{resourceType}/{id}/attachments/{name}/verify-md5
-    def study_attachment_verify_md5(id, name)
-      handle_response(base_uri["studies/#{id}/attachments/#{name}/verify-md5"].get)
-    end
+    # Metadata
 
     # GET /{resourceType}/{id}/metadata
-    def study_all_metadata(id)
-      handle_response(base_uri["studies/#{id}/metadata"].get)
-    end
-
-    # GET /{resourceType}/{id}/metadata/{name}
-    def study_metadata(id, name)
-      handle_response(base_uri["studies/#{id}/metadata/#{name}"].get)
-    end
-
-    # DELETE /{resourceType}/{id}/metadata/{name}
-    def study_delete_metadata(id, name)
-      handle_response(base_uri["studies/#{id}/metadata/#{name}"].delete)
-    end
-
-    # PUT /{resourceType}/{id}/metadata/{name}
-    def study_update_metadata(id, name, payload = {})
-      handle_response(base_uri["studies/#{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/tools.rb

@@ -1,40 +1,46 @@
 module Orthanc
-  class Client
-    # ------------- Tools -------------
+  class Tool
+    include Response
+    attr_accessor :base_uri
+
+    def initialize(id = nil)
+      client = Client.new
+      self.base_uri = client.base_uri["tools"]
+    end
 
     # POST /tools/create-dicom
-    def tools_create_dicom(payload = {}) # Create and store a new DICOM instance (experimental)
-      handle_response(base_uri["tools/create-dicom"].post(payload))
+    def create_dicom(payload = {}) # Create and store a new DICOM instance (experimental)
+      handle_response(base_uri["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
+    def dicom_conformance # DICOM conformance statement of this version of Orthanc
+      base_uri["dicom-conformance"].get
     end
 
     # POST /tools/execute-script
-    def tools_execute_script(payload = {}) # Execute the Lua script in the POST body (experimental)
-      handle_response(base_uri["tools/execute-script"].post(payload))
+    def execute_script(payload = {}) # Execute the Lua script in the POST body (experimental)
+      handle_response(base_uri["execute-script"].post(payload))
     end
 
     # GET /tools/generate-uid
-    def tools_generate_uid(level) # "level" argument among "patient", "study", "series" and "instance"
-      handle_response(base_uri["tools/generate-uid"].get({params: {level: level}}))
+    def generate_uid(level) # "level" argument among "patient", "study", "series" and "instance"
+      handle_response(base_uri["generate-uid"].get({params: {level: level}}))
     end
 
     # POST /tools/lookup
-    def tools_lookup(payload = {}) # Map DICOM UIDs to Orthanc identifiers
-      handle_response(base_uri["tools/lookup"].post(payload))
+    def lookup(payload = {}) # Map DICOM UIDs to Orthanc identifiers
+      handle_response(base_uri["lookup"].post(payload))
     end
 
     # GET /tools/now
-    def tools_now # Returns the current datetime in the ISO 8601 format
-      base_uri["tools/now"].get
+    def now # Returns the current datetime in the ISO 8601 format
+      base_uri["now"].get
     end
 
     # POST /tools/reset
-    def tools_reset(payload = {}) # Hot restart of Orthanc, the configuration file will be read again
-      handle_response(base_uri["tools/reset"].post(payload))
+    def reset(payload = {}) # Hot restart of Orthanc, the configuration file will be read again
+      handle_response(base_uri["reset"].post(payload))
     end
 
   end

data/lib/orthanc/version.rb

@@ -1,3 +1,4 @@
 module Orthanc
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
+  ORTHANC_API_VERSION = "0.8.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orthanc
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Simon Rascovsky
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-17 00:00:00.000000000 Z
+date: 2015-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,12 +95,15 @@ files:
 - bin/console
 - bin/setup
 - lib/orthanc.rb
+- lib/orthanc/attachments.rb
 - lib/orthanc/client.rb
 - lib/orthanc/instances.rb
+- lib/orthanc/metadata.rb
 - lib/orthanc/modalities.rb
 - lib/orthanc/patients.rb
 - lib/orthanc/peers.rb
 - lib/orthanc/plugins.rb
+- lib/orthanc/response.rb
 - lib/orthanc/series.rb
 - lib/orthanc/studies.rb
 - lib/orthanc/tools.rb