sinatra_websocket_template 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 553b00029fe8cceb8e255ac5f16a9c132c7f878d
+  data.tar.gz: eca78352ae22a0f5ded593b779fcb5aa8f379079
+SHA512:
+  metadata.gz: caaa07419335bc28128f28f108a4161e2227e7a36a748aab81294417ebb4b8c669766f3f65938ba34335c05560255c259244fb32a0f82aa328f737a347024a1a
+  data.tar.gz: f5c746096767192a4d1db796cd8c661a1dae89857d929a4e9f3e2b6cd6c3262507ca4f51182b4e09942e50142289015de562a124d1dbe88adc40cca85efc62d9

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 kyoendo
+
+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,33 @@
+# SinatraWebsocketTemplate
+
+`SinatraWebsocketTemplate` is for generating a skeleton of WebSocket application with Ruby(Sinatra)
+
+A concept of the skeleton code is inspired by the following article:
+
+> [Using WebSockets on Heroku with Ruby | Heroku Dev Center](https://devcenter.heroku.com/articles/ruby-websockets "Using WebSockets on Heroku with Ruby | Heroku Dev Center")
+
+## Installation
+
+    $ gem install sinatra_websocket_template
+
+## Usage
+
+4 steps to run a skeleton demo application;
+
+    $ sinatra_websocket_template new YOUR_PROJECT_NAME
+
+    $ cd YOUR_PROJECT_NAME
+
+    $ bundle install
+
+    $ bundle exec foreman start
+
+Open http://localhost:5000 to review it, then modify it as you like.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/sinatra_websocket_template

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'sinatra_websocket_template'
+
+SinatraWebsocketTemplate::CLI.start(ARGV)

data/lib/sinatra_websocket_template.rb

@@ -0,0 +1,7 @@
+%w(version cli).each do |lib|
+  require "sinatra_websocket_template/#{lib}"
+end
+
+module SinatraWebsocketTemplate
+  # Your code goes here...
+end

data/lib/sinatra_websocket_template/cli.rb

@@ -0,0 +1,74 @@
+require 'thor'
+require 'fileutils'
+
+module SinatraWebsocketTemplate
+  class CLI < Thor
+    include Thor::Actions
+
+    def self.source_root
+      File.join(__dir__, 'templates')
+    end
+
+    desc "new PROJECT", "Creates a skeleton for your project"
+    option :dir, aliases:"-d", default:Dir.pwd, banner:"Specify a target directory for your project."
+    option :test, aliases:"-t", lazy_default:"rspec", banner:"Generate a test directory(default: rspec)."
+    option :bin, aliases:"-b", type: :boolean, default:false, banner:"Generate a binary."
+    def new(project_name)
+      target = File.join(options[:dir], project_name)
+      opts = {
+        module_name: project_name.split('_').map(&:capitalize).join,
+        namespaced_path: project_name
+      }
+
+      template("project/Procfile.tt", File.join(target, "Procfile"))
+      template("project/config.ru.tt", File.join(target, "config.ru"), opts)
+      lib_path = File.join(target, "lib")
+      template("project/lib/app.rb.tt", File.join(lib_path, "app.rb"), opts)
+      template("project/lib/views/index.haml.tt", File.join(lib_path, "views", "index.haml"), opts)
+      template("project/lib/public/css/main.css.tt", File.join(lib_path, "public", "css", "main.css"))
+      template("project/lib/public/js/application.js.tt", File.join(lib_path, "public", "js", "application.js"))
+      template("project/lib/project/backend.rb.tt", File.join(lib_path, project_name, "backend.rb"), opts)
+
+      execute_and_edit_bundle_gem(project_name, options)
+    end
+
+    desc "version", "Prints the SinatraWebsocketTemplate's version"
+    def version
+      puts "SinatraWebsocketTemplate version #{SinatraWebsocketTemplate::VERSION}"
+    end
+    map %w(-v --version) => :version
+
+    no_commands do
+      def execute_and_edit_bundle_gem(project_name, options)
+        dir = options[:dir]
+        opts = %i(test bin).map do |k|
+          "--#{k}=#{options[k]}" if options[k]
+        end.join(" ")
+
+        FileUtils.mkdir_p(dir)
+        Dir.chdir(dir) { system("bundle gem #{project_name} #{opts}") }
+        gemspec = File.join(dir, project_name, "#{project_name}.gemspec")
+        edit_gemspec(gemspec)
+      rescue => e
+        abort "Execute 'bundle gem' failed: #{e.message}"
+      end
+
+      def edit_gemspec(file)
+        content = File.read(file)
+        content.sub!(/^end\n$/, '')
+        content.concat(<<-EOS)
+  spec.add_development_dependency "foreman"
+
+  spec.add_dependency "faye-websocket"
+  spec.add_dependency "puma"
+  spec.add_dependency "sinatra"
+  spec.add_dependency "haml"
+
+  spec.required_ruby_version = ">= 2.0.0"
+end
+        EOS
+        File.write(file, content)
+      end
+    end
+  end
+end

data/lib/sinatra_websocket_template/templates/project/Procfile.tt

@@ -0,0 +1 @@
+web: bundle exec puma -p $PORT

data/lib/sinatra_websocket_template/templates/project/config.ru.tt

@@ -0,0 +1,6 @@
+require 'app'
+require '<%=config[:namespaced_path]%>/backend'
+
+use <%=config[:module_name]%>::Backend
+
+run <%=config[:module_name]%>::App

data/lib/sinatra_websocket_template/templates/project/lib/app.rb.tt

@@ -0,0 +1,10 @@
+require 'sinatra/base'
+require 'haml'
+
+module <%=config[:module_name]%>
+  class App < Sinatra::Base
+    get "/" do
+      haml :index
+    end
+  end
+end

data/lib/sinatra_websocket_template/templates/project/lib/project/backend.rb.tt

@@ -0,0 +1,44 @@
+require 'faye/websocket'
+require 'json'
+
+module <%=config[:module_name]%>
+  class Backend
+    KEEPALIVE_TIME = 15
+    def initialize(app)
+      @app = app
+      @clients = []
+    end
+
+    def call(env)
+      if Faye::WebSocket.websocket?(env)
+        ws = Faye::WebSocket.new(env, nil, ping: KEEPALIVE_TIME)
+        
+        ws.on :open do |event|
+          p [:open, ws.object_id]
+          @clients << ws
+          ws.send({ you: ws.object_id }.to_json)
+          @clients.each do |client|
+            client.send({ count: @clients.size }.to_json)
+          end
+        end
+
+        ws.on :message do |event|
+          p [:message, event.data]
+          @clients.each { |client| client.send event.data }
+        end
+
+        ws.on :close do |event|
+          p [:close, ws.object_id, event.code]
+          @clients.delete(ws)
+          @clients.each do |client|
+            client.send({ count: @clients.size }.to_json)
+          end
+          ws = nil
+        end
+        ws.rack_response
+      else
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/sinatra_websocket_template/templates/project/lib/public/css/main.css.tt

@@ -0,0 +1,19 @@
+#count-button {
+  width: 100px;
+}
+
+.message {
+  color: orange;
+}
+
+.user-id {
+  color: green;
+}
+
+#user-counter {
+  border: none;
+  color: #FC0;
+  font-size: 16pt;
+  width: 50px;
+  text-align: right;
+}

data/lib/sinatra_websocket_template/templates/project/lib/public/js/application.js.tt

@@ -0,0 +1,28 @@
+function counterRefresh (count) {
+  $("#user-counter").val(count);
+}
+
+function appendMessage (userid, message) {
+  $("#message-box").append("<div class='message'><span class='user-id'>" + userid + ":</span> " + message + "</div>");
+}
+
+$("#count-button").click(function(event) {
+  var text = this.innerHTML;
+  var data = JSON.stringify({ userid: myid, text: text });
+  ws.send(data);
+});
+
+var myid;
+
+var ws = new WebSocket(location.origin.replace(/^http/, 'ws'));
+
+ws.onmessage = function(msg) {
+  var data = JSON.parse(msg.data);
+  if (data.you) { myid = data.you; }
+  else if (data.text) {
+    var id;
+    myid==data.userid ? id = 'my-message' : id = data.userid;
+    appendMessage(id, data.text);
+  }
+  else if (data.count) { counterRefresh(data.count); }
+}

data/lib/sinatra_websocket_template/templates/project/lib/views/index.haml.tt

@@ -0,0 +1,20 @@
+!!!
+%html
+  %head
+    %meta{charset:'utf-8'}
+    %meta{name:'viewport', content:'width=device-width, initial-scale=1.0'}
+    %title <%=config[:module_name]%>
+    %link{rel:'stylesheet', href:'css/main.css'}
+  %body
+    %header
+      %input#user-counter{type:"text", disable:"disable", value:0}
+      %label{for:"user-counter"} Users
+
+    .container
+      %button#count-button Hello!
+      #message-box
+
+    %footer
+
+%script{src:'//ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js', type:'text/javascript'}
+%script{src:'js/application.js', type:'text/javascript'}

data/lib/sinatra_websocket_template/version.rb

@@ -0,0 +1,3 @@
+module SinatraWebsocketTemplate
+  VERSION = "0.0.1"
+end

data/sinatra_websocket_template.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sinatra_websocket_template/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sinatra_websocket_template"
+  spec.version       = SinatraWebsocketTemplate::VERSION
+  spec.authors       = ["kyoendo"]
+  spec.email         = ["postagie@gmail.com"]
+  spec.description   = %q{Generate a skeleton of WebSocket application with Ruby(Sinatra)}
+  spec.summary       = %q{Generate a skeleton of WebSocket application with Ruby(Sinatra)}
+  spec.homepage      = "https://github.com/melborne/sinatra-websocket-template"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.required_ruby_version = ">= 2.0.0"
+
+  spec.add_dependency "thor"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/cli_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+require 'pathname'
+require 'stringio'
+
+describe SinatraWebsocketTemplate::CLI do
+  before(:each) do
+    @tmp_path = File.join(Dir.pwd, "tmp")
+    @project_name = "project_a"
+    @project = Pathname.new(File.join @tmp_path, @project_name)
+    $stdout = StringIO.new
+  end
+
+  after(:each) do
+    FileUtils.rm_r(@tmp_path)
+    $stdout = STDOUT
+  end
+
+  describe '#new' do
+    context 'without bundler gem options' do
+      it 'creates a skelton project' do
+        described_class.start(['new', @project_name, '--dir', @tmp_path])
+        expect(@project.join("Procfile")).to exist
+
+        configru = @project.join("config.ru")
+        expect(configru).to exist
+        expect(configru.read).to match /project_a\/backend.*ProjectA::App/m
+
+        apprb = @project.join("lib", "app.rb")
+        expect(apprb).to exist
+        expect(apprb.read).to match /module ProjectA/
+
+        indexhaml = @project.join("lib", "views", "index.haml")
+        expect(indexhaml).to exist
+        expect(indexhaml.read).to match /%title ProjectA/
+
+        expect(@project.join("lib", "public", "css", "main.css")).to exist
+        expect(@project.join("lib", "public", "js", "application.js")).to exist
+        expect(@project.join("lib", "project_a", "backend.rb")).to exist
+
+        # created by 'bundle gem command'
+        expect(@project.join("Gemfile")).to exist
+        expect(@project.join("lib", "project_a.rb")).to exist
+
+        gemspec = @project.join("project_a.gemspec")
+        expect(gemspec).to exist
+        expect(gemspec.read).to match /spec\.add_dependency.*faye-websocket.*puma.*sinatra.*haml/m
+      end
+    end
+
+    context 'with bundler gem options' do
+      it 'create a skelton with a binary and spec files' do
+        described_class.start(['new', @project_name, '--dir', @tmp_path, '-bt'])
+        expect(@project.join("bin", "project_a")).to exist
+        expect(@project.join("spec", "project_a_spec.rb")).to exist
+      end
+
+      it 'create a skelton with minitest' do
+        described_class.start(['new', @project_name, '--dir', @tmp_path, '--test=minitest'])
+        expect(@project.join("test", "test_project_a.rb")).to exist
+      end
+    end
+
+  end
+end

data/spec/sinatra_websocket_template_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe SinatraWebsocketTemplate do
+  it 'should have a version number' do
+    SinatraWebsocketTemplate::VERSION.should_not be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'sinatra_websocket_template'

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: sinatra_websocket_template
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- kyoendo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generate a skeleton of WebSocket application with Ruby(Sinatra)
+email:
+- postagie@gmail.com
+executables:
+- sinatra_websocket_template
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/sinatra_websocket_template
+- lib/sinatra_websocket_template.rb
+- lib/sinatra_websocket_template/cli.rb
+- lib/sinatra_websocket_template/templates/project/Procfile.tt
+- lib/sinatra_websocket_template/templates/project/config.ru.tt
+- lib/sinatra_websocket_template/templates/project/lib/app.rb.tt
+- lib/sinatra_websocket_template/templates/project/lib/project/backend.rb.tt
+- lib/sinatra_websocket_template/templates/project/lib/public/css/main.css.tt
+- lib/sinatra_websocket_template/templates/project/lib/public/js/application.js.tt
+- lib/sinatra_websocket_template/templates/project/lib/views/index.haml.tt
+- lib/sinatra_websocket_template/version.rb
+- sinatra_websocket_template.gemspec
+- spec/cli_spec.rb
+- spec/sinatra_websocket_template_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/melborne/sinatra-websocket-template
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Generate a skeleton of WebSocket application with Ruby(Sinatra)
+test_files:
+- spec/cli_spec.rb
+- spec/sinatra_websocket_template_spec.rb
+- spec/spec_helper.rb
+has_rdoc: