form_stalker 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83d69f88a214755316a6cfa5f014989aabb02d1c
-  data.tar.gz: ea5054f20c99e9c0b949a7a521b60560e35b2109
+  metadata.gz: b32f1eee7efca73e34710b9180b5f1358b8ae1c6
+  data.tar.gz: 0c85f46173c155550830617e7acbe9bb274e62fb
 SHA512:
-  metadata.gz: 27ddfab878ab2b2c0e167cd61cb620a83a694c8b44fd56500b939353817770d8b4d5a08d2327c78f34bbf8a09a1189d89897f98665767a5fb05f6a5cab87db3c
-  data.tar.gz: e7fdd74b0234a2129cab3c9cf0ea5ba52ee7421e1ae327f6f3770e0f9f3f68bccd209b526362ba00c676c1f36744a850e4cefd6abd2e57be796ed53faa3150b8
+  metadata.gz: 5b06ab3be3ad932d756530d8d7cdeef49d3f431043847a10b8976197606de7260606bc53e4043ea2b05d6d601edaa0a67eed753b4a45a99ac595d864ff7ef72f
+  data.tar.gz: af92d5230619f03b7949a58bbd85ead871d5f3b995531a5c980a9a987f44812dda1089800dd2f0e67a665267169b1c01ed5434d6d1ed08436a63aeb2d4dc713e

data/README.md

@@ -1,13 +1,15 @@
 # FormStalker
 FormStack API client that can extract conditional logic.
-Some missing methods like editing or deleting a form will be added along the way, but we also encourage you do implement them and submitting a PR :thumbsup:
+
+Some missing methods like editing or deleting a form will be added along the way but we also encourage you do implement them and submitting a PR :thumbsup:
 
 [![Code Climate](https://codeclimate.com/github/Streetbees/form-stalker/badges/gpa.svg)](https://codeclimate.com/github/Streetbees/form-stalker)
 [![Test Coverage](https://codeclimate.com/github/Streetbees/form-stalker/badges/coverage.svg)](https://codeclimate.com/github/Streetbees/form-stalker/coverage)
 [![Build Status](https://travis-ci.org/Streetbees/form-stalker.svg?branch=master)](https://travis-ci.org/Streetbees/form-stalker)
+[![Gem Version](https://badge.fury.io/rb/form_stalker.svg)](https://badge.fury.io/rb/form_stalker)
 
 ## 1) Usage
-Create an initializer and set your your formstack oauth token.
+Create an initializer and set your formstack oauth token.
 ```ruby
 FormStalker.configure do |config|
   config.oauth_token = 'your formstack oauth token'
@@ -18,7 +20,8 @@ Make requests to FormStack and receive a sanitized response
 ```ruby
 response = FormStalker.form(1)
 
-if response.ok? # or (response.status == :ok)
+# don't trust (response.status == :ok) because Formstack API does not respect the HTTP error status
+if response.ok?
   form_data = response.data
 else
   response.status # will return a symbol representing FormStack's HTTP status
@@ -40,4 +43,4 @@ $> bundle install
 ```
 
 ## 3) F.A.Q.
-wip
+- wip

data/lib/form_stalker/client.rb

@@ -1,4 +1,3 @@
-require 'form_stalker/data/base'
 require 'form_stalker/data/form'
 require 'form_stalker/data/form_field'
 require 'form_stalker/connection'

data/lib/form_stalker/data/base.rb

@@ -1,6 +1,22 @@
+require 'form_stalker/data/parser'
+
 module FormStalker
   module Data
     class Base < OpenStruct
+      def self.schema(options = nil)
+        type_cast_schema.merge! options
+      end
+
+      def self.type_cast_schema
+        @type_cast_schema ||= { id: :integer }
+      end
+
+      def self.inherited(base)
+        base.type_cast_schema.merge! type_cast_schema.clone
+
+        super
+      end
+
       def self.tap_into(response)
         return response unless response.ok?
 
@@ -15,6 +31,18 @@ module FormStalker
       end
 
       alias attributes marshal_dump
+
+      attr_reader :parser
+
+      def initialize(attributes = nil)
+        attributes ||= {}
+
+        instance_variable_set('@table', attributes)
+
+        @parser = Parser.new(self, self.class.type_cast_schema, attributes)
+
+        super(@parser.parse_attributes)
+      end
     end
   end
 end

data/lib/form_stalker/data/form.rb

@@ -1,7 +1,24 @@
+require 'form_stalker/data/base'
 
 module FormStalker
   module Data
     class Form < Base
+      schema db: :boolean,
+             views: :integer,
+             deleted: :boolean,
+             created: :datetime,
+             updated: :datetime,
+             inactive: :boolean,
+             encrypted: :boolean,
+             submissions: :integer,
+             submissions_today: :integer,
+             submissions_unread: :integer,
+             last_submission_id: :integer,
+             last_submission_time: :datetime
+
+      def parse_fields(fields_array)
+        (fields_array || []).map { |fields| FormField.new(fields) }
+      end
     end
   end
 end

data/lib/form_stalker/data/form_field.rb

@@ -1,7 +1,17 @@
+require 'form_stalker/data/base'
 
 module FormStalker
   module Data
     class FormField < Base
+      schema sort: :integer,
+             uniq: :boolean,
+             hidden: :boolean,
+             colspan: :integer,
+             required: :boolean,
+             readonly: :boolean,
+             hide_label: :boolean,
+             option_other: :boolean,
+             description_callout: :boolean
     end
   end
 end

data/lib/form_stalker/data/parser.rb

@@ -0,0 +1,47 @@
+module FormStalker
+  module Data
+    class Parser
+      attr_reader :object, :type_cast_schema, :attributes_before_type_cast
+
+      def initialize(object, type_cast_schema, attributes)
+        @object = object
+        @type_cast_schema = type_cast_schema
+        @attributes_before_type_cast = attributes.dup
+      end
+
+      def parse_attributes
+        attributes = {}
+
+        attributes_before_type_cast.each do |key, value|
+          attributes[key] = parse_attribute key, value
+        end
+
+        attributes
+      end
+
+      def parse_attribute(key, value)
+        if object.respond_to?("parse_#{key}")
+          return object.send("parse_#{key}", value)
+        end
+
+        return value unless type_cast_schema[key.to_sym]
+
+        send("sanitize_#{type_cast_schema[key.to_sym]}", value)
+      end
+
+      def sanitize_boolean(value)
+        ![false, 0, '0', 'false', 'FALSE'].include?(value)
+      end
+
+      def sanitize_integer(value)
+        value.to_i if value.to_s =~ /\A[+-]?\d+\Z/
+      end
+
+      def sanitize_datetime(value)
+        DateTime.parse(value)
+      rescue
+        value
+      end
+    end
+  end
+end

data/lib/form_stalker/response.rb

@@ -67,7 +67,7 @@ module FormStalker
     end
 
     def ok?
-      status == :ok
+      status == :ok && (error.nil? || error == '')
     end
 
     protected ######################## PROTECTED ###############################

data/lib/form_stalker/version.rb

@@ -1,3 +1,3 @@
 module FormStalker
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.0.1'.freeze
 end

data/lib/form_stalker.rb

@@ -16,4 +16,12 @@ module FormStalker
   def client
     @client ||= Client.new(Config.new)
   end
+
+  def form(*args)
+    client.form(*args)
+  end
+
+  def form_fields(*args)
+    client.form_fields(*args)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: form_stalker
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - StreetBees Dev Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-29 00:00:00.000000000 Z
+date: 2016-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vcr
@@ -128,17 +128,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-version"
-- ".travis.yml"
-- Gemfile
-- Gemfile.lock
-- LICENSE
 - README.md
-- Rakefile
-- form_stalker.gemspec
 - lib/form_stalker.rb
 - lib/form_stalker/client.rb
 - lib/form_stalker/config.rb
@@ -146,19 +136,10 @@ files:
 - lib/form_stalker/data/base.rb
 - lib/form_stalker/data/form.rb
 - lib/form_stalker/data/form_field.rb
+- lib/form_stalker/data/parser.rb
 - lib/form_stalker/request.rb
 - lib/form_stalker/response.rb
 - lib/form_stalker/version.rb
-- spec/fixtures/vcr_cassettes/form_fields_invalid_id.yml
-- spec/fixtures/vcr_cassettes/form_fields_valid_id.yml
-- spec/fixtures/vcr_cassettes/form_invalid_id.yml
-- spec/fixtures/vcr_cassettes/form_valid_id.yml
-- spec/fixtures/vcr_cassettes/invalid_oauth_token.yml
-- spec/form_stalker/client_spec.rb
-- spec/form_stalker/form_stalker_spec.rb
-- spec/form_stalker/request_spec.rb
-- spec/spec_helper.rb
-- spec/support/helpers.rb
 homepage: https://github.com/streetbees/form-stalker
 licenses:
 - MIT
@@ -183,14 +164,4 @@ rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: FormStack API client that can extract conditional logic
-test_files:
-- spec/fixtures/vcr_cassettes/form_fields_invalid_id.yml
-- spec/fixtures/vcr_cassettes/form_fields_valid_id.yml
-- spec/fixtures/vcr_cassettes/form_invalid_id.yml
-- spec/fixtures/vcr_cassettes/form_valid_id.yml
-- spec/fixtures/vcr_cassettes/invalid_oauth_token.yml
-- spec/form_stalker/client_spec.rb
-- spec/form_stalker/form_stalker_spec.rb
-- spec/form_stalker/request_spec.rb
-- spec/spec_helper.rb
-- spec/support/helpers.rb
+test_files: []

data/.gitignore

@@ -1,50 +0,0 @@
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-.ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
-
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
-
-.DS_Store
-
-# Jetbrains Idea files
-.idea/
-api.iml
-
-db/schema.rb

data/.rspec

@@ -1,4 +0,0 @@
---tty
---color
---format documentation
---format html -o "tmp/rspec_result.html"

data/.rubocop.yml

@@ -1,11 +0,0 @@
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-AllCops:
-  DisplayCopNames: true
-  Exclude:
-    - 'Gemfile*'
-    - '*.gemspec'
-
-Documentation:
-  Enabled: false

data/.ruby-version

@@ -1 +0,0 @@
-2.3.0

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-- 1.9.3
-- 2.3.0

data/Gemfile

@@ -1,3 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec

data/Gemfile.lock

@@ -1,79 +0,0 @@
-PATH
-  remote: .
-  specs:
-    form_stalker (1.0.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.3.8)
-    ast (2.2.0)
-    codeclimate-test-reporter (0.4.8)
-      simplecov (>= 0.7.1, < 1.0.0)
-    coderay (1.1.1)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.2.5)
-    docile (1.1.5)
-    hashdiff (0.3.0)
-    json (1.8.3)
-    method_source (0.8.2)
-    parser (2.3.0.6)
-      ast (~> 2.2)
-    powerpack (0.1.1)
-    pry (0.10.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    rainbow (2.1.0)
-    rake (11.2.2)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.4)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
-    rubocop (0.37.2)
-      parser (>= 2.3.0.4, < 3.0)
-      powerpack (~> 0.1)
-      rainbow (>= 1.99.1, < 3.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 0.3)
-    ruby-progressbar (1.7.5)
-    safe_yaml (1.0.4)
-    simplecov (0.11.2)
-      docile (~> 1.1.0)
-      json (~> 1.8)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
-    slop (3.6.0)
-    unicode-display_width (0.3.1)
-    vcr (3.0.3)
-    webmock (2.1.0)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-      hashdiff
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  codeclimate-test-reporter (= 0.4.8)
-  form_stalker!
-  pry (= 0.10.3)
-  rake (= 11.2.2)
-  rspec (= 3.4.0)
-  rubocop (= 0.37.2)
-  simplecov (= 0.11.2)
-  vcr (= 3.0.3)
-  webmock (= 2.1.0)
-
-BUNDLED WITH
-   1.12.5

data/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2016 
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

data/Rakefile

@@ -1,10 +0,0 @@
-require 'bundler/gem_tasks'
-
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
-
-RSpec::Core::RakeTask.new
-RuboCop::RakeTask.new
-
-task(:default).clear
-task default: [:rubocop, :spec]

data/form_stalker.gemspec

@@ -1,30 +0,0 @@
-lib = File.expand_path('../lib', __FILE__)
-
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'form_stalker/version'
-
-Gem::Specification.new do |gem|
-  gem.name = 'form_stalker'
-  gem.version = FormStalker::VERSION
-  gem.license = 'MIT'
-  gem.authors = ['StreetBees Dev Team']
-  gem.email = 'dev@streetbees.com'
-  gem.summary = 'FormStack API client that can extract conditional logic'
-  gem.description = 'Ruby FormStack API gem that can extract conditional logic'
-  gem.homepage = 'https://github.com/streetbees/form-stalker'
-
-  gem.files = `git ls-files`.split($/)
-  gem.executables = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
-  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ['lib']
-
-  gem.add_development_dependency 'vcr', '3.0.3'
-  gem.add_development_dependency 'pry', '0.10.3'
-  gem.add_development_dependency 'rake', '11.2.2'
-  gem.add_development_dependency 'rspec', '3.4.0'
-  gem.add_development_dependency 'webmock', '2.1.0'
-  gem.add_development_dependency 'rubocop', '0.37.2'
-  gem.add_development_dependency 'simplecov', '0.11.2'
-  gem.add_development_dependency 'codeclimate-test-reporter', '0.4.8'
-end

data/spec/fixtures/vcr_cassettes/form_fields_invalid_id.yml

@@ -1,58 +0,0 @@
----
-http_interactions:
-- request:
-    method: get
-    uri: https://www.formstack.com/api/v2/form/-1/field.json?oauth_token=valid_oauth_token
-    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:
-      - www.formstack.com
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Cache-Control:
-      - no-cache
-      Content-Type:
-      - application/json; charset=UTF-8
-      Date:
-      - Fri, 29 Jul 2016 14:12:04 GMT
-      P3p:
-      - CP="CURa ADMa DEVa PSAo PSDo OUR BUS UNI PUR INT DEM STA PRE COM NAV OTC NOI
-        DSP COR"
-      Server:
-      - nginx
-      Set-Cookie:
-      - FormstackAdmin=rb6oq13q19asaln18lrnt9vjf5; path=/api/; secure; HttpOnly
-      - rgemail=subs%40streetbees.com; expires=Sun, 28-Aug-2016 14:12:04 GMT; Max-Age=2592000
-      - rgfirstname=Queen; expires=Sun, 28-Aug-2016 14:12:04 GMT; Max-Age=2592000
-      - rgfullname=Bee; expires=Sun, 28-Aug-2016 14:12:04 GMT; Max-Age=2592000
-      - rgisanonymous=false; expires=Sun, 28-Aug-2016 14:12:04 GMT; Max-Age=2592000
-      - rgisanonymous=false; expires=Sun, 28-Aug-2016 14:12:04 GMT; Max-Age=2592000
-      - rgisanonymous=true; expires=Sun, 28-Aug-2016 14:12:04 GMT; Max-Age=2592000
-      - rguserid=642682; expires=Sun, 28-Aug-2016 14:12:04 GMT; Max-Age=2592000
-      - rguserid=6cddb9b1-409e-4e89-96d7-ff6e41f5d90d; expires=Sun, 28-Aug-2016 14:12:04
-        GMT; Max-Age=2592000
-      - rguuid=false; expires=Sun, 28-Aug-2016 14:12:04 GMT; Max-Age=2592000
-      - rguuid=true; expires=Sun, 28-Aug-2016 14:12:04 GMT; Max-Age=2592000
-      X-Robots-Tag:
-      - noindex, nofollow
-      Content-Length:
-      - '61'
-      Connection:
-      - keep-alive
-    body:
-      encoding: UTF-8
-      string: '{"status":"error","error":"A valid form id was not supplied"}'
-    http_version:
-  recorded_at: Fri, 29 Jul 2016 14:12:04 GMT
-recorded_with: VCR 3.0.3