prismic.io 1.0.0.preview.3 → 1.0.0.preview.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7115c0e2648174904a54f5b9eca2dee638c334a6
-  data.tar.gz: a6d17ff3c181ae1a273cbdc8956f114262854354
+  metadata.gz: 6e3f3af94b5219971b0b0dbdd62b195a0bb9a5ae
+  data.tar.gz: 157a7210a64dbf0e1a3f5de9b722b6222c7002a5
 SHA512:
-  metadata.gz: 5316b6aac4442b9a90f505a7d949ca07f6b0ca970700e081837c618f10a5a41e280ac86aec1a9214a70e04b4631c41fa233063e86cdde89338a2195448259a62
-  data.tar.gz: 98666ce830de416b0327a009cbb182df89acbe533eaf048a8d723b56fcbdd88ec303251c23771d28397295fc77347159bfa2beb1bfc86adc74ab57c646edb205
+  metadata.gz: 88eb3ea747a31a8226c3fb5f5c364e046e85e08013061510d7f5d55eb369bed64e56ef86bcb2f72220134975923fd7ea8becd557303823efc4e6ef9462cc3a95
+  data.tar.gz: 870e6c272bd7efe97346cdc4186e533a4332c5e2c940e30e183949278b89ccdf22d68942e3731d8d7f4ca61add02119b9ac60659ec7f332f7636a24f67c112d9

data/Gemfile.lock

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

data/README.md

@@ -30,7 +30,7 @@ require 'prismic'
 
 #### API Documentation
 
