webmate 0.1.0 → 0.1.1

data/README.md

@@ -1,42 +1,147 @@
 # Webmate
 
-TODO: Write a gem description
+Real-time web applications framework in Ruby, based on WebSockets and EventMachine.
 
-## Prerequisites
-  git
-  mongo
-  redis
+## Quick start
 
-  sinatra 4.2
-  to make this, use sinatra-contrib at least 1.4.0 version
-    Specify in your Gemfile 
-      gem 'sinatra-contrib', git: 'git://github.com/sinatra/sinatra-contrib.git'
+#### 1. Install Webmate gem
 
-## Installation
+    $ gem install webmate
+
+#### 2. Run Webmate server
+
+    $ webmate server
+
+#### 3. Run Webmate console
+
+    $ webmate console
+
+#### 4. Show available routes
+
+    $ rake routes
+
+## Tutorial
+
+[Webmate Application Skeleton](https://github.com/webmaterb/webmate-app-skeleton)
+
+### Skeleton
 
-Add this line to your application's Gemfile:
+Gemfile
 
     gem 'webmate'
+    gem 'slim'
+    gem 'sass', group: assets
+    gem 'rake'
+    gem 'webmate-sprockets'
 
-And then execute:
+config.ru
 
-    $ bundle
+    require './config/environment'
+    if configatron.assets.compile
+      map '/assets' do
+        run Sinatra::Sprockets.environment
+      end
+    end
+    run ExampleApp
 
-Or install it yourself as:
+config/config.rb
 
-    $ gem install webmate
+    Webmate::Application.configure do |config|
+      # add directory to application load paths
+      #config.app.load_paths << ["app/uploaders"]
+      config.app.cache_classes = true
+      config.assets.compile = false
+
+      config.websockets.namespace = 'api'
+      config.websockets.enabled = true
+      config.websockets.port = 9020
+    end
+
+    Webmate::Application.configure(:development) do |config|
+      config.app.cache_classes = false
+      config.assets.compile = true
+      config.websockets.port = 3503
+    end
+
+config/application.rb
+
+    require 'digest/sha1'
+    require 'base64'
+
+    class ExampleApp < Webmate::Application
+      # do other things)
+    end
+
+config/environment.rb
+
+    WEBMATE_ROOT = File.expand_path('.')
+    require 'webmate'
+
+    Dir[File.join(WEBMATE_ROOT, 'app', 'routes', '**', '*.rb')].each do |file|
+      require file
+    end
 
-## Usage
+### Hello world
 
-TODO: Write usage instructions here
+#### 1. Adding routes
 
-start server as 
-  webmate server [-p port]
+    # app/routes/homepage_routes.rb
+    ExampleApp.define_routes do
+      get '/', to: 'pages#index', transport: [:http]
+    end
 
-running interactive console
-  webmate console [environment]
-  or 
-  webmate console [-e environment]
+#### 2. Adding  responder for this route
+    # app/responders/base_reponder.rb
+    class BaseResponder < Webmate::Responders::Base
+      # Available options
+      # before_filter :do_something
+
+      rescue_from Webmate::Responders::ActionNotFound do
+        render_not_found
+      end
+    end
+
+    # app/responders/pages_reponder.rb
+    class PagesResponder < BaseResponder
+      include Webmate::Responders::Templates
+
+      def index
+        slim :index, layout: 'application'
+      end
+    end
+
+    # app/views/layouts/application.html.slim
+
+    div
+      == yield
+
+    # app/views/pages/index.html.slim
+
+    Hello World!
+
+#### 3. MongoDB connection
+
+    # config/mongoid.yml
+    development:
+      sessions:
+        default:
+          database: deex_example
+          hosts:
+            - localhost:27017
+
+    # config/initializers/mongoid.rb
+    Mongoid.load!(File.join(WEBMATE_ROOT, 'config', 'mongoid.yml'))
+
+#### 4. Models
+
+    # app/models/project.rb
+    class Project
+      include Mongoid::Document
+
+      field :name
+      field :description
+      field :status
+    end
 
 ## Contributing
 
@@ -45,3 +150,13 @@ running interactive console
 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
+
+## License
+
+Licenced under [MIT](http://www.opensource.org/licenses/mit-license.php).
+
+## Thanks for using Webmate!
+
+Hope, you'll enjoy Webmate!
+
+Cheers, [Droid Labs](http://droidlabs.pro).

data/bin/webmate

@@ -42,7 +42,7 @@ opt_parser.parse!
 
 command = ARGV.shift
 case command
-when 'server'
+when 'server', 's'
   #TODO refactor to
   # require 'lib/commands/server'
   # with options
@@ -53,7 +53,7 @@ when 'server'
   cmd += ["-p", options.port.to_s]
 
   Thin::Runner.new(cmd).run!
-when 'console'
+when 'console', 'c'
   require 'irb'
   ENV["RACK_ENV"] ||= ARGV.first || options.environment || 'development'
   puts "Running Webmate console with env: #{ENV["RACK_ENV"]}"
@@ -61,7 +61,7 @@ when 'console'
   ARGV.clear
   IRB.start
 
-when 'generate'
+when 'generate', 'g'
   puts 'not yet implemented'
   puts opt_parser
 

data/lib/webmate/version.rb

@@ -1,3 +1,3 @@
 module Webmate
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webmate
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-07 00:00:00.000000000 Z
+date: 2013-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thin
@@ -196,7 +196,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- GUIDE.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -271,7 +270,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3263911598223733394
+      hash: -655409542714730364
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -280,7 +279,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3263911598223733394
+      hash: -655409542714730364
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25

data/GUIDE.md

@@ -1,115 +0,0 @@
-#webmate app skeleton
-see working example on https://github.com/evgeniypetrov/webmate-app-skeleton
-
-## Quick start
-
-to start application, run
-  webmate start  
-application will be available on localhost:3000 url
-
-to run irb/console
-  webmate console
-
-type webmate without params to know all options
-
-show all available routes [ without assets ]
-rake routes k
-
-## Tutorial
-### Skeleton
-require files
-
-to create file, add following gem to Gemfile
-
-Gemfile
-  gem 'webmate'
-  gem 'slim'
-  gem 'sass', group: assets
-  gem 'alphasights-sinatra-sprockets', require: 'sinatra-sprockets', group: assets
-
-base required files:
-
-config.ru
-  require './config/environment'
-  if configatron.assets.compile
-    map '/assets' do
-      run Sinatra::Sprockets.environment
-    end
-  end
-  run ExampleApp
-
-config/config.rb
-  Webmate::Application.configure do |config|
-    # add directory to application load paths
-    #config.app.load_paths << ["app/uploaders"]
-    config.app.cache_classes = true
-    config.assets.compile = false
-
-    config.websockets.namespace = 'api'
-    config.websockets.enabled = true
-    config.websockets.port = 9020
-  end
-
-Webmate::Application.configure(:development) do |config|
-  config.app.cache_classes = false
-  config.assets.compile = true
-  config.websockets.port = 3503
-end
-
-config/application.rb
-  require 'digest/sha1'
-  require 'base64'
-
-  class ExampleApp < Webmate::Application
-    # do other things)
-  end
-
-config/environment.rb
-  WEBMATE_ROOT = File.expand_path('.')
-  require 'webmate'
-
-  Dir[File.join(WEBMATE_ROOT, 'app', 'routes', '**', '*.rb')].each do |file|
-    require file
-  end
-
-### Hello world
-  adding route
-    app/routes/facade_routes.rb
-      ExampleApp.define_routes do
-        get '/', to: 'pages#index', transport: [:http]
-      end
-
-  adding  responder to this route
-  create files in app/responders
-    base_responder
-      class BaseResponder < Webmate::Responders::Base
-        # Available options
-        # before_filter :do_something
-
-        rescue_from Webmate::Responders::ActionNotFound do
-          render_not_found
-        end
-      end
-
-    pages_responder
-      class PagesResponder < BaseResponder
-        include Webmate::Responders::Templates
-
-        def index
-          slim :index, layout: 'application'
-        end
-      end
-
-    also, required files
-      app/views/layouts/application.html.slim
-      app/views/pages/index.html.slim
-
-### Assets
-  assets will be searched in app/assets folder, so place them to
-  app/assets/javascripts
-  app/assets/stylesheets
-
-### Utilities - rake task, scripts
-  Rakefile
-    require File.expand_path('../config/environment', __FILE__)
-    Webmate::Application.load_tasks