oui 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7463e3796f9ab02ec63573ea6ca8927d38eef923
-  data.tar.gz: d7597f11cf943b25bf50b401c2e78d6e69328de2
+  metadata.gz: 2615ddef89daccfce7848cd820e7099698d2a543
+  data.tar.gz: eabfb4df35310bd79aa3310ae5cb2f867c035231
 SHA512:
-  metadata.gz: 4085cd5cd8d38de2fc8ff203b4051d6bccbfc61beaae41767226c324ef14b15da4d9dbcc9a869bf8e11c178074d60ef8744ac7e03710ad9857330b54f7b9b783
-  data.tar.gz: 8b85aef2a26df22103fa10392e9a903f0d7017fc0d976f170db3d9c1f362d5cebbde938194a1d53d20226bd3d41cc4a2b1a82d6c9ab0fc7c2d3b4ca04826cb4d
+  metadata.gz: 477f020c7cbcad34419f717b5565090f44e9066d1fa3658959f5cdea8d8777343559519b08eaf89f796f49cd7b0a58722211a45620f006377951beec74143831
+  data.tar.gz: f4cfd5bf693de11ceb9673d39f6dbf338b433f2238a7826655ec090dba7779d5ab0545e28ba589f104213e08e21fa1d0f5d2261c34dc8fc773476cfa04cc6f03

data/.gitignore

@@ -14,3 +14,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+records.txt

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+script: bundle exec rspec

data/Gemfile

@@ -3,3 +3,8 @@ source 'https://rubygems.org'
 ruby '2.0.0'
 
 gemspec
+
+gem 'newrelic_rpm'
+
+gem 'unicorn'
+gem 'thin'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    oui (0.0.2)
+    oui (0.0.3)
       sinatra
       sinatra-contrib
 
@@ -10,18 +10,23 @@ GEM
   specs:
     backports (3.6.0)
     coderay (1.1.0)
+    daemons (1.1.9)
     diff-lcs (1.2.5)
+    eventmachine (1.0.3)
+    kgio (2.8.0)
     method_source (0.8.2)
     multi_json (1.10.1)
+    newrelic_rpm (3.9.0.229)
     pry (0.9.12.4)
       coderay (~> 1.0)
       method_source (~> 0.8)
       slop (~> 3.4)
     rack (1.5.2)
-    rack-protection (1.5.0)
+    rack-protection (1.5.3)
       rack
     rack-test (0.6.2)
       rack (>= 1.0)
+    raindrops (0.11.0)
     rake (10.3.2)
     rspec (3.0.0)
       rspec-core (~> 3.0.0)
@@ -37,8 +42,8 @@ GEM
     rspec-support (3.0.2)
     shotgun (0.9)
       rack (>= 1.0)
-    sinatra (1.4.2)
-      rack (~> 1.5, >= 1.5.2)
+    sinatra (1.4.5)
+      rack (~> 1.4)
       rack-protection (~> 1.4)
       tilt (~> 1.3, >= 1.3.4)
     sinatra-contrib (1.4.2)
@@ -49,15 +54,26 @@ GEM
       sinatra (~> 1.4.0)
       tilt (~> 1.3)
     slop (3.4.7)
+    thin (1.5.1)
+      daemons (>= 1.0.9)
+      eventmachine (>= 0.12.6)
+      rack (>= 1.0.0)
     tilt (1.4.1)
+    unicorn (4.6.2)
+      kgio (~> 2.6)
+      rack
+      raindrops (~> 0.7)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.3)
+  newrelic_rpm
   oui!
   pry
   rake
   rspec
   shotgun
+  thin
+  unicorn

data/Procfile

@@ -0,0 +1 @@
+web: bundle exec rackup -p $PORT

data/README.md

@@ -2,6 +2,57 @@
 
 look up OUI information /w Chinese translation using MAC addresses
 
+OUI info from [IEEE OUI text file](https://standards.ieee.org/develop/regauth/oui/oui.txt)
+
+[![Build Status](https://travis-ci.org/modouwifi/oui-gem.svg?branch=master)](https://travis-ci.org/modouwifi/oui-gem)
+
+Currently hosted on [heroku.com](https://heroku.com), live at [http://oui.ly.md](http://oui.ly.md), try URLs like this: [http://oui.ly.md/lookup?mac=14:10:9f:ea:49:11](http://oui.ly.md/lookup?mac=14:10:9f:ea:49:11)
+
+## Service Benchmark
+
+Roughly 320 requests per second, or 20000 requests per minute.
+
+with `ab -n 20000 -c 100 http://oui.ly.md/lookup?mac=14:10:9f:ea:49:11`
+
+```
+Server Software:        thin
+Server Hostname:        oui.ly.md
+Server Port:            80
+
+Document Path:          /lookup?mac=14:10:9f:ea:49:11
+Document Length:        74 bytes
+
+Concurrency Level:      100
+Time taken for tests:   61.629 seconds
+Complete requests:      20000
+Failed requests:        0
+Write errors:           0
+Total transferred:      6160000 bytes
+HTML transferred:       1480000 bytes
+Requests per second:    324.52 [#/sec] (mean)
+Time per request:       308.143 [ms] (mean)
+Time per request:       3.081 [ms] (mean, across all concurrent requests)
+Transfer rate:          97.61 [Kbytes/sec] received
+
+Connection Times (ms)
+              min  mean[+/-sd] median   max
+Connect:       72   74  24.0     73     846
+Processing:    86  233  78.3    233    2377
+Waiting:       85  231  78.0    231    2375
+Total:        161  307  80.9    306    2450
+
+Percentage of the requests served within a certain time (ms)
+  50%    306
+  66%    327
+  75%    334
+  80%    340
+  90%    355
+  95%    369
+  98%    393
+  99%    432
+ 100%   2450 (longest request)
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/Rakefile

@@ -7,3 +7,64 @@ require 'rake'
 # RSpec::Core::RakeTask.new(:spec)
 #
 # task :default => :spec
+
+def download_logs
+  `mkdir -p tmp`
+  `heroku logs -n 100000 > tmp/logs.txt`
+end
+
+def show_report
+  require "oui"
+
+  logs = File.read('tmp/logs.txt')
+
+  mac_addresses = []
+
+  logs.each_line do |line|
+    if line =~ /(#{OUI::MACAddress.mac_regex_string})/
+      puts $1
+      mac_addresses << $1
+    end
+  end
+
+  mac_addresses.uniq!
+
+  File.open("records.txt", "a") do |file|
+    mac_addresses.each do |mac|
+      org = OUI::MACAddress.parse(mac).organization
+      if org.chinese_name.nil? || org.chinese_name.length > 10
+        if org.name
+          p org
+          file.puts org.inspect
+        end
+      end
+    end
+  end
+end
+
+def show_feeds
+  logs = File.read('tmp/logs.txt')
+
+  logs.each_line do |line|
+    if line =~ /path="\/feed/
+      puts line
+    end
+  end
+end
+
+task :report_local do
+  show_report
+end
+
+task :report do
+  download_logs
+  show_report
+end
+
+task :feeds do
+  show_feeds
+end
+
+task :download_logs do
+  download_logs
+end

data/TODO.md

@@ -0,0 +1,10 @@
+## library
+- js call lookup MAC on index page
+- support vendor override: need to analyze logs
+- support locally administered addresses (e.g. 0A:72:2C:1E:8B:0A)
+- support Individual Address Block (addresses start with 40-D8-55)
+
+## server
+- utilize `.profile` and capture `SIGTERM` as described in [https://devcenter.heroku.com/articles/dynos#the-dyno-manager](https://devcenter.heroku.com/articles/dynos#the-dyno-manager)
+- handle deployment downtime gracefully
+- separate `oui.txt` lookup to a database

data/bin/oui

@@ -25,6 +25,23 @@ def generate_yml
   end
 end
 
-mac = ARGV.first
+if ARGV.empty?
+  puts
+  puts "usage:"
+  puts "oui MAC_ADDR_1 MAC_ADDR_2   # lookup MAC addresses"
+  puts "oui local                   # lookup vendor info of all local MAC addresses (via ifconfig)"
+  exit
+end
 
-p OUI::MACAddress.parse(mac).organization
+if ARGV.first == 'local'
+  `ifconfig`.each_line do |line|
+    match = /[\d|[a-f]][\d|[a-f]]:[\d|[a-f]][\d|[a-f]]:[\d|[a-f]][\d|[a-f]]:[\d|[a-f]][\d|[a-f]]:[\d|[a-f]][\d|[a-f]]:[\d|[a-f]][\d|[a-f]]/.match(line)
+    if match
+      puts "#{match[0]} => #{OUI::MACAddress.parse(match[0]).organization.inspect}"
+    end
+  end
+else
+  ARGV.each do |mac|
+    puts "#{mac} => #{OUI::MACAddress.parse(mac).organization.inspect}"
+  end
+end

data/config.ru

@@ -2,4 +2,10 @@
 require "oui"
 require 'oui/server'
 
+# realtime logging
+# https://devcenter.heroku.com/articles/logging
+$stdout.sync = true
+
+use Rack::Static, :urls => ["/assets"], :root => "public"
+
 run OUI::Server

data/config/newrelic.yml

@@ -0,0 +1,227 @@
+#
+# This file configures the New Relic Agent.  New Relic monitors
+# Ruby, Java, .NET, PHP, and Python applications with deep visibility and low overhead.
+# For more information, visit www.newrelic.com.
+#
+# Generated June 03, 2013
+#
+# This configuration file is custom generated for Barsoom
+
+
+# Here are the settings that are common to all environments
+common: &default_settings
+  # ============================== LICENSE KEY ===============================
+
+  # You must specify the license key associated with your New Relic
+  # account.  This key binds your Agent's data to your account in the
+  # New Relic service.
+  license_key: '<%= ENV["NEW_RELIC_LICENSE_KEY"] %>'
+
+  # Agent Enabled (Ruby/Rails Only)
+  # Use this setting to force the agent to run or not run.
+  # Default is 'auto' which means the agent will install and run only
+  # if a valid dispatcher such as Mongrel is running.  This prevents
+  # it from running with Rake or the console.  Set to false to
+  # completely turn the agent off regardless of the other settings.
+  # Valid values are true, false and auto.
+  #
+  # agent_enabled: auto
+
+  # Application Name Set this to be the name of your application as
+  # you'd like it show up in New Relic. The service will then auto-map
+  # instances of your application into an "application" on your
+  # dashboard page. If you want to map this instance into multiple
+  # apps, like "AJAX Requests" and "All UI" then specify a semicolon
+  # separated list of up to three distinct names, or a yaml list.
+  # Defaults to the capitalized RAILS_ENV or RACK_ENV (i.e.,
+  # Production, Staging, etc)
+  #
+  # Example:
+  #
+  #   app_name:
+  #       - Ajax Service
+  #       - All Services
+  #
+  app_name: <%= ENV["NEW_RELIC_APP_NAME"] %>
+
+  # When "true", the agent collects performance data about your
+  # application and reports this data to the New Relic service at
+  # newrelic.com. This global switch is normally overridden for each
+  # environment below. (formerly called 'enabled')
+  monitor_mode: true
+
+  # Developer mode should be off in every environment but
+  # development as it has very high overhead in memory.
+  developer_mode: false
+
+  # The newrelic agent generates its own log file to keep its logging
+  # information separate from that of your application. Specify its
+  # log level here.
+  log_level: info
+
+  # Optionally set the path to the log file This is expanded from the
+  # root directory (may be relative or absolute, e.g. 'log/' or
+  # '/var/log/') The agent will attempt to create this directory if it
+  # does not exist.
+  # log_file_path: 'log'
+
+  # Optionally set the name of the log file, defaults to 'newrelic_agent.log'
+  # log_file_name: 'newrelic_agent.log'
+
+  # The newrelic agent communicates with the service via https by default.  This
+  # prevents eavesdropping on the performance metrics transmitted by the agent.
+  # The encryption required by SSL introduces a nominal amount of CPU overhead,
+  # which is performed asynchronously in a background thread.  If you'd prefer
+  # to send your metrics over http uncomment the following line.
+  # ssl: false
+
+  #============================== Browser Monitoring ===============================
+  # New Relic Real User Monitoring gives you insight into the performance real users are
+  # experiencing with your website. This is accomplished by measuring the time it takes for
+  # your users' browsers to download and render your web pages by injecting a small amount
+  # of JavaScript code into the header and footer of each page.
+  browser_monitoring:
+      # By default the agent automatically injects the monitoring JavaScript
+      # into web pages. Set this attribute to false to turn off this behavior.
+      auto_instrument: true
+
+  # Proxy settings for connecting to the New Relic server.
+  #
+  # If a proxy is used, the host setting is required.  Other settings
+  # are optional. Default port is 8080.
+  #
+  # proxy_host: hostname
+  # proxy_port: 8080
+  # proxy_user:
+  # proxy_pass:
+
+  # The agent can optionally log all data it sends to New Relic servers to a
+  # separate log file for human inspection and auditing purposes. To enable this
+  # feature, change 'enabled' below to true.
+  # See: https://newrelic.com/docs/ruby/audit-log
+  audit_log:
+    enabled: false
+
+  # Tells transaction tracer and error collector (when enabled)
+  # whether or not to capture HTTP params.  When true, frameworks can
+  # exclude HTTP parameters from being captured.
+  # Rails: the RoR filter_parameter_logging excludes parameters
+  # Java: create a config setting called "ignored_params" and set it to
+  #     a comma separated list of HTTP parameter names.
+  #     ex: ignored_params: credit_card, ssn, password
+  capture_params: false
+
+  # Transaction tracer captures deep information about slow
+  # transactions and sends this to the New Relic service once a
+  # minute. Included in the transaction is the exact call sequence of
+  # the transactions including any SQL statements issued.
+  transaction_tracer:
+
+    # Transaction tracer is enabled by default. Set this to false to
+    # turn it off. This feature is only available at the Professional
+    # and above product levels.
+    enabled: true
+
+    # Threshold in seconds for when to collect a transaction
+    # trace. When the response time of a controller action exceeds
+    # this threshold, a transaction trace will be recorded and sent to
+    # New Relic. Valid values are any float value, or (default) "apdex_f",
+    # which will use the threshold for an dissatisfying Apdex
+    # controller action - four times the Apdex T value.
+    transaction_threshold: apdex_f
+
+    # When transaction tracer is on, SQL statements can optionally be
+    # recorded. The recorder has three modes, "off" which sends no
+    # SQL, "raw" which sends the SQL statement in its original form,
+    # and "obfuscated", which strips out numeric and string literals.
+    record_sql: obfuscated
+
+    # Threshold in seconds for when to collect stack trace for a SQL
+    # call. In other words, when SQL statements exceed this threshold,
+    # then capture and send to New Relic the current stack trace. This is
+    # helpful for pinpointing where long SQL calls originate from.
+    stack_trace_threshold: 0.500
+
+    # Determines whether the agent will capture query plans for slow
+    # SQL queries.  Only supported in mysql and postgres.  Should be
+    # set to false when using other adapters.
+    # explain_enabled: true
+
+    # Threshold for query execution time below which query plans will
+    # not be captured.  Relevant only when `explain_enabled` is true.
+    # explain_threshold: 0.5
+
+  # Error collector captures information about uncaught exceptions and
+  # sends them to New Relic for viewing
+  error_collector:
+
+    # Error collector is enabled by default. Set this to false to turn
+    # it off. This feature is only available at the Professional and above
+    # product levels.
+    enabled: true
+
+    # Rails Only - tells error collector whether or not to capture a
+    # source snippet around the place of the error when errors are View
+    # related.
+    capture_source: true
+
+    # To stop specific errors from reporting to New Relic, set this property
+    # to comma-separated values.  Default is to ignore routing errors,
+    # which are how 404's get triggered.
+    ignore_errors: "ActionController::RoutingError,Sinatra::NotFound"
+
+  # If you're interested in capturing memcache keys as though they
+  # were SQL uncomment this flag. Note that this does increase
+  # overhead slightly on every memcached call, and can have security
+  # implications if your memcached keys are sensitive
+  # capture_memcache_keys: true
+
+# Application Environments
+# ------------------------------------------
+# Environment-specific settings are in this section.
+# For Rails applications, RAILS_ENV is used to determine the environment.
+# For Java applications, pass -Dnewrelic.environment <environment> to set
+# the environment.
+
+# NOTE if your application has other named environments, you should
+# provide newrelic configuration settings for these environments here.
+
+development:
+  <<: *default_settings
+  # Turn off communication to New Relic service in development mode (also
+  # 'enabled').
+  # NOTE: for initial evaluation purposes, you may want to temporarily
+  # turn the agent on in development mode.
+  monitor_mode: false
+
+  # Rails Only - when running in Developer Mode, the New Relic Agent will
+  # present performance information on the last 100 transactions you have
+  # executed since starting the mongrel.
+  # NOTE: There is substantial overhead when running in developer mode.
+  # Do not use for production or load testing.
+  developer_mode: true
+
+  # Enable textmate links
+  # textmate: true
+
+test:
+  <<: *default_settings
+  # It almost never makes sense to turn on the agent when running
+  # unit, functional or integration tests or the like.
+  monitor_mode: false
+
+# Turn on the agent in production for 24x7 monitoring. NewRelic
+# testing shows an average performance impact of < 5 ms per
+# transaction, you can leave this on all the time without
+# incurring any user-visible performance degradation.
+production:
+  <<: *default_settings
+  monitor_mode: true
+
+# Many applications have a staging environment which behaves
+# identically to production. Support for that environment is provided
+# here.  By default, the staging environment has the agent turned on.
+staging:
+  <<: *default_settings
+  monitor_mode: true
+  app_name: <%= ENV["NEW_RELIC_APP_NAME"] %> (Staging)