ask_awesomely 0.1.7 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57f17215b78dd2e3143b8491973c5f92886e51eb
-  data.tar.gz: 896f7286ff272ff2a6ed5065a467d0506c8c3c71
+  metadata.gz: 9b1872c38eca936853d8a4c749c86825c32e67b3
+  data.tar.gz: 21e73d3a4c42a1a1b5046c353c893a453c2179cf
 SHA512:
-  metadata.gz: 41d6794bb832347d86d7d8a6052e928999fc2f640cfa5aaa59da04806374386b2a0128ee2533f15967c1a2ce653fc75e65325d545fa72abb89db8804240bdc4f
-  data.tar.gz: fbaf9fb504249c1f1d1e6f1b87a1dc39f9a41c47003c3967c2d953b38d3f0b5951ec26bed5d908b78b2b8d39e4e009b93315eb59c7e06c8d394d2c0f3c2116ba
+  metadata.gz: a71c7706f7c3570b7967ab4b12da84b5ed782f70cc1703b7a805b52c4c1f2c40ef1ea97082db984a35c0b61afec34432b6a9f65bc7a8d7864fc638882cdda631
+  data.tar.gz: 7677f681ef80f096dde29bcac94aca517c06144e6b5002838296c729f92f638b05c6f319a6ca11646ec0a3f8bc5b899110d0641a5d4a2769e39b13e543922cd9

data/README.md

@@ -352,6 +352,27 @@ field :legal
 end
 ```
 
+## Custom Designs
+
+You can customise the appearance of your Typeform by adding a design. While you don't have as much control as you would through the builder on Typeform.com, you are still able to play with colours and fonts. The documentation contains a list of [possible font selections](http://docs.typeform.io/docs/designs).
+
+```ruby
+design do
+  question_color "#FF0099"
+  button_color "#ABCDEF"
+  answer_color "#4AF6E9"
+  background_color "#000000"
+
+  font "Vollkorn"
+end
+```
+
+If you already have a design and would like to re-use it, you can use an ID from the created form.
+
+```ruby
+    design 12345
+```
+
 ## Logic Jumps
 
 A logic jump allows you to change the next questions you ask based on the answer of a previous question. For example, you could have a `yes_no` field that shows one question if the answer is 'yes', and a different question if the answer is 'no'. At the time of writing this is the only supported behaviour for logic jumps.

data/lib/ask_awesomely/api_client.rb

@@ -6,7 +6,8 @@ module AskAwesomely
     ENDPOINTS = {
       root: "/",
       create_typeform: "/forms",
-      create_picture: "/images"
+      create_picture: "/images",
+      create_design: "/designs"
     }
 
     def initialize
@@ -45,6 +46,16 @@ module AskAwesomely
       JSON.parse(response.body)
     end
 
+    def submit_design(design)
+      response = request.post(
+        url_for(:create_design),
+        headers: headers,
+        body: design.to_json
+      )
+
+      JSON.parse(response.body)
+    end
+
     private
 
     def request

data/lib/ask_awesomely/design.rb

@@ -0,0 +1,83 @@
+module AskAwesomely
+  class Design
+
+    VALID_FONTS = %w[
+      Acme
+      Arial
+      Arvo
+      Bangers
+      Cabin
+      Cabin Condensed
+      Courier
+      Crete Round
+      Dancing Script
+      Exo
+      Georgia
+      Handlee
+      Karla
+      Lato
+      Lobster
+      Lora
+      McLaren
+      Monsterrat
+      Nixie
+      Old Standard TT
+      Open Sans
+      Oswald
+      Playfair
+      Quicksand
+      Raleway
+      Signika
+      Sniglet
+      Source Sans Pro
+      Vollkorn
+    ]
+
+    def initialize(&block)
+      @state = OpenStruct.new(colors: {})
+      instance_eval(&block)
+    end
+
+    def id
+      @id ||= upload_to_typeform["id"]
+    end
+
+    def background_color(color)
+      @state.colors[:background] = color
+    end
+
+    def question_color(color)
+      @state.colors[:question] = color
+    end
+
+    def answer_color(color)
+      @state.colors[:answer] = color
+    end
+
+    def button_color(color)
+      @state.colors[:button] = color
+    end
+
+    def font(font)
+      unless VALID_FONTS.include?(font)
+          raise AskAwesomely::InvalidFontError, "#{font} is not supported; you must use one of the following fonts: #{VALID_FONTS.join(', ')}"
+      end
+
+      @state.font = font
+    end
+
+    def to_json(*)
+      {
+        colors: @state.colors,
+        font: @state.font
+      }.to_json
+    end
+
+    private
+
+    def upload_to_typeform
+        ApiClient.new.submit_design(self)
+    end
+
+  end
+end

data/lib/ask_awesomely/dsl.rb

@@ -41,11 +41,15 @@ module AskAwesomely
         _state.jumps << LogicJump.new(conditions)
       end
 
+      def design(id = nil, &block)
+        _state.design_id = id || ->(_) { Design.new(&block).id }
+      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
@@ -58,7 +62,7 @@ module AskAwesomely
     end
 
     private
-    
+
     def initialize(context = nil)
       @context = context
       @state = self.class._state
@@ -68,7 +72,7 @@ module AskAwesomely
       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} 
+        To set one, add `send_responses_to "https://example.com/webhook"` to #{self.class.name}
       STR
     end
   end

data/lib/ask_awesomely/picture.rb

@@ -4,7 +4,7 @@ module AskAwesomely
     attr_reader :file_or_url, :public_url, :type, :typeform_id
 
     DEFAULT_TYPE = :choice
-    
+
     PICTURE_TYPES = [
       :choice
     ]

data/lib/ask_awesomely/version.rb

@@ -1,3 +1,3 @@
 module AskAwesomely
-  VERSION = "0.1.7"
+  VERSION = "0.2.0"
 end

data/lib/ask_awesomely.rb

@@ -17,6 +17,7 @@ require "ask_awesomely/api_client"
 require "ask_awesomely/typeform"
 require "ask_awesomely/embeddable"
 require "ask_awesomely/logic_jump"
+require "ask_awesomely/design"
 
 module AskAwesomely
 
@@ -24,6 +25,7 @@ module AskAwesomely
   FieldTypeError = Class.new(ArgumentError)
   EmbedTypeError = Class.new(ArgumentError)
   InvalidUrlError = Class.new(TypeError)
+  InvalidFontError = Class.new(ArgumentError)
 
   def self.configuration
     @configuration ||= Configuration.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ask_awesomely
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.0
 platform: ruby
 authors:
 - Lee Machin
@@ -115,7 +115,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
@@ -131,6 +130,7 @@ files:
 - lib/ask_awesomely/api_client.rb
 - lib/ask_awesomely/choice.rb
 - lib/ask_awesomely/configuration.rb
+- lib/ask_awesomely/design.rb
 - lib/ask_awesomely/dsl.rb
 - lib/ask_awesomely/embeddable.rb
 - lib/ask_awesomely/embeds/drawer.erb

data/.codeclimate.yml

@@ -1,6 +0,0 @@
-engines:
-  rubocop:
-    enabled: true
-    checks:
-      Rubocop/Style/StringLiterals:
-        enabled: false