top_notify 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+log/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in top_notify.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 kenshin54
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# TopNotify
+
+TopNotify use to process notification stream from TOP. (http://open.taobao.com/doc/detail.htm?spm=0.0.0.198.PfQSxk&id=1065#s7)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'top_notify'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install top_notify
+
+## Usage
+
+configure your app_key and app_secret
+
+```ruby
+  TopNotify.setup do |config|
+    config.app_key = your_app_key
+    config.app_secret = your_app_secret
+  end
+```
+
+write your consumer
+
+```ruby
+  class MyConsumer < TopNotify::Consumer
+    def receive_msg(data)
+      # ... your code
+    end
+  end
+```
+
+start server
+
+```ruby
+  TopNotify::Server.new(MyConsumer.new).start
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = false
+end
+
+task :default => :test

data/lib/top_notify.rb

@@ -0,0 +1,57 @@
+require "top_notify/version"
+
+module TopNotify
+
+	TYPE = {
+		200 => {:method => :connected,              :msg => "connect to taobao server"},
+		201 => {:method => :heartbreak,             :msg => "receive heartbreak"},
+		202 => {:method => :receive_msg,            :msg => "receive msg"},
+		203 => {:method => :discard_msg,            :msg => "receive discard msg"},
+		101 => {:method => :connect_reach_max_time, :msg => "connection reach max time"},
+		102 => {:method => :server_upgrate,         :msg => "taobao server under upgrade"},
+		103 => {:method => :server_rehash,          :msg => "taobao server close the connection"},
+		104 => {:method => :client_kickoff,         :msg => "client kickoff"},
+		105 => {:method => :server_kickoff,         :msg => "server kickoff"},
+    0   => {:method => :unknown_msg,            :msg => "unknown msg"}
+	}
+
+  class << self
+
+    def setup
+      yield self
+    end
+
+    def app_key=(app_key)
+      @app_key = app_key
+    end
+
+    def app_secret=(app_secret)
+      @app_secret = app_secret
+    end
+
+    def logger=(device)
+      @logger = device
+    end
+
+    def logger
+      @logger
+    end
+
+    def app_key
+      @app_key
+    end
+
+    def app_secret
+      @app_secret
+    end
+
+    def service_url
+      @service_url ||= 'http://stream.api.taobao.com/stream'
+    end
+  end
+
+end
+
+require 'top_notify/server'
+require 'top_notify/exception'
+require 'top_notify/connection'

data/lib/top_notify/connection.rb

@@ -0,0 +1,30 @@
+require 'net/http'
+require 'uri'
+require 'top_notify/sign'
+
+module TopNotify
+  class Connection
+
+    include Sign
+
+    def initialize
+      if TopNotify.app_key.to_s.empty? || TopNotify.app_secret.to_s.empty?
+        raise ConfigurationNotFoundError.new('You need to set app_key and app_secret first before use top_notfiy.')
+      end
+      @params = {:app_key => TopNotify.app_key, :timestamp => Time.now.strftime('%F %T'), :sign_method => 'md5'}
+      @params.merge!(:sign => sign(@params))
+      @uri = URI.parse(TopNotify.service_url)
+      @request = Net::HTTP::Post.new(uri.request_uri)
+      @request.set_form_data(@params)
+    end
+
+    def uri
+      @uri
+    end
+
+    def request
+      @request
+    end
+
+  end
+end

data/lib/top_notify/consumer.rb

@@ -0,0 +1,11 @@
+module TopNotify
+  class Consumer
+    TopNotify::TYPE.each_pair do |code, const|
+      class_eval <<-EOF
+        def #{const[:method]}(data)
+          puts data
+        end
+      EOF
+    end
+  end
+end

data/lib/top_notify/exception.rb

@@ -0,0 +1,4 @@
+module TopNotify
+  class ConfigurationNotFoundError < StandardError; end
+  class ConfigurationError < StandardError; end
+end

data/lib/top_notify/logger.rb

@@ -0,0 +1,27 @@
+module TopNotify
+  class Logger
+    def initialize(device)
+      @device = if device.respond_to?(:write)
+        device
+      else
+        File.open(device, 'a')
+      end
+      @device.sync = true if @device.respond_to?(:sync)
+    end
+
+    def log(msg)
+      @device.write(msg)
+    end
+
+    def log_stream(data, msg = nil)
+      content  = "# #{time}"
+      content += " (#{msg})" if msg
+      content += " [#{data}]\n"
+      log content
+    end
+
+    def time
+      Time.now.strftime('%Y-%m-%d %H:%M:%S')
+    end
+  end
+end

data/lib/top_notify/server.rb

@@ -0,0 +1,39 @@
+require 'net/http'
+require 'uri'
+require 'multi_json'
+require 'top_notify/logger'
+require 'top_notify/consumer'
+
+module TopNotify
+  class Server
+    def initialize(consumer = Consumer.new)
+      @conn = Connection.new
+      @consumer = consumer
+    end
+
+    def start
+      Net::HTTP.start(@conn.uri.host, @conn.uri.port) do |http|
+        http.request @conn.request do |response|
+          if response.code.to_i == 400
+            raise ConfigurationError.new('Your configuration is not correct, please check it.')
+          end
+          response.read_body do |chunk|
+            data = MultiJson.load(chunk.strip)['packet']
+            result = TYPE[data['code'].to_i] || TYPE[0]
+            logger.log_stream(data, result[:msg])
+            @consumer.send(result[:method], data) if @consumer.respond_to?(result[:method])
+          end
+        end
+      end
+    end
+
+    private
+    def logger
+      @logger ||= if TopNotify.logger
+        Logger.new(TopNotify.logger)
+      else
+        Logger.new(STDOUT)
+      end
+    end
+  end
+end

data/lib/top_notify/sign.rb

@@ -0,0 +1,10 @@
+require 'digest/md5'
+
+module TopNotify
+  module Sign
+    def sign(params)
+      stringify = params.sort.map{|s|s[0].to_s + s[1].to_s}.join
+      Digest::MD5.hexdigest("#{TopNotify.app_secret}#{stringify}#{TopNotify.app_secret}").upcase
+    end
+  end
+end

data/lib/top_notify/version.rb

@@ -0,0 +1,3 @@
+module TopNotify
+  VERSION = "0.0.1"
+end

data/test/macros/config_macros.rb

@@ -0,0 +1,9 @@
+module ConfigMacros
+  def config_setup
+    @app_key, @app_secret = "my_app_key", "my_app_secret"
+    TopNotify.setup do |config|
+      config.app_key = @app_key
+      config.app_secret = @app_secret
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'bundler/setup'
+require 'time'
+require 'minitest/spec'
+require 'minitest/pride'
+require 'minitest/autorun'
+require 'mocha/setup'
+
+require 'top_notify'
+require 'macros/config_macros'
+
+include ConfigMacros

data/test/unit/connection_test.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+describe TopNotify::Connection do
+
+  it "should raise exception when configuration not be set" do
+    proc { TopNotify::Connection.new }.must_raise(TopNotify::ConfigurationNotFoundError)
+  end
+
+  it "should create connection object successfully" do
+    config_setup
+    TopNotify::Connection.new.must_be_instance_of TopNotify::Connection
+  end
+end

data/test/unit/consumer_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+describe TopNotify::Consumer do
+  
+  before do
+    @consumer = TopNotify::Consumer.new
+  end
+
+  it "should respond_to methods which define in TopNotify::TYPE" do
+    TopNotify::TYPE.each_pair do |code, const|
+      @consumer.must_respond_to const[:method]
+    end
+  end
+end

data/test/unit/logger_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+describe TopNotify::Logger do
+
+  it "should write to STDOUT" do
+    STDOUT.expects(:write).with("Foo!")
+    logger = TopNotify::Logger.new STDOUT
+    logger.log('Foo!')
+  end
+
+  it "should write stream data" do
+    STDOUT.expects(:write).with("# 2012-12-22 11:00:00 (uoho) [#{{:foo => 'bar'}}]\n")
+    logger = TopNotify::Logger.new STDOUT
+    logger.stubs(:time).returns('2012-12-22 11:00:00')
+    logger.log_stream({:foo => 'bar'}, 'uoho')
+  end
+
+  describe 'file log' do
+    it "should write to file" do
+      File.any_instance.expects(:write).with('Foo!')
+      logger = TopNotify::Logger.new 'myfile.log'
+      logger.log('Foo!')
+    end
+    after { File.delete('myfile.log') }
+  end
+end

data/test/unit/server_test.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+describe TopNotify::Server do
+  before do
+    config_setup
+    @consumer = TopNotify::Consumer.new
+    @server = TopNotify::Server.new(@consumer)
+  end
+
+  it "should raise ConfigurationError" do
+    proc { @server.start }.must_raise TopNotify::ConfigurationError
+  end
+end

data/test/unit/setup_test.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+describe "config setup" do
+
+  before do
+    config_setup
+  end
+
+  it "should be set app key and app secret" do
+    TopNotify.app_key.must_equal @app_key
+    TopNotify.app_secret.must_equal @app_secret
+  end
+end

data/test/unit/sign_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+
+describe TopNotify::Sign do
+
+  before do
+    config_setup
+    @dummy = Object.new
+    @dummy.extend(TopNotify::Sign)
+  end
+
+  it "should return signed string with params" do
+    params = {:app_key => TopNotify.app_key, :timestamp => Time.parse('2012/12/22'), :sign_method => 'md5'}
+    @dummy.sign(params).must_equal '33B18B20935190054796B67624B1AC3F'
+  end
+end

data/top_notify.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'top_notify/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "top_notify"
+  gem.version       = TopNotify::VERSION
+  gem.authors       = ["kenshin54"]
+  gem.email         = ["himurakenshin54@gmail.com"]
+  gem.description   = %q{TopNotify use to process notification stream from TOP.}
+  gem.summary       = %q{TopNotify use to process notification stream from TOP.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rake',      '~> 0.9.2'
+  gem.add_development_dependency 'bundler',   '~> 1.1'
+  gem.add_development_dependency 'minitest',  '~> 3.3.0'
+  gem.add_development_dependency 'mocha',     '~> 0.13.0'
+
+
+  gem.add_dependency "multi_json", "~> 1.3.7"
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: top_notify
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- kenshin54
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.7
+description: TopNotify use to process notification stream from TOP.
+email:
+- himurakenshin54@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/top_notify.rb
+- lib/top_notify/connection.rb
+- lib/top_notify/consumer.rb
+- lib/top_notify/exception.rb
+- lib/top_notify/logger.rb
+- lib/top_notify/server.rb
+- lib/top_notify/sign.rb
+- lib/top_notify/version.rb
+- test/macros/config_macros.rb
+- test/test_helper.rb
+- test/unit/connection_test.rb
+- test/unit/consumer_test.rb
+- test/unit/logger_test.rb
+- test/unit/server_test.rb
+- test/unit/setup_test.rb
+- test/unit/sign_test.rb
+- top_notify.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: TopNotify use to process notification stream from TOP.
+test_files:
+- test/macros/config_macros.rb
+- test/test_helper.rb
+- test/unit/connection_test.rb
+- test/unit/consumer_test.rb
+- test/unit/logger_test.rb
+- test/unit/server_test.rb
+- test/unit/setup_test.rb
+- test/unit/sign_test.rb