contentful-scheduler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4cc702a2147e9c4e058dc6d127ebcb881b3f333f
+  data.tar.gz: 572bbe565827d7ecc00245adc776e1217ab8b4dd
+SHA512:
+  metadata.gz: 51f8f0fe78824e9d431b63600daa168681b7b577cfd128d9db55d1df29783f487f85455a054a9e0e4122f76ea1f5c5f9633cbfbfafb057ad174108907c868b7a
+  data.tar.gz: 09ab916ac339b3ac5b9627d7c63cec79ed14d690d0b59fd7c6ca3b7702d69e47094b2aa7b210a70e05d79a437dfac1fdc6b988b7ac5342a3b8dfb35feacb7494

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+dump.rdb

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: 'rspec --format documentation --color' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Contentful GmbH
+
+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/README.md

@@ -0,0 +1,181 @@
+# Contentful Scheduler
+
+Scheduling Server for Contentful entries.
+
+## Contentful
+[Contentful](http://www.contentful.com) is a content management platform for web applications,
+mobile apps and connected devices. It allows you to create, edit & manage content in the cloud
+and publish it anywhere via powerful API. Contentful offers tools for managing editorial
+teams and enabling cooperation between organizations.
+
+## What does `contentful-scheduler` do?
+The aim of `contentful-scheduler` is to have developers setting up their Contentful
+entries for scheduled publishing.
+
+## How does it work
+`contentful-scheduler` provides a web endpoint to receive webhook calls from Contentful,
+every time the endpoint recieves a call it looks for the value of the field defined in the configuration,
+if the value is a time in the future it will schedule the entry for publishing at the specified time.
+A background worker based on the popular `resque` gem will then proceed to actually make the publish call
+against the Content Management API at the due time. For this the Entries you wish to publish require a
+customizable Date field, which we advice to call `publishDate`, this field can be configured inside your
+`Rakefile` and is specific per-space.
+
+You can add multiple spaces to your configuration, making it useful if you have a milti-space setup.
+
+## Requirements
+
+* [Redis](http://redis.io/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'contentful-scheduler'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install contentful-scheduler
+
+## Usage
+
+The best way to use Scheduler is as a stand-alone application that wraps Scheduler and Resque on an execution pipe using [Foreman](http://ddollar.github.io/foreman/).
+
+You can get the template for this setup in the [`/example`](./example) directory.
+
+If you want to roll out your own, you need to follow the next steps:
+
+* Create a new folder
+* Create a `Gemfile` with the following:
+
+```ruby
+source 'https://rubygems.org'
+
+gem 'contentful-scheduler', '~> 0.1'
+gem 'contentful-management', '~> 1.0'
+gem 'resque', '~> 1.0'
+gem 'resque-scheduler', '~> 4.0'
+gem 'rake'
+```
+
+* Create a `Procfile` with the following:
+
+```
+web: env bundle exec rake contentful:scheduler
+monitor: env bundle exec rackup
+resque: env bundle exec rake resque:work
+resque_scheduler: env bundle exec rake resque:scheduler
+```
+
+* Create a `Rakefile` with the following:
+
+```ruby
+require 'contentful/scheduler'
+
+$stdout.sync = true
+
+config = {
+  logger: Logger.new(STDOUT), # Defaults to NullLogger
+  port: 32123, # Defaults to 32123
+  endpoint: '/scheduler', # Defaults to /scheduler
+  redis: {
+    host: 'YOUR_REDIS_HOST',
+    port: 'YOUR_REDIS_PORT',
+    password: 'YOUR_REDIS_PASSWORD'
+  },
+  spaces: {
+    'YOUR_SPACE_ID' => {
+      publish_field: 'publishDate', # It specifies the field ID for your Publish Date in your Content Type
+      management_token: 'YOUR_TOKEN'
+    }
+  },
+}
+
+namespace :contentful do
+  task :setup do
+    Contentful::Scheduler.config = config
+  end
+
+  task :scheduler => :setup do
+    Contentful::Scheduler.start
+  end
+end
+
+require 'resque/tasks'
+require 'resque/scheduler/tasks'
+
+namespace :resque do
+  task :setup => 'contentful:setup' do
+    ENV['QUEUE'] = '*'
+  end
+
+  task :setup_schedule => :setup do
+    require 'resque-scheduler'
+  end
+
+  task :scheduler => :setup_schedule
+end
+```
+
+* Create a `config.ru` with the following for the Resque monitoring server:
+
+```ruby
+require 'resque'
+require 'resque/server'
+require 'resque/scheduler/server'
+
+config = {
+  host: 'YOUR_REDIS_HOST',
+  port: 'YOUR_REDIS_PORT',
+  password: 'YOUR_REDIS_PASSWORD'
+}
+Resque.redis = config
+
+run Rack::URLMap.new \
+  "/" => Resque::Server.new
+```
+
+* Run the Application:
+
+```bash
+$ foreman start
+```
+
+* Configure the webhook in Contentful:
+
+Under the space settings menu choose webhook and add a new webhook pointing to `http://YOUR_SERVER:32123/scheduler`.
+
+Keep in mind that if you modify the defaults, the URL should be changed to the values specified in the configuration.
+
+## Running in Heroku
+
+Heroku offers various Redis plugins, select the one of your liking, add the credentials into your configuration, and proceed to
+`git heroku push master`.
+
+This will get your application set up and running. It will require 4 dynos, so a free plan isn't enough for it to run.
+
+To run the `monitor` process, you'll require to run it from a different application pointing to the same Redis instance.
+
+Make sure to change the `Procfile`'s `web` process to the following:
+
+```
+web: PORT=$PORT bundle exec env rake contentful:scheduler
+```
+
+That will allow Heroku to set it's own Port according to their policy.
+
+The URL for the webhook then will be on port 80, so you should change it to: `http://YOUR_APPLICATION/scheduler`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/contentful/contentful-scheduler.rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'contentful/scheduler/tasks'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/contentful-scheduler.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'contentful/scheduler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "contentful-scheduler"
+  spec.version       = Contentful::Scheduler::VERSION
+  spec.authors       = ["Contentful GmbH (David Litvak Bruno0"]
+  spec.email         = ["david.litvak@contentful.com"]
+
+  spec.summary       = %q{Customizable Scheduler for Contentful Entries.}
+  spec.description   = %q{Customizable Scheduler for Contentful Entries.}
+  spec.homepage      = "https://www.contentful.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "contentful-webhook-listener", "~> 0.2"
+  spec.add_runtime_dependency "contentful-management", "~> 1.0"
+  spec.add_runtime_dependency "resque", "~> 1.0"
+  spec.add_runtime_dependency "resque-scheduler", "~> 4.0"
+  spec.add_runtime_dependency "redis", "~> 3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+end

data/example/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'contentful-scheduler', '~> 0.1'
+gem 'contentful-management', '~> 1.0'
+gem 'resque', '~> 1.0'
+gem 'resque-scheduler', '~> 4.0'
+gem 'rake'

data/example/Procfile

@@ -0,0 +1,4 @@
+web: env bundle exec rake contentful:scheduler
+monitor: env bundle exec rackup
+resque: env bundle exec rake resque:work
+resque_scheduler: env bundle exec rake resque:scheduler

data/example/Rakefile

@@ -0,0 +1,46 @@
+require 'contentful/scheduler'
+require 'logger' # Optional
+
+$stdout.sync = true
+
+config = {
+  logger: Logger.new(STDOUT), # Defaults to NullLogger
+  port: 32123, # Defaults to 32123
+  endpoint: '/scheduler', # Defaults to /scheduler
+  redis: {
+    host: 'YOUR_REDIS_HOST',
+    port: 'YOUR_REDIS_PORT',
+    password: 'YOUR_REDIS_PASSWORD'
+  },
+  spaces: {
+    'YOUR_SPACE_ID' => {
+      publish_field: 'publishDate', # It specifies the field ID for your Publish Date in your Content Type
+      management_token: 'YOUR_TOKEN'
+    }
+  }
+}
+
+namespace :contentful do
+  task :setup do
+    Contentful::Scheduler.config = config
+  end
+
+  task :scheduler => :setup do
+    Contentful::Scheduler.start
+  end
+end
+
+require 'resque/tasks'
+require 'resque/scheduler/tasks'
+
+namespace :resque do
+  task :setup => 'contentful:setup' do
+    ENV['QUEUE'] = '*'
+  end
+
+  task :setup_schedule => :setup do
+    require 'resque-scheduler'
+  end
+
+  task :scheduler => :setup_schedule
+end

data/example/config.ru

@@ -0,0 +1,13 @@
+require 'resque'
+require 'resque/server'
+require 'resque/scheduler/server'
+
+config = {
+  host: 'YOUR_REDIS_HOST',
+  port: 'YOUR_REDIS_PORT',
+  password: 'YOUR_REDIS_PASSWORD'
+}
+Resque.redis = config
+
+run Rack::URLMap.new \
+  "/" => Resque::Server.new

data/lib/contentful/scheduler/controller.rb

@@ -0,0 +1,30 @@
+require 'contentful/webhook/listener'
+require_relative 'queue'
+
+module Contentful
+  module Scheduler
+    class Controller < ::Contentful::Webhook::Listener::Controllers::WebhookAware
+      def create
+        return unless webhook.entry?
+
+        logger.info "Queueing - Space: #{webhook.space_id} - Entry: #{webhook.id}"
+
+        Queue.instance(logger).update_or_create(webhook)
+      end
+      alias_method :save, :create
+      alias_method :auto_save, :create
+      alias_method :unarchive, :create
+
+      def delete
+        return unless webhook.entry?
+
+        logger.info "Unqueueing - Space: #{webhook.space_id} - Entry: #{webhook.id}"
+
+        Queue.instance(logger).remove(webhook)
+      end
+      alias_method :unpublish, :delete
+      alias_method :archive, :delete
+      alias_method :publish, :delete
+    end
+  end
+end

data/lib/contentful/scheduler/queue.rb

@@ -0,0 +1,106 @@
+require_relative "tasks"
+require 'contentful/webhook/listener'
+
+module Contentful
+  module Scheduler
+    class Queue
+      @@instance = nil
+
+      attr_reader :config, :logger
+
+      def self.instance(logger = ::Contentful::Webhook::Listener::Support::NullLogger.new)
+        @@instance ||= new(logger)
+      end
+
+      def update_or_create(webhook)
+        return unless publishable?(webhook)
+        remove(webhook) if in_queue?(webhook)
+        return if already_published?(webhook)
+
+        success = Resque.enqueue_at(
+          publish_date(webhook).to_time.utc,
+          ::Contentful::Scheduler::Tasks::Publish,
+          webhook.space_id,
+          webhook.id,
+          ::Contentful::Scheduler.config[:spaces][webhook.space_id][:management_token]
+        )
+
+        if success
+          logger.info "Webhook {id: #{webhook.id}, space_id: #{webhook.space_id}} successfully added to queue"
+        else
+          logger.warn "Webhook {id: #{webhook.id}, space_id: #{webhook.space_id}} couldn't be added to queue"
+        end
+      end
+
+      def remove(webhook)
+        return unless publishable?(webhook)
+        return unless in_queue?(webhook)
+
+        success = Resque.remove_delayed(
+          ::Contentful::Scheduler::Tasks::Publish,
+          webhook.space_id,
+          webhook.id,
+          ::Contentful::Scheduler.config[:management_token]
+        )
+
+        if success
+          logger.info "Webhook {id: #{webhook.id}, space_id: #{webhook.space_id}} successfully removed from queue"
+        else
+          logger.warn "Webhook {id: #{webhook.id}, space_id: #{webhook.space_id}} couldn't be removed from queue"
+        end
+      end
+
+      def publishable?(webhook)
+        return false unless spaces.key?(webhook.space_id)
+
+        if webhook_publish_field?(webhook)
+          return !webhook_publish_field(webhook).nil?
+        end
+
+        false
+      end
+
+      def already_published?(webhook)
+        return true if publish_date(webhook) < DateTime.now
+        return false unless webhook.sys.key?('publishedAt')
+
+        if !webhook.sys['publishedAt'].nil?
+          return DateTime.strptime(webhook.sys['publishedAt']).to_time.utc < DateTime.now.to_time.utc
+        end
+
+        false
+      end
+
+      def in_queue?(webhook)
+        Resque.peek(::Contentful::Scheduler::Tasks::Publish, 0, -1).any? do |job|
+          job['args'][0] == webhook.space_id && job['args'][1] == webhook.id
+        end
+      end
+
+      def publish_date(webhook)
+        date_field = webhook_publish_field(webhook)
+        date_field = date_field[date_field.keys[0]] if date_field.is_a? Hash
+        DateTime.strptime(date_field)
+      end
+
+      def spaces
+        config[:spaces]
+      end
+
+      def webhook_publish_field?(webhook)
+        webhook.fields.key?(spaces.fetch(webhook.space_id, {})[:publish_field])
+      end
+
+      def webhook_publish_field(webhook)
+        webhook.fields[spaces[webhook.space_id][:publish_field]]
+      end
+
+      private
+
+      def initialize(logger)
+        @config = ::Contentful::Scheduler.config
+        @logger = logger
+      end
+    end
+  end
+end

data/lib/contentful/scheduler/tasks/publish.rb

@@ -0,0 +1,16 @@
+require 'contentful/management'
+
+module Contentful
+  module Scheduler
+    module Tasks
+      class Publish
+        @queue = :publish
+
+        def self.perform(space_id, entry_id, token)
+          client = ::Contentful::Management::Client.new(token, raise_errors: true)
+          client.entries.find(space_id, entry_id).publish
+        end
+      end
+    end
+  end
+end

data/lib/contentful/scheduler/tasks.rb

@@ -0,0 +1 @@
+require_relative 'tasks/publish'

data/lib/contentful/scheduler/version.rb

@@ -0,0 +1,5 @@
+module Contentful
+  module Scheduler
+    VERSION = "0.1.0"
+  end
+end

data/lib/contentful/scheduler.rb

@@ -0,0 +1,57 @@
+require 'resque'
+require 'redis'
+require 'logger'
+require 'contentful/webhook/listener'
+
+require_relative 'scheduler/controller'
+require_relative 'scheduler/version'
+
+module Contentful
+  module Scheduler
+    DEFAULT_PORT = 32123
+    DEFAULT_ENDPOINT = '/scheduler'
+    DEFAULT_LOGGER = ::Contentful::Webhook::Listener::Support::NullLogger.new
+
+    @@config = nil
+
+    def self.config=(config)
+      fail ':redis configuration missing' unless config.key?(:redis)
+      fail ':spaces configuration missing' unless config.key?(:spaces)
+      config[:spaces].each do |space, data|
+        fail ":management_token missing for space: #{space}" unless data.key?(:management_token)
+      end
+
+      config[:port] = (ENV.key?('PORT') ? ENV['PORT'].to_i : DEFAULT_PORT) unless config.key?(:port)
+      config[:logger] = DEFAULT_LOGGER unless config.key?(:logger)
+      config[:endpoint] = DEFAULT_ENDPOINT unless config.key?(:endpoint)
+
+      ::Resque.redis = config[:redis].dup
+      @@config ||= config
+    end
+
+    def self.config
+      @@config
+    end
+
+    def self.start(config = {})
+      fail "Scheduler not configured" if self.config.nil? && !block_given?
+
+      if block_given?
+        yield(config) if block_given?
+        self.config = config
+      end
+
+      ::Contentful::Webhook::Listener::Server.start do |config|
+        config[:port] = self.config[:port]
+        config[:logger] = self.config[:logger]
+        config[:endpoints] = [
+          {
+            endpoint: self.config[:endpoint],
+            controller: ::Contentful::Scheduler::Controller,
+            timeout: 0
+          }
+        ]
+      end.join
+    end
+  end
+end

data/spec/contentful/scheduler/controller_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Contentful::Scheduler::Controller do
+  let(:server) { MockServer.new }
+  let(:logger) { Contentful::Webhook::Listener::Support::NullLogger.new }
+  let(:timeout) { 10 }
+  let(:headers) { {'X-Contentful-Topic' => '', 'X-Contentful-Webhook-Name' => 'SomeName'} }
+  let(:body) { {sys: { id: 'foo', space: { sys: { id: 'space_foo' } } }, fields: {} } }
+  let(:queue) { ::Contentful::Scheduler::Queue.instance }
+  subject { described_class.new server, logger, timeout }
+
+  describe 'events' do
+    [:create, :save, :auto_save, :unarchive].each do |event|
+      it "creates or updates webhook metadata in publish queue on #{event}" do
+        expect(queue).to receive(:update_or_create)
+
+        headers['X-Contentful-Topic'] = "ContentfulManagement.Entry.#{event}"
+        request = RequestDummy.new(headers, body)
+        subject.respond(request, MockResponse.new).join
+      end
+    end
+
+    [:delete, :unpublish, :archive, :publish].each do |event|
+      it "deletes webhook metadata in publish queue on #{event}" do
+        expect(queue).to receive(:remove)
+
+        headers['X-Contentful-Topic'] = "ContentfulManagement.Entry.#{event}"
+        request = RequestDummy.new(headers, body)
+        subject.respond(request, MockResponse.new).join
+      end
+    end
+
+    [:create, :save, :unarchive, :delete, :unpublish, :archive, :publish].each do |event|
+      ['Asset', 'ContentType'].each do |kind|
+        it "ignores #{kind} on #{event}" do
+          expect(queue).not_to receive(:remove)
+          expect(queue).not_to receive(:update_or_create)
+
+          headers['X-Contentful-Topic'] = "ContentfulManagement.#{kind}.#{event}"
+          request = RequestDummy.new(headers, body)
+          subject.respond(request, MockResponse.new).join
+        end
+      end
+    end
+  end
+end

data/spec/contentful/scheduler/queue_spec.rb

@@ -0,0 +1,245 @@
+require 'spec_helper'
+
+class WebhookDouble
+  attr_reader :id, :space_id, :sys, :fields
+  def initialize(id, space_id, sys = {}, fields = {})
+    @id = id
+    @space_id = space_id
+    @sys = sys
+    @fields = fields
+  end
+end
+
+describe Contentful::Scheduler::Queue do
+  let(:config) {
+    {
+      logger: ::Contentful::Scheduler::DEFAULT_LOGGER,
+      endpoint: ::Contentful::Scheduler::DEFAULT_ENDPOINT,
+      port: ::Contentful::Scheduler::DEFAULT_PORT,
+      redis: {
+        host: 'localhost',
+        port: 12341,
+        password: 'foobar'
+      },
+      spaces: {
+        'foo' => {
+          publish_field: 'my_field',
+          management_token: 'foo'
+        }
+      }
+    }
+  }
+
+  subject { described_class.instance }
+
+  before :each do
+    allow(Resque).to receive(:redis=)
+    described_class.class_variable_set(:@@instance, nil)
+    ::Contentful::Scheduler.config = config
+  end
+
+  describe 'singleton' do
+    it 'creates an instance if not initialized' do
+      queue = described_class.instance
+      expect(queue).to be_a described_class
+    end
+
+    it 'reuses same instance' do
+      queue = described_class.instance
+
+      expect(queue).to eq described_class.instance
+    end
+  end
+
+  describe 'attributes' do
+    it '.config' do
+      expect(subject.config).to eq config
+    end
+  end
+
+  describe 'instance methods' do
+    it '#spaces' do
+      expect(subject.spaces).to eq config[:spaces]
+    end
+
+    it '#webhook_publish_field?' do
+      expect(subject.webhook_publish_field?(
+        WebhookDouble.new('bar', 'foo', {}, {'my_field' => 'something'})
+      )).to be_truthy
+
+      expect(subject.webhook_publish_field?(
+        WebhookDouble.new('bar', 'foo', {}, {'not_my_field' => 'something'})
+      )).to be_falsey
+
+      expect(subject.webhook_publish_field?(
+        WebhookDouble.new('bar', 'not_foo', {}, {'not_my_field' => 'something'})
+      )).to be_falsey
+    end
+
+    it '#webhook_publish_field' do
+      expect(subject.webhook_publish_field(
+        WebhookDouble.new('bar', 'foo', {}, {'my_field' => 'something'})
+      )).to eq 'something'
+    end
+
+    it '#publish_date' do
+      expect(subject.publish_date(
+        WebhookDouble.new('bar', 'foo', {}, {'my_field' => '2011-04-04T22:00:00+00:00'})
+      )).to eq DateTime.new(2011, 4, 4, 22, 0, 0)
+    end
+
+    describe '#already_published?' do
+      it 'true if webhook publish_date is in past' do
+        expect(subject.already_published?(
+          WebhookDouble.new('bar', 'foo', {}, {'my_field' => '2011-04-04T22:00:00+00:00'})
+        )).to be_truthy
+      end
+
+      it 'true if sys.publishedAt is in past' do
+        expect(subject.already_published?(
+          WebhookDouble.new('bar', 'foo', {'publishedAt' =>  '2011-04-04T22:00:00+00:00'}, {'my_field' => '2099-04-04T22:00:00+00:00'})
+        )).to be_truthy
+      end
+
+      it 'false if sys.publishedAt is not present' do
+        expect(subject.already_published?(
+          WebhookDouble.new('bar', 'foo', {}, {'my_field' => '2099-04-04T22:00:00+00:00'})
+        )).to be_falsey
+      end
+
+      it 'false if sys.publishedAt is present but nil' do
+        expect(subject.already_published?(
+          WebhookDouble.new('bar', 'foo', {'publishedAt' => nil}, {'my_field' => '2099-04-04T22:00:00+00:00'})
+        )).to be_falsey
+      end
+    end
+
+    describe '#publishable?' do
+      it 'false if webhook space not present in config' do
+        expect(subject.publishable?(
+          WebhookDouble.new('bar', 'not_foo')
+        )).to be_falsey
+      end
+
+      it 'false if publish_field is not found' do
+        expect(subject.publishable?(
+          WebhookDouble.new('bar', 'foo')
+        )).to be_falsey
+      end
+
+      it 'false if publish_field is nil' do
+        expect(subject.publishable?(
+          WebhookDouble.new('bar', 'foo', {}, {'my_field' => nil})
+        )).to be_falsey
+      end
+
+      it 'true if publish_field is populated' do
+        expect(subject.publishable?(
+          WebhookDouble.new('bar', 'foo', {}, {'my_field' => '2011-04-04T22:00:00+00:00'})
+        )).to be_truthy
+      end
+    end
+
+    describe '#in_queue?' do
+      it 'false if not in queue' do
+        allow(Resque).to receive(:peek) { [] }
+        expect(subject.in_queue?(
+          WebhookDouble.new('bar', 'foo')
+        )).to be_falsey
+      end
+
+      it 'true if in queue' do
+        allow(Resque).to receive(:peek) { [{'args' => ['foo', 'bar']}] }
+        expect(subject.in_queue?(
+          WebhookDouble.new('bar', 'foo')
+        )).to be_truthy
+      end
+    end
+
+    describe '#update_or_create' do
+      it 'does nothing if webhook is unpublishable' do
+        expect(Resque).not_to receive(:enqueue_at)
+
+        subject.update_or_create(WebhookDouble.new('bar', 'not_foo'))
+      end
+
+      describe 'webhook is new' do
+        it 'queues' do
+          mock_redis = Object.new
+          allow(mock_redis).to receive(:client) { mock_redis }
+          allow(mock_redis).to receive(:id) { 'foo' }
+          allow(Resque).to receive(:peek) { [] }
+          allow(Resque).to receive(:redis) { mock_redis }
+
+          expect(Resque).to receive(:enqueue_at).with(
+            DateTime.strptime('2099-04-04T22:00:00+00:00').to_time.utc,
+            ::Contentful::Scheduler::Tasks::Publish,
+            'foo',
+            'bar',
+            'foo'
+          ) { true }
+
+          subject.update_or_create(WebhookDouble.new('bar', 'foo', {}, {'my_field' => '2099-04-04T22:00:00+00:00'}))
+        end
+
+        it 'does nothing if already published' do
+          allow(Resque).to receive(:peek) { [] }
+          expect(Resque).not_to receive(:enqueue_at)
+
+          subject.update_or_create(WebhookDouble.new('bar', 'foo', {}, {'my_field' => '2011-04-04T22:00:00+00:00'}))
+        end
+      end
+
+      describe 'webhook already in queue' do
+        it 'calls remove then queues again' do
+          mock_redis = Object.new
+          allow(mock_redis).to receive(:client) { mock_redis }
+          allow(mock_redis).to receive(:id) { 'foo' }
+          allow(Resque).to receive(:redis) { mock_redis }
+
+          allow(Resque).to receive(:peek) { [{'args' => ['foo', 'bar']}] }
+          expect(Resque).to receive(:enqueue_at).with(
+            DateTime.strptime('2099-04-04T22:00:00+00:00').to_time.utc,
+            ::Contentful::Scheduler::Tasks::Publish,
+            'foo',
+            'bar',
+            'foo'
+          ) { true }
+          expect(subject).to receive(:remove)
+
+          subject.update_or_create(WebhookDouble.new('bar', 'foo', {}, {'my_field' => '2099-04-04T22:00:00+00:00'}))
+        end
+
+        it 'removes old call if already published' do
+          allow(Resque).to receive(:peek) { [{'args' => ['foo', 'bar']}] }
+          expect(Resque).not_to receive(:enqueue_at)
+          expect(subject).to receive(:remove)
+
+          subject.update_or_create(WebhookDouble.new('bar', 'foo', {}, {'my_field' => '2011-04-04T22:00:00+00:00'}))
+        end
+      end
+    end
+
+    describe '#remove' do
+      it 'does nothing if webhook is unpublishable' do
+        expect(Resque).not_to receive(:remove_delayed)
+
+        subject.remove(WebhookDouble.new('bar', 'foo'))
+      end
+
+      it 'does nothing if webhook not in queue' do
+        allow(Resque).to receive(:peek) { [] }
+        expect(Resque).not_to receive(:remove_delayed)
+
+        subject.remove(WebhookDouble.new('bar', 'foo', {}, {'my_field' => '2011-04-04T22:00:00+00:00'}))
+      end
+
+      it 'removes if in queue' do
+        allow(Resque).to receive(:peek) { [{'args' => ['foo', 'bar']}] }
+        expect(Resque).to receive(:remove_delayed)
+
+        subject.remove(WebhookDouble.new('bar', 'foo', {}, {'my_field' => '2011-04-04T22:00:00+00:00'}))
+      end
+    end
+  end
+end

data/spec/contentful/scheduler/tasks/publish_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+class MockEntry
+  def publish
+  end
+end
+
+class MockClient
+  def entries
+  end
+end
+
+class MockEntries
+  def find
+  end
+end
+
+describe Contentful::Scheduler::Tasks::Publish do
+  let(:mock_client) { MockClient.new }
+  let(:mock_entries) { MockEntries.new }
+  let(:mock_entry) { MockEntry.new }
+
+  before :each do
+    ::Contentful::Scheduler.class_variable_set(:@@config, {management_token: 'foobar'})
+  end
+
+  describe 'class methods' do
+    it '::perform' do
+      expect(::Contentful::Management::Client).to receive(:new) { mock_client }
+      expect(mock_client).to receive(:entries) { mock_entries }
+      expect(mock_entries).to receive(:find).with('foo', 'bar') { mock_entry }
+      expect(mock_entry).to receive(:publish)
+
+      described_class.perform('foo', 'bar', ::Contentful::Scheduler.config[:management_token])
+    end
+  end
+end

data/spec/contentful/scheduler_spec.rb

@@ -0,0 +1,141 @@
+require 'spec_helper'
+
+class DummyServer
+  def join; end
+end
+
+class DummyLogger
+end
+
+describe Contentful::Scheduler do
+  let(:config) {
+    {
+      redis: {
+        host: 'localhost',
+        port: 12341,
+        password: 'foobar'
+      },
+      spaces: {},
+      management_token: 'foo'
+    }
+  }
+
+  before :each do
+    described_class.class_variable_set(:@@config, nil)
+  end
+
+  describe 'static methods' do
+    describe '::config=' do
+      describe 'failures' do
+        it 'fails if :redis is not configured' do
+          expect { described_class.config = {} }.to raise_error ":redis configuration missing"
+        end
+
+        it 'fails if :spaces are not configured' do
+          expect { described_class.config = {redis: nil} }.to raise_error ":spaces configuration missing"
+        end
+
+        it 'fails if :management_token is not configured' do
+          expect { described_class.config = {redis: nil, spaces: {example_space: {}}} }.to raise_error ":management_token missing for space: example_space"
+        end
+      end
+
+      describe 'success' do
+        it 'sets a resque redis config' do
+          expect(Resque).to receive(:redis=).with(config[:redis])
+
+          described_class.config = config
+        end
+
+        it 'sets global config' do
+          described_class.config = config
+
+          expect(described_class.config).to eq config
+        end
+      end
+    end
+
+    describe '::config' do
+      it 'fetches the config' do
+        expect(described_class.config).to eq nil
+
+        allow(Resque).to receive(:redis=)
+
+        described_class.config = config
+
+        expect(described_class.config).to eq config
+      end
+
+      it ':port defaults to 32123' do
+        described_class.config = config
+
+        expect(described_class.config[:port]).to eq 32123
+      end
+
+      it ':port to ENV["PORT"] if available and :port not set' do
+        ENV['PORT'] = '8000'
+
+        described_class.config = config
+
+        expect(described_class.config[:port]).to eq 8000
+
+        ENV['PORT'] = nil
+      end
+
+      it ':port can be set' do
+        described_class.config = {port: 10101}.merge(config)
+
+        expect(described_class.config[:port]).to eq 10101
+      end
+
+      it ':logger can be set' do
+        described_class.config = {logger: DummyLogger.new}.merge(config)
+
+        expect(described_class.config[:logger]).to be_a DummyLogger
+      end
+
+      it ':logger defaults to NullLogger' do
+        described_class.config = config
+
+        expect(described_class.config[:logger]).to be_a ::Contentful::Webhook::Listener::Support::NullLogger
+      end
+
+      it ':endpoint can be set' do
+        described_class.config = {endpoint: '/foobar'}.merge(config)
+
+        expect(described_class.config[:endpoint]).to eq '/foobar'
+      end
+
+      it ':endpoint defaults to "/scheduler"' do
+        described_class.config = config
+
+        expect(described_class.config[:endpoint]).to eq '/scheduler'
+      end
+    end
+
+    describe '::start' do
+      it 'fails when not configured' do
+        expect { described_class.start }.to raise_error "Scheduler not configured"
+      end
+
+      it 'runs when config set' do
+        allow(Resque).to receive(:redis=)
+        expect(::Contentful::Webhook::Listener::Server).to receive(:start) { DummyServer.new }
+
+        described_class.config = config
+        described_class.start
+      end
+
+      it 'can be configured by a block' do
+        allow(Resque).to receive(:redis=)
+        expect(::Contentful::Webhook::Listener::Server).to receive(:start) { DummyServer.new }
+
+        described_class.start do |config|
+          config[:redis] = {}
+          config[:spaces] = {}
+          config[:management_token] = ''
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,50 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'contentful/scheduler'
+require 'contentful/webhook/listener'
+require 'json'
+
+class MockServer
+  def [](key)
+    nil
+  end
+end
+
+class MockRequest
+end
+
+class MockResponse
+  attr_accessor :status, :body
+end
+
+class RequestDummy
+  attr_reader :headers, :body
+
+  def initialize(headers, body)
+    @headers = headers || {}
+    @body = JSON.dump(body)
+  end
+
+  def [](key)
+    headers[key]
+  end
+
+  def each
+    headers.each do |h, v|
+      yield(h, v)
+    end
+  end
+end
+
+class Contentful::Webhook::Listener::Controllers::Wait
+  @@sleeping = false
+
+  def sleep(time)
+    @@sleeping = true
+  end
+
+  def self.sleeping
+    value = @@sleeping
+    @@sleeping = false
+    value
+  end
+end

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: contentful-scheduler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Contentful GmbH (David Litvak Bruno0
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: contentful-webhook-listener
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: contentful-management
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: resque-scheduler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Customizable Scheduler for Contentful Entries.
+email:
+- david.litvak@contentful.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- contentful-scheduler.gemspec
+- example/Gemfile
+- example/Procfile
+- example/Rakefile
+- example/config.ru
+- lib/contentful/scheduler.rb
+- lib/contentful/scheduler/controller.rb
+- lib/contentful/scheduler/queue.rb
+- lib/contentful/scheduler/tasks.rb
+- lib/contentful/scheduler/tasks/publish.rb
+- lib/contentful/scheduler/version.rb
+- spec/contentful/scheduler/controller_spec.rb
+- spec/contentful/scheduler/queue_spec.rb
+- spec/contentful/scheduler/tasks/publish_spec.rb
+- spec/contentful/scheduler_spec.rb
+- spec/spec_helper.rb
+homepage: https://www.contentful.com
+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.5.0
+signing_key: 
+specification_version: 4
+summary: Customizable Scheduler for Contentful Entries.
+test_files:
+- spec/contentful/scheduler/controller_spec.rb
+- spec/contentful/scheduler/queue_spec.rb
+- spec/contentful/scheduler/tasks/publish_spec.rb
+- spec/contentful/scheduler_spec.rb
+- spec/spec_helper.rb
+has_rdoc: