RedcapAPI 0.0.6a → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ecc5ee19022a7fe8d9bd20f08fb53039a48716b
-  data.tar.gz: 75037075c22cd9bac02d65cbc2e72b0c48ccf742
+  metadata.gz: aeb12add1292232685b8dc3f4261ab2c1e6b1daf
+  data.tar.gz: f8cdffe33d25cd99b30a2bd587ff27775919304e
 SHA512:
-  metadata.gz: 4dabdab78f3a6409c34be703e68496441aed72fe378c7675ee7b05c46c0fed8b81b3da5074de123ecf691cdc8147e2ea2e93aa597d22cb4b278612b6455867fc
-  data.tar.gz: da28bddc0d8b639195a157713f7ac9348b1eb09ba6b3513e77e9a722b22b227ffe234b16cbf76c6a3fd998129e87b32bbc72ad4f4ef8fef2a3b744a4f18872ef
+  metadata.gz: 59b2d2909983bad3a39ad3d77ca8526778659045a7c412d4cb18fe9ac02b44a203f92eff44322dede62ec71649ce11d3c0adf3089496bae5a4c1053dd813710a
+  data.tar.gz: ac9f5cc66f444f3825a639cb204a8eba51da925b4487ef18221431ea11ce0a5c4531bbb622423a973f77d29d67e0b8566afd6f24ae2388a36f19791416c6491f

data/README.md

@@ -3,63 +3,35 @@
 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
 
-This gem is under development and testing.  If you would like to make changes or have comments, reach me at eugene@tranquiltech.io
-
-Special thanks to mmcrockett for making great additions. 
+This gem is still under active development. Please contact me directly with any  questions or suggestions. 
   
 To start:
-```ruby
-r = RedcapAPI.new(token, url, parser) 
-```
-your institution has it's own url, and each project has it's own token, an optional 'parser' that defaults to JSON. See the test cases for how to use other parsers like Nokogiri::XML and CSV.
 
-```ruby
-r.export(optional params) 
-```
-returns all records in JSON format, provide additional hash of parameters in you want to override or add any additional RedcapAPI options.
+r = RedcapAPI.new(token, url, parser) # your institution has it's own url, and each project has it's own token, an optional 'parser' that defaults to JSON. See the test cases for how to use other parsers like Nokogiri::XML and CSV.
+
+r.export(optional params) # returns all records in JSON format, provide additional hash of parameters in you want to override or add any additional RedcapAPI options.
+
+r.export_metadata(optional params) # returns all metadata records in JSON format, provide additional hash of parameters in you want to override or add any additional RedcapAPI options.
+
+r.import(optional params) # imports new records, the 'post' method is likely more helpful as it puts the 'data' in the correct format.
+
+r.api(optional params) # returns the raw data, this allows you to return 'xml' or 'csv' instead of forcing 'json'. Simply override the params. Example r.api({:format => 'xml'}).
 
-```ruby
-r.export_metadata(optional params) 
-```
-returns all metadata records in JSON format, provide additional hash of parameters in you want to override or add any additional RedcapAPI options.
+r.get(optional record_id) # returns all records in JSON format or a specific record if specified
 
-```
-r.import(optional params)
-```
-imports new records, the 'post' method is likely more helpful as it puts the 'data' in the correct format.
+r.get_fields # returns all fields for that instrument
 
-```
-r.api(optional params) 
-```
-returns the raw data, this allows you to return 'xml' or 'csv' instead of forcing 'json'. Simply override the params. Example r.api({:format => 'xml'}).
-```
-r.get(optional record_id) 
-```
-returns all records in JSON format or a specific record if specified
-```
-r.get_fields 
-```
-returns all fields for that instrument
-```
-r.post(data) 
-```
-this will either update an old record or create a new one. the data should be in form of array of hashes or as a hash (for one item).  dates are accepted in Date class or in strftime('%F') format. 
+r.post(data) # this will either update an old record or create a new one. the data should be in form of array of hashes or as a hash (for one item).  dates are accepted in Date class or in strftime('%F') format. 
 for example
-```
   data = {name: 'this is a test', field_2: Date.today}
-  r.post(data)
-```
-creates a new object using the fields above. field names must match those in the existing project
+  r.post(data) # creates a new object using the fields above. field names must match those in the existing project
   "{\"count\": 1}" --> indicates the object posted. 
 
 to update an existing record:
-```
 data = {record_id: 3, name: 'this is a test to update', field_2: Date.today}
-r.post(data) 
-```
-this will update the record with record_id 3. if record_id 3 does not exist it will create an entry with that record id
+r.post(data) # this will update the record with record_id 3. if record_id 3 does not exist it will create an entry with that record id
 
-There is also a helper class added to ruby Hash allowing you to convert a ruby array to a http-post style array. It was created  after having some issues filtering on 'forms' and 'fields'
+There is also a helper class added to ruby Hash allowing you to convert a ruby array to a http-post style array. I created this after having some issues filtering on 'forms' and 'fields'
 Example:
 params = {:fields => ['record_id', 'lab_id'], :forms => ['slide_tracking', 'id_shipping']} # This is the data I want to send to RedcapAPI, limiting the fields and forms
 r.export_metadata(params.to_http_post_array()) # This gets the metadata for only those fields/forms by using the newly added method on Hash 'to_http_post_array'.

data/RedcapAPI.gemspec

@@ -9,10 +9,29 @@ Gem::Specification.new do |spec|
   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.
-  The backend is based on instructions here http://sburns.org/2013/07/22/intro-to-redcap-api.html
+  it is based on instructions here http://sburns.org/2013/07/22/intro-to-redcap-api.html
   }
   spec.description   = %q{
-    Please see Github Repo and Readme file https://github.com/eugyev/RedcapAPI
+    This gem is still under active development. Please contact me directly with any  questions or suggestions. 
+    
+  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
+  
+  r.get_fields # returns all fields for that instrument
+  
+  r.post(data) # this will either update an old record or create a new one. the data should be in form of array of hashes or as a hash (for one item).  dates are accepted in Date class or in strftime('%F') format. 
+  for example
+    data = {name: 'this is a test', field_2: Date.today}
+    r.post(data) # creates a new object using the fields above. field names must match those in the existing project
+    "{\"count\": 1}" --> indicates the object posted. 
+  
+  to update an existing record:
+  data = {record_id: 3, name: 'this is a test to update', field_2: Date.today}
+  r.post(data) # this will update the record with record_id 3. if record_id 3 does not exist it will create an entry with that record id
+  
   }
   spec.homepage      = ""
   spec.license       = "MIT"

data/lib/RedcapAPI/version.rb

@@ -1,3 +1,3 @@
 class RedcapAPI
-  VERSION = "0.0.6a"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: RedcapAPI
 version: !ruby/object:Gem::Version
-  version: 0.0.6a
+  version: 0.0.6
 platform: ruby
 authors:
 - eugyev
@@ -94,8 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: "\n    Please see Github Repo and Readme file https://github.com/eugyev/RedcapAPI\n
-  \ "
+description: "\n    This gem is still under active development. Please contact me
+  directly with any  questions or suggestions. \n    \n  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  \n  r.get_fields # returns all fields for that instrument\n  \n
+  \ r.post(data) # this will either update an old record or create a new one. the
+  data should be in form of array of hashes or as a hash (for one item).  dates are
+  accepted in Date class or in strftime('%F') format. \n  for example\n    data =
+  {name: 'this is a test', field_2: Date.today}\n    r.post(data) # creates a new
+  object using the fields above. field names must match those in the existing project\n
+  \   \"{\\\"count\\\": 1}\" --> indicates the object posted. \n  \n  to update an
+  existing record:\n  data = {record_id: 3, name: 'this is a test to update', field_2:
+  Date.today}\n  r.post(data) # this will update the record with record_id 3. if record_id
+  3 does not exist it will create an entry with that record id\n  \n  "
 email:
 - eugyev@gmail.com
 executables: []
@@ -126,15 +138,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      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. The backend is based on instructions here http://sburns.org/2013/07/22/intro-to-redcap-api.html
+  as a dependency. it is based on instructions here http://sburns.org/2013/07/22/intro-to-redcap-api.html
 test_files:
 - test/test_redcap_api.rb