ramco 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd44c1cc33aeb833b2361b21eb6e2dcbdd2b852bd8c46993ef272276b0964660
-  data.tar.gz: 7d00666754d90a2b54e3c71de2c84649183b5421cea6bbd05f17c0e15ebdafc2
+  metadata.gz: 19c06fea9ff8d546df10661c4b2fc6588e51550a3fdb9888afd39c249e843d08
+  data.tar.gz: f32656e7d50a26edce2220d90eaf2da8b83820f2aae46a938d28fa3cacbfc197
 SHA512:
-  metadata.gz: 4303addff9362c7b601ae3eaec6833a325728dbb1e760a8a4c1f8477caa9fbe8e6ab7507629bf59b5e5f6f7da472ece142a30a380f96e9e5f2eb8e4972d245d8
-  data.tar.gz: eb4c0537d6cb73dad7988532cd6f2a2a9878f280ffed03fd0c2f70e23ca2cd1e0dc40d3ddfc3ef75c0b7b13b5539d16ff82ec357bed7e493380dd0dcff580bc2
+  metadata.gz: a308af1be3e0bd9af4aa1884c1177444896f1e499e2e4ad52be25dbb67ed078f6f1c8d1f09fec7533b8a10306bdcda7a3235a571892a993242a55dd36794d517
+  data.tar.gz: 9b7627c785284a998350603165ea168fb7a92230cdecf77653f3f289a241b67e120e3ba46d9f9b90539cfd8b19112d1377bb53b6c12945903d0d4213914bd0fe

data/README.md

@@ -80,6 +80,55 @@ Returns the globally unique id of a contact that matches the provided cobalt_use
     * cobalt_username = User’s username
     * cobalt_password = User’s password
 
+## UpdateEntity
+
+Allows for modification of attributes of existing Entities.
+
+    ramco.update_entity({"entity" => "Contact", "guid" => "6868642f-0144-e811-9c17-00155d10120d", "attribute_values" => "FirstName=#Jane#,Birthday=1980-12-31,EmailVerified=true,NumChildren=3"})
+
+  * Post params:
+    * Entity = Type of entity being modified (ex: Contact)
+    * Guid = guid of entity being modified
+    * AttributeValues = Comma separated attribute=value pairs.
+    * StringDelimiter (optional) = User-specified delimiter used to wrap string values (default is #)
+
+### The AttributeValue parameter syntax
+
+A comma delimited list of attribute value pairs like: 
+
+    FirstName=#Joe#,Birthday=1980-12-31,EmailVerified=true,NumChildren=3
+
+Strings must be wrapped with a delimiter. The default delimiter is ‘#’ but a user-specified delimiter can be utilized by including the optional StringDelimiter param.
+
+OptionSets must be set to a numeric value valid for that optionset, or zero to clear current existing value. To determine values that are valid for an optionset, use the GetOptionSet api call.
+Note that when updating an attribute of type EntityReferene, usually only the guid needs to be specified. In cases where the EntityReference can be of more than one type (ex: OwnerId can be SystemUser or Team) the value must be type:guid (SystemUser:fb50333e-6b9f-e111-8d5d- 00155d000140).
+
+In instances where the string delimiter occurs in the string itself (ex: ‘Some#Text’), the delimiter must be Base64Encoded (ex: ‘SomeIw==Text’). Of course the option to change the delimiter using the StringDelimiter parameter exists as well.
+
+
+## CreateEntity
+
+Allows for creation of a new entity record.
+
+    ramco.create_entity({"entity" => "Contact", "attribute_values" => "FirstName=#Jane#,Birthday=1980-12-31,EmailVerified=true,NumChildren=3"})
+
+  * Post params:
+    * Entity = Type of entity being modified (ex: Contact)
+    * AttributeValues = Comma separated attribute=value pairs.
+    * StringDelimiter (optional) = User-specified delimiter used to wrap string values (default is #)
+
+### The AttributeValue parameter syntax
+
+The AttributeValue parameter for CreateEntity follows the same format as that for UpdateEntity.
+
+### PrimaryIdAttribute
+
+Every entity type has a PrimaryIdAttribute which can be determined with a GetEntityMetadata call. If a specific guid is desired for the entity being created, it can be added to the AttributeValues parameter along with the other specified values. If the PrimaryIdAttribute is not specified, one will be automatically generated.
+
+Example creating a Contact record (ContactId is PrimaryIdAttribute): 
+
+    FirstName=#John#,LastName=#Doe#,ContactId= 84a4d17f-2e48-4a4b-bb28-26f7c14fc926, Birthday=1980-12-31
+
 ## ClearCache
 
 Clears the server-side metadata cache. If an entity or attribute has been added (or removed), then clearing the cache will permit the changes to be reflected immediately. The cache will normally expire every 24 hours.

data/lib/ramco/api/entity.rb

@@ -17,6 +17,39 @@ class Ramco
         params['operation'] = "GetEntity"
         request(connection, params)
       end
+    
+      # CreateEntity
+      # Allows for creation of a new entity record.
+      #
+      # Entity = Type of entity being modified (ex: Contact)
+      # AttributeValues = Comma separated attribute=value pairs.
+      # StringDelimiter (optional) = User-specified delimiter used to wrap string values (default is #)
+      #
+      # {"entity" => "Contact", "attribute_values" => "FirstName=#Jane#,Birthday=1980-12-31,EmailVerified=true,NumChildren=3"}
+      #
+      # Returns json
+      #
+      def create_entity(params={})
+        params['operation'] = "CreateEntity"
+        request(connection, params)
+      end
+
+      # UpdateEntity
+      # Allows for modification of attributes of existing Entities.
+      #
+      # Entity = Type of entity being modified (ex: Contact)
+      # Guid = guid of entity being modified
+      # AttributeValues = Comma separated attribute=value pairs.
+      # StringDelimiter (optional) = User-specified delimiter used to wrap string values (default is #)
+      #
+      # {"entity" => "Contact", "attribute_values" => "FirstName=#Jane#,Birthday=1980-12-31,EmailVerified=true,NumChildren=3"}
+      #
+      # Returns json
+      #
+      def update_entity(params={})
+        params['operation'] = "UpdateEntity"
+        request(connection, params)
+      end
     end
   end
 end

data/lib/ramco/version.rb

@@ -1,3 +1,3 @@
 class Ramco
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/spec/ramco/api/entity_spec.rb

@@ -13,4 +13,30 @@ describe Ramco::API::Entity do
       end
     end
   end
+  
+  describe "#update_entity" do
+    it "should update an entity" do
+      VCR.use_cassette('update entity') do
+        response = subject.update_entity({"entity" => "Contact", "guid" => "6868642f-0144-e811-9c17-00155d10120d", "attribute_values" => "FirstName=#Jane#,LastName=#Doe#"})
+        expect(response).to be_instance_of(Hash)  
+        expect(response).to have_key "ContactId"
+        expect(response["ContactId"]).to eq("6868642f-0144-e811-9c17-00155d10120d")
+        expect(response["FirstName"]).to eq("Jane")
+        expect(response["LastName"]).to eq("Doe")
+      end
+    end
+  end
+  
+  describe "#create_entity" do
+    it "should create an entity" do
+      VCR.use_cassette('create entity') do
+        response = subject.create_entity({"entity" => "Contact", "attribute_values" => "FirstName=#Jane#,LastName=#Doe#"})
+        expect(response).to be_instance_of(Hash)  
+        expect(response).to have_key "ContactId"
+        expect(response["ContactId"]).to eq("6868642f-0144-e811-9c17-00155d10120d")
+        expect(response["FirstName"]).to eq("Jane")
+        expect(response["LastName"]).to eq("Doe")
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ramco
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Kurt Kowitz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-24 00:00:00.000000000 Z
+date: 2019-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday