contentful-scheduler 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3171ffa6b6fee5eb141d60da86e954868dbfd5e
-  data.tar.gz: 2afa33f5a560b6f330b337b10a9cd4edb2082fd1
+  metadata.gz: ff923429648f1e2a809b1f379f99fa592eafc40d
+  data.tar.gz: 4e6c728e653123254f245d3f6e780a3c986e61c1
 SHA512:
-  metadata.gz: 91dd5e9622d174eefaccb065e09a27d40d683b978567f795ebba156679bb624aa7eb0500ae93245186eea6756519c6178861c14b8d0d1b52fa13879db62ad818
-  data.tar.gz: ba0f65329a151445be938e9301e5710c895e0a61569afc20a83c5d2ece65864230c49bdd21de8a195a093068895db3c4af587ed59c47c3853597db625db83791
+  metadata.gz: eb9ecbbd1524f8da38140c54447d7014aca017a5fa73d6403f5256c82f1e8d7bafe94a43d81d3ca86a002fa5de78006446fe2a16667b6601a4c55a559f052e2b
+  data.tar.gz: 9f62df4f008c1f0c27bca2e1f52a532b132687038e0156e29a5a0a807c8ed70affb1ee85130e4c0b001a82597cf500717f432af74f02853fd2c9c6ae7a535d5b

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 0.5.0
+### Added
+* Added support for scheduled unpublishing. [#10](https://github.com/contentful/contentful-scheduler.rb/issues/10)
+
 ## 0.4.0
 ### Fixed
 * Fixed User Agent Header to comply with specification.

data/README.md

@@ -7,18 +7,18 @@ Scheduling Server for Contentful entries.
 
 ## What does `contentful-scheduler` do?
 The aim of `contentful-scheduler` is to have developers setting up their Contentful
-entries for scheduled publishing.
+entries for scheduled publishing and unpublishing.
 
 ## 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.
+If the value is a time in the future it will schedule the entry for publishing or unpublishing 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.
+against the Content Management API at the due time. For this the Entries you wish to publish or unpublish require a
+customizable Date field, which we advice to call `publishDate` for the publishing action and `unpublishDate` for the unpublishing action,
+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.
 
@@ -91,6 +91,7 @@ config = {
   spaces: {
     'YOUR_SPACE_ID' => {
       publish_field: 'publishDate', # It specifies the field ID for your Publish Date in your Content Type
+      unpublish_field: 'unpublishDate', # Optional - It specifies the field ID for your Unpublish Date in your Content Type
       management_token: 'YOUR_TOKEN',
       auth: { # This is optional
         # ... content in this section will be explained in a separate section ...

data/lib/contentful/scheduler/queue.rb

@@ -1,6 +1,6 @@
-require_relative "tasks"
 require 'chronic'
 require 'contentful/webhook/listener'
+require_relative "tasks"
 
 module Contentful
   module Scheduler
@@ -14,28 +14,51 @@ module Contentful
       end
 
       def update_or_create(webhook)
-        return unless publishable?(webhook)
-        remove(webhook) if in_queue?(webhook)
-        return unless publish_is_future?(webhook)
+        if publishable?(webhook)
+          success = update_or_create_for_publish(webhook)
+          log_event_success(webhook, success, 'publish', 'added to')
+        end
+
+        if unpublishable?(webhook)
+          success = update_or_create_for_unpublish(webhook) && success
+          log_event_success(webhook, success, 'unpublish', 'added to')
+        end
+      end
 
-        success = Resque.enqueue_at(
+      def update_or_create_for_publish(webhook)
+        remove_publish(webhook) if in_publish_queue?(webhook)
+        return false unless publish_is_future?(webhook)
+
+        return Resque.enqueue_at(
           publish_date(webhook),
           ::Contentful::Scheduler::Tasks::Publish,
           webhook.space_id,
           webhook.id,
           ::Contentful::Scheduler.config[:spaces][webhook.space_id][:management_token]
         )
+      end
 
-        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
+      def update_or_create_for_unpublish(webhook)
+        remove_unpublish(webhook) if in_unpublish_queue?(webhook)
+        return false unless unpublish_is_future?(webhook)
+
+        return Resque.enqueue_at(
+          unpublish_date(webhook),
+          ::Contentful::Scheduler::Tasks::Unpublish,
+          webhook.space_id,
+          webhook.id,
+          ::Contentful::Scheduler.config[:spaces][webhook.space_id][:management_token]
+        )
       end
 
       def remove(webhook)
+        remove_publish(webhook)
+        remove_unpublish(webhook)
+      end
+
+      def remove_publish(webhook)
         return unless publishable?(webhook)
-        return unless in_queue?(webhook)
+        return unless in_publish_queue?(webhook)
 
         success = Resque.remove_delayed(
           ::Contentful::Scheduler::Tasks::Publish,
@@ -44,10 +67,28 @@ module Contentful
           ::Contentful::Scheduler.config[:management_token]
         )
 
+        log_event_success(webhook, success, 'publish', 'removed from')
+      end
+
+      def remove_unpublish(webhook)
+        return unless unpublishable?(webhook)
+        return unless in_unpublish_queue?(webhook)
+
+        success = Resque.remove_delayed(
+          ::Contentful::Scheduler::Tasks::Unpublish,
+          webhook.space_id,
+          webhook.id,
+          ::Contentful::Scheduler.config[:management_token]
+        )
+
+        log_event_success(webhook, success, 'unpublish', 'removed from')
+      end
+
+      def log_event_success(webhook, success, event_kind, action)
         if success
-          logger.info "Webhook {id: #{webhook.id}, space_id: #{webhook.space_id}} successfully removed from queue"
+          logger.info "Webhook {id: #{webhook.id}, space_id: #{webhook.space_id}} successfully #{action} the #{event_kind} queue"
         else
-          logger.warn "Webhook {id: #{webhook.id}, space_id: #{webhook.space_id}} couldn't be removed from queue"
+          logger.warn "Webhook {id: #{webhook.id}, space_id: #{webhook.space_id}} couldn't be #{action} the #{event_kind} queue"
         end
       end
 
@@ -61,22 +102,48 @@ module Contentful
         false
       end
 
+      def unpublishable?(webhook)
+        return false unless spaces.key?(webhook.space_id)
+
+        if webhook_unpublish_field?(webhook)
+          return !webhook_unpublish_field(webhook).nil? && unpublish_is_future?(webhook)
+        end
+
+        false
+      end
+
       def publish_is_future?(webhook)
         publish_date(webhook) > Time.now.utc
       end
 
-      def in_queue?(webhook)
+      def unpublish_is_future?(webhook)
+        unpublish_date(webhook) > Time.now.utc
+      end
+
+      def in_publish_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 in_unpublish_queue?(webhook)
+        Resque.peek(::Contentful::Scheduler::Tasks::Unpublish, 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
         Chronic.parse(date_field).utc
       end
 
+      def unpublish_date(webhook)
+        date_field = webhook_unpublish_field(webhook)
+        date_field = date_field[date_field.keys[0]] if date_field.is_a? Hash
+        Chronic.parse(date_field).utc
+      end
+
       def spaces
         config[:spaces]
       end
@@ -85,10 +152,18 @@ module Contentful
         webhook.fields.key?(spaces.fetch(webhook.space_id, {})[:publish_field])
       end
 
+      def webhook_unpublish_field?(webhook)
+        webhook.fields.key?(spaces.fetch(webhook.space_id, {})[:unpublish_field])
+      end
+
       def webhook_publish_field(webhook)
         webhook.fields[spaces[webhook.space_id][:publish_field]]
       end
 
+      def webhook_unpublish_field(webhook)
+        webhook.fields[spaces[webhook.space_id][:unpublish_field]]
+      end
+
       private
 
       def initialize(logger)

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

@@ -0,0 +1,21 @@
+require 'contentful/management'
+
+module Contentful
+  module Scheduler
+    module Tasks
+      class Unpublish
+        @queue = :unpublish
+
+        def self.perform(space_id, entry_id, token)
+          client = ::Contentful::Management::Client.new(
+            token,
+            raise_errors: true,
+            application_name: 'contentful.scheduler',
+            application_version: Contentful::Scheduler::VERSION
+          )
+          client.entries.find(space_id, entry_id).unpublish
+        end
+      end
+    end
+  end
+end

data/lib/contentful/scheduler/tasks.rb

@@ -1 +1,2 @@
 require_relative 'tasks/publish'
+require_relative 'tasks/unpublish'

data/lib/contentful/scheduler/version.rb

@@ -1,5 +1,5 @@
 module Contentful
   module Scheduler
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
   end
 end

data/spec/contentful/scheduler/queue_spec.rb

@@ -36,12 +36,32 @@ describe Contentful::Scheduler::Queue do
       )).to be_falsey
     end
 
+    it '#webhook_unpublish_field?' do
+      expect(subject.webhook_unpublish_field?(
+        WebhookDouble.new('bar', 'unpublish_space', {}, {'unpublish_field' => 'something'})
+      )).to be_truthy
+
+      expect(subject.webhook_publish_field?(
+        WebhookDouble.new('bar', 'unpublish_space', {}, {'not_unpublish_field' => 'something'})
+      )).to be_falsey
+
+      expect(subject.webhook_publish_field?(
+        WebhookDouble.new('bar', 'other_space', {}, {'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 '#webhook_unpublish_field' do
+      expect(subject.webhook_unpublish_field(
+        WebhookDouble.new('bar', 'unpublish_space', {}, {'unpublish_field' => 'something'})
+      )).to eq 'something'
+    end
+
     describe '#publish_date' do
       it 'works if date field not localized' do
         expect(subject.publish_date(
@@ -60,6 +80,24 @@ describe Contentful::Scheduler::Queue do
       end
     end
 
+    describe '#unpublish_date' do
+      it 'works if date field not localized' do
+        expect(subject.unpublish_date(
+          WebhookDouble.new('bar', 'unpublish_space', {}, {'unpublish_field' => '2011-04-04T22:00:00+00:00'})
+        )).to eq DateTime.new(2011, 4, 4, 22, 0, 0).to_time.utc
+      end
+
+      it 'works if date field localized by grabbing first available locale' do
+        expect(subject.unpublish_date(
+          WebhookDouble.new('bar', 'unpublish_space', {}, {'unpublish_field' => {'en-US': '2011-04-04T22:00:00+00:00'}})
+        )).to eq DateTime.new(2011, 4, 4, 22, 0, 0).to_time.utc
+
+        expect(subject.unpublish_date(
+          WebhookDouble.new('bar', 'unpublish_space', {}, {'unpublish_field' => {'en-CA': '2011-04-04T23:00:00Z'}})
+        )).to eq DateTime.new(2011, 4, 4, 23, 0, 0).to_time.utc
+      end
+    end
+
     describe '#publishable?' do
       it 'false if webhook space not present in config' do
         expect(subject.publishable?(
@@ -86,18 +124,60 @@ describe Contentful::Scheduler::Queue do
       end
     end
 
-    describe '#in_queue?' do
+    describe '#unpublishable?' do
+      it 'false if webhook space not present in config' do
+        expect(subject.unpublishable?(
+          WebhookDouble.new('bar', 'not_foo')
+        )).to be_falsey
+      end
+
+      it 'false if unpublish_field is not found' do
+        expect(subject.unpublishable?(
+          WebhookDouble.new('bar', 'unpublish_space')
+        )).to be_falsey
+      end
+
+      it 'false if unpublish_field is nil' do
+        expect(subject.unpublishable?(
+          WebhookDouble.new('bar', 'unpublish_space', {}, {'unpublish_field' => nil})
+        )).to be_falsey
+      end
+
+      it 'true if unpublish_field is populated' do
+        expect(subject.unpublishable?(
+          WebhookDouble.new('bar', 'unpublish_space', {}, {'unpublish_field' => '2111-04-04T22:00:00+00:00'})
+        )).to be_truthy
+      end
+    end
+
+    describe '#in_publish_queue?' do
       it 'false if not in queue' do
         allow(Resque).to receive(:peek) { [] }
-        expect(subject.in_queue?(
+        expect(subject.in_publish_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?(
+        expect(subject.in_publish_queue?(
+          WebhookDouble.new('bar', 'foo')
+        )).to be_truthy
+      end
+    end
+
+    describe '#in_unpublish_queue?' do
+      it 'false if not in queue' do
+        allow(Resque).to receive(:peek) { [] }
+        expect(subject.in_unpublish_queue?(
           WebhookDouble.new('bar', 'foo')
+        )).to be_falsey
+      end
+
+      it 'true if in queue' do
+        allow(Resque).to receive(:peek) { [{'args' => ['unpublish_space', 'bar']}] }
+        expect(subject.in_unpublish_queue?(
+          WebhookDouble.new('bar', 'unpublish_space')
         )).to be_truthy
       end
     end
@@ -151,7 +231,7 @@ describe Contentful::Scheduler::Queue do
             'bar',
             'foo'
           ) { true }
-          expect(subject).to receive(:remove)
+          expect(subject).to receive(:remove_publish)
 
           subject.update_or_create(WebhookDouble.new('bar', 'foo', {}, {'my_field' => '2099-04-04T22:00:00+00:00'}))
         end

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

@@ -0,0 +1,42 @@
+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::Unpublish do
+  let(:mock_client) { MockClient.new }
+  let(:mock_entries) { MockEntries.new }
+  let(:mock_entry) { MockEntry.new }
+
+  before :each do
+    ::Contentful::Scheduler.config = base_config
+  end
+
+  describe 'class methods' do
+    it '::perform' do
+      expect(::Contentful::Management::Client).to receive(:new).with(
+        'foo',
+        raise_errors: true,
+        application_name: 'contentful.scheduler',
+        application_version: Contentful::Scheduler::VERSION
+      ) { 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(:unpublish)
+
+      described_class.perform('foo', 'bar', ::Contentful::Scheduler.config[:spaces]['foo'][:management_token])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -80,6 +80,11 @@ def base_config
         publish_field: 'my_field',
         management_token: 'foo'
       },
+      'unpublish_space' => {
+        publish_field: 'my_field',
+        unpublish_field: 'unpublish_field',
+        management_token: 'foo'
+      },
       'no_auth' => {
         publish_field: 'my_field',
         management_token: 'foo'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contentful-scheduler
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Contentful GmbH (David Litvak Bruno0
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-26 00:00:00.000000000 Z
+date: 2018-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: contentful-webhook-listener
@@ -206,11 +206,13 @@ files:
 - lib/contentful/scheduler/queue.rb
 - lib/contentful/scheduler/tasks.rb
 - lib/contentful/scheduler/tasks/publish.rb
+- lib/contentful/scheduler/tasks/unpublish.rb
 - lib/contentful/scheduler/version.rb
 - spec/contentful/scheduler/auth_spec.rb
 - spec/contentful/scheduler/controller_spec.rb
 - spec/contentful/scheduler/queue_spec.rb
 - spec/contentful/scheduler/tasks/publish_spec.rb
+- spec/contentful/scheduler/tasks/unpublish_spec.rb
 - spec/contentful/scheduler_spec.rb
 - spec/spec_helper.rb
 homepage: https://www.contentful.com
@@ -242,5 +244,6 @@ test_files:
 - spec/contentful/scheduler/controller_spec.rb
 - spec/contentful/scheduler/queue_spec.rb
 - spec/contentful/scheduler/tasks/publish_spec.rb
+- spec/contentful/scheduler/tasks/unpublish_spec.rb
 - spec/contentful/scheduler_spec.rb
 - spec/spec_helper.rb