dmtd_vbmapp_data 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9618795492ef685583687baee0ce2fbb3acdc0a1
-  data.tar.gz: f1349008bd09c3e3b5126de94591bfb8f4b240f2
+  metadata.gz: 93d6ded3058b25dcdddf63fdf9772d4ae2b39225
+  data.tar.gz: 92a1f20afb9d0a0420287a1c6d227e86a592b450
 SHA512:
-  metadata.gz: 9e488f5adcb9479715f9b30e5fa2c0b6f43bf6d560a0518aba61d8035272a9135f4a05b941dabb4049f1d8c84ad5db450e7b084db9dcfae56320f01c1f7d655a
-  data.tar.gz: b49afb5f8cd3b56ce191a198736ed63bfa7c3d85ba2a0e0faf1571310762e5fb8cbf758482a4ace439fbf522e203878674fc68bbbc8558db84ec7a0e675c6a5e
+  metadata.gz: 1fdc047a929060b5fcf19b6b5e6d09738eba0ecdfae67ccc2e4eae217dfefafd224a27e2e937852265ffdd94c9f4cc8c7726516fe88937c83fe3f5032b809832
+  data.tar.gz: c100ae97c161b3f3ccb8a640eabcdbffc3487249e9b053eacf8568cc80edb7d0d8cd3c929f48e53ae209e2a63b05ee0ddd92f01a41db5004cbd021417d0a7dcc

data/lib/dmtd_vbmapp_data.rb

@@ -52,4 +52,6 @@ module DmtdVbmappData
     @config
   end
 
+  AVAILABLE_LANGUAGES=%w(en es)
+
 end

data/lib/dmtd_vbmapp_data/assessment_report.rb

@@ -20,6 +20,9 @@ module DmtdVbmappData
     # The client for which the report will be generated
     attr_reader :client
 
+    # The language in which the report will be generated
+    attr_reader :language
+
     # Initializes the receiver with the given options:
     #
     # This method does *not* block, simply creates an accessor and returns
@@ -27,9 +30,11 @@ module DmtdVbmappData
     # Params:
     # +client+:: The client for which to run the report
     # +resolver+:: See +resolver+ above
+    # +language+:: the language to use (i.e. 'en', 'es' or may be nil)
     def initialize(opts, &resolver)
       @client = opts.fetch(:client)
       @resolver = resolver
+      @language = opts.fetch(:language, nil)
     end
 
     # Returns the JSON for the IEP report (see https://datamtd.atlassian.net/wiki/pages/viewpage.action?pageId=19267590) for the
@@ -95,7 +100,7 @@ module DmtdVbmappData
     end
 
     def retrieve_responses_json
-      response = RequestHelpers::get_authorized(end_point: AssessmentReport::end_point, params: nil, client_id: @client.id, client_code: @client.code)
+      response = RequestHelpers::get_authorized(end_point: AssessmentReport::end_point, params: nil, client_id: @client.id, client_code: @client.code, language: language)
       proc_response = RequestHelpers::process_json_response(response)
       json = proc_response[:json]
       server_response_code = proc_response[:code]

data/lib/dmtd_vbmapp_data/client.rb

@@ -18,6 +18,7 @@ module DmtdVbmappData
     attr_reader :created_at
     attr_reader :updated_at
     attr_reader :server_response_code
+    attr_reader :language
 
     # Creates a new client on the VB-MAPP Data Server
     #
@@ -31,6 +32,9 @@ module DmtdVbmappData
     # If +id+ is specified, then the instance will *not* be sent to the server, it is assumed to already be there.
     # Otherwise it will be sent to the server if is_valid_for_create? is true.
     #
+    # *NOTE:* language is *not* stored on the server along with the client information and thus, it must be
+    #         specified each time the instance is created if a language other than the default is needed.
+    #
     # Params:
     # +date_of_birth+:: the date of birth of the client as a ruby Date object (may be nil)
     # +gender+:: the gender of the client, either +GENDER_MALE+ or +GENDER_FEMALE+ (may be nil)
@@ -40,6 +44,7 @@ module DmtdVbmappData
     # +first_name+:: the first name of the client (may be nil)
     # +last_name+:: the last name of the client (may be nil)
     # +settings+:: a string value that can be associated with the client (may be nil)
+    # +language+:: the language to use (i.e. 'en', 'es' or may be nil)
     def initialize(opts)
       @date_of_birth = opts.fetch(:date_of_birth, nil)
       @gender = opts.fetch(:gender, nil)
@@ -50,6 +55,7 @@ module DmtdVbmappData
       @last_name = opts.fetch(:last_name, nil)
       @settings = opts.fetch(:settings, nil)
       @server_response_code = opts.fetch(:server_response_code, 200)
+      @language = opts.fetch(:language, nil)
 
       date = Time.now.utc.to_date
       @created_at = opts.fetch(:created_at, date)
@@ -62,6 +68,10 @@ module DmtdVbmappData
     #
     # This operation blocks until it receives a response from the VB-MAPP Data Server.
     #
+    # Params:
+    # +organization_id+:: the organization identifier (may be nil, if so DmtdVbmappData.config['organization_id'] will be used)
+    # +language+:: the language to use (i.e. 'en', 'es' or may be nil)
+    #
     # Result:
     # Array of DmtdVbmappData::Client instances or server http response code (integer) if an error was received
     def self.retrieve_clients(opts = {})
@@ -70,12 +80,17 @@ module DmtdVbmappData
 
     # Retrieves the guide for the corresponding client instance
     def guide
-      Guide.new(client: self)
+      Guide.new(client: self, language: language)
     end
 
     # Retrieves the vbmapp for the corresponding client instance
     def vbmapp
-      Vbmapp.new(client: self)
+      Vbmapp.new(client: self, language: language)
+    end
+
+    # Retrieves the IEP report for the corresponding client instance
+    def iep_report(&resolver)
+      AssessmentReport.new(client: self, language: language, &resolver).iep
     end
 
     # Returns true if the receiver is parametrized correctly for creation on the server
@@ -105,13 +120,10 @@ module DmtdVbmappData
 
     def self.retrieve_server_clients(opts)
       result = nil
-      id = opts.fetch(:id, nil)
-      code = opts.fetch(:code, nil)
-      organization_id = opts.fetch(:organization_id, 3)
-
-      params = { organization_id: organization_id }
+      language = opts.fetch(:language, nil)
+      organization_id = opts.fetch(:organization_id, DmtdVbmappData.config[:organization_id])
 
-      response = RequestHelpers::get_authorized(end_point: Client::end_point, params: params, client_id: id, client_code: code)
+      response = RequestHelpers::get_authorized(end_point: Client::end_point, params: {organization_id: organization_id}, language: language)
       proc_response = process_response(response)
       json_array = proc_response[:json]
       server_response_code = proc_response[:code]

data/lib/dmtd_vbmapp_data/guide.rb

@@ -40,7 +40,11 @@ module DmtdVbmappData
     # Note that this method calls +index+. See that method for
     # its blocking characteristics.
     def chapters
-      index.map.with_index {|chapter_json, chapter_num| GuideChapter.new(client: client, chapter_num: chapter_num, chapter_index_json: chapter_json)}
+      @chapters = index.map.with_index do |chapter_json, chapter_num|
+        GuideChapter.new(client: client, chapter_num: chapter_num, chapter_index_json: chapter_json)
+      end if @chapters.nil?
+
+      @chapters
     end
 
     private
@@ -50,7 +54,7 @@ module DmtdVbmappData
     end
 
     def retrieve_guide_index
-      response = RequestHelpers::get_authorized(end_point: Guide::end_point, params: nil, client_id: @client.id, client_code: @client.code)
+      response = RequestHelpers::get_authorized(end_point: Guide::end_point, params: nil, client_id: @client.id, client_code: @client.code, language: client.language)
       proc_response = RequestHelpers::process_json_response(response)
       json = proc_response[:json]
       server_response_code = proc_response[:code]

data/lib/dmtd_vbmapp_data/guide_chapter.rb

@@ -25,6 +25,7 @@ module DmtdVbmappData
       index_json = opts.fetch(:chapter_index_json)
       @chapter_title = index_json[:chapterTitle]
       @chapter_short_title = index_json[:chapterShortTitle]
+
       @sections_index = index_json[:sections]
     end
 
@@ -58,7 +59,7 @@ module DmtdVbmappData
       params = {
           chapter_num: chapter_num
       }
-      response = RequestHelpers::get_authorized(end_point: GuideChapter::end_point, params: params, client_id: @client.id, client_code: @client.code)
+      response = RequestHelpers::get_authorized(end_point: GuideChapter::end_point, params: params, client_id: @client.id, client_code: @client.code, language:client.language)
       proc_response = RequestHelpers::process_json_response(response)
       json = proc_response[:json]
       server_response_code = proc_response[:code]

data/lib/dmtd_vbmapp_data/guide_chapter_section.rb

@@ -28,7 +28,7 @@ module DmtdVbmappData
       index_json = opts.fetch(:section_index_json)
       @section_title = index_json[:sectionTitle]
       @section_short_title = index_json[:sectionShortTitle]
-      @subsection_count = index_json[:subsection_count]
+      @sub_sections_index = index_json[:subSections]
     end
 
     # Returns the content of the Guide's chapter section
@@ -42,9 +42,9 @@ module DmtdVbmappData
 
     # Returns the VB-MAPP Guide section's sub_sections
     def sub_sections
-      @sub_sections = (0..@subsection_count-1).map { |sub_section_num|
-        GuideSectionSubSection.new(client: client, chapter_num: chapter_num, section_num: section_num, sub_section_num: sub_section_num)
-      } if @sub_sections.nil?
+      @sub_sections = @sub_sections_index.map.with_index do |sub_section_index_json, sub_section_num|
+        GuideSectionSubSection.new(client: client, chapter_num: chapter_num, section_num: section_num, sub_section_num: sub_section_num, sub_section_index_json: sub_section_index_json)
+      end if @sub_sections.nil?
 
       @sub_sections
     end
@@ -60,7 +60,7 @@ module DmtdVbmappData
           chapter_num: chapter_num,
           section_num: section_num
       }
-      response = RequestHelpers::get_authorized(end_point: GuideChapterSection::end_point, params: params, client_id: @client.id, client_code: @client.code)
+      response = RequestHelpers::get_authorized(end_point: GuideChapterSection::end_point, params: params, client_id: @client.id, client_code: @client.code, language: client.language)
       proc_response = RequestHelpers::process_json_response(response)
       json = proc_response[:json]
       server_response_code = proc_response[:code]

data/lib/dmtd_vbmapp_data/guide_section_sub_section.rb

@@ -9,6 +9,8 @@ module DmtdVbmappData
     attr_reader :chapter_num
     attr_reader :section_num
     attr_reader :sub_section_num
+    attr_reader :section_title
+    attr_reader :section_short_title
 
     # Creates an accessor for the VB-MAPP Guide Chapter Section on the VB-MAPP Data Server
     #
@@ -19,19 +21,16 @@ module DmtdVbmappData
     # +chapter_num+:: the number (index) of the chapter in the Guide's index array
     # +section_num+:: the number (index) of the section in the chapter's sections array
     # +sub_section_num+:: the number (index) of the sub_section in the range (0..subsection_count)
+    # +sub_section_index_json+:: the guide index json for the chapter
     def initialize(opts)
       @client = opts.fetch(:client)
       @chapter_num = opts.fetch(:chapter_num)
       @section_num = opts.fetch(:section_num)
       @sub_section_num = opts.fetch(:sub_section_num)
-    end
-
-    def section_title
-      retrieve_guide_sub_section[:sectionTitle]
-    end
 
-    def section_short_title
-      retrieve_guide_sub_section[:sectionShortTitle]
+      sub_section_index_json = opts.fetch(:sub_section_index_json)
+      @section_title = sub_section_index_json[:sectionTitle]
+      @section_short_title = sub_section_index_json[:sectionShortTitle]
     end
 
     # Returns the content of the Guide's chapter section
@@ -54,7 +53,7 @@ module DmtdVbmappData
             section_num: section_num,
             sub_section_num: sub_section_num
         }
-        response = RequestHelpers::get_authorized(end_point: GuideSectionSubSection::end_point, params: params, client_id: @client.id, client_code: @client.code)
+        response = RequestHelpers::get_authorized(end_point: GuideSectionSubSection::end_point, params: params, client_id: @client.id, client_code: @client.code, language: client.language)
         proc_response = RequestHelpers::process_json_response(response)
         json = proc_response[:json]
         server_response_code = proc_response[:code]

data/lib/dmtd_vbmapp_data/request_helpers.rb

@@ -11,14 +11,16 @@ module DmtdVbmappData
     # +end_point+:: The end point to post
     # +params+:: The parameters to send to the end point (may be nil)
     # +client_id+:: The client id under which to record the post (may be nil)
-    # +client_code+:: The client code under which to record the post (maybe nil)
+    # +client_code+:: The client code under which to record the post (may be nil)
+    # +language+:: The language to fetch (may be nil)
     def self.get_authorized(opts = {})
       end_point = opts.fetch(:end_point)
       params = opts.fetch(:params, nil)
       client_id = opts.fetch(:client_id, nil)
       client_code = opts.fetch(:client_code, nil)
+      language = opts.fetch(:language, nil)
 
-      get url(end_point), params, client_id, client_code
+      get url(end_point), params, client_id, client_code, language
     end
 
     # POST an authorized message to the vbmappdata server
@@ -27,7 +29,7 @@ module DmtdVbmappData
     # +end_point+:: The end point to post
     # +params+:: The parameters to send to the end point (may be nil)
     # +client_id+:: The client id under which to record the post (may be nil)
-    # +client_code+:: The client code under which to record the post (maybe nil)
+    # +client_code+:: The client code under which to record the post (may be nil)
     def self.post_authorized(opts = {})
       end_point = opts.fetch(:end_point)
       params = opts.fetch(:params, nil)
@@ -55,10 +57,10 @@ module DmtdVbmappData
 
   private
 
-    def self.get(uri, params, client_id, client_code)
+    def self.get(uri, params, client_id, client_code, language)
       http = Net::HTTP.new(uri.host, uri.port)
       request = Net::HTTP::Get.new(uri.request_uri)
-      add_auth(request, client_id, client_code)
+      add_auth(request, client_id, client_code, language)
       request.set_form_data params unless params.nil?
 
       http.request(request)
@@ -67,7 +69,7 @@ module DmtdVbmappData
     def self.post(uri, params, client_id, client_code)
       http = Net::HTTP.new(uri.host, uri.port)
       request = Net::HTTP::Post.new(uri.request_uri)
-      add_auth(request, client_id, client_code)
+      add_auth(request, client_id, client_code, nil)
       request.body = JSON(params)
 
       http.request(request)
@@ -77,7 +79,7 @@ module DmtdVbmappData
       URI.parse("#{DmtdVbmappData.config[:server_url]}/#{end_point}")
     end
 
-    def self.add_auth(request, client_id = nil, client_code = nil)
+    def self.add_auth(request, client_id = nil, client_code = nil, language)
       session_token = DmtdVbmappData.config[:auth_token]
 
       request['Authorization'] = "Token token=\"#{session_token}\""
@@ -86,6 +88,7 @@ module DmtdVbmappData
       request['X-ClientId'] = client_id unless client_id.nil?
       request['X-ClientCode'] = client_code unless client_code.nil?
       request['X-DocType'] = DmtdVbmappData.config[:document_type].downcase unless DmtdVbmappData.config[:document_type].nil?
+      request['Accept-Language'] = language unless language.nil?
     end
   end
 end

data/lib/dmtd_vbmapp_data/vbmapp.rb

@@ -52,7 +52,7 @@ module DmtdVbmappData
     end
 
     def retrieve_vbmapp_index
-      response = RequestHelpers::get_authorized(end_point: Vbmapp::end_point, params: nil, client_id: @client.id, client_code: @client.code)
+      response = RequestHelpers::get_authorized(end_point: Vbmapp::end_point, params: nil, client_id: @client.id, client_code: @client.code, languge: client.language)
       proc_response = RequestHelpers::process_json_response(response)
       json = proc_response[:json]
       server_response_code = proc_response[:code]

data/lib/dmtd_vbmapp_data/vbmapp_area.rb

@@ -57,7 +57,7 @@ module DmtdVbmappData
       params = {
           area: area
       }
-      response = RequestHelpers::get_authorized(end_point: VbmappArea::end_point, params: params, client_id: @client.id, client_code: @client.code)
+      response = RequestHelpers::get_authorized(end_point: VbmappArea::end_point, params: params, client_id: @client.id, client_code: @client.code, language: client.language)
       proc_response = RequestHelpers::process_json_response(response)
       json = proc_response[:json]
       server_response_code = proc_response[:code]

data/lib/dmtd_vbmapp_data/vbmapp_area_group.rb

@@ -36,9 +36,9 @@ module DmtdVbmappData
       level_name = opts.fetch(:level, nil)
 
       if @questions.nil?
-        question_json = retrieve_question_json
+        questions_json = retrieve_questions_json
 
-        @questions = question_json.map {|question_json|
+        @questions = questions_json.map {|question_json|
           VbmappAreaQuestion.new(client: client, area: area, group: group, question_json: question_json)
         }
       end
@@ -71,12 +71,12 @@ module DmtdVbmappData
       '1/vbmapp/area_question'
     end
 
-    def retrieve_question_json
+    def retrieve_questions_json
       params = {
           area: area,
           group: group
       }
-      response = RequestHelpers::get_authorized(end_point: VbmappAreaGroup::end_point, params: params, client_id: @client.id, client_code: @client.code)
+      response = RequestHelpers::get_authorized(end_point: VbmappAreaGroup::end_point, params: params, client_id: @client.id, client_code: @client.code, language: client.language)
       proc_response = RequestHelpers::process_json_response(response)
       json = proc_response[:json]
       server_response_code = proc_response[:code]

data/lib/dmtd_vbmapp_data/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dmtd_vbmapp_data
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - David Hunt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-05 00:00:00.000000000 Z
+date: 2015-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych