prismic.io 1.0.0.rc2 → 1.0.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f3ceb1f0344bdcb62956f4f7a5cc1726f7bd71d
-  data.tar.gz: 15093ac28e13027b611f19dcf0ef5d0711b9e6f0
+  metadata.gz: 406a3849f94ecdfd3516db68fa2ee0d36ecf1c6a
+  data.tar.gz: f6988c94934d3a900af92cf6973dbb3c8d46d135
 SHA512:
-  metadata.gz: f01b158ca5911cca23adeb97c1a5113d17d5e40e4a548074fe787ec7737c1b44e6676d56156a808d215ec6e834a7f1fc57c08aad759c7cc1ba49e110f76a3abb
-  data.tar.gz: b62bfd8113a345921a3700e797d1839f49f0257fbd5f68313fdd392a417aa80c5e0244175a7dbfbb5696312f8198aeda44bfc6bc6ce3a4312c83a09183657eee
+  metadata.gz: 4f69e94c2b76f58b859ab8fac98c5a7a2ad09f2330fc05e1cf66daebf2d5913ac4d7f514d65f44833a4c10d8e98a3253bd0c6c7716e3bb9351a8218269dfc86b
+  data.tar.gz: 2f09cbb004acd083ffb16ab02dc19ab2e4862d019b105456d658de1f066528c1151a9c41695573dc6d98f7e147bf7eecb4bb9b68d4b55b6939bab041d781aa1e

data/Gemfile.lock

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

data/lib/prismic.rb

@@ -161,7 +161,7 @@ module Prismic
     #
     # @param  ref [Ref, String] The {Ref reference} to use (if not already defined)
     #
-    # @return [Array<Document>] The results
+    # @return [Documents] The results (array of Document object + pagination specifics)
     def submit(ref = nil)
       self.ref(ref) if ref
       raise NoRefSetException unless @ref
@@ -174,7 +174,7 @@ module Prismic
         response = api.http_client.get(form_action, data, 'Accept' => 'application/json')
 
         if response.code.to_s == "200"
-          Prismic::JsonParser.results_parser(JSON.parse(response.body))
+          Prismic::JsonParser.documents_parser(JSON.parse(response.body))
         else
           body = JSON.parse(response.body) rescue nil
           error = body.is_a?(Hash) ? body['error'] : response.body
@@ -234,6 +234,36 @@ module Prismic
     alias :repeatable? :repeatable
   end
 
+  class Documents
+    attr_accessor :page, :results_per_page, :results_size, :total_results_size, :total_pages, :next_page, :prev_page, :results
+
+    def initialize(page, results_per_page, results_size, total_results_size, total_pages, next_page, prev_page, results)
+      @page = page
+      @results_per_page = results_per_page
+      @results_size = results_size
+      @total_results_size = total_results_size
+      @total_pages = total_pages
+      @next_page = next_page
+      @prev_page = prev_page
+      @results = results
+    end
+
+    # Accessing the i-th document in the results
+    def [](i)
+      @results[i]
+    end
+
+    def each(&blk)
+      @results.each(&blk)
+    end
+    include Enumerable  # adds map, select, etc
+
+    def length
+      @results.length
+    end
+    alias :size :length
+  end
+
   class Document
     attr_accessor :id, :type, :href, :tags, :slugs, :fragments
 

data/lib/prismic/json_parsers.rb

@@ -204,14 +204,26 @@ module Prismic
                               json['slugs'], fragments)
       end
 
-      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|
+      def results_parser(results)
+        results.map do |doc|
           document_parser(doc)
         end
       end
 
+      def documents_parser(documents)
+        raise FormSearchException, "Error : #{documents['error']}" if documents['error']
+        Prismic::Documents.new(
+          documents['page'],
+          documents['results_per_page'],
+          documents['results_size'],
+          documents['total_results_size'],
+          documents['total_pages'],
+          documents['next_page'],
+          documents['prev_page'],
+          results_parser(documents['results'])
+        )
+      end
+
       private
 
       def link_parser(json)

data/lib/prismic/version.rb

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

data/spec/json_parsers_spec.rb

@@ -316,18 +316,26 @@ describe 'document_parser' do
   end
 end
 
-describe 'results_parser' do
-
-  it "accepts results as an array" do
-    @json = JSON.parse('[]')
-    @results = Prismic::JsonParser.results_parser(@json)
-    @results.should == []
-  end
-
-  it "accepts results as an object" do
-    @json = JSON.parse('{"results":[]}')
-    @results = Prismic::JsonParser.results_parser(@json)
-    @results.should == []
+describe 'documents_parser' do
+
+  it "accepts basic documents response" do
+    @json = JSON.parse('{ "page": 1,
+      "results_per_page": 20,
+      "results_size": 20,
+      "total_results_size": 40,
+      "total_pages": 2,
+      "next_page": "https://lesbonneschoses.prismic.io/api/documents/search?ref=UkL0hcuvzYUANCrm&page=2&pageSize=20",
+      "prev_page": null,
+      "results":[]}')
+    @documents = Prismic::JsonParser.documents_parser(@json)
+    @documents.results.should == []
+    @documents.page.should == 1
+    @documents.results_per_page.should == 20
+    @documents.results_size.should == 20
+    @documents.total_results_size.should == 40
+    @documents.total_pages.should == 2
+    @documents.next_page.should == "https://lesbonneschoses.prismic.io/api/documents/search?ref=UkL0hcuvzYUANCrm&page=2&pageSize=20"
+    @documents.prev_page.should == nil
   end
 
 end

