prismic_rails 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b661aa54deff7c406f834ddd6da31318cbb75d4f
-  data.tar.gz: ba0aecffc2202919bea3da0a318a98b476401b3b
+  metadata.gz: 020d3bd11b1873d59943f9bd97178578c350b53a
+  data.tar.gz: 00b2e319e63e1f4550d443ee960dfee32375d85c
 SHA512:
-  metadata.gz: bb3cb78090badadb3370356ec4b12030e17f4ad7b991d3efadcac1d6cf928a541c9426e39add6aa9be53e80d7a83c2aaa576a8f9650ba67df7cdc7b8c3061d20
-  data.tar.gz: 7b08ab8b08a078073a668e63d8db3e408580cb81933924fe12603bb38f41ec14be78a4bafdeda3cf196067549ce81810c10c942d4711515469f1c72abb9e991b
+  metadata.gz: 16594c30edb833d0b6a835680da5cc35ec818a41ff9ec0ae69fec7504ddbf1d139d7dbf5d3e521a821b98e74ba9a45ce687c8c86429ce1594e7d607f289c938f
+  data.tar.gz: 1279b6f79edd3aef343c6e3e740127d15c63db142a0a017b97d677ebae2cb901706c22f257e6266c6c280063434058a03ae5153ccd9b93e74c3001933e5df08b

data/.env

@@ -1 +1,2 @@
 PRISMIC_API_URL='https://prismic-rails.prismic.io/api'
+PRISMIC_ACCESS_TOKEN='MC5Xb1FQa3lzQUFLMVN3RVh4.ZXo4Uu-_ve-_vXXvv73vv73vv71echEp77-9EzFx77-9MO-_vSXvv71MEO-_vScZ77-977-9XO-_vQ'

data/bin/console

@@ -1,7 +1,10 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "prismicRails"
+require 'dotenv'
+require 'bundler/setup'
+require 'pry'
+require 'rails'
+require 'prismic_rails'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +13,13 @@ require "prismicRails"
 # require "pry"
 # Pry.start
 
-require "irb"
+Dotenv.load
+
+PrismicRails.configure do |config|
+  config.url = ENV.fetch("PRISMIC_API_URL", "")
+  config.token = ENV.fetch("PRISMIC_ACCESS_TOKEN", nil)
+end
+
+require 'irb'
 IRB.start(__FILE__)
+

data/lib/generators/templates/prismic_rails.rb

@@ -6,15 +6,15 @@ PrismicRails.configure do |config|
   # Set the access token of prismic if you have one
   config.token = ENV["PRISMIC_ACCESS_TOKEN"]
 
-  # Language machting of your app locale to prismic locale:
+  ## Language machting of your app locale to prismic locale:
   #  Example
   # config.languages = {
-  #   'en' => 'en-gb',
+  #   'en' => 'en-us',
   #   'de' => 'de-ch',
   #   'fr' => 'fr-ch',
   #   'it' => 'it-ch'
   # }
-  #
-  # Set if PrismicRails should use rails caching
+
+  ## Set if PrismicRails should use rails caching
   # config.caching = true
 end

data/lib/prismic_rails/content/document.rb

@@ -12,12 +12,12 @@ module PrismicRails
     end
 
     # Returns the document as safe html
-    def to_html
-      @document.as_html(nil).html_safe
+    def as_html(serializer = nil)
+      @document.as_html(serializer)
     end
 
     # Returns only the text of a document
-    def to_text
+    def as_text
       @document.as_text
     end
 
@@ -26,7 +26,11 @@ module PrismicRails
     #    +type+ 'text', 'image' etc
     def find_fragment(type)
       fragment = @document.fragments[type]
-      return PrismicRails::Fragment.new(fragment) || NilDocument.new
+      if fragment
+        PrismicRails::Fragment.new(fragment)
+      else
+        NilDocument.new
+      end
     end
 
     # Tests if the document has the type type.

data/lib/prismic_rails/content/fragment.rb

@@ -10,12 +10,12 @@ module PrismicRails
     end
 
     # Returns the document as safe html
-    def to_html
-      @fragment.as_html(nil).html_safe
+    def as_html(serializer = nil)
+      @fragment.as_html(serializer)
     end
 
     # Returns only the text of a document
-    def to_text
+    def as_text
       @fragment.as_text
     end
 

data/lib/prismic_rails/content/nil_document.rb

@@ -10,15 +10,19 @@ module PrismicRails
     end
 
     # Returns the document as safe html, in this case simply an empty string
-    def to_html
+    def as_html(serializer = nil)
       @document
     end
 
     # Returns the document as text, in this case simply an empty string
-    def to_text
+    def as_text
       @document
     end
 
+    def find_fragment(type)
+      PrismicRails::Fragment.new(PrismicRails::NilDocument.new)
+    end
+
     # Returns the type nil of the NilDocument
     def type
       nil

data/lib/prismic_rails/content/result.rb

@@ -13,12 +13,13 @@ module PrismicRails
     # ==== Attributes
     #  +response+ The response of the Prismic API query
     def initialize(response)
-      if response.results
+      if response && response.results && !response.results.empty?
         @documents = response.results.map do |document|
           PrismicRails::Document.new(document)
         end
-      else #Handles the case if the response is nil
-        @documents = []
+      else #Handles the case if the response is nil or empty
+        nil_document = PrismicRails::NilDocument.new
+        @documents = [nil_document]
       end
     end
 
@@ -35,5 +36,13 @@ module PrismicRails
       end
     end
 
+    def first
+      @documents.first
+    end
+
+    def last
+      @documents.last
+    end
+
   end
 end

data/lib/prismic_rails/helpers/view_helpers.rb

@@ -33,7 +33,7 @@ module PrismicRails
     def prismic_type(type, options = {}, &block)
 
       query = Proc.new do
-        result = PrismicRails::QueryService.type(type, options)
+        result = PrismicRails::QueryService.by_type(type, options)
         capture(result, &block)
       end
 

data/lib/prismic_rails/railtie.rb

@@ -14,8 +14,6 @@ module PrismicRails
       PrismicRails.configure do |config|
         config.url = app.config.prismic_rails[:url]
         config.token = app.config.prismic_rails[:token]
-        config.client_id = app.config.prismic_rails[:client_id]
-        config.client_secret = app.config.prismic_rails[:client_secret]
         config.languages = app.config.prismic_rails[:languages]
         config.caching = app.config.prismic_rails[:caching]
       end

data/lib/prismic_rails/services/language_service.rb

@@ -1,3 +1,5 @@
+require 'active_support/core_ext/hash/indifferent_access'
+
 # :nodoc:
 module PrismicRails
   # The PrismicRails::LanguageService tries to match your i18n locale to the

data/lib/prismic_rails/services/query_service.rb

@@ -7,10 +7,7 @@ module PrismicRails
     # :nodoc:
     class << self
 
-      # Constant that holds the query string to query the document type
-      DOCUMENT_TYPE = 'document.type'.freeze
-
-      # Query the Prismic API with a type
+      # Query the Prismic API by type
       # ==== Examples
       #   PrismicRails::QueryService.type('blog-post')
       #
@@ -21,25 +18,30 @@ module PrismicRails
       #
       # This gets all the (published) documents of
       # the type 'blog-post' in english as a Prismic::Response and wraps it around with a PrismicRails::Result
-      #
-      def type(type, options = {})
-        match_language options if options[:lang]
-        response = query(predicates(type), options)
-        PrismicRails::Result.new(response)
+      def by_type(type, options = {})
+        type_query = {'document.type': type}
+        if options[:q]
+          options[:q].merge(type_query)
+        else
+          options[:q] = type_query
+        end
+        query(options)
       end
 
-      private
-
-      # Do the actual query against the Prismic API
-      def query(predicates, options)
-        api.query(predicates,
-                 options)
+      # Query the Prismic API
+      def query(options = {})
+        match_language(options) if options[:lang]
+        predicates = []
+        if q = options.delete(:q)
+          q.each do |key, value|
+            predicates << Prismic::Predicates.at(key, value)
+          end
+        end
+        response = api.query(predicates, options)
+        PrismicRails::Result.new(response)
       end
 
-      # Creates the Prismic::Predicates for a given type
-      def predicates type
-        Prismic::Predicates.at(DOCUMENT_TYPE, type)
-      end
+      private
 
       # Returns the Prismic::Api object
       def api

data/lib/prismic_rails/version.rb

@@ -1,5 +1,5 @@
 # :nodoc:
 module PrismicRails
   # :nodoc:
-  VERSION = "0.3.0"
+  VERSION = "1.0.0"
 end

data/lib/prismic_rails.rb

@@ -13,11 +13,12 @@ require "prismic_rails/content/nil_document.rb"
 # :nodoc:
 module PrismicRails
 
+  class NoPrismicAPIConnection < StandardError; end
+
   # A simple Config class that holds the config objects
   class Config
     attr_accessor :url,       # Prismic API URL
-      :token,                 # Prismic API Token 
-      :client_id,             # Client ID
+      :token,                 # Prismic API Token :client_id,             # Client ID
       :client_secret,         # Client Secret
       :languages,             # Language maching hash
       :caching                # Changing enabled?
@@ -42,7 +43,7 @@ module PrismicRails
       Prismic::API::PrismicWSAuthError,
       SocketError,
       Net::OpenTimeout
-        @api = nil
+        raise NoPrismicAPIConnection
     end
   end
 
@@ -77,12 +78,4 @@ module PrismicRails
     api.master_ref.ref
   end
 
-  def self.find(document_type, fragment_id, options = {})
-    if options[:lang]
-      PrismicRails::QueryService.type(document_type, lang: options[:lang]).find_fragment(fragment_id)
-    else
-      PrismicRails::QueryService.type(document_type).find_fragment(fragment_id)
-    end
-  end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prismic_rails
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Felix Langenegger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-20 00:00:00.000000000 Z
+date: 2018-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prismic.io