prismic.io 1.0.0.preview.5 → 1.0.0.preview.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e3f3af94b5219971b0b0dbdd62b195a0bb9a5ae
-  data.tar.gz: 157a7210a64dbf0e1a3f5de9b722b6222c7002a5
+  metadata.gz: 48b555e3c575061f3461b396c1739459780a690d
+  data.tar.gz: ec67ac158b329572e7a65e76be77bf5464139c4f
 SHA512:
-  metadata.gz: 88eb3ea747a31a8226c3fb5f5c364e046e85e08013061510d7f5d55eb369bed64e56ef86bcb2f72220134975923fd7ea8becd557303823efc4e6ef9462cc3a95
-  data.tar.gz: 870e6c272bd7efe97346cdc4186e533a4332c5e2c940e30e183949278b89ccdf22d68942e3731d8d7f4ca61add02119b9ac60659ec7f332f7636a24f67c112d9
+  metadata.gz: b1f78ed016ec55f62dd5538f688f9ad887cfcb6cf7351840ba1ef2f7f85ab040ace75cd2caebb1546c4d43f1b856acea88d7f33b418a440a31e4910a1f299ba9
+  data.tar.gz: b523de93f12d9c831ce127cad7629682d4cd4d481ef785c9eaac098e7e95c4b3f038e1392f6d28b021b7c1e47ab5c91a088f14d3c2c935eb88a45bdd93392499

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    prismic.io (1.0.0.preview.4)
+    prismic.io (1.0.0.preview.6)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -28,9 +28,15 @@ then add in your code:
 require 'prismic'
 ```
 
-#### API Documentation
+#### Kit Documentation
 
-You can browse the [API Documentation](https://developers.prismic.io/documentation/UjBe8bGIJ3EKtgBZ/api-documentation).
+You should check out [the "Kits and helpers" section of our API documentation](https://developers.prismic.io/documentation/UjBe8bGIJ3EKtgBZ/api-documentation#kits-and-helpers), which sets general information about how our kits work. The Ruby kit is mostly compliant with it, but contains some mild differences:
+
+ * The api object's type is Prismic::API, and the name of the method to retrieve the master ref is gotten by `api.master_ref`.
+ * There's no `ctx` object to pass around; the context is passed in different ways.
+ * From the api object, getting a form is done through the `create_search_form` method; a basic querying therefore looks like this: `api.create_search_form("everything").query("[[:d = at(document.type, \"product\")]]").submit(ref)`
+ * Advice: the `%()` Ruby notation for strings is great for queries, as they may include quotes and/or double-quotes. The above querying is therefore even better this way: `api.create_search_form("everything").query(%([[:d = at(document.type, "product")]])).submit(ref)`
+ * Accessing type-dependent fields from a `document` is done through a `fragments` hash. Printing the HTML version of a field therefore looks like `document.fragments["title_user_friendly"].as_html(link_resolver(ref)).html_safe`.
 
 #### Use it
 

data/lib/prismic/api.rb

@@ -1,33 +1,56 @@
 # encoding: utf-8
 module Prismic
   class API
-    attr_reader :json, :access_token
+    attr_reader :json, :access_token, :http_client
     attr_accessor :refs, :bookmarks, :forms, :master, :tags, :types, :oauth
 
-    def initialize(json, access_token=nil)
+    def initialize(json, access_token, http_client)
       @json = json
       @access_token = access_token
+      @http_client = http_client
       yield self if block_given?
       self.master = refs.values && refs.values.map { |ref| ref if ref.master? }.compact.first
       raise BadPrismicResponseError, "No master Ref found" unless master
     end
 
+    # Get a bookmark by its name
+    # @api
+    # @param  name [String] The bookmark's name
+    #
+    # @return [Hash] The bookmark
     def bookmark(name)
       bookmarks[name]
     end
 
+    # Get a {Ref reference} by its alias
+    # @api
+    # @param  name [String] The reference's alias
+    #
+    # @return [Ref] The reference
     def ref(name)
       refs[name.downcase]
     end
 
+    # Returns the master {Ref reference}
+    # @api
+    #
+    # @return [type] [description]
     def master_ref
       ref('master')
     end
 
+
     def form(name)
       forms[name]
     end
 
+    # Returns a {Prismic::SearchForm search form} by its name
+    # @api
+    # @param  name [String] The name of the form
+    # @param  data [Hash] Default values
+    # @param  ref [type] Default {Ref reference}
+    #
+    # @return [SearchForm] The search form
     def create_search_form(name, data={}, ref={})
       form = self.form(name)
       form and form.create_search_form(data, ref)
@@ -37,29 +60,26 @@ module Prismic
       @json
     end
 
-    def self.get(url, access_token=nil)
-      uri = URI(access_token ? "#{url}?access_token=#{access_token}" : url)
-      http = Net::HTTP.new(uri.host)
-      req = Net::HTTP::Get.new(uri.path, 'Accept' => 'application/json')
-      res = http.request(req)
-
-      if res.code == '200'
-        res
-      else
-        raise PrismicWSConnectionError, res
-      end
+    def self.get(url, access_token=nil, http_client=Prismic::DefaultHTTPClient)
+      data = {}
+      data["access_token"] = access_token if access_token
+      res = http_client.get(url, data, 'Accept' => 'application/json')
+      raise PrismicWSConnectionError, res unless res.code.to_s == '200'
+      res
     end
 
-    def self.start(url, access_token=nil)
-      resp = get(url, access_token)
+    def self.start(url, opts={})
+      http_client = opts[:http_client] || Prismic::DefaultHTTPClient
+      access_token = opts[:access_token]
+      resp = get(url, access_token, http_client)
       json = JSON.load(resp.body)
-      parse_api_response(json, access_token)
+      parse_api_response(json, access_token, http_client)
     end
 
-    def self.parse_api_response(data, access_token=nil)
+    def self.parse_api_response(data, access_token, http_client)
       data_forms = data['forms'] || []
       data_refs = data.fetch('refs'){ raise BadPrismicResponseError, "No refs given" }
-      new(data, access_token) {|api|
+      new(data, access_token, http_client) {|api|
         api.bookmarks = data['bookmarks']
         api.forms = Hash[data_forms.map { |k, form|
           [k, Form.new(

data/lib/prismic/fragments/image.rb

@@ -26,12 +26,14 @@ module Prismic
       class ViewDoesNotExistException < Error ; end
 
       class View
-        attr_accessor :url, :width, :height
+        attr_accessor :url, :width, :height, :alt, :copyright
 
-        def initialize(url, width, height)
+        def initialize(url, width, height, alt, copyright)
           @url = url
           @width = width
           @height = height
+          @alt = alt
+          @copyright = copyright
         end
 
         def ratio
@@ -39,7 +41,7 @@ module Prismic
         end
 
         def as_html(link_resolver=nil)
-          %(<img src="#@url" width="#@width" height="#@height" />)
+          %(<img src="#@url" alt="#@alt" width="#@width" height="#@height" />)
         end
 
       end

data/lib/prismic/fragments/structured_text.rb

@@ -47,6 +47,21 @@ module Prismic
         }.join("\n\n")
       end
 
+      # Finds the first highest title in a structured text
+      def first_title
+        max_level = 6 # any title with a higher level kicks the current one out
+        title = false
+        @blocks.each do |block|
+          if block.is_a?(Prismic::Fragments::StructuredText::Block::Heading)
+            if block.level < max_level
+              title = block.text
+              max_level = block.level # new maximum
+            end
+          end
+        end
+        title
+      end
+
       class Span
         attr_accessor :start, :end
 
@@ -184,6 +199,14 @@ module Prismic
             @view.height
           end
 
+          def alt
+            @view.alt
+          end
+
+          def copyright
+            @view.copyright
+          end
+
           def as_html(link_resolver)
             view.as_html(link_resolver)
           end

data/lib/prismic/json_parsers.rb

@@ -63,12 +63,15 @@ module Prismic
         def self.view_parser(json)
           Prismic::Fragments::Image::View.new(json['url'],
                                               json['dimensions']['width'],
-                                              json['dimensions']['height'])
+                                              json['dimensions']['height'],
+                                              json['alt'],
+                                              json['copyright'])
         end
 
         main  = view_parser(json['value']['main'])
-        views = json['value']['views'].map do |name, view|
-          view_parser(view)
+        views = {}
+        json['value']['views'].each do |name, view|
+          views[name] = view_parser(view)
         end
 
         Prismic::Fragments::Image.new(main, views)
@@ -126,7 +129,9 @@ module Prismic
             view = Prismic::Fragments::Image::View.new(
               block['url'],
               block['dimensions']['width'],
-              block['dimensions']['height']
+              block['dimensions']['height'],
+              block['alt'],
+              block['copyright']
             )
             Prismic::Fragments::StructuredText::Block::Image.new(view)
           when 'embed'
@@ -154,22 +159,23 @@ module Prismic
       end
 
       def document_parser(json)
-        fragments = Hash[json['data'].values.first.map do |name, fragment|
+        data_json = json['data'].values.first  # {"doc_type": data}
+        fragments = Hash[data_json.map { |name, fragment|
           if fragment.is_a? Array
             [name, multiple_parser(fragment)]
           else
             [name, parsers[fragment['type']].call(fragment)]
           end
-        end]
+        }]
 
         Prismic::Document.new(json['id'], json['type'], json['href'], json['tags'],
                               json['slugs'], fragments)
       end
 
-      def results_parser(results)
-        results = results['results'] unless results.is_a?(Array)
-        results.map do |doc|
-          raise FormSearchException, "Error : #{doc['error']}" if doc.include?('error')
+      def results_parser(result)
+        result = {'results' => result} if result.is_a?(Array)
+        raise FormSearchException, "Error : #{result['error']}" if result['error']
+        result['results'].map do |doc|
           document_parser(doc)
         end
       end

data/lib/prismic/version.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Prismic
 
-  VERSION = "1.0.0.preview.5"
+  VERSION = "1.0.0.preview.6"
 
 end

data/lib/prismic.rb

@@ -11,6 +11,11 @@ module Prismic
       msg ? super(msg) : msg
       @cause = cause
     end
+
+    # Return the full trace of the error (including nested errors)
+    # @param  e=self Parent error (don't use)
+    #
+    # @return [String] The trace
     def full_trace(e=self)
       first, *backtrace = e.backtrace
       msg = e == self ? "" : "Caused by "
@@ -22,21 +27,51 @@ module Prismic
     end
   end
 
-  def self.api(*args)
-    API.start(*args)
+  # Return an API instance
+  # @api
+  #
+  # The access token and HTTP client can be provided.
+  #
+  # The HTTP Client must responds to same method than {DefaultHTTPClient}.
+  #
+  # @param url [String] The URL of the prismic.io repository
+  # @param [String] access_token The access token
+  # @param [Hash] opts The options
+  # @option opts [String] :access_token (nil) The access_token
+  # @option opts :http_client (DefaultHTTPClient) The HTTP client to use
+  #
+  # @overload api(url, opts=nil)
+  #   Standard use
+  # @overload api(url, access_token)
+  #   Provide the access_token (only)
+  #
+  # @return [API] The API instance related to this repository
+  def self.api(url, opts=nil)
+    opts ||= {}
+    opts = {access_token: opts} if opts.is_a?(String)
+    API.start(url, opts)
   end
 
   class ApiData
     attr_accessor :refs, :bookmarks, :types, :tags, :forms
   end
 
+
+  # A SearchForm represent a Form returned by the prismic.io API.
+  #
+  # These forms depend on the prismic.io repository, and can be fill and send
+  # in the same way than regular HTML forms.
+  #
+  # Get SearchForm instance through the {API#create_search_form} method.
   class SearchForm
     attr_accessor :api, :form, :data, :ref
 
     def initialize(api, form, data={}, ref=nil)
       @api = api
       @form = form
-      @data = form.default_data.merge(data)
+      @data = {}
+      form.default_data.each { |key, value| set(key, value) }
+      data.each { |key, value| set(key, value) }
       @ref = ref
     end
 
@@ -64,55 +99,81 @@ module Prismic
       form.fields
     end
 
-    def submit(ref = @ref)
+    # Submit the form
+    # @api
+    #
+    # @note The reference MUST be defined, either by setting it at
+    #       {API#create_search_form creation}, by using the {#ref} method or by
+    #       providing the ref parameter.
+    #
+    # @param  ref [Ref, String] The {Ref reference} to use (if not already defined)
+    #
+    # @return [type] [description]
+    def submit(ref = nil)
+      self.ref(ref) if ref
       raise NoRefSetException unless @ref
 
       if form_method == "GET" && enctype == "application/x-www-form-urlencoded"
-        data['ref'] = ref
+        data['ref'] = @ref
         data['access_token'] = api.access_token if api.access_token
         data.delete_if { |k, v| v.nil? }
 
-        uri = URI(action)
-        uri.query = URI.encode_www_form(data)
-
-        request = Net::HTTP::Get.new(uri.request_uri)
-        request.add_field('Accept', 'application/json')
-
-        response = Net::HTTP.new(uri.host, uri.port).start do |http|
-          http.request(request)
+        response = api.http_client.get(action, data, 'Accept' => 'application/json')
+
+        if response.code.to_s == "200"
+          Prismic::JsonParser.results_parser(JSON.parse(response.body))
+        else
+          body = JSON.parse(response.body) rescue nil
+          error = body.is_a?(Hash) ? body['error'] : response.body
+          raise AuthenticationException, error if response.code.to_s == "401"
+          raise AuthorizationException, error if response.code.to_s == "403"
+          raise RefNotFoundException, error if response.code.to_s == "404"
+          raise FormSearchException, error
         end
-
-        raise RefNotFoundException, "Ref #{ref} not found" if response.code == "404"
-
-        raise FormSearchException, "Error : #{response.body}" if response.code != "200"
-
-        Prismic::JsonParser.results_parser(JSON.parse(response.body))
       else
         raise UnsupportedFormKind, "Unsupported kind of form: #{form_method} / #{enctype}"
       end
     end
 
+    # Specify a query for this form
+    # @api
+    # @param  query [String] The query
+    #
+    # @return [SearchForm] self
     def query(query)
       set('q', query)
-      self
     end
 
+    # Specify a parameter for this form
+    # @param  field_name [String] The parameter's name
+    # @param  value [String] The parameter's value
+    #
+    # @return [SearchForm] self
     def set(field_name, value)
       field = @form.fields[field_name]
-      if field.repeatable?
+      if field && field.repeatable?
         data[field_name] = [] unless data.include? field_name
         data[field_name] << value
       else
         data[field_name] = value
       end
+      self
     end
 
+    # Set the {Ref reference} to use
+    # @api
+    # @param  ref [Ref, String] The {Ref reference} to use
+    #
+    # @return [SearchForm] self
     def ref(ref)
-      @ref = ref
+      @ref = ref.is_a?(Ref) ? ref.ref : ref
+      self
     end
 
     class NoRefSetException < Error ; end
     class UnsupportedFormKind < Error ; end
+    class AuthorizationException < Error ; end
+    class AuthenticationException < Error ; end
     class RefNotFoundException < Error ; end
     class FormSearchException < Error ; end
   end
@@ -151,6 +212,27 @@ module Prismic
       }.join("\n")
     end
 
+    # Finds the first highest title in a document
+    #
+    # It is impossible to reuse the StructuredText.first_title method, since we need to test the highest title across the whole document
+    def first_title
+      title = false
+      max_level = 6 # any title with a higher level kicks the current one out
+      @fragments.each do |_, fragment|
+        if fragment.is_a? Prismic::Fragments::StructuredText
+          fragment.blocks.each do |block|
+            if block.is_a?(Prismic::Fragments::StructuredText::Block::Heading)
+              if block.level < max_level
+                title = block.text
+                max_level = block.level # new maximum
+              end
+            end
+          end
+        end
+      end
+      title
+    end
+
     private
 
     def parse_fragments(fragments)
@@ -158,6 +240,12 @@ module Prismic
     end
   end
 
+
+  # Represent a prismic.io reference, a fix point in time.
+  #
+  # The references must be provided when accessing to any prismic.io resource
+  # (except /api) and allow to assert that the URL you use will always
+  # returns the same results.
   class Ref
     attr_accessor :ref, :label, :is_master, :scheduled_at
 
@@ -182,9 +270,51 @@ module Prismic
     end
   end
 
+  # Default HTTP client implementation, using the standard {Net::HTTP} library.
+  module DefaultHTTPClient
+    class << self
+      # Performs a GET call and returns the result
+      #
+      # The result must respond to
+      # - code: returns the response's HTTP status code (as number or String)
+      # - body: returns the response's body (as String)
+      def get(uri, data={}, headers={})
+        uri = URI(uri) if uri.is_a?(String)
+        uri.query = url_encode(data)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = uri.scheme =~ /https/i
+        http.get(uri.request_uri, headers)
+      end
+
+      def url_encode(data)
+        # Can't use URI.encode_www_form (doesn't support multi-values in 1.9.2)
+        encode = ->(k, v){ "#{k}=#{CGI::escape(v)}" }
+        data.map { |k, vs|
+          if vs.is_a?(Array)
+            vs.map{|v| encode.(k, v) }.join("&")
+          else
+            encode.(k, vs)
+          end
+        }.join("&")
+      end
+    end
+  end
+
+  # Build a {LinkResolver} instance
+  # @api
+  #
+  # The {LinkResolver} will help to build URL specific to an application, based
+  # on a generic prismic.io's {Fragments::DocumentLink Document link}.
+  #
+  # @param  ref [Ref] The ref to use
+  # @yieldparam  doc_link [Fragments::DocumentLink] A DocumentLink instance
+  # @yieldreturn [String] The application specific URL of the given document
+  #
+  # @return [LinkResolver] [description]
   def self.link_resolver(ref, &blk)
     LinkResolver.new(ref, &blk)
   end
+
 end
 
 require 'prismic/api'

data/spec/fragments_spec.rb

@@ -275,7 +275,7 @@ describe 'Image::View' do
     @url = 'my_url'
     @width = 10
     @height = 2
-    @view = Prismic::Fragments::Image::View.new(@url, @width, @height)
+    @view = Prismic::Fragments::Image::View.new(@url, @width, @height, "", "")
   end
 
   describe 'ratio' do
@@ -300,13 +300,23 @@ describe 'Image::View' do
     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
+
+    it "if set, returns an element whose `alt` attribute equals the alt" do
+      @alt = "Alternative text"
+      @view.alt = @alt
+      Nokogiri::XML(@view.as_html).child.attribute('alt').value.should == @alt
+    end
+
+    # it "if not set, alt attribute is absent" do
+    #   Nokogiri::XML(@view.as_html).child.attribute('alt').should == nil
+    # 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)
+    @main_view = Prismic::Fragments::Image::View.new('my_url', 10, 10, "Alternative", "CC-BY")
+    @another_view = Prismic::Fragments::Image::View.new('my_url2', 20, 20, "", "")
     @image = Prismic::Fragments::Image.new(@main_view, { 'another_view' => @another_view })
   end
 
@@ -330,10 +340,33 @@ describe 'Image' do
       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
+      Nokogiri::XML(@image.as_html).child.attribute('alt').value.should == Nokogiri::XML(@main_view.as_html).child.attribute('alt').value
     end
   end
 end
 
+describe 'StructuredText' do
+  before do
+    @structuredtext = Prismic::Fragments::StructuredText.new([
+      Prismic::Fragments::StructuredText::Block::Text.new("This is not a title", []),
+      Prismic::Fragments::StructuredText::Block::Heading.new("This is a title, but not the highest", [], 3),
+      Prismic::Fragments::StructuredText::Block::Heading.new("Document's title", [], 1),
+      Prismic::Fragments::StructuredText::Block::Text.new("This is not a title", [])
+    ])
+  end
+  it 'finds the text of the first block' do
+    @structuredtext.blocks[0].text.should == "This is not a title"
+  end
+  it 'finds the right title if exists' do
+    @structuredtext.first_title.should == "Document's title"
+  end
+  it 'returns false if no title' do
+    @structuredtext.blocks[1] = Prismic::Fragments::StructuredText::Block::Text.new("This is not a title either", [])
+    @structuredtext.blocks[2] = Prismic::Fragments::StructuredText::Block::Text.new("And this is not a title either", [])
+    @structuredtext.first_title.should == false
+  end
+end
+
 describe 'StructuredText::Heading' do
   before do
     @text = "This is a simple test."
@@ -393,7 +426,7 @@ end
 
 describe 'StructuredText::Image' do
   before do
-    @view = Prismic::Fragments::Image::View.new('my_url', 10, 10)
+    @view = Prismic::Fragments::Image::View.new('my_url', 10, 10, "Aternative", "CC-BY")
     @image = Prismic::Fragments::StructuredText::Block::Image.new(@view)
   end
 
@@ -414,6 +447,18 @@ describe 'StructuredText::Image' do
       @image.height.should == @view.height
     end
   end
+
+  describe 'alt' do
+    it "returns the view's alt" do
+      @image.alt.should == @view.alt
+    end
+  end
+
+  describe 'copyright' do
+    it "returns the view's copyright" do
+      @image.copyright.should == @view.copyright
+    end
+  end
 end
 
 describe 'StructuredText::Hyperlink' do

data/spec/json_parsers_spec.rb

@@ -141,6 +141,8 @@ describe 'image_parser' do
       "value": {
         "main": {
           "url": "url1",
+          "alt" : "Alternative",
+          "copyright" : "CC-BY",
           "dimensions": {
             "width": 500,
             "height": 500
@@ -149,6 +151,8 @@ describe 'image_parser' do
         "views": {
           "icon": {
             "url": "url2",
+            "alt" : "Alternative2",
+            "copyright" : "CC-0",
               "dimensions": {
                 "width": 250,
                 "height": 250
@@ -166,9 +170,13 @@ 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
+    image.main.alt.should == "Alternative"
+    image.main.copyright.should == "CC-BY"
+    image.views['icon'].url.should == "url2"
+    image.views['icon'].width.should == 250
+    image.views['icon'].height.should == 250
+    image.views['icon'].alt.should == "Alternative2"
+    image.views['icon'].copyright.should == "CC-0"
   end
 end
 

data/spec/lesbonneschoses_spec.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe 'LesBonnesChoses' do
+	before do
+		@api = Prismic.api("https://lesbonneschoses.prismic.io/api", nil)
+		@master_ref = @api.master_ref
+	end
+
+	describe '/api' do
+		it "API works" do
+			@api.should_not be_nil
+		end
+	end
+
+	describe 'query' do
+		it "queries everything and returns 20 documents" do
+			@api.create_search_form("everything").submit(@master_ref).size.should == 20
+		end
+
+		it "queries macarons (using a predicate) and returns 7 documents" do
+			@api.create_search_form("everything")
+				.query(%([[:d = any(document.tags, ["Macaron"])]]))
+				.submit(@master_ref).size.should == 7
+		end
+
+		it "queries macarons (using a form) and returns 7 documents" do
+			@api.create_search_form("macarons").submit(@master_ref).size.should == 7
+		end
+
+		it "queries macarons or cupcakes (using a form + a predicate) and returns 11 documents" do
+			@api.create_search_form("products")
+				.query(%([[:d = any(document.tags, ["Cupcake", "Macaron"])]]))
+				.submit(@master_ref).size.should == 11
+		end		
+	end
+end

data/spec/prismic_spec.rb

@@ -5,7 +5,7 @@ describe 'Api' do
   before do
     json_representation = '{"foo": "bar"}'
     @oauth_initiate_url = "https://lesbonneschoses.prismic.io/auth"
-    @api = Prismic::API.new(json_representation){|api|
+    @api = Prismic::API.new(json_representation, nil, Prismic::DefaultHTTPClient){|api|
       api.bookmarks = {}
       api.tags = {}
       api.types = {}
@@ -17,7 +17,10 @@ describe 'Api' do
       }
       api.forms = {
         'form1' => Prismic::Form.new(@api, 'form1', {}, nil, nil, nil, nil),
-        'form2' => Prismic::Form.new(@api, 'form2', {}, nil, nil, nil, nil),
+        'form2' => Prismic::Form.new(@api, 'form2', {
+          'q' => Prismic::Field.new('string', '[[any(document.type, [\"product\"])]]', true),
+          'param1' => Prismic::Field.new('string', 'value1', false),
+        }, nil, nil, nil, nil),
         'form3' => Prismic::Form.new(@api, 'form3', {}, nil, nil, nil, nil),
         'form4' => Prismic::Form.new(@api, 'form4', {}, nil, nil, nil, nil),
       }
@@ -54,6 +57,14 @@ describe 'Api' do
       @form = @api.create_search_form('form2')
       @form.form.name.should == 'form2'
     end
+    it "store default value as simple value when the field is not repeatable" do
+      @form = @api.create_search_form('form2')
+      @form.data['param1'].should == 'value1'
+    end
+    it "store default value as array when the field is repeatable" do
+      @form = @api.create_search_form('form2')
+      @form.data['q'].should == ['[[any(document.type, [\"product\"])]]']
+    end
   end
 
   describe 'forms' do
@@ -72,20 +83,18 @@ describe 'Api' do
     before do
       @data = File.read("#{File.dirname(__FILE__)}/responses_mocks/api.json")
       @json = JSON.parse(@data)
-      @parsed = Prismic::API.parse_api_response(@json)
+      @parsed = Prismic::API.parse_api_response(@json, nil, Prismic::DefaultHTTPClient)
     end
 
     it "does not allow to be created without master Ref" do
       expect {
-        Prismic::API.parse_api_response({
-          "refs" => [],
-        })
+        Prismic::API.parse_api_response({"refs" => []}, nil, Prismic::DefaultHTTPClient)
       }.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({})
+        Prismic::API.parse_api_response({}, nil, Prismic::DefaultHTTPClient)
       }.to raise_error(Prismic::API::BadPrismicResponseError, "No refs given")
     end
 
@@ -225,6 +234,34 @@ describe 'Document' do
     }
   end
 
+  describe 'first_title' do
+    it "returns the right title" do
+      @document.fragments['field3'] = Prismic::Fragments::StructuredText.new([
+        Prismic::Fragments::StructuredText::Block::Text.new("This is not a title", []),
+        Prismic::Fragments::StructuredText::Block::Heading.new("This is a title, but not the highest", [], 3),
+        Prismic::Fragments::StructuredText::Block::Heading.new("This is the highest title of the fragment, but not the document", [], 2),
+        Prismic::Fragments::StructuredText::Block::Text.new("This is not a title", [])
+      ])
+      @document.fragments['field4'] = Prismic::Fragments::StructuredText.new([
+        Prismic::Fragments::StructuredText::Block::Text.new("This is not a title", []),
+        Prismic::Fragments::StructuredText::Block::Heading.new("This is a title, but not the highest", [], 3),
+        Prismic::Fragments::StructuredText::Block::Heading.new("This is the highest title of the document", [], 1),
+        Prismic::Fragments::StructuredText::Block::Text.new("This is not a title", [])
+      ])
+      @document.fragments['field5'] = Prismic::Fragments::StructuredText.new([
+        Prismic::Fragments::StructuredText::Block::Text.new("This is not a title", []),
+        Prismic::Fragments::StructuredText::Block::Heading.new("This is a title, but not the highest", [], 3),
+        Prismic::Fragments::StructuredText::Block::Heading.new("This is the highest title of the fragment, but not the document", [], 2),
+        Prismic::Fragments::StructuredText::Block::Text.new("This is not a title", [])
+      ])
+      @document.first_title.should == "This is the highest title of the document"
+    end
+
+    it "returns false if no title" do
+      @document.first_title.should == false
+    end
+  end
+
   describe 'slug' do
     it "returns the first slug if found" do
       @document.slug.should == 'my-slug'
@@ -253,7 +290,7 @@ end
 
 describe 'SearchForm' do
   before do
-    @field = Prismic::Field.new('String', ['foo'], true)
+    @field = Prismic::Field.new('String', 'foo', true)
     @api = nil
   end
 
@@ -265,7 +302,7 @@ describe 'SearchForm' do
   describe 'set() for queries' do
 
     it "append value for repeatable fields" do
-      @field = Prismic::Field.new('String', ['foo'], true)
+      @field = Prismic::Field.new('String', 'foo', true)
       @form = create_form('q' => @field)
       @form.set('q', 'bar')
       @form.data.should == { 'q' => ['foo', 'bar'] }  # test the 1st call

data/spec/responses_mocks/document.json

@@ -56,6 +56,8 @@
         "value": {
           "main": {
             "url": "https://wroomio.s3.amazonaws.com/lesbonneschoses/0417110ebf2dc34a3e8b7b28ee4e06ac82473b70.png",
+            "alt" : "Alternative text to image",
+            "copyright" : "CC-BY",
             "dimensions": {
               "width": 500,
               "height": 500
@@ -64,6 +66,8 @@
           "views": {
             "icon": {
               "url": "https://wroomio.s3.amazonaws.com/lesbonneschoses/babdc3421037f9af77720d8f5dcf1b84c912c6ba.png",
+              "alt" : "Alternative text to view",
+              "copyright" : "CC-BY",
               "dimensions": {
                 "width": 250,
                 "height": 250

data/spec/responses_mocks/fragments.json

@@ -60,6 +60,8 @@
         "value": {
           "main": {
             "url": "https://wroomio.s3.amazonaws.com/lesbonneschoses/0417110ebf2dc34a3e8b7b28ee4e06ac82473b70.png",
+            "alt" : "Alternative text to image",
+            "copyright" : "CC-BY",
             "dimensions": {
               "width": 500,
               "height": 500
@@ -68,6 +70,8 @@
           "views": {
             "icon": {
               "url": "https://wroomio.s3.amazonaws.com/lesbonneschoses/babdc3421037f9af77720d8f5dcf1b84c912c6ba.png",
+              "alt" : "Alternative text to view",
+              "copyright" : "CC-BY",
               "dimensions": {
                 "width": 250,
                 "height": 250

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prismic.io
 version: !ruby/object:Gem::Version
-  version: 1.0.0.preview.5
+  version: 1.0.0.preview.6
 platform: ruby
 authors:
 - Étienne Vallette d'Osia
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-07 00:00:00.000000000 Z
+date: 2013-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,6 +100,7 @@ files:
 - prismic.gemspec
 - spec/fragments_spec.rb
 - spec/json_parsers_spec.rb
+- spec/lesbonneschoses_spec.rb
 - spec/prismic_spec.rb
 - spec/responses_mocks/api.json
 - spec/responses_mocks/document.json
@@ -134,6 +135,7 @@ summary: Prismic.io development kit
 test_files:
 - spec/fragments_spec.rb
 - spec/json_parsers_spec.rb
+- spec/lesbonneschoses_spec.rb
 - spec/prismic_spec.rb
 - spec/responses_mocks/api.json
 - spec/responses_mocks/document.json