contentful-scheduler-custom 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f92623b5fe928b9bfe25297cf01e837ab8aa5046
-  data.tar.gz: f9bf39f91e6d5a3554586eb79f9a586088e29ac8
+  metadata.gz: fc1d58e728b500a546433d09f796d8376c3c4f46
+  data.tar.gz: 920cdba7ae773d3f19659500683473437a1f9eb6
 SHA512:
-  metadata.gz: b879d5aca93a62fe73b284078a404c7a1d6680e71474c1f9b6fb55ec7ed1db82d7bc540282d4084acc3445fce8214ec5efb208bffa9879b1ba42fb6220c4b7b4
-  data.tar.gz: 5a0467c6f469baafefd4139f46d4188e5a06cb2ecbeb18b83ce29668b920302c2d8f0162f0a730b3a505f3ea312ee17d912b2d9daaa616ef76f5975c2acd1ab1
+  metadata.gz: 5be132b5e5c167ef33852f3a118becd6057e597794734f91d1527c8dca7ca3ce2f25bed65290f0e86b6240ed0014f698d42561aeb31bc0d4e67b260f2b8dbf4a
+  data.tar.gz: f1a7a8928206d7fbecd1f916f1e2237e01bdda8f8389ea21968c634a14b3ba8829f07a62d016963802dfe67cc9f13e49d8f88a56e3a89f6419e9fe2deacabd87

data/README.md

@@ -16,7 +16,8 @@ if the value is a time in the future it will schedule the entry for publishing a
 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.
+`Rakefile` and is specific per-space(supports multiple spaces), also please make sure contentBlocks are valid
+as per logic contentBlocks are published first then the page is published, so if there is any contentBlocks missing publishing won't work.
 
 You can add multiple spaces to your configuration, making it useful if you have a milti-space setup.
 
@@ -29,7 +30,7 @@ You can add multiple spaces to your configuration, making it useful if you have
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'contentful-scheduler'
+gem 'contentful-scheduler-custom'
 ```
 
 And then execute:
@@ -38,7 +39,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install contentful-scheduler
+    $ gem install contentful-scheduler-custom
 
 ## Usage
 
@@ -54,7 +55,7 @@ If you want to roll out your own, you need to follow the next steps:
 ```ruby
 source 'https://rubygems.org'
 
-gem 'contentful-scheduler-custom-build-john', '~>1.30'
+gem 'contentful-scheduler-custom', '~>1.4'
 gem 'contentful-management', '~> 1.0'
 gem 'resque', '~> 1.0'
 gem 'resque-scheduler', '~> 4.0'
