macker 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3345ba78a64ef11813ffb3c882c6121a7424b201
-  data.tar.gz: 5932cb24ba0b384b2427ac23be31167c517dcc4e
+  metadata.gz: e470b678db144594ba3d9f1b6bbe364604184da3
+  data.tar.gz: c4a79a52c78a08699c27033f6cc04acf7de3581a
 SHA512:
-  metadata.gz: 22f361008a20f33c591574ddf727130ac3dd6d009784b93132f2aa02bda095e73ee384dd6bcc9ef0dd025ec7d927e75d4128c9c36dea4e7e9b78a8034d6f1bf2
-  data.tar.gz: b136c91fd4487d7feda49763ffc397a993efd252d96d31faffc8092b98139c5415282b61e8452d9d2ae1fab1582372610ebab4fd9dca89249aba663bbcafb7cd
+  metadata.gz: 9c1cb71bae8c6ba81f37f13e9fafe284ac12f292e34b199c6a15daea4131603c457ef8ed372d97255230a4c2c7b9597ee29e2398b788dc8daa4a5fc553a6392d
+  data.tar.gz: 45fd38ba9cbf223cb97b61841322014b68deb5f46c45dc4b8381af2036cff73e08a7f231429f3b33c20464566b5bcad9af6dd3b301e732a06b18e83f966fe31b

data/README.md

@@ -1,4 +1,4 @@
-# Macker
+# Macker (The Mac Maker)
 
 [![Gem Version](https://badge.fury.io/rb/macker.svg)](https://rubygems.org/gems/macker)
 [![Gem](https://img.shields.io/gem/dt/macker.svg?maxAge=2592000)](https://rubygems.org/gems/macker)
@@ -44,10 +44,10 @@ Rails users can create a file `macker.rb` in `config/initializers` to load the o
 
 ```ruby
 Maker.configure do |config|
-  config.oui_full_url    = 'http://standards-oui.ieee.org/oui.txt',                                # Full URL of OUI text file
+  config.oui_full_url    = 'http://linuxnet.ca/ieee/oui.txt',                                      # Full URL of OUI text file
   config.user_agent      = 'Mozilla/5.0 (X11; Linux x86_64; rv:54.0) Gecko/20100101 Firefox/54.0', # A common user agent
   config.ttl_in_seconds  = 86_400,                                                                 # Will expire the vendors in one day
-  config.cache:          = File.expand_path(File.dirname(__FILE__) + '/../../data/oui_*.txt'),     # Can be a string, pathname or proc
+  config.cache           = File.expand_path(File.dirname(__FILE__) + '/../../data/oui_*.txt'),     # Can be a string, pathname or proc
   config.auto_expiration = true                                                                    # Expiration can be checked manually
 end
 ```
@@ -84,6 +84,9 @@ mac.to_s
 
 mac = Macker.generate(iso_code: 'US')
 # => #<Macker::Address:0x000000046b86f0 @val=161304050786, @name="The Weather Channel", @address=["Mail Stop 500", "Atlanta Ga 30339", "Us"], @iso_code="US">
+
+# Raise an exception
+Macker.generate!(iso_code: 'HELLO')
 ```
 
 ### Lookup MAC address
@@ -99,6 +102,7 @@ Macker.lookup(mac)
 Macker.lookup('64-E6-82-E5-CC-58')
 Macker.lookup('64E682E5CC58')
 Macker.lookup(110941201353816)
+Macker.lookup!(110941201353816)
 ```
 
 ### MAC address
@@ -107,7 +111,7 @@ mymac = Macker.lookup('64-E6-82-E5-CC-58')
 mymac.class
 # => Macker::Address
 
-# Some method of the class
+# Some methods of the address class
 mymac.name
 mymac.address
 mymac.iso_code
@@ -129,6 +133,46 @@ mymac.prefix
 mymac.full_address
 ```
 
+### Cache control
+
+```ruby
+# Update OUI from cache (careful)
+Macker.update
+# => 2017-07-03 13:03:00 +0200
+
+# Update OUI from remote (straight)
+Macker.update(true)
+# => 2017-07-03 13:04:00 +0200
+
+# Vendor table with all base16 MAC prefixes as keys
+Macker.prefix_table
+# => "F8DA0C"=>{:name=>"Hon Hai..."},  ...
+
+# Vendor table with all country iso codes as keys
+Macker.iso_code_table
+# => "CN"=>[{:name=>"Hon Hai..."} ... ]
+
+# Vendor table with all country vendor names as keys
+Macker.vendor_table
+# => "Apple, Inc."=>[{:prefix=>...} ... ]
+
+Macker.expire!
+# => false
+
+Macker.expired?
+# => false
+
+Macker.stale?
+# => false
+
+Macker.vendors_expiration
+# => 2017-07-04 13:04:00 +0200
+
+# Get configuration of Macker
+Macker.config
+# => #<Macker::Config:0x0000000124ff30 @config=#...>>
+```
+
 ## Contributors
 
 * Inspired by MacVendor [github.com/uceem/mac_vendor](https://github.com/uceem/mac_vendor).

data/lib/macker.rb

@@ -101,7 +101,7 @@ module Macker
   # @return [Address] MAC address with data
   def generate(opts = {})
     expire! if config.auto_expiration
-    return generate_by_iso_code(opts.delete(:iso_code), opts) if opts[:iso_code] && opts[:iso_code].length == 2
+    return generate_by_iso_code(opts.delete(:iso_code), opts) if opts[:iso_code]
     vendor = opts.delete(:vendor)
     case vendor
     when nil, false
@@ -257,6 +257,7 @@ module Macker
       base16_fields = vendor.strip.split("\n")[1].split("\t")
       mac_prefix = Address.new(base16_fields[0].strip[0..5]).prefix
       address = vendor.strip.delete("\t").split("\n")
+      iso_code = address[-1].strip
       next unless @prefix_table[mac_prefix].nil?
       @prefix_table[mac_prefix] = { name: base16_fields[-1]
                                       .strip
@@ -273,7 +274,7 @@ module Macker
                                       .map(&:capitalize)
                                       .join(' ')
                                     },
-                                    iso_code: address[-1].strip.upcase
+                                    iso_code: iso_code.length == 2 ? iso_code.upcase : nil
                                   }
     end
     @iso_code_table = @prefix_table.each_with_object({}) { |(key, value), out| (out[value[:iso_code]] ||= []) << value.merge(prefix: key) }

data/lib/macker/version.rb

@@ -3,5 +3,5 @@
 # Macker namespace
 module Macker
   # Macker version
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

data/macker.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/phlegx/#{spec.name}"
 
   spec.summary       = 'Real MAC addresses maker.'
-  spec.description   = 'Real MAC addresses generator and vendor lookup.'
+  spec.description   = 'Real MAC addresses generator and vendor lookup with MAC address handling.'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: macker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Egon Zemmer
@@ -66,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.1
-description: Real MAC addresses generator and vendor lookup.
+description: Real MAC addresses generator and vendor lookup with MAC address handling.
 email:
 - office@phlegx.com
 executables: []
@@ -106,9 +106,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Real MAC addresses maker.
 test_files:
 - test/maker_test.rb
+has_rdoc: