restforce-db 4.0.5 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2080427a96e971dd5a7e51f37f1f92a37dfd67cc
-  data.tar.gz: 3bcb63d050a559cf47ffdc6ad782487b660be949
+  metadata.gz: 1dafd9fbdfa3ef1b8095e136a0491bca01cf3d73
+  data.tar.gz: 4d7c41b6ea229020fcc3886400053381bae6ba6f
 SHA512:
-  metadata.gz: 27e915cb12532a8c2734b932fca192f01187ecea0ea762fe67795784bf927a975f6c657fe1c9dff5586e7029b333dbbe22aa07983fa69bf55889290ad82f817d
-  data.tar.gz: 5683584abd9d6942b6b247f17210ffc00b651c38ca1afdecde053600fba506a821f85a0c64be9c06cee8389b2348f4e9dc55d7552fdb82fe2ee9782a16811092
+  metadata.gz: 38730782a910cc7fe92e45ea09d7dab57ac3b648246ff8a707ab84c5694394226bf32366f9250a386f3607a39a5d2813304ce3a79983949bcbc6ecd336db1f26
+  data.tar.gz: fc09fefbbe68a85c3a17bcd0967e657dcffec5d899d786127397909417e2c40596c9a3ca3de63368b87b6bcf75b2eb09a26f636900a26c85ef592eb5c4fb837b

data/lib/restforce/db.rb

@@ -54,6 +54,10 @@ module Restforce
   # by the other classes in this library.
   module DB
 
+    # Internal: A String containing the valid suffix Hash values for a
+    # Salesforce ID.
+    HASH_DICTIONARY = "ABCDEFGHIJKLMNOPQRSTUVWXYZ012345".freeze
+
     class << self
 
       attr_accessor :last_run
@@ -140,6 +144,28 @@ module Restforce
       @last_run = nil
     end
 
+    # Public: Get the hashed version of the passed salesforce ID. This will
+    # converts 15-digit Salesforce IDs to their corresponding 18-digit version.
+    # Returns any passed 18-digit IDs back, untouched.
+    #
+    # Returns a String.
+    # Raises an ArgumentError if the passed String is not 15 characters.
+    def self.hashed_id(salesforce_id)
+      return salesforce_id if salesforce_id.length == 18
+      raise ArgumentError, "The passed Salesforce ID must be 15 or 18 characters" unless salesforce_id.length == 15
+
+      suffixes = salesforce_id.scan(/.{5}/).map do |chunk|
+        flag = 0
+        chunk.split("").each_with_index do |char, idx|
+          flag += (1 << idx) if char >= "A" && char <= "Z"
+        end
+
+        HASH_DICTIONARY[flag]
+      end
+
+      salesforce_id + suffixes.join
+    end
+
   end
 
 end

data/lib/restforce/db/task_manager.rb

@@ -76,7 +76,7 @@ module Restforce
 
         true
       rescue Restforce::AuthenticationError => e
-        error(e)
+        log e, :warn
         raise e
       rescue => e
         error(e)

data/lib/restforce/db/version.rb

@@ -3,7 +3,7 @@ module Restforce
   # :nodoc:
   module DB
 
-    VERSION = "4.0.5"
+    VERSION = "4.1.0"
 
   end
 

data/lib/tasks/restforce.rake

@@ -48,19 +48,8 @@ namespace :restforce do
   desc "Get the 18-character version of a 15-character Salesforce ID"
   task :convertid, [:salesforce_id] do |_, args|
     sfid = args[:salesforce_id]
-
     raise ArgumentError, "Provide a Salesforce ID (restforce:convertid[<salesforce_id>])" if sfid.nil?
-    raise ArgumentError, "The passed Salesforce ID must be 15 characters" unless sfid.length == 15
-
-    suffixes = sfid.scan(/.{5}/).map do |chunk|
-      flag = 0
-      chunk.split("").each_with_index do |char, idx|
-        flag += (1 << idx) if char.upcase == char && char >= "A" && char <= "Z"
-      end
-
-      "ABCDEFGHIJKLMNOPQRSTUVWXYZ012345"[flag]
-    end
 
-    puts sfid + suffixes.join
+    puts Restforce::DB.hashed_id(sfid)
   end
 end

data/test/lib/restforce/db_test.rb

@@ -4,7 +4,7 @@ describe Restforce::DB do
 
   configure!
 
-  describe "#configure" do
+  describe ".configure" do
 
     it "yields a Configuration" do
       Restforce::DB.configure do |config|
@@ -13,7 +13,7 @@ describe Restforce::DB do
     end
   end
 
-  describe "#client" do
+  describe ".client" do
     before do
       Restforce::DB.configure do |config|
         config.adapter = :net_http
@@ -28,6 +28,26 @@ describe Restforce::DB do
     end
   end
 
+  describe ".hashed_id" do
+
+    it "returns an 18-character Salesforce ID untouched" do
+      expect(Restforce::DB.hashed_id("a001a000002zhZfAAI")).to_equal("a001a000002zhZfAAI")
+    end
+
+    it "generates a proper hash for a 15-character Salesforce ID" do
+      expect(Restforce::DB.hashed_id("aaaaaaaaaaaaaaa")).to_equal("aaaaaaaaaaaaaaaAAA")
+      expect(Restforce::DB.hashed_id("AaaAAAaaAAAaaAA")).to_equal("AaaAAAaaAAAaaAAZZZ")
+      expect(Restforce::DB.hashed_id("aAaAAaAaAAaAaAA")).to_equal("aAaAAaAaAAaAaAA000")
+      expect(Restforce::DB.hashed_id("AAAAAAAAAAAAAAA")).to_equal("AAAAAAAAAAAAAAA555")
+
+      expect(Restforce::DB.hashed_id("0063200001kSU3I")).to_equal("0063200001kSU3IAAW")
+    end
+
+    it "raises an ArgumentError if the passed String contains an invalid character count" do
+      expect { Restforce::DB.hashed_id("a001a000002zhZfA") }.to_raise(ArgumentError)
+    end
+  end
+
   describe "accessing Salesforce", :vcr do
 
     it "uses the configured credentials" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restforce-db
 version: !ruby/object:Gem::Version
-  version: 4.0.5
+  version: 4.1.0
 platform: ruby
 authors:
 - Andrew Horner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-23 00:00:00.000000000 Z
+date: 2015-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord