prismic.io 1.3.5 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c967051cf02c9b32c0efea073d4180ded1daa9c
-  data.tar.gz: 4a5fcb9e4d376fc317e8cc53bdcc84478130dc36
+  metadata.gz: a60dbb4b693926554c328099d394411b071b4a65
+  data.tar.gz: 9c8dfd97d137e2d40caae80449853fae4acabf15
 SHA512:
-  metadata.gz: 07b4f1a729ee39850383da4356f55b5b3443f48c7c5ba21a97e7576af5ba664081fb35040499832ae67382b10ea6e444bf3dfefcc05aa2a975f46a702a078ade
-  data.tar.gz: c38b558b6035ffeb43b296db4afe6a756158a5080cbcd0f77398ed6f35061b715ac91fd9502c302de20b3de26891c299b82f2cb841cb80d8eb09f41e8a6f8242
+  metadata.gz: 80ebc8910d0034882ff8ed3d7a75a26412c30be715a386f50d4194476b8d57e048ef17182003d113fb000b67b1f399dc33b32bb6bb3d17f1f13c191bcda69110
+  data.tar.gz: 8ade34a126227b09778476b7cc1b2683a7c61e6baf7e9656c7469c2c87916087d0fd045c1380686d0082a61affe31436acaeb7dea3fa5c76ee11911f8824d307

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    prismic.io (1.3.5)
+    prismic.io (1.4.0)
       hashery (~> 2.1.1)
 
 GEM

data/lib/prismic/api.rb

@@ -83,6 +83,38 @@ module Prismic
       form(name, data, ref)
     end
 
+    # Perform a query on this API. Use the master reference is no ref is specified in data.
+    # @param q [String] the query to perform
+    # @param data [Hash] query options (page, pageSize, ref, etc.)
+    def query(q, data={})
+      ref = data['ref'] || self.master.ref
+      form('everything', data).query(q).submit(ref)
+    end
+
+    # Retrieve one document by its id
+    # @param q [String] the query to perform
+    # @param data [Hash] query options (page, pageSize, ref, etc.)
+    # @return the document, or nil if not found
+    def getByID(id, data={})
+      query(Prismic::Predicates::at('document.id', id), data)[0]
+    end
+
+    # Retrieve one document by its uid
+    # @param q [String] the query to perform
+    # @param data [Hash] query options (page, pageSize, ref, etc.)
+    # @return the document, or nil if not found
+    def getByUID(typ, uid, data={})
+      query(Prismic::Predicates::at('my.'+typ+'.uid', uid), data)[0]
+    end
+
+    # Retrieve multiple documents by their ids
+    # @param q [String] the query to perform
+    # @param data [Hash] query options (page, pageSize, ref, etc.)
+    # @return the document, or nil if not found
+    def getByIDs(ids, data={})
+      query(Prismic::Predicates::in('document.id', ids), data)
+    end
+
     # Return the URL to display a given preview
     # @param token [String] as received from Prismic server to identify the content to preview
     # @param link_resolver the link resolver to build URL for your site

data/lib/prismic/predicates.rb

@@ -5,6 +5,10 @@ module Prismic
       ['at', fragment, value]
     end
 
+    def self.in(fragment, value)
+      ['in', fragment, value]
+    end
+
     def self.any(fragment, values)
       ['any', fragment, values]
     end
@@ -17,6 +21,14 @@ module Prismic
       ['similar', fragment, value]
     end
 
+    def self.has(fragment)
+      ['has', fragment]
+    end
+
+    def self.missing(fragment)
+      ['missing', fragment]
+    end
+
     def self.gt(fragment, value)
       ['number.gt', fragment, value]
     end
@@ -81,6 +93,14 @@ module Prismic
       ['date.year', fragment, year]
     end
 
+    def self.year_before(fragment, year)
+      ['date.year-before', fragment, year]
+    end
+
+    def self.year_after(fragment, year)
+      ['date.year-after', fragment, year]
+    end
+
     def self.hour(fragment, hour)
       ['date.hour', fragment, hour]
     end
@@ -110,4 +130,4 @@ module Prismic
     private_class_method :as_timestamp
 
   end
-end
+end

data/lib/prismic/version.rb

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

data/spec/doc_spec.rb

@@ -28,10 +28,7 @@ describe 'Documentation' do
       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')
-      .ref(st_patrick_ref)
-      .query(Prismic::Predicates::at('document.type', 'product'))
-      .submit
+      response = api.query(Prismic::Predicates::at('document.type', 'product'), 'ref' => st_patrick_ref)
       # The Response object contains all documents of type "product"
       # including the new "Saint-Patrick's Cupcake"
       # endgist
