gather_content-api 1.0.0 → 1.1.0

data/lib/gather_content/dsl/text.rb

@@ -0,0 +1,29 @@
+require 'gather_content/dsl/base'
+require 'gather_content/config/elements/text'
+
+module GatherContent
+  module DSL
+    class Text < Base
+      def initialize(tab)
+        @text = GatherContent::Config::Element::Text.new
+        super(tab, @text)
+      end
+
+      def value(value)
+        @text.value = value
+      end
+
+      def limit_type(limit_type)
+        @text.limit_type = limit_type
+      end
+
+      def limit(limit)
+        @text.limit = limit
+      end
+
+      def plain_text(plain_text)
+        @text.plain_text = plain_text
+      end
+    end
+  end
+end

data/lib/gather_content/error.rb

@@ -1,5 +1,5 @@
+require 'gather_content/error/request_error'
 module GatherContent
   module Error
-    autoload :RequestError, 'gather_content/error/request_error'
   end
 end

data/lib/gather_content/version.rb

@@ -1,3 +1,3 @@
 module GatherContent
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/gather_content/config/builder_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require 'gather_content/config/tab'
+require 'gather_content/config/builder'
+
+RSpec.describe GatherContent::Config::Builder do
+  context "adding a tab element" do
+    it "adds the tab" do
+      builder = GatherContent::Config::Builder.build do
+        tab do
+          label "text_label"
+          name "Text Label"
+        end
+      end
+
+      expect(builder.first).to be_instance_of(GatherContent::Config::Tab)
+    end
+  end
+
+  context "to_json" do
+    it "returns a JSON object" do
+      builder = GatherContent::Config::Builder.build do
+        tab do
+          label "text_label"
+          name "Text Label"
+
+          text do
+            name "Text"
+            label "text"
+            required false
+            value ""
+            microcopy ""
+            limit_type :chars
+            limit 255
+            plain_text true
+          end
+        end
+      end
+
+      expect(JSON.parse(builder.to_json)).to eq(JSON.parse([{"label": "text_label", "name": "Text Label", "hidden": false, "elements": [{"name": "Text", "required": false, "label": "text", "microcopy": "", "type": "text", "value": "", "limit_type": "chars", "limit": 255, "plain_text": true}]}].to_json))
+    end
+  end
+end

data/spec/gather_content/config/elements/choice_checkbox_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+require 'gather_content/config/elements/choice_checkbox'
+require 'gather_content/config/elements/option'
+require 'gather_content/config/elements/other_option'
+
+RSpec.describe GatherContent::Config::Element::ChoiceCheckbox do
+  let(:name) { "checkbox" }
+  let(:required) { false }
+  let(:label) { "Choices" }
+  let(:microcopy) { "Choose a thing" }
+  let(:options) do
+    o1 = GatherContent::Config::Element::Option.new("option_1", "Option 1")
+    o2 = GatherContent::Config::Element::Option.new("option_2", "Option 2")
+
+    [o1, o2]
+  end
+
+  let(:checkbox) { GatherContent::Config::Element::ChoiceCheckbox.new }
+
+  context "defaults" do
+    subject { checkbox }
+
+    include_examples "Gather Content Defaults", "text"
+  end
+
+  context "when converting to JSON" do
+    before(:each) do
+      checkbox.name = name
+      checkbox.required = required
+      checkbox.label = label
+      checkbox.microcopy = microcopy
+      checkbox.options = options
+    end
+
+    subject { checkbox.serialize }
+    it_behaves_like "a Gather Content Element", "choice_checkbox"
+
+    context "options" do
+      context "aren't supplied" do
+        let(:options) { [] }
+
+        it "raises a ArgumentError" do
+          expect {
+            subject
+          }.to raise_error(ArgumentError)
+        end
+      end
+
+      context "are supplied" do
+        let(:options) { [ GatherContent::Config::Element::Option.new("option_1", "Option 1") ] }
+
+        it "serialises the options" do
+          expect(subject[:options]).to eq(options.map{ |el| el.serialize })
+        end
+      end
+
+      context "are type OtherOption" do
+        let(:options) { [ GatherContent::Config::Element::OtherOption.new("option_1", "Option 1") ] }
+
+        it "raises a ArgumentError" do
+          expect {
+            subject
+          }.to raise_error(ArgumentError)
+        end
+      end
+
+      context "are not an Option type" do
+        let(:options) { [ "Hello" ] }
+
+        it "raises a ArgumentError" do
+          expect {
+            subject
+          }.to raise_error(ArgumentError)
+        end
+      end
+    end
+  end
+end

data/spec/gather_content/config/elements/choice_radio_spec.rb

@@ -0,0 +1,175 @@
+require 'spec_helper'
+require 'gather_content/config/elements/choice_radio'
+require 'gather_content/config/elements/option'
+
+RSpec.describe GatherContent::Config::Element::ChoiceRadio do
+  let(:name) { "radio" }
+  let(:required) { false }
+  let(:label) { "Choices" }
+  let(:microcopy) { "Choose a thing" }
+  let(:other_option) { false }
+  let(:options) do
+    o1 = GatherContent::Config::Element::Option.new("option_1", "Option 1")
+    o2 = GatherContent::Config::Element::Option.new("option_2", "Option 2")
+
+    [o1, o2]
+  end
+
+  let(:radio) { GatherContent::Config::Element::ChoiceRadio.new }
+
+  context "defaults" do
+    subject { radio }
+
+    include_examples "Gather Content Defaults", "text"
+
+    context "other_option" do
+      it "is false" do
+        expect(subject.other_option).to eq(false)
+      end
+    end
+  end
+
+  context "when converting to JSON" do
+    before(:each) do
+      radio.name = name
+      radio.required = required
+      radio.label = label
+      radio.microcopy = microcopy
+      radio.options = options
+      radio.other_option = other_option
+    end
+
+    subject { radio.serialize }
+    it_behaves_like "a Gather Content Element", "choice_radio"
+
+    context "options" do
+      context "aren't supplied" do
+        let(:options) { [] }
+
+        it "raises a ArgumentError" do
+          expect {
+            subject
+          }.to raise_error(ArgumentError)
+        end
+      end
+
+      context "where none are selected" do
+        let(:options) do
+          o1 = GatherContent::Config::Element::Option.new("option_1", "Option 1", false)
+          o2 = GatherContent::Config::Element::Option.new("option_2", "Option 2", false)
+
+          [o1, o2]
+        end
+
+        it "serialises the options" do
+          expect(subject[:options]).to eq(options.map{ |el| el.serialize })
+        end
+      end
+
+      context "where one is selected" do
+        let(:options) do
+          o1 = GatherContent::Config::Element::Option.new("option_1", "Option 1", true)
+          o2 = GatherContent::Config::Element::Option.new("option_2", "Option 2", false)
+
+          [o1, o2]
+        end
+
+        it "serialises the options" do
+          expect(subject[:options]).to eq(options.map{ |el| el.serialize })
+        end
+      end
+
+      context "where more than one is selected" do
+        let(:options) do
+          o1 = GatherContent::Config::Element::Option.new("option_1", "Option 1", true)
+          o2 = GatherContent::Config::Element::Option.new("option_2", "Option 2", true)
+
+          [o1, o2]
+        end
+
+        it "raises a ArgumentError" do
+          expect {
+            subject
+          }.to raise_error(ArgumentError)
+        end
+      end
+
+      context "when other_option is false" do
+        context "there is only one option" do
+          let(:options) { [ GatherContent::Config::Element::Option.new("option_1", "Option 1") ] }
+
+          it "serialises the options" do
+            expect(subject[:options]).to eq(options.map{ |el| el.serialize })
+          end
+        end
+      end
+
+      context "when other_option is true" do
+        let(:other_option) { true }
+
+        context "there is only one option" do
+          let(:options) { [ GatherContent::Config::Element::Option.new("option_1", "Option 1") ] }
+
+          it "raises a ArgumentError" do
+            expect {
+              subject
+            }.to raise_error(ArgumentError)
+          end
+        end
+
+        context "and the last option is a OptionOther" do
+          let(:options) do
+            o1 = GatherContent::Config::Element::Option.new("option_1", "Option 1")
+            o2 = GatherContent::Config::Element::OtherOption.new("option_2", "Option 2")
+
+            [o1, o2]
+          end
+
+          it "serialises the options" do
+            expect(subject[:options]).to eq(options.map{ |el| el.serialize })
+          end
+        end
+
+        context "and the last option is not an OtherOption" do
+          let(:options) do
+            o1 = GatherContent::Config::Element::Option.new("option_1", "Option 1")
+            o2 = GatherContent::Config::Element::Option.new("option_2", "Option 2")
+
+            [o1, o2]
+          end
+
+          it "raises a ArgumentError" do
+            expect {
+              subject
+            }.to raise_error(ArgumentError)
+          end
+        end
+
+        context "the OtherOption is not the last option" do
+          let(:options) do
+            o1 = GatherContent::Config::Element::OtherOption.new("option_1", "Option 1")
+            o2 = GatherContent::Config::Element::Option.new("option_2", "Option 2")
+
+            [o1, o2]
+          end
+
+          it "raises a ArgumentError" do
+            expect {
+              subject
+            }.to raise_error(ArgumentError)
+          end
+        end
+      end
+
+      context "are not an Option type" do
+        let(:options) { [ "Hello" ] }
+
+        it "raises a ArgumentError" do
+          expect {
+            subject
+          }.to raise_error(ArgumentError)
+        end
+      end
+    end
+  end
+end

data/spec/gather_content/config/elements/files_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+require 'gather_content/config/elements/files'
+
+RSpec.describe GatherContent::Config::Element::Files do
+  let(:name) { "file" }
+  let(:required) { false }
+  let(:label) { "Files" }
+  let(:microcopy) { "Upload a file" }
+
+  let(:files) { GatherContent::Config::Element::Files.new }
+
+  before(:each) do
+    files.name = name
+    files.required = required
+    files.label = label
+    files.microcopy = microcopy
+  end
+
+  context "when converting to JSON" do
+    subject { files.serialize }
+    it_behaves_like "a Gather Content Element", "files"
+  end
+end

data/spec/gather_content/config/elements/option_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+require 'gather_content/config/elements/option'
+
+RSpec.describe GatherContent::Config::Element::Option do
+  let(:name) { "file" }
+  let(:label) { "Files" }
+  let(:selected) { false }
+
+  let(:option) { GatherContent::Config::Element::Option.new }
+
+  before(:each) do
+    option.name = name
+    option.label = label
+    option.selected = selected
+  end
+
+  context "when converting to JSON" do
+    subject { option.serialize }
+
+    context "a valid section instance" do
+      it "has a name" do
+        expect(subject[:name]).to eq(name)
+      end
+
+      it "has a label" do
+        expect(subject[:label]).to eq(label)
+      end
+
+      it "has a selected flag" do
+        expect(subject[:selected]).to eq(selected)
+      end
+    end
+
+    context "with an empty name" do
+      let(:name) { "" }
+
+      it "raises a ArgumentError" do
+        expect {
+          subject
+        }.to raise_error(ArgumentError)
+      end
+    end
+
+    context "with an empty label" do
+      let(:label) { "" }
+
+      it "raises a ArgumentError" do
+        expect {
+          subject
+        }.to raise_error(ArgumentError)
+      end
+    end
+
+    context "selected" do
+      context "is true" do
+        let(:selected) { true }
+
+        it "compiles to true" do
+          expect(subject[:selected]).to eq(true)
+        end
+      end
+
+      context "is false" do
+        let(:selected) { false }
+
+        it "compiles to false" do
+          expect(subject[:selected]).to eq(false)
+        end
+      end
+
+      context "is truthy" do
+        let(:selected) { "I'm a string!" }
+
+        it "compiles to true" do
+          expect(subject[:selected]).to eq(true)
+        end
+      end
+
+      context "is falsey" do
+        let(:selected) { nil }
+
+        it "compiles to false" do
+          expect(subject[:selected]).to eq(false)
+        end
+      end
+    end
+  end
+end