data/spec/lesbonneschoses_spec.rb

@@ -16,25 +16,66 @@ describe 'LesBonnesChoses' do
 	describe 'query' do
 		it "queries everything and returns 20 documents" do
 			@api.form("everything").submit(@master_ref).size.should == 20
+			@api.form("everything").submit(@master_ref).results.size.should == 20
 		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
 		end
 
 		it "queries macarons (using a form) and returns 7 documents" do
+			@api.form("macarons").submit(@master_ref).results.size.should == 7
 			@api.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.form("products")
+				.query(%([[:d = any(document.tags, ["Cupcake", "Macaron"])]]))
+				.submit(@master_ref).results.size.should == 11
 			@api.form("products")
 				.query(%([[:d = any(document.tags, ["Cupcake", "Macaron"])]]))
 				.submit(@master_ref).size.should == 11
 		end		
 	end
 
+	describe 'pagination' do
+		it "works in basic cases" do
+			documents = @api.form("everything").submit(@master_ref)
+			documents.page.should == 1
+			documents.results_per_page.should == 20
+			documents.results_size.should == 20
+			documents.total_results_size.should == 40
+			documents.total_pages.should == 2
+			documents.next_page.should == "https://lesbonneschoses.prismic.io/api/documents/search?ref=UkL0hcuvzYUANCrm&page=2&pageSize=20"
+			documents.prev_page.should == nil
+		end
+		it "works on page 2" do
+			documents = @api.form("everything").page("2").submit(@master_ref)
+			documents.page.should == 2
+			documents.results_per_page.should == 20
+			documents.results_size.should == 20
+			documents.total_results_size.should == 40
+			documents.total_pages.should == 2
+			documents.next_page.should == nil
+			documents.prev_page.should == "https://lesbonneschoses.prismic.io/api/documents/search?ref=UkL0hcuvzYUANCrm&page=1&pageSize=20"
+		end
+		it "works on page 2 with a pagination step of 10" do
+			documents = @api.form("everything").page("2").page_size("10").submit(@master_ref)
+			documents.page.should == 2
+			documents.results_per_page.should == 10
+			documents.results_size.should == 10
+			documents.total_results_size.should == 40
+			documents.total_pages.should == 4
+			documents.next_page.should == "https://lesbonneschoses.prismic.io/api/documents/search?ref=UkL0hcuvzYUANCrm&page=3&pageSize=10"
+			documents.prev_page.should == "https://lesbonneschoses.prismic.io/api/documents/search?ref=UkL0hcuvzYUANCrm&page=1&pageSize=10"
+		end
+	end
+
 	describe 'API::Document' do
 		before do
 			@document = @api.form('everything').query(%([[:d = at(document.id, "UkL0gMuvzYUANCpf")]])).submit(@master_ref)[0]
@@ -55,6 +96,28 @@ describe 'LesBonnesChoses' do
 		end
 	end
 
+	describe 'API::Documents' do
+		before do
+			@documents = @api.form('everything').submit(@master_ref)
+		end
+
+		it 'has a working [] operator' do
+			@documents[0].slug.should == @documents.results[0].slug
+		end
+		it 'has a proper size' do
+			@documents.length.should == 20
+			@documents.size.should == 20
+		end
+		it 'has a proper each method' do
+			array = []
+			@documents.each {|document| array << document.slug }
+			array.join(' ').should == 'pastry-dresser exotic-kiwi-pie apricot-pie sweet-strawberry-pie woodland-cherry-pie cool-coconut-macaron salted-caramel-macaron the-end-of-a-chapter-the-beginning-of-a-new-one get-the-right-approach-to-ganache one-day-in-the-life-of-a-les-bonnes-choses-pastry les-bonnes-chosess-internship-a-testimony our-world-famous-pastry-art-brainstorm-event tips-to-dress-a-pastry triple-chocolate-cupcake dont-be-a-stranger about-us wedding-gift-box art-director store-intern content-director'
+		end
+		it 'is a proper Enumerable' do
+			@documents.map {|document| document.slug }.join(' ').should == 'pastry-dresser exotic-kiwi-pie apricot-pie sweet-strawberry-pie woodland-cherry-pie cool-coconut-macaron salted-caramel-macaron the-end-of-a-chapter-the-beginning-of-a-new-one get-the-right-approach-to-ganache one-day-in-the-life-of-a-les-bonnes-choses-pastry les-bonnes-chosess-internship-a-testimony our-world-famous-pastry-art-brainstorm-event tips-to-dress-a-pastry triple-chocolate-cupcake dont-be-a-stranger about-us wedding-gift-box art-director store-intern content-director'
+		end
+	end
+
 	describe 'Fragments' do
 		before do
 			@link_resolver = Prismic.link_resolver("master"){|doc_link| "http://localhost/#{doc_link.id}" }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prismic.io
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc2
+  version: 1.0.0.rc3
 platform: ruby
 authors:
 - Étienne Vallette d'Osia
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-12 00:00:00.000000000 Z
+date: 2014-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler