formstack_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2770a835cee7a6e24aed13966673cd37601f5a03
+  data.tar.gz: 0a235785524cf3e6920c7f5cf931c8261589d3e1
+SHA512:
+  metadata.gz: cd4b7017d8bed0726a2761e53eb39b90a663b2c7e88f664a9567a593643275caa3a11a58191449d91bf1b6a06f9bfdba6977a050e1d9d2a554623c384fcdf34a
+  data.tar.gz: 95333c4a7075426f5997165d2644555c682d77476c73f1f54d0d464db8931df2710a8c0eb09942b4c5a7025ff30ad66f190298a7f3d133227aa78c6048917360

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in formstack.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Travis Petticrew
+
+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,123 @@
+[![CircleCI](https://circleci.com/gh/watermarkchurch/formstack.svg?style=svg)](https://circleci.com/gh/watermarkchurch/formstack)
+
+# Formstack Ruby Gem
+
+This is a Ruby client to v2 of the Formstack API. It has a low level
+call-for-call functional style API and a higher level object style API.
+Let's see some examples!
+
+```ruby
+# Fetch all forms at once
+forms = Formstack::Form.all
+
+# Fetch a single form by ID
+form = Formstack::Form.find(123)
+
+# Get collections for items on a form
+form.fields
+form.submissions
+form.confirmation_emails
+form.notification_emails
+form.submissions
+
+# Create a new item from the collection
+form.fields.create(type: "string", label: "New Field") # => <Field...>
+form.submissions.create => <Submission...>
+
+# Update a form
+form.update(active: false)
+
+# Copy a form
+form.copy # => Returns the newly copied form
+
+# Reload a form (useful to convert a list version of an object to a show
+# version--the API returns different object structures for each endpoint)
+form.load
+
+# Delete a form
+form.delete
+```
+
+Each of the individual objects (fields, submissions, etc.) can be
+loaded, updated, or deleted just like a form. There is also a `create`
+class method on each of the underlying classes if you would rather say
+`Formstack::Field.create(form_id, field_attributes)`.
+
+There is also a `Client` class that defines each endpoint as a seperate
+method. It is the low-level API that the above API uses. You can use it
+as follows:
+
+```ruby
+client = Formstack::Client.new
+client.forms
+client.form(form_id)
+client.create_form(form_attributes)
+client.update_form(form_id, form_attributes)
+client.delete_form(form_id)
+client.copy_form(form_id)
+
+client.fields(form_id)
+#...
+```
+
+To see a full list of methods check out the [Client class].
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'formstack_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install formstack_client
+
+## Setup
+
+In order to get rolling, follow the installation instructions above and
+then set the `FORMSTACK_ACCESS_TOKEN` environment variable to a valid
+access token for your account. You're good to go!
+
+If you don't know your access token you can create a new one for your
+account on the [Formstack API Applications] page.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` to run the tests. You can also run `rake pry`
+for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake
+install`. To release a new version, update the version number in
+`version.rb`, and then run `bundle exec rake release`, which will create
+a git tag for the version, push git commits and tags, and push the
+`.gem` file to [rubygems.org](https://rubygems.org).
+
+This project also uses the `dotenv` gem. You can create a `.env` file
+and add your `FORMSTACK_ACCESS_TOKEN` environment variable so that when
+you launch a console with `rake pry` your configuration will already be
+set.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/watermarkchurch/formstack.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Resources
+
+The spec this library was built from: [Formstack v2 API Documentation]
+
+[Formstack v2 API Documentation]: https://developers.formstack.com/v2.0
+[Formstack API Applications]: https://www.formstack.com/admin/apiKey/main
+[Client class]: https://github.com/watermarkchurch/formstack/blob/master/lib/formstack/client.rb

data/Rakefile

@@ -0,0 +1,20 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :environment do
+  require 'dotenv'
+  Dotenv.load
+
+  $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+  require 'formstack'
+end
+
+desc "Launch a pry shell with Formstack library loaded"
+task :pry => :environment do
+  require 'pry'
+  Pry.start
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "formstack"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/rspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/circle.yml

@@ -0,0 +1,6 @@
+machine:
+  ruby:
+    version: 2.2.0
+dependencies:
+  pre:
+    - gem install bundler --version='~>1.10'

data/formstack_client.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'formstack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "formstack_client"
+  spec.version       = Formstack::VERSION
+  spec.authors       = ["Travis Petticrew and the Watermark Development team"]
+  spec.email         = ["travis@petticrew.net"]
+
+  spec.summary       = %q{A client to the Formstack v2 API}
+  spec.description   = %q{A client to the Formstack v2 API}
+  spec.homepage      = "https://github.com/watermarkchurch/formstack"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-mocks", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 2.1"
+end

data/lib/formstack/client.rb

@@ -0,0 +1,139 @@
+require 'forwardable'
+require 'formstack/connection'
+
+module Formstack
+  class Client
+    extend Forwardable
+    attr_reader :connection
+
+    def_delegators :connection, :get, :post, :put, :delete
+
+    def initialize(connection: Connection.new)
+      @connection = connection
+    end
+
+    def forms(args={})
+      get("form", args)
+    end
+
+    def form(form_id)
+      get("form/#{form_id}")
+    end
+
+    def create_form(args={})
+      post("form", args)
+    end
+
+    def update_form(form_id, args={})
+      put("form/#{form_id}", args)
+    end
+
+    def delete_form(form_id)
+      delete("form/#{form_id}")
+    end
+
+    def copy_form(form_id)
+      post("form/#{form_id}/copy")
+    end
+
+    def fields(form_id)
+      get("form/#{form_id}/field")
+    end
+
+    def field(field_id)
+      get("field/#{field_id}")
+    end
+
+    def create_field(form_id, args={})
+      post("form/#{form_id}/field", args)
+    end
+
+    def update_field(field_id, args={})
+      put("field/#{field_id}", args)
+    end
+
+    def delete_field(field_id)
+      delete("field/#{field_id}")
+    end
+
+    def submissions(form_id)
+      get("form/#{form_id}/submission")
+    end
+
+    def submission(submission_id)
+      get("submission/#{submission_id}")
+    end
+
+    def create_submission(form_id, args={})
+      post("form/#{form_id}/submission", args)
+    end
+
+    def update_submission(submission_id, args={})
+      put("submission/#{submission_id}", args)
+    end
+
+    def delete_submission(submission_id)
+      delete("submission/#{submission_id}")
+    end
+
+    def confirmation_emails(form_id)
+      get("form/#{form_id}/confirmation")
+    end
+
+    def confirmation_email(confirmation_id)
+      get("confirmation/#{confirmation_id}")
+    end
+
+    def create_confirmation_email(form_id, args={})
+      post("form/#{form_id}/confirmation", args)
+    end
+
+    def update_confirmation_email(confirmation_id, args={})
+      put("confirmation/#{confirmation_id}", args)
+    end
+
+    def delete_confirmation_email(confirmation_id)
+      delete("confirmation/#{confirmation_id}")
+    end
+
+    def notification_emails(form_id)
+      get("form/#{form_id}/notification")
+    end
+
+    def notification_email(notification_id)
+      get("notification/#{notification_id}")
+    end
+
+    def create_notification_email(form_id, args={})
+      post("form/#{form_id}/notification", args)
+    end
+
+    def update_notification_email(notification_id, args={})
+      put("notification/#{notification_id}", args)
+    end
+
+    def delete_notification_email(notification_id)
+      delete("notification/#{notification_id}")
+    end
+
+    def webhooks(form_id)
+      get("form/#{form_id}/webhook")
+    end
+
+    def webhook(webhook_id)
+      get("webhook/#{webhook_id}")
+    end
+
+    def create_webhook(form_id, args={})
+      post("form/#{form_id}/webhook", args)
+    end
+
+    def update_webhook(webhook_id, args={})
+      put("webhook/#{webhook_id}", args)
+    end
+
+    def delete_webhook(webhook_id)
+      delete("webhook/#{webhook_id}")
+    end
+  end
+end

data/lib/formstack/collection.rb

@@ -0,0 +1,15 @@
+require 'delegate'
+
+module Formstack
+  class Collection < SimpleDelegator
+    def initialize(array, klass:, context: [])
+      @klass = klass
+      @context = context
+      super(array)
+    end
+
+    def create(*args)
+      @klass.create(*@context, *args)
+    end
+  end
+end

data/lib/formstack/connection.rb

@@ -0,0 +1,53 @@
+require 'net/http'
+require 'uri'
+require 'json'
+
+module Formstack
+  class Connection
+    attr_reader :base_uri, :access_token
+
+    BASE_URI = URI('https://www.formstack.com/api/v2/').freeze
+
+    def initialize(base_uri: BASE_URI, access_token: ENV['FORMSTACK_ACCESS_TOKEN'])
+      @base_uri = URI(base_uri)
+      @access_token = access_token
+    end
+
+    def get(uri, args={})
+      request(uri: uri, request_factory: Net::HTTP::Get, args: args)
+    end
+
+    def post(uri, args={})
+      request(uri: uri, request_factory: Net::HTTP::Post, args: args)
+    end
+
+    def put(uri, args={})
+      request(uri: uri, request_factory: Net::HTTP::Put, args: args)
+    end
+
+    def delete(uri, args={})
+      request(uri: uri, request_factory: Net::HTTP::Delete, args: args)
+    end
+
+    private
+
+    def request(uri:, request_factory:, args: {})
+      uri = base_uri + uri
+      response = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        request = request_factory.new uri
+        request["Authorization"] = "Bearer #{access_token}"
+        if !args.empty?
+          request["Content-Type"] = "application/json"
+          request.body = args.to_json
+        end
+        http.request request
+      end
+
+      parse_response(response)
+    end
+
+    def parse_response(response)
+      JSON.parse(response.body)
+    end
+  end
+end

data/lib/formstack/form.rb

@@ -0,0 +1,99 @@
+require 'formstack/model'
+
+module Formstack
+  class Form
+    include Model
+
+    def copy
+      new_from_response client.copy_form self[:id]
+    end
+
+    def fields
+      @fields ||= if self[:fields]
+                    self[:fields].map { |f| Field.new(f) }
+                  else
+                    Field.all(self[:id])
+                  end
+    end
+
+    def submissions
+      @submissions ||= Submission.all(self[:id])
+    end
+
+    def confirmation_emails
+      @confirmation_emails ||= ConfirmationEmail.all(self[:id])
+    end
+
+    def notification_emails
+      @notification_emails ||= NotificationEmail.all(self[:id])
+    end
+
+    def webhooks
+      @webhooks ||= Webhook.all(self[:id])
+    end
+
+    def self.client_method
+      :form
+    end
+
+    def self.response_nesting
+      "forms"
+    end
+  end
+
+  class Field
+    include Model
+
+    def self.client_method
+      :field
+    end
+  end
+
+  class Submission
+    include Model
+
+    def self.client_method
+      :submission
+    end
+
+    def self.response_nesting
+      "submissions"
+    end
+  end
+
+  class ConfirmationEmail
+    include Model
+
+    def self.client_method
+      :confirmation_email
+    end
+
+    def self.response_nesting
+      "confirmations"
+    end
+  end
+
+  class NotificationEmail
+    include Model
+
+    def self.client_method
+      :notification_email
+    end
+
+    def self.response_nesting
+      "notifications"
+    end
+  end
+
+  class Webhook
+    include Model
+
+    def self.client_method
+      :webhook
+    end
+
+    def self.response_nesting
+      "webhooks"
+    end
+  end
+end

data/lib/formstack/model.rb

@@ -0,0 +1,82 @@
+require 'forwardable'
+require 'formstack/collection'
+
+module Formstack
+  module Model
+
+    def self.included(base)
+      base.send :attr_reader, :attributes
+      base.extend ClassMethods
+      base.extend Forwardable
+      base.def_delegators :'self.class', :client, :client_method, :new_from_response
+    end
+
+    def initialize(attributes={})
+      @attributes = attributes
+    end
+
+    def [](key)
+      attributes[key.to_s]
+    end
+
+    def load
+      @attributes = client.public_send(client_method, self[:id])
+    end
+
+    def update(new_attributes={})
+      attributes.merge!(stringify_hash_keys(new_attributes))
+      client.public_send("update_#{client_method}", self[:id], attributes)
+    end
+
+    def delete
+      client.public_send("delete_#{client_method}", self[:id])
+    end
+
+    private
+
+    def stringify_hash_keys(hash)
+      hash.each_with_object({}) { |(k, v), h| h[k.to_s] = v }
+    end
+
+    module ClassMethods
+
+      def all(*args)
+        new_from_response client.public_send("#{client_method}s", *args), context: args
+      end
+
+      def find(*args)
+        new_from_response client.public_send(client_method, *args)
+      end
+
+      def create(*args)
+        new_from_response(client.public_send("create_#{client_method}", *args)).tap do |obj|
+          obj.load if obj[:id]
+        end
+      end
+
+      def new_from_response(response, context: [])
+        if response.respond_to?(:has_key?) && response.has_key?(response_nesting)
+          response = response[response_nesting]
+        end
+        if response.is_a?(Array)
+          Collection.new(response.map { |item| new item }, klass: self, context: context)
+        else
+          new response
+        end
+      end
+
+      def client
+        Formstack.client
+      end
+
+      def client_method
+        raise NotImplementedError
+      end
+
+      def response_nesting
+        ""
+      end
+
+    end
+  end
+end

data/lib/formstack/version.rb

@@ -0,0 +1,3 @@
+module Formstack
+  VERSION = "0.1.0"
+end

data/lib/formstack.rb

@@ -0,0 +1,11 @@
+require 'formstack/version'
+require 'formstack/form'
+require 'formstack/client'
+
+module Formstack
+
+  def self.client
+    @client ||= Client.new
+  end
+
+end

data/lib/formstack_client.rb

@@ -0,0 +1 @@
+require 'formstack'

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: formstack_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Travis Petticrew and the Watermark Development team
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: A client to the Formstack v2 API
+email:
+- travis@petticrew.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
+- circle.yml
+- formstack_client.gemspec
+- lib/formstack.rb
+- lib/formstack/client.rb
+- lib/formstack/collection.rb
+- lib/formstack/connection.rb
+- lib/formstack/form.rb
+- lib/formstack/model.rb
+- lib/formstack/version.rb
+- lib/formstack_client.rb
+homepage: https://github.com/watermarkchurch/formstack
+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.4.2
+signing_key: 
+specification_version: 4
+summary: A client to the Formstack v2 API
+test_files: []