prismic.io 1.0.0.rc7 → 1.0.0.rc8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc69199255c2d6ef198403766b9bc0d54ab2b36e
-  data.tar.gz: 1613eaab5156a26ab56fdd2f2470dc3009256bd0
+  metadata.gz: 5e8407198320a76fe68735f7adbab9c99caf2540
+  data.tar.gz: ea27a831a0d80593f279ae187f0530a5094c6f3b
 SHA512:
-  metadata.gz: 9abb44957fddcea4d59a4526ab212d139921b9518eab7aa0038aaeaf3a982dbd4c55bab6f398927c372ceca0d9c6faad5822e8d5ffc18bae01f95947946fae9a
-  data.tar.gz: 28eef0cc87ca7504d0ec0fee7fc9ba05f02ca8bf50724627317918fb45b782047119d7c672f3885f0c4319cdc1c44de54bfb393d22f255305f33532e2001bc76
+  metadata.gz: 4dbc3131e382071d913859b15005f039c17323862c7da63d19ebabbfa766c0337c11aa462665985ed5714bbec4ad74820d6460640ff688bcf2ccbdc0d7b84fb9
+  data.tar.gz: 322c49ea82af8afe85a487c6a4643be5ad68671b73deec72e0a802bb9505161b843c53c7f139c385f73a77b3a22be379dbfb030fcc6af1d9efc048267db6a9e2

data/Gemfile.lock

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

data/README.md

@@ -37,14 +37,28 @@ Also on our [prismic.io developer's portal](https://developers.prismic.io/), on
  * get a thorough introduction of [how to use prismic.io kits](https://developers.prismic.io/documentation/UjBe8bGIJ3EKtgBZ/api-documentation#kits-and-helpers), including this one.
  * see [what else is available for Ruby](https://developers.prismic.io/technologies/UjBh6MuvzeMJvE4m/ruby): starter projects, examples, ...
 
+### Using the kit
+
 #### Kit's detailed documentation
 
 To get a detailed documentation of the Ruby kit's variables and methods, please check out the [prismic.io Ruby kit's documentation](http://rubydoc.info/github/prismicio/ruby-kit/master/frames).
 
+#### Specific Ruby kit syntax
+
 Thanks to Ruby's syntax, this kit contains some mild differences and syntastic sugar over [the "Kits and helpers" section of our API documentation](https://developers.prismic.io/documentation/UjBe8bGIJ3EKtgBZ/api-documentation#kits-and-helpers) in general (which you should read first). They are listed here:
+
  * When calling the API, a faster way to pass the `ref`: directly as a parameter of the `submit` method (no need to use the `ref` method then): `api.form("everything").submit(@ref)`.
  * Accessing type-dependent fields from a `document` is done through the `[]` operator (rather than a `get()` method). Printing the HTML version of a field therefore looks like `document["title_user_friendly"].as_html(link_resolver(@ref))`.
  * Two of the fields in the `DocumentLink` object (the one used to write your `link_resolver` method, for instance) were renamed to fit Ruby's best practice: `doc.type` is in fact `doc.link_type`, and `doc.isBroken` is in fact `doc.broken?`.
+ * You don't need to pass a `ctx` object in `as_html()`, you can use the `Prismic.link_resolver` static method to build a link resolver object that takes the `ref` into account, like this: `@link_resolver = Prismic.link_resolver(@ref) { |doc| ...  }`. Then you can simply go: `fragment.as_html(@link_resolver)`. Note: the Rails starter kit provides you with a helper allowing you to pass the ref each time you call the link resolver, like this: `fragment.as_html(link_resolver(@ref))`.
+ * the `Response` class is fit to work with the [Kaminari](https://github.com/amatsuda/kaminari) gem. So if you have a `@response` object in your controller, you can display a whole pagination for it in your view like this: `<%= paginate @response %>` (this works with any Rails 3 or 4 app with the Kaminari gem installed).
+
+Knowing all that, here is typical code written with the Ruby kit:
+
+ * A typical API object instantiation looks like this: `Prismic.api(url, opts)`
+ * A typical querying looks like this: `api.form('everything').query('[[:d = at(document.type, "product")]]').submit(@ref)`
+ * A typical fragment manipulation looks like this: `doc['article.image'].get_view('icon').url`
+ * A typical fragment serialization to HTML looks like this: `doc['article.body'].as_html(@link_resolver)`
 
 ### Changelog
 

data/lib/prismic/api.rb

@@ -88,28 +88,31 @@ module Prismic
       @json
     end
 
-    def self.get(url, access_token=nil, http_client=Prismic::DefaultHTTPClient)
+    def self.get(url, access_token=nil, http_client=Prismic::DefaultHTTPClient, api_cache=Prismic::DefaultApiCache)
       data = {}
       data["access_token"] = access_token if access_token
-      res = http_client.get(url, data, 'Accept' => 'application/json')
-      case res.code
-      when '200'
-        res
-      when '401', '403'
-        begin
-          json = JSON.load(res.body)
-          raise PrismicWSAuthError.new(
-            json['error'],
-            json['oauth_initiate'],
-            json['oauth_token'],
-            http_client
-          )
-        rescue => e
-          raise PrismicWSConnectionError.new(res, e)
+      cache_key = url + (access_token ? ("#" + access_token) : "")
+      api_cache.get_or_set(cache_key, expired_in:5) {
+        res = http_client.get(url, data, 'Accept' => 'application/json')
+        case res.code
+        when '200'
+          res
+        when '401', '403'
+          begin
+            json = JSON.load(res.body)
+            raise PrismicWSAuthError.new(
+              json['error'],
+              json['oauth_initiate'],
+              json['oauth_token'],
+              http_client
+            )
+          rescue => e
+            raise PrismicWSConnectionError.new(res, e)
+          end
+        else
+          raise PrismicWSConnectionError, res
         end
-      else
-        raise PrismicWSConnectionError, res
-      end
+      }
     end
 
     def self.start(url, opts={})
@@ -142,7 +145,7 @@ module Prismic
         }]
         api.refs = Hash[data_refs.map { |ref|
           scheduled_at = ref['scheduledAt']
-          [ref['label'].downcase, Ref.new(ref['ref'], ref['label'], ref['isMasterRef'], scheduled_at && Time.at(scheduled_at / 1000.0))]
+          [ref['label'].downcase, Ref.new(ref['id'], ref['ref'], ref['label'], ref['isMasterRef'], scheduled_at && Time.at(scheduled_at / 1000.0))]
         }]
         api.tags = data['tags']
         api.types = data['types']

data/lib/prismic/cache/basic.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+module Prismic
+
+  class BasicCacheEntry
+
+    attr_reader :expired_in
+    attr_reader :data
+
+    def initialize(data, expired_in = 0)
+      @data = data
+      @expired_in = expired_in
+    end
+  end
+
+  class BasicCache
+
+    attr_reader :cache
+    attr_reader :expirations
+
+    def initialize(data = {})
+      @cache = {}
+    end
+
+    def get(key)
+      return delete(key) if expired?(key)
+      include?(key) ? @cache[key].data : nil
+    end
+
+    def set(key, value = nil, expired_in = 0)
+      data = block_given? ? yield : value
+      expired_in = (expired_in == 0) ? 0 : Time.now.getutc.to_i + expired_in
+      entry = BasicCacheEntry.new(data, expired_in)
+      @cache[key] = entry
+      entry.data
+    end
+
+    def include?(key)
+      @cache.keys.include?(key)
+    end
+
+    def get_or_set(key, value = nil, expired_in = 0)
+      return get(key) if include?(key)
+      set(key, block_given? ? yield : value, expired_in)
+    end
+
+    def delete(key)
+      @cache.delete(key)
+      nil
+    end
+
+    def expired?(key)
+      if include?(key)
+        expired_in = @cache[key].expired_in
+        (expired_in != 0) && expired_in < Time.now.getutc.to_i
+      else
+        false
+      end
+    end
+
+    def clear()
+      @cache = {}
+    end
+  end
+
+  DefaultApiCache = BasicCache.new
+end

data/lib/prismic/{cache.rb → cache/lru.rb}

@@ -16,7 +16,7 @@ module Prismic
   # class you created as a :cache option. Therefore, to use this simple cache,
   # you can create your API object like this: `Prismic.api(url, cache:
   # Prismic::DefaultCache)`
-  class Cache
+  class LruCache
 
     # Based on http://stackoverflow.com/questions/1933866/efficient-ruby-lru-cache
     # The Hash are sorted, so the age is represented by the key order
@@ -127,5 +127,5 @@ module Prismic
 
   # This default instance is used by the API to avoid creating a new instance
   # per request (which would make the cache useless).
-  DefaultCache = Cache.new
+  DefaultCache = LruCache.new
 end

data/lib/prismic/json_parsers.rb

@@ -199,8 +199,17 @@ module Prismic
           end
         }]
 
