prismic.io 1.0.0.rc5 → 1.0.0.rc6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca80b38d048125991d9ddb08ae46e30ff195a315
-  data.tar.gz: 175dbc5a5df2492651e3eb3794f9bcd0ea5d3117
+  metadata.gz: 8f817e26c9531dedb21f23cae69edbcf8f5a1f77
+  data.tar.gz: 41cd13bd44d6a052b0e770f138b6d70cf799b21e
 SHA512:
-  metadata.gz: 4f1d0d419feeb6cfe59e08c8e1e8b3ce40371407ecfa7d0ded8971f2e943d0588edce93f469d5e1a6d5a66ccec1b7f4ed6aeacc715ac7fdc92797ea54dd2fb1f
-  data.tar.gz: 24189dbe64510b5023e9ad339bd408910724eff3c034f60c36a6ec0d227994e9c46a973c965cfca1956f33538ba17b22600c579fa94791a28640771b89c70728
+  metadata.gz: 4cbfe1c5347987bd16de9c244d4d89c13bf2ea2a79315e3094215ec63a5aa9f2ba20936701e92d6aa7c6cb74291421b958b7bb785aed03845914d19fb0f7c5d8
+  data.tar.gz: 63767dc468b7a7f93c1bc8b4b1afcf4bedac8bf839dd4e8480e1f56cbabc1bf04ef999f565be4efaf10d477a114d1a63195cb86ffc48c90712bb20de07dbc689

data/Gemfile.lock

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

data/lib/prismic.rb

@@ -43,6 +43,7 @@ module Prismic
   #   @param [Hash] opts The options
   #   @option opts [String] :access_token (nil) The access_token
   #   @option opts :http_client (DefaultHTTPClient) The HTTP client to use
+  #   @option opts :cache (nil) The caching object (for instance Prismic::Cache) to use, or false for no caching
   # @overload api(url, access_token)
   #   Provide the access_token (only)
   #   @param [String] url The URL of the prismic.io repository
@@ -178,26 +179,31 @@ module Prismic
       self.ref(ref) if ref
       raise NoRefSetException unless @ref
 
-      if form_method == "GET" && form_enctype == "application/x-www-form-urlencoded"
-        data['ref'] = @ref
-        data['access_token'] = api.access_token if api.access_token
-        data.delete_if { |k, v| v.nil? }
+      # cache_key is a mix of HTTP URL and HTTP method
+      cache_key = form_method+'::'+form_action+'?'+data.map{|k,v|"#{k}=#{v}"}.join('&')
 
-        response = api.http_client.get(form_action, data, 'Accept' => 'application/json')
+      api.caching(cache_key) {
+        if form_method == "GET" && form_enctype == "application/x-www-form-urlencoded"
+          data['ref'] = @ref
+          data['access_token'] = api.access_token if api.access_token
+          data.delete_if { |k, v| v.nil? }
 
-        if response.code.to_s == "200"
-          Prismic::JsonParser.documents_parser(JSON.parse(response.body))
+          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))
+          else
+            body = JSON.parse(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 FormSearchException, error
+          end
         else
-          body = JSON.parse(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 FormSearchException, error
+          raise UnsupportedFormKind, "Unsupported kind of form: #{form_method} / #{enctype}"
         end
-      else
-        raise UnsupportedFormKind, "Unsupported kind of form: #{form_method} / #{enctype}"
-      end
+      }
     end
 
     # Specify a parameter for this form
@@ -440,3 +446,4 @@ require 'prismic/api'
 require 'prismic/form'
 require 'prismic/fragments'
 require 'prismic/json_parsers'
+require 'prismic/cache'

data/lib/prismic/api.rb

@@ -1,11 +1,31 @@
 # encoding: utf-8
+
 module Prismic
   class API
+    @@cache = nil
     @@warned_create_search_form = false
     @@warned_oauth_initiate_url = false
     @@warned_oauth_check_token = false
     attr_reader :json, :access_token, :http_client
-    attr_accessor :refs, :bookmarks, :forms, :tags, :types, :oauth
+    attr_accessor :refs, :bookmarks, :forms, :tags, :types, :oauth, :cache
+
+    # Is the cache enabled on this API object?
+    #
+    # @return [Boolean]
+    def has_cache?
+      !!cache
+    end
+
+    # Calls the given block if the provided key is not already cached
+    #
+    # If the cache is disabled, the block is always called
+    #
+    # @param key [String] the cache's key to test
+    #
+    # @return the return of the given block
+    def caching(key)
+      cache ? cache.get(key){ yield(key) } : yield(key)
+    end
 
     # Returns the master {Ref reference}
     # @api
@@ -14,11 +34,12 @@ module Prismic
     attr_accessor :master
     alias :master_ref :master
 
-    def initialize(json, access_token, http_client)
+    def initialize(json, access_token, http_client, cache)
       @json = json
       @access_token = access_token
       @http_client = http_client
       yield self if block_given?
+      @cache = cache
       self.master = refs.values && refs.values.map { |ref| ref if ref.master? }.compact.first
       raise BadPrismicResponseError, "No master Ref found" unless master
     end
@@ -93,15 +114,17 @@ module Prismic
     def self.start(url, opts={})
       http_client = opts[:http_client] || Prismic::DefaultHTTPClient
       access_token = opts[:access_token]
+      cache = opts[:cache]
+      cache ||= Prismic::DefaultCache unless cache == false
       resp = get(url, access_token, http_client)
       json = JSON.load(resp.body)
-      parse_api_response(json, access_token, http_client)
+      parse_api_response(json, access_token, http_client, cache)
     end
 
-    def self.parse_api_response(data, access_token, http_client)
+    def self.parse_api_response(data, access_token, http_client, cache)
       data_forms = data['forms'] || []
       data_refs = data.fetch('refs'){ raise BadPrismicResponseError, "No refs given" }
-      new(data, access_token, http_client) {|api|
+      new(data, access_token, http_client, cache) {|api|
         api.bookmarks = data['bookmarks']
         api.forms = Hash[data_forms.map { |k, form|
           [k, Form.new(

data/lib/prismic/cache.rb

@@ -0,0 +1,123 @@
+# encoding: utf-8
+module Prismic
+  # This is a simple cache class provided with the prismic.io Ruby kit.
+  # It is pretty dumb but effective:
+  #  * everything is stored in memory,
+  #  * invalidation: not needed for prismic.io documents (they are eternally immutable), but we don't want the cache to expand indefinitely; therefore all cache but the new master ref is cleared when a new master ref gets published.
+  #
+  # If you need a smarter caching (for instance, caching in files), you can extend this class and replace its methods,
+  # and when creating your API object like this for instance: Prismic.api(url, options), pass the name of the 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
+
+    # Based on http://stackoverflow.com/questions/1933866/efficient-ruby-lru-cache
+    # The Hash are sorted, so the age is represented by the key order
+
+    # Returns the cache object holding the responses to "results" queries (lists of documents).
+    # This is a Hash in a Hash: keys in the outer Hash are the refs (so that it's easy to invalidate entire refs at once);
+    # keys in the inner Hash are the query strings (URLs) of each query.
+    # The object that is stored as a cache_object is what is returned by Prismic::JsonParser::results_parser
+    # (so that we don't have to parse anything again, it's stored already parsed).
+    #
+    # @return [Hash<String,Object>]
+    attr_reader :intern
+
+    # Returns the maximum of keys to store
+    #
+    # @return [Fixum]
+    attr_reader :max_size
+
+    # @param max_size [Fixnum] (100) The default maximum of keys to store
+    def initialize(max_size=100)
+      @intern = {}
+      @max_size = max_size
+    end
+
+    # Add a cache entry.
+    #
+    # @param key [String] the key
+    # @param value the value to store
+    #
+    # @return the value
+    def store(key, value)
+      @intern.delete(key)
+      @intern[key] = value
+      if @intern.length > @max_size
+        @intern.delete(@intern.first[0])
+      end
+      value
+    end
+    alias :[]= :store
+
+    # Update the maximun number of keys to store
+    #
+    # Prune the cache old oldest keys if the new max_size is older than the keys
+    # number.
+    #
+    # @param max_size [Fixnum] the new maximun number of keys to store
+    def max_size=(max_size)
+      raise ArgumentError.new(:max_size) if max_size < 1
+      @max_size = max_size
+      if @max_size < @intern.size
+        @intern.keys[0 .. (@max_size-@intern.size)].each { |k|
+          @intern.delete(k)
+        }
+      end
+    end
+
+    # Get a cache entry
+    #
+    # A block can be provided: it will be used to compute (and store) the value
+    # if the key is missing.
+    #
+    # @param key [String] the key to fetch
+    #
+    # @return [Object] the cache object as was stored
+    def get(key)
+      found = true
+      value = @intern.delete(key){ found = false }
+      if found
+        @intern[key] = value
+      else
+        self[key] = yield(key)
+      end
+    end
+    alias :[] :get
+
+    # Checks if a cache entry exists
+    #
+    # @param key [String] the key to test
+    #
+    # @return [Boolean]
+    def include?(key)
+      @intern.include?(key)
+    end
+
+    # Invalidates all the cache
+    def invalidate_all!
+      @intern.clear
+    end
+    alias :clear! :invalidate_all!
+
+    # Expose a Hash of the keys of both Hashes. The keys of this Hash is the ref_ids, the values are arrays of cache_keys.
+    # This is only for displaying purposes, if you want to check out what's stored in your cache without checking out the
+    # quite verbose cache_objects.
+    #
+    # @return [Array<String>]
+    def keys
+      @intern.keys
+    end
+
+    # Return the number of stored keys
+    #
+    # @return [Fixum]
+    def size
+      @intern.size
+    end
+    alias :length :size
+
+  end
+
+  DefaultCache = Cache.new
+end

data/lib/prismic/json_parsers.rb

@@ -148,14 +148,13 @@ module Prismic
             Prismic::Fragments::StructuredText::Block::Image.new(view)
           when 'embed'
             boembed = block['oembed']
-            embed = Prismic::Fragments::Embed.new(
+            Prismic::Fragments::Embed.new(
               boembed['type'],
               boembed['provider_name'],
               boembed['provider_url'],
               boembed['html'],
               boembed
             )
-            Prismic::Fragments::StructuredText::Block::Image.new(embed)
           else
             puts "Unknown bloc type: #{block['type']}"
           end

data/lib/prismic/version.rb

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

data/spec/cache_spec.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe "Cache's" do
+
+	describe 'on/off switch' do
+		before do
+			@api = Prismic.api("https://lesbonneschoses.prismic.io/api", cache: Prismic::Cache.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
+		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
+	end
+end

data/spec/micro_spec.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe 'micro' do
+  before do
+    @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}" }
+  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(%([[:d = 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>)
+    end
+  end
+end

data/spec/prismic_spec.rb

@@ -5,7 +5,7 @@ describe 'Api' do
   before do
     json_representation = '{"foo": "bar"}'
     @oauth_initiate_url = "https://lesbonneschoses.prismic.io/auth"
-    @api = Prismic::API.new(json_representation, nil, Prismic::DefaultHTTPClient){|api|
+    @api = Prismic::API.new(json_representation, nil, Prismic::DefaultHTTPClient, false){|api|
       api.bookmarks = {}
       api.tags = {}
       api.types = {}
@@ -111,18 +111,18 @@ describe 'Api' do
     before do
       @data = File.read("#{File.dirname(__FILE__)}/responses_mocks/api.json")
       @json = JSON.parse(@data)
-      @parsed = Prismic::API.parse_api_response(@json, nil, Prismic::DefaultHTTPClient)
+      @parsed = Prismic::API.parse_api_response(@json, nil, Prismic::DefaultHTTPClient, false)
     end
 
     it "does not allow to be created without master Ref" do
       expect {
-        Prismic::API.parse_api_response({"refs" => []}, nil, Prismic::DefaultHTTPClient)
+        Prismic::API.parse_api_response({"refs" => []}, nil, Prismic::DefaultHTTPClient, false)
       }.to raise_error(Prismic::API::BadPrismicResponseError, "No master Ref found")
     end
 
     it "does not allow to be created without any Ref" do
       expect {
-        Prismic::API.parse_api_response({}, nil, Prismic::DefaultHTTPClient)
+        Prismic::API.parse_api_response({}, nil, Prismic::DefaultHTTPClient, false)
       }.to raise_error(Prismic::API::BadPrismicResponseError, "No refs given")
     end
 
@@ -259,11 +259,11 @@ describe 'LinkResolver' do
       '/'+doc.link_type+'/'+doc.id+'/'+doc.slug
     end
   end
-  
+
   it "builds the right URL from a DocumentLink" do
     @link_resolver.link_to(@doc_link).should == '/blog-post/id/my-slug'
   end
-  
+
   it "builds the right URL from a Document" do
     @link_resolver.link_to(@document).should == '/blog-post/id/my-slug'
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prismic.io
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc5
+  version: 1.0.0.rc6
 platform: ruby
 authors:
 - "Étienne Vallette d'Osia"
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-04 00:00:00.000000000 Z
+date: 2014-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,6 +82,7 @@ files:
 - Rakefile
 - lib/prismic.rb
 - lib/prismic/api.rb
+- lib/prismic/cache.rb
 - lib/prismic/form.rb
 - lib/prismic/fragments.rb
 - lib/prismic/fragments/color.rb
@@ -99,9 +100,11 @@ files:
 - lib/prismic/json_parsers.rb
 - lib/prismic/version.rb
 - prismic.gemspec
+- spec/cache_spec.rb
 - spec/fragments_spec.rb
 - spec/json_parsers_spec.rb
 - spec/lesbonneschoses_spec.rb
+- spec/micro_spec.rb
 - spec/oauth_spec.rb
 - spec/prismic_spec.rb
 - spec/responses_mocks/api.json
@@ -138,9 +141,11 @@ signing_key:
 specification_version: 4
 summary: Prismic.io development kit
 test_files:
+- spec/cache_spec.rb
 - spec/fragments_spec.rb
 - spec/json_parsers_spec.rb
 - spec/lesbonneschoses_spec.rb
+- spec/micro_spec.rb
 - spec/oauth_spec.rb
 - spec/prismic_spec.rb
 - spec/responses_mocks/api.json