propertybase_id 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8643adb6124aba399189a527653bdcd28280a778
+  data.tar.gz: 76bd327742cfb04ee9e29befc306b91425b32347
+SHA512:
+  metadata.gz: 5298e1e086d89822a60397eb8c17b048e75d8ba8a9e9be46b44768105b01cefb0a8d07abb899056e3447be82b0f621472cedd1e6a6731f2cac07e878a4d4c26d
+  data.tar.gz: 874bdfc5ca289a7ea4c253ad9bc88ec1eab948b5e65f556d42e9fa307dadaade091a6cb00cf790b5b29cc2d8bb4607e29a02996a8779d5727afe98c1dcb4c9f1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+cache: bundler
+bundler_args: --without documentation production
+rvm:
+  - 2.0.0
+  - 2.1.5
+  - 2.2.0
+  - jruby-19mode
+  - rbx
+  - ruby-head
+  - jruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+  fast_finish: true
+script:
+  - bundle exec rspec
+before_install: gem update bundler

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem"s dependencies in propertybase_id.gemspec
+gemspec
+
+gem "guard"
+gem "guard-rspec"

data/Guardfile

@@ -0,0 +1,19 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Standard RubyGem Project
+  watch(/^spec\/.+_spec\.rb/)
+  watch(/^lib\/(.+)\.rb/)     { |m| "spec/#{m[1]}_spec.rb" }
+  watch("spec/spec_helper.rb")  { "spec" }
+end

data/README.md

@@ -0,0 +1,52 @@
+# PropertybaseId
+
+This gem can be utilized to create globally uniqu Propertybase IDs.
+
+## Installation
+
+Add this line to your application"s Gemfile:
+
+```ruby
+gem "propertybase_id"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install propertybase_id
+
+## Usage
+
+### Create
+
+    id = PropertybaseId.create(objectt: "team", server: 1)
+    => #<PropertybaseId:0x007fe855071a58 @_object_id=2, @local_random=738414242805187245, @object="team", @server=1>
+
+For string representation do:
+
+    id.to_s
+    => "02015lyq044bfuel"
+
+### Parsing
+
+To get a PropertybaseId object from a string representation do:
+
+    PropertybaseId.parse("02015lyq044bfuel")
+    => #<PropertybaseId:0x007f9943cb48a8 @_object_id=2, @local_random=738414242805187245, @object="team", @server=1>
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/propertybase_id/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am "Add some feature"`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "propertybase_id"
+
+# 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 "pry"
+Pry.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/lib/propertybase_id/data/objects.json

@@ -0,0 +1,4 @@
+{
+  "user": 1,
+  "team": 2
+}

data/lib/propertybase_id/generator.rb

@@ -0,0 +1,49 @@
+require "digest/sha1"
+
+class PropertybaseId
+  class Generator
+    def initialize
+      @counter = 0
+      @mutex = Mutex.new
+    end
+
+    def generate(object: )
+      @mutex.lock
+      begin
+        count = next_counter
+      ensure
+        @mutex.unlock rescue nil
+      end
+
+      PropertybaseId.new(
+        object: object,
+        host_id: host_id,
+        time: time,
+        process_id: process_id,
+        counter: count
+      )
+    end
+
+    private
+
+    def time
+      @_time ||= ::Time.now.to_i
+    end
+
+    def host_id
+      @_host_id ||= Digest::SHA1.hexdigest(Socket.gethostname).to_i(16) % max_value(2)
+    end
+
+    def next_counter
+      @counter = (@counter + 1) % max_value(3)
+    end
+
+    def process_id
+      "#{Process.pid}#{Thread.current.object_id}".hash % max_value(2)
+    end
+
+    def max_value(digits)
+      ("z" * digits).to_i(36) + 1
+    end
+  end
+end

data/lib/propertybase_id/local_random.rb

@@ -0,0 +1,23 @@
+class PropertybaseId
+  class LocalRandom
+    MAX_INTEGER = 10000
+    TIME_MULTIPLIER = 10000
+
+    attr_reader :time
+
+    def initialize(time=Time.now)
+      @time = time
+    end
+
+    def to_i
+      @_integer ||= begin
+        rand_int = SecureRandom.random_number(MAX_INTEGER)
+        max_digits = (MAX_INTEGER - 1).to_s.size
+        prefix = "%0#{max_digits}d" % rand_int
+        time_with_miliseconds = (time.to_f * TIME_MULTIPLIER).to_i
+
+        "#{prefix}#{time_with_miliseconds}".to_i
+      end
+    end
+  end
+end

data/lib/propertybase_id/mappings.rb

@@ -0,0 +1,19 @@
+require "json"
+
+class PropertybaseId
+  module Mappings
+    extend self
+
+    def objects
+      @_objects ||= begin
+        load_json_file("objects")
+      end
+    end
+
+    private
+
+    def load_json_file(name)
+      JSON.parse(File.read(File.expand_path('../data/objects.json', __FILE__)))
+    end
+  end
+end

data/lib/propertybase_id/version.rb

@@ -0,0 +1,3 @@
+class PropertybaseId
+  VERSION = "0.2.0"
+end

data/lib/propertybase_id.rb

@@ -0,0 +1,91 @@
+require "propertybase_id/version"
+require "propertybase_id/local_random"
+require "propertybase_id/generator"
+require "propertybase_id/mappings"
+
+class PropertybaseId
+  attr_reader :object
+  attr_reader :host_id
+  attr_reader :time
+  attr_reader :process_id
+  attr_reader :counter
+
+  def initialize(object:, host_id:, time:, process_id:, counter:)
+    @object = object && object.dup.freeze
+    @host_id = host_id
+    @time = time
+    @process_id = process_id
+    @counter = counter
+    validate!
+  end
+
+  def to_s
+    @_string ||= begin
+      object_str = format_number(@object_id, 3)
+      host_str = format_number(@host_id, 2)
+      time_str = format_number(@time, 6)
+      process_str = format_number(@process_id, 2)
+      counter_str = format_number(@counter, 3)
+
+      "#{object_str}#{host_str}#{time_str}#{process_str}#{counter_str}"
+    end
+  end
+
+  def ==(o)
+    self.class == o.class &&
+    self.object == o.object &&
+    self.host_id == o.host_id &&
+    self.process_id == o.process_id &&
+    self.time == o.time &&
+    self.counter == o.counter
+  end
+
+  alias_method :eql?, :==
+
+  def hash
+    [
+      @object_id,
+      @host_id,
+      @time,
+      @process_id,
+      @counter,
+    ].hash
+  end
+
+  def self.generate(object:)
+    @_generator ||= begin
+      PropertybaseId::Generator.new
+    end
+    @_generator.generate(object: object)
+  end
+
+  def self.parse(input_id)
+    raise ArgumentError, "invalid length (#{input_id.size})" if input_id.size != 16
+
+    _, object_id, host_id, time, process_id, counter = input_id.match(/(\w{3})(\w{2})(\w{6})(\w{2})(\w{3})/).to_a
+
+    object, _ = PropertybaseId::Mappings.objects.select{|_, v| v == object_id.to_i(36) }.first
+
+    raise ArgumentError, "No object to id #{object_id}" if object.nil?
+
+    new(
+      object: object,
+      host_id: host_id.to_i(36),
+      time: time.to_i(36),
+      process_id: process_id.to_i(36),
+      counter: counter.to_i(36),
+    )
+  end
+
+  private
+
+  def validate!
+    @object_id ||= PropertybaseId::Mappings.objects.fetch(object) do
+      raise ArgumentError, "Object #{object.inspect} not found"
+    end
+  end
+
+  def format_number(integer, length)
+    integer.to_s(36).rjust(length, "0")
+  end
+end

data/propertybase_id.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "propertybase_id/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "propertybase_id"
+  spec.version       = PropertybaseId::VERSION
+  spec.authors       = ["Leif Gensert"]
+  spec.email         = ["leif@propertybase.com"]
+
+  spec.summary       = %q{Gem for creating Propertybase compatible IDs}
+  spec.description   = %q{This gem lets you create IDs in the Propertybase universe. Still under heavy development}
+  spec.homepage      = "http://www.propertybase.com"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: propertybase_id
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Leif Gensert
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem lets you create IDs in the Propertybase universe. Still under
+  heavy development
+email:
+- leif@propertybase.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/propertybase_id.rb
+- lib/propertybase_id/data/objects.json
+- lib/propertybase_id/generator.rb
+- lib/propertybase_id/local_random.rb
+- lib/propertybase_id/mappings.rb
+- lib/propertybase_id/version.rb
+- propertybase_id.gemspec
+homepage: http://www.propertybase.com
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Gem for creating Propertybase compatible IDs
+test_files: []