typeform-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5b7fe3729f6d220c700c7d3e84eb9c2891d8e20a
+  data.tar.gz: 79a8fb1c2b21a215584a933bd3cca6c8d9deb168
+SHA512:
+  metadata.gz: 534646c1ae913ae7498458e02ca6474645aca1b4160058e0f87e470274b0a1b7a661f9069919f74f40d3ea02a4eb5331f34cf8fb2f3c063fe4c7ba7f8e5246f7
+  data.tar.gz: 39be9012b42a4b0e5dacd918e9ad6110730f0b09741c48edb6ac1d76728f5a194a3560838fec7263575d96f3df9e48ced1a7b69a96b8dba292ae659880658931

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.5
+before_install: gem install bundler -v 1.10.5

data/Gemfile

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

data/README.md

@@ -0,0 +1,75 @@
+# Typeform
+
+[Typeform I/O](http://typeform.io/) client for Ruby.
+
+## Usage
+
+### Initialize Client
+
+```ruby
+typeform_api_key = ENV['TYPEFORM_API_KEY']
+client = Typeform::Client.new(typeform_api_key)
+```
+
+### Get API information
+
+If you want to make sure your authentication and connection to Typeform I/O works, call `Typeform::Client#information`.
+
+```ruby
+client.information
+```
+
+The response contains information about the API. It is useful for testing or making sure you have access.
+
+```json
+{
+  "name": "Typeform I/O Build API",
+  "description": "Build API for creating forms awesomely",
+  "version": "v0.4",
+  "documentation": "https://docs.typeform.io/",
+  "support": "support@typeform.io",
+  "time": "2015-05-26 17:55:23 +0000"
+}
+```
+
+### Create a typeform
+
+Call `Typeform::Client#create_form_from_file` to create a new typeform.
+
+```ruby
+file = File.open("example/example.json")
+client.create_form_from_file(file)
+```
+
+You have parameters to set the title, webhook URL and of course, the fields. The form endpoint will also return you a hash of URLs that you can use to distribute your typeform or delete it.
+
+```json
+{
+  "id": "keEwsGeuC",
+  "title": "My first typeform",
+  "fields": [
+    {
+      "type": "short_text",
+      "question": "What is your name?"
+    }
+  ],
+  "links": [
+    {
+      "rel": "self",
+      "href": "https://api.typeform.io/latest/forms/keEwsGeuC"
+    },
+    {
+      "rel": "form_render",
+      "href": "https://forms.typeform.io/to/keEwsGeuC"
+    }
+  ]
+}
+```
+
+### Show typeform
+
+You can get the structure back of a typeform. It's useful if you want to allow your users to edit their typeform or you just want to get the URL of the typeform by leveraging the links.rel['form_render'].href link.
+
+```ruby
+client.show_form(form_id)
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "typeform"
+
+# 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/setup

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

data/example/example.json

@@ -0,0 +1,10 @@
+{
+  "title": "title",
+  "fields": [
+    {
+      "type": "short_text",
+      "question": "short_text"
+    }
+  ],
+  "webhook_submit_url": "https://webhook_submit_url.com"
+}

data/example/example.rb

@@ -0,0 +1,30 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require "typeform"
+require "pry"
+
+typeform_api_key = ENV['TYPEFORM_API_KEY']
+client = Typeform::Client.new(typeform_api_key)
+
+# information
+pp client.information
+
+# show form
+pp client.show_form("tPvxO8qyP6gIzg")
+
+# create_form_from_json
+# field = Typeform::Field.new
+# field.type = "multiple_choice"
+# field.question = "What is your name?"
+# field.description = "description"
+# field.required = false
+# field.choices = [{label: "A"}]
+# form = Typeform::Form.new
+# form.title = "title"
+# form.fields = [field]
+# form.design_id = "design_id"
+# form.webhook_submit_url = "https://webhook_submit_url.com"
+# pp client.create_form_from_json(form.as_json).body
+
+# create_form_from_file
+# file = File.open("example/example.json")
+# pp client.create_form_from_file(file)

data/example/index.html

@@ -0,0 +1,30 @@
+<!--Upload this file to your server-->
+
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+  <!--Add the title of your typeform below-->
+  <title>All fields</title>
+
+  <!--CSS styles that ensure your typeform takes up all the available screen space (DO NOT EDIT!)-->
+<style type="text/css">
+    html{
+      margin: 0;
+      height: 100%;
+      overflow: hidden;
+    }
+    iframe{
+      position: absolute;
+      left:0;
+      right:0;
+      bottom:0;
+      top:0;
+      border:0;
+    }
+  </style>
+</head>
+<body>
+  <iframe id="typeform-full" width="100%" height="100%" frameborder="0" src="https://forms.typeform.io/to/tPvxO8qyP6gIzg"></iframe>
+  <script type="text/javascript" src="https://s3-eu-west-1.amazonaws.com/share.typeform.com/embed.js"></script>
+</body>
+</html>

data/lib/typeform.rb

@@ -0,0 +1,7 @@
+require "typeform/version"
+require "typeform/client"
+
+module Typeform
+  class << self
+  end
+end

data/lib/typeform/client.rb

@@ -0,0 +1,31 @@
+require "typeform/version"
+require "typeform/connection"
+require "typeform/form"
+require "typeform/field"
+require "faraday"
+require "faraday_middleware"
+require "json"
+
+module Typeform
+  class Client
+    def initialize(api_key)
+      @conn = Connection.new(api_key)
+    end
+
+    def information
+      @conn.get "/"
+    end
+
+    def show_form(id)
+      @conn.get "/forms/#{id}"
+    end
+
+    def create_form_from_json(json)
+      @conn.post "/forms", json
+    end
+
+    def create_form_from_file(file)
+      create_form_from_json(JSON.parse(file.read))
+    end
+  end
+end

data/lib/typeform/connection.rb

@@ -0,0 +1,36 @@
+module Typeform
+  class Connection
+    @@base_uri = "https://api.typeform.io"
+
+    def initialize(api_key)
+      @api_key = api_key
+      @conn = Faraday.new(url: @@base_uri) do |faraday|
+        faraday.request :json
+        faraday.response :logger
+        faraday.adapter  Faraday.default_adapter
+        faraday.use FaradayMiddleware::ParseJson, :content_type => /\bjson$/
+      end
+    end
+
+    def set_base_headers(request)
+      request.headers["X-API-TOKEN"] = @api_key
+      request.headers["Content-Type"] = "application/json; charset=utf-8"
+      request.headers["Accept-Encoding"] = "gzip, deflate"
+    end
+
+    def get(path)
+      @conn.get do |request|
+        set_base_headers(request)
+        request.url "/v0.3#{path}"
+      end
+    end
+
+    def post(path, body)
+      @conn.post do |request|
+        set_base_headers(request)
+        request.url "/v0.3#{path}"
+        request.body = body
+      end
+    end
+  end
+end

data/lib/typeform/field.rb

@@ -0,0 +1,47 @@
+module Typeform
+  class Field
+    include JSON::Encodable
+
+    property :type, type: String
+    property :question, type: String
+    property :description, type: String
+    property :required
+    property :choices
+
+    attr_accessor :type, :question, :description, :required, :choices
+
+    # This value could take...
+    # short_text:      The ShortText Field is the typical, standard text input that you would expect.
+    # long_text:       You would use a LongTextField if you want your user to leave answers with freely written text, longer than one line.
+    # multiple_choice: The MultipleChoiceField is used for (guess), displaying multiple choice text based answers.
+    # picture_choice:  The PictureChoiceField is much like the MultipleChoiceField but you can also use images as choices and make your typeforms beautiful and engaging.
+    # statement:       The statement field is not a question, it's just a opportunity to make conversation in your typeform.
+    # dropdown:        The DropdownField is a cross between select element auto-completion. Use it when you need your respondent to choose from a long list of choices.
+    # yes_no:          The YesNo Field is a field that allows the user to answer only yes or no to a question
+    # number:          The NumberField is like a ShortTextField that only allows numbers.
+    # raiting:         RatingField is the best field to use if you want your users to rate anything in a visual way.
+    # opinion_scale:   OpinionScale field is the perfect field if you want to do a NPS style evaluation or simply ask your respondents to review a product of yours, with a scale you can set yourself.
+    # email:           You want your users to give you their precious email? Then the EmailField is just the right field for you!
+    # website:         The WebsiteField is the field you would use if you want to collect a URL from your respondent. It will validate that the answer contains a URL.
+    # legal:           The LegalField is very similar to the YesNoField, with some minor UI differences including a smaller body text.
+    def type
+      @type
+    end
+
+    def question
+      @question
+    end
+
+    def description
+      @description
+    end
+
+    def required
+      @required
+    end
+
+    def choices
+      @choices
+    end
+  end
+end

data/lib/typeform/form.rb

@@ -0,0 +1,30 @@
+require "json-encodable"
+
+module Typeform
+  class Form
+    include JSON::Encodable
+
+    property :title, type: String
+    property :fields
+    property :design_id, type: Integer
+    property :webhook_submit_url, type: String
+
+    attr_accessor :title, :fields, :design_id, :webhook_submit_url
+
+    def title
+      @title
+    end
+
+    def fields
+      @fields
+    end
+
+    def design_id
+      @design_id
+    end
+
+    def webhook_submit_url
+      @webhook_submit_url
+    end
+  end
+end

data/lib/typeform/version.rb

@@ -0,0 +1,3 @@
+module Typeform
+  VERSION = "0.0.1"
+end

data/typeform.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'typeform/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "typeform-ruby"
+  spec.version       = Typeform::VERSION
+  spec.authors       = ["Kentaro Takiguchi"]
+  spec.email         = ["kentaro-takiguchi@cookpad.com"]
+
+  spec.summary       = "Typeform I/O client for Ruby"
+  spec.description   = "Simple wrapper for the Typeform I/O"
+  spec.homepage      = "https://github.com/rejasupotaro/typeform-ruby"
+
+  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.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rspec-json_matcher"
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "json"
+  spec.add_dependency "json-encodable"
+end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: typeform-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kentaro Takiguchi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '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: pry-byebug
+  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: rspec-json_matcher
+  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: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json-encodable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple wrapper for the Typeform I/O
+email:
+- kentaro-takiguchi@cookpad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example/example.json
+- example/example.rb
+- example/index.html
+- lib/typeform.rb
+- lib/typeform/client.rb
+- lib/typeform/connection.rb
+- lib/typeform/field.rb
+- lib/typeform/form.rb
+- lib/typeform/version.rb
+- typeform.gemspec
+homepage: https://github.com/rejasupotaro/typeform-ruby
+licenses: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Typeform I/O client for Ruby
+test_files: []
+has_rdoc: