prismic.io 1.0.0.preview.1

data/lib/prismic/version.rb

@@ -0,0 +1,5 @@
+module Prismic
+
+  VERSION = "1.0.0.preview.1"
+
+end

data/prismic.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'prismic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "prismic.io"
+  spec.version       = Prismic::VERSION
+  spec.authors       = ["Étienne Vallette d'Osia", "Samy Dindane"]
+  spec.email         = ["evo@zenexity.com"]
+  spec.description   = %q{The standard Prismic.io's API library.}
+  spec.summary       = %q{Prismic.io development kit}
+  spec.homepage      = "http://prismic.io"
+  spec.license       = "Apache-2"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "yajl-ruby", "~> 1.1"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "nokogiri", "~> 1.6"
+  spec.add_development_dependency "simplecov", "~> 0.7"
+end

data/spec/fragments_spec.rb

@@ -0,0 +1,372 @@
+require 'spec_helper'
+
+describe 'WebLink' do
+  describe 'as_html' do
+    before do
+      @web_link = Prismic::Fragments::WebLink.new('my_url')
+    end
+
+    it "returns an <a> HTML element" do
+      Nokogiri::XML(@web_link.as_html).child.name.should == 'a'
+    end
+
+    it "returns a HTML element with an href attribute" do
+      Nokogiri::XML(@web_link.as_html).child.has_attribute?('href').should be_true
+    end
+
+    it "returns a HTML element with an href attribute pointing to the url" do
+      Nokogiri::XML(@web_link.as_html).child.attribute('href').value.should == 'my_url'
+    end
+
+    it "returns a HTML element whose content is the link" do
+      Nokogiri::XML(@web_link.as_html).child.content.should == 'my_url'
+    end
+  end
+end
+
+describe 'MediaLink' do
+  describe 'as_html' do
+    before do
+      @media_link = Prismic::Fragments::MediaLink.new('my_url')
+    end
+
+    it "returns an <a> HTML element" do
+      Nokogiri::XML(@media_link.as_html).child.name.should == 'a'
+    end
+
+    it "returns a HTML element with an href attribute" do
+      Nokogiri::XML(@media_link.as_html).child.has_attribute?('href').should be_true
+    end
+
+    it "returns a HTML element with an href attribute pointing to the url" do
+      Nokogiri::XML(@media_link.as_html).child.attribute('href').value.should == 'my_url'
+    end
+
+    it "returns a HTML element whose content is the link" do
+      Nokogiri::XML(@media_link.as_html).child.content.should == 'my_url'
+    end
+  end
+end
+
+describe 'Text' do
+  describe 'as_html' do
+    before do
+      @text = Prismic::Fragments::Text.new('my_value')
+    end
+
+    it "returns a <span> HTML element" do
+      Nokogiri::XML(@text.as_html).child.name.should == 'span'
+    end
+
+    it "returns a HTML element with the 'text' class" do
+      Nokogiri::XML(@text.as_html).child.attribute('class').value.split.should include 'text'
+    end
+
+    it "returns a HTML element whose content is the value" do
+      Nokogiri::XML(@text.as_html).child.content.should == 'my_value'
+    end
+  end
+end
+
+describe 'Select' do
+  describe 'as_html' do
+    before do
+      @select = Prismic::Fragments::Select.new('my_value')
+    end
+
+    it "returns a <span> HTML element" do
+      Nokogiri::XML(@select.as_html).child.name.should == 'span'
+    end
+
+    it "returns a HTML element with the 'text' class" do
+      Nokogiri::XML(@select.as_html).child.attribute('class').value.split.should include 'text'
+    end
+
+    it "returns a HTML element whose content is the value" do
+      Nokogiri::XML(@select.as_html).child.content.should == 'my_value'
+    end
+  end
+end
+
+describe 'Date' do
+  before do
+    @date = Prismic::Fragments::Date.new(DateTime.new(2013, 8, 7, 11, 13, 7, '+2'))
+  end
+
+  describe 'as_html' do
+    it "returns a <time> HTML element" do
+      Nokogiri::XML(@date.as_html).child.name.should == 'time'
+    end
+
+    it "returns a HTML element whose content is the date in the ISO8601 format" do
+      Nokogiri::XML(@date.as_html).child.content.should == '2013-08-07T11:13:07.000+02:00'
+    end
+  end
+end
+
+describe 'Number' do
+  before do
+    @number = Prismic::Fragments::Number.new(10.2)
+  end
+
+  describe 'as_int' do
+    it "returns an Integer" do
+      @number.as_int.should be_kind_of Integer
+    end
+
+    it "returns the integer representation of the number" do
+      @number.as_int.should == 10
+    end
+  end
+
+  describe 'as_html' do
+    it "returns a <span> HTML element" do
+      Nokogiri::XML(@number.as_html).child.name.should == 'span'
+    end
+
+    it "returns a HTML element with the class 'number'" do
+      Nokogiri::XML(@number.as_html).child.attribute('class').value.split.should include 'number'
+    end
+
+    it "returns a HTML element whose content is the value" do
+      Nokogiri::XML(@number.as_html).child.content.should == 10.2.to_s
+    end
+  end
+end
+
+describe 'Color' do
+  before do
+    @hex_value = '00FF99'
+    @color = Prismic::Fragments::Color.new(@hex_value)
+  end
+
+  describe 'asRGB' do
+    it "returns a hash" do
+      @color.asRGB.should be_kind_of Hash
+    end
+
+    it "returns a hash of 3 elements" do
+      @color.asRGB.size.should == 3
+    end
+
+    it "returns the correct red value" do
+      @color.asRGB['red'].should == 0
+    end
+
+    it "returns the correct green value" do
+      @color.asRGB['green'].should == 255
+    end
+
+    it "returns the correct blue value" do
+      @color.asRGB['blue'].should == 153
+    end
+  end
+
+  describe 'self.asRGB' do
+    before do
+      @color = Prismic::Fragments::Color
+    end
+
+    it "returns a hash" do
+      @color.asRGB(@hex_value).should be_kind_of Hash
+    end
+
+    it "returns a hash of 3 elements" do
+      @color.asRGB(@hex_value).size.should == 3
+    end
+
+    it "returns the correct red value" do
+      @color.asRGB(@hex_value)['red'].should == 0
+    end
+
+    it "returns the correct green value" do
+      @color.asRGB(@hex_value)['green'].should == 255
+    end
+
+    it "returns the correct blue value" do
+      @color.asRGB(@hex_value)['blue'].should == 153
+    end
+  end
+
+  describe 'as_html' do
+    it "returns a <span> HTML element" do
+      Nokogiri::XML(@color.as_html).child.name.should == 'span'
+    end
+
+    it "returns a HTML element with the class 'color'" do
+      Nokogiri::XML(@color.as_html).child.attribute('class').value.split.should include 'color'
+    end
+
+    it "returns a HTML element whose content is the value" do
+      Nokogiri::XML(@color.as_html).child.content.should == "##@hex_value"
+    end
+  end
+
+  describe 'self.valid?' do
+    it "returns true if the color is valid" do
+      Prismic::Fragments::Color.valid?(@hex_value).should be_true
+    end
+
+    it "returns false if the color is not valid" do
+      Prismic::Fragments::Color.valid?("I'm a murloc").should be_false
+    end
+  end
+end
+
+describe 'Embed' do
+  before do
+    @embed = Prismic::Fragments::Embed.new(
+      'MY_TYPE',
+      'MY_PROVIDER',
+      'my_url',
+      'my_html',
+      'my_oembed_json'
+    )
+  end
+
+  describe 'as_html' do
+    it "returns a div element" do
+      Nokogiri::XML(@embed.as_html).child.name.should == 'div'
+    end
+
+    it "returns an element with a data-oembed attribute" do
+      Nokogiri::XML(@embed.as_html).child.has_attribute?('data-oembed').should be_true
+    end
+
+    it "returns an element with a data-oembed attribute containing the url" do
+      Nokogiri::XML(@embed.as_html).child.attribute('data-oembed').value.should == 'my_url'
+    end
+
+    it "returns an element with a data-oembed-type attribute" do
+      Nokogiri::XML(@embed.as_html).child.has_attribute?('data-oembed-type').should be_true
+    end
+
+    it "returns an element with a data-oembed-type attribute containing the type in lowercase" do
+      Nokogiri::XML(@embed.as_html).child.attribute('data-oembed-type').value.should == 'my_type'
+    end
+
+    it "returns an element with a data-oembed-provider attribute" do
+      Nokogiri::XML(@embed.as_html).child.has_attribute?('data-oembed-provider').should be_true
+    end
+
+    it "returns an element with a data-oembed-provider attribute containing the provider in lowercase" do
+      Nokogiri::XML(@embed.as_html).child.attribute('data-oembed-provider').value.should == 'my_provider'
+    end
+
+    it "returns an element wrapping the `html` value" do
+      Nokogiri::XML(@embed.as_html).child.content.should == 'my_html'
+    end
+  end
+end
+
+describe 'Image::View' do
+  before do
+    @url = 'my_url'
+    @width = 10
+    @height = 2
+    @view = Prismic::Fragments::Image::View.new(@url, @width, @height)
+  end
+
+  describe 'ratio' do
+    it "returns the width/height ratio of the image" do
+      @view.ratio.should == @width / @height
+    end
+  end
+
+  describe 'as_html' do
+    it "return an <img> HTML element" do
+      Nokogiri::XML(@view.as_html).child.name.should == 'img'
+    end
+
+    it "returns an element whose `src` attribute equals the url" do
+      Nokogiri::XML(@view.as_html).child.attribute('src').value.should == @url
+    end
+
+    it "returns an element whose `width` attribute equals the width" do
+      Nokogiri::XML(@view.as_html).child.attribute('width').value.should == @width.to_s
+    end
+
+    it "returns an element whose `height` attribute equals the height" do
+      Nokogiri::XML(@view.as_html).child.attribute('height').value.should == @height.to_s
+    end
+  end
+end
+
+describe 'Image' do
+  before do
+    @main_view = Prismic::Fragments::Image::View.new('my_url', 10, 10)
+    @another_view = Prismic::Fragments::Image::View.new('my_url2', 20, 20)
+    @image = Prismic::Fragments::Image.new(@main_view, { 'another_view' => @another_view })
+  end
+
+  describe 'get_view' do
+    it "returns `main`'s value is asked for`" do
+      @image.get_view('main').should == @main_view
+    end
+
+    it "returns the value of the specified key" do
+      @image.get_view('another_view').should == @another_view
+    end
+
+    it "raises an error if the key does not exist" do
+      expect { @image.get_view('foo') }.to raise_error Prismic::Fragments::Image::ViewDoesNotExistException
+    end
+  end
+
+  describe 'as_html' do
+    it "returns the HTML representation of the main view" do
+      Nokogiri::XML(@image.as_html).child.name.should == Nokogiri::XML(@main_view.as_html).child.name
+      Nokogiri::XML(@image.as_html).child.attribute('src').value.should == Nokogiri::XML(@main_view.as_html).child.attribute('src').value
+      Nokogiri::XML(@image.as_html).child.attribute('width').value.should == Nokogiri::XML(@main_view.as_html).child.attribute('width').value
+      Nokogiri::XML(@image.as_html).child.attribute('height').value.should == Nokogiri::XML(@main_view.as_html).child.attribute('height').value
+    end
+  end
+end
+
+describe 'StructuredText::Image' do
+  before do
+    @view = Prismic::Fragments::Image::View.new('my_url', 10, 10)
+    @image = Prismic::Fragments::StructuredText::Block::Image.new(@view)
+  end
+
+  describe 'url' do
+    it "returns the view's url" do
+      @image.url.should == @view.url
+    end
+  end
+
+  describe 'width' do
+    it "returns the view's width" do
+      @image.width.should == @view.width
+    end
+  end
+
+  describe 'height' do
+    it "returns the view's height" do
+      @image.height.should == @view.height
+    end
+  end
+end
+
+describe 'StructuredText::Span' do
+  describe 'as_html'
+end
+
+describe 'DocumentLink' do
+  describe 'as_html'
+end
+
+describe 'Multiple' do
+  before do
+    @multiple = Prismic::Fragments::Multiple.new
+  end
+
+  describe 'push' do
+    it "adds the element to the collection" do
+      @multiple.push(:something)
+      @multiple.size.should == 1
+      @multiple.push(:something_else)
+      @multiple.size.should == 2
+    end
+  end
+end

data/spec/json_parsers_spec.rb

@@ -0,0 +1,287 @@
+describe 'document_link_parser' do
+  before do
+    raw_json = <<json
+      {
+        "type": "Link.document",
+        "value": {
+          "document": {
+            "id": "UdUjvt_mqVNObPeO",
+            "type": "product",
+            "tags": ["Macaron"],
+            "slug": "dark-chocolate-macaron"
+          },
+          "isBroken": false
+        }
+      }
+json
+    @json = JSON.parse(raw_json)
+  end
+
+  it "correctly parses DocumentLinks" do
+    document_link = Prismic::JsonParser.document_link_parser(@json)
+    document_link.id.should == "UdUjvt_mqVNObPeO"
+    document_link.link_type.should == "product"
+    document_link.tags.should == ['Macaron']
+    document_link.slug.should == "dark-chocolate-macaron"
+    document_link.broken?.should == false
+  end
+end
+
+describe 'text_parser' do
+  before do
+    raw_json = <<json
+    {
+      "type": "Text",
+      "value": "New York City, NY"
+    }
+json
+    @json = JSON.parse(raw_json)
+  end
+
+  it "correctly parses Text objects" do
+    text = Prismic::JsonParser.text_parser(@json)
+    text.value.should == "New York City, NY"
+  end
+end
+
+describe 'web_link_parser' do
+  before do
+    raw_json = <<json
+    {
+      "type": "Link.web",
+      "value": {
+        "url": "http://prismic.io"
+      }
+    }
+json
+    @json = JSON.parse(raw_json)
+  end
+
+  it "correctly parses WebLinks objects" do
+    web_link = Prismic::JsonParser.web_link_parser(@json)
+    web_link.url.should == "http://prismic.io"
+  end
+end
+
+describe 'date_parser' do
+  before do
+    raw_json = <<json
+    {
+      "type": "date",
+      "value": "2013-09-19"
+    }
+json
+    @json = JSON.parse(raw_json)
+  end
+
+  it "correctly parses Date objects" do
+    date = Prismic::JsonParser.date_parser(@json)
+    date.value.should == Time.new(2013, 9, 19)
+  end
+end
+
+describe 'number_parser' do
+  before do
+    raw_json = <<json
+    {
+      "type": "Number",
+      "value": 3.55
+    }
+json
+    @json = JSON.parse(raw_json)
+  end
+
+  it "correctly parses Number objects" do
+    number = Prismic::JsonParser.number_parser(@json)
+    number.value.should == 3.55
+  end
+end
+
+describe 'embed_parser' do
+  before do
+    @embed_type = "rich"
+    @provider = "GitHub"
+    @url = "https://gist.github.com"
+    @html = '<script src="https://gist.github.com/dohzya/6762845.js"></script>'
+    raw_json = <<json
+    {
+      "type": "embed",
+      "value": {
+        "oembed": {
+          "version": "1.0",
+          "type": #{@embed_type.to_json},
+          "provider_name": #{@provider.to_json},
+          "provider_url": #{@url.to_json},
+          "html": #{@html.to_json},
+          "gist": "dohzya/6762845",
+          "embed_url": "https://gist.github.com/dohzya/6762845",
+          "title": "dohzya/gist:6762845"
+        }
+      }
+    }
+json
+    @json = JSON.parse(raw_json)
+  end
+
+  it "correctly parses Embed objects" do
+    embed = Prismic::JsonParser.embed_parser(@json)
+    embed.embed_type.should == @embed_type
+    embed.provider.should == @provider
+    embed.url.should == @url
+    embed.html.should == @html
+  end
+end
+
+describe 'image_parser' do
+  before do
+    raw_json = <<json
+    {
+      "type": "Image",
+      "value": {
+        "main": {
+          "url": "url1",
+          "dimensions": {
+            "width": 500,
+            "height": 500
+          }
+        },
+        "views": {
+          "icon": {
+            "url": "url2",
+              "dimensions": {
+                "width": 250,
+                "height": 250
+              }
+          }
+        }
+      }
+    }
+json
+    @json = JSON.parse(raw_json)
+  end
+
+  it "correctly parses Image objects" do
+    image = Prismic::JsonParser.image_parser(@json)
+    image.main.url.should == "url1"
+    image.main.width.should == 500
+    image.main.height.should == 500
+    image.views[0].url.should == "url2"
+    image.views[0].width.should == 250
+    image.views[0].height.should == 250
+  end
+end
+
+describe 'color_parser' do
+  before do
+    raw_json = <<json
+    {
+      "type": "Color",
+      "value": "#ffeacd"
+    }
+json
+    @json = JSON.parse(raw_json)
+  end
+
+  it "correctly parses Color objects" do
+    color = Prismic::JsonParser.color_parser(@json)
+    color.value.should == "ffeacd"
+  end
+end
+
+describe 'structured_text_parser' do
+  before do
+    raw_json_paragraph = File.read("#{File.dirname(__FILE__)}/responses_mocks/structured_text_paragraph.json")
+    json_paragraph = JSON.parse(raw_json_paragraph)
+    @structured_text_paragraph = Prismic::JsonParser.structured_text_parser(json_paragraph)
+
+    raw_json_heading = File.read("#{File.dirname(__FILE__)}/responses_mocks/structured_text_heading.json")
+    json_heading = JSON.parse(raw_json_heading)
+    @structured_text_heading = Prismic::JsonParser.structured_text_parser(json_heading)
+  end
+
+  describe 'headings parsing' do
+    it "correctly parses headings" do
+      @structured_text_heading.blocks[0].should be_a Prismic::Fragments::StructuredText::Block::Heading
+      @structured_text_heading.blocks[0].text.should == "Salted Caramel Macaron"
+      @structured_text_heading.blocks[0].level.should == 1
+    end
+
+    it "parses all the spans" do
+      @structured_text_heading.blocks[0].spans.size.should == 1
+    end
+  end
+
+  describe 'paragraphs parsing' do
+    it "correctly parses paragraphs" do
+      @structured_text_paragraph.blocks[0].should be_a Prismic::Fragments::StructuredText::Block::Paragraph
+      @structured_text_paragraph.blocks[0].text.size.should == 224
+    end
+  end
+
+  describe 'spans parsing' do
+    it "parses all the spans" do
+      @structured_text_paragraph.blocks[0].spans.size.should == 3
+    end
+
+    it "correctly parses the em spans" do
+      @structured_text_paragraph.blocks[0].spans[0].start.should == 103
+      @structured_text_paragraph.blocks[0].spans[0].end.should == 137
+      @structured_text_paragraph.blocks[0].spans[0].should be_a Prismic::Fragments::StructuredText::Span::Em
+    end
+
+    it "correctly parses the strong spans" do
+      @structured_text_paragraph.blocks[0].spans[2].should be_a Prismic::Fragments::StructuredText::Span::Strong
+    end
+
+    it "correctly parses the hyperlink spans" do
+      @structured_text_paragraph.blocks[0].spans[1].should be_a Prismic::Fragments::StructuredText::Span::Hyperlink
+      @structured_text_paragraph.blocks[0].spans[1].link.should be_a Prismic::Fragments::WebLink
+    end
+  end
+end
+
+describe 'document_parser' do
+  before do
+    raw_json = File.read("#{File.dirname(__FILE__)}/responses_mocks/document.json")
+    json = JSON.parse(raw_json)
+    @document = Prismic::JsonParser.document_parser(json)
+  end
+
+  it "correctly parses Document objects" do
+    @document.id.should == 'UdUkXt_mqZBObPeS'
+    @document.type.should == 'product'
+    @document.href.should == 'doc-url'
+    @document.tags.should == ['Macaron']
+    @document.slugs.should == ['vanilla-macaron']
+  end
+
+  it "correctly parses the document's fragments" do
+    @document.fragments.size.should == 11
+    @document.fragments['name'].should be_a Prismic::Fragments::StructuredText
+  end
+end
+
+describe 'multiple_parser' do
+  before do
+    raw_json = <<json
+      [
+        {
+          "type": "Text",
+          "value": "foo"
+        },
+        {
+          "type": "Text",
+          "value": "bar"
+        }
+      ]
+json
+    @json = JSON.parse(raw_json)
+  end
+
+  it "correctly parses the Multiple object's elements" do
+    multiple = Prismic::JsonParser.multiple_parser(@json)
+    multiple.size.should == 2
+    multiple[0].class.should == Prismic::Fragments::Text
+    multiple[0].class.should == Prismic::Fragments::Text
+  end
+end