contentful-scheduler-custom 1.5.6999 → 1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aae2fb3cd4336bbeb9160a6474726bf05fa58153
-  data.tar.gz: ea9cc62d1998f52769961d226faebd0fbf3ab0f5
+  metadata.gz: 24c8e76a7bb0e793768f797eb6b2252796328df7
+  data.tar.gz: ec6d9c83ff444867914d62efaa43a221f7701c51
 SHA512:
-  metadata.gz: 21852b25d6d66a73ea437fe95ee2a54ce1adc5f42f178c001c7d3383c9c70791cd79dc15e96604424d7a96ed9e9ebe71b6af8cbd37982f80391d2c5a66221963
-  data.tar.gz: 1690e04e7936aec3913e1cabf8ca3df249b2960b047cb18820f5a5c861a64356969338f290d142588cf0a6f2b6227368bc0251ba61128e31b0c7b18b82ba5b80
+  metadata.gz: 47aa3a11c0e51b5166fde9ab1816e167c659c0959b39fe462f1fc8441645b9f483b21f213c75b87d0b951ebf1db685496e4930b544bb119d14e9354b5946c834
+  data.tar.gz: 887d473720281c0c31cd066697f65ed0af986713a3f487dad55c459dafb914ff10c6c595358bccf6b9a760a032f73dd71e85618ce0d64e0a4ff8a2443176549e

data/.gitignore

@@ -9,3 +9,5 @@
 /tmp/
 .DS_Store
 dump.rdb
+/.idea/
+/example/.rakeTasks

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 2.2.3
   - 2.3.1
-  - 2.4.0
+  - 2.4.1
+  - 2.5.1
 before_install: gem install bundler -v 1.10.6

data/CHANGELOG.md

@@ -2,21 +2,17 @@
 
 ## Unreleased
 
-## 0.5.0
-### Added
-* Added support for scheduled unpublishing. [#10](https://github.com/contentful/contentful-scheduler.rb/issues/10)
+## 1.6
 
-## 0.4.0
-### Fixed
+* Added support for scheduled unpublishing. [#10](https://github.com/contentful/contentful-scheduler.rb/issues/10)
 * Fixed User Agent Header to comply with specification.
-
-### Added
 * Added authentication mechanisms. [#9](https://github.com/contentful/contentful-scheduler.rb/issues/9)
-
-## 0.3.0
-### Added
 * Added possibility to republish already published content. [#5](https://github.com/contentful/contentful-scheduler.rb/issues/5)
 
+## 1.4.0
+* Contentful Scheduler now supports future publishing for any existing enteries and
+publishing ContentBlocks first before publishing the page.
+
 ## 0.2.1
 
 ### Fixed

data/README.md

@@ -15,12 +15,14 @@ entries for scheduled publishing and unpublishing.
 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 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 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.
+A background worker based on the popular `resque` gem will then proceed to actually make the publish or unpublish call
+against the Content Management API at the due time. For this the Entries you wish to publish/unpublish require a
+customizable Date field, which we advice to call `publishDate`/`unpublishDate`, this field can be configured inside your
+`Rakefile` and is specific per-space(supports multiple spaces), also please make sure contentBlocks are valid
+as per logic contentBlocks are published/unpublished first then the page is published, so if there is any contentBlocks with errors those won't be 
+published/unpublished.
 
-You can add multiple spaces to your configuration, making it useful if you have a milti-space setup.
+You can add multiple spaces to your configuration, making it useful if you have a multi-space setup.
 
 ## Requirements
 
@@ -31,7 +33,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:
@@ -40,7 +42,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install contentful-scheduler
+    $ gem install contentful-scheduler-custom
 
 ## Usage
 
@@ -56,7 +58,7 @@ If you want to roll out your own, you need to follow the next steps:
 ```ruby
 source 'https://rubygems.org'
 
-gem 'contentful-scheduler', '~> 0.1'
+gem 'contentful-scheduler-custom', '~>1.6'
 gem 'contentful-management', '~> 1.0'
 gem 'resque', '~> 1.0'
 gem 'resque-scheduler', '~> 4.0'
@@ -89,13 +91,30 @@ 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
+      auth: { # This is optional
+        # ... content in this section will be explained in a separate section ...
+https://github.devcloud.elisa.fi/contentful-cms/scheduler/pull/2/conflict?name=README.md&ancestor_oid=091876b7c593e3c9ec6ffb1ccd405dcd03fcae1e&base_oid=02b7b6fbfcfa15c1f257beb63ac6b578da282205&head_oid=16b4e23acd70062e83d9bf5930590183234a6c1b      }
+      management_token: 'YOUR_TOKEN'
+     },
+      management_token: 'YOUR_TOKEN'
+    },
+    '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
+      auth: { # This is optional
+        # ... content in this section will be explained in a separate section ...
+      }
+      management_token: 'YOUR_TOKEN'
+     },
     '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 ...
       }
+      management_token: 'YOUR_TOKEN'
     }
   },
 }
@@ -265,6 +284,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/contentful-scheduler.gemspec

@@ -21,9 +21,9 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "contentful-webhook-listener", "~> 0.2"
   spec.add_runtime_dependency "contentful-management", "~> 1.8"
-  spec.add_runtime_dependency "resque", "~> 1.0"
-  spec.add_runtime_dependency "resque-scheduler", "~> 4.0"
-  spec.add_runtime_dependency "redis", "~> 3.0"
+  spec.add_runtime_dependency "resque", "~> 1.27.4"
+  spec.add_runtime_dependency "resque-scheduler", "~> 4.3.1"
+  spec.add_runtime_dependency "redis", "~> 4.0.1"
   spec.add_runtime_dependency "chronic", "~> 0.10"
 
   spec.add_development_dependency "bundler", "~> 1.10"

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', '~> 0.1'
+gem 'contentful-scheduler-custom', '~>1.4'
 gem 'contentful-management', '~> 1.0'
 gem 'resque', '~> 1.0'
-gem 'resque-scheduler', '~> 4.0'
+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
+resque_scheduler: env bundle exec rake resque:scheduler

data/example/Rakefile

@@ -1,23 +1,22 @@
 require 'contentful/scheduler'
-require 'logger' # Optional
 
 $stdout.sync = true
 
 config = {
   logger: Logger.new(STDOUT), # Defaults to NullLogger
-  port: 32123, # Defaults to 32123
+  port: 8080, # Defaults to 8081
   endpoint: '/scheduler', # Defaults to /scheduler
   redis: {
-    host: 'YOUR_REDIS_HOST',
-    port: 'YOUR_REDIS_PORT',
-    password: 'YOUR_REDIS_PASSWORD'
+    host: 'scheduler-redis-db',
+    port: '6379',
+    password: 'password'
   },
   spaces: {
-    'YOUR_SPACE_ID' => {
+    'qbra4qai2ti2' => {
       publish_field: 'publishDate', # It specifies the field ID for your Publish Date in your Content Type
-      management_token: 'YOUR_TOKEN'
+      management_token: 'CFPAT-45f0c4258aa9b32e8a8b6ccebf64136386b31f3ec435cc17f540368d5416de02'
     }
-  }
+  },
 }
 
 namespace :contentful do

data/example/config.ru

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

data/lib/contentful/scheduler/queue.rb

@@ -1,6 +1,7 @@
+require_relative "tasks"
+require_relative "tasks"
 require 'chronic'
 require 'contentful/webhook/listener'
-require_relative "tasks"
 
 module Contentful
   module Scheduler
@@ -39,7 +40,7 @@ module Contentful
           ::Contentful::Scheduler.config[:spaces][webhook.space_id][:management_token]
         )
       end
-
+      
       def update_or_create_for_unpublish(webhook)
         remove_unpublish(webhook) if in_unpublish_queue?(webhook)
         return false unless unpublish_is_future?(webhook)
@@ -54,8 +55,8 @@ module Contentful
       end
 
       def remove(webhook)
-        remove_unpublish(webhook)
         remove_publish(webhook)
+        remove_unpublish(webhook)
       end
 
       def remove_publish(webhook)
@@ -98,6 +99,10 @@ module Contentful
         end
       end
 
+      def isContentBlockAvailable(webhook)
+        return !webhook.fields['contentBlocks'].nil?
+      end
+
       def publishable?(webhook)
         return false unless spaces.key?(webhook.space_id)
 
@@ -114,7 +119,6 @@ module Contentful
         if webhook_unpublish_field?(webhook)
           return !webhook_unpublish_field(webhook).nil? && unpublish_is_future?(webhook)
         end
-
         false
       end
 
@@ -187,10 +191,6 @@ module Contentful
         end
       end
 
-      def isContentBlockAvailable(webhook)
-        return !webhook.fields['contentBlocks'].nil?
-      end
-
       def getScheduleType(type)
         if type == 'publish'
           ::Contentful::Scheduler::Tasks::Publish
@@ -212,11 +212,11 @@ module Contentful
       end
 
       def webhook_publish_field?(webhook)
-        webhook.fields.key?(spaces.fetch(webhook.space_id, {})[:publish_field])
+        webhook.fields.key?(spaces.fetch(webhook.space_id, {})[:publish_field]) if webhook.respond_to?(:fields)
       end
 
       def webhook_unpublish_field?(webhook)
-        webhook.fields.key?(spaces.fetch(webhook.space_id, {})[:unpublish_field])
+        webhook.fields.key?(spaces.fetch(webhook.space_id, {})[:unpublish_field]) if webhook.respond_to?(:fields)
       end
 
       def webhook_publish_field(webhook)

data/lib/contentful/scheduler/version.rb

@@ -1,5 +1,5 @@
 module Contentful
   module Scheduler
-    VERSION = "1.5.6999"
+    VERSION = "1.6"
   end
 end

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

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 class MockEntry
-  def publish
+  def unpublish
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contentful-scheduler-custom
 version: !ruby/object:Gem::Version
-  version: 1.5.6999
+  version: '1.6'
 platform: ruby
 authors:
 - Contentful GmbH (David Litvak Bruno0
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-19 00:00:00.000000000 Z
+date: 2018-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: contentful-webhook-listener
@@ -44,42 +44,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.27.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.27.4
 - !ruby/object:Gem::Dependency
   name: resque-scheduler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.3.1
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 4.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 4.0.1
 - !ruby/object:Gem::Dependency
   name: chronic
   requirement: !ruby/object:Gem::Requirement
@@ -196,6 +196,7 @@ files:
 - README.md
 - Rakefile
 - contentful-scheduler.gemspec
+- example/Dockerfile
 - example/Gemfile
 - example/Procfile
 - example/Rakefile