springcm-sdk 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ede0e8cbe39a1ba56490a8747d394136877c4ba297f42bc618d665a37822b5b
-  data.tar.gz: 2c6c5bf9194b9f63f937f491cd3522d8175db3d8aabd5cf799b8a09aba7689e6
+  metadata.gz: d6147bd5e61e56858a0c7bd91d8aab95a718b580e32e42f1fe7de34a2599742a
+  data.tar.gz: 84260d0c7050d3675765f7d481da6ca261e98ad900c272731de26daa8d1792a5
 SHA512:
-  metadata.gz: 9aee61e667d073e51bc57f7e8aa00c67e6f47067cc106b11e1caee6306836e390035df29d63714f7f10c8d6351bbca8eaabca34ef95a65a4cc71eecbd60f9874
-  data.tar.gz: 40aeda6cd074142c6546a3451fd29c495dc1f1a73bebce8dab2d2382f730e268cc5690de41d9c89b7b5203d149a5915a7997802e871b7bc559c3e70558271512
+  metadata.gz: 3ed35a3f5b082bf08b7e4162f8a6491f8a27d8f4d6ffb9a88de4116dd2b1c078cb564f161d683c557c0eda46b9251dfb23f7ffee6aec592d64ca804cde7af254
+  data.tar.gz: cf064b9ea38ac974f63f87d67e548aab6e58fed69d545bff2e84da68e30be373b9c1924954c16ee6a5ad582cd58eb1a6930e56a0f4b37f2b4657b31fa4b9c3ea

data/CHANGELOG.md

@@ -4,6 +4,27 @@ All notable changes to springcm-sdk will be documented in this file.
 
 ## [Unreleased]
 
+## [0.5.0] - 2020-01-03
+### Added
+* #patch and #put for Resources.
+* #set_attribute for Attribute mixin.
+* Safeguard against permanent Document deletions. DeleteRefusedError will be
+  be raised on documents that are in the trash folder unless #delete! is used.
+
+### Changed
+* Moved attribute-related tests to a separate test file. May need to re-add
+  to document/folder specs just for live testing.
+* AttributeGroupBuilder JSON now includes IsSystem property.
+* Fix property default values on DocumentBuilder
+* Raise error on invalid attribute groups or fields.
+
+### Bugfixes
+* Fix issue with Resource#resource_params not being applied properly in
+  request methods.
+* Fix JSON returned from builders when retrieving data in lists, e.g.
+  `/folders/<uid>/documents` does not include attribute groups. Tests have
+  been modified to call #reload where full data is needed.
+
 ## [0.4.0] - 2019-12-27
 ### Added
 * Faraday middleware for authorization expiration and rate limit handling.
@@ -89,7 +110,7 @@ All notable changes to springcm-sdk will be documented in this file.
 ### Added
 * Initial release to reserve gem name
 
-[Unreleased]: https://github.com/paulholden2/springcm-sdk/compare/0.4.0...HEAD
+[Unreleased]: https://github.com/paulholden2/springcm-sdk/compare/0.5.0...HEAD
 [0.1.0]: https://github.com/paulholden2/springcm-sdk/releases/tag/0.1.0
 [0.1.1]: https://github.com/paulholden2/springcm-sdk/releases/tag/0.1.1
 [0.1.2]: https://github.com/paulholden2/springcm-sdk/releases/tag/0.1.2
@@ -102,3 +123,4 @@ All notable changes to springcm-sdk will be documented in this file.
 [0.3.5]: https://github.com/paulholden2/springcm-sdk/releases/tag/0.3.5
 [0.3.6]: https://github.com/paulholden2/springcm-sdk/releases/tag/0.3.6
 [0.4.0]: https://github.com/paulholden2/springcm-sdk/releases/tag/0.4.0
+[0.5.0]: https://github.com/paulholden2/springcm-sdk/releases/tag/0.5.0

data/lib/springcm-sdk/attribute_group.rb

@@ -6,7 +6,7 @@ module Springcm
   class AttributeGroup < Resource
     # Retrieve an attribute set by name.
     def set(name)
-      res = @data["Attributes"].select { |attr|
+      res = attributes_config.select { |attr|
         attr["Attributes"].is_a?(Array) && attr["Name"] == name
       }
       return nil if !res.any?
@@ -38,7 +38,7 @@ module Springcm
     end
 
     def attributes
-      @data["Attributes"].map { |attr|
+      attributes_config.map { |attr|
         if attr["Attributes"].is_a?(Array)
           attr["Attributes"]
         else
@@ -48,9 +48,16 @@ module Springcm
     end
 
     def sets
-      @data["Attributes"].select { |attr|
+      attributes_config.select { |attr|
         attr["Attributes"].is_a?(Array)
       }
     end
+
+    protected
+
+    def attributes_config
+      @data = reload.raw if !@data.key?("Attributes")
+      @data["Attributes"]
+    end
   end
 end

data/lib/springcm-sdk/document.rb

@@ -11,7 +11,7 @@ module Springcm
 
     def self.resource_params
       {
-        "expand" => "attributegroups"
+        "expand" => "attributegroups,path"
       }
     end
 
@@ -30,5 +30,20 @@ module Springcm
         nil
       end
     end
+
+    def delete!
+      unsafe_delete
+    end
+
+    alias_method :unsafe_delete, :delete
+    private :unsafe_delete
+
+    def delete
+      reload
+      if path.start_with?("/#{@client.account.name}/Trash")
+        raise Springcm::DeleteRefusedError.new(path)
+      end
+      unsafe_delete
+    end
   end
 end

data/lib/springcm-sdk/helpers.rb

@@ -11,6 +11,25 @@ module Springcm
       end
     end
 
+    def self.serialize_field(field_config, value)
+      type = field_config.type
+      repeating = field_config.repeating_attribute?
+      serialized = {
+        "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
+      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"]

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

@@ -4,16 +4,46 @@ module Springcm
   module Mixins
     # Mixin for objects that have attributes.
     module Attributes
+      def attribute_groups=(value)
+        @data["AttributeGroups"] = value
+      end
+
+      def set_attribute(group:, field:, index: nil, value:)
+        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, {})
+          set_data["Items"].insert(index || -1, Springcm::Helpers.serialize_field(field_config, value))
+          group_data[set_name] = set_data
+        else
+          group_data[field] = Springcm::Helpers.serialize_field(field_config, value)
+        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
-        return nil if group_config.nil?
+        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
-        return nil if field_config.nil?
+        raise Springcm::NoAttributeFieldError.new(group, field) if field_config.nil?
         groups = attribute_groups
         # No attribute groups applied
         return nil if groups.nil?

data/lib/springcm-sdk/resource.rb

@@ -30,6 +30,38 @@ module Springcm
       end
     end
 
+    # Send a PATCH request for this resource.
+    def patch
+      conn = @client.authorized_connection(url: @client.object_api_url)
+      res = conn.patch do |req|
+        req.headers['Content-Type'] = "application/json"
+        req.url resource_uri
+        req.body = raw.to_json
+      end
+      if res.success?
+        data = JSON.parse(res.body)
+        self.class.new(data, @client)
+      else
+        nil
+      end
+    end
+
+    # Send a PUT request for this resource.
+    def put
+      conn = @client.authorized_connection(url: @client.object_api_url)
+      res = conn.put do |req|
+        req.headers['Content-Type'] = "application/json"
+        req.url resource_uri
+        req.body = raw.to_json
+      end
+      if res.success?
+        data = JSON.parse(res.body)
+        self.class.new(data, @client)
+      else
+        nil
+      end
+    end
+
     # Send a DELETE request for this resource.
     def delete
       conn = @client.authorized_connection(url: @client.object_api_url)
@@ -52,10 +84,14 @@ module Springcm
 
     # Some resources have query parameters that must be passed when
     # retrieving it, e.g. expand=attributegroups when retrieving a document.
-    def resource_params
+    def self.resource_params
       {}
     end
 
+    def resource_params
+      self.class.resource_params
+    end
+
     # Pluralized resource name, e.g. documents or folders. Used to construct
     # request URLs.
     def resource_name

data/lib/springcm-sdk/version.rb

@@ -1,3 +1,3 @@
 module Springcm
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/springcm-sdk.rb

@@ -15,6 +15,18 @@ module Springcm
   class ConnectionInfoError < Error
   end
 
+  class NoAttributeGroupError < Error
+    def initialize(group)
+      super("No such attribute group: #{group}")
+    end
+  end
+
+  class NoAttributeFieldError < Error
+    def initialize(group, field)
+      super("No such attribute field: #{group}.#{field}")
+    end
+  end
+
   class InvalidClientIdOrSecretError < Error
     def initialize
       super("Invalid Client Id or Client Secret")
@@ -32,4 +44,10 @@ module Springcm
       super("Rate limit exceeded")
     end
   end
+
+  class DeleteRefusedError < Error
+    def initialize(path)
+      super("Refused to delete #{path}, use #delete! instead.")
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: springcm-sdk
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Paul Holden
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-27 00:00:00.000000000 Z
+date: 2020-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -187,7 +187,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.4.0
+  documentation_uri: https://rubydoc.info/github/paulholden2/springcm-sdk/0.5.0
   changelog_uri: https://github.com/paulholden2/springcm-sdk/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []