ask_awesomely 0.1.2

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "lib" << "spec"
+  t.test_files = FileList["spec/**/*_spec.rb"]
+  t.verbose = true
+end
+
+task default: :test
+

data/ask_awesomely.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ask_awesomely/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ask_awesomely"
+  spec.version       = AskAwesomely::VERSION
+  spec.authors       = ["Lee Machin"]
+  spec.email         = ["me@mrl.ee"]
+
+  spec.summary       = "Create Typeforms on the fly, the Typeform way."
+  spec.homepage      = "https://github.com/leemachin/ask_awesomely"
+
+  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_dependency "aws-sdk", "~> 2.0"
+  spec.add_dependency "typhoeus", "~> 0.8"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.8"
+  spec.add_development_dependency "vcr", "~> 2.9"
+end

data/bin/console

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

@@ -0,0 +1,31 @@
+require "ask_awesomely/version"
+require "ask_awesomely/configuration"
+require "ask_awesomely/dsl"
+require "ask_awesomely/field"
+require "ask_awesomely/choice"
+require "ask_awesomely/picture"
+require "ask_awesomely/s3"
+require "ask_awesomely/api_client"
+require "ask_awesomely/typeform"
+require "ask_awesomely/embeddable"
+
+require "erb"
+require "json"
+require "aws-sdk"
+require "typhoeus"
+
+module AskAwesomely
+
+  ConfigurationError = Class.new(ArgumentError)
+  FieldTypeError = Class.new(ArgumentError)
+  EmbedTypeError = Class.new(ArgumentError)
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure(&block)
+    block.call(self.configuration)
+  end
+
+end

data/lib/ask_awesomely/api_client.rb

@@ -0,0 +1,56 @@
+module AskAwesomely
+  class ApiClient
+
+    USER_AGENT = "leemachin/ask_awesomely; (v#{AskAwesomely::VERSION})"
+    BASE_URL = "https://api.typeform.io/latest"
+    ENDPOINTS = {
+      root: "/",
+      create_typeform: "/forms"
+    }
+    
+    def initialize
+      Typhoeus::Config.user_agent = USER_AGENT
+    end
+
+    def get_info
+      response = request.get(
+        url_for(:root),
+        headers: headers
+      )
+
+      JSON.parse(response.body)
+    end
+    
+    def submit_typeform(typeform)
+      response = request.post(
+        url_for(:create_typeform),
+        headers: headers,
+        body: typeform.to_json
+      )
+
+      typeform.tap do |tf|
+        body = JSON.parse(response.body)
+        tf.update_with_api_response(body)
+      end
+    end
+
+    private
+
+    def request
+      Typhoeus::Request
+    end
+
+    def url_for(endpoint)
+      BASE_URL + ENDPOINTS[endpoint]
+    end
+
+    def headers(others = {})
+      others.merge({
+        "X-API-TOKEN" => AskAwesomely.configuration.typeform_api_key,
+        "Accept" => "application/json",
+        "Content-Type" => "application/json"
+      })
+    end
+
+  end
+end

data/lib/ask_awesomely/choice.rb

@@ -0,0 +1,10 @@
+module AskAwesomely
+  class Choice
+
+    def initialize(label:, picture: nil)
+      @label = label
+      @picture = picture && Picture.new(picture)
+    end
+    
+  end
+end

data/lib/ask_awesomely/configuration.rb

@@ -0,0 +1,30 @@
+module AskAwesomely
+  class Configuration
+
+    DEFAULT_AWS_BUCKET = "typeform_io_images"
+    DEFAULT_AWS_REGION = "us-east-1"
+
+    attr_accessor :typeform_api_key,
+                  :aws_access_key_id,
+                  :aws_access_key_secret,
+                  :aws_region,
+                  :aws_bucket
+    
+    def typeform_api_key
+      unless @typeform_api_key
+        raise ConfigurationError, "Typeform I/O API Key must be set before use, get one from <https://typeform.io>."
+      end
+      
+      @typeform_api_key
+    end
+
+    def aws_region
+      @aws_region || DEFAULT_AWS_REGION
+    end
+
+    def aws_bucket
+      @aws_bucket || DEFAULT_AWS_BUCKET
+    end
+
+  end
+end

data/lib/ask_awesomely/dsl.rb

@@ -0,0 +1,50 @@
+module AskAwesomely
+  module DSL
+
+    def self.included(recv)
+      recv.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def _api_client
+        @api_client = ApiClient.new
+      end
+
+      def _state
+        @state ||= OpenStruct.new(
+          title: "",
+          fields: []
+        )
+      end
+
+      def build(context = nil)
+        structure = new(context)
+        typeform = Typeform.new(structure)
+        _api_client.submit_typeform(typeform)
+      end
+
+      def title(title)
+        _state.title = title
+      end
+
+      def tags(*tags)
+        _state.tags = tags
+      end
+
+      def field(type, &block)
+        _state.fields << Field::Field.of_type(type, &block)
+      end
+    end
+
+    attr_reader :context, :json
+
+    private def initialize(context = nil)
+      @context = context
+    end
+
+    def to_json
+      self.class._state.to_h.to_json
+    end
+
+  end
+end

data/lib/ask_awesomely/embeddable.rb

@@ -0,0 +1,30 @@
+module AskAwesomely
+  class Embeddable
+
+    EMBED_TYPES = %i(
+      modal
+      drawer
+      widget
+      fullscreen
+    )
+
+    def initialize(embed_type)
+      unless EMBED_TYPES.include?(embed_type)
+        raise AskAwesomely::EmbedTypeError, "embed type must be one of: #{EMBED_TYPES.join(', ')}"
+      end
+
+      @embed_type = embed_type
+    end
+
+    def render(typeform)
+      ERB.new(template, 0, '>').result(typeform.get_binding)
+    end
+
+    private 
+
+    def template
+      Pathname.new(__dir__).join("embeds", "#{@embed_type}.erb").read
+    end
+
+  end
+end

