prismic.io 1.0.0.preview.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f251fe260baae8f6d9759bdb71e67cc2754ccd2d
+  data.tar.gz: e7e13a4e8f6c225633f7134d47a42457a8e65e4a
+SHA512:
+  metadata.gz: 9ba102393aba6870ef0992fde91d090331368103906674ba94f75f1202ab8ed5729ce67153721a6874b52987a3e9bb1a94de88424d523c1ca7dc9959544da949
+  data.tar.gz: e42b10fe090f8adfca57267f456896da72e4b6474743f6acceaf3ff1bae4ac03094783d11e472dfe6d11186ab05b0c4f884a3a22856780205b64151f8dee4c30

data/.gitignore

@@ -0,0 +1,2 @@
+coverage/
+pkg/*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in truc.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    Prismic (1.0.0.preview.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    mini_portile (0.5.1)
+    multi_json (1.8.0)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.4)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.2)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    yajl-ruby (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  Prismic!
+  bundler (~> 1.3)
+  nokogiri (~> 1.6)
+  rspec (~> 2.14)
+  simplecov (~> 0.7)
+  yajl-ruby (~> 1.1)

data/README.md

@@ -0,0 +1,43 @@
+## Ruby development kit for prismic.io
+
+### Getting Started
+
+#### Install using bundler
+
+You can this line in your Gemfile:
+
+```ruby
+gem 'prismic.io', require: 'prismic'
+```
+
+#### Install manually
+
+Run in shell:
+
+```sh
+gem install prismic.io
+```
+
+then add in your code:
+
+```ruby
+require 'prismic'
+```
+
+#### API Documentation
+
+You can browse the [API Documentation](http://prismicio.github.io/ruby-kit/).
+
+#### Use it
+
+You can look at the [rails starter](https://github.com/prismicio/ruby-rails-starter) project to see how to use it :-)
+
+### Licence
+
+This software is licensed under the Apache 2 license, quoted below.
+
+Copyright 2013 Zengularity (http://www.zengularity.com).
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/prismic.rb

@@ -0,0 +1,167 @@
+require 'net/http'
+require 'uri'
+
+module Prismic
+
+  # These exception can contains an error cause and is able to show them
+  class Error < Exception
+    attr_reader :cause
+    def initialize(msg=nil, cause=nil)
+      msg ? super(msg) : msg
+      @cause = cause
+    end
+    def full_trace(e=self)
+      first, *backtrace = e.backtrace
+      msg = e == self ? "" : "Caused by "
+      msg += "#{first}: #{e.message} (#{e.class})"
+      stack = backtrace.map{|s| "\tfrom #{s}" }.join("\n")
+      cause = e.respond_to?(:cause) ? e.cause : nil
+      cause_stack = cause ? full_trace(cause) : nil
+      [msg, stack, cause_stack].compact.join("\n")
+    end
+  end
+
+  def self.api(*args)
+    API.start(*args)
+  end
+
+  class ApiData
+    attr_accessor :refs, :bookmarks, :types, :tags, :forms
+  end
+
+  class SearchForm
+    attr_accessor :form, :data
+
+    def initialize(form, data=form.default_data)
+      @form = form
+      @data = data
+    end
+
+    def name
+      form.name
+    end
+
+    def form_method
+      form.form_method
+    end
+
+    def rel
+      form.rel
+    end
+
+    def enctype
+      form.enctype
+    end
+
+    def action
+      form.action
+    end
+
+    def fields
+      form.fields
+    end
+
+    def submit(ref)
+      if form_method == "GET" && enctype == "application/x-www-form-urlencoded"
+        data['ref'] = ref
+        data.delete_if { |k, v| !v }
+
+        uri = URI(action)
+        uri.query = URI.encode_www_form(data)
+
+        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|
+          http.request(request)
+        end
+
+        raise RefNotFoundException, "Ref #{ref} not found" if response.code == "404"
+
+        JSON.parse(response.body).map do |doc|
+          Prismic::JsonParser.document_parser(doc)
+        end
+      else
+        raise UnsupportedFormKind, "Unsupported kind of form: #{form_method} / #{enctype}"
+      end
+    end
+
+    def query(query)
+      strip_brakets = Proc.new {|str| str.strip[1, str.strip.length - 2]}
+
+      previous_query = (not form.fields['q'].nil?) ? form.fields['q'].default.to_s : ''
+      data['q'] = "[#{strip_brakets.call(previous_query)}#{strip_brakets.call(query)}]"
+      self
+    end
+
+    class UnsupportedFormKind < Error ; end
+    class RefNotFoundException < Error ; end
+  end
+
+  class Field
+    attr_accessor :field_type, :default
+
+    def initialize(field_type, default)
+      @field_type = field_type
+      @default = default
+    end
+
+  end
+
+  class Document
+    attr_accessor :id, :type, :href, :tags, :slugs, :fragments
+
+    def initialize(id, type, href, tags, slugs, fragments)
+      @id = id
+      @type = type
+      @href = href
+      @tags = tags
+      @slugs = slugs
+      @fragments = (fragments.is_a? Hash) ? parse_fragments(fragments) : fragments
+    end
+
+    def slug
+      slugs.empty? ? '-' : slugs.first
+    end
+
+    def as_html(link_resolver)
+      fragments.map { |field, fragment|
+        %(<section data-field="#{field}">#{fragment.as_html(link_resolver)}</section>)
+      }.join("\n")
+    end
+
+    private
+
+    def parse_fragments(fragments)
+      fragments
+    end
+  end
+
+  class Ref
+    attr_accessor :ref, :label, :is_master, :scheduledAt
+
+    def initialize(ref, label, is_master = false)
+      @ref = ref
+      @label = label.downcase
+      @is_master = is_master
+    end
+
+    alias :master? :is_master
+  end
+
+  class LinkResolver
+    attr_reader :ref
+    def initialize(ref, &blk)
+      @ref = ref
+      @blk = blk
+    end
+    def link_to(doc_link)
+      @blk.call(doc_link)
+    end
+  end
+end
+
+require 'prismic/api'
+require 'prismic/form'
+require 'prismic/fragments'
+require 'prismic/json_parsers'

data/lib/prismic/api.rb

@@ -0,0 +1,94 @@
+module Prismic
+  class API
+    attr_accessor :refs, :bookmarks, :forms, :master, :tags, :types
+
+    def initialize(args)
+      @json = args.fetch(:json)
+      @bookmarks = args.fetch(:bookmarks)
+      @refs = args.fetch(:refs)
+      @forms = args.fetch(:forms)
+      @tags = args.fetch(:tags)
+      @types = args.fetch(:types)
+      self.master = refs.values.map { |ref| ref if ref.master? }.compact.first
+      raise BadPrismicResponseError, "No master Ref found" unless master
+    end
+
+    def bookmark(name)
+      bookmarks[name]
+    end
+
+    def ref(name)
+      refs[name]
+    end
+
+    def ref_id_by_label(label)
+      refs.find { |k, ref| k == label }.last
+    end
+
+    def form(name)
+      forms[name]
+    end
+
+    def as_json
+      @json
+    end
+
+    def self.get(url, token=nil)
+      url = url + "?access_token=" + token if token
+      puts url
+      uri = URI(url)
+      http = Net::HTTP.new(uri.host)
+      path = token ? "#{uri.path}?access_token=#{token}" : uri.path
+      req = Net::HTTP::Get.new(path, 'Accept' => 'application/json')
+      res = http.request(req)
+
+      if res.code == '200'
+        res
+      else
+        raise PrismicWSConnectionError, res
+      end
+    end
+
+    def self.start(url, token=nil)
+      resp = get(url, token)
+      json = JSON.load(resp.body)
+      parse_api_response(json)
+    end
+
+    def self.parse_api_response(data)
+      data_forms = data['forms'] || []
+      data_refs = data.fetch('refs'){ raise BadPrismicResponseError, "No refs given" }
+      new({
+        json: data,
+        bookmarks: data['bookmarks'],
+        forms: Hash[data_forms.map { |k, form|
+          [k, SearchForm.new(Form.new(
+            form['name'],
+            Hash[form['fields'].map { |k2, field|
+              [k2, Field.new(field['type'], field['default'])]
+            }],
+            form['method'],
+            form['rel'],
+            form['enctype'],
+            form['action'],
+          ))]
+        }],
+        refs: Hash[data_refs.map { |ref|
+          [ref['label'], Ref.new(ref['ref'], ref['label'], ref['isMasterRef'])]
+        }],
+        tags: data['tags'],
+        types: data['types'],
+      })
+    end
+
+    private
+
+    class BadPrismicResponseError < Error ; end
+
+    class PrismicWSConnectionError < Error
+      def initialize(resp, cause=nil)
+        super("Can't connect to Prismic's API: #{resp.code} #{resp.message}", cause)
+      end
+    end
+  end
+end

data/lib/prismic/form.rb

@@ -0,0 +1,19 @@
+module Prismic
+  class Form
+    attr_accessor :name, :form_method, :rel, :enctype, :action, :fields
+
+    def initialize(name, fields, form_method, rel, enctype, action)
+      @name = name
+      @fields = fields
+      @form_method = form_method
+      @rel = rel
+      @enctype = enctype
+      @action = action
+    end
+
+    def default_data
+      Hash[fields.map{|key, field| [key, field.default] }.compact]
+    end
+
+  end
+end

data/lib/prismic/fragments.rb

@@ -0,0 +1,11 @@
+require 'prismic/fragments/block'
+require 'prismic/fragments/color'
+require 'prismic/fragments/date'
+require 'prismic/fragments/embed'
+require 'prismic/fragments/image'
+require 'prismic/fragments/link'
+require 'prismic/fragments/multiple'
+require 'prismic/fragments/number'
+require 'prismic/fragments/select'
+require 'prismic/fragments/structured_text'
+require 'prismic/fragments/text'

data/lib/prismic/fragments/block.rb

@@ -0,0 +1,4 @@
+module Prismic
+  module Fragments
+  end
+end

data/lib/prismic/fragments/color.rb

@@ -0,0 +1,31 @@
+module Prismic
+  module Fragments
+    class Color
+      attr_accessor :value
+
+      def initialize(value)
+        @value = value
+      end
+
+      def asRGB
+        Fragments::Color.asRGB(@value)
+      end
+
+      def self.asRGB(value)
+        {
+          'red'   => value[0..1].to_i(16),
+          'green' => value[2..3].to_i(16),
+          'blue'  => value[4..5].to_i(16)
+        }
+      end
+
+      def as_html(link_resolver=nil)
+        %(<span class="color">##@value</span>)
+      end
+
+      def self.valid?(value)
+        /(\h{2})(\h{2})(\h{2})/ ===  value
+      end
+    end
+  end
+end

data/lib/prismic/fragments/date.rb

@@ -0,0 +1,15 @@
+module Prismic
+  module Fragments
+    class Date
+      attr_accessor :value
+
+      def initialize(value)
+        @value = value
+      end
+
+      def as_html(link_resolver=nil)
+        %(<time>#{value.iso8601(3)}</time>)
+      end
+    end
+  end
+end