commcare_api 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c35502341c3508641810cd09701468ec7636ccb2
-  data.tar.gz: 5aad2a4a16d179a528fcb11faa9f9fa077b72228
+  metadata.gz: 10bc11038fa05f625b82678b3f4e1c73b13b142b
+  data.tar.gz: 4273da724c705d51f04311fba14e8aa9d0ef0da4
 SHA512:
-  metadata.gz: 73bba04b91c4dc78c1064ca5e3c8c36d16bece30e90e0599f8d21b5d960f7168e4331dbeb38fcc41075ffdef46981843aaa2b833ff5ccfb13ed97082bf41b81f
-  data.tar.gz: dda7aaab5436fe4eda7f2ff3ec5ecd9055fde13c5446ef21e9298c3eb50c3c8201e59879ee514b75c95daca51cc3d8042391459433f8a672efdacb3be5eb19a3
+  metadata.gz: 4f452a84ce3dad3024a1597d176c135ac195257bdde4c50e4e17ad5371b0eb91e437d678a781996027590b5cf2ad0fd3218a25ccb37d0bd94d889d65cdece329
+  data.tar.gz: ac5a9e8ff74162e69b59941070fefe21c89ba44a6ccb296023dbf3022764dcfa52f99afb4bc0428133944ec4e942e94893ced31c3fd87aacd825456199a01d3c

data/README.md

@@ -1,6 +1,6 @@
 # CommcareApi
 
-A CommCare API wrapper in Ruby
+A CommCare API wrapper in Ruby.
 
 ## Installation
 
@@ -16,13 +16,26 @@ Or install it yourself as:
 
     $ gem install commcare_api
 
+## Supported APIs
+
+* [List cases](https://wiki.commcarehq.org/display/commcarepublic/List+Cases)
+* [Case data](https://wiki.commcarehq.org/display/commcarepublic/Case+Data)
+* [List forms](https://wiki.commcarehq.org/display/commcarepublic/Form+Data)
+* [Form data](https://wiki.commcarehq.org/display/commcarepublic/Form+Data)
+
 ## Usage
 
-TODO: Write usage instructions here
+    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.
 
 ## Contributing
 
-1. Fork it ( http://github.com/gdeflaux/commcare_api/fork )
+1. Fork it (http://github.com/gdeflaux/commcare_api/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`)

data/lib/commcare_api.rb

@@ -45,9 +45,9 @@ module CommcareApi
     end
 
     def build_url(domain, action, options)
-      url = "#{CommcareApi::CC_BASE_URL}/#{domain}/api/#{@version}/#{action}"
+      url = "#{CommcareApi::CC_BASE_URL}/#{domain}/api/#{@version}/#{action}/"
       options = options.map {|k,v| "#{k.to_s}=#{v}"}.join("&")
-      url = "#{url}/?#{options}" if !options.empty?
+      url = "#{url}?#{options}" if !options.empty?
       url
     end
     

data/lib/commcare_api/version.rb

@@ -1,3 +1,3 @@
 module CommcareApi
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: commcare_api
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Guillaume Deflaux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-26 00:00:00.000000000 Z
+date: 2014-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler