net-address 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 49b34ee328f786f6c03435b5af4648f300deb418
+  data.tar.gz: 9ea72cf12d3e77b8235619c61527030008ed03e2
+SHA512:
+  metadata.gz: 4a2688a71b747233bb0af5ca9d41380ec34320517dbf7d2c80b5ffe15d80e39857f6659ae28cfce7a236eff85ae2714f1c99c4fc175be78ce64430f1aa1a6fbe
+  data.tar.gz: 2bdcf9869329db2349972ceea4dcb6e44f509b0bba0e40f07b392434702f63e96c46883957ddf07b5d769dd2a7fff7626caf7becb356b33b168fff5856d7c581

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.idea/
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.3
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at piotr.wojcieszonek@tkk.net.pl. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in net-address.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Piotr Wojcieszonek
+
+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,43 @@
+# Net::Address
+
+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/net/address`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'net-address'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install net-address
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/net-address. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Net::Address project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/net-address/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "net/address"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/net/address.rb

@@ -0,0 +1,4 @@
+require 'net/address/version'
+require 'net/address/mac'
+require 'net/address/mask'
+require 'net/address/ipv4'

data/lib/net/address/ipv4.rb

@@ -0,0 +1,110 @@
+#Author: Piotr Wojcieszonek
+#e-mail: piotr@wojcieszonek.pl
+# Copyright 03.01.2018 by Piotr Wojcieszonek
+
+require 'net/address/mask'
+
+module Net
+  module Address
+    class IPv4
+
+      include Comparable
+
+      attr_reader :mask
+
+      def initialize(address, mask=nil)
+        parse_address(address)
+        if @mask.nil?
+          @mask = Net::Address::Mask.new(mask.nil? ? 32 : mask)
+        else
+          raise ArgumentError, 'To many parameters' unless mask.nil?
+        end
+      end
+
+      def to_s
+        [@address].pack('N*').unpack('C*').join('.')
+      end
+
+      def to_str
+        "#{to_s}/#{mask.to_cidr}"
+      end
+
+      def to_i
+        @address
+      end
+
+      def <=>(other)
+        self.to_i <=> (other.is_a?(self.class) ? other.to_i : self.class.new(other).to_i)
+      end
+
+      def include?(address)
+        address = address.is_a?(self.class) ? address : self.class.new(address)
+        address.to_i >= net.to_i and address <= broadcast.to_i
+      end
+
+      def net
+        self.class.new(range.first, mask)
+      end
+
+      def broadcast
+        self.class.new(range.last, mask)
+      end
+
+      def previous
+        previous = to_i - 1
+        net <= previous ? self.class.new(previous) : nil
+      end
+
+      def next
+        next_address = to_i + 1
+        broadcast >= next_address ? self.class.new(next_address) : nil
+      end
+
+      def each
+        (net.to_i..broadcast.to_i).each do |address|
+          yield self.class.new(address, mask)
+        end
+      end
+
+
+      private
+
+      def parse_address(address)
+        case address
+          when self.class
+            @address = address.to_i
+            @mask = address.mask
+          when Integer
+            parse_integer(address)
+          when String
+            parse_string(address)
+          else
+            raise ArgumentError, "No implicit conversion of #{address.class.name} to #{self.class.name}"
+        end
+      end
+
+      def parse_string(address)
+        match_data = address.match(/^(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})\/?(\d{1,2})*$/)
+        raise ArgumentError,"No valid IPv4 address #{address}" if match_data.nil?
+        @address = match_data[1].split(/\./).map{|c| c.to_i}.pack('C*').unpack('N').first
+        @mask = Net::Address::Mask.new(match_data[2]) unless match_data[2].nil?
+        raise ArgumentError, "No valid IPv4 address #{address}" unless self.to_s == match_data[1]
+      end
+
+      def parse_integer(address)
+        @address = address
+        if address.to_i < 0 or address.to_i > 0xffffffffffff
+          raise ArgumentError, "No implicit conversion of #{address.class.name} : #{address} to #{self.class.name}"
+        end
+      end
+
+      def range
+        bits = mask.to_i & 0xFFFFFFFF
+        min = bits & to_i
+        max = min + (bits ^ 0xFFFFFFFF)
+        [min, max]
+      end
+
+    end
+  end
+end

data/lib/net/address/mac.rb

@@ -0,0 +1,63 @@
+#Author: Piotr Wojcieszonek
+#e-mail: piotr@wojcieszonek.pl
+# Copyright 02.01.2018 by Piotr Wojcieszonek
+
+module Net
+  module Address
+    class MAC
+
+      include Comparable
+
+      def initialize(mac_address)
+        case mac_address
+          when self.class
+            @mac_address = mac_address.to_i
+          when Integer
+            @mac_address = mac_address.to_i
+          when String
+            @mac_address = clear(mac_address).hex
+          when Array
+            @mac_address = mac_address.join.hex
+          else
+            raise ArgumentError, "No implicit conversion of #{mac_address.class.name} into #{self.name}"
+        end
+        raise ArgumentError, "MAC Address out of range #{mac_address}" if @mac_address.to_i < 0 or @mac_address.to_i > 0xffffffffffff
+      end
+
+      def to_s(separator='.', step = 4)
+        step = step.to_i
+        mac = '%012X' % @mac_address.to_i
+        return mac if separator.nil? or step == 0
+        raise ArgumentError, "Wrong step value #{step}" unless [0,2,4].include? step.to_i
+        (0..(mac.length-1)/step).map{|i|mac[i*step,step]}.join(separator.to_s)
+      end
+
+      def to_i
+        @mac_address.to_i
+      end
+
+      def to_a
+        mac = '%012X' % @mac_address.to_i
+        (0..5).map{|i| mac[i*2,2]}
+      end
+
+      alias_method :octets, :to_a
+
+      def <=>(other)
+        begin
+        other = self.class.new(other) unless other.is_a? self.class
+        rescue ArgumentError => e
+          raise ArgumentError, "No implicit conversion of #{other.class.name} into #{self.name}"
+        end
+        self.to_i <=> other.to_i
+      end
+
+      private
+
+      def clear(mac_address)
+        mac_address.to_s.gsub(/(:|-|\.|,|"|)/,'').gsub(/\s+/, '')
+      end
+
+    end
+  end
+end

data/lib/net/address/mask.rb

@@ -0,0 +1,78 @@
+#Author: Piotr Wojcieszonek
+#e-mail: piotr@wojcieszonek.pl
+# Copyright 02.01.2018 by Piotr Wojcieszonek
+
+module Net
+  module Address
+    class Mask
+
+      include Comparable
+
+      def initialize(mask)
+        mask = mask.nil? ? 0 : mask
+        @mask = parse_mask(mask)
+        raise ArgumentError, "Not valid Net::Address::Mask #{mask}" unless 0 <= @mask.to_i and @mask.to_i <= 32
+      end
+
+      def to_s
+        [self.to_i].pack('N').unpack('C*').join '.'
+      end
+
+      def to_i
+        (0xFFFFFFFF << (32 - @mask.to_i)) & 0xFFFFFFFF
+      end
+
+      def to_cidr
+        @mask.to_i
+      end
+
+      def <=>(other)
+        begin
+          other = self.class.new(other) unless other.is_a? self.class
+        rescue
+          nil
+        end
+        self.to_i <=> other.to_i
+      end
+
+      private
+
+      def parse_mask(mask)
+        case mask
+          when self.class
+            mask.to_cidr
+          when Integer
+            parse_integer(mask)
+          when String
+            parse_string(mask)
+          else
+            raise ArgumentError, "Not valid Net::Address::Mask #{mask}"
+        end
+      end
+
+      def parse_string(mask)
+        case mask
+          when /^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/
+            matching_bits = mask.split('.').map(&:to_i).pack('C*').unpack('B*').first.match(/^(1{0,32})(0{0,32})$/)
+            raise ArgumentError, "Not valid Net::Address::Mask #{mask}" if matching_bits.nil?
+            matching_bits[1].size
+          when /^\/\d{1,2}$/
+            mask.to_s.gsub(/\//, '').to_i
+          when /^\d{1,2}$/
+            mask
+          else
+            raise ArgumentError, "Not valid Net::Address::Mask #{mask}"
+        end
+      end
+
+      def parse_integer(mask)
+        raise ArgumentError, "Not valid Net::Address::Mask #{mask}" if mask < 0
+        return mask if mask.to_i <= 32
+        matching_bits = [mask].pack('N*').unpack('B*').first.match(/^(1{0,32})(0{0,32})$/)
+        raise ArgumentError, "Not valid Net::Address::Mask #{mask}" if matching_bits.nil?
+        matching_bits[1].size
+      end
+
+    end
+  end
+end

data/lib/net/address/version.rb

@@ -0,0 +1,5 @@
+module Net
+  module Address
+    VERSION = "0.1.0"
+  end
+end

data/net-address.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "net/address/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "net-address"
+  spec.version       = Net::Address::VERSION
+  spec.authors       = ["Piotr Wojcieszonek"]
+  spec.email         = ["piotr@wojcieszonek.pl"]
+
+  spec.summary       = %q{Ruby library for network addresses}
+  spec.description   = %q{Net::Address is a Ruby library designed to make manipulation of network addresses such as MAC, IPv4, Netmask.}
+  spec.homepage      = "https://github.com/pwojcieszonek/net-address."
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: net-address
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Piotr Wojcieszonek
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Net::Address is a Ruby library designed to make manipulation of network
+  addresses such as MAC, IPv4, Netmask.
+email:
+- piotr@wojcieszonek.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/net/address.rb
+- lib/net/address/ipv4.rb
+- lib/net/address/mac.rb
+- lib/net/address/mask.rb
+- lib/net/address/version.rb
+- net-address.gemspec
+homepage: https://github.com/pwojcieszonek/net-address.
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Ruby library for network addresses
+test_files: []