prismic.io 1.0.9 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f497718ba2bd089e57df07768002414936d16b88
-  data.tar.gz: ed6c0a61282b5103fa37944d46d404f75d5a54a8
+  metadata.gz: 08719b7d27a244af6b9b57a68aee5980db6aeb25
+  data.tar.gz: 7ba1a6bcb021a1fc6ba55cc15cd0ca196e440044
 SHA512:
-  metadata.gz: 83a15ad2f3f28020e0c36ca73a330f84e29103a914a190224e6006842d4985a676b9b6c8b9f94d5f040a3e63a280c66e56df04cd3082cb633d0519da8c613b9f
-  data.tar.gz: 4c549baab450a23a98f6101587a76e7364f93eff8c56b97a0534f738235a37cc47b8b9eaee8c08217d0bb847a31916e513494df35f96f55b55999e48a2f69e94
+  metadata.gz: c3b0b134abe08cc7a74e92fbf4ee9e2dd8ddc87795f36fa1cfcc0e2b20c4e4a0c5117f53ebc5b6cc601ff73ad8962d4863dd55ed04138e054eb2e24555fd506f
+  data.tar.gz: 4366750b86e6a3d109aaf99b65fbe6c13de48764af245a0b6f53f09745ab1cfdf67d40e1cf49af397c9aced0e206f0d1ec3acacb21443c824d65f07904ce70da

data/.travis.yml

@@ -4,7 +4,6 @@ rvm:
 - 2.1.0
 - 2.0.0
 - 1.9.3
-- 1.9.2
 - jruby-19mode
 script: bundle exec rspec spec
 notifications:
@@ -21,4 +20,3 @@ deploy:
   on:
     tags: true
     all_branches: true
-

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    prismic.io (1.0.9)
+    prismic.io (1.1.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -7,6 +7,8 @@
 
 ### Getting Started
 
+The prismic kit is compatible with Ruby 1.9.3 or later.
+
 #### Install the kit for your project
 
 *(Assuming that [Ruby is installed](https://www.ruby-lang.org/en/downloads/) on your computer, as well as [RubyGems](http://rubygems.org/pages/download))*
@@ -96,4 +98,3 @@ Copyright 2013 Zengularity (http://www.zengularity.com).
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.
 
 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-

data/lib/prismic.rb

@@ -191,6 +191,16 @@ module Prismic
     #   @param  page_size [String,Fixum] The page size
     #   @return [SearchForm] self
 
+    # @!method fetch(fields)
+    #   Restrict the document fragments to the specified fields
+    #   @param  fields [String] The fields separated by commas (,)
+    #   @return [SearchForm] self
+
+    # @!method fetch_links(fields)
+    #   Include the document fragments correspondong to the specified fields for DocumentLink
+    #   @param  fields [String] The fields separated by commas (,)
+    #   @return [SearchForm] self
+
     # Create the fields'helper methods
     def create_field_helper_method(name)
       return if name == 'ref'
@@ -415,21 +425,14 @@ module Prismic
     alias :size :length
   end
 
-  class LinkedDocument
-    attr_accessor :id, :slug, :type, :tags
+  class Document
+    include Prismic::WithFragments
 
-    def initialize(id, slug, type, tags)
-      @id = id
-      @slug = slug
-      @type = type
-      @tags = tags
-    end
-  end
-
-  class Document < Prismic::WithFragments
     # @return [String]
     attr_accessor :id
     # @return [String]
+    attr_accessor :uid
+    # @return [String]
     attr_accessor :type
     # @return [String]
     attr_accessor :href
@@ -437,31 +440,19 @@ module Prismic
     attr_accessor :tags
     # @return [Array<String>]
     attr_accessor :slugs
-    # @return [Array<LinkedDocument>]
-    attr_accessor :linked_documents
+    # @return [Array<Fragment>]
+    attr_accessor :fragments
 
-    def initialize(id, type, href, tags, slugs, linked_documents, fragments)
-      super(fragments)
+    def initialize(id, uid, type, href, tags, slugs, fragments)
       @id = id
+      @uid = uid
       @type = type
       @href = href
       @tags = tags
       @slugs = slugs
-      @linked_documents = linked_documents
+      @fragments = fragments
     end
 
-    # Get a document's field
-    # @return [Fragments::Fragment]
-    def [](field)
-      array = field.split('.')
-      if array.length != 2
-        raise ArgumentError, 'Argument should contain one dot. Example: product.price'
-      end
-      return nil if array[0] != self.type
-      fragments[array[1]]
-    end
-    alias :get :[]
-
     # Returns the document's slug
     #
     # @return [String]
@@ -532,7 +523,7 @@ module Prismic
       if doc.is_a? Prismic::Fragments::DocumentLink
         @blk.call(doc)
       elsif doc.is_a? Prismic::Document
-        doc_link = Prismic::Fragments::DocumentLink.new(doc.id, doc.type, doc.tags, doc.slug, false)
+        doc_link = Prismic::Fragments::DocumentLink.new(doc.id, doc.uid, doc.type, doc.tags, doc.slug, doc.fragments, false)
         @blk.call(doc_link)
       end
     end

data/lib/prismic/api.rb

@@ -104,14 +104,13 @@ module Prismic
     # @return [String] the URL to redirect the user to
     def preview_session(token, link_resolver, default_url)
       response = self.http_client.get(token, {}, 'Accept' => 'application/json')
-      if response.code.to_s == '200'
-        json = JSON.load(response.body)
-        documents = self.form('everything').query(Prismic::Predicates.at('document.id', json['mainDocument'])).submit(token)
-        if documents.results.size > 0
-          link_resolver.link_to(documents.results[0])
-        else
-          default_url
-        end
+      if response.code.to_s != '200'
+        return default_url
+      end
+      json = JSON.load(response.body)
+      documents = self.form('everything').query(Prismic::Predicates.at('document.id', json['mainDocument'])).submit(token)
+      if documents.results.size > 0
+        link_resolver.link_to(documents.results[0])
       else
         default_url
       end

data/lib/prismic/fragments/group.rb

@@ -2,6 +2,23 @@
 module Prismic
   module Fragments
 
+    class GroupDocument
+      include Prismic::WithFragments
+      attr_accessor :fragments
+
+      def initialize(fragments)
+        @fragments = fragments
+      end
+
+      # Get a document's field
+      # @return [Fragments::Fragment]
+      def [](field)
+        @fragments[field]
+      end
+      alias :get :[]
+
+    end
+
     # A fragment of type Group, which contains an array of FragmentList (which
     # itself is a Hash of fragments).
     #

data/lib/prismic/fragments/link.rb

@@ -95,13 +95,16 @@ module Prismic
     end
 
     class DocumentLink < Link
-      attr_accessor :id, :link_type, :tags, :slug, :broken
+      include Prismic::WithFragments
+      attr_accessor :id, :uid, :type, :tags, :slug, :fragments, :broken
 
-      def initialize(id, link_type, tags, slug, broken)
+      def initialize(id, uid, type, tags, slug, fragments, broken)
         @id = id
-        @link_type = link_type
+        @uid = uid
+        @type = type
         @tags = tags
         @slug = slug
+        @fragments = fragments
         @broken = broken
       end
 
@@ -117,6 +120,11 @@ module Prismic
         %(#{start_html(link_resolver)}#{slug}#{end_html})
       end
 
+      def link_type
+        warn('WARNING: DocumentLink.link_type is deprecated, use DocumentLink.type instead')
+        self.type
+      end
+
       # Returns the URL of the link
       #
       # @overload url(link_resolver)

data/lib/prismic/json_parsers.rb

@@ -29,11 +29,24 @@ module Prismic
 
       def document_link_parser(json)
         doc = json['value']['document']
+        type = doc['type']
+        fragments = {}
+        if doc['data'] and doc['data'][type]
+          fragments = Hash[doc['data'][type].map { |name, fragment|
+            if fragment.is_a? Array
+              [name, multiple_parser(fragment)]
+            else
+              [name, parsers[fragment['type']].call(fragment)]
+            end
+          }]
+        end
         Prismic::Fragments::DocumentLink.new(
           doc['id'],
-          doc['type'],
+          doc['uid'],
+          type,
           doc['tags'],
           URI.unescape(doc['slug']),
+          fragments,
           json['value']['isBroken'])
       end
 
@@ -181,7 +194,7 @@ module Prismic
         fragment_list_array = []
         json['value'].each do |group|
           fragments = Hash[ group.map {|name, fragment| [name, parsers[fragment['type']].call(fragment)] }]
-          fragment_list_array << Prismic::WithFragments.new(fragments)
+          fragment_list_array << Prismic::Fragments::GroupDocument.new(fragments)
         end
         Prismic::Fragments::Group.new(fragment_list_array)
       end
@@ -207,15 +220,13 @@ module Prismic
           end
         }]
 
-        linked_documents = linked_documents_parser(json['linked_documents'])
-
         Prismic::Document.new(
             json['id'],
+            json['uid'],
             json['type'],
             json['href'],
             json['tags'],
             json['slugs'].map { |slug| URI.unescape(slug) },
-            linked_documents,
             fragments)
       end
 

data/lib/prismic/version.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 module Prismic
 
-  VERSION = '1.0.9'
+  VERSION = '1.1.0'
 
 end

data/lib/prismic/with_fragments.rb

@@ -2,14 +2,10 @@
 module Prismic
 
   # A document with Fragments: usually a Prismic.io Document, or a Document within a Group
-  class WithFragments
+  module WithFragments
     # @return [Hash{String => Fragment}]
     attr_accessor :fragments
 
-    def initialize(fragments)
-      @fragments = fragments
-    end
-
     # Generate an HTML representation of the entire document
     #
     # @param link_resolver [LinkResolver] The LinkResolver used to build
@@ -48,7 +44,12 @@ module Prismic
     # Get a document's field
     # @return [Fragments::Fragment]
     def [](field)
-      @fragments[field]
+      array = field.split('.')
+      if array.length != 2
+        raise ArgumentError, 'Argument should contain one dot. Example: product.price'
+      end
+      return nil if array[0] != self.type
+      fragments[array[1]]
     end
     alias :get :[]
 
@@ -135,6 +136,27 @@ module Prismic
       fragment
     end
 
+    # @return [Array<LinkedDocument>]
+    def linked_documents
+      self.fragments.map { |name, fragment|
+        if fragment.is_a? Prismic::Fragments::DocumentLink
+          [fragment]
+        elsif fragment.is_a? Prismic::Fragments::StructuredText
+          fragment.blocks
+            .select { |block| block.is_a? Prismic::Fragments::StructuredText::Block::Text}
+            .map { |block| block.spans }.flatten
+            .select { |span| span.is_a? Prismic::Fragments::StructuredText::Span::Hyperlink }
+            .map { |span| span.link }
+            .select { |link| link.is_a? Prismic::Fragments::DocumentLink }
+        elsif fragment.is_a? Prismic::Fragments::Group
+          fragment.group_documents
+            .map { |groupDoc| groupDoc.linked_documents }
+            .flatten
+        else
+          []
+        end
+      }.flatten
+    end
   end
 
 end

data/prismic.gemspec

@@ -4,22 +4,22 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'prismic/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "prismic.io"
+  spec.name          = 'prismic.io'
   spec.version       = Prismic::VERSION
-  spec.authors       = ["Étienne Vallette d'Osia", "Erwan Loisant", "Samy Dindane", "Rudy Rigot"]
-  spec.email         = ["evo@zenexity.com"]
+  spec.authors       = ["Étienne Vallette d'Osia", 'Erwan Loisant', 'Samy Dindane', 'Rudy Rigot']
+  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.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.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rspec", "~> 2.14"
-  spec.add_development_dependency "nokogiri", "~> 1.6"
-  spec.add_development_dependency "simplecov", "~> 0.7"
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rspec', '~> 2.14'
+  spec.add_development_dependency 'nokogiri', '~> 1.6'
+  spec.add_development_dependency 'simplecov', '~> 0.7'
 end

data/spec/doc_spec.rb

@@ -7,7 +7,7 @@ describe 'Documentation' do
 
     it 'api.get' do
       # startgist:31cf4b514778d5d9d9cc:prismic-api.rb
-      api = Prismic.api('https://lesbonneschoses.prismic.io/api')
+      api = Prismic.api('https://lesbonneschoses.cdn.wroom.io/api')
       # endgist
       api.should_not be_nil
     end
@@ -16,16 +16,16 @@ describe 'Documentation' do
       expect {
         # startgist:10822fc1befeeea1191a:prismic-apiPrivate.rb
         # This will fail because the token is invalid, but this is how to access a private API
-        api = Prismic.api('https://lesbonneschoses.prismic.io/api', 'MC5-XXXXXXX-vRfvv70')
+        api = Prismic.api('https://lesbonneschoses.cdn.prismic.io/api', 'MC5-XXXXXXX-vRfvv70')
         # endgist
-        # err.message, "Unexpected status code [401] on URL https://lesbonneschoses.prismic.io/api?access_token=MC5-XXXXXXX-vRfvv70"); // gisthide
+        # err.message, "Unexpected status code [401] on URL https://lesbonneschoses.cdn.prismic.io/api?access_token=MC5-XXXXXXX-vRfvv70"); // gisthide
       }.to raise_error(Prismic::API::PrismicWSAuthError, "Can't connect to Prismic's API: Invalid access token")
     end
 
     it 'references' do
       # startgist:431e191cabf5e160c701:prismic-references.rb
       preview_token = 'MC5VbDdXQmtuTTB6Z0hNWHF3.c--_vVbvv73vv73vv73vv71EA--_vS_vv73vv70T77-9Ke-_ve-_vWfvv70ebO-_ve-_ve-_vQN377-9ce-_vRfvv70';
-      api = Prismic.api('https://lesbonneschoses.prismic.io/api', preview_token)
+      api = Prismic.api('https://lesbonneschoses.cdn.prismic.io/api', preview_token)
       st_patrick_ref = api.ref('St-Patrick specials')
       # Now we'll use this reference for all our calls
       response = api.form('everything')
@@ -44,7 +44,7 @@ describe 'Documentation' do
 
     it 'simple query' do
       # startgist:8943931ba0cf2bb2c873:prismic-simplequery.rb
-      api = Prismic.api('https://lesbonneschoses.prismic.io/api')
+      api = Prismic.api('https://lesbonneschoses.cdn.prismic.io/api')
       response = api
         .form('everything')
         .query(Prismic::Predicates::at('document.type', 'product'))
@@ -56,7 +56,7 @@ describe 'Documentation' do
 
     it 'orderings' do
       # startgist:2866b2e2cae0221f2188:prismic-orderings.rb
-      api = Prismic.api('https://lesbonneschoses.prismic.io/api')
+      api = Prismic.api('https://lesbonneschoses.cdn.prismic.io/api')
       response = api.form('everything')
         .ref(api.master_ref)
         .query(Prismic::Predicates::at('document.type', 'product'))
@@ -71,7 +71,7 @@ describe 'Documentation' do
 
     it 'predicates' do
       # startgist:e0501cce9a12fa4b83db:prismic-predicates.rb
-      api = Prismic.api('https://lesbonneschoses.prismic.io/api')
+      api = Prismic.api('https://lesbonneschoses.cdn.prismic.io/api')
       response = api
         .form('everything')
         .query(
@@ -104,7 +104,7 @@ describe 'Documentation' do
   describe 'fragments' do
 
     it 'text' do
-      api = Prismic::api('https://lesbonneschoses.prismic.io/api')
+      api = Prismic::api('https://lesbonneschoses.cdn.prismic.io/api')
       response = api.form('everything')
         .query(Predicates::at('document.id', 'UlfoxUnM0wkXYXbl'))
         .ref(api.master_ref)
@@ -122,7 +122,7 @@ describe 'Documentation' do
     end
 
     it 'number' do
-      api = Prismic::api('https://lesbonneschoses.prismic.io/api')
+      api = Prismic::api('https://lesbonneschoses.cdn.prismic.io/api')
       response = api.form('everything')
         .query(Predicates::at('document.id', 'UlfoxUnM0wkXYXbO'))
         .ref(api.master_ref)
@@ -141,7 +141,7 @@ describe 'Documentation' do
     end
 
     it 'images' do
-      api = Prismic::api('https://lesbonneschoses.prismic.io/api')
+      api = Prismic::api('https://lesbonneschoses.cdn.prismic.io/api')
       response = api.form('everything')
         .query(Predicates::at('document.id', 'UlfoxUnM0wkXYXbO'))
         .ref(api.master_ref)
@@ -153,11 +153,11 @@ describe 'Documentation' do
       # Most of the time you will be using the "main" view
       url = image.main.url
       # endgist
-      url.should == 'https://prismic-io.s3.amazonaws.com/lesbonneschoses/f606ad513fcc2a73b909817119b84d6fd0d61a6d.png'
+      url.should == 'https://lesbonneschoses.cdn.prismic.io/lesbonneschoses/f606ad513fcc2a73b909817119b84d6fd0d61a6d.png'
     end
 
     it 'date and timestamp' do
-      api = Prismic::api('https://lesbonneschoses.prismic.io/api')
+      api = Prismic::api('https://lesbonneschoses.cdn.prismic.io/api')
       response = api.form('everything')
         .query(Predicates::at('document.id', 'UlfoxUnM0wkXYXbl'))
         .ref(api.master_ref)
@@ -254,7 +254,7 @@ describe 'Documentation' do
     end
 
     it 'asHtml' do
-      api = Prismic.api('https://lesbonneschoses.prismic.io/api')
+      api = Prismic.api('https://lesbonneschoses.cdn.prismic.io/api')
       response = api
         .form('everything')
         .query(Prismic::Predicates::at('document.id', 'UlfoxUnM0wkXYXbX'))
@@ -268,7 +268,7 @@ describe 'Documentation' do
     end
 
     it 'HtmlSerializer' do
-      api = Prismic.api('https://lesbonneschoses.prismic.io/api')
+      api = Prismic.api('https://lesbonneschoses.cdn.prismic.io/api')
       response = api
       .form('everything')
       .query(Prismic::Predicates::at('document.id', 'UlfoxUnM0wkXYXbX'))
@@ -294,7 +294,7 @@ describe 'Documentation' do
       # You can pass any object implementing the same methods as the BasicCache
       # https://github.com/prismicio/ruby-kit/blob/master/lib/prismic/cache/basic.rb
       cache = Prismic::BasicCache.new
-      api = Prismic::api('https://lesbonneschoses.prismic.io/api', { :cache => cache })
+      api = Prismic::api('https://lesbonneschoses.cdn.prismic.io/api', { :cache => cache })
       # The Api will use the custom cache object
       # endgist
       api.should_not be_nil