Giter VIP home page Giter VIP logo

skinny's Introduction

Skinny

Simple, upgradable Thin WebSockets.

I wanted to be able to upgrade a plain old Rack request to a proper WebSocket. The easiest way seemed to use the oh-so-nice-and-clean Thin with a new pair of skinnies.

More details coming soon.

Examples

More comprehensive examples will be coming soon. Here's a really simple, not-yet-optimised example I'm using at the moment:

class Sinatra::Request
  include Skinny::Helpers
end

module MailCatcher
  class Web < Sinatra::Base
    get '/messages' do
      if request.websocket?
        request.websocket! :protocol => "MailCatcher 0.2 Message Push",
          :on_start => proc do |websocket|
            subscription = MailCatcher::Events::MessageAdded.subscribe { |message| websocket.send_message message.to_json }
            websocket.on_close do |websocket|
              MailCatcher::Events::MessageAdded.unsubscribe subscription
            end
          end
      else
        MailCatcher::Mail.messages.to_json
      end
    end
  end
end

This syntax will probably get cleaned up. I would like to build a nice Sinatra handler with DSL with unbound handlers so Sinatra requests can be recycled.

TODO

  • Nicer
  • Documentation
  • Tests
  • Make more generic for alternate server implementations?

Thanks

The latest WebSocket draft support is adapted from https://github.com/gimite/web-socket-ruby -- thank you!

Copyright

Copyright (c) 2010 Samuel Cochran. See LICENSE for details.

Wear Them

Do you?

skinny's People

Contributors

olleolleolle avatar sj26 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

skinny's Issues

Thin

Restricting thin to be less than 1.7 is a real pain. The mailcatcher gem is, by a huge margin, the main client of this gem and it has no such restriction on thin...but you're effectively imposing one for it.

Is there some known issue with versions of thin >= 1.7?

License missing from gemspec

RubyGems.org doesn't report a license for your gem. This is because it is not specified in the gemspec of your last release.

via e.g.

  spec.license = 'MIT'
  # or
  spec.licenses = ['MIT', 'GPL-2']

Including a license in your gemspec is an easy way for rubygems.org and other tools to check how your gem is licensed. As you can imagine, scanning your repository for a LICENSE file or parsing the README, and then attempting to identify the license or licenses is much more difficult and more error prone. So, even for projects that already specify a license, including a license in your gemspec is a good practice. See, for example, how rubygems.org uses the gemspec to display the rails gem license.

There is even a License Finder gem to help companies/individuals ensure all gems they use meet their licensing needs. This tool depends on license information being available in the gemspec. This is an important enough issue that even Bundler now generates gems with a default 'MIT' license.

I hope you'll consider specifying a license in your gemspec. If not, please just close the issue with a nice message. In either case, I'll follow up. Thanks for your time!

Appendix:

If you need help choosing a license (sorry, I haven't checked your readme or looked for a license file), GitHub has created a license picker tool. Code without a license specified defaults to 'All rights reserved'-- denying others all rights to use of the code.
Here's a list of the license names I've found and their frequencies

p.s. In case you're wondering how I found you and why I made this issue, it's because I'm collecting stats on gems (I was originally looking for download data) and decided to collect license metadata,too, and make issues for gemspecs not specifying a license as a public service :). See the previous link or my blog post about this project for more information.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.