@@ -87,6 +88,14 @@ config = {
     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'
+    },
+    'YOUR_SPACE_ID' => {
+      publish_field: 'publishDate', # It specifies the field ID for your Publish Date in your Content Type
+      management_token: 'YOUR_TOKEN'
+     },
     'YOUR_SPACE_ID' => {
       publish_field: 'publishDate', # It specifies the field ID for your Publish Date in your Content Type
       management_token: 'YOUR_TOKEN'
@@ -169,6 +178,67 @@ 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`.
 
+## Running in Production Mode
+
+After verifying that application is working fine in development mode(run "foreman start" for development mode)
+
+Run the following commands
+
+1. sudo foreman export -p5000 --app stp --user username_to_start_from systemd /etc/systemd/system/
+
+Output will be like this:
+
+[foreman export] cleaning up directory: /etc/systemd/system//graphical.target.wants
+[foreman export] writing: stp-web@.service
+[foreman export] creating: stp-web.target.wants
+[foreman export] symlinking: stp-web.target.wants/stp-web@5000.service -> ../stp-web@.service
+[foreman export] writing: stp-web.target
+[foreman export] writing: stp-celery@.service
+[foreman export] creating: stp-celery.target.wants
+[foreman export] symlinking: stp-celery.target.wants/stp-celery@5100.service -> ../stp-celery@.service
+[foreman export] writing: stp-celery.target
+[foreman export] writing: stp.target
+
+2. cat /etc/systemd/system/stp-web@.service | head -n 10
+
+Output will be like this:
+
+[Unit]
+PartOf=stp-web.target
+
+[Service]
+User=username_to_start_from 
+WorkingDirectory=/srv/stp/
+Environment=PORT=%i
+... HERE OTHER DIRICTIVES FROM YOUR .env file ...
+Environment=DEBUG=0
+...
+
+
+3. Start only gunicorn on port 5700:
+
+   systemctl start stp-web@5700.service
+
+4. Start whole target:
+
+   systemctl start stp.target
+
+5. Enable whole target (start on OS boot):
+
+   systemctl enable stp.target
+
+6. Restarting daemon
+
+   sudo systemctl daemon-reload
+   
+   sudo systemctl restart stp.target
+   
+7. Optional 
+
+   You can also simply define port when call foreman export -pXXXX, but it should be multiple of 1000,
+   e.g. 1000, 2000, 3000, 45000 etc.
+
+
 ## 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.

data/example/Dockerfile

@@ -0,0 +1,25 @@
+FROM ruby:2.5
+MAINTAINER Bugs Bunny <bbunny@rubyplus.com>
+
+
+
+# Install gems
+ENV APP_HOME /app
+ENV HOME /root
+RUN mkdir $APP_HOME
+RUN chmod -R 777 /app
+RUN chmod -R 777 /root
+
+
+WORKDIR $APP_HOME
+COPY Gemfile* $APP_HOME/
+RUN bundle install
+
+# Upload source
+COPY . $APP_HOME
+
+# Start server
+ENV PORT 8080
+EXPOSE 8080
+USER 1001
+CMD ["foreman", "start"]

data/example/Gemfile

@@ -1,7 +1,8 @@
 source 'https://rubygems.org'
 
-gem 'contentful-scheduler-custom-build-john', '~>1.30'
+gem 'contentful-scheduler-custom', '~>1.4'
 gem 'contentful-management', '~> 1.0'
 gem 'resque', '~> 1.0'
-gem 'resque-scheduler', '~> 4.0'
-gem 'rake'
+gem 'resque-scheduler', '4.2.1'
+gem 'rake'
+gem 'foreman', '~> 0.84.0'

data/example/Procfile

@@ -1,4 +1,4 @@
-web: env bundle exec rake contentful:scheduler
+web: PORT=$PORT bundle exec env 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

@@ -4,12 +4,12 @@ $stdout.sync = true
 
 config = {
   logger: Logger.new(STDOUT), # Defaults to NullLogger
-  port: 6378, # Defaults to 8081
+  port: 8080, # Defaults to 8081
   endpoint: '/scheduler', # Defaults to /scheduler
   redis: {
-    host: '127.0.0.1',
+    host: 'scheduler-redis-db',
     port: '6379',
-    password: '5D40001BB59A2EF2439A55DAB7E718609A3A93CC9D3FD414BB13A75933048CD7'
+    password: 'password'
   },
   spaces: {
     'qbra4qai2ti2' => {
@@ -42,4 +42,4 @@ namespace :resque do
   end
 
   task :scheduler => :setup_schedule
-end
+end

data/example/config.ru

@@ -3,9 +3,9 @@ require 'resque/server'
 require 'resque/scheduler/server'
 
 config = {
-  host: '127.0.0.1',
+  host: 'scheduler-redis-db',
   port: '6379',
-  password: '5D40001BB59A2EF2439A55DAB7E718609A3A93CC9D3FD414BB13A75933048CD7'
+  password: 'password'
 }
 Resque.redis = config
 

data/lib/contentful/scheduler/queue.rb

@@ -14,30 +14,53 @@ module Contentful
       end
 
       def update_or_create(webhook)
-        return unless publishable?(webhook)
-        remove(webhook) if in_queue?(webhook)
-        return if already_published?(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
+
+        updateContentBlocks(webhook)
+      end
+
+      def update_or_create_for_publish(webhook)
+        remove_publish(webhook) if in_publish_queue?(webhook)
+        return false unless publish_is_future?(webhook)
 
-        success = Resque.enqueue_at(
+        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
 
-        updateContentBlocks(webhook)
+      def update_or_create_for_unpublish(webhook)
+        remove_unpublish(webhook) if in_unpublish_queue?(webhook)
+        return false unless unpublish_is_future?(webhook)
 
-        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
+        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,
@@ -48,11 +71,7 @@ module Contentful
 
         removeContentBlocks(webhook)
 
-        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
+        log_event_success(webhook, success, 'publish', 'removed from')
       end
 
       def updateContentBlocks(webhook)
@@ -100,30 +119,70 @@ module Contentful
         return false unless spaces.key?(webhook.space_id)
 
         if webhook_publish_field?(webhook)
-          return !webhook_publish_field(webhook).nil?
+          return !webhook_publish_field(webhook).nil? && publish_is_future?(webhook)
         end
 
         false
       end
 
-      def already_published?(webhook)
-        return true if publish_date(webhook) < Time.now.utc
-
-        false
+      def publish_is_future?(webhook)
+        publish_date(webhook) > Time.now.utc
       end
 
-      def in_queue?(webhook)
+      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 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]
+        )
+
+        removeContentBlocks(webhook)
+
+        log_event_success(webhook, success, 'unpublish', 'removed from')
+      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 unpublish_is_future?(webhook)
+        unpublish_date(webhook) > Time.now.utc
+      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_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
@@ -132,10 +191,26 @@ 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
+
+      def log_event_success(webhook, success, event_kind, action)
+        if success
+          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 #{action} the #{event_kind} queue"
+        end
+      end
+
       private
 
       def initialize(logger)

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 = "1.4.0"
+    VERSION = "1.5.0"
   end
 end

data/spec/contentful/scheduler/queue_spec.rb

@@ -100,32 +100,6 @@ describe Contentful::Scheduler::Queue do
       end
     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 'false 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_falsey
-      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?(
@@ -147,7 +121,7 @@ describe Contentful::Scheduler::Queue do
 
       it 'true if publish_field is populated' do
         expect(subject.publishable?(
-          WebhookDouble.new('bar', 'foo', {}, {'my_field' => '2011-04-04T22:00:00+00:00'})
+          WebhookDouble.new('bar', 'foo', {}, {'my_field' => '2111-04-04T22:00:00+00:00'})
         )).to be_truthy
       end
     end
@@ -221,14 +195,6 @@ describe Contentful::Scheduler::Queue do
 
           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
 
@@ -250,7 +216,7 @@ describe Contentful::Scheduler::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'}))
+        subject.remove(WebhookDouble.new('bar', 'foo', {}, {'my_field' => '2111-04-04T22:00:00+00:00'}))
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contentful-scheduler-custom
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Contentful GmbH (David Litvak Bruno0
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-24 00:00:00.000000000 Z
+date: 2018-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: contentful-webhook-listener
@@ -196,8 +196,8 @@ files:
 - README.md
 - Rakefile
 - contentful-scheduler.gemspec
+- example/Dockerfile
 - example/Gemfile
-- example/Gemfile.lock
 - example/Procfile
 - example/Rakefile
 - example/config.ru

data/example/Gemfile.lock

@@ -1,83 +0,0 @@
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
-    chronic (0.10.2)
-    contentful-management (1.10.0)
-      http (> 1.0, < 3.0)
-      json (~> 1.8)
-      multi_json (~> 1)
-    contentful-scheduler (0.2.1)
-      chronic (~> 0.10)
-      contentful-management (~> 1.8)
-      contentful-webhook-listener (~> 0.2)
-      redis (~> 3.0)
-      resque (~> 1.0)
-      resque-scheduler (~> 4.0)
-    contentful-webhook-listener (0.3.0)
-    domain_name (0.5.20170404)
-      unf (>= 0.0.5, < 1.0.0)
-    et-orbi (1.0.8)
-      tzinfo
-    http (2.2.2)
-      addressable (~> 2.3)
-      http-cookie (~> 1.0)
-      http-form_data (~> 1.0.1)
-      http_parser.rb (~> 0.6.0)
-    http-cookie (1.0.3)
-      domain_name (~> 0.5)
-    http-form_data (1.0.3)
-    http_parser.rb (0.6.0)
-    json (1.8.6)
-    mono_logger (1.1.0)
-    multi_json (1.13.1)
-    mustermann (1.0.1)
-    public_suffix (3.0.1)
-    rack (2.0.3)
-    rack-protection (2.0.0)
-      rack
-    rake (12.3.0)
-    redis (3.3.5)
-    redis-namespace (1.6.0)
-      redis (>= 3.0.4)
-    resque (1.27.4)
-      mono_logger (~> 1.0)
-      multi_json (~> 1.0)
-      redis-namespace (~> 1.3)
-      sinatra (>= 0.9.2)
-      vegas (~> 0.1.2)
-    resque-scheduler (4.3.1)
-      mono_logger (~> 1.0)
-      redis (>= 3.3, < 5)
-      resque (~> 1.26)
-      rufus-scheduler (~> 3.2)
-    rufus-scheduler (3.4.2)
-      et-orbi (~> 1.0)
-    sinatra (2.0.0)
-      mustermann (~> 1.0)
-      rack (~> 2.0)
-      rack-protection (= 2.0.0)
-      tilt (~> 2.0)
-    thread_safe (0.3.6)
-    tilt (2.0.8)
-    tzinfo (1.2.4)
-      thread_safe (~> 0.1)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.4)
-    vegas (0.1.11)
-      rack (>= 1.0.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  contentful-management (~> 1.0)
-  contentful-scheduler (~> 0.1)
-  rake
-  resque (~> 1.0)
-  resque-scheduler (~> 4.0)
-
-BUNDLED WITH
-   1.16.1