commcare_api 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a1a094c4aabb3912660bcc1781b4ca9e161328f
-  data.tar.gz: 76f4b639d4b5ffa84b3b2dcf5873c43ccf016a11
+  metadata.gz: 198967693f77f06157318d0091075344dd8f54e4
+  data.tar.gz: 9793c8b2f0c86809e228b6d43618978f8ed8a4b5
 SHA512:
-  metadata.gz: 84162557fad10cc384b6c07129181ea90d98b73dd7a69517c6bf95d840503074c5f63de9702941289ec7d994892849340e88fb2fa4617577670dd4e7e0cc2897
-  data.tar.gz: fed262d16c1f1d84d30b56d99104c9843a03373af1c70ce496d1d2ffb472efa888c8be00d2e1d79e9aa8c152faf40c49ab5d11abeaf8ff6600dffd8ccd78cf0f
+  metadata.gz: 2e4e78a4b6dd1eabc1a45c0c9462777ee8a9cbbb50ceefdb6d7536905941c6e315c139400479d72fb3bbd1604f080d133239143731b8c3d6772a5726dd47c363
+  data.tar.gz: 44d9a1a88059b7cf835f85ae1bd8f6cac0cbc48fed940c8ff824560d8ca79c9a5d112938fa91cd8c7116dd63145653451c8d47b76e0632810846173340291582

data/README.md

@@ -32,13 +32,29 @@ Or install it yourself as:
 ## Usage
 
     require 'commcare_api'
-    
+
     ccc = CommcareApi::CommcareConnector.new(username, password)
     response = ccc.get_cases("my_domain", type: "my_case_type", date_modified_start: "2014-05-30", limit: 15)
     puts response.body
 
 Filters are added to the request with an options hash as shown above. See [CommCare documentation](https://wiki.commcarehq.org/display/commcarepublic/CommCare+HQ+APIs) for possible filters.
 
+## Getting data in multiple queries
+
+If the total amount of data you want cannot be retrieved with a single query you will have to perform multiple queries.
+
+    require 'commcare_api'
+
+    ccc = CommcareApi::CommcareConnector.new(username, password)
+    response = ccc.get_cases("my_domain", type: "my_case_type", date_modified_start: "2014-05-30", limit: 15)
+
+    while !response.nil? do
+      # Get the data you need
+      response = ccc.get_next_data
+    end
+
+You can also use the `get_previous_data` method similarly.
+
 ## Contributing
 
 1. Fork it (http://github.com/gdeflaux/commcare_api/fork)

data/commcare_api.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec'
   spec.add_dependency "httpi"
   spec.add_dependency "httpclient"
+  spec.add_dependency "json"
 end

data/lib/commcare_api.rb

@@ -1,6 +1,7 @@
 require "commcare_api/version"
 require "httpi"
 require "httpclient"
+require "json"
 
 module CommcareApi
   
@@ -12,6 +13,16 @@ module CommcareApi
       @user = user
       @password = password
       @version = "v#{version}"
+      @last_response = nil
+      @last_request = nil
+    end
+  
+    def get_next_data
+      get_contiguous_data("next")
+    end
+    
+    def get_previous_data
+      get_contiguous_data("previous")
     end
   
     def get_cases(domain, options = {})
@@ -90,6 +101,8 @@ module CommcareApi
       request = HTTPI::Request.new(url)
       request.auth.digest(@user, @password)
       response = HTTPI.get(request, :httpclient)
+      @last_response = response
+      @last_request = request
       response
     end
 
@@ -100,6 +113,15 @@ module CommcareApi
       url
     end
     
+    def get_contiguous_data(direction)
+      return nil if @last_response.nil?
+      j = JSON.parse(@last_response.body)
+      return nil if j["meta"][direction].nil?
+      @last_request.url.query = j["meta"][direction].gsub(/\?/, "")
+      url = @last_request.url.to_s
+      get_request(url)
+    end
+    
   end # Class
   
 end # Module

data/lib/commcare_api/version.rb

@@ -1,3 +1,3 @@
 module CommcareApi
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

data/spec/commcare_api_spec.rb

@@ -1,8 +1,26 @@
+# The commcare domain must have a least 2 cases
+
 require 'spec_helper'
 
 describe CommcareApi do
   ccc = CommcareApi::CommcareConnector.new(ENV["CC_USER"], ENV["CC_PWD"])
   
+  r = ccc.get_cases(ENV["CC_DOMAIN"], offset: 100, limit: 1)
+  puts r.code
+  j = JSON.parse(r.body)
+
+  puts JSON.pretty_generate(j)
+  
+  it "get_next_data (nil)" do
+    r = ccc.get_next_data
+    expect(r.class).to eq nil.class
+  end
+  
+  it "get_previous_data (nil)" do
+    r = ccc.get_previous_data
+    expect(r.class).to eq nil.class
+  end
+  
   case_id = ""
   it "get_cases" do
     r = ccc.get_cases(ENV["CC_DOMAIN"])
@@ -27,6 +45,18 @@ describe CommcareApi do
     expect(r.code).to eq 200
   end
   
+  it "get_previous_data" do
+    r = ccc.get_cases(ENV["CC_DOMAIN"], limit: 1)
+    r = ccc.get_next_data
+    expect(r.code).to eq 200
+  end
+  
+  it "get_previous_data" do
+    r = ccc.get_cases(ENV["CC_DOMAIN"], limit: 1, offset: 1)
+    r = ccc.get_previous_data
+    expect(r.code).to eq 200
+  end
+  
   it "get_groups" do
     r = ccc.get_groups(ENV["CC_DOMAIN"])
     expect(r.code).to eq 200

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: commcare_api
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Guillaume Deflaux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-03 00:00:00.000000000 Z
+date: 2016-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  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'
 description: A CommCare API wrapper in Ruby
 email:
 - deflaux.guillaume@gmail.com
@@ -117,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: A CommCare API wrapper in Ruby