SFDO-API 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a889210734dd667c332c1a2b6cc9c2e614f7b96e
-  data.tar.gz: bc0172a50528c4c7aa20ec670d8336227868640f
+  metadata.gz: c627cf05d223498b3612c2c9c152f183f422e8f1
+  data.tar.gz: ee2535a593751055205437893ee947279bc05171
 SHA512:
-  metadata.gz: 6fc1612e504e920b02d7a65a1b1456b1efccf524c3e63048791a1c04a06be25cc1a48ebc643242f114a204d286ddff53adf84a73bc0bc2307f4663bbc346e1c1
-  data.tar.gz: 5ef960b4d79bd44d37384955516412c85fd92d6d03e63d53a4c806ec6d2d48b4cd2e833ed250bca5f795ed4957bfd9ad0e6a1e271110526e26417ce658122a84
+  metadata.gz: f1cea12846844cd70926fd2c68e4270f30c0158273fc2e9d173db612c2f7fe8cbf54052ee0c9129a5de6d145dce7b3b7fe073dac437633abffd660007990c469
+  data.tar.gz: 7940ad8a382c3eebfa65c06a192ecd2bd5fef2974dd2cf8306d8d50b63b94c6eb0f94f7490af618a32962adb3b3dc1ba212467e4ddc9474c750948dded92692e

data/README.md

@@ -78,9 +78,9 @@ To delete all instances of an object
   end
 ```
 
-To create instances of custom objects that may have managed or unmanaged namespace use true_object_name. 
+### Custom Objects
 
-NOTE: in the future we will remove the need to use true_object_name() from calling code, but for now this is how it works.
+To create instances of custom objects that may have managed or unmanaged namespace use true_object_name. 
 
 ```ruby
   def create_gau_via_api(gau_name)
@@ -88,7 +88,10 @@ NOTE: in the future we will remove the need to use true_object_name() from calli
   end
 ```
 
-Note that when using delete_one_foo or delete_all_foo do not use any namespace value, SFDO-API does that for you
+NOTE: in the future we will remove the need to use true_object_name() from calling code when creating and selecting custom objects, 
+but for now this is how it works.
+
+When using delete_one_foo or delete_all_foo do not use any namespace value, SFDO-API does that for you
 
 ```ruby
   def delete_gaus_via_api
@@ -100,7 +103,9 @@ puts gaus.inspect
   end
 ```
 
-Note that ISVs may override required fields and these may be needed for SFDO-API to work properly
+### Using objects where local override changes required fields
+
+Note that ISVs may override required fields on standard Salesforce objects, and these may be needed for SFDO-API to work properly
 
 ```ruby
   # NPSP will automatically create certain fields on certain objects based on required input values for those records.
@@ -110,8 +115,11 @@ Note that ISVs may override required fields and these may be needed for SFDO-API
                              'Opportunity': ['ForecastCategory'] }
 ```
 
+### TODO
 
+Fields on namespaced object may be namespaced themselves. SFDO-API does not handle this case yet. 
 
+Custom fields on standard Salesforce objects may have namespaces. SFDO-API does not handle such fields yet. 
 
 
 ## Development
@@ -123,4 +131,3 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/SalesforceFoundation/SFDO-API.
-

data/lib/SFDO/API.rb

@@ -36,65 +36,83 @@ module SfdoAPI
   end
 
   def org_describe()
-    @org_describe ||= api_client do
-      @api_client.describe
+    if @org_description.nil? || !@org_description.respond_to?(:contains)
+      @org_description = api_client do
+        @api_client.describe
+      end
     end
+    return @org_description
   end
 
+  def prefix_to_name
+    if @prefix_to_name.nil? || !@prefix_to_name.respond_to?(:contains)
+      @prefix_to_name = {}
+      org_describe.each do |z|
+        @prefix_to_name.store(z.keyPrefix, z.name)
+      end
+    end
+    return @prefix_to_name
+  end
 
-  def npsp_managed_obj_names()
-    # GOAL: Delete NPSP objects whether managed or unmanaged
-    # Managed will start with np*__
-    # Unmanaged will have no prefix but end with __c
-    @npsp_managed_obj_names ||= @org_describe.select{|x| x.name =~ /^np.*__.*__c/i}.map{|y| y.name}
+  def true_object_name(handle) #either an ID or a string name
+    from_id = prefix_to_name[handle[0..2]]
+    from_name = obj_names_without_namespace[handle]
+    if !from_name.nil? || !from_id.nil?
+      return from_name if from_id.nil?
+      return from_id if from_name.nil?
+    end
+    return 'invalid'
   end
 
-  def true_object_name(obj_name)
-    potentials = npsp_managed_obj_names().select{|x| x =~ /#{obj_name}/i}
-    if potentials.size  > 0
-      return potentials.first #.split("__.").first + "__."
-    elsif org_describe().select{|x| x.name =~ /^#{obj_name}/i}.map{|y| y.name}.size > 0
-      return obj_name
+  def obj_names_without_namespace
+    if @obj_names_without_namespace.nil? || !@obj_names_without_namespace.respond_to?(:contains)
+      @obj_names_without_namespace = {}
+      org_describe.each do |z|
+        @obj_names_without_namespace.store(z.name.split("__",2).last, z.name)
       end
+    end
+    @obj_names_without_namespace
   end
 
   def get_object_describe(object_name)
     api_client do
-      org_describe
       @description = @api_client.get("/services/data/v35.0/sobjects/#{object_name}/describe")
 
       describeobject = Hashie::Mash.new(@description.body)
 
       required = describeobject.fields.map do |x|
         Hashie::Mash.new(
-          fieldName: x.name,
-          required: (!x.nillable && !x.defaultedOnCreate),
-          default: x.defaultValue)
+            fieldName: x.name,
+            required: (!x.nillable && !x.defaultedOnCreate),
+            default: x.defaultValue)
       end
       required.select(&:required)
     end
   end
 
   def delete(type, obj_id)
+    delete_by_id(obj_id)
+  end
+
+  def delete_by_id(obj_id)
     api_client do
-      @api_client.destroy(true_object_name(type), obj_id)
+      @api_client.destroy(true_object_name(obj_id), obj_id)
     end
   end
 
-  def delete_all(obj_type, id)
+  def delete_all(id)
     api_client do
-      obj_type = true_object_name(obj_type)
       id.each(&:destroy)
     end
   end
 
-
   def method_missing(method_called, *args, &block)
     breakdown = method_called.to_s.split('_')
     obj_type = breakdown.last.capitalize
+
     case method_called.to_s
       when /^delete_all_/
-        delete_all obj_type, *args
+        delete_all *args
       when /^delete_one/
         delete obj_type, *args
       when /^create_/

data/lib/SFDO/API/version.rb

@@ -1,5 +1,5 @@
 module SFDO
   module API
-    VERSION = "0.1.3"
+    VERSION = "0.1.4"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: SFDO-API
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Chris McMahon
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-28 00:00:00.000000000 Z
+date: 2016-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler