contentful-scheduler-custom 1.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f92623b5fe928b9bfe25297cf01e837ab8aa5046
+  data.tar.gz: f9bf39f91e6d5a3554586eb79f9a586088e29ac8
+SHA512:
+  metadata.gz: b879d5aca93a62fe73b284078a404c7a1d6680e71474c1f9b6fb55ec7ed1db82d7bc540282d4084acc3445fce8214ec5efb208bffa9879b1ba42fb6220c4b7b4
+  data.tar.gz: 5a0467c6f469baafefd4139f46d4188e5a06cb2ecbeb18b83ce29668b920302c2d8f0162f0a730b3a505f3ea312ee17d912b2d9daaa616ef76f5975c2acd1ab1

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+# CHANGELOG
+
+## Unreleased
+
+## 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
+* Fix time parsing.
+
+## 0.2.0
+
+### Added
+
+* Added User Agent Header Application Name
+
+### Changed
+
+* Updated to latest CMA SDK Version.
+
+## 0.1.0
+
+* Initial Release

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,178 @@
+# Contentful Scheduler
+
+Scheduling Server for Contentful entries.
+
+## Contentful
+[Contentful](https://www.contentful.com) provides a content infrastructure for digital teams to power content in websites, apps, and devices. Unlike a CMS, Contentful was built to integrate with the modern software stack. It offers a central hub for structured content, powerful management and delivery APIs, and a customizable web app that enable developers and content creators to ship digital products faster.
+
+## 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-custom-build-john', '~>1.30'
+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,35 @@
+# 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-custom"
+  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.8"
+  spec.add_runtime_dependency "resque", "~> 1.27.4"
+  spec.add_runtime_dependency "resque-scheduler", "~> 4.2.1"
+  spec.add_runtime_dependency "redis", "~> 3.0"
+  spec.add_runtime_dependency "chronic", "~> 0.10"
+
+  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"
+  spec.add_development_dependency "simplecov"
+end

data/example/Gemfile

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

data/example/Gemfile.lock

@@ -0,0 +1,83 @@
+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

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,45 @@
+require 'contentful/scheduler'
+
+$stdout.sync = true
+
+config = {
+  logger: Logger.new(STDOUT), # Defaults to NullLogger
+  port: 6378, # Defaults to 8081
+  endpoint: '/scheduler', # Defaults to /scheduler
+  redis: {
+    host: '127.0.0.1',
+    port: '6379',
+    password: '5D40001BB59A2EF2439A55DAB7E718609A3A93CC9D3FD414BB13A75933048CD7'
+  },
+  spaces: {
+    'qbra4qai2ti2' => {
+      publish_field: 'publishDate', # It specifies the field ID for your Publish Date in your Content Type
+      management_token: 'CFPAT-45f0c4258aa9b32e8a8b6ccebf64136386b31f3ec435cc17f540368d5416de02'
+    }
+  },
+}
+
+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