formhub_ruby 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19a10a14da1e872eccaf21412f6ba5dbfb4b577c
-  data.tar.gz: d0708177046b6a808fb1787023a4ad79203beda5
+  metadata.gz: 53e40696a5df2916c66b1c0147d072f249745cd3
+  data.tar.gz: b75207dbede97b2e27594c4f441afd39b4503139
 SHA512:
-  metadata.gz: 08b626d2b17c11e413c3477ab3a7ab5ae65a1b5440c883e4f4c88f3f8d35d88233d65bdc7ff480d9bf3403ce3d1b21e22b748cf19d5c5d3c87e7d508d773d39b
-  data.tar.gz: edb9912b9fb3a5f7d4e809ec576a4e28b4414eeaca2b95eb399f1cdf14d67f21028344ec544134de428da3e4970edf837accd145d00cae2fbbf0c4f9037cd73b
+  metadata.gz: 9e779da0e015cf45314fe0a3f25014366e11dafee2ada6503ce7bfe0cc42888d33d0ecbdd5d5982a821ce8c8acc1b04b10c3ca0fead91bb2d9f0885fb0589fe1
+  data.tar.gz: 3bea5ec656654992ab7e089e7f2adda6c04aa080738be73ef44f071890cb932d07537bcd8ad723efb55c626e613790edd9bf7a276427517f2072bb817c337e25

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+script: 
+  - bundle exec rspec spec/
+
+bundler_args: --binstubs=./bundler_stubs
+
+# addons:
+#   code_climate:
+#     repo_token: 161c371501ee0f5ff7656178f8265702fd9f6a069652bcbeeee38002a3add8c9
+branches:
+  only:
+    - master
+    - develop

data/lib/formhub_ruby/api_connector.rb

@@ -1,21 +1,27 @@
 require 'net/http'
 require 'json'
+require 'cgi'
 module FormhubRuby
   class ApiConnector
     attr_reader :formname, :filetype, :username, :password, :data
+    attr_accessor :query, :start, :limit
 
-    def initialize(args)  
+
+    def initialize(args) 
       @username = args[:username] || FormhubRuby.configuration.username
       @password = args[:password] || FormhubRuby.configuration.password
-      @formname = args[:formname]
       @filetype = args[:filetype] || 'json'
+      @formname = args[:formname]
+      @query = args[:query]
+      @start = args[:start] 
+      @limit = args[:limit]
     end
 
     def fetch
       # CAN DO THAT A LATER STAGE: Define different url format
       # for different data point formats
       # uri = URI(form_uri)         
-      uri = URI("http://formhub.org/#{@username}/forms/#{@formname}/api")
+      uri = URI(api_uri)
       req = Net::HTTP::Get.new(uri)
       req.basic_auth @username, @password
       response = Net::HTTP.start(uri.hostname, uri.port) do |http|
@@ -31,15 +37,46 @@ module FormhubRuby
 
     # private
 
-    # CAN DO THAT A LATER STAGE: Define different data point formats
-    # (now will default to JSON)
+    def api_uri
+      "http://formhub.org/#{@username}/forms/#{@formname}/api" + api_parameters.to_s
+    end
+
+    def api_parameters
+       if api_parameters_array.any?
+          "?#{api_parameters_joined}"
+       end
+    end
+
+    def api_query
+      if @query
+        "query=#{CGI.escape stringify_hash_values(@query).to_json}"
+      end
+    end
+
+    def api_parameters_array
+      [api_query, start, limit]
+    end
+
+    def api_parameters_joined
+      api_parameters_array.compact.join('&')
+    end
+
+    def start
+      if @start
+        "start=#{@start.to_s}"
+      end
+    end
+
+    def limit
+      if @limit
+        "limit=#{@limit.to_s}"
+      end
+    end
+
+    def stringify_hash_values(hash)
+      hash.merge(hash){|k,hashv|hashv.to_s}
+    end
 
-    # def form_uri
-    #   case @filetype.downcase
-    #   when 'json' then "http://formhub.org/#{@username}/forms/#{@formname}/api"
-    #   when 'csv' then "http://formhub.org/#{@username}/forms/#{@formname}/data.csv"
-    #   when 'xls' then "http://formhub.org/#{@username}/forms/#{@formname}/data.xls"
-    #   end
     # end
   end
 end

data/lib/formhub_ruby/version.rb

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

data/spec/api_connectior_spec.rb

@@ -3,7 +3,6 @@ require 'spec_helper'
 require 'yaml'
 
 describe FormhubRuby::ApiConnector do
-
   before :each do
     credentials = YAML.load_file('spec/fixtures/test_credentials.yml')
     FormhubRuby.configure do |config|
@@ -11,20 +10,66 @@ describe FormhubRuby::ApiConnector do
       config.password = credentials['password']
     end
   end
+  
+
+  context 'when connecting to the API' do
+    
 
-  it 'successfully connects to the FormHub API and retrieve JSON Data' 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)
+    it 'successfully connects to the FormHub API and retrieve JSON Data' 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)
+      end
     end
-  end
 
-  it "displays appropriate message if the JSON data is not successfully retrieved" do
-      stub_request(:any, "http://formhub.org/#{FormhubRuby.configuration.username}/forms/survey/api").to_return(:body => "NO JSON HERE")
+    it 'displays appropriate message if the JSON data is not successfully retrieved' do
+      stub_request(:any, "http://formhub.org/#{FormhubRuby.configuration.username}/forms/survey/api").to_return(:body => 'NO JSON HERE')
       connection = FormhubRuby::ApiConnector.new(formname: 'fake')
-      expect {connection.fetch}.to raise_error("API connection error")
+      expect {connection.fetch}.to raise_error('API connection error')
+    end
   end
+
+  context 'when formulating a more complex query string' do
+
+    let(:connection) {FormhubRuby::ApiConnector.new(formname: 'survey')}
+    let(:username) {FormhubRuby.configuration.username}
+
+    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"
+    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"
+      VCR.use_cassette 'age_query' do
+        connection.fetch
+        connection.data.length.should == 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"
+      VCR.use_cassette 'query_start' do
+        connection.fetch
+        connection.data.length.should == 1
+      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"
+      VCR.use_cassette 'query_limit' do
+        connection.fetch
+        connection.data.length.should == 1
+      end
+    end
+    
+  end
+
 end
 

data/spec/fixtures/vcr_cassettes/age_query.yml

@@ -0,0 +1,60 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://<USERNAME>:<PASSWORD>@formhub.org/<USERNAME>/forms/survey/api?query=%7B%22age%22:%2212%22%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:
+      - Fri, 23 May 2014 11:41:14 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: Fri, 23 May 2014 11:41:39 GMT
+recorded_with: VCR 2.9.0

data/spec/fixtures/vcr_cassettes/query_limit.yml

@@ -0,0 +1,60 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://<USERNAME>:<PASSWORD>@formhub.org/<USERNAME>/forms/survey/api?limit=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:
+      - Fri, 23 May 2014 11:46:21 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: Fri, 23 May 2014 11:46:46 GMT
+recorded_with: VCR 2.9.0

data/spec/fixtures/vcr_cassettes/query_start.yml

@@ -0,0 +1,60 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://<USERNAME>:<PASSWORD>@formhub.org/<USERNAME>/forms/survey/api?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:
+      - Fri, 23 May 2014 11:47:06 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:
+      - "\"cca3b5eba43f81971965707f51c4882b\""
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Methods:
+      - GET
+      Strict-Transport-Security:
+      - 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\"}]"
+    http_version: 
+  recorded_at: Fri, 23 May 2014 11:47:31 GMT
+recorded_with: VCR 2.9.0

data/spec/fixtures/vcr_cassettes/successful_connection.yml

@@ -0,0 +1,69 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://<USERNAME>:<PASSWORD>@formhub.org/<USERNAME>/forms/survey/api
+    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:
+      - Fri, 23 May 2014 10:45:15 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:
+      - "\"29c06f8ea5b6a1ac0301ef2e10305bea\""
+      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\"}, {\"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\"}]"
+    http_version: 
+  recorded_at: Fri, 23 May 2014 10:45:40 GMT
+recorded_with: VCR 2.9.0

data/spec/spec_helper.rb

@@ -1,11 +1,10 @@
 require 'vcr'
 require 'webmock'
 require 'webmock/rspec'
-require 'factory_girl'
+require 'yaml'
+require 'cgi'
 
 RSpec.configure do |config|
-  FactoryGirl.find_definitions
-
   config.include WebMock::API
   config.before(:each) do
     WebMock.reset!
@@ -13,22 +12,16 @@ RSpec.configure do |config|
       c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
       c.allow_http_connections_when_no_cassette = true
       c.hook_into :webmock
-      # c.before_record do |i|
-
-      #   i.response.headers.delete('Set-Cookie')
-      #   i.request.headers.delete('Authorization')
-
-      #   u = URI.parse(i.request.uri)
-      #   i.request.uri.sub!(%r{:\/\/.*#{Regexp.escape(u.host)}}, "://#{u.host}")
 
-      # end
+      # Created a yml file with credentials 
+      # ignored by git repository
+      credentials = YAML.load_file('spec/fixtures/test_credentials.yml')
+      
+      c.filter_sensitive_data('<USERNAME>') { credentials['username'] }
+      c.filter_sensitive_data('<PASSWORD>') { CGI.escape credentials['password'] }
+      c.filter_sensitive_data('<PASSWORD>') { credentials['password'] }
 
-      # Matches authenticated requests regardless of their Basic
-      # auth string (https://user:pass@domain.tld)
-      # c.register_request_matcher :anonymized_uri do |request_1, request_2|
-      #   (URI(request_1.uri).port == URI(request_2.uri).port) &&
-      #     URI(request_1.uri).path == URI(request_2.uri).path
-      # end
+      
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: formhub_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Loïc Seigland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-21 00:00:00.000000000 Z
+date: 2014-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -172,6 +172,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -184,6 +185,10 @@ files:
 - lib/formhub_ruby/version.rb
 - spec/api_connectior_spec.rb
 - spec/client_spec.rb
+- spec/fixtures/vcr_cassettes/age_query.yml
+- spec/fixtures/vcr_cassettes/query_limit.yml
+- spec/fixtures/vcr_cassettes/query_start.yml
+- spec/fixtures/vcr_cassettes/successful_connection.yml
 - spec/spec_helper.rb
 homepage: http://loicseigland.ie
 licenses:
@@ -212,4 +217,8 @@ summary: Simple Client for the Formhub API
 test_files:
 - spec/api_connectior_spec.rb
 - spec/client_spec.rb
+- spec/fixtures/vcr_cassettes/age_query.yml
+- spec/fixtures/vcr_cassettes/query_limit.yml
+- spec/fixtures/vcr_cassettes/query_start.yml
+- spec/fixtures/vcr_cassettes/successful_connection.yml
 - spec/spec_helper.rb