form_stalker 1.0.0

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,50 @@
+*.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

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

data/.rubocop.yml

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

data/.ruby-version

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

data/.travis.yml

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,79 @@
+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

@@ -0,0 +1,21 @@
+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/README.md

@@ -0,0 +1,43 @@
+# 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:
+
+[![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)
+
+## 1) Usage
+Create an initializer and set your your formstack oauth token.
+```ruby
+FormStalker.configure do |config|
+  config.oauth_token = 'your formstack oauth token'
+end
+```
+
+Make requests to FormStack and receive a sanitized response
+```ruby
+response = FormStalker.form(1)
+
+if response.ok? # or (response.status == :ok)
+  form_data = response.data
+else
+  response.status # will return a symbol representing FormStack's HTTP status
+  response.error # will return a message string explaining the error
+end
+```
+
+## 2) Instalation
+
+Add this to your Gemfile:
+```
+gem 'form_stalker'
+```
+
+And then execute:
+
+```
+$> bundle install
+```
+
+## 3) F.A.Q.
+wip

data/Rakefile

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,30 @@
+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/lib/form_stalker.rb

@@ -0,0 +1,19 @@
+require 'form_stalker/version'
+require 'form_stalker/client'
+require 'form_stalker/config'
+
+module FormStalker
+  module_function
+
+  def configure
+    yield(config)
+  end
+
+  def config
+    client.config
+  end
+
+  def client
+    @client ||= Client.new(Config.new)
+  end
+end

data/lib/form_stalker/client.rb

@@ -0,0 +1,33 @@
+require 'form_stalker/data/base'
+require 'form_stalker/data/form'
+require 'form_stalker/data/form_field'
+require 'form_stalker/connection'
+require 'form_stalker/request'
+
+module FormStalker
+  class Client
+    attr_reader :connection
+
+    def initialize(config_or_options = nil)
+      @connection = Connection.new(config_or_options || {})
+    end
+
+    def config
+      connection.config
+    end
+
+    def form(form_id)
+      Data::Form.tap_into request.get("form/#{form_id}.json")
+    end
+
+    def form_fields(form_id)
+      Data::FormField.tap_into request.get("form/#{form_id}/field.json")
+    end
+
+    protected ######################## PROTECTED ###############################
+
+    def request
+      Request.new(connection)
+    end
+  end
+end

data/lib/form_stalker/config.rb

@@ -0,0 +1,16 @@
+module FormStalker
+  class Config
+    DEFAULT_VALUES = {
+      protocol: 'https',
+      base_uri: 'www.formstack.com/api/v2'
+    }.freeze
+
+    attr_accessor :protocol, :base_uri, :oauth_token
+
+    def initialize(attributes = nil)
+      DEFAULT_VALUES.merge(attributes || {}).each do |name, value|
+        send("#{name}=", value)
+      end
+    end
+  end
+end

data/lib/form_stalker/connection.rb

@@ -0,0 +1,16 @@
+module FormStalker
+  class Connection
+    attr_reader :config
+
+    def initialize(config_or_options)
+      @config = config_or_options
+
+      @config = Config.new(@config) if @config.is_a?(Hash)
+    end
+
+    def build_url(path)
+      [config.protocol, '://', config.base_uri, '/', path,
+       "?oauth_token=#{config.oauth_token}"].join
+    end
+  end
+end

data/lib/form_stalker/data/base.rb

@@ -0,0 +1,20 @@
+module FormStalker
+  module Data
+    class Base < OpenStruct
+      def self.tap_into(response)
+        return response unless response.ok?
+
+        response.data =
+          if response.data.is_a?(Array)
+            response.data.map { |subset| new(subset) }
+          else
+            new(response.data)
+          end
+
+        response
+      end
+
+      alias attributes marshal_dump
+    end
+  end
+end

data/lib/form_stalker/data/form.rb

@@ -0,0 +1,7 @@
+
+module FormStalker
+  module Data
+    class Form < Base
+    end
+  end
+end

data/lib/form_stalker/data/form_field.rb

@@ -0,0 +1,7 @@
+
+module FormStalker
+  module Data
+    class FormField < Base
+    end
+  end
+end

data/lib/form_stalker/request.rb

@@ -0,0 +1,26 @@
+require 'net/http'
+require 'form_stalker/response'
+
+module FormStalker
+  class Request
+    attr_reader :response, :connection
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def get(path)
+      make_the_call(:get, path)
+    end
+
+    protected ######################## PROTECTED ###############################
+
+    def make_the_call(http_verb, path)
+      uri = URI(connection.build_url(path))
+
+      http_response = Net::HTTP.send("#{http_verb}_response", uri)
+
+      @response = Response.new(http_response)
+    end
+  end
+end