prismic.io 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0efa24b3f98e9f3dc05f26b50f7125e45409afa2
-  data.tar.gz: fb6164ea1e1fa198951e92353429fc985e4432b1
+  metadata.gz: 16a00d0902a7e578bae02a8f3ba454601d4a11eb
+  data.tar.gz: c4c7c7328802c53c8a4b756be7696a313926675c
 SHA512:
-  metadata.gz: 7af5bae716dcdf93e5672a8639b71ce1974c903a352739c2cf27d8dbf600b16b396bd5c4f273787f723c612aff16f1e6f4750f68cb3f40f8288d6a115e8e2501
-  data.tar.gz: 14d0b5d69449eeb4e3ec27a8524a0eb69358ad45545b46cc75d5cea1ee061a59cee26e6c672392a4ea555c7561b73fe41132f3eb72b696027eec99919a1cd091
+  metadata.gz: 01275c85a8294298cc99f43bbbaf9dd63e537d6ae73e3c446cb6d8e7fc9797a65509c329eb4f8e75d535010f8035c0dfec1ed4c39dde4f777dc08a3ab661cbe8
+  data.tar.gz: 79c636388540a1cd684691373f42d978fb7a8b7994219b4b05086fa9d850b99c747ef8866f4974e11c85400782959a572c4e6e8baddf9ad9b3a1f28b34772358

data/.gitignore

@@ -4,5 +4,5 @@ pkg/*.gem
 .idea/
 .yardoc/
 doc/
-
+node_modules/
 

data/Gemfile.lock

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

data/gulpfile.js

@@ -0,0 +1,25 @@
+var gulp = require('gulp'),
+    gist = require('gulp-gist'),
+    deploy = require("gulp-gh-pages");
+
+var pkg = require('./package.json');
+
+gulp.task('deploy:doc', function () {
+    gulp.src("./doc/**/*")
+        .pipe(deploy());
+});
+
+gulp.task('deploy:gist', function () {
+
+    gulp.src("./spec/doc_spec.rb")
+        .pipe(gist());
+});
+
+gulp.task('dist', ['deploy:doc', 'deploy:gist']);
+
+/**
+ * Default task
+ */
+
+gulp.task('default', ['deploy:gist']);
+

data/lib/prismic.rb