data/lib/ask_awesomely/embeds/drawer.erb

@@ -0,0 +1,3 @@
+<a class="typeform-share link" href="<%= public_url %>" data-mode="2" target="_blank">Launch me!</a>
+
+<script>(function(){var qs,js,q,s,d=document,gi=d.getElementById,ce=d.createElement,gt=d.getElementsByTagName,id='typef_orm',b='https://s3-eu-west-1.amazonaws.com/share.typeform.com/';if(!gi.call(d,id)){js=ce.call(d,'script');js.id=id;js.src=b+'share.js';q=gt.call(d,'script')[0];q.parentNode.insertBefore(js,q)}})()</script>

data/lib/ask_awesomely/embeds/fullscreen.erb

@@ -0,0 +1,28 @@
+<!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><%= title %></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="<%= public_url %>"></iframe>
+  <script type="text/javascript" src="https://s3-eu-west-1.amazonaws.com/share.typeform.com/embed.js"></script>
+</body>
+</html>

data/lib/ask_awesomely/embeds/modal.erb

@@ -0,0 +1,3 @@
+<a class="typeform-share link" href="<%= public_url %>" data-mode="1" target="_blank">Launch me!</a>
+
+<script>(function(){var qs,js,q,s,d=document,gi=d.getElementById,ce=d.createElement,gt=d.getElementsByTagName,id='typef_orm',b='https://s3-eu-west-1.amazonaws.com/share.typeform.com/';if(!gi.call(d,id)){js=ce.call(d,'script');js.id=id;js.src=b+'share.js';q=gt.call(d,'script')[0];q.parentNode.insertBefore(js,q)}})()</script>

data/lib/ask_awesomely/embeds/widget.erb

@@ -0,0 +1,3 @@
+<div class="typeform-widget" data-url="<%= public_url %>" data-text="<%= title %>" style="width:100%;height:500px;"></div>
+
+<script>(function(){var qs,js,q,s,d=document,gi=d.getElementById,ce=d.createElement,gt=d.getElementsByTagName,id='typef_orm',b='https://s3-eu-west-1.amazonaws.com/share.typeform.com/';if(!gi.call(d,id)){js=ce.call(d,'script');js.id=id;js.src=b+'widget.js';q=gt.call(d,'script')[0];q.parentNode.insertBefore(js,q)}})()</script>

data/lib/ask_awesomely/field.rb

@@ -0,0 +1,18 @@
+module AskAwesomely
+  module Field
+    require "ask_awesomely/field/field"
+    require "ask_awesomely/field/short_text"
+    require "ask_awesomely/field/long_text"
+    require "ask_awesomely/field/multiple_choice"
+    require "ask_awesomely/field/picture_choice"
+    require "ask_awesomely/field/statement"
+    require "ask_awesomely/field/number"
+    require "ask_awesomely/field/dropdown"
+    require "ask_awesomely/field/yes_no"
+    require "ask_awesomely/field/rating"
+    require "ask_awesomely/field/opinion_scale"
+    require "ask_awesomely/field/email"
+    require "ask_awesomely/field/website"
+    require "ask_awesomely/field/legal"
+  end
+end

data/lib/ask_awesomely/field/dropdown.rb

@@ -0,0 +1,18 @@
+module AskAwesomely
+  class Field::Dropdown < Field::Field
+
+    def initialize(*)
+      super
+      @state.choices = []
+    end
+
+    def choice(label)
+      @state.choices << Choice.new(label: label)
+    end
+
+    def in_alphabetical_order
+      @state.alphabetical_order = true
+    end
+    
+  end
+end

data/lib/ask_awesomely/field/email.rb

@@ -0,0 +1,5 @@
+module AskAwesomely
+  class Field::Email < Field::Field
+
+  end
+end

data/lib/ask_awesomely/field/field.rb

@@ -0,0 +1,68 @@
+module AskAwesomely
+  class Field::Field
+
+    VALID_FIELD_TYPES = %i(
+      short_text 
+      long_text 
+      multiple_choice 
+      picture_choice 
+      statement
+      dropdown
+      yes_no
+      number
+      rating
+      opinion_scale
+      email
+      website
+      legal
+    ).freeze
+
+    attr_reader :state
+
+    # todo: make this easier to maintain
+    def self.of_type(type, &block)
+      field = case type
+      when :short_text then Field::ShortText
+      when :long_text then Field::LongText
+      when :multiple_choice then Field::MultipleChoice
+      when :picture_choice then Field::PictureChoice
+      when :statement then Field::Statement
+      when :dropdown then Field::Dropdown
+      when :yes_no then Field::YesNo
+      when :number then Field::Number
+      when :rating then Field::Rating
+      when :opinion_scale then Field::OpinionScale
+      when :email then Field::Email
+      when :website then Field::Website
+      when :legal then Field::Legal
+      else
+        raise FieldTypeError, "This type of field does not exist, please use one of: #{VALID_FIELD_TYPES.join(", ")}"
+      end
+
+      field.new(type, &block)
+    end
+    
+    # Allow init with properties common to *all* fields
+    def initialize(type, &block)
+      @state = OpenStruct.new(type: type)
+
+      self.instance_eval(&block) if block_given?
+    end
+
+    def ask(question)
+      @state.question = question
+    end
+    
+    def required
+      @state.required = true
+    end
+
+    def tags(*tags)
+      @state.tags = tags
+    end
+    
+    def to_json(*args)
+      @state.to_h.to_json(*args)
+    end
+  end
+end