dmtd_vbmapp_data 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b6bc8d28e9e614d0e592527719a19c36f80aed6
+  data.tar.gz: ae285530bf3d1beab9b092645a645c858c7e2c1b
+SHA512:
+  metadata.gz: aa6c9a4d8c78fab9c1a605fc0d03a82bae480832f302045adb381a0d3152823d7b4ee5336ae2372a8826b09aa194c1011e06927305405fa572a69cd6e9615114
+  data.tar.gz: 4d9df7246386e2e7a252e4370f93d3d8ef2fabfd6ab4e4f100d047153cd1c720ed50fa3332ec3e73b1586d592ad1fd1c3cecb9ac8db5ccf04a04b62ed062f59b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+
+rvm:
+- 2.1.0
+
+env:
+  global:
+  - secure: gP248+snjbNPc0Uk6+rcTqRCVOrC7xsI9kFDQMnC+k04qkZ4B2ZJbz8ZFhws1XFAd0SNhEsmqnxVuTwAIUxdsJpe8eEqUFIYpNRWz6KNL58yADmQX84BjeNLBM4BxPIej4crr+1i++KxW9WVMV1SAA6/5NQ9wR0fCC39HyaVmgk=
+  - secure: Tv043DGoNh8bconcyqXVeWPnR81TrbLC2xwiUbdE6Utm9I5s34aqCjeiv1oV8Dd/OfqceHW9exQD9qBgD9VHsV+2VQhuamjwI4Oy4/PwHyyaMuSVKgvQsHfJRdxMNQbHNxfdYBhf4W6yYbSWquP8JzO3fnLtXEVEGDrDBxI3CRg=
+  - secure: GRXGSJG3ygT//t/ADWGLV8G9xYgAs2twmMV9vjP8qpCDn0ijlk3KpwrieqO+Ewz4ru1u1GS6ha5KFlTA5pWRdzc75u7N7xHFbMnLSMe74U54pU12xuAgwo5mGjGm9KcjCRlR5d2aKAcuI2geTz2dfWAZTrjak7mQcy1APUoBmxk=
+
+before_install:
+- gem install bundler --no-rdoc --no-ri --no-document --quiet
+
+script:
+- bundle exec rspec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dmtd_vbmapp_data.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Data Makes the Difference, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# DmtdVbmapp
+
+[![CI Status](http://img.shields.io/travis/foscomputerservices/dmtd_vbmapp_data.svg?style=flat)](https://travis-ci.org/foscomputerservices/dmtd_vbmapp_data)
+[![Version](https://img.shields.io/gem/v/dmtd_vbmapp_data.svg?style=flat)](http://www.rubydoc.info/github/foscomputerservices/dmtd_vbmapp_data/master)
+[![License](https://img.shields.io/gem/l/dmtd_vbmapp_data.svg?style=flat)](http://www.rubydoc.info/github/foscomputerservices/dmtd_vbmapp_data/master)
+[![Platform](https://img.shields.io/gem/p/dmtd_vbmapp_data.svg?style=flat)](http://www.rubydoc.info/github/foscomputerservices/dmtd_vbmapp_data/master)
+
+The gem is provided to ease access to DMTD's vbmappapp.com REST service.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dmtd_vbmapp_data'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dmtd_vbmapp_data
+
+## Configuration
+
+Upon receiving an authorization token from Data Makes the Difference, add the following lines to your application's configuration: 
+
+```ruby
+DmtdVbmappData.configure server_url: 'your_assigned_web_service_url' # It can also be 'http://data-sandbox.vbmappapp.com' for testing purposes
+DmtdVbmappData.configure auth_token: 'your_auth_token'
+DmtdVbmappData.configure organization_id: your_organization_id
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/dmtd_vbmapp_data/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'dmtd_vbmapp_data'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dmtd_vbmapp_data.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dmtd_vbmapp_data/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dmtd_vbmapp_data'
+  spec.version       = DmtdVbmappData::VERSION
+  spec.authors       = ['David Hunt']
+  spec.email         = ['support@vbmappapp.com']
+
+  spec.summary       = %q{Ruby gem to simplify access to DMTD's VB-MAPP REST service}
+  spec.description   = %q{This gem provides a simplified Ruby API for DMTD customers accessing the vbmappapp.com REST service.}
+  spec.homepage      = 'https://github.com/foscomputerservices/dmtd_vbmapp_data'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'psych', '~> 2.0'
+  spec.add_dependency 'json', '~> 1.8'
+  spec.add_dependency 'hashie', '~> 3.4'
+
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_development_dependency 'rspec', '~> 3.2'
+end

data/lib/dmtd_vbmapp_data.rb

@@ -0,0 +1,52 @@
+# External deps
+require 'psych'
+require 'json'
+require 'hashie'
+
+# Our classes
+require 'dmtd_vbmapp_data/client'
+
+require 'dmtd_vbmapp_data/guide'
+require 'dmtd_vbmapp_data/guide_chapter'
+require 'dmtd_vbmapp_data/guide_chapter_section'
+require 'dmtd_vbmapp_data/guide_section_sub_section'
+
+require 'dmtd_vbmapp_data/vbmapp'
+require 'dmtd_vbmapp_data/vbmapp_area'
+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/version'
+
+module DmtdVbmappData
+
+  @config = {
+      server_url: 'http://data-sandbox.vbmappapp.com',
+      auth_token: '',
+      organization_id: nil
+  }
+
+  @valid_config_keys = @config.keys
+
+  def self.configure(opts = {})
+    opts.each {|k,v| @config[k.to_sym] = v if @valid_config_keys.include? k.to_sym}
+  end
+
+  def self.configure_with(path_to_yaml_file)
+    begin
+      config = Psych::load(IO.read(path_to_yaml_file))
+    rescue Errno::ENOENT
+      log(:warning, "YAML configuration file couldn't be found. Using defaults."); return
+    rescue Psych::SyntaxError
+      log(:warning, 'YAML configuration file contains invalid syntax. Using defaults.'); return
+    end
+
+    configure(config)
+  end
+
+  def self.config
+    @config
+  end
+
+end

data/lib/dmtd_vbmapp_data/client.rb

@@ -0,0 +1,132 @@
+require 'dmtd_vbmapp_data/request_helpers'
+
+module DmtdVbmappData
+
+  GENDER_MALE=1
+  GENDER_FEMALE=2
+
+  # Provides for the creating and retrieving of client instances in the VB-MAPP Data Server.
+  class Client
+
+    attr_reader :id
+    attr_reader :organization_id
+    attr_reader :code
+    attr_reader :date_of_birth
+    attr_reader :first_name
+    attr_reader :last_name
+    attr_reader :settings
+    attr_reader :created_at
+    attr_reader :updated_at
+    attr_reader :server_response_code
+
+    # 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).
+    #
+    # 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.
+    #
+    # Params:
+    # +date_of_birth+:: the date of birth of the client as a ruby Date object
+    # +gender+:: the gender of the client, either +GENDER_MALE+ or +GENDER_FEMALE+
+    # +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)
+    def initialize(opts)
+      @date_of_birth = opts.fetch(:date_of_birth)
+      @gender = opts.fetch(:gender)
+      @id = opts.fetch(:id, nil)
+      @organization_id = opts.fetch(:organization_id, DmtdVbmappData.config[:organization_id])
+      @code = opts.fetch(:code, nil)
+      @first_name = opts.fetch(:first_name, nil)
+      @last_name = opts.fetch(:last_name, nil)
+      @settings = opts.fetch(:settings, nil)
+      @server_response_code = opts.fetch(:server_response_code, 200)
+
+      date = Time.now.utc.to_date
+      @created_at = opts.fetch(:created_at, date)
+      @updated_at = opts.fetch(:updated_at, date)
+
+      create_server_client if @id.nil?
+    end
+
+    # Retrieves all existing clients from the VB-MAPP Data Server
+    #
+    # This operation blocks until it receives a response from the VB-MAPP Data Server.
+    #
+    # Result:
+    # Array of DmtdVbmappData::Client instances or server 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
+    def guide
+      Guide.new(client: self)
+    end
+
+    # Retrieves the vbmapp for the corresponding client instance
+    def vbmapp
+      Vbmapp.new(client: self)
+    end
+
+    private
+
+    def self.end_point
+      '1/clients'
+    end
+
+    def create_server_client
+      params = { date_of_birth: @date_of_birth, gender: @gender, organization_id: @organization_id }
+      params[:code] = code unless code.nil?
+      params[:first_name] = first_name unless first_name.nil?
+      params[:last_name] = last_name unless last_name.nil?
+      params[:settings] = settings unless settings.nil?
+
+      proc_response = Client.process_response(RequestHelpers::post_authorized(end_point: Client::end_point, params: {object: params}))
+      json = proc_response[:json]
+      @server_response_code = proc_response[:code]
+
+      @id = json[:id] unless json.nil?
+    end
+
+    def self.retrieve_server_clients(opts)
+      result = nil
+      id = opts.fetch(:id, nil)
+      code = opts.fetch(:code, nil)
+      organization_id = opts.fetch(:organization_id, 1)
+
+      params = { organization_id: organization_id }
+
+      response = RequestHelpers::get_authorized(end_point: Client::end_point, params: params, client_id: id, client_code: code)
+      proc_response = process_response(response)
+      json_array = proc_response[:json]
+      server_response_code = proc_response[:code]
+
+      result = json_array.map {|json| json[:server_response_code] = server_response_code; Client.new(json) } unless json_array.nil?
+      result = server_response_code if json_array.nil?
+
+      result
+    end
+
+    def self.process_response(response)
+      json = nil
+      server_response_code = response.code.to_i
+
+      if server_response_code == 200
+        json_body = Hashie.symbolize_keys!(JSON.parse(response.body))
+        json = json_body[:response]
+      end
+
+      { json: json, code: server_response_code }
+    end
+  end
+
+end

data/lib/dmtd_vbmapp_data/guide.rb

@@ -0,0 +1,65 @@
+require 'dmtd_vbmapp_data/request_helpers'
+
+module DmtdVbmappData
+
+  # Provides for the retrieving of VB-MAPP Guide content from the VB-MAPP Data Server.
+  class Guide
+
+    attr_reader :client
+
+    # Creates an accessor for the VB-MAPP Guide on the VB-MAPP Data Server
+    #
+    # This method does *not* block, simply creates an accessor and returns
+    #
+    # Params:
+    # +client+:: a client instance
+    def initialize(opts)
+      @client = opts.fetch(:client)
+    end
+
+    # Populates the internal VB-MAPP guide index
+    #
+    # This index is cached locally and expires once a day.
+    #
+    # 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
+    def index
+      if @guide_index.nil?
+        @guide_index = retrieve_guide_index
+      end
+
+      @guide_index
+    end
+
+    # Returns the VB-MAPP Guide chapters
+    #
+    # 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)}
+    end
+
+    private
+
+    def self.end_point
+      '1/guide/index'
+    end
+
+    def retrieve_guide_index
+      response = RequestHelpers::get_authorized(end_point: Guide::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/guide_chapter.rb

@@ -0,0 +1,74 @@
+require 'dmtd_vbmapp_data/request_helpers'
+
+module DmtdVbmappData
+
+  # Provides for the retrieving of VB-MAPP Guide chapters from the VB-MAPP Data Server.
+  class GuideChapter
+
+    attr_reader :client
+    attr_reader :chapter_num
+    attr_reader :chapter_title
+    attr_reader :chapter_short_title
+
+    # 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
+    #
+    # 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
+    def initialize(opts)
+      @client = opts.fetch(:client)
+      @chapter_num = opts.fetch(:chapter_num)
+
+      index_json = opts.fetch(:chapter_index_json)
+      @chapter_title = index_json[:chapterTitle]
+      @chapter_short_title = index_json[:chapterShortTitle]
+      @sections_index = index_json[:sections]
+    end
+
+    # Returns the preamble of the Guide's chapter
+    #
+    # This method *does* block as the content is retrieved
+    def chapter_preamble
+      @chapter_preamble = retrieve_guide_chapter[:chapterPreamble] if @chapter_preamble.nil?
+
+      @chapter_preamble
+    end
+
+    # Returns the VB-MAPP Guide chapter sections
+    #
+    # This method does *not* block on server access
+    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)
+      } if @sections.nil?
+
+      @sections
+    end
+
+    private
+
+    def self.end_point
+      '1/guide/chapter'
+    end
+
+    def retrieve_guide_chapter
+      params = {
+          chapter_num: chapter_num
+      }
+      response = RequestHelpers::get_authorized(end_point: GuideChapter::end_point, params: params, 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/guide_chapter_section.rb

@@ -0,0 +1,75 @@
+require 'dmtd_vbmapp_data/request_helpers'
+
+module DmtdVbmappData
+
+  # Provides for the retrieving of VB-MAPP Guide chapter sections from the VB-MAPP Data Server.
+  class GuideChapterSection
+
+    attr_reader :client
+    attr_reader :chapter_num
+    attr_reader :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
+    #
+    # 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
+    def initialize(opts)
+      @client = opts.fetch(:client)
+      @chapter_num = opts.fetch(:chapter_num)
+      @section_num = opts.fetch(:section_num)
+
+      index_json = opts.fetch(:section_index_json)
+      @section_title = index_json[:sectionTitle]
+      @section_short_title = index_json[:sectionShortTitle]
+      @subsection_count = index_json[:subsection_count]
+    end
+
+    # Returns the content of the Guide's chapter section
+    #
+    # This method *does* block as the content is retrieved
+    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
+    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
+    end
+
+    private
+
+    def self.end_point
+      '1/guide/section'
+    end
+
+    def retrieve_guide_section
+      params = {
+          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)
+      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/guide_section_sub_section.rb

@@ -0,0 +1,70 @@
+require 'dmtd_vbmapp_data/request_helpers'
+
+module DmtdVbmappData
+
+  # Provides for the retrieving of VB-MAPP Guide section sub_sections from the VB-MAPP Data Server.
+  class GuideSectionSubSection
+
+    attr_reader :client
+    attr_reader :chapter_num
+    attr_reader :section_num
+    attr_reader :sub_section_num
+
+    # 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
+    #
+    # 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)
+    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]
+    end
+
+    # Returns the content of the Guide's chapter section
+    #
+    # This method *does* block as the content is retrieved
+    def section_content
+      retrieve_guide_sub_section[:sectionContent]
+    end
+
+    private
+
+    def self.end_point
+      '1/guide/sub_section'
+    end
+
+    def retrieve_guide_sub_section
+      if @guide_sub_section.nil?
+        params = {
+            chapter_num: chapter_num,
+            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)
+        proc_response = RequestHelpers::process_json_response(response)
+        json = proc_response[:json]
+        server_response_code = proc_response[:code]
+
+        @guide_sub_section = json
+        # result = server_response_code if json.nil?
+      end
+
+      @guide_sub_section
+    end
+  end
+
+end

data/lib/dmtd_vbmapp_data/request_helpers.rb

@@ -0,0 +1,90 @@
+require 'net/http'
+require 'uri'
+
+module DmtdVbmappData
+
+  class RequestHelpers
+
+    # GET an authorized message from the vbmappdata server
+    #
+    # Params:
+    # +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)
+    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)
+
+      get url(end_point), params, client_id, client_code
+    end
+
+    # POST an authorized message to the vbmappdata server
+    #
+    # Params:
+    # +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)
+    def self.post_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)
+
+      post url(end_point), params, client_id, client_code
+    end
+
+    # Process a JSON response from the server
+    #
+    # Returns:
+    # { json: <json>, code: <response.code.to_i> }
+    def self.process_json_response(response)
+      json = nil
+      server_response_code = response.code.to_i
+
+      if server_response_code == 200
+        json_body = Hashie.symbolize_keys!(JSON.parse(response.body))
+        json = json_body[:response]
+      end
+
+      { json: json, code: server_response_code }
+    end
+
+  private
+
+    def self.get(uri, params, client_id, client_code)
+      http = Net::HTTP.new(uri.host, uri.port)
+      request = Net::HTTP::Get.new(uri.request_uri)
+      add_auth(request, client_id, client_code)
+      request.set_form_data params unless params.nil?
+
+      http.request(request)
+    end
+
+    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)
+      request.body = JSON(params)
+
+      http.request(request)
+    end
+
+    def self.url(end_point)
+      URI.parse("#{DmtdVbmappData.config[:server_url]}/#{end_point}")
+    end
+
+    def self.add_auth(request, client_id = nil, client_code = nil)
+      session_token = DmtdVbmappData.config[:auth_token]
+
+      request['Authorization'] = "Token token=\"#{session_token}\""
+      request['Accept'] = 'application/json'
+      request['Content-Type'] = 'application/json'
+      request['X-ClientId'] = client_id unless client_id.nil?
+      request['X-ClientCode'] = client_code unless client_code.nil?
+    end
+  end
+end

data/lib/dmtd_vbmapp_data/vbmapp.rb

@@ -0,0 +1,68 @@
+require 'dmtd_vbmapp_data/request_helpers'
+
+module DmtdVbmappData
+
+  # Provides for the retrieving of VB-MAPP content from the VB-MAPP Data Server.
+  class Vbmapp
+
+    attr_reader :client
+
+    # 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
+    #
+    # Params:
+    # +client+:: a client instance
+    def initialize(opts)
+      @client = opts.fetch(:client)
+    end
+
+    # Populates the internal VB-MAPP content index
+    #
+    # This index is cached locally and expires once a day.
+    #
+    # 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
+    def index
+      if @vbmapp_index.nil?
+        @vbmapp_index = retrieve_vbmapp_index
+      end
+
+      @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?
+
+      @areas
+    end
+
+    private
+
+    def self.end_point
+      '1/vbmapp/index'
+    end
+
+    def retrieve_vbmapp_index
+      response = RequestHelpers::get_authorized(end_point: Vbmapp::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/vbmapp_area.rb

@@ -0,0 +1,73 @@
+require 'dmtd_vbmapp_data/request_helpers'
+
+module DmtdVbmappData
+
+  # Provides for the retrieving of VB-MAPP area information from the VB-MAPP Data Server.
+  class VbmappArea
+
+    attr_reader :client
+    attr_reader :area
+
+    # 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
+    #
+    # Params:
+    # +client+:: a client instance
+    # +area_index_json+:: the vbmapp area index json for the chapter
+    def initialize(opts)
+      @client = opts.fetch(:client)
+
+      index_json = opts.fetch(:area_index_json)
+      @area = index_json[:area]
+      @groups_index = index_json[:groups]
+    end
+
+    # Returns the VB-MAPP groups
+    #
+    # This method does *not* block on server access
+    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)
+      } if @groups.nil?
+
+      @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)
+      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

@@ -0,0 +1,91 @@
+require 'dmtd_vbmapp_data/request_helpers'
+
+module DmtdVbmappData
+
+  # Provides for the retrieving of VB-MAPP Guide chapter sections from the VB-MAPP Data Server.
+  class VbmappAreaGroup
+
+    attr_reader :client
+    attr_reader :area
+    attr_reader :group
+
+    # 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
+    #
+    # Params:
+    # +client+:: a client instance
+    # +area+:: the vbmapp area of the group
+    # +group_index_json+:: the vbmapp index json for the group
+    def initialize(opts)
+      @client = opts.fetch(:client)
+      @area = opts.fetch(:area)
+
+      index_json = opts.fetch(:group_index_json)
+      @group = index_json[:group]
+      @question_count = index_json[:question_count]
+      @levels = index_json[:levels]
+    end
+
+    # Returns the content of the Guide's chapter section
+    #
+    # This method *does* block as the content is retrieved
+    #
+    # +level+:: filters the questions to the given level (may be null)
+    def questions(opts = {})
+      level_name = opts.fetch(:level, nil)
+
+      if @questions.nil?
+        question_json = retrieve_question_json
+
+        @questions = question_json.map {|question_json|
+          VbmappAreaQuestion.new(client: client, area: area, group: group, question_json: question_json)
+        }
+      end
+
+      if level_name.nil?
+        result = @questions
+      else
+        level_desc = @levels.select {|level| level[:level] == level_name}[0]
+        start_num = level_desc[:start_question_num] + 1 # question_number is 1-based
+        end_num = start_num + level_desc[:question_count]
+
+        result = @questions.select {|question| question.question_number >= start_num && question.question_number <= end_num}
+      end
+
+      result
+    end
+
+    # Returns the VB-MAPP Guide section's sub_sections
+    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
+    end
+
+    private
+
+    def self.end_point
+      '1/vbmapp/area_question'
+    end
+
+    def retrieve_question_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)
+      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_question.rb

@@ -0,0 +1,62 @@
+require 'dmtd_vbmapp_data/request_helpers'
+
+module DmtdVbmappData
+
+  # Provides for the retrieving of VB-MAPP Guide chapter sections from the VB-MAPP Data Server.
+  class VbmappAreaQuestion
+
+    attr_reader :client
+    attr_reader :area
+    attr_reader :group
+    attr_reader :example
+    attr_reader :materials
+    attr_reader :question_number
+    attr_reader :question_text
+
+    # 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
+    #
+    # 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
+    def initialize(opts)
+      @client = opts.fetch(:client)
+      @area = opts.fetch(:area)
+      @group = opts.fetch(:group)
+
+      question_json = opts.fetch(:question_json)
+      @example = question_json[:example]
+      @guide_content = question_json[:guideContent]
+      @materials = question_json[:materials]
+      @question_number = question_json[:questionNumber]
+      @question_text = question_json[:questionText]
+      @responses_json_array = question_json[:responses]
+    end
+
+    # Returns the VB-MAPP question's possible responses.
+    def responses
+      if @responses.nil?
+
+        # If we don't have responses, get them from the area
+        if @responses_json_array.nil?
+          @responses = client.vbmapp.areas.select { |client_area| client_area.area == area}[0].responses
+        else
+          @responses = @responses_json_array.map { |response_json| VbmappAreaResponse.new(area: area, response_json: response_json) }
+        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
+
+  end
+
+end

data/lib/dmtd_vbmapp_data/vbmapp_area_response.rb

@@ -0,0 +1,31 @@
+require 'dmtd_vbmapp_data/request_helpers'
+
+module DmtdVbmappData
+
+  # Provides for the retrieving of VB-MAPP Guide chapter sections from the VB-MAPP Data Server.
+  class VbmappAreaResponse
+
+    attr_reader :area
+    attr_reader :score
+    attr_reader :text
+    attr_reader :description
+
+    # 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
+    #
+    # Params:
+    # +area+:: the vbmapp area
+    # +response_json+:: the response's json
+    def initialize(opts)
+      @area = opts.fetch(:area)
+
+      response_json = opts.fetch(:response_json)
+      @score = response_json[:score]
+      @text = response_json[:text]
+      @description = response_json[:description]
+    end
+
+  end
+
+end

data/lib/dmtd_vbmapp_data/version.rb

@@ -0,0 +1,3 @@
+module DmtdVbmappData
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: dmtd_vbmapp_data
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- David Hunt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: This gem provides a simplified Ruby API for DMTD customers accessing
+  the vbmappapp.com REST service.
+email:
+- support@vbmappapp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dmtd_vbmapp_data.gemspec
+- lib/dmtd_vbmapp_data.rb
+- lib/dmtd_vbmapp_data/client.rb
+- lib/dmtd_vbmapp_data/guide.rb
+- lib/dmtd_vbmapp_data/guide_chapter.rb
+- lib/dmtd_vbmapp_data/guide_chapter_section.rb
+- lib/dmtd_vbmapp_data/guide_section_sub_section.rb
+- lib/dmtd_vbmapp_data/request_helpers.rb
+- lib/dmtd_vbmapp_data/vbmapp.rb
+- lib/dmtd_vbmapp_data/vbmapp_area.rb
+- lib/dmtd_vbmapp_data/vbmapp_area_group.rb
+- lib/dmtd_vbmapp_data/vbmapp_area_question.rb
+- lib/dmtd_vbmapp_data/vbmapp_area_response.rb
+- lib/dmtd_vbmapp_data/version.rb
+homepage: https://github.com/foscomputerservices/dmtd_vbmapp_data
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby gem to simplify access to DMTD's VB-MAPP REST service
+test_files: []