tamashii 0.3.6 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2975301e1fa682a9eec4fa18f6c4d77499ef89a7
-  data.tar.gz: e794adc70265dedfef2d34a2ae4e703a0b86ed11
+  metadata.gz: 8ed79e176bb8b330675dcc17af8432771df1701b
+  data.tar.gz: 111bcf61a0685a6dba7c31146bf0ceb6a5582d6b
 SHA512:
-  metadata.gz: e3b4b1f51372ac5c4b91aa150c4cda7bcbddb5a596f6f2e232fae978e96731cac7273d8d7e00dc4bfced9f258af41972609f255ee6ba70e46641c4bbb18d19e1
-  data.tar.gz: 617a103df0234f6b9d8321b517e06efc4f7d10f4604c5a2c56a0d64c561054d7f780c4a35e2d7cf35b31026bea2f9c5fc0b95420a089526727246ab7409d55f6
+  metadata.gz: 54c52fe0e4afaea67fc83c1cf6a9105457f6126f3a3ceaeabf730d1e50fb4a91a399afbeb8969658e994a067239bdc562b4539bdb4e7a7b43c45c1c8cc2cb9f9
+  data.tar.gz: 0b76ec9201d43b852afeca20faf1ae02651f774d2c481de52849cc95118c8d311e4a5908a9433ccb36005684886148832b8513c078b6c12851e96a4b87d0912f

data/.travis.yml

@@ -3,3 +3,9 @@ cache: bundler
 language: ruby
 rvm:
   - 2.4.1
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT; fi

data/README.md

@@ -1,38 +1,110 @@
-Tamashii [![Gem Version](https://badge.fury.io/rb/tamashii.svg)](https://badge.fury.io/rb/tamashii) [![Build Status](https://travis-ci.org/5xRuby/tamashii.svg?branch=master)](https://travis-ci.org/5xRuby/tamashii) [![Test Coverage](https://codeclimate.com/github/5xRuby/tamashii/badges/coverage.svg)](https://codeclimate.com/github/5xRuby/tamashii/coverage) [![Code Climate](https://codeclimate.com/github/5xRuby/tamashii/badges/gpa.svg)](https://codeclimate.com/github/5xRuby/tamashii)
+Tamashii [![Gem Version](https://badge.fury.io/rb/tamashii.svg)](https://badge.fury.io/rb/tamashii) [![Build Status](https://travis-ci.org/tamashii-io/tamashii.svg?branch=master)](https://travis-ci.org/tamashii-io/tamashii) [![Test Coverage](https://codeclimate.com/github/tamashii-io/tamashii/badges/coverage.svg)](https://codeclimate.com/github/tamashii-io/tamashii/coverage) [![Code Climate](https://codeclimate.com/github/tamashii-io/tamashii/badges/gpa.svg)](https://codeclimate.com/github/tamashii-io/tamashii)
 ===
 
+Tamashii is a package designed for IoT. You can write the WebSocket server and client easily by using this gem.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tamashii`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add the following code to your `Gemfile`
 
 ```ruby
 gem 'tamashii'
 ```
 
 And then execute:
+```ruby
+$ bundle install
+```
+
+Or install it yourself with:
+```ruby
+$ gem install tamashii
+```
 
-    $ bundle
+## Usage
 
-Or install it yourself as:
+There are two section in Tamashii, Server and Client, is responsible for the WebSocket server and client, respectively.
 
-    $ gem install tamashii
+### Server
 
-## Usage
+Server section is a server designed based on Rack, it can not only be easily compatible with the web server, such as Puma, Passenger, but also be used as a module in the Rails and other projects.
+
+To start the server, generate `config.ru` and add the following code to it.
+
+```ruby
+require 'tamashii/server'
+
+run Tamashii::Server::Base.new
+```
+
+Then, you can start the server with:
+
+    $ rackup
+If you want to start the server with other web server, such as Puma:
+
+    $ puma
+
+> You can refer to the project in [tamashii-manager](https://github.com/5xRuby/tamashii-manager) in the IoT server application.
+
+#### Connection
+
+In Tamashii, we only need to focus on how to connect with WebSocket users to exchange information, on the process of multi-process web server problems have been resolved in Tamashii.
+
+We can create a `Client` object to handle the behavior of each user.
+
+```ruby
+Tamashii::Server.config do |config|
+  config.connection_class = Client
+end
+```
+
+In `Client` , there are four events that need to be handled.
+
+* `on_open` : when the user is connected to the server
+* `on_message` : when the server receives the message from user
+* `on_error` : when the server gets an error
+* `on_close` : when the connection is shut down
+
+In most cases, we only need to deal with parts of `on_message` , the other events can be handled as needed.
+
+```ruby
+class Client
+  def on_message(data)
+    # Processing for the received Data (Binary)
+  end
+end
+```
+
+By default Tamashii will broadcast the received message to other clients automatically.
+
+
+### Client
+
+The client is in another repository: [tamashii-client](https://github.com/tamashii-io/tamashii-client)
 
-TODO: Write usage instructions here
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+To get the source code
+
+    $ git clone git@github.com:tamashii-io/tamashii.git
+
+Initialize the development environment
+
+    $ ./bin/setup
+
+Run the spec
+
+    $ rspec
+
+Installation the version of development on localhost
+
+    $ bundle exec rake install
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+## Contribution
 
-## Contributing
+Please report to us on [GitHub](https://github.com/tamashii-io/tamashii) if there is any bug or suggested modified.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tamashii.
+The project was developed by [5xruby Inc.](https://5xruby.tw/)
 

data/lib/tamashii/server.rb

@@ -6,10 +6,11 @@ require 'logger/colors'
 require 'websocket/driver'
 require 'rack'
 require 'nio'
-require 'thread'
 require 'concurrent'
 require 'redis'
 
+require 'tamashii/hookable'
+
 module Tamashii
   # :nodoc:
   module Server
@@ -33,3 +34,7 @@ module Tamashii
     end
   end
 end
+
+Tamashii::Hook.after(:config) do |config|
+  config.register(:server, Tamashii::Server.config)
+end

data/lib/tamashii/server/config.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'tamashii/configurable'
+require 'tamashii/config'
 
 module Tamashii
   module Server
@@ -8,9 +8,9 @@ module Tamashii
     class Config
       include Tamashii::Configurable
 
-      register :connection_class, Connection::Base
-      register :pubsub_class, Subscription::Redis
-      register :log_path, STDOUT
+      config :connection_class, default: Connection::Base
+      config :pubsub_class, default: Subscription::Redis
+      config :log_path, default: STDOUT
     end
   end
 end

data/lib/tamashii/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tamashii
-  VERSION = "0.3.6"
+  VERSION = "0.4.0"
 end

data/tamashii.gemspec

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
@@ -31,19 +31,20 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency "concurrent-ruby"
+  spec.add_runtime_dependency "logger-colors"
+  spec.add_runtime_dependency "nio4r"
   spec.add_runtime_dependency "rack"
+  spec.add_runtime_dependency "redis"
   spec.add_runtime_dependency "tamashii-common"
+  spec.add_runtime_dependency "tamashii-config"
+  spec.add_runtime_dependency "tamashii-hookable"
   spec.add_runtime_dependency "websocket-driver"
-  spec.add_runtime_dependency "nio4r"
-  spec.add_runtime_dependency "redis"
-  spec.add_runtime_dependency "logger-colors"
 
   spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "rack-test"
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency "rack-test"
   spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "guard"
-  spec.add_development_dependency "guard-rspec"
-  spec.add_development_dependency "codeclimate-test-reporter"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tamashii
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.4.0
 platform: ruby
 authors:
 - 蒼時弦也
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-06 00:00:00.000000000 Z
+date: 2017-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -27,7 +27,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: logger-colors
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -41,7 +41,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: tamashii-common
+  name: nio4r
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -55,7 +55,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: websocket-driver
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -69,7 +69,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: nio4r
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -83,7 +83,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: tamashii-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -97,7 +97,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: logger-colors
+  name: tamashii-config
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -111,49 +111,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: tamashii-hookable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: websocket-driver
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -167,7 +167,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -181,7 +181,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -195,21 +195,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -244,7 +258,6 @@ files:
 - bin/console
 - bin/setup
 - lib/tamashii.rb
-- lib/tamashii/configurable.rb
 - lib/tamashii/server.rb
 - lib/tamashii/server/base.rb
 - lib/tamashii/server/client.rb

data/lib/tamashii/configurable.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-module Tamashii
-  # :nodoc:
-  module Configurable
-    # :nodoc:
-    module ClassMethods
-      def register(key, default, &_block)
-        @defaults ||= {}
-        return @defaults[key.to_sym] = yield if block_given?
-        @defaults[key.to_sym] = default
-      end
-
-      def exist?(key)
-        @defaults.key?(key.to_sym) || @defaults.key?(key.to_s[0..-2].to_sym)
-      end
-
-      def default_value(key)
-        @defaults[key.to_sym]
-      end
-    end
-
-    def self.included(klass)
-      klass.extend ClassMethods
-    end
-
-    def config(key, value = nil, &_block)
-      @configs ||= {}
-      return unless self.class.exist?(key)
-      return @configs[key.to_sym] || self.class.default_value(key) if value.nil?
-      return @configs[key.to_sym] = yield if block_given?
-      @configs[key.to_sym] = value
-    end
-
-    def respond_to_missing?(name, _all = false)
-      self.class.exist?(name)
-    end
-
-    def method_missing(name, *args, &block)
-      return super unless self.class.exist?(name)
-      return config(name.to_sym, nil, &block) unless name.to_s.end_with?('=')
-      config(name.to_s[0..-2].to_sym, args.first)
-    end
-  end
-end