RedcapAPI 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTY3OWQ3Y2JiNGVkNzJkZDllZjkxNzA3YThmZGRkNTE3NDk2ODVmOA==
+  data.tar.gz: !binary |-
+    YTc1ZDQyOTYwZTAyY2UyZTYxYmU2YzJiNzdmZjJlZGFjNjIxNzhmNw==
+SHA512:
+  metadata.gz: !binary |-
+    NTI0ZmNmMTlkOWVkNTQ2NmQyZDdiNjMyMzY1ZTA0NjE3N2M4NTFkZjdjYzI2
+    ZDRlYTJhMmM4ODk4YzYxM2MyYzRhYjNjYThhMzJmYjI5OTc0MjFmMGNlMTY3
+    NDMwZTgyZThiZjhhYjA1YTMxYWZkNGY2NzY4ODlhYzBlODJhOTk=
+  data.tar.gz: !binary |-
+    NWU4NTNjNGNlMWI2MDQxNDI3ODY3MmRlNWE1MGI5NjU0ZWJhMGZjNTU3NTcw
+    ODYxZTBlNDA0Mjc5NjY4ZDJiZmM0ZmRjNTA1NjU1NWRkYmFlMDZlYjQ5OGI0
+    ZDcyNjNlOGQ5YjQ4ZDRkZDAwOGQ2MzUxZDRhMmQyMTAzZWI4ZWE=

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 eugyev
+
+MIT License
+
+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,18 @@
+# Usage
+
+This is an api to utilize REDCAP api with ruby. This Gem requires mechanize as a dependency.
+it is based on instructions here http://sburns.org/2013/07/22/intro-to-redcap-api.html
+
+To start:
+
+r = RedcapAPI.new(token, url) # your institution has it's own url, and each project has it's own token
+
+r.get(optional record_id) # returns all records in JSON format or a specific record if specified
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/RedcapAPI/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,2 @@
+require "bundler/gem_tasks"
+

data/RedcapAPI.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'RedcapAPI/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "RedcapAPI"
+  spec.version       = RedcapAPI::VERSION
+  spec.authors       = ["eugyev"]
+  spec.email         = ["eugyev@gmail.com"]
+  spec.summary       = %q{This is an api to utilize REDCAP api with ruby. This Gem requires mechanize as a dependency.
+  it is based on instructions here http://sburns.org/2013/07/22/intro-to-redcap-api.html
+  }
+  spec.description   = %q{To start:
+
+  r = RedcapAPI.new(token, url) # your institution has it's own url, and each project has it's own token
+
+  r.get(optional record_id) # returns all records in JSON format or a specific record if specified
+  }
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "mechanize"
+end

data/lib/RedcapAPI/version.rb

@@ -0,0 +1,3 @@
+module RedcapAPI
+  VERSION = "0.0.1"
+end

data/lib/RedcapAPI.rb

@@ -0,0 +1,64 @@
+require "RedcapAPI/version"
+
+ class RedcapAPI
+  def initialize(token, url)
+    @url = url
+    @token = token
+  end
+
+  def get(record_id = nil)
+    payload = {:token=>@token, :format=>"json", :content=>"record", :type => 'flat'}
+    data = JSON.parse Mechanize.new.post(@url, payload).body
+    if record_id
+      data = data.select{|x| x['record_id'] == record_id.to_s}
+    end
+    data
+  end
+  
+  def get_fields
+    payload = {:token=>@token, :format=>"json", :content=>"metadata"}
+    response = JSON.parse Mechanize.new.post(@url, payload).body
+    if response
+      response.collect {|r| r['field_name'] if r }
+    end
+  end
+  
+  def post(data)
+    data = filter_data(data)
+    data_string = data.to_json
+    payload = {:token => @token, :format=> 'json', :content=>'record', :type => 'flat', :data => data_string}
+    Mechanize.new.post(@url, payload).body      
+  end
+  
+  def filter_data(data)
+    data = [data] if data.class == Hash
+    
+    data = data.collect do |entry|
+      entry.each do |k, v|
+        if v.class == Date
+          entry[k] = v.strftime('%F')
+        end
+      end
+      
+      if !(entry.keys.include? 'record_id' or entry.keys.include? :record_id) # new entry and no id listed
+        entry['record_id'] = next_open_record_id
+      end
+      entry
+    end
+    
+  end
+  
+  def next_open_record_id
+    old_entries = self.get
+    if old_entries.empty?
+      '1'
+    else
+      max_entry = old_entries.max_by{|e| e['record_id'].to_i}['record_id']
+      (max_entry.to_i + 1).to_s
+    end
+  end
+  
+  
+end  
+
+

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: RedcapAPI
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- eugyev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "To start:\n\n  r = RedcapAPI.new(token, url) # your institution has
+  it's own url, and each project has it's own token\n\n  r.get(optional record_id)
+  # returns all records in JSON format or a specific record if specified\n  "
+email:
+- eugyev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- RedcapAPI.gemspec
+- lib/RedcapAPI.rb
+- lib/RedcapAPI/version.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: This is an api to utilize REDCAP api with ruby. This Gem requires mechanize
+  as a dependency. it is based on instructions here http://sburns.org/2013/07/22/intro-to-redcap-api.html
+test_files: []