springcm-sdk 0.6.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7d75a3305c25f460d0344253f9f38c072a2bfbe654d8d12a9367dfb5d305f8a
-  data.tar.gz: '048dace2594c405e3738d5d8fc67dc90014a1e601dc2d6e49cb3fa6553188ae2'
+  metadata.gz: bda471ab4007cc6a9f27e8be3fa16e9f4081520bcdf456413be1e45b202969b5
+  data.tar.gz: 52b63c7b43d2a9f4256f2925d4b028c4c493a255315651b93ade97e2a63d2435
 SHA512:
-  metadata.gz: 07fe708519c5427679d0b1e563c78d7bcf7559e4a59944b3e2fe106bebec7819c3988423b9f9ab9b2b937ee771649956014148518034ece12bda8bc228fb2fd7
-  data.tar.gz: 7bd8f1a6d76a10cf4961f48a0d2c42b92ee4aac63000cb0264f76ae05b76ee3de9c659c6125733600d3f3d44bf4f75f61e206a7b7fe5101eaed7c090719ffc42
+  metadata.gz: d7c365620c4b7c556c8f1eabf0c89800331bc47d40fd78650e0733c907d1462013d6d527cfb0fadf02df20acc2c922368ccb16c4c3639255fcd040f276fd5178
+  data.tar.gz: 8ebe53f6ea3e116f90bdc6b6d153531ce21edaf55c012ab74e7c772ddbd82f72cfd933cbb951f42e1d2e2a4b1d7bcfaa6b57ba9598ce7e480f4b24516eb67253

data/.gitignore

@@ -3,3 +3,4 @@ springcm-sdk-*.gem
 coverage
 .yardoc
 doc
+**/.DS_Store

data/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to springcm-sdk will be documented in this file.
 
 ## [Unreleased]
+
+## [1.0.0] - 2020-02-14 ❤️
+### Added
+* Setting object JSON properties
+* New API for retrieving and modifying applied attributes on documents and folders
+* Folders now include attribute API.
+
+### Removed
+* Old attribute API
+
 ## [0.6.1] - 2020-01-13
 ### Changed
 * Fix bug with set_attribute on repeatable set data when attribute group is not already applied - empty array of items is created.
@@ -145,3 +155,4 @@ All notable changes to springcm-sdk will be documented in this file.
 [0.5.0]: https://github.com/paulholden2/springcm-sdk/releases/tag/0.5.0
 [0.6.0]: https://github.com/paulholden2/springcm-sdk/releases/tag/0.6.0
 [0.6.1]: https://github.com/paulholden2/springcm-sdk/releases/tag/0.6.1
+[1.0.0]: https://github.com/paulholden2/springcm-sdk/releases/tag/1.0.0

data/lib/springcm-sdk/account.rb

@@ -37,6 +37,15 @@ module Springcm
       end
     end
 
+    def attribute_group(name: nil, uid: nil)
+      if (name.nil? && uid.nil?) || (!name.nil? && !uid.nil?)
+        raise ArgumentError.new("Specify exactly one of: name, uid")
+      end
+      all_attribute_groups.select { |group|
+        (!name.nil? && group.name == name) || (!uid.nil? && group.uid == uid)
+      }.first
+    end
+
     private
 
     def load_all_attribute_groups

data/lib/springcm-sdk/applied_attribute_field.rb

@@ -0,0 +1,50 @@
+require "springcm-sdk/object"
+
+module Springcm
+  class AppliedAttributeField < Object
+    attr_reader :subject
+    attr_reader :group
+    attr_reader :set
+    attr_reader :name
+
+    def initialize(data, field_name, subject, group, set, client)
+      @subject = subject
+      @group = group
+      @set = set
+      @name = field_name
+      super(data, client)
+    end
+
+    def value
+      if repeating_attribute == true
+        raise RepeatableAttributeFieldUsageError.new(group.name, name)
+      else
+        Helpers.deserialize_field(raw)
+      end
+    end
+
+    def value=(val)
+      if repeating_attribute == true
+        raise RepeatableAttributeFieldUsageError.new(group.name, name)
+      else
+        @data["Value"] = Helpers.serialize_value(@data["AttributeType"], val)
+      end
+    end
+
+    def [](*args)
+      if repeating_attribute == true
+        Helpers.deserialize_value(@data["AttributeType"], @data["Value"].send(:[], *args))
+      else
+        raise NonRepeatableAttributeFieldUsageError.new(group.name, name)
+      end
+    end
+
+    def []=(key, val)
+      if repeating_attribute == true
+        @data["Value"].send(:[]=, key, val)
+      else
+        raise NonRepeatableAttributeFieldUsageError.new(group.name, name)
+      end
+    end
+  end
+end

data/lib/springcm-sdk/applied_attribute_group.rb

@@ -0,0 +1,37 @@
+require "springcm-sdk/object"
+require "springcm-sdk/applied_attribute_set"
+
+module Springcm
+  class AppliedAttributeGroup < Object
+    attr_reader :subject
+    attr_reader :name
+
+    def initialize(data, group_name, subject, client)
+      @subject = subject
+      @name = group_name
+      super(data, client)
+    end
+
+    def set(set_name)
+      set_data = raw[set_name]
+      if set_data.nil? || set_data["AttributeType"] != "Set"
+        raise NoAttributeSetError.new(group.name, name)
+      end
+      AppliedAttributeSet.new(set_data, set_name, subject, self, @client)
+    end
+
+    def field(field_name)
+      group_config = @client.account.attribute_group(name: name)
+      set_config = group_config.set_for_field(field_name)
+      field_data = nil
+      if set_config.nil?
+        field_data = raw[field_name]
+      elsif set_config.repeating_attribute?
+        raise RepeatableAttributeSetUsageError.new(group.name, name)
+      else
+        field_data = raw[set_config.name]["Attributes"][field_name]
+      end
+      AppliedAttributeField.new(field_data, field_name, subject, self, nil, @client)
+    end
+  end
+end

data/lib/springcm-sdk/applied_attribute_set.rb

@@ -0,0 +1,54 @@
+require "springcm-sdk/object"
+require "springcm-sdk/applied_attribute_set_item"
+require "springcm-sdk/applied_attribute_field"
+
+module Springcm
+  class AppliedAttributeSet < Object
+    attr_reader :subject
+    attr_reader :group
+    attr_reader :name
+
+    def initialize(data, set_name, subject, group, client)
+      @subject = subject
+      @group = group
+      @name = set_name
+      super(data, client)
+    end
+
+    def field(field_name)
+      # Validate name not one of the restricted attribute names:
+      # RepeatingAttribute, AttributeType
+      field_data = raw[field_name]
+      # puts field_data
+      if repeating_attribute == true
+        raise RepeatableAttributeSetUsageError.new(group.name, name)
+      else
+        AppliedAttributeField.new(field_data, field_name, subject, group, self, @client)
+      end
+    end
+
+    def [](*args)
+      if repeating_attribute == true
+        item = @data["Items"].send(:[], *args)
+        AppliedAttributeSetItem.new(item, subject, group, self, @client)
+      else
+        raise NonRepeatableAttributeSetUsageError.new(group.name, name)
+      end
+    end
+
+    def []=(key, data)
+      if repeating_attribute == true
+        raise NonRepeatableAttributeSetUsageError.new(group.name, name)
+      end
+      group_config = @client.account.attribute_group(name: group.name)
+      set = group_config.set(name)
+      item = @data["Items"][key]
+      item.clear
+      data.each { |key, value|
+        field_config = group_config.field(key)
+        item[key] = Helpers.serialize_field(field_config, value)
+      }
+      item
+    end
+  end
+end

data/lib/springcm-sdk/applied_attribute_set_item.rb

