tamashii-common 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6afdc81465395d22163335e5e1f7e746bdcb71be
-  data.tar.gz: 5f64a2e9084beddf0c3ad572aed70fc0e3545af1
+  metadata.gz: fcc88eaa8ec67a5c9098396905962e21ceca0ba6
+  data.tar.gz: 25321f5d4b2c993f421caf122b4dcafe1e9a2122
 SHA512:
-  metadata.gz: 2208cb0c2df290e09ee816639eeed7b2f3c030a183d0af6ecaccad36959fef84a20d7b0edda75341a6139edc47a0fd427ca39e60ac564f8d89ffffc5f166719a
-  data.tar.gz: b0bcb56b8a65823620df49804cccb65652d6dad276b4c4d0a3db135ac5b40fc59101548c1964654affe01577dbbe952034e8a5786eaef131e28fff3d2c16929f
+  metadata.gz: 68ef0d4e242e1597d4cf9804fc1fd56507843720f8bd6dc12b4b1c37801b8b57a7850ec939eeccebe204edc65ee55fc37a92a6976983087cc4700ae18930235f
+  data.tar.gz: 9420294cb59cf5b8c8ae90641456d899bd6eef0ea29617c525b96c8d67cf682d2c185388abdc5983cbc42f08e33b1c2dfadea1062b5b143dda03e8f98badd192

data/README.md

@@ -1,38 +1,143 @@
-# Tamashii::Common
+Tamashii Common
+===
 
