formstack-api 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2669b7804e8939a5c727199f0e1aa3ae2d2515cf
-  data.tar.gz: ee47e04b29a3cca360bcd77876e4f4b135556f31
+  metadata.gz: d4550818e45ca4caffc11f17568f2bc56d3035f5
+  data.tar.gz: 61d6a9f6490535ee5fd7071651abc6064cefdd4c
 SHA512:
-  metadata.gz: 9db243304d627a09c4bfdab0b336c21b75f0246ca5e49e17c627ba9c52d774e7ba77e9f258bb215cf4b132bd6d48ce00c9b7ce87ef6b8a5f7d27758674aec8eb
-  data.tar.gz: 40a94809cf2643ff6dc33fd0877cff951b75c24f8e1db0a366dbfa92790311bc649785476ce17344989ebfc4faf7a906e723855f1fe1c3fac90a656c403c68c2
+  metadata.gz: 59af4928b5511cc03da28f1aee3107817a2baaaf57ee45cce3f105489aff5119344556bf01752f5d493dee50e417e87a26c6d18d88e5d64b3ecf151010b04629
+  data.tar.gz: 515b9bf68e4f112c750bc237f146bc47383354892c81ee2f9c2b9b2b32baf5a75e24dfac6d30719080d7f39ba0aee6fbb3400b746b75e16800e6e44a96c0f4b7

data/lib/formstack/api.rb

@@ -82,6 +82,12 @@ module Formstack
       request("form/#{form_id}", 'GET');
     end
 
+    def form_fields(form_id)
+      is_numeric?(form_id)
+
+      request("form/#{form_id}/field.json", 'GET');
+    end
+
     def copy_form(form_id)
       is_numeric?(form_id)
 

data/lib/formstack/api/version.rb

@@ -1,5 +1,5 @@
 module Formstack
   module Api
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

data/spec/support/vcr.rb

@@ -13,6 +13,7 @@ SUBMISSION_DETAILS_ID = 000000000
 SUBMISSION_DETAILS_FORM_ID = 0000000
 EDIT_SUBMISSION_FIELD_ID = 00000000
 EDIT_SUBMISSION_ARRAY_FIELD_ID = 00000000
+FORM_FIELDS_ID = 0000000
 
 # ACCESS_TOKEN = '982cf05d56baa2f12db45bea51d68968'
 # INACCESSIBLE_FORM_ID = 1832744
@@ -26,12 +27,14 @@ EDIT_SUBMISSION_ARRAY_FIELD_ID = 00000000
 # SUBMISSION_DETAILS_FORM_ID = 1873710
 # EDIT_SUBMISSION_FIELD_ID = 28705506
 # EDIT_SUBMISSION_ARRAY_FIELD_ID = 28705506
+# FORM_FIELDS_ID = 1881378
 
 VCR.configure do |c|
     c.cassette_library_dir = 'spec/vcr'
     c.hook_into :webmock # or :fakeweb
     c.filter_sensitive_data('<ACCESS_TOKEN>') { ACCESS_TOKEN }
     c.filter_sensitive_data('<FORM_ID>') { SUBMIT_FORM_ID }
+    c.filter_sensitive_data('<FORM_FIELDS_ID>') { FORM_FIELDS_ID }
     c.filter_sensitive_data('<INACCESSIBLE_FORM_ID>') { INACCESSIBLE_FORM_ID }
     c.filter_sensitive_data('<SUBMISSION_DETAILS_ID>') { SUBMISSION_DETAILS_ID }
     c.filter_sensitive_data('<UPLOAD_FORM_ID>') { UPLOAD_FORM_ID }

data/spec/vcr/Formstack_API/_form_fields/retrieves_all_the_fields_from_a_form.yml

