gn_uuid 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b61f9a7696746ef2adcbdf7db09b4491e4bb1e59
+  data.tar.gz: 0d0029fbd7b1d3e6cb241c7bc0af190d4ff20d29
+SHA512:
+  metadata.gz: f26e1d84559a74fd9b9d09ffdaa9144191de38bbc79d4faf355be161ac7c7f4dc5b82abf0e14009e25b9ad501ca49f3d96cd946e103a1aad23957c23b9f091be
+  data.tar.gz: fc7f64d798a58bca1a535e06f90760a93b574574090ac6b3556d70ecfbb5a40ef880a07be8d4161e76b0373df10977de756eeff4a3d94a5d811dd59774ce14f9

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  Exclude:
+    - db/**/*
+    - bundle_bin/**/*
+  Include:
+    - gn_uuid.gemspec
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/DotPosition:
+  EnforcedStyle: trailing

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9
+  - 2.0
+  - 2.1
+  - 2.2
+script:
+  - bundle exec rake
+branches:
+  only:
+      - master

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+CHANGELOG for gn_uuid
+=====================
+
+v0.5.0
+------
+
+Original release. I start with highish number to indicate that this gem is
+not expected to go through many changes, as it uses very stable specification

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Dmitry Mozzherin
+
+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,140 @@
+Global Names UUID
+=================
+
+[![Gem Version][gem_badge]][gem_link]
+[![Continuous Integration Status][ci_badge]][ci_link]
+[![Coverage Status][cov_badge]][cov_link]
+[![CodeClimate][code_badge]][code_link]
+[![Dependency Status][dep_badge]][dep_link]
+
+Gem `gn_uuid` creates UUID version 5 out of scientific name string. It
+uses `globalnames.org` domain for DNS namespace. There is a 1:1 relationship
+between the string and the corresponding UUID, so it allows globally connect
+data about a name string originated from independent sources without a need
+to negotiate identifiers. You can find more information about UUID v5 from
+the original [RFC4122][rfc] document.
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gn_uuid'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gn_uuid
+
+Usage
+-----
+
+#### GnUUID.uuid(string, guid = true)
+
+ Parameter | Type    | Description
+-----------|---------|----------------------------------------------------------
+ str       | String  | Scientific Name String
+ guid      | Boolean | `true` returns a String guid, `false` -- UUID object; *default* `true`
+
+```ruby
+require "gn_uuid"
+
+uuid = GnUUID.uuid("Homo sapiens")
+# output: 16f235a0-e4a3-529c-9b83-bd15fe722110
+```
+If you plan to convert uuid into its other formats use
+
+```ruby
+uuid = GnUUID.uuid("Homo sapiens", false)
+# output: urn:uuid:b33e4b19-2399-56c8-9dd3-eff79f221d2f
+
+# as a 'stanard guid'
+uuid.to_s
+# output: b33e4b19-2399-56c8-9dd3-eff79f221d2f
+
+# as an decimal integer
+uuid.to_i
+# output: 30500639462008600581628158843502600464
+
+# as an URI
+uuid.to_uri
+uuid.inspect (alias_method for to_uri)
+# output: urn:uuid:b33e4b19-2399-56c8-9dd3-eff79f221d2f
+
+
+# as a 16-bytes string
+uuid.bytes
+# output: "\x16\xF25\xA0\xE4\xA3R\x9C\x9B\x83\xBD\x15\xFEr!\x10"
+
+# return UUID version
+uuid.version
+# output: 5
+```
+Please note that the internal GnUUID::UUID does not have to be of the version
+5, but GnUUID.uuid generates only version 5 UUIDs
+
+#### GnUUID.parse(uuid)
+
+Takes a uuid string like "b33e4b19-2399-56c8-9dd3-eff79f221d2f" and returns an
+instance of GnUUID::UUID class. It can parse any UUID, not only version 5
+
+```ruby
+uuid = GnUUID.parse("b33e4b19-2399-56c8-9dd3-eff79f221d2f")
+uuid.inspect
+# output: urn:uuid:b33e4b19-2399-56c8-9dd3-eff79f221d2f
+```
+Development
+-----------
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake rspec` 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/GlobalNamesArchitecture/gn_uuid.
+
+Acknowledgement
+---------------
+
+This gem heavily borrowed ideas and code from [Urabe Shyouhei's][shyouhei]
+[ruby-uuid gem][uuidgem]
+
+Copyright
+---------
+
+The gem is available as open source under the terms of the [MIT License][mit].
+
+Author -- [Dmitry Mozzherin][dimus]
+
+Copyright (c) 2015 [Marine Biological Laboratory][mbl].
+
+[gem_badge]: https://badge.fury.io/rb/gn_uuid.svg
+[gem_link]: http://badge.fury.io/rb/gn_uuid
+[ci_badge]: https://secure.travis-ci.org/GlobalNamesArchitecture/gn_uuid.svg
+[ci_link]: http://travis-ci.org/GlobalNamesArchitecture/gn_uuid
+[cov_badge]: https://coveralls.io/repos/GlobalNamesArchitecture/gn_uuid/badge.svg?branch=master
+[cov_link]: https://coveralls.io/r/GlobalNamesArchitecture/gn_uuid?branch=master
+[code_badge]: https://codeclimate.com/github/GlobalNamesArchitecture/gn_uuid/badges/gpa.svg
+[code_link]: https://codeclimate.com/github/GlobalNamesArchitecture/gn_uuid
+[dep_badge]: https://gemnasium.com/GlobalNamesArchitecture/gn_uuid.png
+[dep_link]: https://gemnasium.com/GlobalNamesArchitecture/gn_uuid
+[rfc]: https://www.ietf.org/rfc/rfc4122.txt
+[mit]: http://opensource.org/licenses/MIT
+[shyouhei]: https://github.com/shyouhei
+[uuidgem]: https://github.com/shyouhei/ruby-uuid
+[dimus]: https://github.com/dimus
+[mbl]: http://mbl.edu

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:rspec)
+
+RuboCop::RakeTask.new
+
+task default: [:rubocop, :rspec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gn_uuid"
+
+# 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

data/bin/setup

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

data/gn_uuid.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "gn_uuid/version"
+
+Gem::Specification.new do |gem|
+  gem.name          = "gn_uuid"
+  gem.version       = GnUUID::VERSION
+  gem.authors       = ["Dmitry Mozzherin"]
+  gem.email         = ["dmozzherin@gmail.com"]
+
+  gem.summary       = "Creates UUID v5 with DNS:globalnames.org namespace"
+  gem.description   = "Creates UUID version 5 out of scientific name " \
+                      "string. It uses globalnames.org domain for DNS " \
+                      "namespace. There is a 1:1 relationship between the " \
+                      "string and the corresponding UUID, so it allows " \
+                      "globally connect data about a name string originated " \
+                      "from independent sources without a need to negotiate " \
+                      "identifiers."
+  gem.homepage      = "https://github.com/GlobalNamesArchitecture/gn_uuid"
+  gem.license       = "MIT"
+  gem.required_ruby_version = ">= 1.9"
+
+  gem.files         = `git ls-files -z`.split("\x0").
+    reject { |f| f.match(%r{^(test|spec|features)/}) }
+  gem.bindir        = "exe"
+  gem.executables   = gem.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "bundler", "~> 1.7"
+  gem.add_development_dependency "rake", "~> 10.4"
+  gem.add_development_dependency "rspec", "~> 3.2"
+  gem.add_development_dependency "rubocop", "~> 0.31"
+  gem.add_development_dependency "coveralls", "~> 0.8"
+end

data/lib/gn_uuid.rb

@@ -0,0 +1,32 @@
+require "digest/sha1"
+require "gn_uuid/version"
+require "gn_uuid/uuid"
+
+# UUID version 5 with DNS|globalnames.org namespace
+module GnUUID
+  GN_NAMESPACE = "\x90\x18\x11\x96\xFE\xCFP\x82\xA4\xC1A\x1DO1L\xDA"
+
+  class << self
+    def uuid(str, guid = true)
+      sha1 = Digest::SHA1.new
+      sha1.update(GN_NAMESPACE)
+      sha1.update(str)
+      res = GnUUID::UUID.new(stamp_v5(sha1.digest[0..15]))
+      guid ? res.to_s : res
+    end
+
+    def parse(obj)
+      str = obj.to_s.gsub(/\Aurn:uuid:/, "")
+      str.gsub!(/[^0-9A-Fa-f]/, "")
+      GnUUID::UUID.new([str[0..31]].pack("H*"))
+    end
+
+    private
+
+    def stamp_v5(str)
+      str[6] = (str[6].ord & 0b1111 | 0b101_0000).chr
+      str[8] = (str[8].ord & 0b11_1111 | 0b1000_0000).chr
+      str
+    end
+  end
+end

data/lib/gn_uuid/uuid.rb

@@ -0,0 +1,33 @@
+module GnUUID
+  # handles UUID byte string and it's conversion  to different format
+  # NOTE: this is a general UUID class which is not limited to only v5
+  class UUID
+    attr_reader :bytes
+
+    def initialize(bytes)
+      @bytes = bytes
+      @ary = @bytes.unpack("C*")
+    end
+
+    def to_s
+      return @str if @str
+      fmt = "%02x%02x%02x%02x-%02x%02x-%02x%02x-%02x%02x-" \
+            "%02x%02x%02x%02x%02x%02x"
+      @str = fmt % @ary
+    end
+
+    def to_i
+      @num ||= @ary.inject(0) { |a, e| a << 8 | e }
+    end
+
+    def to_uri
+      "urn:uuid:" + to_s
+    end
+
+    alias_method :inspect, :to_uri
+
+    def version
+      @ary[6] >> 4
+    end
+  end
+end

data/lib/gn_uuid/version.rb

@@ -0,0 +1,8 @@
+# UUID version 5 with DNS|globalnames.org namespace
+module GnUUID
+  VERSION = "0.5.0"
+
+  def self.version
+    VERSION
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: gn_uuid
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Dmitry Mozzherin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.31'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.31'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Creates UUID version 5 out of scientific name string. It uses globalnames.org
+  domain for DNS namespace. There is a 1:1 relationship between the string and the
+  corresponding UUID, so it allows globally connect data about a name string originated
+  from independent sources without a need to negotiate identifiers.
+email:
+- dmozzherin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gn_uuid.gemspec
+- lib/gn_uuid.rb
+- lib/gn_uuid/uuid.rb
+- lib/gn_uuid/version.rb
+homepage: https://github.com/GlobalNamesArchitecture/gn_uuid
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.3
+signing_key: 
+specification_version: 4
+summary: Creates UUID v5 with DNS:globalnames.org namespace
+test_files: []