@@ -0,0 +1,23 @@
+require "springcm-sdk/object"
+require "springcm-sdk/applied_attribute_field"
+
+module Springcm
+  class AppliedAttributeSetItem < Object
+    attr_reader :subject
+    attr_reader :group
+    attr_reader :name
+
+    def initialize(data, subject, group, set, client)
+      @subject = subject
+      @group = group
+      super(data, client)
+    end
+
+    def field(field_name)
+      # Validate name not one of the restricted attribute names:
+      # RepeatingAttribute, AttributeType
+      field_data = raw[field_name]
+      AppliedAttributeField.new(field_data, field_name, subject, group, set, @client)
+    end
+  end
+end

data/lib/springcm-sdk/attribute_group.rb

@@ -53,6 +53,40 @@ module Springcm
       }
     end
 
+    def template
+      group = {}
+      attributes_config.each { |attribute|
+        type = attribute["Type"]
+        if type == "DynamicDropDown"
+          type = "MagicDropdown" # Not sure why they do this for applied groups, but oh well
+        end
+        repeating = attribute["RepeatingAttribute"]
+        attr = {
+          "AttributeType" => type,
+          "RepeatingAttribute" => repeating
+        }
+        if attribute.key?("Attributes") # If it's a set
+          attr["AttributeType"] = "Set"
+          set = attr
+          if repeating
+            set = {}
+            attr["Items"] = [set]
+          end
+          attribute["Attributes"].each { |field|
+            set[field["Name"]] = {
+              "AttributeType" => field["Type"],
+              "RepeatingAttribute" => false
+            }
+          }
+        elsif repeating
+          # Must have empty array for repeating plain fields
+          attr["Value"] = []
+        end
+        group[attribute["Name"]] = attr
+      }
+      group
+    end
+
     protected
 
     def attributes_config

data/lib/springcm-sdk/document.rb

@@ -1,4 +1,5 @@
 require "springcm-sdk/resource"
+require "springcm-sdk/applied_attribute_group"
 require "springcm-sdk/mixins/access_level"
 require "springcm-sdk/mixins/attributes"
 require "springcm-sdk/mixins/parent_folder"

data/lib/springcm-sdk/folder.rb

@@ -13,6 +13,7 @@ module Springcm
     include Springcm::Mixins::AccessLevel
     include Springcm::Mixins::ParentFolder
     include Springcm::Mixins::Documents
+    include Springcm::Mixins::Attributes
 
     def self.resource_params
       {

data/lib/springcm-sdk/helpers.rb

@@ -11,6 +11,15 @@ module Springcm
       end
     end
 
+    def self.serialize_value(type, value)
+      if type == "Date"
+        # Raise if value is not a DateTime
+        serialized_value = value.strftime("%m/%d/%Y")
+      else
+        serialized_value = value.to_s
+      end
+    end
+
     def self.serialize_field(field_config, value)
       type = field_config.type
       name = field_config.name
@@ -19,22 +28,13 @@ module Springcm
         "AttributeType" => type,
         "RepeatingAttribute" => repeating
       }
-      serialized_value = nil
-      if type == "Date"
-        # Raise if value is not a DateTime
-        serialized_value = value.strftime("%m/%d/%Y")
-      else
-        serialized_value = value.to_s
+      if !value.nil?
+        serialized["Value"] = Helpers.serialize_value(type, value)
       end
-      return nil if serialized_value.nil?
-      serialized["Value"] = serialized_value
       serialized
     end
 
-    # Deserialize a SpringCM attribute value
-    def self.deserialize_field(field)
-      type = field["AttributeType"]
-      value = field["Value"]
+    def self.deserialize_value(type, value)
       if type == "String"
         value
       elsif type == "Number"
@@ -48,6 +48,13 @@ module Springcm
       end
     end
 
+    # Deserialize a SpringCM attribute value
+    def self.deserialize_field(field)
+      type = field["AttributeType"]
+      value = field["Value"]
+      Helpers.deserialize_value(type, value)
+    end
+
     def self.validate_access!(access)
       access_types = [
         :inherit_from_parent_folder,

data/lib/springcm-sdk/mixins/attributes.rb

@@ -1,3 +1,7 @@
+require "springcm-sdk/applied_attribute_group"
+require "springcm-sdk/applied_attribute_set"
+require "springcm-sdk/applied_attribute_set_item"
+require "springcm-sdk/applied_attribute_field"
 require "springcm-sdk/helpers"
 
 module Springcm
@@ -8,99 +12,24 @@ module Springcm
         @data["AttributeGroups"] = value
       end
 
-      # TODO: Clean this whole mess up. This pattern sucks. Better:
-      #         doc = client.document(...)
-      #         group = doc.attribute_group("My Data")
-      #         attr = group.attribute("My Field")
-      #         attr.type
-      #         attr.repeating?
-      #         attr.value
-      #         attr.value = 2
-      #         attr.value = [1, 2, 3]
-      #         attr.value[0] = 3
-      #         attr.insert(at: 0, value: 5)
-      #         doc.patch
-
-      def set_attribute(group:, field:, index: nil, value:, mode: :insert)
-        if ![:insert, :replace].include?(mode)
-          raise ArgumentError.new("Set attribute mode must be one of: :insert, :replace")
-        end
-        if mode == :replace && (index.nil? || index < 0)
-          raise ArgumentError.new("When set attribute mode is :replace, index must be a non-negative integer")
-        end
-        group_config = @client.account.all_attribute_groups.select { |g|
-          g.name == group
-        }.first
-        # Non-existent group
-        raise Springcm::NoAttributeGroupError.new(group) if group_config.nil?
-        field_config = group_config.field(field)
-        field_set_config = group_config.set_for_field(field)
-        # Non-existent field
-        raise Springcm::NoAttributeFieldError.new(group, field) if field_config.nil?
-        groups = attribute_groups || {}
-        group_data = groups.fetch(group, {})
-        # Repeating set
-        if !field_set_config.nil? && field_set_config["RepeatingAttribute"]
-          set_name = field_set_config["Name"]
-          set_data = group_data.fetch(set_name, { "Items"=>[] })
-          field_data = {
-            "#{field}" => Springcm::Helpers.serialize_field(field_config, value)
-          }
-          if mode == :insert
-            set_data["Items"].insert(index || -1, field_data)
-          elsif
-            set = set_data["Items"][index] || {}
-            set.merge!(field_data)
-          end
-          set_data["Items"][index] = set
-          set_data["Items"].reject!(&:nil?)
-          group_data[set_name] = set_data
+      def attribute_group(group_name)
+        groups = @data["AttributeGroups"] || get.attribute_groups || {}
+        group_data = groups[group_name]
+        if group_data.nil?
+          nil
         else
-          serialized = Springcm::Helpers.serialize_field(field_config, value)
-          if field_config.repeating_attribute?
-            if mode == :insert
-              group_data[field]["Value"].insert(index || -1, serialized["Value"])
-            else
-              group_data[field]["Value"][index] = serialized["Value"]
-            end
-            group_data[field]["Value"].reject!(&:nil?)
-          else
-            group_data[field] = serialized
-          end
+          AppliedAttributeGroup.new(group_data, group_name, self, @client)
         end
-        groups[group] = group_data
-        attribute_groups = groups
-        value
       end
 
-      def get_attribute(group:, field:)
-        group_config = @client.account.all_attribute_groups.select { |g|
-          g.name == group
-        }.first
-        # Non-existent group
-        raise Springcm::NoAttributeGroupError.new(group) if group_config.nil?
-        field_config = group_config.field(field)
-        field_set_config = group_config.set_for_field(field)
-        # Non-existent field
-        raise Springcm::NoAttributeFieldError.new(group, field) if field_config.nil?
-        groups = attribute_groups
-        # No attribute groups applied
-        return nil if groups.nil?
-        group_data = groups.fetch(group, nil)
-        # Group is not applied
-        return nil if group_data.nil?
-        # Repeating set
-        if !field_set_config.nil? && field_set_config["RepeatingAttribute"]
-          set_data = group_data.fetch(field_set_config["Name"], nil)
-          return nil if set_data.nil?
-          set_data["Items"].map { |item|
-            Springcm::Helpers.deserialize_field(item[field])
-          }
-        else
-          field_data = group_data.fetch(field, nil)
-          return nil if field_data.nil?
-          Springcm::Helpers.deserialize_field(field_data)
-        end
+      # Apply a skeleton attribute group to the Document object. Calling #patch
+      # or #put before actually applying any data will have no effect on the
+      # document within SpringCM.
+      def apply_attribute_group(group_name)
+        return if !attribute_group(group_name).nil?
+        group_config = @client.account.attribute_group(name: group_name)
+        @data["AttributeGroups"] ||= {}
+        @data["AttributeGroups"].merge!({ "#{group_name}" => group_config.template })
       end
     end
   end

data/lib/springcm-sdk/object.rb

@@ -15,9 +15,19 @@ module Springcm
     # for retrieving data deeper in the JSON document, e.g. documents_href
     # via Springcm::Mixins::Documents.
     def method_missing(m, *args, &block)
-      key = m.to_s.split("_").map(&:capitalize).join
+      mode = :get
+      method = m.to_s
+      if method.end_with?("=")
+        mode = :set
+        method = method[0...-1]
+      end
+      key = method.split("_").map(&:capitalize).join
       if @data.key?(key)
-        @data.fetch(key)
+        if mode == :get
+          @data.fetch(key)
+        else
+          @data[key] = args.first
+        end
       else
         super
       end

data/lib/springcm-sdk/version.rb

@@ -1,3 +1,3 @@
 module Springcm
-  VERSION = "0.6.1"
+  VERSION = "1.0.0"
 end

data/lib/springcm-sdk.rb

@@ -21,6 +21,12 @@ module Springcm
     end
   end
 
+  class NoAttributeSetError < Error
+    def initialize(group, set)
+      super("No such attribute set: #{group}.#{set}")
+    end
+  end
+
   class NoAttributeFieldError < Error
     def initialize(group, field)
       super("No such attribute field: #{group}.#{field}")
@@ -56,4 +62,28 @@ module Springcm
       super("Timed out while awaiting ChangeSecurityTask to complete.")
     end
   end
+
+  class RepeatableAttributeSetUsageError < Error
+    def initialize(group, set)
+      super("The attribute set #{group}.#{set} is repeatable. Use #[] to access and modify fields.")
+    end
+  end
+
+  class NonRepeatableAttributeSetUsageError < Error
+    def initialize(group, set)
+      super("The attribute set #{group}.#{set} is not repeatable. Use #field to access and modify fields.")
+    end
+  end
+
+  class RepeatableAttributeFieldUsageError < Error
+    def initialize(group, field)
+      super("The attribute field #{group}.#{field} is repeatable. Use #[] to access and modify values.")
+    end
+  end
+
+  class NonRepeatableAttributeFieldUsageError < Error
+    def initialize(group, field)
+      super("The attribute field #{group}.#{field} is not repeatable. Use #field to access and modify values.")
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: springcm-sdk
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Paul Holden
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-14 00:00:00.000000000 Z
+date: 2020-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -158,6 +158,10 @@ files:
 - bin/setup
 - lib/springcm-sdk.rb
 - lib/springcm-sdk/account.rb
+- lib/springcm-sdk/applied_attribute_field.rb
+- lib/springcm-sdk/applied_attribute_group.rb
+- lib/springcm-sdk/applied_attribute_set.rb
+- lib/springcm-sdk/applied_attribute_set_item.rb
 - lib/springcm-sdk/attribute.rb
 - lib/springcm-sdk/attribute_group.rb
 - lib/springcm-sdk/change_security_task.rb
@@ -188,7 +192,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/paulholden2/springcm-sdk
   source_code_uri: https://github.com/paulholden2/springcm-sdk
-  documentation_uri: https://rubydoc.info/github/paulholden2/springcm-sdk/0.6.1
+  documentation_uri: https://rubydoc.info/github/paulholden2/springcm-sdk/1.0.0
   changelog_uri: https://github.com/paulholden2/springcm-sdk/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []