salesforce_id_formatter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 62b7e82d6f655aa0ef4f30f2c96e2626c4f3a63c
+  data.tar.gz: 90ea7d900623067fb302d6dc1e55461dd214cf13
+SHA512:
+  metadata.gz: 4bccfb2a208be53db1113b9f49e297fef24d68c31d60945c55832c3738eeee36d6525c193e8b0ee336c536dffa8ff978cfd18be1c2bc24884587e499a630c3e2
+  data.tar.gz: d2759cdcc2e05afd28d3d38b0ffbd038f97055d2f280819f877701c4e53fad25e7375e29acc28840a7984d852889ed6e31d4346699d079e465dd5aa9afc0bd3a

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.6
+  - 2.2.1

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in salesforce_id_formatter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Raul Murciano
+
+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,47 @@
+Salesforce originally used case-sensitive 15-character alphanumeric IDs.
+Later on, added three error-correcting characters to make their 18-character ID.
+
+## Usage
+
+`SalesforceIdFormatter.to_18`:
+
+- Converts a 15-char String to its equivalent 18-char ID as a String: `SalesforceIdFormatter.to_18('70130000001tcyI')  # =>  '70130000001tcyIAAQ'``
+- Leaves a 18-char String unaltered: `SalesforceIdFormatter.to_18('70130000001tcyIAAQ') # =>  '70130000001tcyIAAQ'`
+- Raises `SalesforceIdFormatter::InvalidId` if the given ID doesn't follow Salesforce's conventions
+  http://www.salesforce.com/us/developer/docs/api/Content/field_types.htm#i1435616
+  TL;DR: 15 or 18 alphanumeric, case-sensitive chars
+
+`SalesforceIdFormatter.to_15` applies the same rules, returning 15-char IDs instead.
+
+Code is a modified version of https://gist.github.com/jbaylor-rpx/2691624
+(original does seemt to calculate control digits correctly)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'salesforce_id_formatter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install salesforce_id_formatter
+
+## 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]/salesforce_id_formatter/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,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+end
+
+task :default => :test

data/bin/console

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

@@ -0,0 +1,54 @@
+require "salesforce_id_formatter/version"
+
+module SalesforceIdFormatter
+  extend self
+
+  InvalidId = Class.new(StandardError)
+
+  def to_18(id)
+    raise InvalidId unless valid_id?(id)
+
+    id.size == 15 ? convert_15_to_18(id) : id
+  end
+
+  def to_15(id)
+    raise InvalidId unless valid_id?(id)
+
+    id.size == 18 ? id[0..14] : id
+  end
+
+  def valid_id?(id)
+    [15, 18].include?(id.size) && id.match(/[^a-zA-Z0-9]/).nil?
+  end
+
+  private
+
+  def decimal_to_base_32(dec)
+    Array(base32.rassoc(dec)).first
+  end
+
+  def base32
+    @@b32 ||= begin
+      hash = {}
+      ('A'..'Z').each_with_index {|letter, idx| hash[letter] = idx }
+      ('0'..'5').each_with_index {|digit, idx|  hash[digit]  = idx + 26 }
+      hash
+    end
+  end
+
+  def is_upper?(char)
+    !(char =~ /[A-Z]/).nil?
+  end
+
+  # Algorithm http://salesforce.stackexchange.com/questions/1653/what-are-salesforce-ids-composed-of
+  def convert_15_to_18(str)
+    bits = str.split('').map{ |char| is_upper?(char) ? '1' : '0' }
+    checkdigits = [
+      bits[0..4].join.reverse.to_i(2),
+      bits[5..9].join.reverse.to_i(2),
+      bits[10..14].join.reverse.to_i(2)
+    ]
+    checkdigits = checkdigits.map {|d| decimal_to_base_32(d) }.join
+    str + checkdigits
+  end
+end

data/lib/salesforce_id_formatter/version.rb

@@ -0,0 +1,3 @@
+module SalesforceIdFormatter
+  VERSION = "1.0.0"
+end

data/salesforce_id_formatter.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'salesforce_id_formatter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "salesforce_id_formatter"
+  spec.version       = SalesforceIdFormatter::VERSION
+  spec.authors       = ["Raul Murciano"]
+  spec.email         = ["raul@heroku.com"]
+
+  spec.summary       = %q{Formats Salesforce IDs}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/heroku/salesforce_id_formatter"
+  spec.license       = "MIT"
+
+  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.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: salesforce_id_formatter
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Raul Murciano
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: minitest
+  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: ''
+email:
+- raul@heroku.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/salesforce_id_formatter.rb
+- lib/salesforce_id_formatter/version.rb
+- salesforce_id_formatter.gemspec
+homepage: https://github.com/heroku/salesforce_id_formatter
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Formats Salesforce IDs
+test_files: []