-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/common`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Tamashii Common is a collection of some commonly used features in Tamashii, including recorded, setting, packet encapsulation, etc.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add the following code to your `Gemfile`:
 
 ```ruby
 gem 'tamashii-common'
 ```
 
 And then execute:
+```ruby
+$ bundle install
+```
 
-    $ bundle
+Or install it yourself with:
+```ruby
+$ gem install tamashii-common
+```
 
-Or install it yourself as:
+## Usage
 
-    $ gem install tamashii-common
+### Tamashii::Resolver
 
-## Usage
+Used to handle with different types of packets in Tamashii.
+
+```ruby
+Tamashii::Resolver.handle Tamashii::AUTH_TOKEN, Tamashii::Manager::Authorization
+```
+
+#### Default processing
+
+In the absence of a specified processing mode, we can specify the way the default processing.
+
+```ruby
+Tamashii::Resolver.default_handler Tamashii::Manager::Handler::Broadcaster
+```
+
+#### Hook
+
+This is a mechanism similar to Rack Middleware, which can intercept or process packets before the Handler executes.
+
+```ruby
+Tamashii::Resolver.hook TamashiiRailsHook
+```
+
+When there are lots of items need to be setting, we can write the following way instead.
+
+```ruby
+Tamashii::Resolver.config do
+  handler Tamashii::Manager::Authorization
+  # ...
+
+  hook MyRailsHook
+  # ...
+end
+```
 
-TODO: Write usage instructions here
+### Tamashii::Packet
+
+IoT devices need some information about the data when transferring, so define a simple format to encapsulate the data in Tamashii.
+
+|Field  |Size     |Description
+|---    |---      |-
+|type   | 1byte   |control code(Octal)
+|tag    | 2bytes  |tag, default 0 is broadcast（will be removed）
+|size   | 2bytes  |data size
+|body   | ~       |data content
+
+We can use `Tamashii::Packet`  to encapsulate different types of information, e.g., String, JSON,and Binary.
+
+```ruby
+packet = Tamashii::Packet.new(Tamashii::Type::AUTH_TOKEN, 0, '1234')
+```
+
+When we transfer data, we will translate the data into a Binary format before the transmission. If you want to convert, then we can use `dump` and `load` these two methods.
+
+```ruby
+buffer = packet.dump
+recv_packet = Tamashii::Packet.load(buffer)
+```
+
+To get the original content of the data, you can use `type` and` body` to determine what information you want to access.
+
+```ruby
+if packet.type == Tamashii::Type::AUTH_TOKEN
+  puts packet.body # AUTH_TOKEN is a string
+end
+```
+
+### Tamashii::Type
+
+There are a wide variety of types data exchange in Tamashii. In order to access these packet easily, we define a series of settings to assist in accessing these types.
+
+```ruby
+# System Action
+Tamashii::Type::POWEROFF
+Tamashii::Type::REBOOT
+# ...
+```
+
+|Type id|Name|Description
+|------|---------|-
+|000   |POWEROFF|Shut down
+|001   |REBOOT|Restart
+|002   |RESTART|Restart service
+|003   |UPDATE|Update the software
+|010   |AUTH_TOKEN|Token certification
+|017   |AUTH_RESPONSE|Certification results
+|030   |RFID_NUMBER|Authentication card number
+|031   |RFID_DATA|Card information
+|036   |RFID_RESPONSE_JSON|Card reader results
+|037   |RFID_RESPONSE_STRING|Card reader results
+|040   |BUZZER_SOUND|Make buzzer sound
+|050   |LCD_MESSAGE|Display LCD text
+|051   |LCD_SET_IDLE_TEXT|Set the display text when standby
 
 ## 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-common.git
+
+Initialize the development environment
+
+    $ ./bin/setup
+
+Run the spec
+
+    $ rspec
 
-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).
+Installation the version of development on localhost
 
-## Contributing
+    $ bundle exec rake install
+## Contribution
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/lctseng/tamashii-common.
+Please report to us on [Github](https://github.com/tamashii-io/tamashii-common) 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/common.rb

@@ -3,10 +3,8 @@ require "tamashii/packet"
 require "tamashii/type"
 require "tamashii/agent_hint"
 require "tamashii/handler"
-require "tamashii/hook"
 require "tamashii/resolver"
 require "tamashii/logger"
-require "tamashii/config"
 require "tamashii/environment"
 
 module Tamashii

data/lib/tamashii/common/version.rb

@@ -1,5 +1,5 @@
 module Tamashii
   module Common
-    VERSION = "0.1.6"
+    VERSION = "0.2.0"
   end
 end

data/lib/tamashii/resolver.rb

@@ -7,7 +7,7 @@ module Tamashii
       def method_missing(name, *args, &block)
         self.instance.send(name, *args, &block)
       end
-      
+
       def instance
         @instance ||= self.new
       end
@@ -17,6 +17,7 @@ module Tamashii
       @handlers ||= {}
     end
 
+    # TODO: Rename hook to middleware
     def hooks
       @hooks ||= []
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tamashii-common
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - 蒼時弦也
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-04 00:00:00.000000000 Z
+date: 2017-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -118,10 +118,8 @@ files:
 - lib/tamashii/agent_hint.rb
 - lib/tamashii/common.rb
 - lib/tamashii/common/version.rb
-- lib/tamashii/config.rb
 - lib/tamashii/environment.rb
 - lib/tamashii/handler.rb
-- lib/tamashii/hook.rb
 - lib/tamashii/logger.rb
 - lib/tamashii/packet.rb
 - lib/tamashii/resolver.rb

data/lib/tamashii/config.rb

@@ -1,55 +0,0 @@
-require "tamashii/environment"
-
-module Tamashii
-  class Config < Hash
-    SHARED_CONFIG = %i(auth_type token log_file log_level token env).freeze
-
-    class << self
-      attr_accessor :default_config
-
-      def method_missing(name, *args, &block)
-        (@instance ||= self.new).send(name, *args, &block)
-      end
-
-      def register(name, default = nil)
-        self.default_config ||= {}
-        self.default_config[name.to_sym] = default
-      end
-
-      def [](name)
-        send(name.to_sym)
-      end
-    end
-
-    def initialize
-      @accept_config = Set.new(SHARED_CONFIG)
-      (self.class.default_config || {}).each { |name, value| register(name, value) }
-    end
-
-    def method_missing(name, *args, &block)
-      return unless accept?(name) || accept?(name[0..-2])
-      return register(name[0..-2], args.first) if name[-1..-1] == "="
-      return register(name, args.first) if args.size > 0
-      return register(name, yield(self)) if block_given?
-      self[name]
-    end
-
-    def register(key, default = nil)
-      @accept_config.add(key.to_sym)
-      self[key.to_sym] = default if default
-    end
-
-    def accept?(key)
-      @accept_config.include?(key.to_sym)
-    end
-
-    def env(env = nil)
-      return Environment.new(self[:env]) if env.nil?
-      self[:env] = env.to_s
-    end
-
-    def env=(env)
-      self[:env] = env.to_s
-    end
-  end
-end

data/lib/tamashii/hook.rb

@@ -1,13 +0,0 @@
-module Tamashii
-  class Hook
-    attr_reader :env
-
-    def initialize(env)
-      @env = env
-    end
-
-    def call(pkt)
-      raise NotImplementedError.new("Hook should implement the #call method")
-    end
-  end
-end