@@ -105,11 +102,7 @@ describe 'Documentation' do
 
     it 'text' do
       api = Prismic::api('https://lesbonneschoses.cdn.prismic.io/api')
-      response = api.form('everything')
-        .query(Predicates::at('document.id', 'UlfoxUnM0wkXYXbl'))
-        .ref(api.master_ref)
-        .submit
-      doc = response[0]
+      doc = api.getByID('UlfoxUnM0wkXYXbl')
       # startgist:4cbc1abffe7cc1209f95:prismic-getText.rb
       author = doc.get_text('blog-post.author')
       if author == nil

data/spec/fragments_spec.rb

@@ -668,11 +668,11 @@ describe 'Group' do
     @micro_api = Prismic.api('https://micro.prismic.io/api', nil)
     @master_ref = @micro_api.master_ref
     @docchapter = @micro_api.form('everything').query('[[:d = at(document.type, "docchapter")]]').orderings('[my.docchapter.priority]').submit(@master_ref)[0]
-    @link_resolver = Prismic.link_resolver('master'){|doc_link| "http://localhost/#{doc_link.link_type}/#{doc_link.id}" }
+    @link_resolver = Prismic.link_resolver('master'){|doc_link| "http://localhost/#{doc_link.type}/#{doc_link.id}" }
   end
 
   it 'accesses fields the proper way' do
-    @docchapter['docchapter.docs'][0]['linktodoc'].link_type.should == 'doc'
+    @docchapter['docchapter.docs'][0]['linktodoc'].type.should == 'doc'
   end
 
   it 'serializes towards HTML as expected' do
@@ -708,7 +708,7 @@ describe 'Slices' do
     @json_slices = JSON.load(@raw_json_slices)
     @doc = Prismic::JsonParser.document_parser(@json_slices)
     @slices = @doc.get_slice_zone("article.blocks")
-    @link_resolver = Prismic.link_resolver('master'){|doc_link| "http://localhost/#{doc_link.link_type}/#{doc_link.id}" }
+    @link_resolver = Prismic.link_resolver('master'){|doc_link| "http://localhost/#{doc_link.type}/#{doc_link.id}" }
   end
 
   it 'parses correctly' do

data/spec/json_parsers_spec.rb

@@ -23,7 +23,7 @@ json
   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.type.should == "product"
     document_link.tags.should == ['Macaron']
     document_link.slug.should == "dark-chocolate-macaron"
     document_link.broken?.should == false

data/spec/lesbonneschoses_spec.rb

@@ -20,12 +20,9 @@ describe 'LesBonnesChoses' do
     end
 
     it 'queries macarons (using a predicate) and returns 7 documents' do
-      @api.form('everything')
-        .query('[[:d = any(document.tags, ["Macaron"])]]')
-        .submit(@master_ref).results.size.should == 7
-      @api.form('everything')
-        .query('[[:d = any(document.tags, ["Macaron"])]]')
-        .submit(@master_ref).size.should == 7
+      @api.query('[[:d = any(document.tags, ["Macaron"])]]')
+        .results.size.should == 7
+      @api.query('[[:d = any(document.tags, ["Macaron"])]]').size.should == 7
     end
 
     it 'queries macarons (using a form) and returns 7 documents' do

data/spec/predicates_spec.rb

@@ -28,6 +28,13 @@ describe 'predicates' do
     end
   end
 
+  describe 'fulltext predicate' do
+    it 'with helper serializes well' do
+      form = @api.form('everything').query(Predicates.fulltext('document.type', ['article', 'blog-post']))
+      form.data['q'].should == ['[[:d = fulltext(document.type, ["article", "blog-post"])]]']
+    end
+  end
+
   describe 'similar predicate' do
     it 'as an array serializes well' do
       form = @api.form('everything').query(['similar', 'idOfSomeDocument', 10])
@@ -39,6 +46,28 @@ describe 'predicates' do
     end
   end
 
