RedcapAPI 0.0.4 → 0.0.5a

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTc3NGJhYzZmMTJhNzAyMTUyNTZiZmRhMjk5ZjcxOWRlMjU3OTE2OA==
+    MDMyNzg4ZWJjZWUyZThkMzExN2Q5ODQ2NzQyZDE2YzFiZTQ1OGI0MA==
   data.tar.gz: !binary |-
-    MTg2MmU2MDAyNmQ0ZWQwMmJiOTViYWQ2NjEyNjcyMGU3ZmQzNzBjZg==
+    ZWUxNGMyM2ZkZGEzZDMxMmM0YTU3ZDQ5ZmJlYmRhZTI3NTFhNjk3MA==
 SHA512:
   metadata.gz: !binary |-
-    ZTAxMWRlNmFlMzczMTAwOWVhNzU1YWQ5ODFkZWY3OTczYmI0M2Y3YmI1Nzc3
-    NzZjMTNiNjkwNjZlNTE1OTU2MzkwZjYyYzNkNTFiM2Y5YWJmY2ZkYzBlYzk1
-    MjJhMzkwOTRmNDdhMzFlYzk1ODQ3OWNmNWMzMDhmYzNiYzcyM2Y=
+    MDJkZjkzYmY2OTNiN2RhYmFlZWVkYjI2N2Y5YTE1YzY5MTFmODQ1Y2JkOGJi
+    ZjQ0Y2I3NDQ0NmRkNjlkYmY1OTViNjE5MWU3ZTE0NzhjNWNlYTQyMWQ4ZGQ3
+    Njc4NWMxZDAwOWVlMTIxYWQ5ZGVhMjA0YjRjYmJkZjhjODM5OGI=
   data.tar.gz: !binary |-
-    ZjA4OWQzYWNiZjliMDUyNzQ2YTI0NjRhMTM2ZDAxOTZmYzllMGI1NmQ4YjEw
-    ODFkYmNlOTMyZTE1OGIzNmE0M2M0NTVjNDVlNDUwZWYwM2RmMjY4MzhmNzgx
-    ZmI2M2U0MjdlYmZjNTdjMjA0ODQ2Zjk2NGEyNjU2NDY0MzQ0YTA=
+    YzJjOGRmNDRkZGVlMTJiZjRiZjQ1MmRjMGNkOWEzYjg5Yjk1ZmY4ODhhYjYx
+    YmFiZTQ2MzliZTMyZDVkMWVlMGYyNzVjY2YzMDZmYzBhNTI0NDBjOWRmZjc0
+    ODc5OGY5YWM0MDUxMWZmOWJmODg2YjYwZjQ3NzJiNTEwOGVhZGI=

data/README.md

@@ -3,12 +3,26 @@
 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 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
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/RedcapAPI/fork )

data/RedcapAPI.gemspec

@@ -23,6 +23,15 @@ Gem::Specification.new do |spec|
   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.rb

@@ -1,59 +1,59 @@
 require "RedcapAPI/version"
-class RedcapAPI
-  def initialize(token, url)
-    @url = url
-    @token = token
-  end
+  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}
+    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
-    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 }
+    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
-  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 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
+    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')
+      data = data.collect do |entry|
+        entry.each do |k, v|
+          if v.class == Date
+            entry[k] = v.strftime('%F')
+          end
         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
+        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
-      entry
-    end
     
-  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
+    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
-

data/lib/RedcapAPI/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: RedcapAPI
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5a
 platform: ruby
 authors:
 - eugyev
@@ -59,7 +59,13 @@ description: ! "\n    This gem is still under active development. Please contact
   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  "
+  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: []
@@ -89,9 +95,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2