contentful_rails 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: acff54ce8df7277286e663152c3456dd299d9f6e
+  data.tar.gz: fa9169f868f67296d300a09a7a0951f33b9c5c11
+SHA512:
+  metadata.gz: a99d3187b7e5f7160230c9b1b21f21cfba259a53d4d8b98e1b109a4916da637d46e3d6682ace25ef2c6882d4d3ce9ef280e6d003ba65668644a3269d3d743ed9
+  data.tar.gz: ac698630aae0f9b76f5d6c4c5042a8888dfbde5bd7be2876f2a1ced92299bf4760dcdae98f078a6c4163122794cb30a6f7735698b82cd2f7b679d30d94bed6e7

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Error Creative Studio
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ContentfulRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/controllers/contentful_rails/webhooks_controller.rb

@@ -0,0 +1,45 @@
+class ContentfulRails::WebhooksController < ActionController::Base
+  if ContentfulRails.configuration.authenticate_webhooks
+    http_basic_authenticate_with  name: ContentfulRails.configuration.webhooks_username,
+                                  password: ContentfulRails.configuration.webhooks_password
+  end
+
+  skip_before_filter :verify_authenticity_token, :only => [:create]
+
+  #this is where we receive a webhook, via a POST
+  def create
+    # The only things we need to handle in here (for now at least) are entries.
+    # If there's been an update or a deletion, we just remove the cached timestamp.
+    # The updated_at method which is included in ContentfulModel::Base in this gem
+    # will check the cache first before making the call to the API.
+
+    # We can then just use normal Rails russian doll caching without expensive API calls.
+    request.format = :json
+    update_type = request.headers['HTTP_X_CONTENTFUL_TOPIC']
+    content_type_id = params[:sys][:contentType][:sys][:id]
+    item_id = params[:sys][:id]
+    cache_key = "contentful_timestamp/#{content_type_id}/#{item_id}"
+
+    #delete the cache entry
+    if update_type =~ %r(Entry)
+      Rails.cache.delete(cache_key)
+    end
+
+    #must return an ok
+    render nothing: true
+  end
+
+  def debug
+    render text: "Debug method works ok"
+  end
+
+  private
+
+  def webhook_params
+    params.permit!
+    params.require(:sys).permit(:id, contentType: [sys: [:id]])
+  end
+
+
+
+end

data/app/helpers/contentful_rails/markdown_helper.rb

@@ -0,0 +1,10 @@
+module ContentfulRails
+  module MarkdownHelper
+    def parse_markdown(content)
+      @markdown ||= Redcarpet::Markdown.new(
+          Redcarpet::Render::HTML, autolink: true, space_after_headers: true, fenced_code_blocks: true
+      )
+      @markdown.render(content).html_safe
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,11 @@
+ContentfulRails::Engine.routes.draw do
+
+  resources :webhooks, only: [:create], defaults: { format: :json } do
+    collection do
+      scope constraints: ContentfulRails::DevelopmentConstraint do
+        get "/debug", to: "webhooks#debug"
+      end
+    end
+  end
+
+end

data/lib/contentful_rails/cached_timestamps.rb

@@ -0,0 +1,24 @@
+module ContentfulRails
+  #A module to prepend into ContentfulModel::Base which will allow the model instance
+  #to check the cache for its timestamp before making an expensive API call
+  module CachedTimestamps
+    def self.included(base)
+      base.class_eval do
+        alias_method_chain :updated_at, :caching
+      end
+    end
+
+    def updated_at_with_caching
+      Rails.cache.fetch(self.timestamp_cache_key) do
+        updated_at_without_caching
+      end
+    end
+
+    def timestamp_cache_key
+      "contentful_timestamp/#{self.class.content_type_id}/#{self.id}"
+    end
+
+  end
+
+end
+

data/lib/contentful_rails/development_constraint.rb

@@ -0,0 +1,5 @@
+class ContentfulRails::DevelopmentConstraint
+  def self.matches?(request)
+    Rails.env =~ %r{development} && (request.remote_ip =~ %r{127.0.0} || request.remote_ip =~ %r{^::1$})
+  end
+end

data/lib/contentful_rails/engine.rb

@@ -0,0 +1,36 @@
+module ContentfulRails
+  class Engine < ::Rails::Engine
+
+    isolate_namespace ContentfulRails
+
+    #Iterate through all models which inherit from ContentfulModel::Base
+    #and add an entry mapping for them, so calls to the Contentful API return
+    #the appropriate classes.
+    initializer "add_entry_mappings_for_contentful_models" do
+      if defined?(ContentfulModel)
+        Rails.application.eager_load!
+        ContentfulModel::Base.descendents.each do |klass|
+          klass.send(:add_entry_mapping)
+        end
+      end
+    end
+
+    initializer "add_contentful_mime_type" do
+      Mime::Type.register "application/json", :json, ["application/vnd.contentful.management.v1+json"]
+    end
+
+    config.to_prepare do
+      if defined?(::ContentfulModel)
+        ContentfulModel::Base.send(:include, ContentfulRails::CachedTimestamps)
+      end
+    end
+
+    #if we're at the end of initialization and there's no config object,
+    #set one up with the default options (i.e. an empty proc)
+    config.after_initialize do
+      if ContentfulRails.configuration.nil?
+        ContentfulRails.configure {}
+      end
+    end
+  end
+end

data/lib/contentful_rails/version.rb

@@ -0,0 +1,3 @@
+module ContentfulRails
+  VERSION = "0.0.4"
+end

data/lib/contentful_rails.rb

@@ -0,0 +1,23 @@
+require "contentful_rails/engine"
+require "contentful_rails/development_constraint"
+require "contentful_rails/cached_timestamps"
+require 'redcarpet'
+
+module ContentfulRails
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :authenticate_webhooks, :webhooks_username, :webhooks_password
+
+    def initialize
+      @authenticate = true
+    end
+  end
+end

data/lib/tasks/contentful_rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :contentful_rails do
+#   # Task goes here
+# end

data/test/contentful_rails_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class ContentfulRailsTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, ContentfulRails
+  end
+end

data/test/integration/navigation_test.rb

@@ -0,0 +1,10 @@
+require 'test_helper'
+
+class NavigationTest < ActionDispatch::IntegrationTest
+  fixtures :all
+
+  # test "the truth" do
+  #   assert true
+  # end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../../test/dummy/config/environment.rb",  __FILE__)
+ActiveRecord::Migrator.migrations_paths = [File.expand_path("../../test/dummy/db/migrate", __FILE__)]
+require "rails/test_help"
+
+Rails.backtrace_cleaner.remove_silencers!
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+# Load fixtures from the engine
+if ActiveSupport::TestCase.method_defined?(:fixture_path=)
+  ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: contentful_rails
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Error Creative Studio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.1.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.1.8
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: A gem to help with hooking Contentful into your Rails application
+email:
+- hosting@errorstudio.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- app/controllers/contentful_rails/webhooks_controller.rb
+- app/helpers/contentful_rails/markdown_helper.rb
+- config/routes.rb
+- lib/contentful_rails.rb
+- lib/contentful_rails/cached_timestamps.rb
+- lib/contentful_rails/development_constraint.rb
+- lib/contentful_rails/engine.rb
+- lib/contentful_rails/version.rb
+- lib/tasks/contentful_rails_tasks.rake
+- test/contentful_rails_test.rb
+- test/integration/navigation_test.rb
+- test/test_helper.rb
+homepage: https://github.com/errorstudio/contentful_rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A gem to help with hooking Contentful into your Rails application
+test_files:
+- test/contentful_rails_test.rb
+- test/integration/navigation_test.rb
+- test/test_helper.rb