@@ -277,20 +277,20 @@ module Prismic
       cache_key = form_method+'::'+form_action+'?'+data.map{|k,v|"#{k}=#{v}"}.join('&')
 
       api.caching(cache_key) {
-        if form_method == "GET" && form_enctype == "application/x-www-form-urlencoded"
+        if form_method == 'GET' && form_enctype == 'application/x-www-form-urlencoded'
           data['access_token'] = api.access_token if api.access_token
           data.delete_if { |k, v| v.nil? }
 
           response = api.http_client.get(form_action, data, 'Accept' => 'application/json')
 
-          if response.code.to_s == "200"
+          if response.code.to_s == '200'
             response.body
           else
             body = JSON.load(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 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
         else
@@ -308,9 +308,9 @@ module Prismic
       field = @form.fields[field_name]
       if field && field.repeatable?
         data[field_name] = [] unless data.include? field_name
-        data[field_name] << value
+        data[field_name] << value.to_s
       else
-        data[field_name] = value
+        data[field_name] = value.to_s
       end
       self
     end
@@ -459,13 +459,67 @@ module Prismic
     def [](field)
       array = field.split('.')
       if array.length != 2
-        raise ArgumentError, "Argument should contain one dot. Example: product.price"
+        raise ArgumentError, 'Argument should contain one dot. Example: product.price'
       end
       return nil if array[0] != self.type
       fragments[array[1]]
     end
     alias :get :[]
 
+    def get_text(field)
+      fragment = self[field]
+      return nil unless fragment.is_a? Prismic::Fragments::Text
+      fragment
+    end
+
+    def get_number(field)
+      fragment = self[field]
+      return nil unless fragment.is_a? Prismic::Fragments::Number
+      fragment
+    end
+
+    def get_date(field)
+      fragment = self[field]
+      return nil unless fragment.is_a? Prismic::Fragments::Date
+      fragment
+    end
+
+    def get_timestamp(field)
+      fragment = self[field]
+      return nil unless fragment.is_a? Prismic::Fragments::Timestamp
+      fragment
+    end
+
+    def get_group(field)
+      fragment = self[field]
+      return nil unless fragment.is_a? Prismic::Fragments::Group
+      fragment
+    end
+
+    def get_link(field)
+      fragment = self[field]
+      return nil unless fragment.is_a? Prismic::Fragments::Link
+      fragment
+    end
+
+    def get_embed(field)
+      fragment = self[field]
+      return nil unless fragment.is_a? Prismic::Fragments::Embed
+      fragment
+    end
+
+    def get_color(field)
+      fragment = self[field]
+      return nil unless fragment.is_a? Prismic::Fragments::Color
+      fragment
+    end
+
+    def get_geopoint(field)
+      fragment = self[field]
+      return nil unless fragment.is_a? Prismic::Fragments::GeoPoint
+      fragment
+    end
+
     private
 
     def parse_fragments(fragments)

data/lib/prismic/api.rb

@@ -185,9 +185,9 @@ module Prismic
     end
 
     def oauth_check_token(params)
-      if !@@warned_oauth_check_token
+      unless @@warned_oauth_check_token
         warn "[DEPRECATION] Method `API#oauth_check_token` is deprecated.  " +
-          "Please use `Prismic::API.oauth_check_token` instead."
+                 "Please use `Prismic::API.oauth_check_token` instead."
         @@warned_oauth_check_token = true
       end
       oauth.check_token(params)

data/lib/prismic/fragments/embed.rb

@@ -19,11 +19,7 @@ module Prismic
       #
       # @return [String] the HTML representation
       def as_html(link_resolver=nil, html_serializer=nil)
-        <<-HTML
-        <div data-oembed="#@url"
-            data-oembed-type="#{@embed_type.downcase}"
-            data-oembed-provider="#{@provider.downcase}">#@html</div>
-        HTML
+        %Q|<div data-oembed="#{@url}" data-oembed-type="#{@embed_type.downcase}" data-oembed-provider="#{@provider.downcase}">#@html</div>|
       end
     end
   end

data/lib/prismic/fragments/structured_text.rb

@@ -252,7 +252,7 @@ module Prismic
           attr_accessor :level
 
           def initialize(text, spans, level, label = nil)
-            super(text, spans)
+            super(text, spans, label)
             @level = level
           end
 
@@ -293,7 +293,7 @@ module Prismic
           alias :ordered? :ordered
 
           def initialize(text, spans, ordered, label = nil)
-            super(text, spans)
+            super(text, spans, label)
             @ordered = ordered
           end
 

data/lib/prismic/predicates.rb

@@ -30,15 +30,15 @@ module Prismic
     end
 
     def self.date_before(fragment, before)
-      ['date.before', fragment, before]
+      ['date.before', fragment, as_timestamp(before)]
     end
 
     def self.date_after(fragment, after)
-      ['date.after', fragment, after]
+      ['date.after', fragment, as_timestamp(after)]
     end
 
     def self.date_between(fragment, before, after)
-      ['date.between', fragment, before, after]
+      ['date.between', fragment, as_timestamp(before), as_timestamp(after)]
     end
 
     def self.day_of_month(fragment, day)
@@ -97,5 +97,17 @@ module Prismic
       ['geopoint.near', fragment, latitude, longitude, radius]
     end
 
+    def self.as_timestamp(date)
+      if date.is_a? Date or date.is_a? DateTime
+        date.to_time.to_i * 1000
+      elsif date.is_a? Time
+        date.to_i * 1000
+      else
+        date
+      end
+    end
+
+    private_class_method :as_timestamp
+
   end
 end

data/lib/prismic/version.rb

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

data/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "prismic.io",
+  "description": "Ruby development kit for prismic.io",
+  "url": "https://github.com/prismicio/ruby-kit",
+  "devDependencies": {
+    "gulp": "~3.8.8",
+    "gulp-gist": "~1.0.3",
+    "gulp-gh-pages": "~0.3.4"
+  }
+}

data/spec/cache_spec.rb

@@ -3,101 +3,101 @@ require 'spec_helper'
 
 describe "Cache's" do
 
-	describe 'on/off switch' do
-		before do
-			@api = Prismic.api("https://lesbonneschoses.prismic.io/api", cache: Prismic::LruCache.new(3))
-			@cache = @api.cache
-			@master_ref = @api.master_ref
-		end
-
-		it "is properly on" do
-			@api.has_cache?.should == true
-			@cache.is_a?(Prismic::LruCache).should == true
-		end
-
-		it "is properly off" do
-			api = Prismic.api("https://lesbonneschoses.prismic.io/api", cache: false)
-			api.has_cache?.should == false
-		end
-
-		describe 'storage and retrieval' do
-			it 'stores properly' do
-				@cache.intern.size.should == 0
-				@api.form('products').submit(@master_ref)
-				@cache.intern.size.should == 1
-			end
-
-			it 'does not cache /api' do
-				# do not call anything, so the only request made is the /api one
-				@cache.intern.size.should == 0
-			end
-		end
-
-		describe 'cache storage' do
-			before do
-				# max_size = 3
-				@cache['fake_key1'] = 1
-				@cache['fake_key2'] = 2
-				@cache['fake_key3'] = 3
-			end
-			it 'contains some keys' do
-				@cache.include?('fake_key1').should be_true
-			end
-			it 'contains all keys' do
-				@cache.intern.size.should == 3
-			end
-			it 'can return all keys' do
-				@cache.keys.should == %w(fake_key1 fake_key2 fake_key3)
-			end
-			it 'deletes oldest key when updating max_size' do
-				@cache.max_size = 1
-				@cache.size.should == 1
-				@cache.include?('fake_key1').should be_false
-				@cache.include?('fake_key2').should be_false
-				@cache.include?('fake_key3').should be_true
-			end
-			it 'deletes oldest key when adding new one (at max_size)' do
-				@cache['fake_key4'] = 4
-				@cache.max_size = 3
-				@cache.size.should == 3
-				@cache.include?('fake_key1').should be_false
-			end
-			it 'keeps readed keys alive' do
-				@cache['fake_key1']
-				@cache['fake_key4'] = 4
-				@cache.include?('fake_key1').should be_true
-				@cache.include?('fake_key2').should be_false
-			end
-		end
-
-		describe 'caching on a real repository' do
-			before do
-				@api = Prismic.api("https://lesbonneschoses.prismic.io/api", access_token: 'MC5VbDdXQmtuTTB6Z0hNWHF3.c--_vVbvv73vv73vv73vv71EA--_vS_vv73vv70T77-9Ke-_ve-_vWfvv70ebO-_ve-_ve-_vQN377-9ce-_vRfvv70')
-				@cache = @api.cache
-				@master_ref = @api.master_ref
-				@other_ref = @api.refs['announcement of new sf shop']
-			end
-			it 'works on different refs' do
-				@api.form('everything').submit(@master_ref).total_results_size.should == 40
-				@api.form('everything').submit(@other_ref).total_results_size.should == 43
-			end
-		end
-	end
+  describe 'on/off switch' do
+    before do
+      @api = Prismic.api("https://lesbonneschoses.prismic.io/api", cache: Prismic::LruCache.new(3))
+      @cache = @api.cache
+      @master_ref = @api.master_ref
+    end
+
+    it "is properly on" do
+      @api.has_cache?.should == true
+      @cache.is_a?(Prismic::LruCache).should == true
+    end
+
+    it "is properly off" do
+      api = Prismic.api("https://lesbonneschoses.prismic.io/api", cache: false)
+      api.has_cache?.should == false
+    end
+
+    describe 'storage and retrieval' do
+      it 'stores properly' do
+        @cache.intern.size.should == 0
+        @api.form('products').submit(@master_ref)
+        @cache.intern.size.should == 1
+      end
+
+      it 'does not cache /api' do
+        # do not call anything, so the only request made is the /api one
+        @cache.intern.size.should == 0
+      end
+    end
+
+    describe 'cache storage' do
+      before do
+        # max_size = 3
+        @cache['fake_key1'] = 1
+        @cache['fake_key2'] = 2
+        @cache['fake_key3'] = 3
+      end
+      it 'contains some keys' do
+        @cache.include?('fake_key1').should be_true
+      end
+      it 'contains all keys' do
+        @cache.intern.size.should == 3
+      end
+      it 'can return all keys' do
+        @cache.keys.should == %w(fake_key1 fake_key2 fake_key3)
+      end
+      it 'deletes oldest key when updating max_size' do
+        @cache.max_size = 1
+        @cache.size.should == 1
+        @cache.include?('fake_key1').should be_false
+        @cache.include?('fake_key2').should be_false
+        @cache.include?('fake_key3').should be_true
+      end
+      it 'deletes oldest key when adding new one (at max_size)' do
+        @cache['fake_key4'] = 4
+        @cache.max_size = 3
+        @cache.size.should == 3
+        @cache.include?('fake_key1').should be_false
+      end
+      it 'keeps readed keys alive' do
+        @cache['fake_key1']
+        @cache['fake_key4'] = 4
+        @cache.include?('fake_key1').should be_true
+        @cache.include?('fake_key2').should be_false
+      end
+    end
+
+    describe 'caching on a real repository' do
+      before do
+        @api = Prismic.api("https://lesbonneschoses.prismic.io/api", access_token: 'MC5VbDdXQmtuTTB6Z0hNWHF3.c--_vVbvv73vv73vv73vv71EA--_vS_vv73vv70T77-9Ke-_ve-_vWfvv70ebO-_ve-_ve-_vQN377-9ce-_vRfvv70')
+        @cache = @api.cache
+        @master_ref = @api.master_ref
+        @other_ref = @api.refs['announcement of new sf shop']
+      end
+      it 'works on different refs' do
+        @api.form('everything').submit(@master_ref).total_results_size.should == 40
+        @api.form('everything').submit(@other_ref).total_results_size.should == 43
+      end
+    end
+  end
 end
 
 describe "Basic Cache's" do
 
   it 'set & get value' do
-	cache = Prismic::BasicCache.new
-	cache.set('key', 'value')
-	cache.get('key').should == 'value'
+    cache = Prismic::BasicCache.new
+    cache.set('key', 'value')
+    cache.get('key').should == 'value'
   end
 
   it 'set with expiration value & get value' do
-	cache = Prismic::BasicCache.new
-	cache.set('key', 'value', 1)
-	sleep(2)
-	cache.get('key').should == nil
+    cache = Prismic::BasicCache.new
+    cache.set('key', 'value', 1)
+    sleep(2)
+    cache.get('key').should == nil
   end
 
   it 'set with expiration and a block' do
@@ -109,41 +109,41 @@ describe "Basic Cache's" do
   end
 
   it 'set & test value' do
-	cache = Prismic::BasicCache.new
-	cache.set('key', 'value')
-	cache.include?('key').should == true
+    cache = Prismic::BasicCache.new
+    cache.set('key', 'value')
+    cache.include?('key').should == true
   end
 
   it 'get or set value' do
-	cache = Prismic::BasicCache.new
-	cache.set('key', 'value')
-	cache.get('key').should == 'value'
-	cache.get_or_set('key', 'value1')
-	cache.get('key').should == 'value'
-	cache.get_or_set('key1', 'value2')
-	cache.get('key1').should == 'value2'
+    cache = Prismic::BasicCache.new
+    cache.set('key', 'value')
+    cache.get('key').should == 'value'
+    cache.get_or_set('key', 'value1')
+    cache.get('key').should == 'value'
+    cache.get_or_set('key1', 'value2')
+    cache.get('key1').should == 'value2'
   end
 
   it 'set, delete & get value' do
-	cache = Prismic::BasicCache.new
-	cache.set('key', 'value')
-	cache.get('key').should == 'value'
-	cache.delete('key')
-	cache.get('key').should == nil
+    cache = Prismic::BasicCache.new
+    cache.set('key', 'value')
+    cache.get('key').should == 'value'
+    cache.delete('key')
+    cache.get('key').should == nil
   end
 
   it 'set, clear & get value' do
-	cache = Prismic::BasicCache.new
-	cache.expired?('key')
-	cache.set('key', 'value')
-	cache.set('key1', 'value1')
-	cache.set('key2', 'value2')
-	cache.get('key').should == 'value'
-	cache.get('key1').should == 'value1'
-	cache.get('key2').should == 'value2'
-	cache.clear()
-	cache.get('key').should == nil
-	cache.get('key1').should == nil
-	cache.get('key2').should == nil
+    cache = Prismic::BasicCache.new
+    cache.expired?('key')
+    cache.set('key', 'value')
+    cache.set('key1', 'value1')
+    cache.set('key2', 'value2')
+    cache.get('key').should == 'value'
+    cache.get('key1').should == 'value1'
+    cache.get('key2').should == 'value2'
+    cache.clear()
+    cache.get('key').should == nil
+    cache.get('key1').should == nil
+    cache.get('key2').should == nil
   end
 end

data/spec/doc_spec.rb

@@ -0,0 +1,289 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe 'Documentation' do
+
+  describe 'api' do
+
+    it 'api.get' do
+      # startgist:31cf4b514778d5d9d9cc:prismic-api.rb
+      api = Prismic.api('https://lesbonneschoses.prismic.io/api')
+      # endgist
+      api.should_not be_nil
+    end
+
+    it 'apiPrivate' 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')
+        # endgist
+        # err.message, "Unexpected status code [401] on URL https://lesbonneschoses.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)
+      st_patrick_ref = api.ref('St-Patrick specials')
+      # Now we'll use this reference for all our calls
+      response = api.form('everything')
+      .ref(st_patrick_ref)
+      .query(Prismic::Predicates::at('document.type', 'product'))
+      .submit
+      # The Response object contains all documents of type "product"
+      # including the new "Saint-Patrick's Cupcake"
+      # endgist
+      response.results.length.should == 17
+    end
+
+  end
+
+  describe 'queries' do
+
+    it 'simple query' do
+      # startgist:8943931ba0cf2bb2c873:prismic-simplequery.rb
+      api = Prismic.api('https://lesbonneschoses.prismic.io/api')
+      response = api
+        .form('everything')
+        .query(Prismic::Predicates::at('document.type', 'product'))
+        .submit(api.master_ref)
+      # response contains all documents of type 'product', paginated
+      # endgist
+      response.results.size.should == 16
+    end
+
+    it 'orderings' do
+      # startgist:2866b2e2cae0221f2188:prismic-orderings.rb
+      api = Prismic.api('https://lesbonneschoses.prismic.io/api')
+      response = api.form('everything')
+        .ref(api.master_ref)
+        .query(Prismic::Predicates::at('document.type', 'product'))
+        .page_size(100)
+        .orderings('[my.product.price desc]')
+        .submit
+      # The products are now ordered by price, highest first
+      results = response.results
+      # endgist
+      response.results_per_page.should == 100
+    end
+
+    it 'predicates' do
+      # startgist:e0501cce9a12fa4b83db:prismic-predicates.rb
+      api = Prismic.api('https://lesbonneschoses.prismic.io/api')
+      response = api
+        .form('everything')
+        .query(
+          Prismic::Predicates::at('document.type', 'product'),
+          Prismic::Predicates::date_after('my.blog-post.date', 1401580800000))
+        .submit(api.master_ref)
+      # endgist
+      response.results.size.should == 0
+    end
+
+    it 'all predicates' do
+      # startgist:e4875d732426a7b9fd09:prismic-allPredicates.rb
+      # 'at' predicate: equality of a fragment to a value.
+      at = Predicates::at('document.type', 'article')
+      # 'any' predicate: equality of a fragment to a value.
+      any = Predicates::any('document.type', ['article', 'blog-post'])
+
+      # 'fulltext' predicate: fulltext search in a fragment.
+      fulltext = Predicates::fulltext('my.article.body', 'sausage')
+
+      # 'similar' predicate, with a document id as reference
+      similar = Predicates::similar('UXasdFwe42D', 10)
+      # endgist
+      at.should == ['at', 'document.type', 'article']
+      any.should == ['any', 'document.type', ['article', 'blog-post']]
+    end
+
+  end
+
+  describe 'fragments' do
+
+    it 'text' do
+      api = Prismic::api('https://lesbonneschoses.prismic.io/api')
+      response = api.form('everything')
+        .query(Predicates::at('document.id', 'UlfoxUnM0wkXYXbl'))
+        .ref(api.master_ref)
+        .submit
+      doc = response[0]
+      # startgist:cd0d4559870f5f88b90f:prismic-getText.rb
+      author = doc.get_text('blog-post.author')
+      if author == nil
+        name = 'Anonymous'
+      else
+        name = author.value
+      end
+      # endgist
+      name.should == 'John M. Martelle, Fine Pastry Magazine'
+    end
+
+    it 'number' do
+      api = Prismic::api('https://lesbonneschoses.prismic.io/api')
+      response = api.form('everything')
+        .query(Predicates::at('document.id', 'UlfoxUnM0wkXYXbO'))
+        .ref(api.master_ref)
+        .submit
+      doc = response[0]
+      # startgist:c6783e9789d3ff446876:prismic-getNumber.rb
+      # Number predicates
+      gt = Predicates::gt('my.product.price', 10)
+      lt = Predicates::lt('my.product.price', 20)
+      in_range = Predicates::in_range('my.product.price', 10, 20)
+
+      # Accessing number fields
+      price = doc.get_number('product.price').value
+      # endgist
+      price.should == 2.5
+    end
+
+    it 'date and timestamp' do
+      api = Prismic::api('https://lesbonneschoses.prismic.io/api')
+      response = api.form('everything')
+        .query(Predicates::at('document.id', 'UlfoxUnM0wkXYXbl'))
+        .ref(api.master_ref)
+        .submit
+      doc = response[0]
+      # startgist:aa956ac3d7fb9c221011:prismic-dateTimestamp.rb
+      # Date and Timestamp predicates
+      dateBefore = Predicates::date_before('my.product.releaseDate', Time.new(2014, 6, 1))
+      dateAfter = Predicates::date_after('my.product.releaseDate', Time.new(2014, 1, 1))
+      dateBetween = Predicates::date_between('my.product.releaseDate', Time.new(2014, 1, 1), Time.new(2014, 6, 1))
+      dayOfMonth = Predicates::day_of_month('my.product.releaseDate', 14)
+      dayOfMonthAfter = Predicates::day_of_month_after('my.product.releaseDate', 14)
+      dayOfMonthBefore = Predicates::day_of_month_before('my.product.releaseDate', 14)
+      dayOfWeek = Predicates::day_of_week('my.product.releaseDate', 'Tuesday')
+      dayOfWeekAfter = Predicates::day_of_week_after('my.product.releaseDate', 'Wednesday')
+      dayOfWeekBefore = Predicates::day_of_week_before('my.product.releaseDate', 'Wednesday')
+      month = Predicates::month('my.product.releaseDate', 'June')
+      monthBefore = Predicates::month_before('my.product.releaseDate', 'June')
+      monthAfter = Predicates::month_after('my.product.releaseDate', 'June')
+      year = Predicates::year('my.product.releaseDate', 2014)
+      hour = Predicates::hour('my.product.releaseDate', 12)
+      hourBefore = Predicates::hour_before('my.product.releaseDate', 12)
+      hourAfter = Predicates::hour_after('my.product.releaseDate', 12)
+
+      # Accessing Date and Timestamp fields
+      date = doc.get_date('blog-post.date').value
+      date_year = date ? date.year : nil
+      update_time = doc.get_timestamp('blog-post.update')
+      update_hour = update_time ? update_time.value.hour : nil
+      # endgist
+      date_year.should == 2013
+    end
+
+    it 'group' do
+      json = '{"id":"abcd","type":"article","href":"","slugs":[],"tags":[],"data":{"article":{"documents":{"type":"Group","value":[{"linktodoc":{"type":"Link.document","value":{"document":{"id":"UrDejAEAAFwMyrW9","type":"doc","tags":[],"slug":"installing-meta-micro"},"isBroken":false}},"desc":{"type":"StructuredText","value":[{"type":"paragraph","text":"A detailed step by step point of view on how installing happens.","spans":[]}]}},{"linktodoc":{"type":"Link.document","value":{"document":{"id":"UrDmKgEAALwMyrXA","type":"doc","tags":[],"slug":"using-meta-micro"},"isBroken":false}}}]}}}}'
+      document = Prismic::JsonParser.document_parser(JSON.load(json))
+      resolver = Prismic.link_resolver('master') { |doc_link| "http://localhost/#{doc_link.id}" }
+      # startgist:825cff092f082058520d:prismic-group.rb
+      group = document.get_group('article.documents')
+      docs = group ? group : []
+      docs.each do |doc|
+        # Desc and Link are Fragments, their type depending on what's declared in the Document Mask
+        desc = doc['desc']
+        link = doc['linktodoc']
+      end
+      # endgist
+      docs[0]['desc'].as_html(resolver).should == '<p>A detailed step by step point of view on how installing happens.</p>'
+    end
+
+    it 'link' do
+      json = '{"id":"abcd","type":"article","href":"","slugs":[],"tags":[],"data":{"article":{"source":{"type":"Link.document","value":{"document":{"id":"UlfoxUnM0wkXYXbE","type":"product","tags":["Macaron"],"slug":"dark-chocolate-macaron"},"isBroken":false}}}}}'
+      document = Prismic::JsonParser.document_parser(JSON.load(json))
+      # startgist:6c7ae8d7ab6dc057a8b0:prismic-link.rb
+      resolver = Prismic.link_resolver('master') { |doc_link| "http://localhost/#{doc_link.id}/#{doc_link.slug}" }
+      source = document.get_link('article.source')
+      url = source ? source.url(resolver) : nil
+      # endgist
+      url.should == 'http://localhost/UlfoxUnM0wkXYXbE/dark-chocolate-macaron'
+    end
+
+    it 'embed' do
+      json = '{"id":"abcd","type":"article","href":"","slugs":[],"tags":[],"data":{"article":{"video":{"type":"Embed","value":{"oembed":{"provider_url":"http://www.youtube.com/","type":"video","thumbnail_height":360,"height":270,"thumbnail_url":"http://i1.ytimg.com/vi/baGfM6dBzs8/hqdefault.jpg","width":480,"provider_name":"YouTube","html":"<iframe width=\\"480\\" height=\\"270\\" src=\\"http://www.youtube.com/embed/baGfM6dBzs8?feature=oembed\\" frameborder=\\"0\\" allowfullscreen></iframe>","author_name":"Siobhan Wilson","version":"1.0","author_url":"http://www.youtube.com/user/siobhanwilsonsongs","thumbnail_width":480,"title":"Siobhan Wilson - All Dressed Up","embed_url":"https://www.youtube.com/watch?v=baGfM6dBzs8"}}}}}}'
+      document = Prismic::JsonParser.document_parser(JSON.load(json))
+      # startgist:d5a6c0715c9a8df984e4:prismic-embed.rb
+      video = document.get_embed('article.video')
+      # Html is the code to include to embed the object, and depends on the embedded service
+      html = video ? video.as_html : ''
+      # endgist
+      html.should == '<div data-oembed="http://www.youtube.com/" data-oembed-type="video" data-oembed-provider="youtube"><iframe width="480" height="270" src="http://www.youtube.com/embed/baGfM6dBzs8?feature=oembed" frameborder="0" allowfullscreen></iframe></div>'
+    end
+
+    it 'color' do
+      json = '{"id":"abcd","type":"article","href":"","slugs":[],"tags":[],"data":{"article":{"background":{"type":"Color","value":"#000000"}}}}'
+      document = Prismic::JsonParser.document_parser(JSON.load(json))
+      # startgist:ccafcdcbcd6ef6f2fce8:prismic-color.rb
+      bgcolor = document.get_color('article.background')
+      hex = '#' + (bgcolor ? bgcolor.value : 'FFFFFF')
+      # endgist
+      hex.should == '#000000'
+    end
+
+    it 'GeoPoint' do
+      json = '{"id":"abcd","type":"article","href":"","slugs":[],"tags":[],"data":{"article":{"location":{"type":"GeoPoint","value":{"latitude":48.877108,"longitude":2.333879}}}}}'
+      document = Prismic::JsonParser.document_parser(JSON.load(json))
+      # startgist:c70626752d00669ee18f:prismic-geopoint.rb
+      # "near" predicate for GeoPoint fragments
+      near = Predicates::near('my.store.location', 48.8768767, 2.3338802, 10)
+
+      # Accessing GeoPoint fragments
+      place = document.get_geopoint('article.location')
+      coordinates = place ? (place.latitude.to_s + ',' + place.longitude.to_s) : ''
+      # endgist
+      coordinates.should == '48.877108,2.333879'
+    end
+
+    it 'asHtml' do
+      api = Prismic.api('https://lesbonneschoses.prismic.io/api')
+      response = api
+        .form('everything')
+        .query(Prismic::Predicates::at('document.id', 'UlfoxUnM0wkXYXbX'))
+        .submit(api.master_ref)
+      # startgist:7bc04d4690b74e4d4a39:prismic-asHtml.rb
+      resolver = Prismic.link_resolver('master'){ |doc_link| "http:#localhost/#{doc_link.id}" }
+      doc = response.results[0]
+      html = doc['blog-post.body'].as_html(resolver)
+      # endgist
+      html.should_not be_nil
+    end
+
+    it 'HtmlSerializer' do
+      api = Prismic.api('https://lesbonneschoses.prismic.io/api')
+      response = api
+      .form('everything')
+      .query(Prismic::Predicates::at('document.id', 'UlfoxUnM0wkXYXbX'))
+      .submit(api.master_ref)
+      # startgist:db34a3847be03315da55:prismic-htmlSerializer.rb
+      resolver = Prismic.link_resolver('master'){ |doc_link| "http:#localhost/#{doc_link.id}" }
+      serializer = Prismic.html_serializer do |element, html|
+        if element.is_a?(Prismic::Fragments::StructuredText::Block::Image)
+          # Don't wrap images in a <p> tag
+          %(<img src="#{element.url}" alt="#{element.alt}" width="#{element.width}" height="#{element.height}" />)
+        else
+          nil
+        end
+      end
+      doc = response.results[0]
+      html = doc['blog-post.body'].as_html(resolver, serializer)
+      # endgist
+      html.should_not be_nil
+    end
+
+    it 'cache' do
+      # startgist:a6b898cc3af15d7def0a:prismic-cache.rb
+      # 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 })
+      # The Api will use the custom cache object
+      # endgist
+      api.should_not be_nil
+    end
+
+  end
+
+end

data/spec/lesbonneschoses_spec.rb

@@ -149,8 +149,8 @@ describe 'LesBonnesChoses' do
             "<p>As you may know, we like to give our workshop artists the ability to master their art to the top; that is why our Preparation Experts always start off as being Ganache Specialists for Les Bonnes Choses. That way, they're given an opportunity to focus on one exercise before moving on. "\
             "Once they master their ganache, and are able to provide the most optimal delight to our customers, we consider they'll thrive as they work on other kinds of preparations.</p>\n\n"\
             "<h2>About the chocolate in our ganache</h2>\n\n"\
-            "<p>Now, we've also had a lot of questions about how our chocolate gets made. It's true, as you might know, that we make it ourselves, from Columbian cocoa and French cow milk, with a process that much resembles the one in the following Discovery Channel documentary.</p>\n\n        "\
-            "<div data-oembed=\"http://www.youtube.com/\"\n            data-oembed-type=\"video\"\n            data-oembed-provider=\"youtube\"><iframe width=\"459\" height=\"344\" src=\"http://www.youtube.com/embed/Ye78F3-CuXY?feature=oembed\" frameborder=\"0\" allowfullscreen></iframe></div>\n"
+            "<p>Now, we've also had a lot of questions about how our chocolate gets made. It's true, as you might know, that we make it ourselves, from Columbian cocoa and French cow milk, with a process that much resembles the one in the following Discovery Channel documentary.</p>\n\n"\
+            "<div data-oembed=\"http://www.youtube.com/\" data-oembed-type=\"video\" data-oembed-provider=\"youtube\"><iframe width=\"459\" height=\"344\" src=\"http://www.youtube.com/embed/Ye78F3-CuXY?feature=oembed\" frameborder=\"0\" allowfullscreen></iframe></div>"
       end
       it "returns a correct as_html on a StructuredText with custom HTML serializer" do
         @api.form("everything")

data/spec/micro_spec.rb

@@ -3,25 +3,25 @@ require 'spec_helper'
 
 describe 'micro' do
   before do
-    @api = Prismic.api("https://micro.prismic.io/api", nil)
+    @api = Prismic.api('https://micro.prismic.io/api', nil)
     @master_ref = @api.master_ref
-    @link_resolver = Prismic.link_resolver("master"){|doc_link| "http://localhost/#{doc_link.id}" }
+    @link_resolver = Prismic.link_resolver('master'){|doc_link| "http://localhost/#{doc_link.id}" }
   end
 
   describe 'embed block in structured text fragments' do
     it 'is of the right Embed object, and serializes well' do
-      fragment = @api.form("everything").query(%w(at document.id UrjI1gEAALOCeO5i)).submit(@master_ref)[0]['article.body']
+      fragment = @api.form('everything').query(%w(at document.id UrjI1gEAALOCeO5i)).submit(@master_ref)[0]['article.body']
       fragment.blocks[4].is_a?(Prismic::Fragments::Embed).should == true
-      fragment.as_html(@link_resolver).gsub(/[\n\r]+/, '').gsub(/ +/, ' ').gsub(/&#39;/, "'").should == %(<h2>The meta-micro mailing-list</h2><p>This is where you go to give feedback, and discuss the future of micro. <a href="https://groups.google.com/forum/?hl=en#!forum/micro-meta-framework">Subscribe to the list now</a>!</p><h2>The micro GitHub repository</h2><p>This is where you get truly active, by forking the project's source code, and making it better. Please always feel free to send us pull requests.</p> <div data-oembed="" data-oembed-type="link" data-oembed-provider="object"><div data-type="object"><a href="https://github.com/rudyrigot/meta-micro"><h1>rudyrigot/meta-micro</h1><img src="https://avatars2.githubusercontent.com/u/552279?s=400"><p>The meta-micro-framework you simply need</p></a></div></div><h2>Report bugs on micro</h2><p>If you think micro isn't working properly in one of its features, <a href="https://github.com/rudyrigot/meta-micro/issues">open a new issue in the micro GitHub repository</a>.</p><h2>Ask for help</h2><p>Feel free to ask a new question <a href="http://stackoverflow.com/questions/tagged/meta-micro">on StackOverflow</a>.</p>)
+      fragment.as_html(@link_resolver).gsub(/[\n\r]+/, '').gsub(/ +/, ' ').gsub(/&#39;/, "'").should == %(<h2>The meta-micro mailing-list</h2><p>This is where you go to give feedback, and discuss the future of micro. <a href="https://groups.google.com/forum/?hl=en#!forum/micro-meta-framework">Subscribe to the list now</a>!</p><h2>The micro GitHub repository</h2><p>This is where you get truly active, by forking the project's source code, and making it better. Please always feel free to send us pull requests.</p><div data-oembed="" data-oembed-type="link" data-oembed-provider="object"><div data-type="object"><a href="https://github.com/rudyrigot/meta-micro"><h1>rudyrigot/meta-micro</h1><img src="https://avatars2.githubusercontent.com/u/552279?s=400"><p>The meta-micro-framework you simply need</p></a></div></div><h2>Report bugs on micro</h2><p>If you think micro isn't working properly in one of its features, <a href="https://github.com/rudyrigot/meta-micro/issues">open a new issue in the micro GitHub repository</a>.</p><h2>Ask for help</h2><p>Feel free to ask a new question <a href="http://stackoverflow.com/questions/tagged/meta-micro">on StackOverflow</a>.</p>)
     end
   end
 
   describe 'linked documents' do
     it 'should have linked documents' do
-      response = @api.form("everything").query(%([[:d = any(document.type, ["doc","docchapter"])]])).submit(@master_ref)
+      response = @api.form('everything').query('[[:d = any(document.type, ["doc","docchapter"])]]').submit(@master_ref)
       linked_documents = response.results[0].linked_documents
       linked_documents.count.should == 1
-      linked_documents[0].id.should == "U0w8OwEAACoAQEvB"
+      linked_documents[0].id.should == 'U0w8OwEAACoAQEvB'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prismic.io
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Étienne Vallette d'Osia
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-06 00:00:00.000000000 Z
+date: 2014-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,6 +84,7 @@ files:
 - README.md
 - Rakefile
 - deploy-doc.sh
+- gulpfile.js
 - lib/prismic.rb
 - lib/prismic/api.rb
 - lib/prismic/cache/basic.rb
@@ -107,8 +108,10 @@ files:
 - lib/prismic/json_parsers.rb
 - lib/prismic/predicates.rb
 - lib/prismic/version.rb
+- package.json
 - prismic.gemspec
 - spec/cache_spec.rb
+- spec/doc_spec.rb
 - spec/fragments_spec.rb
 - spec/json_parsers_spec.rb
 - spec/lesbonneschoses_spec.rb
@@ -152,6 +155,7 @@ specification_version: 4
 summary: Prismic.io development kit
 test_files:
 - spec/cache_spec.rb
+- spec/doc_spec.rb
 - spec/fragments_spec.rb
 - spec/json_parsers_spec.rb
 - spec/lesbonneschoses_spec.rb