red_cap 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d5dfa5cee79acd4e53556829793b591d6f63149
+  data.tar.gz: 67711da2449a588359bfd5ea063557df95d8538f
+SHA512:
+  metadata.gz: e8c93ad56c780a58380aa2dab9082576922dc96002272501b408db283df7b142a8460a0f996a7c99ae1016303018e6625fb1fbaec7aae9e660da7136f42257d5
+  data.tar.gz: bddc8d3b30d9233a3123b6e2037c13a9d26842cebc899e58dafb0fa295ee474c9a86a810d18c12ba775739a8162189eaf1fb8832b9728045dbca740984e34f4e

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.3
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in red_cap.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Micah Geisel
+
+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,39 @@
+# REDCap
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/red_cap`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'red_cap'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install red_cap
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/red_cap.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "red_cap"
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/red_cap/client.rb

@@ -0,0 +1,48 @@
+require "json"
+require "faraday"
+
+module REDCap
+  class Client
+    def initialize url: REDCap.url, token: REDCap.token
+      @url = url
+      @token = token
+    end
+
+    def records
+      json_api_request(content: "record")
+    end
+
+    def metadata
+      json_api_request(content: "metadata")
+    end
+
+    def file record_id, file_id
+      response = base_request({
+        content: "file",
+        action: "export",
+        record: record_id,
+        field: file_id,
+      })
+      _, type, filename = *response.headers["content-type"].match(/\A(.+); name=\"(.+)\"\z/)
+      File.new(response.body, type, filename)
+    end
+
+    File = Struct.new(:data, :type, :filename)
+
+    private
+
+    def json_api_request options
+      response = base_request(options.reverse_merge({
+        format: "json",
+      }))
+      JSON.load(response.body)
+    end
+
+    def base_request options
+      connection = Faraday.new(url: @url)
+      connection.post(nil, options.reverse_merge({
+        token: @token,
+      }))
+    end
+  end
+end

data/lib/red_cap/form/fields.rb

@@ -0,0 +1,155 @@
+require "active_support/core_ext/object/blank"
+
+module REDCap
+  class Form
+    class Field < Struct.new(:form, :attributes, :responses)
+      KEYS = [
+        :field_name,
+        :form_name,
+        :section_header,
+        :field_type,
+        :field_label,
+        :select_choices_or_calculations,
+        :field_note,
+        :text_validation_type_or_show_slider_number,
+        :text_validation_min,
+        :text_validation_max,
+        :identifier,
+        :branching_logic,
+        :required_field,
+        :custom_alignment,
+        :question_number,
+        :matrix_group_name,
+        :matrix_ranking,
+        :field_annotation,
+      ].each do |key|
+        define_method key do
+          attributes[key.to_s]
+        end
+      end
+
+      def value
+        responses[field_name]
+      end
+
+      # field type inquiry methods
+      def method_missing method, *args, **kwargs, &block
+        if method.to_s.ends_with?("?")
+          field_type == method.to_s.chomp("?")
+        else
+          super
+        end
+      end
+
+      private
+
+      def associated_fields_for_key key
+        form.fields.select do |field|
+          field.branching_logic == %{[#{field_name}(#{key})]="1"}
+        end
+      end
+    end
+
+    class Text < Field; end
+    class Notes < Field; end
+    class Dropdown < Field; end
+    class Sql < Field; end
+
+    class File < Field
+      def value
+        if responses[field_name].present?
+          field_name
+        end
+      end
+    end
+
+    class RadioButtons < Field
+      def value
+        options[responses[field_name]]
+      end
+
+      def options
+        select_choices_or_calculations
+          .split("|")
+          .reduce({}) do |options, pair|
+            _, key, value = *pair.match(/\A(\d+),(.+)\z/)
+            options.merge key => value
+          end
+      end
+    end
+
+    # default "radio" implementation
+    Radio = RadioButtons
+
+    class Checkboxes < RadioButtons
+      def value
+        selected_options.values
+      end
+
+      private
+
+      def selected_options
+        options.select do |key, value|
+          responses["#{field_name}___#{key}"] == "1"
+        end
+      end
+    end
+
+    class CheckboxesWithOther < Checkboxes
+      def value
+        selected_options.map do |key, value|
+          if key == "501" # Other
+            "#{value}: #{other_text_field&.value}"
+          else
+            value
+          end
+        end
+      end
+
+      def other_text_field
+        associated_fields_for_key("501").find(&:text?)
+      end
+    end
+
+    # default "checkbox" implementation
+    Checkbox = CheckboxesWithOther
+
+    class CheckboxesWithRadioButtonsOrOther < CheckboxesWithOther
+      def value
+        radio_values = selected_options.keys.map do |key|
+          radio_field_for(key).value
+        end
+
+        Hash[super.zip(radio_values)]
+      end
+
+      private
+
+      def radio_field_for key
+        associated_fields_for_key(key).find(&:radio?)
+      end
+    end
+
+    class CheckboxesWithCheckboxesOrOther < CheckboxesWithOther
+      def value
+        left = selected_options.values
+
+        right = selected_options.keys.map do |key|
+          checkbox_fields_for(key).map(&:value)
+        end
+
+        if selected_options.keys.include?("501")
+          right[-1] = [other_text_field&.value]
+        end
+
+        Hash[left.zip(right)]
+      end
+
+      private
+
+      def checkbox_fields_for key
+        associated_fields_for_key(key).select(&:checkbox?)
+      end
+    end
+  end
+end

data/lib/red_cap/form.rb

@@ -0,0 +1,49 @@
+require "red_cap/form/fields"
+require "active_support/core_ext/string/inflections"
+
+module REDCap
+  class Form
+    def initialize data_dictionary, responses
+      @data_dictionary = data_dictionary
+      @responses = responses
+    end
+
+    attr_reader :data_dictionary, :responses
+
+    # field accessors
+    def method_missing method, *args, **kwargs, &block
+      key = method.to_s
+      field_class = kwargs[:as]
+      if field_class.is_a?(Symbol)
+        field_class = lookup_field_class(field_class.to_s)
+      end
+      if field = find_field(key, field_class)
+        field.value
+      else
+        super
+      end
+    end
+
+    def find_field key, field_class=nil
+      field = fields.find { |field| field.field_name == key }
+      field = field_class.new(self, field.attributes, responses) if field_class
+      field
+    end
+
+    def fields
+      @fields ||= data_dictionary.map do |attributes|
+        klass = lookup_field_class(attributes["field_type"])
+        klass.new(self, attributes, responses)
+      end
+    end
+
+    private
+
+    def lookup_field_class field_type
+      self.class.const_get field_type.camelize, false
+    rescue NameError
+      puts "Unimplemented field type: #{field_type}. Falling back to Text."
+      Text
+    end
+  end
+end

data/lib/red_cap/version.rb

@@ -0,0 +1,3 @@
+module REDCap
+  VERSION = "0.1.0"
+end

data/lib/red_cap.rb

@@ -0,0 +1,12 @@
+require "red_cap/version"
+require "red_cap/client"
+require "red_cap/form"
+
+module REDCap
+  def self.configure
+    yield self
+  end
+
+  cattr_accessor :url, :token
+end
+

data/red_cap.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "red_cap/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "red_cap"
+  spec.version       = REDCap::VERSION
+  spec.authors       = ["Micah Geisel"]
+  spec.email         = ["micah@botandrose.com"]
+
+  spec.summary       = %q{Library for connecting to REDCap and parsing forms and data}
+  spec.description   = %q{Library for connecting to REDCap and parsing forms and data}
+  spec.homepage      = "https://github.com/botandrose/red_cap"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: red_cap
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Micah Geisel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Library for connecting to REDCap and parsing forms and data
+email:
+- micah@botandrose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/red_cap.rb
+- lib/red_cap/client.rb
+- lib/red_cap/form.rb
+- lib/red_cap/form/fields.rb
+- lib/red_cap/version.rb
+- red_cap.gemspec
+homepage: https://github.com/botandrose/red_cap
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Library for connecting to REDCap and parsing forms and data
+test_files: []