dmtd_vbmapp_data 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62145702d8eaf8720862e4ebd8f05d5c5af9e9f0
-  data.tar.gz: e5bbd03554809fea9e11b2e08506b3ae426dc989
+  metadata.gz: 9618795492ef685583687baee0ce2fbb3acdc0a1
+  data.tar.gz: f1349008bd09c3e3b5126de94591bfb8f4b240f2
 SHA512:
-  metadata.gz: ea1e65ece5e633fe43f0bd943c8d71d816b058ba691f5c79eb40d74c7a87bb3d07724d17c864b461b848797f3aab1263a3ab8627468122496bd6c14d14679397
-  data.tar.gz: 4fb9cb8b6fadab766af986123a5b4471883077466ffa7f9b1bec236792f27a2f82463bb046d385ef9bcec67ed276212cb98dbc1c13dc1a46311aa6bb0389c04f
+  metadata.gz: 9e488f5adcb9479715f9b30e5fa2c0b6f43bf6d560a0518aba61d8035272a9135f4a05b941dabb4049f1d8c84ad5db450e7b084db9dcfae56320f01c1f7d655a
+  data.tar.gz: b49afb5f8cd3b56ce191a198736ed63bfa7c3d85ba2a0e0faf1571310762e5fb8cbf758482a4ace439fbf522e203878674fc68bbbc8558db84ec7a0e675c6a5e

data/CHANGELOG.md

@@ -4,4 +4,8 @@
 
 * Added support for setting the X-DocType via DmtdFoundation.configure document_type: 'text' || 'html'
 * Fixed a bug in the client_spec. It now specifies the correct organization id.
-* Changed Client.new() to allow specification of the id or code and then be used throughout the API without needing to pull it from the server.
+* Changed Client.new() to allow specification of the id or code and then be used throughout the API without needing to pull it from the server.
+
+## 1.0.2
+
+* Added an AssessmentReport class that simplifies the functionality of generating an IEP report

data/lib/dmtd_vbmapp_data/assessment_report.rb

@@ -0,0 +1,111 @@
+require 'dmtd_vbmapp_data/request_helpers'
+
+module DmtdVbmappData
+
+  # Provides for the tailoring of a VB-MAPP report from the VB-MAPP Data Server.
+  #
+  # This class retrieves the report for the given client and performs the following operations on the report data
+  # before returning the final JSON:
+  #
+  # * All variables are substituted
+  # * All conditional statements are executed and only the sections that apply are returned
+  #
+  # The only step remaining is to format the resulting JSON into whatever output format is required (e.g. RTF, PDF, HTML, etc.).
+  class AssessmentReport
+
+    # Resolver is a block that takes a single argument, a string, which is the variable name.  The result
+    # should be the value to bind to that variable.
+    attr_reader :resolver
+
+    # The client for which the report will be generated
+    attr_reader :client
+
+    # Initializes the receiver with the given options:
+    #
+    # This method does *not* block, simply creates an accessor and returns
+    #
+    # Params:
+    # +client+:: The client for which to run the report
+    # +resolver+:: See +resolver+ above
+    def initialize(opts, &resolver)
+      @client = opts.fetch(:client)
+      @resolver = resolver
+    end
+
+    # Returns the JSON for the IEP report (see https://datamtd.atlassian.net/wiki/pages/viewpage.action?pageId=19267590) for the
+    # full format.
+    #
+    # The following transformations are made to the server JSON:
+    #
+    # * The top-level 'response' node is removed
+    # * All variables are substituted according to +resolver+
+    # * All conditionals are evaluated
+    #    * Only paragraphs with successful conditions are retained
+    #    * All Condition nodes are stripped
+    #    * All Condition_Comment nodes are stripped
+    #
+    # This method *will* block on the first access to retrieve the
+    # data from the server.
+    #
+    # Note that the keys in the JSON hash will be symbols and *not* strings.
+    def iep
+      result = retrieve_responses_json
+
+      if result.is_a?(Array)
+        result = process_report json_array:result
+      end
+
+      result
+    end
+
+    private
+
+    def process_report(json_array:)
+      filtered_json = json_array.select do |para|
+        keep_para = true
+        condition = para[:Condition]
+
+        unless condition.nil?
+          keep_para = eval(sub_vars(condition))
+        end
+
+        keep_para
+      end
+
+      filtered_json.map do |para|
+        {
+          Style: para[:Style],
+          Text: sub_vars(para[:Text])
+        }
+      end
+    end
+
+    def sub_vars(sub_string)
+      result = sub_string
+
+      sub_string.scan(/%([a-zA-Z_][a-zA-Z0-9_]*)%/).flatten.each do |var|
+        result = result.gsub("%#{var}%", resolver.call(var).to_s)
+      end
+
+      result
+    end
+
+    def self.end_point
+      '1/assessment_report/iep'
+    end
+
+    def retrieve_responses_json
+      response = RequestHelpers::get_authorized(end_point: AssessmentReport::end_point, params: nil, client_id: @client.id, client_code: @client.code)
+      proc_response = RequestHelpers::process_json_response(response)
+      json = proc_response[:json]
+      server_response_code = proc_response[:code]
+
+      result = json
+      result = server_response_code if json.nil?
+
+      result
+    end
+
+  end
+
+end

data/lib/dmtd_vbmapp_data/version.rb

@@ -1,3 +1,3 @@
 module DmtdVbmappData
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/lib/dmtd_vbmapp_data.rb

@@ -17,6 +17,8 @@ require 'dmtd_vbmapp_data/vbmapp_area_group'
 require 'dmtd_vbmapp_data/vbmapp_area_question'
 require 'dmtd_vbmapp_data/vbmapp_area_response'
 
+require 'dmtd_vbmapp_data/assessment_report'
+
 require 'dmtd_vbmapp_data/version'
 
 module DmtdVbmappData

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dmtd_vbmapp_data
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - David Hunt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-04 00:00:00.000000000 Z
+date: 2015-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych
@@ -114,6 +114,7 @@ files:
 - bin/setup
 - dmtd_vbmapp_data.gemspec
 - lib/dmtd_vbmapp_data.rb
+- lib/dmtd_vbmapp_data/assessment_report.rb
 - lib/dmtd_vbmapp_data/client.rb
 - lib/dmtd_vbmapp_data/guide.rb
 - lib/dmtd_vbmapp_data/guide_chapter.rb