tamashii-manager 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a4a056c16a53a471ec345555af9fab757c2bc07
-  data.tar.gz: 7a8d8f76b80661f220abf2bafa9d08552189b9ba
+  metadata.gz: e261e9f42acf76a96f678f43a6c95d6ca206680c
+  data.tar.gz: e1a3c8fa43ecbd156abff71ba9d1a73a39cf79a1
 SHA512:
-  metadata.gz: 71e0d71ba4c8dddfe8644b1d6b76c5c5f4a291a28a31d3c696f45012591f963192c6c99ac8acdaee957f6d70ccf76397814f49928d709cb5f060b974e6351e03
-  data.tar.gz: d500c1cb4e003e8e2076d8043be9689c2ec677826d0dde28fc1bf22e8ef18059e2c55e1bdd456d12dd0009c9740f061fa04860679868a9676cb3936b3024c7e1
+  metadata.gz: 407385d718724a79a0aad75aeeba1ebe8cdf6ed363fff05683a57d16244d3f9caa04698961caf3e1671e27f95f096f32542873861aa24167ca3747249d23c541
+  data.tar.gz: e1494e24c0ffa4a5bd6789ab9ff5d2dd9b2cf6fbabc955f6615404b6fea13dad0d7e2e1849e41990b909d8eae51257e1002dafd595f25ad366d95d77975e35f6

data/.travis.yml

@@ -1,5 +1,11 @@
 sudo: false
+cache: bundler
 language: ruby
 rvm:
-  - 2.3.1
-before_install: gem install bundler -v 1.13.6
+  - 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,156 @@
-# Tamashii::Manager
+Tamashii Manager [![Gem Version](https://badge.fury.io/rb/tamashii-manager.svg)](https://badge.fury.io/rb/tamashii-manager) [![Build Status](https://travis-ci.org/tamashii-io/tamashii-manager.svg?branch=master)](https://travis-ci.org/tamashii-io/tamashii-manager) [![Test Coverage](https://codeclimate.com/github/tamashii-io/tamashii-manager/badges/coverage.svg)](https://codeclimate.com/github/tamashii-io/tamashii-manager/coverage) [![Code Climate](https://codeclimate.com/github/tamashii-io/tamashii-manager/badges/gpa.svg)](https://codeclimate.com/github/tamashii-io/tamashii-manager)
+===
 
-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/manager`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Tamashii Manager is a package for managing IoT devices that can handle communication between IoT devices in a way similar to Rack.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add the following code to your `Gemfile`:
 
 ```ruby
 gem 'tamashii-manager'
 ```
 
 And then execute:
+```ruby
+$ bundle install
+```
 
-    $ bundle
+Or install it yourself with:
+```ruby
+$ gem install tamashii-manager
+```
 
-Or install it yourself as:
+## Usage
 
-    $ gem install tamashii-manager
+Tamashii Manager can be started directly through `tamashii-manager` .
 
-## Usage
+    $ tamashii-manager
+
+Because the connection of IoT devices may need verification, we implement a simple Token authentication function, which can achieve through the configuration file.
+
+```ruby
+# config.rb
+
+Tamashii::Manager.config do |config|
+  config.env = :test
+  config.auth_type = :token
+  config.token = 'abc123'
+  config.port = ENV['PORT'] || 3000
+end
+```
+
+Then start with `tamashii-manager` :
+
+    $ tamashii-manager -C config.rb
+
+### Rack
+
+To integrate with the project that use Rack through `config.ru` .
+
+```ruby
+# config.ru
+
+require 'tamashii/manager'
+require './config.rb'
+
+run Tamashii::Manager.server
+```
+
+Then start Tamashii Manager through the web server.
+
+    $ puma
+
+Use `Rack :: URLMap` to consolidate your project when collocating with Sinatra and other frameworks.
+
+```ruby
+# config.ru
+
+Rack::URLMap.new(
+   '/' => App,
+  '/tamashii' => Tamashii::Manager.server
+)
+```
+
+### Rails
+
+To integrate with the Rails project, you can use the `mount` function to plug Tamashii Manager onto Rails.
+
+```ruby
+# config/routes.rb
+
+Rails.application.routes.draw do
+    mount Tamashii::Manager.server => '/tamashii'
+end
+```
+
+In Rails, we will want to intercept information in the Tamashii Manager, processed in advance and then send to each IoT device, so it will use Tamashii Resolver function.
+
+```ruby
+# config/initializer/tamashii.rb
+
+Tamashii::Manager.config do |config|
+  config.env = Rails.env
+  config.log_file = Rails.root.join('log', 'tamashii.log')
+  config.auth_type = :token
+  config.token = 'example'
+end
+
+Tamashii::Resolver.config do
+  hook RailsHookForTamashii
+end
+```
+
+Use the `call` method in Resolver function to handle incoming packets.
+
+```ruby
+# app/tamashii/rails_hook_for_tamashii.rb
+
+class RailsHookForTamashii < Tamashii::Hook
+  def initialize(*args)
+    super
+    @client = @env[:client]
+  end
+
+  def call(packet)
+      # Handle packets here
+      return false if packet.nil? # The processing failed and let the other Handler go on
+      true # Finished processing
+  end
+end
+```
+
+In this way, you can use the Hook to handle the packets sent to Tamashii Manager.
+
+### send_to method
 
-TODO: Write usage instructions here
+Tamashii Manager will require a `serial number` as a machine ID when authenticating, and so we can use the` send_to` function to send packets to a specify machine.
+
+```ruby
+Tamashii::Manager::Client.send_to('example', '...')
+```
 
 ## 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-manager.git
+
+Initialize the development environment
+
+    $ ./bin/setup
+
+Run the spec
+
+    $ rspec
+
+Installation the version of development on localhost
 
-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).
+    $ bundle exec rake install
 
-## Contributing
+## Contribution
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/lctseng/tamashii-manager.
+Please report to us on [Github](https://github.com/tamashii-io/tamashii-manager) if there is any bug or suggested modified.
 
-Contributed by [5xruby Inc.](https://5xruby.tw/)
+The project was developed by [5xruby Inc.](https://5xruby.tw/)
 

data/lib/tamashii/manager/server.rb

@@ -24,6 +24,10 @@ module Tamashii
           @event_loop.post { Client.accepted_clients.values.map(&:beat) }
         end
       end
+
+      def inspect
+        "Tamashii::Manager::Server v#{VERSION}"
+      end
     end
   end
 end

data/lib/tamashii/manager/version.rb

@@ -1,5 +1,5 @@
 module Tamashii
   module Manager
-    VERSION = "0.2.4"
+    VERSION = "0.2.5"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tamashii-manager
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - 蒼時弦也
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-01 00:00:00.000000000 Z
+date: 2017-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puma