salesforce_id 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4898a0b33f8f54372cff05bd0b65c0705c544a8c
+  data.tar.gz: c9f1d80e51b4229bc9bd636fb5a684c050494cf6
+SHA512:
+  metadata.gz: 4b6885c6be43f1ead7dc991a006278faaad1968b734324eed060b13f9801f7ca8868ca8602735fb1a7c5992b9772a50426d0d8ab96e7c32aae11ff49086b4f88
+  data.tar.gz: fe2d8cab75769f2eba6f618a9ab9072e09e3c8938a6d4f633ef5a338afa8926cff19e0e6ff25d7ed6748bb60b6434d06926f73a740bab010ab8e5b7325ddd444

data/.gitignore

@@ -0,0 +1,30 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+
+.project
+.directory
+*.swp
+*~
+.DS_Store
+.idea
+.envrc
+.nvmrc
+.ruby-gemset
+.ruby-version
+.rspec-local
+*.backup
+npm-debug.log
+
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.2
+  - 2.2.1
+before_install: gem install bundler -v 1.10.6
+cache: bundler

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in salesforce_id.gemspec
+gemspec
+
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Fire-Dragon-DoL
+
+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,86 @@
+# SalesforceId [![Build Status](https://api.travis-ci.org/plataformatec/devise.svg?branch=master)](https://travis-ci.org/Fire-Dragon-DoL/salesforce_id.svg?branch=master) [![Code Climate](https://codeclimate.com/github/Fire-Dragon-DoL/salesforce_id/badges/gpa.svg)](https://codeclimate.com/github/Fire-Dragon-DoL/salesforce_id) [![Test Coverage](https://codeclimate.com/github/Fire-Dragon-DoL/salesforce_id/badges/coverage.svg)](https://codeclimate.com/github/Fire-Dragon-DoL/salesforce_id/coverage)
+
+Gem to properly convert from and to 15 characters case sensitive format and
+18 characters case insensitive format for salesforce record ID.
+
+It's implemented as a C library to make the conversion as fast and performant
+as possible.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'salesforce_id'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install salesforce_id
+
+## Usage
+
+The gem can be used as easily as:
+
+```ruby
+id15 = "003G000001SUbc4"
+id18 = "003G000001SUbc4IAD"
+
+# Convert to insensitive id, 18 characters
+SalesforceId.to_insensitive(id15) == id18 # => true
+
+# Convert to sensitive id, 15 characters
+SalesforceId.to_sensitive(id18) == id15 # => true
+
+# Check if salesforce id is valid
+SalesforceId.valid?(id15)  # => true
+SalesforceId.valid?(id18)  # => true
+SalesforceId.valid?("foo") # => false
+
+# Fixes casing for case-insensitive ids
+SalesforceId.repair_casing(id18.downcase) == id18 # => true
+
+# Check if id is case-sensitive format
+SalesforceId.sensitive?(id15) # => true
+SalesforceId.sensitive?(id18) # => false
+SalesforceId.sensitive?(nil)  # => false
+
+# Check if id is case-insensitive format
+SalesforceId.insensitive?(id18) # => true
+SalesforceId.insensitive?(id15) # => false
+SalesforceId.insensitive?(nil)  # => false
+```
+
+## Documentation
+
+Methods are documented in [salesforce_id_ext.h](https://github.com/Fire-Dragon-DoL/salesforce_id/blob/master/ext/salesforce_id/salesforce_id_ext.h), this file is
+the only public API of the gem, everything else must be considered private.
+
+## Links
+
+Some useful links related to this Salesforce ID issue:
+
+- [What are salesforce ids composed of](http://salesforce.stackexchange.com/questions/1653/what-are-salesforce-ids-composed-of)
+- [How I can view 18 characters long Salesforce ID in reports?](https://success.salesforce.com/answers?id=90630000000gy8oAAA)
+- [Why does 18-character ID casing matter in a SOQL WHERE clause?](http://salesforce.stackexchange.com/questions/50163/why-does-18-character-id-casing-matter-in-a-soql-where-clause)
+- [Creating a link using an 18 character ID](http://salesforce.stackexchange.com/questions/9568/creating-a-link-using-an-18-character-id/9569#9569)
+
+## 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/Fire-Dragon-DoL/salesforce_id.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => [:compile, :spec]
+require "rake/extensiontask"
+
+task :build => :compile
+
+Rake::ExtensionTask.new("salesforce_id") do |ext|
+  ext.lib_dir = "lib/salesforce_id"
+end

data/bin/bundler

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'bundler' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('bundler', 'bundler')

data/bin/byebug

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'byebug' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('byebug', 'byebug')

data/bin/cc-tddium-post-worker

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'cc-tddium-post-worker' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('codeclimate-test-reporter', 'cc-tddium-post-worker')

data/bin/coderay

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'coderay' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('coderay', 'coderay')

data/bin/console

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

data/bin/htmldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'htmldiff')

data/bin/ldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'ldiff')

data/bin/pry

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'pry' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('pry', 'pry')

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rake-compiler

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake-compiler' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake-compiler', 'rake-compiler')

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

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/ext/salesforce_id/charmap.c

@@ -0,0 +1,17 @@
+#include "charmap.h"
+#include <ctype.h>
+
+const char CHARMAP[CHARMAP_SIZE] = {
+  'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P',
+  'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z', '0', '1', '2', '3', '4', '5'
+};
+
+int charmap_index(const char character)
+{
+  char upped = toupper(character);
+
+  for (int index = 0; index < CHARMAP_SIZE; ++index)
+    if (CHARMAP[index] == upped) return index;
+
+  return (-1);
+}

data/ext/salesforce_id/charmap.h

@@ -0,0 +1,10 @@
+#ifndef CHARMAP_H
+#define CHARMAP_H 1
+
+#define CHARMAP_SIZE 32
+
+extern const char CHARMAP[CHARMAP_SIZE];
+
+int charmap_index(const char character);
+
+#endif /* CHARMAP_H */

data/ext/salesforce_id/extconf.rb

@@ -0,0 +1,5 @@
+require "mkmf"
+
+$CFLAGS += " -std=c99"
+
+create_makefile("salesforce_id/salesforce_id")

data/ext/salesforce_id/insensitive_to_sensitive.c

@@ -0,0 +1,19 @@
+#include "insensitive_to_sensitive.h"
+#include "ruby.h"
+#include <string.h>
+#include "salesforce_id_ext.h"
+#include "repair_casing.h"
+
+// rb_sId MUST be a string and of size 18
+VALUE insensitive_to_sensitive(VALUE rb_sId)
+{
+  const int   new_id_size = SALESFORCE_ID_INSENSITIVE_STRING_LENGTH;
+        char* id          = StringValueCStr(rb_sId);
+        char  new_id[SALESFORCE_ID_INSENSITIVE_STRING_LENGTH] = {0};
+
+  memcpy(new_id, id, new_id_size);
+  repair_casing(new_id);
+  memset(&new_id[15], '\0', sizeof(new_id[0]) * 4u);
+
+  return rb_str_new2(new_id);
+}

data/ext/salesforce_id/insensitive_to_sensitive.h

@@ -0,0 +1,8 @@
+#ifndef INSENSITIVE_TO_SENSITIVE_H
+#define INSENSITIVE_TO_SENSITIVE_H 1
+
+#include "ruby.h"
+
+VALUE insensitive_to_sensitive(VALUE rb_sId);
+
+#endif /* INSENSITIVE_TO_SENSITIVE_H */

data/ext/salesforce_id/repair_casing.c

@@ -0,0 +1,49 @@
+#include "repair_casing.h"
+#include "ruby.h"
+#include <stddef.h>
+#include <string.h>
+#include <ctype.h>
+#include <stdbool.h>
+#include "salesforce_id_ext.h"
+#include "charmap.h"
+
+static void chunk_casing(const char character, bool* casing);
+
+void repair_casing(char* id)
+{
+  const int    chunk_index = SALESFORCE_ID_SENSITIVE_LENGTH;
+  const size_t casing_size = (size_t)SALESFORCE_ID_SENSITIVE_LENGTH;
+        bool   casing[SALESFORCE_ID_SENSITIVE_LENGTH] = {false};
+
+  chunk_casing(id[chunk_index], casing);
+  chunk_casing(id[chunk_index + 1], &casing[5]);
+  chunk_casing(id[chunk_index + 2], &casing[10]);
+
+  for (size_t index = 0u; index < casing_size; ++index)
+  {
+    if (casing[index])
+      id[index] = toupper(id[index]);
+    else
+      id[index] = tolower(id[index]);
+  }
+
+  id[chunk_index]     = toupper(id[chunk_index]);
+  id[chunk_index + 1] = toupper(id[chunk_index]);
+  id[chunk_index + 2] = toupper(id[chunk_index]);
+}
+
+// Casing is an array of size 5
+void chunk_casing(const char character, bool* casing)
+{
+  const size_t casing_size = 5u;
+        int    map_index   = charmap_index(character);
+
+  if (map_index < 0)
+  {
+    rb_raise(rb_eArgError, "Salesforce ID contains invalid character");
+    return;
+  }
+
+  for (size_t bit_index = 0u; bit_index < casing_size; ++bit_index)
+    casing[bit_index] = (map_index & (1u << bit_index)) != 0u;
+}

data/ext/salesforce_id/repair_casing.h

@@ -0,0 +1,6 @@
+#ifndef REPAIR_CASING_H
+#define REPAIR_CASING_H 1
+
+void repair_casing(char* id);
+
+#endif /* REPAIR_CASING_H */

data/ext/salesforce_id/salesforce_id_ext.c

@@ -0,0 +1,151 @@
+#include "salesforce_id_ext.h"
+#include <string.h>
+#include <ctype.h>
+#include <stddef.h>
+#include "repair_casing.h"
+#include "insensitive_to_sensitive.h"
+#include "sensitive_to_insensitive.h"
+#include "validate_id.h"
+
+VALUE rb_mSalesforceId;
+
+void Init_salesforce_id()
+{
+  // Module
+  rb_mSalesforceId = rb_define_module("SalesforceId");
+
+  // Constants
+  rb_define_const(
+    rb_mSalesforceId,
+    "SENSITIVE_SIZE",
+    INT2FIX(SALESFORCE_ID_SENSITIVE_LENGTH)
+  );
+  rb_define_const(
+    rb_mSalesforceId,
+    "INSENSITIVE_SIZE",
+    INT2FIX(SALESFORCE_ID_INSENSITIVE_LENGTH)
+  );
+
+  // Methods
+  rb_define_method(
+    rb_mSalesforceId,
+    "to_sensitive",
+    salesforce_id_to_sensitive,
+    1
+  );
+  rb_define_method(
+    rb_mSalesforceId,
+    "to_insensitive",
+    salesforce_id_to_insensitive,
+    1
+  );
+  rb_define_method(
+    rb_mSalesforceId,
+    "valid?",
+    salesforce_id_is_valid,
+    1
+  );
+  rb_define_method(
+    rb_mSalesforceId,
+    "repair_casing",
+    salesforce_insensitive_repair_casing,
+    1
+  );
+  rb_define_method(
+    rb_mSalesforceId,
+    "sensitive?",
+    salesforce_id_is_sensitive,
+    1
+  );
+  rb_define_method(
+    rb_mSalesforceId,
+    "insensitive?",
+    salesforce_id_is_insensitive,
+    1
+  );
+}
+
+// Convert to 15 character case-sensitive id
+VALUE salesforce_id_to_sensitive(VALUE self, VALUE rb_sId)
+{
+  VALUE id = rb_obj_as_string(rb_sId);
+
+  if (!is_id_valid(id))
+  {
+    rb_raise(rb_eArgError, "Invalid Salesforce ID");
+    return Qnil;
+  }
+
+  if (RSTRING_LEN(id) == SALESFORCE_ID_SENSITIVE_LENGTH) return id;
+
+  return insensitive_to_sensitive(id);
+}
+
+// Convert to 18 character case-insensitive id
+VALUE salesforce_id_to_insensitive(VALUE self, VALUE rb_sId)
+{
+  VALUE id = rb_obj_as_string(rb_sId);
+
+  if (!is_id_valid(id))
+  {
+    rb_raise(rb_eArgError, "Invalid Salesforce ID");
+    return Qnil;
+  }
+
+  if (RSTRING_LEN(id) == SALESFORCE_ID_INSENSITIVE_LENGTH) return id;
+
+  return sensitive_to_insensitive(id);
+}
+
+VALUE salesforce_id_is_valid(VALUE self, VALUE rb_sId)
+{
+  VALUE id = rb_obj_as_string(rb_sId);
+
+  if (is_id_valid(id)) return Qtrue;
+
+  return Qfalse;
+}
+
+VALUE salesforce_insensitive_repair_casing(VALUE self, VALUE rb_sId)
+{
+  VALUE id = rb_obj_as_string(rb_sId);
+
+  if (!is_id_valid(id) || RSTRING_LEN(id) != SALESFORCE_ID_INSENSITIVE_LENGTH)
+    rb_raise(rb_eArgError, "Salesforce ID is not case-insensitive format");
+
+  // Start for insensitive characters
+  const size_t istart          = (size_t)SALESFORCE_ID_SENSITIVE_LENGTH;
+  const size_t sensitive_chars = 3u;
+  const int    new_id_size     = SALESFORCE_ID_INSENSITIVE_STRING_LENGTH;
+        char*  old_id          = StringValueCStr(id);
+        char   new_id[SALESFORCE_ID_INSENSITIVE_STRING_LENGTH] = {0};
+
+  memcpy(new_id, old_id, new_id_size);
+  repair_casing(new_id);
+  memcpy(&new_id[istart], &old_id[istart], sizeof(new_id[0]) * sensitive_chars);
+
+  for (size_t index = 0u; index < sensitive_chars; ++index)
+    new_id[istart + index] = toupper(new_id[istart + index]);
+
+  return rb_str_new2(new_id);
+}
+
+VALUE salesforce_id_is_sensitive(VALUE self, VALUE rb_sId)
+{
+  VALUE id = rb_obj_as_string(rb_sId);
+
+  if (is_id_valid(id) && (RSTRING_LEN(id) == SALESFORCE_ID_SENSITIVE_LENGTH))
+    return Qtrue;
+
+  return Qfalse;
+}
+
+VALUE salesforce_id_is_insensitive(VALUE self, VALUE rb_sId)
+{
+  VALUE id = rb_obj_as_string(rb_sId);
+
+  if (is_id_valid(id) && (RSTRING_LEN(id) == SALESFORCE_ID_INSENSITIVE_LENGTH))
+    return Qtrue;
+
+  return Qfalse;
+}

data/ext/salesforce_id/salesforce_id_ext.h

@@ -0,0 +1,67 @@
+#ifndef SALESFORCE_ID_H
+#define SALESFORCE_ID_H 1
+
+#include "ruby.h"
+
+extern VALUE rb_mSalesforceId;
+
+#define SALESFORCE_ID_SENSITIVE_LENGTH          15
+#define SALESFORCE_ID_INSENSITIVE_LENGTH        18
+#define SALESFORCE_ID_SENSITIVE_STRING_LENGTH   16
+#define SALESFORCE_ID_INSENSITIVE_STRING_LENGTH 19
+
+/*
+ * Entry point
+ */
+void Init_salesforce_id();
+
+/*
+ * Converts any valid salesforce ID to case-sensitive version. Raises
+ * ArgumentError if ID contains invalid characters or it's not correct length
+ * @param rb_sId [String] valid salesforce id
+ * @return [String] salesforce id in case-sensitive version
+ */
+VALUE salesforce_id_to_sensitive(VALUE self, VALUE rb_sId);
+
+/*
+ * Converts any valid salesforce ID to case-insensitive version. Raises
+ * ArgumentError if ID contains invalid characters or it's not correct length
+ * @param rb_sId [String] valid salesforce id
+ * @return [String] salesforce id in case-insensitive version
+ */
+VALUE salesforce_id_to_insensitive(VALUE self, VALUE rb_sId);
+
+/*
+ * Performs a deep check of the ID ensuring characters are all valid and length
+ * is valid too
+ * @param rb_sId [String] salesforce id (valid or not)
+ * @return [Boolean] true if the deep check has success and salesforce id is
+ *   valid
+ */
+VALUE salesforce_id_is_valid(VALUE self, VALUE rb_sId);
+
+/*
+ * Fixes a valid case-insensitive salesforce id casing by using the last 3
+ * letters
+ * @param rb_sId [String] valid salesforce id in case-insensitive format
+ * @return [String] case-insensitive salesforce id with casing fixed, which
+ *   means you can strip the last 3 characters to obtain the case-sensitive
+ *   format
+ */
+VALUE salesforce_insensitive_repair_casing(VALUE self, VALUE rb_sId);
+
+/*
+ * Detects if given ID is case-sensitive
+ * @param rb_sId [String] salesforce id (valid or not)
+ * @return [Boolean] true if passed ID is valid case-sensitive salesforce ID
+ */
+VALUE salesforce_id_is_sensitive(VALUE self, VALUE rb_sId);
+
+/*
+ * Detects if given ID is case-insensitive
+ * @param rb_sId [String] salesforce id (valid or not)
+ * @return [Boolean] true if passed ID is valid case-insensitive salesforce ID
+ */
+VALUE salesforce_id_is_insensitive(VALUE self, VALUE rb_sId);
+
+#endif /* SALESFORCE_ID_H */

data/ext/salesforce_id/sensitive_to_insensitive.c

@@ -0,0 +1,54 @@
+#include "sensitive_to_insensitive.h"
+#include "ruby.h"
+#include <stddef.h>
+#include <string.h>
+#include <stdint.h>
+#include <ctype.h>
+#include "salesforce_id_ext.h"
+#include "charmap.h"
+
+static void append_casing_hash(char* id);
+static char char_from_chunk(char* id, size_t chunk);
+
+// rb_sId MUST be a string and of size 15
+VALUE sensitive_to_insensitive(VALUE rb_sId)
+{
+  const int   id_size = SALESFORCE_ID_SENSITIVE_STRING_LENGTH;
+        char* id      = StringValueCStr(rb_sId);
+        char  new_id[SALESFORCE_ID_INSENSITIVE_STRING_LENGTH] = {0};
+
+  memcpy(new_id, id, sizeof(char) * id_size);
+  append_casing_hash(new_id);
+
+  return rb_str_new2(new_id);
+}
+
+void append_casing_hash(char* id)
+{
+  const int    insensitive_index = SALESFORCE_ID_SENSITIVE_LENGTH;
+  const size_t chunks            = 3u;
+        char   hash[3]           = {'\0', '\0', '\0'};
+
+  for (size_t chunk = 0u; chunk < chunks; ++chunk)
+    hash[chunk] = char_from_chunk(id, chunk);
+
+  id[insensitive_index]     = hash[0];
+  id[insensitive_index + 1] = hash[1];
+  id[insensitive_index + 2] = hash[2];
+}
+
+// Chunk must be within 0 and 2
+char char_from_chunk(char* id, size_t chunk)
+{
+  const size_t  chars_per_chunk = 5u;
+        uint8_t map_index       = 0u;
+
+  for (size_t index = 0u; index < chars_per_chunk; ++index)
+  {
+    char current = id[(chars_per_chunk * chunk) + index];
+
+    if (isupper(current)) map_index = (map_index | (1u << index));
+  }
+
+  return CHARMAP[map_index];
+}

data/ext/salesforce_id/sensitive_to_insensitive.h

@@ -0,0 +1,8 @@
+#ifndef SENSITIVE_TO_INSENSITIVE_H
+#define SENSITIVE_TO_INSENSITIVE_H 1
+
+#include "ruby.h"
+
+VALUE sensitive_to_insensitive(VALUE rb_sId);
+
+#endif /* SENSITIVE_TO_INSENSITIVE_H */

data/ext/salesforce_id/validate_id.c

@@ -0,0 +1,18 @@
+#include "validate_id.h"
+#include "ruby.h"
+#include <stdbool.h>
+#include <string.h>
+#include <stddef.h>
+#include "salesforce_id_ext.h"
+#include "charmap.h"
+
+// rb_sId MUST be a string
+bool is_id_valid(VALUE rb_sId)
+{
+  VALUE id = rb_sId;
+
+  if (RSTRING_LEN(id) == SALESFORCE_ID_SENSITIVE_LENGTH)   return true;
+  if (RSTRING_LEN(id) == SALESFORCE_ID_INSENSITIVE_LENGTH) return true;
+
+  return false;
+}

data/ext/salesforce_id/validate_id.h

@@ -0,0 +1,11 @@
+#ifndef VALIDATE_SALESFORCE_ID_H
+#define VALIDATE_SALESFORCE_ID_H 1
+
+#include "ruby.h"
+#include <stdbool.h>
+
+bool is_id_valid(VALUE rb_sId);
+
+#endif /* VALIDATE_SALESFORCE_ID_H */
+
+

data/lib/salesforce_id/version.rb

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

data/lib/salesforce_id.rb

@@ -0,0 +1,6 @@
+require 'salesforce_id/version'
+require 'salesforce_id/salesforce_id'
+
+module SalesforceId
+  extend self
+end

data/salesforce_id.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'salesforce_id/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "salesforce_id"
+  spec.version       = SalesforceId::VERSION
+  spec.authors       = ["Fire-Dragon-DoL"]
+  spec.email         = ["francesco.belladonna@gmail.com"]
+
+  spec.summary       = %q{Gem to handle 15 characters and 18 characters salesforce IDs}
+  spec.description   = %q{Gem to properly convert from and to 15 characters case sensitive format and 18 characters case insensitive format for salesforce record ID}
+  spec.homepage      = "https://github.com/Fire-Dragon-DoL/salesforce_id"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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.extensions    = ["ext/salesforce_id/extconf.rb"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake-compiler"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "fuubar"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: salesforce_id
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Fire-Dragon-DoL
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-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.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: rake-compiler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: Gem to properly convert from and to 15 characters case sensitive format
+  and 18 characters case insensitive format for salesforce record ID
+email:
+- francesco.belladonna@gmail.com
+executables: []
+extensions:
+- ext/salesforce_id/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/bundler
+- bin/byebug
+- bin/cc-tddium-post-worker
+- bin/coderay
+- bin/console
+- bin/htmldiff
+- bin/ldiff
+- bin/pry
+- bin/rake
+- bin/rake-compiler
+- bin/rspec
+- bin/setup
+- ext/salesforce_id/charmap.c
+- ext/salesforce_id/charmap.h
+- ext/salesforce_id/extconf.rb
+- ext/salesforce_id/insensitive_to_sensitive.c
+- ext/salesforce_id/insensitive_to_sensitive.h
+- ext/salesforce_id/repair_casing.c
+- ext/salesforce_id/repair_casing.h
+- ext/salesforce_id/salesforce_id_ext.c
+- ext/salesforce_id/salesforce_id_ext.h
+- ext/salesforce_id/sensitive_to_insensitive.c
+- ext/salesforce_id/sensitive_to_insensitive.h
+- ext/salesforce_id/validate_id.c
+- ext/salesforce_id/validate_id.h
+- lib/salesforce_id.rb
+- lib/salesforce_id/version.rb
+- salesforce_id.gemspec
+homepage: https://github.com/Fire-Dragon-DoL/salesforce_id
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6
+signing_key: 
+specification_version: 4
+summary: Gem to handle 15 characters and 18 characters salesforce IDs
+test_files: []