-You can browse the [API Documentation](http://prismicio.github.io/ruby-kit/).
+You can browse the [API Documentation](https://developers.prismic.io/documentation/UjBe8bGIJ3EKtgBZ/api-documentation).
 
 #### Use it
 

data/lib/prismic/api.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 module Prismic
   class API
     attr_reader :json, :access_token
@@ -27,6 +28,11 @@ module Prismic
       forms[name]
     end
 
+    def create_search_form(name, data={}, ref={})
+      form = self.form(name)
+      form and form.create_search_form(data, ref)
+    end
+
     def as_json
       @json
     end
@@ -56,16 +62,17 @@ module Prismic
       new(data, access_token) {|api|
         api.bookmarks = data['bookmarks']
         api.forms = Hash[data_forms.map { |k, form|
-          [k, SearchForm.new(api, Form.new(
+          [k, Form.new(
+            api,
             form['name'],
             Hash[form['fields'].map { |k2, field|
-              [k2, Field.new(field['type'], field['default'])]
+              [k2, Field.new(field['type'], field['default'], k2 == 'q')]
             }],
             form['method'],
             form['rel'],
             form['enctype'],
             form['action'],
-          ))]
+          )]
         }]
         api.refs = Hash[data_refs.map { |ref|
           scheduled_at = ref['scheduledAt']

data/lib/prismic/form.rb

@@ -1,8 +1,10 @@
+# encoding: utf-8
 module Prismic
   class Form
     attr_accessor :name, :form_method, :rel, :enctype, :action, :fields
 
-    def initialize(name, fields, form_method, rel, enctype, action)
+    def initialize(api, name, fields, form_method, rel, enctype, action)
+      @api = api
       @name = name
       @fields = fields
       @form_method = form_method
@@ -12,8 +14,11 @@ module Prismic
     end
 
     def default_data
-      Hash[fields.map{|key, field| [key, field.default] }.compact]
+      Hash[fields.map{|key, field| [key, field.default] if field.default }.compact]
     end
 
+    def create_search_form(data={}, ref=nil)
+      SearchForm.new(@api, self, data, ref)
+    end
   end
 end

data/lib/prismic/fragments/block.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 module Prismic
   module Fragments
   end

data/lib/prismic/fragments/color.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 module Prismic
   module Fragments
     class Color

data/lib/prismic/fragments/date.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 module Prismic
   module Fragments
     class Date

data/lib/prismic/fragments/embed.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 module Prismic
   module Fragments
     class Embed

data/lib/prismic/fragments/image.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 module Prismic
   module Fragments
     class Image

data/lib/prismic/fragments/link.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 module Prismic
   module Fragments
     class Link

data/lib/prismic/fragments/multiple.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 module Prismic
   module Fragments
     class Multiple

data/lib/prismic/fragments/number.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 module Prismic
   module Fragments
     class Number

data/lib/prismic/fragments/select.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 module Prismic
   module Fragments
     class Select

data/lib/prismic/fragments/structured_text.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 module Prismic
   module Fragments
     class StructuredText

data/lib/prismic/fragments/text.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 module Prismic
   module Fragments
     class Text

data/lib/prismic/fragments.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'prismic/fragments/block'
 require 'prismic/fragments/color'
 require 'prismic/fragments/date'

data/lib/prismic/json_parsers.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 module Prismic
   module JsonParser
     class << self
@@ -165,7 +166,13 @@ module Prismic
                               json['slugs'], fragments)
       end
 
-      private
+      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')
+          document_parser(doc)
+        end
+      end
 
       private
 

data/lib/prismic/version.rb

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

data/lib/prismic.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'net/http'
 require 'uri'
 
@@ -30,12 +31,13 @@ module Prismic
   end
 
   class SearchForm
-    attr_accessor :api, :form, :data
+    attr_accessor :api, :form, :data, :ref
 
-    def initialize(api, form, data={})
+    def initialize(api, form, data={}, ref=nil)
       @api = api
       @form = form
       @data = form.default_data.merge(data)
+      @ref = ref
     end
 
     def name
@@ -62,17 +64,18 @@ module Prismic
       form.fields
     end
 
-    def submit(ref)
+    def submit(ref = @ref)
+      raise NoRefSetException unless @ref
+
       if form_method == "GET" && enctype == "application/x-www-form-urlencoded"
         data['ref'] = ref
-        data.delete_if { |k, v| !v }
+        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_uri = uri.request_uri
-        request_uri += (request_uri =~ /\?/ ? '&' : '?') + "access_token=#{api.access_token}" if api.access_token
-        request = Net::HTTP::Get.new(request_uri)
+        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|
@@ -83,35 +86,47 @@ module Prismic
 
         raise FormSearchException, "Error : #{response.body}" if response.code != "200"
 
-        JSON.parse(response.body).map do |doc|
-          raise FormSearchException, "Error : #{doc['error']}" if doc.include?('error')
-          Prismic::JsonParser.document_parser(doc)
-        end
+        Prismic::JsonParser.results_parser(JSON.parse(response.body))
       else
         raise UnsupportedFormKind, "Unsupported kind of form: #{form_method} / #{enctype}"
       end
     end
 
     def query(query)
-      strip_brakets = ->(str) { str =~ /^\[(.*)\]$/ ? $1 : str }
-      previous_query = form.fields['q'] ? form.fields['q'].default.to_s : ''
-      data['q'] = "[%s%s]" % [strip_brakets.(previous_query), strip_brakets.(query)]
+      set('q', query)
       self
     end
 
+    def set(field_name, value)
+      field = @form.fields[field_name]
+      if field.repeatable?
+        data[field_name] = [] unless data.include? field_name
+        data[field_name] << value
+      else
+        data[field_name] = value
+      end
+    end
+
+    def ref(ref)
+      @ref = ref
+    end
+
+    class NoRefSetException < Error ; end
     class UnsupportedFormKind < Error ; end
     class RefNotFoundException < Error ; end
     class FormSearchException < Error ; end
   end
 
   class Field
-    attr_accessor :field_type, :default
+    attr_accessor :field_type, :default, :repeatable
 
-    def initialize(field_type, default)
+    def initialize(field_type, default, repeatable = false)
       @field_type = field_type
       @default = default
+      @repeatable = repeatable
     end
 
+    alias :repeatable? :repeatable
   end
 
   class Document
@@ -170,7 +185,6 @@ module Prismic
   def self.link_resolver(ref, &blk)
     LinkResolver.new(ref, &blk)
   end
-
 end
 
 require 'prismic/api'

data/spec/fragments_spec.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'spec_helper'
 
 describe 'WebLink' do

data/spec/json_parsers_spec.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 describe 'document_link_parser' do
   before do
     raw_json = <<json
@@ -277,6 +278,22 @@ 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 == []
+  end
+
+end
+
 describe 'multiple_parser' do
   before do
     raw_json = <<json

data/spec/prismic_spec.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'spec_helper'
 
 describe 'Api' do
@@ -15,10 +16,10 @@ describe 'Api' do
         'key4' => Prismic::Ref.new('ref4', 'label4'),
       }
       api.forms = {
-        'form1' => Prismic::SearchForm.new(@api, Prismic::Form.new('form1', {}, nil, nil, nil, nil)),
-        'form2' => Prismic::SearchForm.new(@api, Prismic::Form.new('form2', {}, nil, nil, nil, nil)),
-        'form3' => Prismic::SearchForm.new(@api, Prismic::Form.new('form3', {}, nil, nil, nil, nil)),
-        'form4' => Prismic::SearchForm.new(@api, Prismic::Form.new('form4', {}, nil, nil, nil, nil)),
+        'form1' => Prismic::Form.new(@api, 'form1', {}, nil, nil, nil, nil),
+        'form2' => Prismic::Form.new(@api, 'form2', {}, nil, nil, nil, nil),
+        'form3' => Prismic::Form.new(@api, 'form3', {}, nil, nil, nil, nil),
+        'form4' => Prismic::Form.new(@api, 'form4', {}, nil, nil, nil, nil),
       }
       api.oauth =  Prismic::API::OAuth.new(@oauth_initiate_url, "https://lesbonneschoses.prismic.io/auth/token")
     }
@@ -44,7 +45,14 @@ describe 'Api' do
 
   describe 'form' do
     it "return the right Form" do
-      @api.form('form2').form.name.should == 'form2'
+      @api.form('form2').name.should == 'form2'
+    end
+  end
+
+  describe 'create_search_form' do
+    it "create a new search form for the right form" do
+      @form = @api.create_search_form('form2')
+      @form.form.name.should == 'form2'
     end
   end
 
@@ -157,6 +165,15 @@ describe 'Api' do
       @parsed.forms['pies'].fields['q'].default.should ==
         '[[at(document.tags, ["Pie"])][any(document.type, ["product"])]]'
     end
+
+    it "create fields (other than 'q') as non repeatable" do
+      @parsed.forms['pies'].fields['ref'].repeatable.should be_false
+    end
+
+    it "create 'q' fields as repeatable" do
+      @parsed.forms['pies'].fields['q'].repeatable.should be_true
+    end
+
   end
 
   describe 'as_json' do
@@ -236,34 +253,67 @@ end
 
 describe 'SearchForm' do
   before do
+    @field = Prismic::Field.new('String', ['foo'], true)
     @api = nil
-    @field = Prismic::Field.new('String', '[foo]')
   end
 
-  describe 'query' do
-    it "adds the query to the form's data" do
-      @form = Prismic::SearchForm.new(@api, Prismic::Form.new('form1', {}, nil, nil, nil, nil), {})
-      @form.query('[bar]')
-      @form.data.should == { 'q' => '[bar]' }
+  def create_form(fields)
+    form = Prismic::Form.new(nil, 'form1', fields, nil, nil, nil, nil)
+    form.create_search_form
+  end
+
+  describe 'set() for queries' do
+
+    it "append value for repeatable fields" do
+      @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
+      @form.set('q', 'baz')
+      @form.data.should == { 'q' => ['foo', 'bar', 'baz'] }  # test an other
     end
 
-    it "adds existant non-nil queries (in fields) to the form's data" do
-      @form = Prismic::SearchForm.new(@api, Prismic::Form.new('form1', {'q' => @field}, nil, nil, nil, nil), {})
-      @form.query('[bar]')
-      @form.data.should == { 'q' => '[foobar]' }
+    it "replace value for non repeatable fields" do
+      @field = Prismic::Field.new('String', 'foo', false)
+      @form = create_form('q' => @field)
+      @form.set('q', 'bar')
+      @form.data.should == { 'q' => 'bar' }  # test the 1st call
+      @form.set('q', 'baz')
+      @form.data.should == { 'q' => 'baz' }  # test an other
+    end
+
+    it "create value array for repeatable fields without value" do
+      @field = Prismic::Field.new('String', nil, true)
+      @form = create_form('q' => @field)
+      @form.set('q', 'bar')
+      @form.data.should == { 'q' => ['bar'] }
+    end
+
+    it "create value for non repeatable fields without value" do
+      @field = Prismic::Field.new('String', nil, false)
+      @form = create_form('q' => @field)
+      @form.set('q', 'bar')
+      @form.data.should == { 'q' => 'bar' }
     end
 
     it "returns the form itself" do
-      @form = Prismic::SearchForm.new(@api, Prismic::Form.new('form1', {'q' => @field}, nil, nil, nil, nil), {})
-      @form.query('[foo]').should == @form
+      @form = create_form('q' => @field)
+      @form.query('foo').should equal @form
     end
 
     it "merge user defined params into default ones" do
       field = ->(value){ Prismic::Field.new('String', value) }
       default_params = {'param1' => field.('a'), 'param2' => field.('b')}
-      user_params = {'param1' => 'a2'}
-      @form = Prismic::SearchForm.new(@api, Prismic::Form.new('form1', default_params, nil, nil, nil, nil), user_params)
+      @form = create_form(default_params)
+      @form.set('param1', 'a2')
       @form.data.should == {'param1' => 'a2', 'param2' => 'b'}
     end
   end
+
+  describe 'submit' do
+    it "raises an exception if no ref is set" do
+      @form = create_form('q' => @field)
+      expect { @form.submit }.to raise_error Prismic::SearchForm::NoRefSetException
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'nokogiri'
 begin
   require 'yajl'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prismic.io
 version: !ruby/object:Gem::Version
-  version: 1.0.0.preview.3
+  version: 1.0.0.preview.5
 platform: ruby
 authors:
 - Étienne Vallette d'Osia
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-18 00:00:00.000000000 Z
+date: 2013-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler