prismic.io 1.0.0.preview.1

data/spec/prismic_spec.rb

@@ -0,0 +1,237 @@
+require 'spec_helper'
+
+describe 'Api' do
+  before do
+    json_representation = '{"foo": "bar"}'
+    @api = Prismic::API.new({
+      json: json_representation,
+      bookmarks: {},
+      tags: {},
+      types: {},
+      refs: {
+        'key1' => Prismic::Ref.new('ref1', 'label1'),
+        'key2' => Prismic::Ref.new('ref2', 'label2'),
+        'key3' => Prismic::Ref.new('ref3', 'label3', true),
+        'key4' => Prismic::Ref.new('ref4', 'label4'),
+      },
+      forms: {
+        'form1' => Prismic::SearchForm.new(Prismic::Form.new('form1', {}, nil, nil, nil, nil)),
+        'form2' => Prismic::SearchForm.new(Prismic::Form.new('form2', {}, nil, nil, nil, nil)),
+        'form3' => Prismic::SearchForm.new(Prismic::Form.new('form3', {}, nil, nil, nil, nil)),
+        'form4' => Prismic::SearchForm.new(Prismic::Form.new('form4', {}, nil, nil, nil, nil)),
+      },
+    })
+  end
+
+  describe 'ref' do
+    it "returns the right Ref" do
+      @api.ref('key2').label.should == 'label2'
+    end
+  end
+
+  describe 'refs' do
+    it "returns the correct number of elements" do
+      @api.refs.size.should == 4
+    end
+  end
+
+  describe 'ref_id_by_label' do
+    it "returns the id of the ref" do
+      @api.ref_id_by_label('key4').ref == 'ref4'
+    end
+  end
+
+  describe 'form' do
+    it "return the right Form" do
+      @api.form('form2').form.name.should == 'form2'
+    end
+  end
+
+  describe 'forms' do
+    it "returns the correct number of elements" do
+      @api.forms.size.should == 4
+    end
+  end
+
+  describe 'master' do
+    it "returns a master Ref" do
+      @api.master.master?.should be_true
+    end
+  end
+
+  describe 'parse_api_response' do
+    before do
+      @data = File.read("#{File.dirname(__FILE__)}/responses_mocks/api.json")
+      @json = JSON.parse(@data)
+      @parsed = Prismic::API.parse_api_response(@json)
+    end
+
+    it "does not allow to be created without master Ref" do
+      expect {
+        Prismic::API.parse_api_response({
+          "refs" => [],
+        })
+      }.to raise_error(Prismic::API::BadPrismicResponseError, "No master Ref found")
+    end
+
+    it "does not allow to be created without any Ref" do
+      expect {
+        Prismic::API.parse_api_response({})
+      }.to raise_error(Prismic::API::BadPrismicResponseError, "No refs given")
+    end
+
+    it "creates 2 refs" do
+      @parsed.refs.size.should == 2
+    end
+
+    it "creates the right ref's ref" do
+      @parsed.refs['bar'].ref.should == 'foo'
+    end
+
+    it "creates the right ref's label" do
+      @parsed.refs['bar'].label.should == 'bar'
+    end
+
+    it "creates the right ref's 'master' value" do
+      @parsed.refs['bar'].master?.should == false
+    end
+
+    it "creates 3 bookmarks" do
+      @parsed.bookmarks.size.should == 3
+    end
+
+    it "creates the right bookmarks" do
+      @parsed.bookmarks['about'].should == 'Ue0EDd_mqb8Dhk3j'
+    end
+
+    it "creates 6 types" do
+      @parsed.types.size.should == 6
+    end
+
+    it "creates the right types" do
+      @parsed.types['blog-post'].should == 'Blog post'
+    end
+
+    it "creates 4 tags" do
+      @parsed.tags.size.should == 4
+    end
+
+    it "creates the right tags" do
+      @parsed.tags.should include 'Cupcake'
+    end
+
+    it "creates 10 forms" do
+      @parsed.forms.size.should == 10
+    end
+
+    it "creates the right form's name" do
+      @parsed.forms['pies'].name.should == 'Little Pies'
+    end
+
+    it "creates the right form's method" do
+      @parsed.forms['pies'].form_method.should == 'GET'
+    end
+
+    it "creates the right form's rel" do
+      @parsed.forms['pies'].rel.should == 'collection'
+    end
+
+    it "creates the right form's enctype" do
+      @parsed.forms['pies'].enctype.should == 'application/x-www-form-urlencoded'
+    end
+
+    it "creates the right form's action" do
+      @parsed.forms['pies'].action.should == 'http://lesbonneschoses.wroom.io/api/documents/search'
+    end
+
+    it "creates forms with the right fields" do
+      @parsed.forms['pies'].fields.size.should == 2
+    end
+
+    it "creates forms with the right type info" do
+      @parsed.forms['pies'].fields['ref'].field_type.should == 'String'
+    end
+
+    it "creates forms with the right default info" do
+      @parsed.forms['pies'].fields['q'].default.should ==
+        '[[at(document.tags, ["Pie"])][any(document.type, ["product"])]]'
+    end
+  end
+
+  describe 'as_json' do
+    before do
+      @json = @api.as_json
+    end
+
+    it "returns the json representation of the api" do
+      JSON.parse(@json)['foo'].should == 'bar'
+    end
+
+    it "returns the json representation of the api containing one single element" do
+      JSON.parse(@json).size.should == 1
+    end
+  end
+end
+
+describe 'Document' do
+  before do
+    fragments = {
+      'field1' => Prismic::Fragments::DocumentLink.new(nil, nil, nil, nil, nil),
+      'field2' => Prismic::Fragments::WebLink.new('weburl')
+    }
+    @document = Prismic::Document.new(nil, nil, nil, nil, ['my-slug'], fragments)
+    @link_resolver = Prismic::LinkResolver.new('master'){|doc_link|
+      "http://host/#{doc_link.id}"
+    }
+  end
+
+  describe 'slug' do
+    it "returns the first slug if found" do
+      @document.slug.should == 'my-slug'
+    end
+
+    it "returns '-' if no slug found" do
+      @document.slugs = []
+      @document.slug.should == '-'
+    end
+  end
+
+  describe 'as_html' do
+    it "returns a <section> HTML element" do
+      Nokogiri::XML(@document.as_html(@link_resolver)).child.name.should == 'section'
+    end
+
+    it "returns a HTML element with a 'data-field' attribute" do
+      Nokogiri::XML(@document.as_html(@link_resolver)).child.has_attribute?('data-field').should be_true
+    end
+
+    it "returns a HTML element with a 'data-field' attribute containing the name of the field" do
+      Nokogiri::XML(@document.as_html(@link_resolver)).child.attribute('data-field').value.should == 'field1'
+    end
+  end
+end
+
+describe 'SearchForm' do
+  before do
+    @field = Prismic::Field.new('String', '[foo]')
+  end
+
+  describe 'query' do
+    it "adds the query to the form's data" do
+      @form = Prismic::SearchForm.new(Prismic::Form.new('form1', {}, nil, nil, nil, nil), {})
+      @form.query('[bar]')
+      @form.data.should == { 'q' => '[bar]' }
+    end
+
+    it "adds existant non-nil queries (in fields) to the form's data" do
+      @form = Prismic::SearchForm.new(Prismic::Form.new('form1', {'q' => @field}, nil, nil, nil, nil), {})
+      @form.query('[bar]')
+      @form.data.should == { 'q' => '[foobar]' }
+    end
+
+    it "returns the form itself" do
+      @form = Prismic::SearchForm.new(Prismic::Form.new('form1', {'q' => @field}, nil, nil, nil, nil), {})
+      @form.query('[foo]').should == @form
+    end
+  end
+end

data/spec/responses_mocks/api.json

@@ -0,0 +1,192 @@
+{
+   "refs":[
+      {
+         "ref":"UfuJ2d_mqXoNBZDt",
+         "label":"Master",
+         "isMasterRef":true
+      },
+      {
+         "ref":"foo",
+         "label":"bar",
+         "isMasterRef":false
+      }
+   ],
+   "bookmarks":{
+      "about":"Ue0EDd_mqb8Dhk3j",
+      "jobs":"Ue0EHN_mqbwDhk3l",
+      "stores":"Ue0EVt_mqd8Dhk3n"
+   },
+   "types":{
+      "blog-post":"Blog post",
+      "store":"Store",
+      "article":"Site-level article",
+      "selection":"Products selection",
+      "job-offer":"Job offer",
+      "product":"Product"
+   },
+   "tags":[
+      "Cupcake",
+      "Featured",
+      "Pie",
+      "Macaron"
+   ],
+   "forms":{
+      "featured":{
+         "name":"Featured on homepage",
+         "method":"GET",
+         "rel":"collection",
+         "enctype":"application/x-www-form-urlencoded",
+         "action":"http://lesbonneschoses.wroom.io/api/documents/search",
+         "fields":{
+            "ref":{
+               "type":"String"
+            },
+            "q":{
+               "default":"[[at(document.tags, [\"Featured\"])][any(document.type, [\"product\",\"selection\",\"blog-post\"])]]",
+               "type":"String"
+            }
+         }
+      },
+      "products":{
+         "name":"All Products",
+         "method":"GET",
+         "rel":"collection",
+         "enctype":"application/x-www-form-urlencoded",
+         "action":"http://lesbonneschoses.wroom.io/api/documents/search",
+         "fields":{
+            "ref":{
+               "type":"String"
+            },
+            "q":{
+               "default":"[[any(document.type, [\"product\"])]]",
+               "type":"String"
+            }
+         }
+      },
+      "macarons":{
+         "name":"Macarons",
+         "method":"GET",
+         "rel":"collection",
+         "enctype":"application/x-www-form-urlencoded",
+         "action":"http://lesbonneschoses.wroom.io/api/documents/search",
+         "fields":{
+            "ref":{
+               "type":"String"
+            },
+            "q":{
+               "default":"[[at(document.tags, [\"Macaron\"])][any(document.type, [\"product\"])]]",
+               "type":"String"
+            }
+         }
+      },
+      "cupcakes":{
+         "name":"Cupcakes",
+         "method":"GET",
+         "rel":"collection",
+         "enctype":"application/x-www-form-urlencoded",
+         "action":"http://lesbonneschoses.wroom.io/api/documents/search",
+         "fields":{
+            "ref":{
+               "type":"String"
+            },
+            "q":{
+               "default":"[[at(document.tags, [\"Cupcake\"])][any(document.type, [\"product\"])]]",
+               "type":"String"
+            }
+         }
+      },
+      "pies":{
+         "name":"Little Pies",
+         "method":"GET",
+         "rel":"collection",
+         "enctype":"application/x-www-form-urlencoded",
+         "action":"http://lesbonneschoses.wroom.io/api/documents/search",
+         "fields":{
+            "ref":{
+               "type":"String"
+            },
+            "q":{
+               "default":"[[at(document.tags, [\"Pie\"])][any(document.type, [\"product\"])]]",
+               "type":"String"
+            }
+         }
+      },
+      "selections":{
+         "name":"Product selections",
+         "method":"GET",
+         "rel":"collection",
+         "enctype":"application/x-www-form-urlencoded",
+         "action":"http://lesbonneschoses.wroom.io/api/documents/search",
+         "fields":{
+            "ref":{
+               "type":"String"
+            },
+            "q":{
+               "default":"[[any(document.type, [\"selection\"])]]",
+               "type":"String"
+            }
+         }
+      },
+      "blog":{
+         "name":"The Blog",
+         "method":"GET",
+         "rel":"collection",
+         "enctype":"application/x-www-form-urlencoded",
+         "action":"http://lesbonneschoses.wroom.io/api/documents/search",
+         "fields":{
+            "ref":{
+               "type":"String"
+            },
+            "q":{
+               "default":"[[any(document.type, [\"blog-post\"])]]",
+               "type":"String"
+            }
+         }
+      },
+      "stores":{
+         "name":"Stores",
+         "method":"GET",
+         "rel":"collection",
+         "enctype":"application/x-www-form-urlencoded",
+         "action":"http://lesbonneschoses.wroom.io/api/documents/search",
+         "fields":{
+            "ref":{
+               "type":"String"
+            },
+            "q":{
+               "default":"[[any(document.type, [\"store\"])]]",
+               "type":"String"
+            }
+         }
+      },
+      "jobs":{
+         "name":"Jobs",
+         "method":"GET",
+         "rel":"collection",
+         "enctype":"application/x-www-form-urlencoded",
+         "action":"http://lesbonneschoses.wroom.io/api/documents/search",
+         "fields":{
+            "ref":{
+               "type":"String"
+            },
+            "q":{
+               "default":"[[any(document.type, [\"job-offer\"])]]",
+               "type":"String"
+            }
+         }
+      },
+      "everything":{
+         "method":"GET",
+         "enctype":"application/x-www-form-urlencoded",
+         "action":"http://lesbonneschoses.wroom.io/api/documents/search",
+         "fields":{
+            "ref":{
+               "type":"String"
+            },
+            "q":{
+               "type":"String"
+            }
+         }
+      }
+   }
+}

data/spec/responses_mocks/document.json

@@ -0,0 +1,170 @@
+{
+  "id": "UdUkXt_mqZBObPeS",
+  "type": "product",
+  "href": "doc-url",
+  "tags": [
+    "Macaron"
+  ],
+  "slugs": [
+    "vanilla-macaron"
+  ],
+  "data": {
+    "product": {
+      "name": {
+        "type": "StructuredText",
+        "value": [
+          {
+          "type": "heading1",
+          "text": "Vanilla Macaron",
+          "spans": []
+        }
+        ]
+      },
+      "short_lede": {
+        "type": "StructuredText",
+        "value": [
+          {
+          "type": "heading2",
+          "text": "Crispiness and softness, rolled into one",
+          "spans": []
+        }
+        ]
+      },
+      "description": {
+        "type": "StructuredText",
+        "value": [
+          {
+          "type": "paragraph",
+          "text": "Experience the ultimate vanilla experience. Our vanilla Macarons are made with our very own (in-house) pure extract of Madagascar vanilla, and subtly dusted with our own vanilla sugar (which we make from real vanilla beans).",
+          "spans": [
+            {
+            "start": 103,
+            "end": 137,
+            "type": "strong"
+          },
+          {
+            "start": 162,
+            "end": 183,
+            "type": "strong"
+          }
+          ]
+        }
+        ]
+      },
+      "image": {
+        "type": "Image",
+        "value": {
+          "main": {
+            "url": "https://wroomio.s3.amazonaws.com/lesbonneschoses/0417110ebf2dc34a3e8b7b28ee4e06ac82473b70.png",
+            "dimensions": {
+              "width": 500,
+              "height": 500
+            }
+          },
+          "views": {
+            "icon": {
+              "url": "https://wroomio.s3.amazonaws.com/lesbonneschoses/babdc3421037f9af77720d8f5dcf1b84c912c6ba.png",
+              "dimensions": {
+                "width": 250,
+                "height": 250
+              }
+            }
+          }
+        }
+      },
+      "allergens": {
+        "type": "Text",
+        "value": "Contains almonds, eggs, milk"
+      },
+      "price": {
+        "type": "Number",
+        "value": 3.55
+      },
+      "flavour": [
+        {
+        "type": "Select",
+        "value": "Vanilla"
+      }
+      ],
+      "color": {
+        "type": "Color",
+        "value": "#ffeacd"
+      },
+      "related": [
+        {
+        "type": "Link.document",
+        "value": {
+          "document": {
+            "id": "UdUjvt_mqVNObPeO",
+            "type": "product",
+            "tags": [
+              "Macaron"
+            ],
+            "slug": "dark-chocolate-macaron"
+          },
+          "isBroken": false
+        }
+      },
+      {
+        "type": "Link.document",
+        "value": {
+          "document": {
+            "id": "UdUjsN_mqT1ObPeM",
+            "type": "product",
+            "tags": [
+              "Macaron"
+            ],
+            "slug": "salted-caramel-macaron"
+          },
+          "isBroken": false
+        }
+      }
+      ],
+      "testimonial_author": [
+        {
+        "type": "StructuredText",
+        "value": [
+          {
+          "type": "heading3",
+          "text": "Chef Guillaume Bort",
+          "spans": []
+        }
+        ]
+      }
+      ],
+      "testimonial_quote": [
+        {
+        "type": "StructuredText",
+        "value": [
+          {
+          "type": "paragraph",
+          "text": "The taste of pure vanilla is very hard to tame, and therefore, most cooks resort to substitutes. It takes a high-skill chef to know how to get the best of tastes, and Les Bonnes Choses's vanilla macaron does just that. The result is more than a success, it simply is a gastronomic piece of art.",
+          "spans": [
+            {
+            "start": 97,
+            "end": 167,
+            "type": "strong"
+          },
+          {
+            "start": 167,
+            "end": 184,
+            "type": "strong"
+          },
+          {
+            "start": 167,
+            "end": 184,
+            "type": "em"
+          },
+          {
+            "start": 184,
+            "end": 217,
+            "type": "strong"
+          }
+          ]
+        }
+        ]
+      }
+      ]
+    }
+  }
+}