form_stalker 1.0.0

data/spec/fixtures/vcr_cassettes/invalid_oauth_token.yml

@@ -0,0 +1,52 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://www.formstack.com/api/v2/form/1.json?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: 401
+      message: Unauthorized
+    headers:
+      Content-Type:
+      - text/html; charset=UTF-8
+      Date:
+      - Fri, 29 Jul 2016 14:10:09 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=j6qsj5ic07b4mc6hjl5ajrgs20; path=/api/; secure; HttpOnly
+      - rgisanonymous=false; expires=Sun, 28-Aug-2016 14:10:09 GMT; Max-Age=2592000
+      - rgisanonymous=true; expires=Sun, 28-Aug-2016 14:10:09 GMT; Max-Age=2592000
+      - rguserid=ab9075e5-0ad0-4463-966b-38209e9005dd; expires=Sun, 28-Aug-2016 14:10:09
+        GMT; Max-Age=2592000
+      - rguuid=true; expires=Sun, 28-Aug-2016 14:10:09 GMT; Max-Age=2592000
+      Www-Authenticate:
+      - Bearer realm='Service', error='invalid_token'
+      X-Robots-Tag:
+      - noindex, nofollow
+      Content-Length:
+      - '0'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Fri, 29 Jul 2016 14:10:09 GMT
+recorded_with: VCR 3.0.3

data/spec/form_stalker/client_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+describe FormStalker::Client do
+  describe '.new' do
+    context 'when sending configuration options' do
+      let(:client) { described_class.new(oauth_token: '123') }
+
+      it 'client.config.oauth_token should reflect that initialization' do
+        expect(client.config.oauth_token).to eq '123'
+      end
+    end
+
+    context 'when sending a Config instance' do
+      let(:client) do
+        described_class.new(FormStalker::Config.new(oauth_token: '1234'))
+      end
+
+      it 'client.config.oauth_token should reflect that initialization' do
+        expect(client.config.oauth_token).to eq '1234'
+      end
+    end
+  end
+
+  describe '.form' do
+    before(:all) do
+      @client ||= described_class.new(oauth_token: valid_oauth_token)
+    end
+
+    context 'when sending a valid id' do
+      before do
+        VCR.use_cassette('form_valid_id') do
+          @response = @client.form('2178204')
+        end
+      end
+
+      it '@response should have data' do
+        expect(@response.data).to be_an_instance_of FormStalker::Data::Form
+      end
+
+      it '@response should NOT have an error' do
+        expect(@response.error).to be_nil
+      end
+    end
+
+    context 'when sending an invalid id' do
+      before do
+        VCR.use_cassette('form_invalid_id') do
+          @response = @client.form(-1)
+        end
+      end
+
+      it '@response should have an error' do
+        expect(@response.error).to eq 'The form was not found'
+      end
+    end
+  end
+
+  describe '.form_fields' do
+    before(:all) do
+      @client ||= described_class.new(oauth_token: valid_oauth_token)
+    end
+
+    context 'when sending a valid id' do
+      before do
+        VCR.use_cassette('form_fields_valid_id') do
+          @response = @client.form_fields('2178204')
+        end
+      end
+
+      it '@response should have data' do
+        expect(@response.data[0]).to \
+          be_an_instance_of FormStalker::Data::FormField
+      end
+
+      it '@response should NOT have an error' do
+        expect(@response.error).to be_nil
+      end
+    end
+
+    context 'when sending an invalid id' do
+      before do
+        VCR.use_cassette('form_fields_invalid_id') do
+          @response = @client.form_fields(-1)
+        end
+      end
+
+      it '@response should have an error' do
+        expect(@response.error).to eq 'A valid form id was not supplied'
+      end
+    end
+  end
+end

data/spec/form_stalker/form_stalker_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe FormStalker do
+  describe '.configure' do
+    context 'when setting the "config.oauth_token"' do
+      before do
+        FormStalker.configure { |config| config.oauth_token = '123' }
+      end
+      after do
+        FormStalker.configure { |config| config.oauth_token = nil }
+      end
+
+      it 'FormStalker.config.oauth_token should reflect that change' do
+        expect(FormStalker.config.oauth_token).to eq '123'
+      end
+
+      context 'when setting the "config.oauth_token" yet again' do
+        before do
+          FormStalker.configure { |config| config.oauth_token = '1234' }
+        end
+        after do
+          FormStalker.configure { |config| config.oauth_token = nil }
+        end
+
+        it 'FormStalker.config.oauth_token should reflect that change' do
+          expect(FormStalker.config.oauth_token).to eq '1234'
+        end
+      end
+    end
+  end
+
+  describe '.config' do
+    context 'when setting the #oauth_token' do
+      before { FormStalker.config.oauth_token = '123' }
+      after { FormStalker.config.oauth_token = nil }
+
+      it 'FormStalker.client.config.oauth_token should reflect that change' do
+        expect(FormStalker.client.config.oauth_token).to eq '123'
+      end
+    end
+  end
+
+  describe '.client' do
+    context 'when setting the #config.oauth_token' do
+      before { FormStalker.client.config.oauth_token = '123' }
+      after { FormStalker.client.config.oauth_token = nil }
+
+      it 'FormStalker.config.oauth_token should reflect that change' do
+        expect(FormStalker.config.oauth_token).to eq '123'
+      end
+    end
+  end
+end

data/spec/form_stalker/request_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe FormStalker::Request do
+  describe '.get' do
+    context 'when using an invalid oauth_token' do
+      let(:bad_connection) { FormStalker::Connection.new({}) }
+      let(:request) { described_class.new(bad_connection) }
+
+      before do
+        VCR.use_cassette('invalid_oauth_token') do
+          @response = request.get('form/1.json')
+        end
+      end
+
+      it '@response should have an error' do
+        expect(@response.error).to eq \
+          'Either your oauth token is invalid ' \
+          "or you don't have access to this resource"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+require 'codeclimate-test-reporter'
+
+CodeClimate::TestReporter.start
+
+require 'simplecov'
+
+SimpleCov.start do
+  root('lib/')
+  coverage_dir('../tmp/coverage/')
+end
+
+$LOAD_PATH << File.expand_path('../', File.dirname(__FILE__))
+
+require 'pry'
+require 'vcr'
+require 'form_stalker'
+require 'webmock/rspec'
+
+Dir['./spec/**/support/**/*.rb'].each do |file|
+  require file
+end
+
+VCR.configure do |config|
+  config.hook_into :webmock
+  config.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+end
+
+RSpec.configure do |config|
+  config.include Helpers
+
+  config.run_all_when_everything_filtered = true
+
+  config.order = 'random'
+end

data/spec/support/helpers.rb

@@ -0,0 +1,9 @@
+module Helpers
+  def valid_oauth_token
+    ENV['FORMSTACK_OAUTH_TOKEN'] || 'valid_oauth_token'
+  end
+
+  def invalid_oauth_token
+    'invalid_oauth_token'
+  end
+end

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: form_stalker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- StreetBees Dev Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 11.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 11.2.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.37.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.37.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.8
+description: Ruby FormStack API gem that can extract conditional logic
+email: dev@streetbees.com
+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
+- lib/form_stalker/connection.rb
+- lib/form_stalker/data/base.rb
+- lib/form_stalker/data/form.rb
+- lib/form_stalker/data/form_field.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
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+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