+        linked_documents = json['linked_documents']
+        if linked_documents
+          linked_documents.map! do |linked_doc|
+            LinkedDocument.new(linked_doc['id'], linked_doc['type'], linked_doc['tags'])
+          end
+        else
+          linked_documents = []
+        end
+
         Prismic::Document.new(json['id'], json['type'], json['href'], json['tags'],
-                              json['slugs'], fragments)
+                              json['slugs'], linked_documents, fragments)
       end
 
       def results_parser(results)
@@ -209,9 +218,9 @@ module Prismic
         end
       end
 
-      def documents_parser(documents)
+      def response_parser(documents)
         raise FormSearchException, "Error : #{documents['error']}" if documents['error']
-        Prismic::Documents.new(
+        Prismic::Response.new(
           documents['page'],
           documents['results_per_page'],
           documents['results_size'],

data/lib/prismic/version.rb

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

data/lib/prismic.rb

@@ -228,7 +228,7 @@ module Prismic
     # @param ref [Ref, String] The {Ref reference} to use (if not already
     #     defined)
     #
-    # @return [Documents] The results (array of Document object + pagination
+    # @return [Response] The results (array of Document object + pagination
     #     specifics)
     def submit(ref = nil)
       self.ref(ref) if ref
@@ -246,7 +246,7 @@ module Prismic
           response = api.http_client.get(form_action, data, 'Accept' => 'application/json')
 
           if response.code.to_s == "200"
-            Prismic::JsonParser.documents_parser(JSON.parse(response.body))
+            Prismic::JsonParser.response_parser(JSON.parse(response.body))
           else
             body = JSON.parse(response.body) rescue nil
             error = body.is_a?(Hash) ? body['error'] : response.body
@@ -307,9 +307,13 @@ module Prismic
     alias :repeatable? :repeatable
   end
 
-  class Documents
+  class Response
     attr_accessor :page, :results_per_page, :results_size, :total_results_size, :total_pages, :next_page, :prev_page, :results
 
+    # To be able to use Kaminari as a paginator in Rails out of the box
+    alias :current_page :page
+    alias :limit_value :results_per_page
+
     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
@@ -347,15 +351,26 @@ module Prismic
     alias :size :length
   end
 
+  class LinkedDocument
+    attr_accessor :id, :type, :tags
+
+    def initialize(id, type, tags)
+      @id = id
+      @type = type
+      @tags = tags
+    end
+  end
+
   class Document
-    attr_accessor :id, :type, :href, :tags, :slugs, :fragments
+    attr_accessor :id, :type, :href, :tags, :slugs, :linked_documents, :fragments
 
-    def initialize(id, type, href, tags, slugs, fragments)
+    def initialize(id, type, href, tags, slugs, linked_documents, fragments)
       @id = id
       @type = type
       @href = href
       @tags = tags
       @slugs = slugs
+      @linked_documents = linked_documents
       @fragments = (fragments.is_a? Hash) ? parse_fragments(fragments) : fragments
     end
 
@@ -427,6 +442,11 @@ module Prismic
   # returns the same results.
   class Ref
 
+    # Returns the value of attribute id.
+    #
+    # @return [String]
+    attr_accessor :id
+
     # Returns the value of attribute ref.
     #
     # @return [String]
@@ -447,7 +467,8 @@ module Prismic
     # @return [Time]
     attr_accessor :scheduled_at
 
-    def initialize(ref, label, is_master = false, scheduled_at = nil)
+    def initialize(id, ref, label, is_master = false, scheduled_at = nil)
+      @id = id
       @ref = ref
       @label = label
       @is_master = is_master
@@ -550,4 +571,5 @@ require 'prismic/api'
 require 'prismic/form'
 require 'prismic/fragments'
 require 'prismic/json_parsers'
-require 'prismic/cache'
+require 'prismic/cache/lru'
+require 'prismic/cache/basic'

data/spec/cache_spec.rb

@@ -5,14 +5,14 @@ describe "Cache's" do
 
 	describe 'on/off switch' do
 		before do
-			@api = Prismic.api("https://lesbonneschoses.prismic.io/api", cache: Prismic::Cache.new(3))
+			@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::Cache).should == true
+			@cache.is_a?(Prismic::LruCache).should == true
 		end
 
 		it "is properly off" do
@@ -84,3 +84,58 @@ describe "Cache's" do
 		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'
+  end
+
+  it 'set with expiration value & get value' do
+	cache = Prismic::BasicCache.new
+	cache.set('key', 'value', 2)
+	sleep(3)
+	cache.get('key').should == nil
+  end
+
+  it 'set & test value' do
+	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'
+  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
+  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
+  end
+end

data/spec/json_parsers_spec.rb

@@ -316,7 +316,7 @@ describe 'document_parser' do
   end
 end
 
-describe 'documents_parser' do
+describe 'response_parser' do
 
   it "accepts basic documents response" do
     @json = JSON.parse('{ "page": 1,
@@ -327,7 +327,7 @@ describe 'documents_parser' do
       "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 = Prismic::JsonParser.response_parser(@json)
     @documents.results.should == []
     @documents.page.should == 1
     @documents.results_per_page.should == 20

data/spec/micro_spec.rb

@@ -15,4 +15,13 @@ describe 'micro' do
       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)
+      linked_documents = response.results[0].linked_documents
+      linked_documents.count.should == 1
+      linked_documents[0].id.should == "U0w8OwEAACoAQEvB"
+    end
+  end
 end

data/spec/prismic_spec.rb

@@ -10,10 +10,10 @@ describe 'Api' do
       api.tags = {}
       api.types = {}
       api.refs = {
-        'key1' => Prismic::Ref.new('ref1', 'label1'),
-        'key2' => Prismic::Ref.new('ref2', 'label2'),
-        'key3' => Prismic::Ref.new('ref3', 'label3', true),
-        'key4' => Prismic::Ref.new('ref4', 'label4'),
+        'key1' => Prismic::Ref.new('id1', 'ref1', 'label1'),
+        'key2' => Prismic::Ref.new('id2', 'ref2', 'label2'),
+        'key3' => Prismic::Ref.new('id3', 'ref3', 'label3', true),
+        'key4' => Prismic::Ref.new('id4', 'ref4', 'label4'),
       }
       api.forms = {
         'form1' => Prismic::Form.new(@api, 'form1', {}, nil, nil, nil, nil),
@@ -28,6 +28,12 @@ describe 'Api' do
     }
   end
 
+  describe 'id' do
+    it "returns the right id" do
+      @api.ref('key1').id.should == 'id1'
+    end
+  end
+
   describe 'ref' do
     it "returns the right Ref" do
       @api.ref('key2').label.should == 'label2'
@@ -253,7 +259,7 @@ end
 describe 'LinkResolver' do
   before do
     @doc_link = Prismic::Fragments::DocumentLink.new('id', 'blog-post', ['tag1', 'tag2'], 'my-slug', false)
-    @document = Prismic::Document.new('id', 'blog-post', nil, ['tag1', 'tag2'], ['my-slug', 'my-other-slug'], nil)
+    @document = Prismic::Document.new('id', 'blog-post', nil, ['tag1', 'tag2'], ['my-slug', 'my-other-slug'], nil, nil)
 
     @link_resolver = Prismic::LinkResolver.new(nil) do |doc|
       '/'+doc.link_type+'/'+doc.id+'/'+doc.slug
@@ -275,7 +281,7 @@ describe 'Document' do
       'field1' => Prismic::Fragments::DocumentLink.new(nil, nil, nil, nil, nil),
       'field2' => Prismic::Fragments::WebLink.new('weburl')
     }
-    @document = Prismic::Document.new(nil, nil, nil, nil, ['my-slug'], fragments)
+    @document = Prismic::Document.new(nil, nil, nil, nil, ['my-slug'], nil, fragments)
     @link_resolver = Prismic::LinkResolver.new('master'){|doc_link|
       "http://host/#{doc_link.id}"
     }

data/spec/responses_mocks/api.json

@@ -1,11 +1,13 @@
 {
    "refs":[
       {
+         "id":"master",
          "ref":"UfuJ2d_mqXoNBZDt",
          "label":"Master",
          "isMasterRef":true
       },
       {
+         "id":"release1",
          "ref":"foo",
          "label":"bar",
          "isMasterRef":false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prismic.io
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc7
+  version: 1.0.0.rc8
 platform: ruby
 authors:
 - "Étienne Vallette d'Osia"
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-14 00:00:00.000000000 Z
+date: 2014-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,7 +83,8 @@ files:
 - Rakefile
 - lib/prismic.rb
 - lib/prismic/api.rb
-- lib/prismic/cache.rb
+- lib/prismic/cache/basic.rb
+- lib/prismic/cache/lru.rb
 - lib/prismic/form.rb
 - lib/prismic/fragments.rb
 - lib/prismic/fragments/color.rb
@@ -137,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.3.0
 signing_key: 
 specification_version: 4
 summary: Prismic.io development kit