@@ -0,0 +1,41 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://www.formstack.com/api/v2/form/<FORM_FIELDS_ID>/field.json
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Authorization:
+      - Bearer <ACCESS_TOKEN>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 24 Nov 2014 13:17:26 GMT
+      Content-Type:
+      - application/json; charset=UTF-8
+      Content-Length:
+      - '234'
+      Connection:
+      - keep-alive
+      P3p:
+      - CP="CURa ADMa DEVa PSAo PSDo OUR BUS UNI PUR INT DEM STA PRE COM NAV OTC NOI
+        DSP COR"
+      Set-Cookie:
+      - FormstackAdmin=4ln4vl6k68mk99a528o61400t4; path=/api/; secure; HttpOnly
+      Cache-Control:
+      - no-cache
+      X-Robots-Tag:
+      - noindex, nofollow
+    body:
+      encoding: UTF-8
+      string: '[{"id":"28906371","label":"Short Answer","hide_label":"0","description":null,"name":"short_answer","type":"text","options":"","default":"","required":"0","uniq":"0","hidden":"0","readonly":"0","colspan":"1","sort":"0","text_size":50}]'
+    http_version: 
+  recorded_at: Mon, 24 Nov 2014 13:17:25 GMT
+recorded_with: VCR 2.9.3

data/spec/wrapper_spec.rb

@@ -16,6 +16,7 @@ RSpec.describe Formstack::API do
   let(:submission_details_form_id) { SUBMISSION_DETAILS_FORM_ID }
   let(:edit_submission_field_id) { EDIT_SUBMISSION_FIELD_ID }
   let(:edit_submission_array_field_id) { EDIT_SUBMISSION_ARRAY_FIELD_ID }
+  let(:form_fields_id) { FORM_FIELDS_ID }
 
   subject(:wrapper) { Formstack::API.new(access_token) }
 
@@ -334,6 +335,32 @@ RSpec.describe Formstack::API do
     end
   end
 
+  describe '#form_fields', :vcr do
+    let(:form_fields) { [{"id"=>"28906371",
+                          "label"=>"Short Answer",
+                          "hide_label"=>"0",
+                          "description"=>nil,
+                          "name"=>"short_answer",
+                          "type"=>"text",
+                          "options"=>"",
+                          "default"=>"",
+                          "required"=>"0",
+                          "uniq"=>"0",
+                          "hidden"=>"0",
+                          "readonly"=>"0",
+                          "colspan"=>"1",
+                          "sort"=>"0",
+                          "text_size"=>50}] }
+
+    it 'retrieves all the fields from a form' do
+      fields = wrapper.form_fields(form_fields_id)
+      expect(fields).to eq(form_fields)
+    end
+
+    it 'raises an exception if form id is not numeric' do
+      expect{wrapper.form_fields('fail')}.to raise_exception('Form ID must be numeric')
+    end
+  end
   # describe '#', :vcr => { :record => :all } do
 
   def get_editable_submission_id

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: formstack-api
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Mauro Morales
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-20 00:00:00.000000000 Z
+date: 2014-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -157,6 +157,7 @@ files:
 - spec/vcr/Formstack_API/_form_details/reads_a_form_name.yml
 - spec/vcr/Formstack_API/_form_details/responds_with_an_error_if_form_id_doesnt_exist.yml
 - spec/vcr/Formstack_API/_form_details/responds_with_an_error_if_you_dont_have_access_to_form.yml
+- spec/vcr/Formstack_API/_form_fields/retrieves_all_the_fields_from_a_form.yml
 - spec/vcr/Formstack_API/_form_submissions/gets_submissions_default.yml
 - spec/vcr/Formstack_API/_form_submissions/raises_an_error_if_page_number_is_not_working.yml
 - spec/vcr/Formstack_API/_form_submissions/returns_data_if_specified.yml
@@ -209,6 +210,7 @@ test_files:
 - spec/vcr/Formstack_API/_form_details/reads_a_form_name.yml
 - spec/vcr/Formstack_API/_form_details/responds_with_an_error_if_form_id_doesnt_exist.yml
 - spec/vcr/Formstack_API/_form_details/responds_with_an_error_if_you_dont_have_access_to_form.yml
+- spec/vcr/Formstack_API/_form_fields/retrieves_all_the_fields_from_a_form.yml
 - spec/vcr/Formstack_API/_form_submissions/gets_submissions_default.yml
 - spec/vcr/Formstack_API/_form_submissions/raises_an_error_if_page_number_is_not_working.yml
 - spec/vcr/Formstack_API/_form_submissions/returns_data_if_specified.yml