+  describe 'has predicate' do
+    it 'as an array serializes well' do
+      form = @api.form('everything').query(['has', 'my.blog-post.author'])
+      form.data['q'].should == ['[[:d = has(my.blog-post.author)]]']
+    end
+    it 'with helpers serializes well' do
+      form = @api.form('everything').query(Predicates.has('my.blog-post.author'))
+      form.data['q'].should == ['[[:d = has(my.blog-post.author)]]']
+    end
+  end
+
+  describe 'missing predicate' do
+    it 'as an array serializes well' do
+      form = @api.form('everything').query(['missing', 'my.blog-post.author'])
+      form.data['q'].should == ['[[:d = missing(my.blog-post.author)]]']
+    end
+    it 'with helpers serializes well' do
+      form = @api.form('everything').query(Predicates.missing('my.blog-post.author'))
+      form.data['q'].should == ['[[:d = missing(my.blog-post.author)]]']
+    end
+  end
+
   describe 'multiple predicates' do
     it 'as an array serializes well' do
       form = @api.form('everything').query(
@@ -56,6 +85,15 @@ describe 'predicates' do
     end
   end
 
+  describe 'number GT' do
+    it 'with helpers serializes well' do
+      form = @api.form('everything').query(
+          Predicates.gt('my.blog-post.publication-date', 4)
+      )
+      form.data['q'].should == ['[[:d = number.gt(my.blog-post.publication-date, 4)]]']
+    end
+  end
+
   describe 'number LT' do
     it 'with helpers serializes well' do
       form = @api.form('everything').query(
@@ -74,6 +112,186 @@ describe 'predicates' do
     end
   end
 
+  describe 'date is before' do
+    it 'with helpers serializes well' do
+      form = @api.form('everything').query(
+          Predicates.date_before('my.blog-post.publication-date', Date.parse('2016-03-02') )
+      )
+      form.data['q'].should == ["[[:d = date.before(my.blog-post.publication-date, #{Date.parse('2016-03-02').to_time.to_i * 1000})]]"]
+    end
+  end
+
+  describe 'date is after' do
+    it 'with helpers serializes well' do
+      form = @api.form('everything').query(
+          Predicates.date_after('my.blog-post.publication-date', Date.parse('2016-03-02') )
+      )
+      form.data['q'].should == ["[[:d = date.after(my.blog-post.publication-date, #{Date.parse('2016-03-02').to_time.to_i * 1000})]]"]
+    end
+  end
+
+  describe 'date is between' do
+    it 'with helpers serializes well' do
+      form = @api.form('everything').query(
+          Predicates.date_between('my.blog-post.publication-date', Date.parse('2016-03-02'), Date.parse('2016-03-04') )
+      )
+      form.data['q'].should == ["[[:d = date.between(my.blog-post.publication-date, #{Date.parse('2016-03-02').to_time.to_i * 1000}, #{Date.parse('2016-03-04').to_time.to_i * 1000})]]"]
+    end
+  end
+
+  describe 'day of month' do
+    it 'with helpers serializes well' do
+      form = @api.form('everything').query(
+          Predicates.day_of_month('my.blog-post.publication-date', 10)
+      )
+      form.data['q'].should == ['[[:d = date.day-of-month(my.blog-post.publication-date, 10)]]']
+    end
+  end
+
+  describe 'day of month after' do
+    it 'with helpers serializes well' do
+      form = @api.form('everything').query(
+          Predicates.day_of_month_after('my.blog-post.publication-date', 10)
+      )
+      form.data['q'].should == ['[[:d = date.day-of-month-after(my.blog-post.publication-date, 10)]]']
+    end
+  end
+
+  describe 'day of month before' do
+    it 'with helpers serializes well' do
+      form = @api.form('everything').query(
+          Predicates.day_of_month_before('my.blog-post.publication-date', 10)
+      )
+      form.data['q'].should == ['[[:d = date.day-of-month-before(my.blog-post.publication-date, 10)]]']
+    end
+  end
+
+  describe 'day of week' do
+    it 'with helpers serializes well' do
+      form = @api.form('everything').query(
+          Predicates.day_of_week('my.blog-post.publication-date', 7)
+      )
+      form.data['q'].should == ['[[:d = date.day-of-week(my.blog-post.publication-date, 7)]]']
+    end
+  end
+
+  describe 'day of week after' do
+    it 'with helpers serializes well' do
+      form = @api.form('everything').query(
+          Predicates.day_of_week_after('my.blog-post.publication-date', 7)
+      )
+      form.data['q'].should == ['[[:d = date.day-of-week-after(my.blog-post.publication-date, 7)]]']
+    end
+  end
+
+  describe 'day of week before' do
+    it 'with helpers serializes well' do
+      form = @api.form('everything').query(
+          Predicates.day_of_week_before('my.blog-post.publication-date', 7)
+      )
+      form.data['q'].should == ['[[:d = date.day-of-week-before(my.blog-post.publication-date, 7)]]']
+    end
+  end
+
+  describe 'month' do
+    it 'with helpers serializes well' do
+      form = @api.form('everything').query(
+          Predicates.month('my.blog-post.publication-date', 5)
+      )
+      form.data['q'].should == ['[[:d = date.month(my.blog-post.publication-date, 5)]]']
+    end
+    it 'with helpers serializes well' do
+      form = @api.form('everything').query(
+          Predicates.month('my.blog-post.publication-date', 'May')
+      )
+      form.data['q'].should == ['[[:d = date.month(my.blog-post.publication-date, "May")]]']
+    end
+  end
+
+  describe 'month after' do
+    it 'with helpers serializes well' do
+      form = @api.form('everything').query(
+          Predicates.month_after('my.blog-post.publication-date', 4)
+      )
+      form.data['q'].should == ['[[:d = date.month-after(my.blog-post.publication-date, 4)]]']
+    end
+    it 'with helpers serializes well' do
+      form = @api.form('everything').query(
+          Predicates.month_after('my.blog-post.publication-date', 'April')
+      )
+      form.data['q'].should == ['[[:d = date.month-after(my.blog-post.publication-date, "April")]]']
+    end
+  end
+
+  describe 'month before' do
+    it 'with helpers serializes well' do
+      form = @api.form('everything').query(
+          Predicates.month_before('my.blog-post.publication-date', 12)
+      )
+      form.data['q'].should == ['[[:d = date.month-before(my.blog-post.publication-date, 12)]]']
+    end
+    it 'with helpers serializes well' do
+      form = @api.form('everything').query(
+          Predicates.month_before('my.blog-post.publication-date', 'December')
+      )
+      form.data['q'].should == ['[[:d = date.month-before(my.blog-post.publication-date, "December")]]']
+    end
+  end
+
+  describe 'year' do
+    it 'with helpers serializes well' do
+      form = @api.form('everything').query(
+          Predicates.year('my.blog-post.publication-date', 2013)
+      )
+      form.data['q'].should == ['[[:d = date.year(my.blog-post.publication-date, 2013)]]']
+    end
+  end
+
+  describe 'year before' do
+    it 'with helpers serializes well' do
+      form = @api.form('everything').query(
+          Predicates.year_before('my.blog-post.publication-date', 2013)
+      )
+      form.data['q'].should == ['[[:d = date.year-before(my.blog-post.publication-date, 2013)]]']
+    end
+  end
+
+  describe 'year after' do
+    it 'with helpers serializes well' do
+      form = @api.form('everything').query(
+          Predicates.year_after('my.blog-post.publication-date', 2011)
+      )
+      form.data['q'].should == ['[[:d = date.year-after(my.blog-post.publication-date, 2011)]]']
+    end
+  end
+
+  describe 'hour' do
+    it 'with helpers serializes well' do
+      form = @api.form('everything').query(
+          Predicates.hour('my.blog-post.publication-date', 2)
+      )
+      form.data['q'].should == ['[[:d = date.hour(my.blog-post.publication-date, 2)]]']
+    end
+  end
+
+  describe 'hour before' do
+    it 'with helpers serializes well' do
+      form = @api.form('everything').query(
+          Predicates.hour_before('my.blog-post.publication-date', 12)
+      )
+      form.data['q'].should == ['[[:d = date.hour-before(my.blog-post.publication-date, 12)]]']
+    end
+  end
+
+  describe 'hour after' do
+    it 'with helpers serializes well' do
+      form = @api.form('everything').query(
+          Predicates.hour_after('my.blog-post.publication-date', 17)
+      )
+      form.data['q'].should == ['[[:d = date.hour-after(my.blog-post.publication-date, 17)]]']
+    end
+  end
+
   describe 'geopoint near' do
     it 'with helpers serializes well' do
       form = @api.form('everything').query(

data/spec/prismic_spec.rb

@@ -271,7 +271,7 @@ describe 'LinkResolver' do
     @document = Prismic::Document.new('id', nil, 'blog-post', nil, ['tag1', 'tag2'], ['my-slug', 'my-other-slug'], nil)
 
     @link_resolver = Prismic::LinkResolver.new(nil) do |doc|
-      '/'+doc.link_type+'/'+doc.id+'/'+doc.slug
+      '/'+doc.type+'/'+doc.id+'/'+doc.slug
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prismic.io
 version: !ruby/object:Gem::Version
-  version: 1.3.5
+  version: 1.4.0
 platform: ruby
 authors:
 - Étienne Vallette d'Osia
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-20 00:00:00.000000000 Z
+date: 2016-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler