oui_lookup 1.0.0 → 1.0.1

Sign up to get free protection for your applications and to get access to all the features.
data/README.rdoc ADDED
@@ -0,0 +1,85 @@
1
+ = OUI_Lookup
2
+
3
+ == Copyright and Licensing
4
+
5
+ === Copyright Notice
6
+
7
+ Copyright 2011 Todd A. Jacobs
8
+ All rights reserved.
9
+
10
+ === Software License
11
+
12
+ http://www.gnu.org/graphics/gplv3-88x31.png
13
+
14
+ The software is licensed under the
15
+ GPLv3[http://www.gnu.org/copyleft/gpl.html].
16
+ The LICENSE is also included in the source tree.
17
+
18
+ === README License
19
+
20
+ http://i.creativecommons.org/l/by-nc-sa/3.0/us/88x31.png
21
+
22
+ {Creative Commons Attribution-NonCommercial-ShareAlike 3.0 United States
23
+ License}[http://creativecommons.org/licenses/by-nc-sa/3.0/us/]
24
+
25
+ == Purpose
26
+
27
+ The IEEE hands out Organizationally Unique Identifiers to companies for
28
+ use in such things as manufacturing NIC cards. The first three octets of
29
+ a MAC address should be the manufacturer's prefix, so this gem may be
30
+ useful in identifyng NIC cards or constructing valid MAC addresses.
31
+
32
+ == Installation and Usage
33
+
34
+ The install instructons assume RVM with Ruby 1.9.2. The dependencies
35
+ aren't heavy, and it would probably take less time to backport the tests
36
+ and syntax to 1.8.7 than it did to write this sentence, but life is like
37
+ that sometimes. Don't file a bug about it; just make sure you are using
38
+ the correct Ruby within RVM.
39
+
40
+ === Installing the OUI_Lookup Gem
41
+
42
+ gem install oui_lookup
43
+
44
+ === Running the CLI
45
+
46
+ oui_lookup <mac_address_or_prefix>
47
+
48
+ === Using the Library
49
+
50
+ require 'oui_lookup'
51
+
52
+ == Sample Output
53
+
54
+ No screenshots here, just samples of what you can expect from running
55
+ this thing.
56
+
57
+ [NOTE]
58
+ The input format is pretty flexible. It will take both a three-octet
59
+ prefix, as well as a full MAC address with six octets. It's also
60
+ pretty agnostic about separators (or the lack thereof).
61
+
62
+ === Looking up a valid prefix
63
+
64
+ $ oui_lookup 000000
65
+ Searching...
66
+
67
+ 00-00-00 (hex) XEROX CORPORATION
68
+ 000000 (base 16) XEROX CORPORATION
69
+ M/S 105-50C
70
+ 800 PHILLIPS ROAD
71
+ WEBSTER NY 14580
72
+ UNITED STATES
73
+
74
+ === Looking up a MAC address with an unregistered prefix
75
+
76
+ $ oui_lookup FF:FF:FF:FF:FF:FF
77
+ Searching...
78
+
79
+ OUI not found: FF-FF-FF
80
+
81
+ == Further Reading
82
+
83
+ 1. {Ruby Version Manager (RVM)}[http://beginrescueend.com/]
84
+ 2. RubyGems[http://rubygems.org/]
85
+ 3. {IEEE OUIs}[http://standards.ieee.org/develop/regauth/oui/index.html]
@@ -1,3 +1,3 @@
1
1
  module OUI_Lookup
2
- VERSION = '1.0.0'
2
+ VERSION = '1.0.1'
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: oui_lookup
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.0.1
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors:
@@ -9,11 +9,11 @@ authors:
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2011-09-23 00:00:00.000000000Z
12
+ date: 2011-09-24 00:00:00.000000000Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: minitest
16
- requirement: &8825860 !ruby/object:Gem::Requirement
16
+ requirement: &18259420 !ruby/object:Gem::Requirement
17
17
  none: false
18
18
  requirements:
19
19
  - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
21
21
  version: '0'
22
22
  type: :development
23
23
  prerelease: false
24
- version_requirements: *8825860
24
+ version_requirements: *18259420
25
25
  - !ruby/object:Gem::Dependency
26
26
  name: rest-client
27
- requirement: &8825380 !ruby/object:Gem::Requirement
27
+ requirement: &18258680 !ruby/object:Gem::Requirement
28
28
  none: false
29
29
  requirements:
30
30
  - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
32
32
  version: '0'
33
33
  type: :runtime
34
34
  prerelease: false
35
- version_requirements: *8825380
35
+ version_requirements: *18258680
36
36
  - !ruby/object:Gem::Dependency
37
37
  name: nokogiri
38
- requirement: &8824960 !ruby/object:Gem::Requirement
38
+ requirement: &18257960 !ruby/object:Gem::Requirement
39
39
  none: false
40
40
  requirements:
41
41
  - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
43
43
  version: '0'
44
44
  type: :runtime
45
45
  prerelease: false
46
- version_requirements: *8824960
46
+ version_requirements: *18257960
47
47
  description: Find OUI prefixes using the IEEE public registry.
48
48
  email:
49
49
  - spamivore+oui_lookup@codegnome.org
@@ -58,7 +58,7 @@ files:
58
58
  - AUTHORS
59
59
  - Gemfile
60
60
  - LICENSE
61
- - README.asciidoc
61
+ - README.rdoc
62
62
  - Rakefile
63
63
  - bin/oui_lookup
64
64
  - lib/oui_lookup.rb
data/README.asciidoc DELETED
@@ -1,105 +0,0 @@
1
- OUI_Lookup README
2
- =================
3
-
4
- == Copyright and Licensing
5
-
6
- Copyright (C) 2011 Todd A. Jacobs +
7
- All rights reserved.
8
-
9
- === Software License
10
-
11
- image:http://www.gnu.org/graphics/gplv3-88x31.png[GNU General Public
12
- License, Version 3]
13
-
14
- The software is licensed under the
15
- http://www.gnu.org/copyleft/gpl.html[GPLv3]. The LICENSE is also
16
- included in the source tree.
17
-
18
- === README License
19
-
20
- // Creative Commons Attribution-NonCommercial-ShareAlike 3.0 United
21
- // States License
22
-
23
- +++
24
- <a rel="license"
25
- href="http://creativecommons.org/licenses/by-nc-sa/3.0/us/"><img
26
- alt="Creative Commons License" style="border-width:0"
27
- src="http://i.creativecommons.org/l/by-nc-sa/3.0/us/88x31.png" /></a><br
28
- /><span xmlns:dct="http://purl.org/dc/terms/"
29
- href="http://purl.org/dc/dcmitype/Text" property="dct:title"
30
- rel="dct:type">OUI_Lookup README</span> by <a
31
- xmlns:cc="http://creativecommons.org/ns#"
32
- href="https://github.com/CodeGnome/oui_lookup"
33
- property="cc:attributionName" rel="cc:attributionURL">Todd A. Jacobs</a>
34
- is licensed under a <a rel="license"
35
- href="http://creativecommons.org/licenses/by-nc-sa/3.0/us/">Creative
36
- Commons Attribution-NonCommercial-ShareAlike 3.0 United States
37
- License</a>.
38
- +++
39
-
40
- == Purpose
41
-
42
- The IEEE hands out Organizationally Unique Identifiers to companies for
43
- use in such things as manufacturing NIC cards. The first three octets of
44
- a MAC address should be the manufacturer's prefix, so this gem may be
45
- useful in identifyng NIC cards or constructing valid MAC addresses.
46
-
47
- == Installation and Usage
48
-
49
- The install instructons assume RVM with Ruby 1.9.2. The dependencies
50
- aren't heavy, and it would probably take less time to backport the tests
51
- and syntax to 1.8.7 than it did to write this sentence, but life is like
52
- that sometimes. Don't file a bug about it; just make sure you are using
53
- the correct Ruby within RVM.
54
-
55
- .Installing the OUI_Lookup Gem
56
- ----------------------------------------------------------------------
57
- gem install oui_lookup
58
- ----------------------------------------------------------------------
59
-
60
- .Running the CLI
61
- ----------------------------------------------------------------------
62
- oui_lookup <mac_address_or_prefix>
63
- ----------------------------------------------------------------------
64
-
65
- .Using the Library
66
- ----------------------------------------------------------------------
67
- require 'oui_lookup'
68
- ----------------------------------------------------------------------
69
-
70
- == Sample Output
71
-
72
- No screenshots here, just samples of what you can expect from running
73
- this thing.
74
-
75
- [NOTE]
76
- The input format is pretty flexible. It will take both a three-octet
77
- prefix, as well as a full MAC address with six octets. It's also pretty
78
- agnostic about separators (or the lack thereof).
79
-
80
- .Looking up a valid prefix
81
- ----------------------------------------------------------------------
82
- $ oui_lookup 000000
83
- Searching...
84
-
85
- 00-00-00 (hex) XEROX CORPORATION
86
- 000000 (base 16) XEROX CORPORATION
87
- M/S 105-50C
88
- 800 PHILLIPS ROAD
89
- WEBSTER NY 14580
90
- UNITED STATES
91
- ----------------------------------------------------------------------
92
-
93
- .Looking up a MAC address with an unregistered prefix
94
- ----------------------------------------------------------------------
95
- $ oui_lookup FF:FF:FF:FF:FF:FF
96
- Searching...
97
-
98
- OUI not found: FF-FF-FF
99
- ----------------------------------------------------------------------
100
-
101
- == Further Reading
102
-
103
- . http://beginrescueend.com/[Ruby Version Manager (RVM)]
104
- . http://rubygems.org/[RubyGems]
105
- . http://standards.ieee.org/develop/regauth/oui/index.html[IEEE OUIs]