formhub_ruby 0.0.3 → 0.0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53e40696a5df2916c66b1c0147d072f249745cd3
-  data.tar.gz: b75207dbede97b2e27594c4f441afd39b4503139
+  metadata.gz: 95753893821c1be2a8456e22fb70499992484a8d
+  data.tar.gz: a847323a8e96ec51dfa6137f75204c50d987dcc9
 SHA512:
-  metadata.gz: 9e779da0e015cf45314fe0a3f25014366e11dafee2ada6503ce7bfe0cc42888d33d0ecbdd5d5982a821ce8c8acc1b04b10c3ca0fead91bb2d9f0885fb0589fe1
-  data.tar.gz: 3bea5ec656654992ab7e089e7f2adda6c04aa080738be73ef44f071890cb932d07537bcd8ad723efb55c626e613790edd9bf7a276427517f2072bb817c337e25
+  metadata.gz: eab39d6ce6bb0b1de0a1302102913c47cc32b4a867f4ff4c9b374c74530644301c0e2ac69d1ff8394af193503dd9fdf73f934b9c626eb9eef1a6e64a0545208b
+  data.tar.gz: eff1f2671954992df3408fc050f52f716ae113d4c95d37260363bebac0142f7fadd37f687dbe8dbee48f6fcd6711a03d8ced9bf8486a6c088e673b6bd7a124ba

data/README.md

@@ -1,6 +1,6 @@
 # FormhubRuby
 
-TODO: Write a gem description
+A very simple Ruby Wrapper for the Formhub API
 
 ## Installation
 
@@ -18,7 +18,60 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Basic usage
+This gem is a very simple API wrapper for the JSON API of [Formhub
+](https://formhub.org/) application.
+More details on their JSON API can be foud on their [wiki page]( https://github.com/SEL-Columbia/formhub/wiki/Formhub-Access-Points-(API)).
+
+
+### Set a connection with the Formhub API
+
+Create a connection like so:
+
+    connection = FormhubRuby::API.new(username: 'fake_username', password: 'fake_password', formnamne: 'my_form_name' )
+
+You can also pass authentification configuration arguments in a block (e.g. in a initializer file, etc...):
+
+    FormhubRuby.configure do |config|
+      config.username =  'fake_username'
+      config.password =  'fake_password'
+    end
+
+To get the actual data from the api call, call the fetch method on it:
+
+    connection.fetch
+
+You should then be able to retrieve an array of hashes by using the data method
+
+    the_result = connection.data 
+    the_result.first.name
+    # => Loic
+
+If only want the actual count of rows is needed, use the count method:
+
+    connection.count
+    # => 4
+
+Before fetching, a more refined query can be created by using a hash of queries:
+    
+    connection.query = {age: 12}
+
+You can set a start and limit for the rows returned
+    
+    connection.start = 2
+    connection.limit = 2
+
+and select the fields to be retrieved:
+    
+    connection.fields = [:age, :name]
+
+Finally you can also sort the results:  1 denotes an ascending sort while -1 denotes a descending sort:
+
+    connection.sort =  {name: -1} # Descending by name
+    connection.sort =  {name: 1} # Ascending by name
+
+As far as I could tell though, the integers seem to be stored as strings in the Formhub database, so the sorting of these would be quite irrelevant.
+
 
 ## Contributing
 

data/formhub_ruby.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'addressable'
+
   spec.add_development_dependency 'bundler', '~> 1.5'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'

data/lib/formhub_ruby/api_connector.rb

@@ -1,10 +1,12 @@
 require 'net/http'
 require 'json'
 require 'cgi'
+require 'addressable/uri'
+
 module FormhubRuby
   class ApiConnector
     attr_reader :formname, :filetype, :username, :password, :data
-    attr_accessor :query, :start, :limit
+    attr_accessor :query, :start, :limit, :sort, :fields
 
 
     def initialize(args) 
@@ -15,13 +17,27 @@ module FormhubRuby
       @query = args[:query]
       @start = args[:start] 
       @limit = args[:limit]
+      @sort = args[:sort]
+      @fields = args[:fields]
+      @data = []
     end
 
     def fetch
-      # CAN DO THAT A LATER STAGE: Define different url format
-      # for different data point formats
-      # uri = URI(form_uri)         
-      uri = URI(api_uri)
+      get_response(api_uri)
+    end
+
+    def get_count
+      response = get_response("#{api_uri}&count=1")
+      response[0]['count']
+    end
+
+
+
+
+    # private
+
+    def get_response(custom_uri)
+      uri = URI(custom_uri)
       req = Net::HTTP::Get.new(uri)
       req.basic_auth @username, @password
       response = Net::HTTP.start(uri.hostname, uri.port) do |http|
@@ -35,7 +51,6 @@ module FormhubRuby
       end
     end
 
-    # private
 
     def api_uri
       "http://formhub.org/#{@username}/forms/#{@formname}/api" + api_parameters.to_s
@@ -54,7 +69,7 @@ module FormhubRuby
     end
 
     def api_parameters_array
-      [api_query, start, limit]
+      [api_query, start, limit, sort_query, fields_query]
     end
 
     def api_parameters_joined
@@ -77,6 +92,29 @@ module FormhubRuby
       hash.merge(hash){|k,hashv|hashv.to_s}
     end
 
+    # Note that integers seem to be stored as strings in Formhub database,
+    # and will be sorted as such
+
+    def sort_query
+      if @sort
+        validates_sort
+        "sort=#{CGI.escape @sort.to_json}"
+      end
+    end
+
+    def fields_query
+      if @fields
+        "fields=#{CGI.escape  @fields.to_json}"  
+      end    
+    end
+
+    def validates_sort
+      unless @sort.values.all? { |value| value == 1 || value == -1}
+        raise 'The sort option is hash taking +1 (ascending) or -1 (descending) value '
+      end
+
+    end
+
     # end
   end
 end

data/lib/formhub_ruby/version.rb

@@ -1,3 +1,3 @@
 module FormhubRuby
-  VERSION = '0.0.3'
+  VERSION = '0.0.6.1'
 end

data/spec/api_connectior_spec.rb

@@ -2,12 +2,14 @@ require 'formhub_ruby'
 require 'spec_helper'
 require 'yaml'
 
+# Currently 4 records on my account for the survey form
+
 describe FormhubRuby::ApiConnector do
   before :each do
     credentials = YAML.load_file('spec/fixtures/test_credentials.yml')
     FormhubRuby.configure do |config|
-      config.username = credentials['username']
-      config.password = credentials['password']
+      config.username = credentials['username'] || 'fake'
+      config.password = credentials['password'] || 'fake'
     end
   end
   
@@ -19,8 +21,8 @@ describe FormhubRuby::ApiConnector do
       VCR.use_cassette 'successful_connection' do 
         connection = FormhubRuby::ApiConnector.new(formname: 'survey')
         connection.fetch
-        connection.data.should be_a_kind_of(Array)
-        connection.data[0].should be_a_kind_of(Object)
+        expect(connection.data).to be_a_kind_of(Array)
+        expect(connection.data[0]).to be_a_kind_of(Object)
       end
     end
 
@@ -38,36 +40,86 @@ describe FormhubRuby::ApiConnector do
 
     it "does not add any extraneaous query" do
        connection = FormhubRuby::ApiConnector.new(formname: 'survey')
-       connection.api_uri.should == "http://formhub.org/#{username}/forms/survey/api"
+       expect(connection.api_uri).to eq("http://formhub.org/#{username}/forms/survey/api")
     end
 
     it "does form a simple query" do
       connection.query = {age: 12}
-      connection.api_uri.should == "http://formhub.org/#{username}/forms/survey/api?query=%7B%22age%22%3A%2212%22%7D"
+
+      expect(connection.api_uri).to eq("http://formhub.org/#{username}/forms/survey/api?query=%7B%22age%22%3A%2212%22%7D")
       VCR.use_cassette 'age_query' do
         connection.fetch
-        connection.data.length.should == 1
+        expect(connection.data.length).to eq(1)
       end
 
     end
 
     it "formulates a query with a start" do
       connection.start = 1
-      connection.api_uri.should == "http://formhub.org/#{username}/forms/survey/api?start=1"
+      expect(connection.api_uri).to eq("http://formhub.org/#{username}/forms/survey/api?start=1")
       VCR.use_cassette 'query_start' do
         connection.fetch
-        connection.data.length.should == 1
+        expect(connection.data.length).to eq(3)
       end
     end
 
     it "formulates a query with a limit" do
       connection.limit = 1
-      connection.api_uri.should == "http://formhub.org/#{username}/forms/survey/api?limit=1"
+      expect(connection.api_uri).to eq("http://formhub.org/#{username}/forms/survey/api?limit=1")
       VCR.use_cassette 'query_limit' do
         connection.fetch
-        connection.data.length.should == 1
+        expect(connection.data.length).to eq(1)
       end
     end
+
+    it "combines a query with a start and a limit" do
+      connection.start = 1
+      connection.limit = 1
+      expect(connection.api_uri).to eq("http://formhub.org/#{username}/forms/survey/api?start=1&limit=1")
+      VCR.use_cassette 'query_start_and_limit' do
+        connection.fetch
+        expect(connection.data.length).to eq(1)
+      end
+    end
+
+
+    it "just returns the count of rows for the query" do
+     connection.start = 1
+      connection.limit = 1
+      VCR.use_cassette "just_get_the_count" do
+        response = connection.get_count
+        expect(response).to eq(4)
+      end 
+
+     end 
+
+
+     it "sorts the data according to the supplied params" do
+
+      connection.sort = {name: -1}
+
+       VCR.use_cassette "sorts_properly" do
+        connection.fetch
+        expect(connection.data.map{|row| row["name"]}  ).to eq(['napoléon', 'loic', 'georges', 'Robert'])
+       end 
+
+      end 
+
+      it "only retrieve the selected fields" do
+
+       connection.fields = [:name, :age]
+       puts connection.api_uri
+
+        VCR.use_cassette "retrieve_selected_fields_only" do
+          connection.fetch
+         expect(connection.data.first['pizza_fan']).to be_nil
+         expect(connection.data.first['name']).not_to be_nil
+        end
+
+
+
+       end 
+
     
   end
 

data/spec/fixtures/vcr_cassettes/age_query.yml

@@ -21,7 +21,7 @@ http_interactions:
       message: OK
     headers:
       Date:
-      - Fri, 23 May 2014 11:41:14 GMT
+      - Mon, 02 Jun 2014 11:09:53 GMT
       Content-Type:
       - application/json
       Transfer-Encoding:
@@ -56,5 +56,5 @@ http_interactions:
         \"start_time\": \"2014-05-15T17:28:43.000+01:00\", \"today\": \"2014-05-15\",
         \"formhub/uuid\": \"1bfb7222748a4ee98106ea7d7a9c72cf\"}]"
     http_version: 
-  recorded_at: Fri, 23 May 2014 11:41:39 GMT
+  recorded_at: Mon, 02 Jun 2014 11:09:53 GMT
 recorded_with: VCR 2.9.0

data/spec/fixtures/vcr_cassettes/just_get_the_count.yml

@@ -0,0 +1,52 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://<USERNAME>:<PASSWORD>@formhub.org/<USERNAME>/forms/survey/api?count=1&limit=1&start=1
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Host:
+      - formhub.org
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 29 May 2014 15:28:33 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Server:
+      - gunicorn/0.15.0
+      Access-Control-Allow-Headers:
+      - Accept, Origin, X-Requested-With, Authorization
+      Content-Language:
+      - en-us
+      Vary:
+      - Accept-Language, Cookie
+      Etag:
+      - "\"14a3ce9385ab94d0a05702445e9cb804\""
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - GET
+      Strict-Transport-Security:
+      - max-age=31536000
+    body:
+      encoding: UTF-8
+      string: "[{\"count\": 4}]"
+    http_version: 
+  recorded_at: Thu, 29 May 2014 15:28:43 GMT
+recorded_with: VCR 2.9.0

data/spec/fixtures/vcr_cassettes/query_limit.yml

@@ -21,7 +21,7 @@ http_interactions:
       message: OK
     headers:
       Date:
-      - Fri, 23 May 2014 11:46:21 GMT
+      - Thu, 29 May 2014 15:28:31 GMT
       Content-Type:
       - application/json
       Transfer-Encoding:
@@ -37,7 +37,7 @@ http_interactions:
       Vary:
       - Accept-Language, Cookie
       Etag:
-      - "\"a8b3103fef34948c7ead4c8335e29543\""
+      - "\"0d06d7f4e0deb690eab5d9ed82e6a990\""
       Access-Control-Allow-Origin:
       - "*"
       Access-Control-Allow-Methods:
@@ -46,15 +46,15 @@ http_interactions:
       - max-age=31536000
     body:
       encoding: UTF-8
-      string: "[{\"meta/instanceID\": \"uuid:be1b882a-b377-4cf0-95d3-c2acc8d04e7a\",
-        \"name\": \"georges\", \"_submission_time\": \"2014-05-15T16:29:00\", \"age\":
-        \"12\", \"_uuid\": \"be1b882a-b377-4cf0-95d3-c2acc8d04e7a\", \"_bamboo_dataset_id\":
-        \"\", \"_tags\": [], \"_attachments\": [], \"_geolocation\": [null, null],
-        \"end_time\": \"2014-05-15T17:28:59.000+01:00\", \"_xform_id_string\": \"survey\",
-        \"imei\": \"enketo.formhub.org:fSucCmZ5zwzNcTe1\", \"phonenumber\": \"no phonenumber
-        property in enketo\", \"_status\": \"submitted_via_web\", \"_id\": 3318651,
-        \"start_time\": \"2014-05-15T17:28:43.000+01:00\", \"today\": \"2014-05-15\",
-        \"formhub/uuid\": \"1bfb7222748a4ee98106ea7d7a9c72cf\"}]"
+      string: "[{\"meta/instanceID\": \"uuid:269e2328-5997-43c1-aeb1-6edec8f914af\",
+        \"age\": \"15\", \"name\": \"napol\\u00e9on\", \"_submission_time\": \"2014-05-29T13:55:58\",
+        \"start_time\": \"2014-05-29T14:55:42.000+01:00\", \"_uuid\": \"269e2328-5997-43c1-aeb1-6edec8f914af\",
+        \"_bamboo_dataset_id\": \"\", \"_tags\": [], \"_attachments\": [], \"imei\":
+        \"enketo.formhub.org:fSucCmZ5zwzNcTe1\", \"_geolocation\": [null, null], \"end_time\":
+        \"2014-05-29T14:56:05.000+01:00\", \"gender\": \"female\", \"_xform_id_string\":
+        \"survey\", \"phonenumber\": \"no phonenumber property in enketo\", \"_status\":
+        \"submitted_via_web\", \"_id\": 3413156, \"pizza_fan\": \"no\", \"today\":
+        \"2014-05-29\", \"formhub/uuid\": \"1bfb7222748a4ee98106ea7d7a9c72cf\"}]"
     http_version: 
-  recorded_at: Fri, 23 May 2014 11:46:46 GMT
+  recorded_at: Thu, 29 May 2014 15:28:41 GMT
 recorded_with: VCR 2.9.0

data/spec/fixtures/vcr_cassettes/query_start.yml

@@ -21,7 +21,7 @@ http_interactions:
       message: OK
     headers:
       Date:
-      - Fri, 23 May 2014 11:47:06 GMT
+      - Thu, 29 May 2014 15:28:31 GMT
       Content-Type:
       - application/json
       Transfer-Encoding:
@@ -37,7 +37,7 @@ http_interactions:
       Vary:
       - Accept-Language, Cookie
       Etag:
-      - "\"cca3b5eba43f81971965707f51c4882b\""
+      - "\"ce11c6a0cd553a81e77d3553380fe14d\""
       Access-Control-Allow-Origin:
       - "*"
       Access-Control-Allow-Methods:
@@ -46,15 +46,33 @@ http_interactions:
       - max-age=31536000
     body:
       encoding: UTF-8
-      string: "[{\"meta/instanceID\": \"uuid:2aebfa29-6284-4c3a-9c3f-6eb604f89194\",
-        \"age\": \"23\", \"name\": \"loic\", \"_submission_time\": \"2014-05-15T16:28:19\",
-        \"start_time\": \"2014-05-15T17:27:57.000+01:00\", \"_uuid\": \"2aebfa29-6284-4c3a-9c3f-6eb604f89194\",
-        \"_bamboo_dataset_id\": \"\", \"_tags\": [], \"_attachments\": [], \"imei\":
-        \"enketo.formhub.org:fSucCmZ5zwzNcTe1\", \"_geolocation\": [null, null], \"end_time\":
-        \"2014-05-15T17:28:18.000+01:00\", \"gender\": \"female\", \"_xform_id_string\":
-        \"survey\", \"phonenumber\": \"no phonenumber property in enketo\", \"_status\":
-        \"submitted_via_web\", \"_id\": 3318647, \"pizza_fan\": \"no\", \"today\":
-        \"2014-05-15\", \"formhub/uuid\": \"1bfb7222748a4ee98106ea7d7a9c72cf\"}]"
+      string: "[{\"meta/instanceID\": \"uuid:be1b882a-b377-4cf0-95d3-c2acc8d04e7a\",
+        \"name\": \"georges\", \"_submission_time\": \"2014-05-15T16:29:00\", \"age\":
+        \"12\", \"_uuid\": \"be1b882a-b377-4cf0-95d3-c2acc8d04e7a\", \"_bamboo_dataset_id\":
+        \"\", \"_tags\": [], \"_attachments\": [], \"_geolocation\": [null, null],
+        \"end_time\": \"2014-05-15T17:28:59.000+01:00\", \"_xform_id_string\": \"survey\",
+        \"imei\": \"enketo.formhub.org:fSucCmZ5zwzNcTe1\", \"phonenumber\": \"no phonenumber
+        property in enketo\", \"_status\": \"submitted_via_web\", \"_id\": 3318651,
+        \"start_time\": \"2014-05-15T17:28:43.000+01:00\", \"today\": \"2014-05-15\",
+        \"formhub/uuid\": \"1bfb7222748a4ee98106ea7d7a9c72cf\"}, {\"meta/instanceID\":
+        \"uuid:2aebfa29-6284-4c3a-9c3f-6eb604f89194\", \"age\": \"23\", \"name\":
+        \"loic\", \"_submission_time\": \"2014-05-15T16:28:19\", \"start_time\": \"2014-05-15T17:27:57.000+01:00\",
+        \"_uuid\": \"2aebfa29-6284-4c3a-9c3f-6eb604f89194\", \"_bamboo_dataset_id\":
+        \"\", \"_tags\": [], \"_attachments\": [], \"imei\": \"enketo.formhub.org:fSucCmZ5zwzNcTe1\",
+        \"_geolocation\": [null, null], \"end_time\": \"2014-05-15T17:28:18.000+01:00\",
+        \"gender\": \"female\", \"_xform_id_string\": \"survey\", \"phonenumber\":
+        \"no phonenumber property in enketo\", \"_status\": \"submitted_via_web\",
+        \"_id\": 3318647, \"pizza_fan\": \"no\", \"today\": \"2014-05-15\", \"formhub/uuid\":
+        \"1bfb7222748a4ee98106ea7d7a9c72cf\"}, {\"_bamboo_dataset_id\": \"\", \"_tags\":
+        [], \"pizza_type\": \"chitown\", \"phonenumber\": \"no phonenumber property
+        in enketo\", \"_xform_id_string\": \"survey\", \"meta/instanceID\": \"uuid:d85cf54e-ecf9-4b0a-b9dd-600f3dd69460\",
+        \"pizza_fan\": \"yes\", \"favorite_toppings\": \"pepperoni sausauge\", \"_attachments\":
+        [], \"_status\": \"submitted_via_web\", \"today\": \"2014-05-29\", \"start_time\":
+        \"2014-05-29T14:53:31.000+01:00\", \"_uuid\": \"d85cf54e-ecf9-4b0a-b9dd-600f3dd69460\",
+        \"imei\": \"enketo.formhub.org:fSucCmZ5zwzNcTe1\", \"formhub/uuid\": \"1bfb7222748a4ee98106ea7d7a9c72cf\",
+        \"name\": \"Robert\", \"_submission_time\": \"2014-05-29T13:55:41\", \"age\":
+        \"100\", \"_geolocation\": [null, null], \"end_time\": \"2014-05-29T14:53:58.000+01:00\",
+        \"gender\": \"male\", \"_id\": 3413155}]"
     http_version: 
-  recorded_at: Fri, 23 May 2014 11:47:31 GMT
+  recorded_at: Thu, 29 May 2014 15:28:41 GMT
 recorded_with: VCR 2.9.0

data/spec/fixtures/vcr_cassettes/query_start_and_limit.yml

@@ -0,0 +1,60 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://<USERNAME>:<PASSWORD>@formhub.org/<USERNAME>/forms/survey/api?limit=1&start=1
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Host:
+      - formhub.org
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 29 May 2014 15:28:32 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Server:
+      - gunicorn/0.15.0
+      Access-Control-Allow-Headers:
+      - Accept, Origin, X-Requested-With, Authorization
+      Content-Language:
+      - en-us
+      Vary:
+      - Accept-Language, Cookie
+      Etag:
+      - "\"a8b3103fef34948c7ead4c8335e29543\""
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - GET
+      Strict-Transport-Security:
+      - max-age=31536000
+    body:
+      encoding: UTF-8
+      string: "[{\"meta/instanceID\": \"uuid:be1b882a-b377-4cf0-95d3-c2acc8d04e7a\",
+        \"name\": \"georges\", \"_submission_time\": \"2014-05-15T16:29:00\", \"age\":
+        \"12\", \"_uuid\": \"be1b882a-b377-4cf0-95d3-c2acc8d04e7a\", \"_bamboo_dataset_id\":
+        \"\", \"_tags\": [], \"_attachments\": [], \"_geolocation\": [null, null],
+        \"end_time\": \"2014-05-15T17:28:59.000+01:00\", \"_xform_id_string\": \"survey\",
+        \"imei\": \"enketo.formhub.org:fSucCmZ5zwzNcTe1\", \"phonenumber\": \"no phonenumber
+        property in enketo\", \"_status\": \"submitted_via_web\", \"_id\": 3318651,
+        \"start_time\": \"2014-05-15T17:28:43.000+01:00\", \"today\": \"2014-05-15\",
+        \"formhub/uuid\": \"1bfb7222748a4ee98106ea7d7a9c72cf\"}]"
+    http_version: 
+  recorded_at: Thu, 29 May 2014 15:28:42 GMT
+recorded_with: VCR 2.9.0

data/spec/fixtures/vcr_cassettes/retrieve_selected_fields_only.yml

@@ -0,0 +1,55 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://<USERNAME>:<PASSWORD>@formhub.org/<USERNAME>/forms/survey/api?fields=%5B%22name%22,%22age%22%5D
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Host:
+      - formhub.org
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 02 Jun 2014 11:53:49 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Server:
+      - gunicorn/0.15.0
+      Access-Control-Allow-Headers:
+      - Accept, Origin, X-Requested-With, Authorization
+      Content-Language:
+      - en-us
+      Vary:
+      - Accept-Language, Cookie
+      Etag:
+      - "\"28b1d13b897184580960f6691040cc94\""
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - GET
+      Strict-Transport-Security:
+      - max-age=31536000
+    body:
+      encoding: UTF-8
+      string: "[{\"age\": \"15\", \"_id\": 3413156, \"name\": \"napol\\u00e9on\"},
+        {\"age\": \"12\", \"_id\": 3318651, \"name\": \"georges\"}, {\"age\": \"23\",
+        \"_id\": 3318647, \"name\": \"loic\"}, {\"age\": \"100\", \"_id\": 3413155,
+        \"name\": \"Robert\"}]"
+    http_version: 
+  recorded_at: Mon, 02 Jun 2014 11:53:49 GMT
+recorded_with: VCR 2.9.0

data/spec/fixtures/vcr_cassettes/sorts_properly.yml

@@ -0,0 +1,87 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://<USERNAME>:<PASSWORD>@formhub.org/<USERNAME>/forms/survey/api?sort=%7B%22name%22:-1%7D
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Host:
+      - formhub.org
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 02 Jun 2014 11:37:40 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Server:
+      - gunicorn/0.15.0
+      Access-Control-Allow-Headers:
+      - Accept, Origin, X-Requested-With, Authorization
+      Content-Language:
+      - en-us
+      Vary:
+      - Accept-Language, Cookie
+      Etag:
+      - "\"f9b8d47fed9e7bad4df95ec530fd7134\""
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - GET
+      Strict-Transport-Security:
+      - max-age=31536000
+    body:
+      encoding: UTF-8
+      string: "[{\"meta/instanceID\": \"uuid:269e2328-5997-43c1-aeb1-6edec8f914af\",
+        \"age\": \"15\", \"name\": \"napol\\u00e9on\", \"_submission_time\": \"2014-05-29T13:55:58\",
+        \"start_time\": \"2014-05-29T14:55:42.000+01:00\", \"_uuid\": \"269e2328-5997-43c1-aeb1-6edec8f914af\",
+        \"_bamboo_dataset_id\": \"\", \"_tags\": [], \"_attachments\": [], \"imei\":
+        \"enketo.formhub.org:fSucCmZ5zwzNcTe1\", \"_geolocation\": [null, null], \"end_time\":
+        \"2014-05-29T14:56:05.000+01:00\", \"gender\": \"female\", \"_xform_id_string\":
+        \"survey\", \"phonenumber\": \"no phonenumber property in enketo\", \"_status\":
+        \"submitted_via_web\", \"_id\": 3413156, \"pizza_fan\": \"no\", \"today\":
+        \"2014-05-29\", \"formhub/uuid\": \"1bfb7222748a4ee98106ea7d7a9c72cf\"}, {\"meta/instanceID\":
+        \"uuid:2aebfa29-6284-4c3a-9c3f-6eb604f89194\", \"age\": \"23\", \"name\":
+        \"loic\", \"_submission_time\": \"2014-05-15T16:28:19\", \"start_time\": \"2014-05-15T17:27:57.000+01:00\",
+        \"_uuid\": \"2aebfa29-6284-4c3a-9c3f-6eb604f89194\", \"_bamboo_dataset_id\":
+        \"\", \"_tags\": [], \"_attachments\": [], \"imei\": \"enketo.formhub.org:fSucCmZ5zwzNcTe1\",
+        \"_geolocation\": [null, null], \"end_time\": \"2014-05-15T17:28:18.000+01:00\",
+        \"gender\": \"female\", \"_xform_id_string\": \"survey\", \"phonenumber\":
+        \"no phonenumber property in enketo\", \"_status\": \"submitted_via_web\",
+        \"_id\": 3318647, \"pizza_fan\": \"no\", \"today\": \"2014-05-15\", \"formhub/uuid\":
+        \"1bfb7222748a4ee98106ea7d7a9c72cf\"}, {\"meta/instanceID\": \"uuid:be1b882a-b377-4cf0-95d3-c2acc8d04e7a\",
+        \"name\": \"georges\", \"_submission_time\": \"2014-05-15T16:29:00\", \"age\":
+        \"12\", \"_uuid\": \"be1b882a-b377-4cf0-95d3-c2acc8d04e7a\", \"_bamboo_dataset_id\":
+        \"\", \"_tags\": [], \"_attachments\": [], \"_geolocation\": [null, null],
+        \"end_time\": \"2014-05-15T17:28:59.000+01:00\", \"_xform_id_string\": \"survey\",
+        \"imei\": \"enketo.formhub.org:fSucCmZ5zwzNcTe1\", \"phonenumber\": \"no phonenumber
+        property in enketo\", \"_status\": \"submitted_via_web\", \"_id\": 3318651,
+        \"start_time\": \"2014-05-15T17:28:43.000+01:00\", \"today\": \"2014-05-15\",
+        \"formhub/uuid\": \"1bfb7222748a4ee98106ea7d7a9c72cf\"}, {\"_bamboo_dataset_id\":
+        \"\", \"_tags\": [], \"pizza_type\": \"chitown\", \"phonenumber\": \"no phonenumber
+        property in enketo\", \"_xform_id_string\": \"survey\", \"meta/instanceID\":
+        \"uuid:d85cf54e-ecf9-4b0a-b9dd-600f3dd69460\", \"pizza_fan\": \"yes\", \"favorite_toppings\":
+        \"pepperoni sausauge\", \"_attachments\": [], \"_status\": \"submitted_via_web\",
+        \"today\": \"2014-05-29\", \"start_time\": \"2014-05-29T14:53:31.000+01:00\",
+        \"_uuid\": \"d85cf54e-ecf9-4b0a-b9dd-600f3dd69460\", \"imei\": \"enketo.formhub.org:fSucCmZ5zwzNcTe1\",
+        \"formhub/uuid\": \"1bfb7222748a4ee98106ea7d7a9c72cf\", \"name\": \"Robert\",
+        \"_submission_time\": \"2014-05-29T13:55:41\", \"age\": \"100\", \"_geolocation\":
+        [null, null], \"end_time\": \"2014-05-29T14:53:58.000+01:00\", \"gender\":
+        \"male\", \"_id\": 3413155}]"
+    http_version: 
+  recorded_at: Mon, 02 Jun 2014 11:37:39 GMT
+recorded_with: VCR 2.9.0

data/spec/fixtures/vcr_cassettes/successful_connection.yml

@@ -21,7 +21,7 @@ http_interactions:
       message: OK
     headers:
       Date:
-      - Fri, 23 May 2014 10:45:15 GMT
+      - Thu, 29 May 2014 15:28:29 GMT
       Content-Type:
       - application/json
       Transfer-Encoding:
@@ -37,7 +37,7 @@ http_interactions:
       Vary:
       - Accept-Language, Cookie
       Etag:
-      - "\"29c06f8ea5b6a1ac0301ef2e10305bea\""
+      - "\"4baf3432bbeb6cd2b3425cf06e7158ef\""
       Access-Control-Allow-Origin:
       - "*"
       Access-Control-Allow-Methods:
@@ -46,15 +46,23 @@ http_interactions:
       - max-age=31536000
     body:
       encoding: UTF-8
-      string: "[{\"meta/instanceID\": \"uuid:be1b882a-b377-4cf0-95d3-c2acc8d04e7a\",
-        \"name\": \"georges\", \"_submission_time\": \"2014-05-15T16:29:00\", \"age\":
-        \"12\", \"_uuid\": \"be1b882a-b377-4cf0-95d3-c2acc8d04e7a\", \"_bamboo_dataset_id\":
-        \"\", \"_tags\": [], \"_attachments\": [], \"_geolocation\": [null, null],
-        \"end_time\": \"2014-05-15T17:28:59.000+01:00\", \"_xform_id_string\": \"survey\",
-        \"imei\": \"enketo.formhub.org:fSucCmZ5zwzNcTe1\", \"phonenumber\": \"no phonenumber
-        property in enketo\", \"_status\": \"submitted_via_web\", \"_id\": 3318651,
-        \"start_time\": \"2014-05-15T17:28:43.000+01:00\", \"today\": \"2014-05-15\",
-        \"formhub/uuid\": \"1bfb7222748a4ee98106ea7d7a9c72cf\"}, {\"meta/instanceID\":
+      string: "[{\"meta/instanceID\": \"uuid:269e2328-5997-43c1-aeb1-6edec8f914af\",
+        \"age\": \"15\", \"name\": \"napol\\u00e9on\", \"_submission_time\": \"2014-05-29T13:55:58\",
+        \"start_time\": \"2014-05-29T14:55:42.000+01:00\", \"_uuid\": \"269e2328-5997-43c1-aeb1-6edec8f914af\",
+        \"_bamboo_dataset_id\": \"\", \"_tags\": [], \"_attachments\": [], \"imei\":
+        \"enketo.formhub.org:fSucCmZ5zwzNcTe1\", \"_geolocation\": [null, null], \"end_time\":
+        \"2014-05-29T14:56:05.000+01:00\", \"gender\": \"female\", \"_xform_id_string\":
+        \"survey\", \"phonenumber\": \"no phonenumber property in enketo\", \"_status\":
+        \"submitted_via_web\", \"_id\": 3413156, \"pizza_fan\": \"no\", \"today\":
+        \"2014-05-29\", \"formhub/uuid\": \"1bfb7222748a4ee98106ea7d7a9c72cf\"}, {\"meta/instanceID\":
+        \"uuid:be1b882a-b377-4cf0-95d3-c2acc8d04e7a\", \"name\": \"georges\", \"_submission_time\":
+        \"2014-05-15T16:29:00\", \"age\": \"12\", \"_uuid\": \"be1b882a-b377-4cf0-95d3-c2acc8d04e7a\",
+        \"_bamboo_dataset_id\": \"\", \"_tags\": [], \"_attachments\": [], \"_geolocation\":
+        [null, null], \"end_time\": \"2014-05-15T17:28:59.000+01:00\", \"_xform_id_string\":
+        \"survey\", \"imei\": \"enketo.formhub.org:fSucCmZ5zwzNcTe1\", \"phonenumber\":
+        \"no phonenumber property in enketo\", \"_status\": \"submitted_via_web\",
+        \"_id\": 3318651, \"start_time\": \"2014-05-15T17:28:43.000+01:00\", \"today\":
+        \"2014-05-15\", \"formhub/uuid\": \"1bfb7222748a4ee98106ea7d7a9c72cf\"}, {\"meta/instanceID\":
         \"uuid:2aebfa29-6284-4c3a-9c3f-6eb604f89194\", \"age\": \"23\", \"name\":
         \"loic\", \"_submission_time\": \"2014-05-15T16:28:19\", \"start_time\": \"2014-05-15T17:27:57.000+01:00\",
         \"_uuid\": \"2aebfa29-6284-4c3a-9c3f-6eb604f89194\", \"_bamboo_dataset_id\":
@@ -63,7 +71,16 @@ http_interactions:
         \"gender\": \"female\", \"_xform_id_string\": \"survey\", \"phonenumber\":
         \"no phonenumber property in enketo\", \"_status\": \"submitted_via_web\",
         \"_id\": 3318647, \"pizza_fan\": \"no\", \"today\": \"2014-05-15\", \"formhub/uuid\":
-        \"1bfb7222748a4ee98106ea7d7a9c72cf\"}]"
+        \"1bfb7222748a4ee98106ea7d7a9c72cf\"}, {\"_bamboo_dataset_id\": \"\", \"_tags\":
+        [], \"pizza_type\": \"chitown\", \"phonenumber\": \"no phonenumber property
+        in enketo\", \"_xform_id_string\": \"survey\", \"meta/instanceID\": \"uuid:d85cf54e-ecf9-4b0a-b9dd-600f3dd69460\",
+        \"pizza_fan\": \"yes\", \"favorite_toppings\": \"pepperoni sausauge\", \"_attachments\":
+        [], \"_status\": \"submitted_via_web\", \"today\": \"2014-05-29\", \"start_time\":
+        \"2014-05-29T14:53:31.000+01:00\", \"_uuid\": \"d85cf54e-ecf9-4b0a-b9dd-600f3dd69460\",
+        \"imei\": \"enketo.formhub.org:fSucCmZ5zwzNcTe1\", \"formhub/uuid\": \"1bfb7222748a4ee98106ea7d7a9c72cf\",
+        \"name\": \"Robert\", \"_submission_time\": \"2014-05-29T13:55:41\", \"age\":
+        \"100\", \"_geolocation\": [null, null], \"end_time\": \"2014-05-29T14:53:58.000+01:00\",
+        \"gender\": \"male\", \"_id\": 3413155}]"
     http_version: 
-  recorded_at: Fri, 23 May 2014 10:45:40 GMT
+  recorded_at: Thu, 29 May 2014 15:28:39 GMT
 recorded_with: VCR 2.9.0

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: formhub_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.6.1
 platform: ruby
 authors:
 - Loïc Seigland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-23 00:00:00.000000000 Z
+date: 2014-06-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -186,8 +200,12 @@ files:
 - spec/api_connectior_spec.rb
 - spec/client_spec.rb
 - spec/fixtures/vcr_cassettes/age_query.yml
+- spec/fixtures/vcr_cassettes/just_get_the_count.yml
 - spec/fixtures/vcr_cassettes/query_limit.yml
 - spec/fixtures/vcr_cassettes/query_start.yml
+- spec/fixtures/vcr_cassettes/query_start_and_limit.yml
+- spec/fixtures/vcr_cassettes/retrieve_selected_fields_only.yml
+- spec/fixtures/vcr_cassettes/sorts_properly.yml
 - spec/fixtures/vcr_cassettes/successful_connection.yml
 - spec/spec_helper.rb
 homepage: http://loicseigland.ie
@@ -218,7 +236,11 @@ test_files:
 - spec/api_connectior_spec.rb
 - spec/client_spec.rb
 - spec/fixtures/vcr_cassettes/age_query.yml
+- spec/fixtures/vcr_cassettes/just_get_the_count.yml
 - spec/fixtures/vcr_cassettes/query_limit.yml
 - spec/fixtures/vcr_cassettes/query_start.yml
+- spec/fixtures/vcr_cassettes/query_start_and_limit.yml
+- spec/fixtures/vcr_cassettes/retrieve_selected_fields_only.yml
+- spec/fixtures/vcr_cassettes/sorts_properly.yml
 - spec/fixtures/vcr_cassettes/successful_connection.yml
 - spec/spec_helper.rb