dmtd_vbmapp_data 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ff92a3ffefd26edba360ec5d1124fe9ad42509d
-  data.tar.gz: b282d4a1a768fc22f3425335c07c8b36b5758f6e
+  metadata.gz: 122b6604eb2c2c904d99f0f07a3906eabda7ee7f
+  data.tar.gz: 602691f8db6c4739446f01dc8e6ca1b6a4795092
 SHA512:
-  metadata.gz: f0b1b76b66fff0f900e4aeecd7123133575a68805c5ac91eb9feef7ef9d2eb6d4a530516b641ff2a0b66824e79237dd89e4fe2e79ac0b4a81e9853aacdd67295
-  data.tar.gz: 3a4e745d5dac38f95c578924d1a772b176cd8b476c62701bdc19010c23f4f02ada40b11575001f40bcf97893c1b4b3ed22a6d4f94760bac124f9ba6262c9145a
+  metadata.gz: 27ba06d0568758a013914f72ad4ecfdfa23a1230811dd95dd5812d8b30a3c42e123652d37732df78f0a26dea0711ad193d163d6ee89fb243ab3142125c5999af
+  data.tar.gz: 3e927cd10c3bf0aa66d2fde5b5a399384da10ae9337c712a857cf6b336f81f8cb740bb517c73ce693d3198adb1a395aa588fe8b74cbc0feda0075a2cad499b68

data/CHANGELOG.md

@@ -16,4 +16,11 @@
 
 ## 1.0.4
 
-* Implemented the Guide's caching support
+* Implemented the Guide's caching support
+
+## 1.1.0
+
+* Implemented the VB-Mapp controller's caching support
+* Completely reworked the documentation to be 'yard'-style format
+* Privatized the 'index' methods on guide & vbmapp as they really aren't needed publicly
+* Minor bug fixes 

data/lib/dmtd_vbmapp_data/assessment_report.rb

@@ -20,24 +20,18 @@ 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
     #
-    # 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)
+    # @option opts [Client] :client The client for which to run the report
+    # @param [method] :resolver @see #resolver
     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
+    # Returns the JSON for the IEP report. See {https://datamtd.atlassian.net/wiki/pages/viewpage.action?pageId=19267590 /1/assessment_report/iep - GET} for the
     # full format.
     #
     # The following transformations are made to the server JSON:
@@ -49,10 +43,10 @@ module DmtdVbmappData
     #    * 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 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.
+    # @note The keys in the JSON hash will be symbols and *not* strings.
     def iep
       result = retrieve_responses_json
 
@@ -100,7 +94,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, language: language)
+      response = RequestHelpers::get_authorized(end_point: AssessmentReport::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/client.rb

@@ -22,29 +22,28 @@ module DmtdVbmappData
 
     # Creates a new client on the VB-MAPP Data Server
     #
-    # Note that +code+ may be specified as a key of the corresponding record in your database.
-    # This allows the client to be referred to later on via this key as opposed to the id
-    # generated by our system.  Using this option means that your application data is not required
-    # to store a new id for the client, but can use your existing id (primary key).
+    # @note The {code} may be specified as a key of the corresponding record in your database.
+    #   This allows the client to be referred to later on via this key as opposed to the id
+    #   generated by our system.  Using this option means that your application data is not required
+    #   to store a new id for the client, but can use your existing id (primary key).
     #
-    # This operation blocks until it receives a response from the VB-MAPP Data Server.
+    # @note This operation blocks until it receives a response from the VB-MAPP Data Server.
     #
-    # 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 If {is_valid_for_create?} returns false, 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.
     #
-    # *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.
+    # @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)
-    # +id+:: the vbmapp_data server's identifier for this client (may be nil)
-    # +organization_id+:: the organization identifier (may be nil, if so DmtdVbmappData.config['organization_id'] will be used)
-    # +code+:: a code that can be used to refer to the client; possibly a key in the customer's database (may be nil)
-    # +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)
+    # @option opts [Date] :date_of_birth The date of birth of the client as a ruby Date object (may be nil)
+    # @option opts [Integer] :gender The gender of the client, either {GENDER_MALE} or {GENDER_FEMALE} (may be nil if {is_valid_for_create?})
+    # @option opts [String] :id The vbmapp_data server's identifier for this client (may be nil)
+    # @option opts [String] :organization_id The organization identifier (may be nil, if so {DmtdVbmappData.config}['organization_id'] will be used)
+    # @option opts [String] :code A code that can be used to refer to the client; possibly a key in the customer's database (may be nil)
+    # @option opts [String] :first_name The first name of the client (may be nil)
+    # @option opts [String] :last_name The last name of the client (may be nil)
+    # @option opts [String] :settings A string value that can be associated with the client (may be nil)
+    # @option opts [String] :language The language to use (i.e. 'en', 'es' or may be nil) @see #DmtdVbmappData.AVAILABLE_LANGUAGES
     def initialize(opts)
       @date_of_birth = opts.fetch(:date_of_birth, nil)
       @gender = opts.fetch(:gender, nil)
@@ -66,34 +65,38 @@ module DmtdVbmappData
 
     # Retrieves all existing clients from the VB-MAPP Data Server
     #
-    # This operation blocks until it receives a response from the VB-MAPP Data Server.
+    # @note 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)
+    # @option opts [String] :organization_id The organization identifier (may be nil, if so {DmtdVbmappData.config}['organization_id'] will be used)
+    # @option opts [String] :language The language to use (i.e. 'en', 'es' or may be nil) @see #DmtdVbmappData.AVAILABLE_LANGUAGES
     #
-    # Result:
-    # Array of DmtdVbmappData::Client instances or server http response code (integer) if an error was received
+    # @return [Array<Client> | Integer] http response code (integer) if an error was received
     def self.retrieve_clients(opts = {})
       retrieve_server_clients(opts)
     end
 
-    # Retrieves the guide for the corresponding client instance
+    # @note This method does *not* block
+    #
+    # @return [Guide]
     def guide
       Guide.new(client: self, language: language)
     end
 
-    # Retrieves the vbmapp for the corresponding client instance
+    # @note This method does *not* block
+    #
+    # @return [Vbmapp]
     def vbmapp
       Vbmapp.new(client: self, language: language)
     end
 
-    # Retrieves the IEP report for the corresponding client instance
+    # @note This method does *not* block
+    #
+    # @return [AssessmentReport]
     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
+    # @return [true | false] true if the receiver is parametrized correctly for creation on the server
     def is_valid_for_create?
       @id.nil? && !@date_of_birth.nil? && !@gender.nil? && !@organization_id.nil?
     end

data/lib/dmtd_vbmapp_data/guide.rb

@@ -11,27 +11,30 @@ module DmtdVbmappData
     #
     # This method does *not* block, simply creates an accessor and returns
     #
-    # Params:
-    # +client+:: a client instance
+    # @option opts [Client] :client A client instance
     def initialize(opts)
       @client = opts.fetch(:client)
     end
 
-    # Populates the internal VB-MAPP guide index
+    # @note The first call to this method with an expired cache will
+    #    block until the cache is populated.  All subsequent calls
+    #    will load from the cache.
     #
-    # This index is cached locally and expires once a day at midnight UTC.
+    # @note The cache is an in-memory cache (not on-disc).  Thus, if the process is restarted,
+    #    the cache will be dropped.  Additionally this cache expires once a day at midnight UTC.
     #
-    # The first call to this method with an expired cache will
-    # block until the cache is populated.  All subsequent calls
-    # will load from the cache.
-    #
-    # NOTE: The cache is an in-memory cache (not on-disc).  Thus, if the process is restarted,
-    #       the cache will be dropped.
-    #
-    # Returns:
-    # Array as defined as the result of the 1/guide/index REST api
-    def index
+    # @return [Array<GuideChapter>] The entire set of {GuideChapter} instances
+    def chapters
+      @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
 
+    def index
       expire_cache
       if defined?(@@guide_cache).nil?
         @@guide_cache = {
@@ -43,20 +46,6 @@ module DmtdVbmappData
       @@guide_cache[:guide_index]
     end
 
-    # Returns the VB-MAPP Guide chapters
-    #
-    # Note that this method calls +index+. See that method for
-    # its blocking characteristics.
-    def chapters
-      @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
-
     def expire_cache
       if defined?(@@guide_cache)
         today = DateTime.now.new_offset(0).to_date

data/lib/dmtd_vbmapp_data/guide_chapter.rb

@@ -12,12 +12,12 @@ module DmtdVbmappData
 
     # Creates an accessor for the VB-MAPP Guide Chapter on the VB-MAPP Data Server
     #
-    # This method does *not* block, simply creates an accessor and returns
+    # @note This method does *not* block, simply creates an accessor and returns
     #
-    # Params:
-    # +client+:: a client instance
-    # +chapter_num+:: the number (index) of the chapter in the Guide's index array
-    # +chapter_index_json+:: the guide index json for the chapter
+    # @option opts [Client] :client A client instance
+    # @option opts [Integer] :chapter_num The number (index 0..n) of the chapter in the Guide's index array
+    # @option opts [Hash] :chapter_index_json The guide index json for the chapter in the format described at
+    #     {https://datamtd.atlassian.net/wiki/pages/viewpage.action?pageId=18710558 1/guide/index REST api - Chapter Fields}
     def initialize(opts)
       @client = opts.fetch(:client)
       @chapter_num = opts.fetch(:chapter_num)
@@ -29,18 +29,18 @@ module DmtdVbmappData
       @sections_index = index_json[:sections]
     end
 
-    # Returns the preamble of the Guide's chapter
+    # @note This method *does* block as the content is retrieved
     #
-    # This method *does* block as the content is retrieved
+    # @return [String] The preamble of the Guide's chapter
     def chapter_preamble
       @chapter_preamble = retrieve_guide_chapter[:chapterPreamble] if @chapter_preamble.nil?
 
       @chapter_preamble
     end
 
-    # Returns the VB-MAPP Guide chapter sections
+    # @note This method does *not* block
     #
-    # This method does *not* block on server access
+    # @return [Array<GuideChapterSection>] all of the the VB-MAPP Guide's {GuideChapterSection} instances
     def sections
       @sections = @sections_index.map.with_index { |section_index_json, section_num|
         GuideChapterSection.new(client: client, chapter_num: chapter_num, section_num: section_num, section_index_json: section_index_json)

data/lib/dmtd_vbmapp_data/guide_chapter_section.rb

@@ -13,13 +13,13 @@ module DmtdVbmappData
 
     # Creates an accessor for the VB-MAPP Guide Chapter Section on the VB-MAPP Data Server
     #
-    # This method does *not* block, simply creates an accessor and returns
+    # @note This method does *not* block, simply creates an accessor and returns
     #
-    # Params:
-    # +client+:: a client instance
-    # +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
-    # +section_index_json+:: the guide index json for the chapter
+    # @option opts [Client] :client A client instance
+    # @option opts [Integer] :chapter_num The number (index 0..n) of the chapter in the Guide's index array
+    # @option opts [Integer] :section_num The number (index 0..n) of the section in the chapter's sections array
+    # @option opts [Hash] :section_index_json The guide index json for the chapter section in the format described at
+    #     {https://datamtd.atlassian.net/wiki/pages/viewpage.action?pageId=18710558 1/guide/index REST api - Section Fields}
     def initialize(opts)
       @client = opts.fetch(:client)
       @chapter_num = opts.fetch(:chapter_num)
@@ -31,16 +31,18 @@ module DmtdVbmappData
       @sub_sections_index = index_json[:subSections]
     end
 
-    # Returns the content of the Guide's chapter section
+    # @note This method *does* block as the content is retrieved
     #
-    # This method *does* block as the content is retrieved
+    # @return [String] The content of the Guide's chapter section
     def section_content
       @section_content = retrieve_guide_section[:sectionContent] if @section_content.nil?
 
       @section_content
     end
 
-    # Returns the VB-MAPP Guide section's sub_sections
+    # @note This method does *not* block
+    #
+    # @return [Array<GuideSectionSubSection>] The VB-MAPP Guide section's sub_sections
     def sub_sections
       @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)

data/lib/dmtd_vbmapp_data/guide_section_sub_section.rb

@@ -14,14 +14,14 @@ module DmtdVbmappData
 
     # Creates an accessor for the VB-MAPP Guide Chapter Section on the VB-MAPP Data Server
     #
-    # This method does *not* block, simply creates an accessor and returns
+    # @note This method does *not* block, simply creates an accessor and returns
     #
-    # Params:
-    # +client+:: a client instance
-    # +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
+    # @option opts [Client] :client A client instance
+    # @option opts [Integer] :chapter_num The number (index 0..n) of the chapter in the Guide's index array
+    # @option opts [Integer] :section_num The number (index 0..n) of the section in the chapter's sections array
+    # @option opts [Integer] :sub_section_num The number (index 0..n) of the subSection in section's subSections array
+    # @option opts [Hash] :sub_section_index_json The guide index json for the subSection in the format described at
+    #     {https://datamtd.atlassian.net/wiki/pages/viewpage.action?pageId=18710558 1/guide/index REST api - SubSection Fields}
     def initialize(opts)
       @client = opts.fetch(:client)
       @chapter_num = opts.fetch(:chapter_num)
@@ -33,9 +33,9 @@ module DmtdVbmappData
       @section_short_title = sub_section_index_json[:sectionShortTitle]
     end
 
-    # Returns the content of the Guide's chapter section
+    # @note This method *does* block as the content is retrieved
     #
-    # This method *does* block as the content is retrieved
+    # @return [String] The content of the Guide's sub section
     def section_content
       retrieve_guide_sub_section[:sectionContent]
     end

data/lib/dmtd_vbmapp_data/vbmapp.rb

@@ -9,44 +9,53 @@ module DmtdVbmappData
 
     # Creates an accessor for the VB-MAPP content on the VB-MAPP Data Server
     #
-    # This method does *not* block, simply creates an accessor and returns
+    # @note This method does *not* block, simply creates an accessor and returns
     #
-    # Params:
-    # +client+:: a client instance
+    # @option opts [Client] :client A client instance
     def initialize(opts)
       @client = opts.fetch(:client)
     end
 
-    # Populates the internal VB-MAPP content index
+    # @note The first call to this method with an expired cache will
+    #    block until the cache is populated.  All subsequent calls
+    #    will load from the cache.
     #
-    # This index is cached locally and expires once a day.
+    # @note The cache is an in-memory cache (not on-disc).  Thus, if the process is restarted,
+    #    the cache will be dropped.  Additionally this cache expires once a day at midnight UTC.
     #
-    # The first call to this method with an expired cache will
-    # block until the cache is populated.  All subsequent calls
-    # will load from the cache.
-    #
-    # Returns:
-    # Array as defined as the result of the 1/guide/index REST api
+    # @return [Array<VbmappArea>] The entire set of {VbmappArea} instances
+    def areas
+      @areas = index.map do |area_index_json|
+        VbmappArea.new(client: client, area_index_json: area_index_json)
+      end if @areas.nil?
+
+      @areas
+    end
+
+    private
+
     def index
-      if @vbmapp_index.nil?
-        @vbmapp_index = retrieve_vbmapp_index
+
+      expire_cache
+      if defined?(@@vbmapp_index_cache).nil?
+        @@vbmapp_index_cache = {
+            datestamp: DateTime.now.new_offset(0).to_date,
+            vbmapp_index: retrieve_vbmapp_index
+        }
       end
 
-      @vbmapp_index
+      @@vbmapp_index_cache[:vbmapp_index]
     end
 
-    # Returns the VB-MAPP Areas
-    #
-    # Note that this method calls +index+. See that method for
-    # its blocking characteristics.
-    def areas
-      @areas = index.map {|area_index_json| VbmappArea.new(client: client, area_index_json: area_index_json)} if @areas.nil?
+    def expire_cache
+      if defined?(@@vbmapp_index_cache)
+        today = DateTime.now.new_offset(0).to_date
+        cache_day = @@vbmapp_index_cache[:datestamp]
 
-      @areas
+        @@vbmapp_index_cache = nil unless cache_day == today
+      end
     end
 
-    private
-
     def self.end_point
       '1/vbmapp/index'
     end

data/lib/dmtd_vbmapp_data/vbmapp_area.rb

@@ -10,11 +10,11 @@ module DmtdVbmappData
 
     # Creates an accessor for the VB-MAPP Guide Chapter on the VB-MAPP Data Server
     #
-    # This method does *not* block, simply creates an accessor and returns
+    # @note This method does *not* block, simply creates an accessor and returns
     #
-    # Params:
-    # +client+:: a client instance
-    # +area_index_json+:: the vbmapp area index json for the chapter
+    # @option opts [Client] :client A client instance
+    # @option opts [Hash] :area_index_json The vbmapp area index json for the VB-Mapp Area in the format described at
+    #     {https://datamtd.atlassian.net/wiki/pages/viewpage.action?pageId=18710543 /1/vbmapp/index - GET REST api - Area Fields}
     def initialize(opts)
       @client = opts.fetch(:client)
 
@@ -23,9 +23,9 @@ module DmtdVbmappData
       @groups_index = index_json[:groups]
     end
 
-    # Returns the VB-MAPP groups
+    # @note This method does *not* block on server access
     #
-    # This method does *not* block on server access
+    # @return [Array<VbmappAreaGroup>] all of the VB-Mapp's {VbmappAreaGroup} instances
     def groups
       @groups = @groups_index.map.with_index { |group_index_json, group_num|
         VbmappAreaGroup.new(client: client, area: area, group_index_json: group_index_json)
@@ -34,40 +34,6 @@ module DmtdVbmappData
       @groups
     end
 
-    # Returns the possible responses for all questions of this area
-    #
-    # This method *will* block on the first access to retrieve the
-    # data from the server
-    def responses
-      if @responses.nil?
-        responses_json = retrieve_responses_json || []
-        @responses = responses_json.map { |response_json| VbmappAreaResponse.new(area: area, response_json: response_json) }
-      end
-
-      @responses
-    end
-
-    private
-
-    def self.end_point
-      '1/vbmapp/area_responses'
-    end
-
-    def retrieve_responses_json
-      params = {
-          area: area
-      }
-      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]
-
-      result = json
-      result = server_response_code if json.nil?
-
-      result
-    end
-
   end
 
 end

data/lib/dmtd_vbmapp_data/vbmapp_area_group.rb

@@ -11,12 +11,12 @@ module DmtdVbmappData
 
     # Creates an accessor for the VB-MAPP Area Group on the VB-MAPP Data Server
     #
-    # This method does *not* block, simply creates an accessor and returns
+    # @note This method does *not* block, simply creates an accessor and returns
     #
-    # Params:
-    # +client+:: a client instance
-    # +area+:: the vbmapp area of the group
-    # +group_index_json+:: the vbmapp index json for the group
+    # @option opts [Client] :client A client instance
+    # @option opts [String] :area The vbmapp area of the group ('milestones', 'barriers', 'transitions', 'eesa')
+    # @option opts [Hash]   :group_index_json The vbmapp index json for the group in the format described at
+    #     {https://datamtd.atlassian.net/wiki/pages/viewpage.action?pageId=18710543 /1/vbmapp/index - GET REST api - Group Fields}
     def initialize(opts)
       @client = opts.fetch(:client)
       @area = opts.fetch(:area)
@@ -27,26 +27,23 @@ module DmtdVbmappData
       @levels = index_json[:levels]
     end
 
-    # Returns the content of the Guide's chapter section
+    # @note This method *does* block as the content is retrieved
     #
-    # This method *does* block as the content is retrieved
+    # @option opts [String | Symbol] :level Filters the questions to the given level (may be null)
     #
-    # +level+:: filters the questions to the given level (may be null)
+    # @return [Array<VbmappAreaQuestion>] all of the area group's {VbmappAreaQuestion} instances
     def questions(opts = {})
       level_name = opts.fetch(:level, nil)
 
-      if @questions.nil?
-        questions_json = retrieve_questions_json
-
-        @questions = questions_json.map {|question_json|
-          VbmappAreaQuestion.new(client: client, area: area, group: group, question_json: question_json)
-        }
-      end
+      @questions = retrieve_questions_json.map do |question_json|
+        VbmappAreaQuestion.new(client: client, area: area, group: group, question_json: question_json)
+      end if @questions.nil?
 
       if level_name.nil?
         result = @questions
       else
-        level_desc = @levels.select {|level| level[:level] == level_name}[0]
+        level_str = level_name.to_s
+        level_desc = @levels.select {|level| level[:level].to_s == level_str}[0]
         start_num = level_desc[:start_question_num] + 1 # question_number is 1-based
         end_num = start_num + level_desc[:question_count]
 
@@ -56,13 +53,11 @@ module DmtdVbmappData
       result
     end
 
-    # Returns the VB-MAPP Guide section's sub_sections
+    # @note This method does *not* block
+    #
+    # @return [Symbol] all of the area group's levels
     def levels
-      @levels = @levels.map { |sub_section_num|
-        VbmappAreaLevel.new(client: client, area: area, group: section_num, sub_section_num: sub_section_num)
-      } if @levels.nil?
-
-      @levels
+      @levels.map {|level_json| level_json[:level].to_sym }
     end
 
     private

data/lib/dmtd_vbmapp_data/vbmapp_area_question.rb

@@ -15,13 +15,13 @@ module DmtdVbmappData
 
     # Creates an accessor for the VB-MAPP Area Question on the VB-MAPP Data Server
     #
-    # This method does *not* block, simply creates an accessor and returns
+    # @note This method does *not* block, simply creates an accessor and returns
     #
-    # Params:
-    # +client+:: a client instance
-    # +area+:: the vbmapp area
-    # +group+:: the vbmapp area group name
-    # +question_json+:: The JSON that describes a VB-MAPP area question
+    # @option opts [Client] :client A client instance
+    # @option opts [String] :area The vbmapp area of the group ('milestones', 'barriers', 'transitions', 'eesa')
+    # @option opts [String] :group The vbmapp area group name (i.e. 'mand', 'tact', 'group1', etc.)
+    # @option opts [Hash]   :question_json The vbmapp question json for the question in the format described at
+    #     {https://datamtd.atlassian.net/wiki/pages/viewpage.action?pageId=18710549 /1/vbmapp/area_question - GET REST api - Fields}
     def initialize(opts)
       @client = opts.fetch(:client)
       @area = opts.fetch(:area)
@@ -36,7 +36,9 @@ module DmtdVbmappData
       @responses_json_array = question_json[:responses]
     end
 
-    # Returns the VB-MAPP question's possible responses.
+    # @note This method does *not* block.
+    #
+    # @return [Array<VbmappAreaResponse>] all of the VB-MAPP question's possible responses
     def responses
       if @responses.nil?
 
@@ -48,12 +50,6 @@ module DmtdVbmappData
         end
       end
 
-      # @levels = @levels.map { |sub_section_num|
-      #   GuideSectionSubSection.new(client: client, chapter_num: chapter_num, section_num: section_num, sub_section_num: sub_section_num)
-      # } if @levels.nil?
-      #
-      # @levels
-
       @responses
     end
 

data/lib/dmtd_vbmapp_data/vbmapp_area_response.rb

@@ -12,11 +12,12 @@ module DmtdVbmappData
 
     # Creates an accessor for the VB-MAPP Area Question on the VB-MAPP Data Server
     #
-    # This method does *not* block, simply creates an accessor and returns
+    # @note This method does *not* block, simply creates an accessor and returns
     #
-    # Params:
-    # +area+:: the vbmapp area
-    # +response_json+:: the response's json
+    # @option opts [Client] :client A client instance
+    # @option opts [String] :area The vbmapp area of the group ('milestones', 'barriers', 'transitions', 'eesa')
+    # @option opts [Hash]   :response_json The vbmapp question json for the question in the format described at
+    #     {https://datamtd.atlassian.net/wiki/pages/viewpage.action?pageId=18710549 /1/vbmapp/area_question - GET REST api - response}
     def initialize(opts)
       @area = opts.fetch(:area)
 

data/lib/dmtd_vbmapp_data/version.rb

@@ -1,3 +1,3 @@
 module DmtdVbmappData
-  VERSION = '1.0.4'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dmtd_vbmapp_data
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - David Hunt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-06 00:00:00.000000000 Z
+date: 2015-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych
@@ -152,3 +152,4 @@ signing_key:
 specification_version: 4
 summary: Ruby gem to simplify access to DMTD's VB-MAPP REST service
 test_files: []
+has_rdoc: