ask_awesomely 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70509a7f4e01e364e2e6177430566f5853fb4bb9
-  data.tar.gz: 5348d34668d7a5ad781707d297ad08c7579f245d
+  metadata.gz: 7d1822232d0b2c24ecdc6cef57fee6af17ba2f64
+  data.tar.gz: 31dba1d91b42808d5b5162ba725abb5f9c208d90
 SHA512:
-  metadata.gz: 2ba0944f97f24d5d291704e381e00f6539b85d5d1056e8cd13d1cca2da9d3fbb22d59a29ee9c5c4c14c9fb3fd70cb882781ebfc8cf6ec9ec46ad03af423ed928
-  data.tar.gz: 5016b441a5fc79fdd3dbff2682e7c6a44915798c54ea8a910530633783cdff1a856b69ccdc533b86c3ac39facb3c789a64dfd59835933e0a88ac3166f2c4de2b
+  metadata.gz: 0f83e055124bbe75c7a4e1417773a1bc1ea95c4d399563655e089fa81881932499964923c7119181a23795b96d9040e5506063ce5621d1a3e4ba9eb2d6970e88
+  data.tar.gz: d3a9def670b3ad1011948c96d9ec3e32298ac968056a7422074dbabf004131cb4262b3648cda428c596746e47028f63d3482109e98aaf714a848ddbb7e49d5c2

data/README.md

@@ -13,6 +13,7 @@ Build Typeforms awesomely. In Ruby.
 - [Usage](#usage)
   - [Authentication](#authentication)
   - [If you're using images](#if-youre-using-images)
+  - [Logging](#logging)
   - [Basic example](#basic-example)
 - [Available fields and options](#available-fields-and-options)
   - [Statement](#statement)
@@ -37,6 +38,7 @@ Build Typeforms awesomely. In Ruby.
     - [Widget](#widget)
     - [Drawer](#drawer)
     - [Fullscreen](#fullscreen)
+- [Getting Results](#getting-results)
 - [Development](#development)
 - [Feedback and Contributions](#feedback-and-contributions)
 
@@ -83,6 +85,9 @@ AskAwesomely.configure do |config|
 end
 ```
 
+If you don't already have a key, [sign up for one here](https://io1.typeform.com/to/HMLOBl?v=1).
+
+
 Your API Keys are **super secret** so don't commit them in your code. Use `ENV` or
 something like [dotenv](https://github.com/bkeepers/dotenv) so you can keep the credentials out of the repository. This stops bad people from stealing the key and hijacking your Typeform I/O account.
 
@@ -105,6 +110,16 @@ end
 
 As before, don't commit these keys to your repo unless you want [bad things to happen](http://vertis.io/2013/12/16/unauthorised-litecoin-mining.html). Check up on the [AWS Best Practices](http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html) if you want to know more.
 
+### Logging
+
+`AskAwesomely` might warn you if you miss something out, just to make sure. By default this will go straight to `STDOUT`, but you can tell it to use your own logging:
+
+```ruby
+AskAwesomely.configure do |config|
+  config.logger = your_new_logger
+end
+```
+
 ### Basic example
 
 You will want to create a class that represents a specific form to be built:
@@ -351,7 +366,6 @@ field :legal do
 end
 ```
 
-
 ## Passing Context
 
 Building a form full of hard-coded data is all well and good, but it doesn't offer much benefit over using a web interface. What if you want to build personalised forms based on, say, an `ActiveRecord` model?
@@ -410,7 +424,7 @@ end
 
 ### Embedding
 
-You can also embed a form straight away if you prefer. `AskAwesomely` generates the correct embed code for you, with the correct URL and Typeform title. The style can be customised with CSS but some aspects of the embed itself are not currently customisable (e.g. changing button text and widget size).
+You can also embed a form straight away if you prefer. `AskAwesomely` generates the correct embed code for you, with the correct URL and Typeform title. The style can be customised with CSS, and you can also tweak some of the output.
 
 To see what each embedding option looks like, check out the [`Embedding Modes`](http://docs.typeform.io/docs/embedding-introduction) documentation at Typeform I/O. It has pictures and everything.
 
@@ -421,7 +435,7 @@ Assuming you have built a Typeform as in the other examples, rendering the embed
 Pops up over the page content and fills most of the screen.
 
 ```ruby
-typeform.embed_as(:modal)
+typeform.embed_as(:modal, button_text: "Launch me!")
 ```
 
 #### Widget
@@ -429,7 +443,7 @@ typeform.embed_as(:modal)
 Allows you more control over where the form is embedded and how it appears. Just a box on the page.
 
 ```ruby
-typeform.embed_as(:widget)
+typeform.embed_as(:widget, width: "1024px", height: "768px")
 ```
 
 #### Drawer
@@ -437,7 +451,7 @@ typeform.embed_as(:widget)
 Makes the form slide in from the side of the page, hamburger menu style, and fills at least half of the screen.
 
 ```ruby
-typeform.embed_as(:drawer)
+typeform.embed_as(:drawer, button_text: "Launch me!")
 ```
 
 #### Fullscreen
@@ -450,6 +464,23 @@ Note that this outputs a **complete** HTML document, CSS and all. If you're work
 typeform.embed_as(:fullscreen)
 ```
 
+## Getting Results
+
+Typeform I/O uses webhooks to send you the responses to your Typeforms. You can configure the URL by telling it where to send responses to, like this:
+
+```ruby
+class UserTypeform
+
+  # all the fields ...
+
+  send_responses_to "https://www.my-awesome-website.com/webhooks"
+end
+```
+
+`AskAwesomely` will warn you if you don't configure this, as Typeform I/O doesn't store the responses for you and they'll be lost in the either.
+
+Check the documentation on [results and webhooks](http://docs.typeform.io/docs/results-introduction) to find out more about how this works, what happens when a webhook submission request fails, and how you can deduplicate your submissions.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

data/ask_awesomely.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "aws-sdk", "~> 2.0"
   spec.add_dependency "typhoeus", "~> 0.8"
+  spec.add_dependency "erubis", "~> 2.7"
 
   spec.add_development_dependency "bundler", "~> 1.9"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/ask_awesomely.rb

@@ -9,8 +9,9 @@ require "ask_awesomely/api_client"
 require "ask_awesomely/typeform"
 require "ask_awesomely/embeddable"
 
-require "erb"
 require "json"
+require "uri"
+require "erubis"
 require "aws-sdk"
 require "typhoeus"
 
@@ -19,6 +20,7 @@ module AskAwesomely
   ConfigurationError = Class.new(ArgumentError)
   FieldTypeError = Class.new(ArgumentError)
   EmbedTypeError = Class.new(ArgumentError)
+  InvalidUrlError = Class.new(TypeError)
 
   def self.configuration
     @configuration ||= Configuration.new

data/lib/ask_awesomely/configuration.rb

@@ -8,7 +8,8 @@ module AskAwesomely
                   :aws_access_key_id,
                   :aws_access_key_secret,
                   :aws_region,
-                  :aws_bucket
+                  :aws_bucket,
+                  :logger
     
     def typeform_api_key
       unless @typeform_api_key
@@ -26,5 +27,11 @@ module AskAwesomely
       @aws_bucket || DEFAULT_AWS_BUCKET
     end
 
+    def logger
+      @logger ||= Logger.new(STDOUT).tap do |logger|
+        logger.level = Logger::WARN
+      end
+    end
+
   end
 end

data/lib/ask_awesomely/dsl.rb

@@ -34,17 +34,29 @@ module AskAwesomely
       def field(type, &block)
         _state.fields << Field::Field.of_type(type, &block)
       end
+
+      def send_responses_to(url)
+        unless url =~ /\A#{URI::regexp(['http', 'https'])}\z/
+          raise AskAwesomely::InvalidUrlError, "you must use a valid URL for webhooks, e.g https://example.com/webhook"
+        end
+        
+        _state.webhook_submit_url = url
+      end
     end
 
     attr_reader :context, :json
 
     def build_json
+      warn_if_no_webhook_set!
+      
       state.to_h.reduce({}) do |json, (k, v)|
         json[k] = case k
-        when :title, :tags
-          v.respond_to?(:call) ? v.call(@context) : v
         when :fields
           v.map {|f| f.build_json(@context) }
+        when :webhook_submit_url
+           v
+        else
+          v.respond_to?(:call) ? v.call(@context) : v
         end
 
         json
@@ -61,5 +73,12 @@ module AskAwesomely
       self.class._state
     end
 
+    def warn_if_no_webhook_set!
+      return if state.webhook_submit_url
+      AskAwesomely.configuration.logger.warn(<<-STR.gsub(/^\s*/, ''))
+        Your Typeform has no webhook URL! The responses to this form **will NOT** be saved!
+        To set one, add `send_responses_to "https://example.com/webhook"` to #{self.class.name} 
+      STR
+    end
   end
 end

data/lib/ask_awesomely/embeddable.rb

@@ -8,6 +8,12 @@ module AskAwesomely
       fullscreen
     )
 
+    DEFAULT_OPTIONS = {
+      width: 800,
+      height: 600,
+      button_text: "Launch me!"
+    }
+
     def initialize(embed_type)
       unless EMBED_TYPES.include?(embed_type)
         raise AskAwesomely::EmbedTypeError, "embed type must be one of: #{EMBED_TYPES.join(', ')}"
@@ -16,8 +22,11 @@ module AskAwesomely
       @embed_type = embed_type
     end
 
-    def render(typeform)
-      ERB.new(template, 0, '>').result(typeform.get_binding)
+    def render(typeform, options = {})
+      locals = DEFAULT_OPTIONS
+               .merge(options)
+               .merge(public_url: typeform.public_url, title: typeform.title)
+      Erubis::Eruby.new(template).result(locals)
     end
 
     private 

data/lib/ask_awesomely/embeds/drawer.erb

@@ -1,3 +1,3 @@
-<a class="typeform-share link" href="<%= public_url %>" data-mode="2" target="_blank">Launch me!</a>
+<a class="typeform-share link" href="<%= public_url -%>" data-mode="2" target="_blank"><%= button_text -%></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/modal.erb

@@ -1,3 +1,3 @@
-<a class="typeform-share link" href="<%= public_url %>" data-mode="1" target="_blank">Launch me!</a>
+<a class="typeform-share link" href="<%= public_url -%>" data-mode="1" target="_blank"><%= button_text -%></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

@@ -1,3 +1,3 @@
-<div class="typeform-widget" data-url="<%= public_url %>" data-text="<%= title %>" style="width:100%;height:500px;"></div>
+<div class="typeform-widget" data-url="<%= public_url -%>" data-text="<%= title -%>" style="width:<%= width -%>;height: <%= height -%>;"></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/typeform.rb

@@ -23,8 +23,8 @@ module AskAwesomely
       }.fetch("href")
     end
 
-    def embed_as(type)
-      Embeddable.new(type, options).render(binding)
+    def embed_as(type, options = {})
+      Embeddable.new(type, options).render(self, options)
     end
 
     def update_with_api_response(response)
@@ -36,8 +36,5 @@ module AskAwesomely
       @structure.build_json
     end
 
-    def get_binding
-      binding
-    end
   end
 end

data/lib/ask_awesomely/version.rb

@@ -1,3 +1,3 @@
 module AskAwesomely
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ask_awesomely
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Lee Machin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-29 00:00:00.000000000 Z
+date: 2015-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement