SFDO-API 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a59da5f72e29a615e9772927feba92ec2fa811b0
-  data.tar.gz: 3285cb4a58ceb3d7b303b7b40e76c998a08f2ebf
+  metadata.gz: a889210734dd667c332c1a2b6cc9c2e614f7b96e
+  data.tar.gz: bc0172a50528c4c7aa20ec670d8336227868640f
 SHA512:
-  metadata.gz: 2169619919809de7efa02ea7fb9283686530fc47ea02baf41d85d2ed07f6a168ba02ce795f72257a31053e66c504c166ab3e3746474b5607a9d73cb96000742e
-  data.tar.gz: 991a116695161d5335461188e948cb99f332523621eeae1bb8becc9e9b2bce3f7b4b0227905be8e8b9dd621de72aa8366db298e88c34aa892d4c1cdb9d76d61d
+  metadata.gz: 6fc1612e504e920b02d7a65a1b1456b1efccf524c3e63048791a1c04a06be25cc1a48ebc643242f114a204d286ddff53adf84a73bc0bc2307f4663bbc346e1c1
+  data.tar.gz: 5ef960b4d79bd44d37384955516412c85fd92d6d03e63d53a4c806ec6d2d48b4cd2e833ed250bca5f795ed4957bfd9ad0e6a1e271110526e26417ce658122a84

data/README.md

@@ -1,7 +1,10 @@
 # SFDO::API
 
-SFDO-API is a convenient way to manipulate valid Salesforce objects in a target environment. It accepts commands from
-the calling script, and then lets the restforce Ruby gem deal directly with the Salesforce API.
+SFDO-API is a convenient way to use the Salesforce API to manipulate objects in a target org. SFDO-API was intended orginally to
+facilitate the sharing of common API calls across multiple source repositories, but the project is evolving to provide powerful
+tools for handiling SF objects, like support for managed and unmanaged namespaces, multiple namespaces in an org, etc. 
+
+SFDO-API accepts commands from the calling script, and then lets the restforce Ruby gem deal directly with the Salesforce API.
 
 ## Installation
 
@@ -21,13 +24,18 @@ Or install it yourself as:
 
 ## Usage
 
+### All examples below are calling code, not SFDO-API code
+
 To create a simple Account and get the ID for that Account:
+
 ```ruby
   def create_account_via_api(client_name)
     @account_id = create 'Account', Name: client_name
   end
 ```
+
 You can also address the Restforce API client directly if you want, for example to issue a 'select' query:
+
 ```ruby
   def create_contact_via_api(client_name, street = '', city = '', state = '', country = '', zip = '')
     @contact_id = create 'Contact', LastName: client_name,
@@ -41,6 +49,71 @@ You can also address the Restforce API client directly if you want, for example
     @account_id_for_contact = my_account_object.AccountId
   end
 ```
+
+To delete a single instance of an object for which you have the Id value
+```ruby
+  def delete_account_via_api
+   delete_one_account(@account_id)
+  end
+```
+
+```ruby
+  def delete_contacts_via_api
+    api_client do
+      @array_of_contacts.each do |contact_id|
+        delete_one_contact(contact_id)
+      end
+    end
+  end
+```
+
+To delete all instances of an object 
+
+```ruby
+  def delete_household_accounts
+    api_client do
+      hh_accs = @api_client.query("select Id from Account where Type = 'Household'")
+      delete_all_household_account(hh_accs)
+    end
+  end
+```
+
+To create instances of custom objects that may have managed or unmanaged namespace use true_object_name. 
+
+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.
+
+```ruby
+  def create_gau_via_api(gau_name)
+    @gau_id = create "#{true_object_name('General_Accounting_Unit__c')}", Name: gau_name
+  end
+```
+
+Note that 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
+    api_client do
+      gaus = @api_client.query("select Id from #{true_object_name('General_Accounting_Unit__c')}")
+puts gaus.inspect
+      delete_all_General_Accounting_Unit__c(gaus)
+    end
+  end
+```
+
+Note that ISVs may override required fields 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.
+  # There is no way to know in advance from the API which these are, so we find them empirically and note them here
+  # before calling the create() method in SfdoAPI
+  @fields_acceptibly_nil = { 'Contact': ['Name'],
+                             'Opportunity': ['ForecastCategory'] }
+```
+
+
+
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/SFDO/API.rb

@@ -22,7 +22,6 @@ module SfdoAPI
 
   def is_valid_obj_hash?(object_name, obj_hash, fields_acceptibly_nil)
     required_fields = get_object_describe(object_name).map(&:fieldName)
-    #   [name, id, required_field_1__c, etc]
     valid = true
     required_fields.each do |f|
 
@@ -36,15 +35,32 @@ module SfdoAPI
     valid
   end
 
-  def get_org_objects()
-    #binding.pry
-    @org_objects ||= api_client do
+  def org_describe()
+    @org_describe ||= api_client do
       @api_client.describe
     end
   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}
+  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
+      end
+  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)
@@ -61,21 +77,17 @@ module SfdoAPI
 
   def delete(type, obj_id)
     api_client do
-      @api_client.destroy(type, obj_id)
+      @api_client.destroy(true_object_name(type), obj_id)
     end
   end
 
   def delete_all(obj_type, id)
     api_client do
-      #p "id is " + id.inspect
-      #@api_client.destroy(obj_type, id)
+      obj_type = true_object_name(obj_type)
       id.each(&:destroy)
     end
   end
 
-    # Given that the developer calls 'delete_contact(id)'
-    # When 'contact' is a valid object
-    # Then this method_missing method, will translate 'delete_contact' into "generic_delete('contact', id)"
 
   def method_missing(method_called, *args, &block)
     breakdown = method_called.to_s.split('_')

data/lib/SFDO/API/version.rb

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

metadata

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