sinatra_cyclist_multi 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f75250653f1bd09cfcb1aff0400b70c3d87ab39e
+  data.tar.gz: b6be1a3c3326c4b039f7eb8f68c4b3012dff0ef1
+SHA512:
+  metadata.gz: 1b844166fa754c49a074fa6aa646cce68671764d22d738427ba5de36149dabf8b2ac9c9f18843c96e8ececc63689ccd90c5df674775602e315b428e82b1df36a
+  data.tar.gz: 82cee65afad8ecf68a881a55e952f9b4e54d50a549a8e242669a6580042b21bea6b7d8920b0934d6d7b0c086f5543405d92ffae69b8ebd40af6a190afa81a999

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/Dockerfile

@@ -0,0 +1,34 @@
+FROM ruby:2.3-alpine
+MAINTAINER nfa
+RUN apk --update --no-cache add \
+  build-base \
+  nodejs \
+  zlib-dev \
+  libxml2-dev \
+  libxslt-dev \
+  sqlite-dev \
+  tzdata \
+  git \
+  && rm -rf /var/cache/apk/*
+
+RUN cp /usr/share/zoneinfo/Europe/Paris /etc/localtime &&\
+  echo "Europe/Paris" >  /etc/timezone
+
+RUN bundle config --global build.nokogiri  "--use-system-libraries" &&\
+  bundle config --global build.nokogumbo "--use-system-libraries" &&\
+  echo 'gem: --no-doc --no-ri' >> ~/.gemrc && chmod +r ~/.gemrc
+
+ENV APP_HOME /app
+RUN mkdir -p $APP_HOME
+WORKDIR $APP_HOME
+
+RUN gem install dashing
+RUN dashing new . &&\
+  rm -f dashboards/sample* jobs/*.rb &&\
+  bundle
+COPY test/dashing/ ./
+COPY . ./lib/sinatra_cyclist_multi
+RUN rm -rf ./lib/sinatra_cyclist_multi/examples
+
+EXPOSE 8080:3030
+CMD dashing start

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Michael Lavrisha
+
+MIT License
+
+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,155 @@
+# Sinatra Cyclist Multi
+
+This is a fork of the original gem [vrish88/sinatra_cyclist](https://github.com/vrish88/sinatra_cyclist), thank you vrish88.
+
+Added option to use multiple cycled routes.
+
+|  cycled routes           |  routes pages                         |  cycle time  |
+|--------------------------|---------------------------------------|--------------|
+| first-cycled-route       | ['dashboard1', 'dashboard2', 'dash3'] |  10          |
+| another-cycled-route     | ['dashboard12', 'dashboardY']         |  5           |
+| prod-cycle-route         | ['dashi', 'dashou', 'dashbord36']     |  45          |
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sinatra_cyclist_multi'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sinatra_cyclist_multi
+
+Installation into your code depends on how you are using Sinatra.
+
+## Configuration
+
+If you need only one cycled route you can use [vrish88/sinatra_cyclist](https://github.com/vrish88/sinatra_cyclist) gem or set only one cycled route:
+
+```ruby
+  set :cycles_configuration, [
+    {cycled_route: '_cycle', routes: [:page1, :page2], cycle_duration: 15},
+    {cycled_route: '_cycle2', routes: [:page12, :page3, :page4], cycle_duration: 5},
+    {cycled_route: '_prod', routes: [:page7, :page4, :page5, :page6], cycle_duration: 45},
+  ]
+```
+
+### Dashing
+If you are using [dashing](https://github.com/Shopify/dashing) update your `config.ru` to look something like:
+
+```ruby
+require "sinatra/cyclist"
+require 'dashing'
+
+configure do
+  set :auth_token, 'YOUR_AUTH_TOKEN'
+
+  helpers do
+    def protected!
+     # Put any authentication code you want in here.
+     # This method is run before accessing any resource.
+    end
+  end
+end
+
+map Sinatra::Application.assets_prefix do
+  run Sinatra::Application.sprockets
+end
+
+set :cycles_configuration, [
+  {cycled_route: '_cycle', routes: [:page1, :page2], cycle_duration: 15},
+  {cycled_route: '_cycle2', routes: [:page12, :page3, :page4], cycle_duration: 5},
+  {cycled_route: '_prod', routes: [:page7, :page4, :page5, :page6], cycle_duration: 45},
+]
+
+run Sinatra::Application
+```
+
+* Require `sinatra_cyclist_multi` before `dashing` otherwise you will see this error:
+
+    > No such file or directory - sample/dashboards/_cycle.erb
+
+* Set the `routes_to_cycle_through` before running the application.
+
+### Classic Applications
+Require the gem and specify the routes you want to cycle through.
+
+```ruby
+require "sinatra"
+require "sinatra/cyclist"
+
+set :cycles_configuration, [
+  {cycled_route: '_cycle', routes: [:page1, :page2], cycle_duration: 30},
+]
+
+get "/page_1" do
+  "Page 1"
+end
+
+get "/page_2" do
+  "Page 2"
+end
+```
+
+### Modular Applications
+Require the gem, explicitly register the extension, and specify the routes.
+```ruby
+require "sinatra/base"
+require "sinatra/cyclist"
+
+class MyApp < Sinatra::Base
+  register Sinatra::Cyclist
+
+  set :cycles_configuration, [
+    {cycled_route: '_cycle', routes: [:page1, :page2], cycle_duration: 30},
+  ]
+
+  get "/page_1" do
+    "Page 1"
+  end
+
+  get "/page_2" do
+    "Page 2"
+  end
+end
+```
+
+## Usage
+Now visit one of your configured cycled routes `/_cycle/#{cycled_route}` to start cycling!
+
+You can also specify a duration (in seconds) in the params to the cycle action
+
+```
+http://sinatra_app.com/_cycle/#{cycled_route}?duration=10
+```
+
+/!\ **Do not use this gem with the original, it will conflict** /!\
+
+
+## Try it with on Dashing
+You can try with the **Dockerfile** in test folder. Considering you have a working docker installation you can run:
+
+```shell
+  cd sinatra_cyclist_multi/test
+  docker build -t nfaa/cyclist . && docker run --name cyclist -p8080:3030 nfaa/cyclist
+```
+
+There are three cycled routes configured:
+```
+  http://{docker host ip}:8080/_cycle/_cycle
+  http://{docker host ip}:8080/_cycle/cycle
+  http://{docker host ip}:8080/_cycle/prod
+```
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/examples/classic_application.rb

@@ -0,0 +1,12 @@
+require "sinatra"
+require "sinatra/cyclist"
+
+set :routes_to_cycle_through, [:page_1, :page_2]
+
+get "/page_1" do
+  "Page 1"
+end
+
+get "/page_2" do
+  "Page 2"
+end

data/examples/config.ru

@@ -0,0 +1,2 @@
+require "./modular_application"
+run MyApp

data/examples/modular_application.rb

@@ -0,0 +1,16 @@
+require "sinatra/base"
+require "sinatra/cyclist"
+
+class MyApp < Sinatra::Base
+  register Sinatra::Cyclist
+
+  set :routes_to_cycle_through, [:page_1, :page_2]
+
+  get "/page_1" do
+    "Page 1"
+  end
+
+  get "/page_2" do
+    "Page 2"
+  end
+end

data/lib/sinatra/cyclist.rb

@@ -0,0 +1,47 @@
+require "sinatra/base"
+require_relative "cyclist/version"
+
+module Sinatra
+  module Cyclist
+    def self.registered(app)
+      app.enable :sessions
+      app.set :cycles_configuration, []
+
+      app.get "/_cycle/:cycled_route" do
+        not_found if
+          settings.cycles_configuration.empty? or
+          settings.cycles_configuration.select{ |cycle|
+            cycle[:cycled_route] == params['cycled_route'] &&
+            cycle[:routes].is_a?(Array) &&
+            !cycle[:routes].empty?
+          }.empty?
+
+        cycle = settings.cycles_configuration.select{ |cycle|
+          cycle[:cycled_route] == params['cycled_route']
+        }.first
+
+        page_index = session[:_cycle_page_index] || -1
+        session[:_cycle_page_index] = page_index + 1
+
+        number_of_routes = cycle[:routes].length
+        page = cycle[:routes][session[:_cycle_page_index] % number_of_routes]
+
+        session[:_cycle_duration] = params[:duration] if params[:duration]
+        session[:_cycle_duration] = cycle[:cycle_duration]
+        session[:_cycled_route] = cycle[:cycled_route]
+        session[:_cycle] = true
+
+        redirect "/#{page}"
+      end
+
+      app.before do
+        if session[:_cycle]
+          headers["Refresh"] = "#{session[:_cycle_duration]}; url=/_cycle/#{session[:_cycled_route]}"
+          session[:_cycle] = false
+        end
+      end
+    end
+  end
+
+  register Cyclist
+end

data/lib/sinatra/cyclist/version.rb

@@ -0,0 +1,5 @@
+module Sinatra
+  module Cyclist
+    VERSION = "0.0.2"
+  end
+end

data/sinatra_cyclist_multi.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sinatra/cyclist/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Michael Lavrisha", 'Nabil Abachouayb']
+  gem.email         = ["michael.lavrisha@gmail.com", 'me@nabile.fr']
+  gem.description   = %q{Cycle through pages at a regular interval}
+  gem.summary       = %q{Sinatra can ride a bicycle over and over and over again}
+  gem.homepage      = "https://github.com/faouzzz/sinatra_cyclist_multi"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "sinatra_cyclist_multi"
+  gem.require_paths = ["lib"]
+  gem.version       = Sinatra::Cyclist::VERSION
+
+  gem.add_dependency "sinatra"
+
+end

data/test/dashing/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'dashing'
+gem 'sinatra_cyclist_multi', path: './lib/sinatra_cyclist_multi'

data/test/dashing/config.ru

@@ -0,0 +1,28 @@
+require 'sinatra/cyclist'
+require 'dashing'
+
+configure do
+  set :auth_token, 'YOUR_AUTH_TOKEN'
+
+  helpers do
+    def protected!
+      # Put any authentication code you want in here.
+      # This method is run before accessing any resource.
+    end
+  end
+end
+
+map Sinatra::Application.assets_prefix do
+  run Sinatra::Application.sprockets
+end
+
+set :cycles_configuration, [
+  {cycled_route: '_cycle', routes: [:sample, :sample2], cycle_duration: 2},
+  {cycled_route: 'cycle', routes: [:sample2, :sample3, :sample4], cycle_duration: 5},
+  {cycled_route: 'prod', routes: [:sample1, :sample6, :sample5, :sample4], cycle_duration: 10},
+  {cycled_route: 'bad', routes: [], cycle_duration: 10}, # should redirect not_found
+  {cycled_route: 'baad', routes: '', cycle_duration: 10}, # should redirect not_found
+  {cycled_route: 'baaad', routes: nil, cycle_duration: 10}, # should redirect not_found
+]
+
+run Sinatra::Application

data/test/dashing/dashboards/sample.erb

@@ -0,0 +1,7 @@
+<div class="gridster">
+  <ul>
+    <li data-row="1" data-col="1" data-sizex="4" data-sizey="2">
+      <div data-id="sample" data-view="Number" data-title="Dashboard" data-current='0'></div>
+    </li>
+  </ul>
+</div>

data/test/dashing/dashboards/sample1.erb

@@ -0,0 +1,7 @@
+<div class="gridster">
+  <ul>
+    <li data-row="1" data-col="1" data-sizex="4" data-sizey="2">
+      <div data-id="sample" data-view="Number" data-title="Dashboard" data-current='1'></div>
+    </li>
+  </ul>
+</div>

data/test/dashing/dashboards/sample2.erb

@@ -0,0 +1,7 @@
+<div class="gridster">
+  <ul>
+    <li data-row="1" data-col="1" data-sizex="4" data-sizey="2">
+      <div data-id="sample" data-view="Number" data-title="Dashboard" data-current='2'></div>
+    </li>
+  </ul>
+</div>

data/test/dashing/dashboards/sample3.erb

@@ -0,0 +1,7 @@
+<div class="gridster">
+  <ul>
+    <li data-row="1" data-col="1" data-sizex="4" data-sizey="2">
+      <div data-id="sample" data-view="Number" data-title="Dashboard" data-current='3'></div>
+    </li>
+  </ul>
+</div>

data/test/dashing/dashboards/sample4.erb

@@ -0,0 +1,7 @@
+<div class="gridster">
+  <ul>
+    <li data-row="1" data-col="1" data-sizex="4" data-sizey="2">
+      <div data-id="sample" data-view="Number" data-title="Dashboard" data-current='4'></div>
+    </li>
+  </ul>
+</div>

data/test/dashing/dashboards/sample5.erb

@@ -0,0 +1,7 @@
+<div class="gridster">
+  <ul>
+    <li data-row="1" data-col="1" data-sizex="4" data-sizey="2">
+      <div data-id="sample" data-view="Number" data-title="Dashboard" data-current='5'></div>
+    </li>
+  </ul>
+</div>

data/test/dashing/dashboards/sample6.erb

@@ -0,0 +1,7 @@
+<div class="gridster">
+  <ul>
+    <li data-row="1" data-col="1" data-sizex="4" data-sizey="2">
+      <div data-id="sample" data-view="Number" data-title="Dashboard" data-current='6'></div>
+    </li>
+  </ul>
+</div>

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: sinatra_cyclist_multi
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Michael Lavrisha
+- Nabil Abachouayb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Cycle through pages at a regular interval
+email:
+- michael.lavrisha@gmail.com
+- me@nabile.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Dockerfile
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- examples/classic_application.rb
+- examples/config.ru
+- examples/modular_application.rb
+- lib/sinatra/cyclist.rb
+- lib/sinatra/cyclist/version.rb
+- sinatra_cyclist_multi.gemspec
+- test/dashing/Gemfile
+- test/dashing/config.ru
+- test/dashing/dashboards/sample.erb
+- test/dashing/dashboards/sample1.erb
+- test/dashing/dashboards/sample2.erb
+- test/dashing/dashboards/sample3.erb
+- test/dashing/dashboards/sample4.erb
+- test/dashing/dashboards/sample5.erb
+- test/dashing/dashboards/sample6.erb
+homepage: https://github.com/faouzzz/sinatra_cyclist_multi
+licenses: []
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Sinatra can ride a bicycle over and over and over again
+test_files:
+- test/dashing/Gemfile
+- test/dashing/config.ru
+- test/dashing/dashboards/sample.erb
+- test/dashing/dashboards/sample1.erb
+- test/dashing/dashboards/sample2.erb
+- test/dashing/dashboards/sample3.erb
+- test/dashing/dashboards/sample4.erb
+- test/dashing/dashboards/sample5.erb
+- test/dashing/dashboards/sample6.erb