ask_awesomely 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f05c9c5cdae79172a5a1bcddbef1f3c6fa488033
-  data.tar.gz: 798898689f330e31f28685a690180813797c84d5
+  metadata.gz: 70509a7f4e01e364e2e6177430566f5853fb4bb9
+  data.tar.gz: 5348d34668d7a5ad781707d297ad08c7579f245d
 SHA512:
-  metadata.gz: cf064d4f65fb1d9bcc6e9a41f979aa16c5621ae3dbcd482c55371bad955aeba199c6fb34351f368507c2c9eb1f60d0d49b955eadf7923fde6c4ae0617313d097
-  data.tar.gz: ed9e1bd633c56fbf521a8fc521a61c49d0073269241b7fcfa47397cd5c894c031e452b42b5c7916a426c2ce2ac858f89f33dcf0ba2956b0f5b35ada56477cd63
+  metadata.gz: 2ba0944f97f24d5d291704e381e00f6539b85d5d1056e8cd13d1cca2da9d3fbb22d59a29ee9c5c4c14c9fb3fd70cb882781ebfc8cf6ec9ec46ad03af423ed928
+  data.tar.gz: 5016b441a5fc79fdd3dbff2682e7c6a44915798c54ea8a910530633783cdff1a856b69ccdc533b86c3ac39facb3c789a64dfd59835933e0a88ac3166f2c4de2b

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Lee Machin
+
+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

@@ -8,6 +8,7 @@ Build Typeforms awesomely. In Ruby.
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 ## Table of Contents
 
+- [Before you start](#before-you-start)
 - [Installation](#installation)
 - [Usage](#usage)
   - [Authentication](#authentication)
@@ -27,7 +28,7 @@ Build Typeforms awesomely. In Ruby.
   - [Email](#email)
   - [Website](#website)
   - [Legal](#legal)
-    - [Common Customisations](#common-customisations)
+- [Common Customisations](#common-customisations)
 - [Passing Context](#passing-context)
 - [Rendering the Typeform](#rendering-the-typeform)
   - [Getting the URL](#getting-the-url)
@@ -36,25 +37,26 @@ Build Typeforms awesomely. In Ruby.
     - [Widget](#widget)
     - [Drawer](#drawer)
     - [Fullscreen](#fullscreen)
-- [Todo](#todo)
 - [Development](#development)
-- [Contributing](#contributing)
+- [Feedback and Contributions](#feedback-and-contributions)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
+## Before you start
+
 
 ## Installation
 
-I wouldn't recommend you do this yet, because it doesn't actually work. Nevertheless, add this line to your application's Gemfile:
+Prepare your best [Jamie Oliver](https://en.wikipedia.org/wiki/Jamie_Oliver) impression and bang this in yer Gemfile:
 
 ```ruby
 gem 'ask_awesomely'
 ```
 
-And then execute:
+Turn your CPU up to 80ºC and let it simmer for a while with this:
 
 ```shell
-bundle
+bundle install
 ```
 
 Or install it yourself as:
@@ -63,6 +65,11 @@ Or install it yourself as:
 gem install ask_awesomely
 ```
 
+Then include it in your code like this:
+
+```ruby
+require "ask_awesomely"
+```
 
 ## Usage
 
@@ -134,8 +141,6 @@ After that, it's simply a matter of calling `build` on the class:
 typeform = MyNewTypeform.build
 ```
 
-Check the rest of the (not currently finished) documentation to find out what else you can do.
-
 Check out [Typeform I/O](https://typeform.io) for detailed information about the API, and how to get your API key.
 
 
@@ -329,7 +334,7 @@ end
 ```
 
 
-#### Common Customisations
+## Common Customisations
 
 Every field type allows you customize the following things:
 
@@ -349,8 +354,6 @@ end
 
 ## Passing Context
 
-**note: not yet supported**
-
 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?
 
 Lets create the basic form, with a title and a single question:
@@ -409,7 +412,7 @@ end
 
 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).
 
-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.
+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.
 
 Assuming you have built a Typeform as in the other examples, rendering the embed code is simple:
 
@@ -447,25 +450,22 @@ Note that this outputs a **complete** HTML document, CSS and all. If you're work
 typeform.embed_as(:fullscreen)
 ```
 
+## Development
 
-## Todo
-
-- implement and test dynamic fields
-- test the API interaction behaves well
-- deal with errors from the API
-- allow webhook URL to be configured
-- allow design to be configured
+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.
 
+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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 
-## Development
+## Feedback and Contributions
 
-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.
+Practically every aspect of this gem (save for image uploading) is an extension of the Typeform I/O API. If the API has it, `AskAwesomely` eventually will. Here's what the Typeform I/O peeps say:
 
-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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+> We are continuously working on and improving Typeform I/O, and we're heavily focused on making the API as simple as possible, but also feature-rich so you can make good use of it. We would be forever grateful if you can leave us feedback. We welcome all questions, and we'd love to talk to you about how you're using Typeform I/O, what you hope for from us in the future, or anything else!
 
+> We recommend you join our [#Slack group](http://docs.typeform.io/v0.4/page/slack-invite) to chat with us, and with other people using Typeform I/O. You can also ask us questions in our [Q&A section](http://docs.typeform.io/v0.4/discuss), or you can simply send us an email to [support@typeform.io](mailto:support@typeform.io).
 
-## Contributing
+That doesn't preclude contributing to the gem itself by fixing bugs or offering improvements. If you'd like to do that, follow these simple steps:
 
 1. Fork it (https://github.com/leemachin/ask_awesomely/fork)
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/lib/ask_awesomely/dsl.rb

@@ -38,12 +38,27 @@ module AskAwesomely
 
     attr_reader :context, :json
 
-    private def initialize(context = nil)
+    def build_json
+      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) }
+        end
+
+        json
+      end.to_json
+    end
+
+    private
+    
+    def initialize(context = nil)
       @context = context
     end
 
-    def to_json
-      self.class._state.to_h.to_json
+    def state
+      self.class._state
     end
 
   end

data/lib/ask_awesomely/field/field.rb

@@ -61,8 +61,12 @@ module AskAwesomely
       @state.tags = tags
     end
     
-    def to_json(*args)
-      @state.to_h.to_json(*args)
+    def build_json(context = nil)
+      state.to_h.reduce({}) do |json, (k, v)|
+        json[k] = v.respond_to?(:call) ? v.call(context) : v
+        json
+      end
     end
+    
   end
 end

data/lib/ask_awesomely/typeform.rb

@@ -33,7 +33,7 @@ module AskAwesomely
     end
 
     def to_json
-      @structure.to_json
+      @structure.build_json
     end
 
     def get_binding

data/lib/ask_awesomely/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ask_awesomely
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Lee Machin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-26 00:00:00.000000000 Z
+date: 2015-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -106,6 +106,7 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - ask_awesomely.gemspec