springcm-sdk 0.3.2 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08e2b1331f3dcb52b9ae6046ba374275586f58f287e7b47ab21d5d3e2b8733d5'
-  data.tar.gz: 7a5c41aed3ca626531c71527c1a30cbd2bd445b2f7eb001dadae940df843e1c3
+  metadata.gz: 4ad5c7b8f5ee94f60381f7a7c1584dade0d0e3a060f7a2914063e0d5c044db61
+  data.tar.gz: b314ab30a1191edf5df3ff00d629cb45184d01e10e12819b425c8a65c87b78a4
 SHA512:
-  metadata.gz: 8057fdf959e404fa084073027b9efed06b1ae04c6cb02ce6db7b15b225c961cd0e426a84ddc894fe946fcba4e58ea77781ce24ea25c2b08cb801a284bc32369b
-  data.tar.gz: c5781be7af9eee9a5493e75af6ecf5d0e1b7edc3df7efddd6379c9b3c1f2e576c2c62662486abe21cdd72e3ed5fc689456610f1a8ecac4cd66a74500f5cd2f21
+  metadata.gz: 05db834bd55f338e04f3d8b6275d87aa41727823300f339771934fe190eda689ff1b6e4fc120f9d9b7e00d6a7b4b8cc2961189af1ebde8bf1675d51d91658fde
+  data.tar.gz: 2d35b5c934bb4fe530e1f7e7d0ffd5f0424e1f1b8f63da0ae17c757d7d57003acc6c2e69398b42f00606b06489aa8425d8fd07501727381dc7ad346879c3f155

data/CHANGELOG.md

@@ -4,6 +4,27 @@ All notable changes to springcm-sdk will be documented in this file.
 
 ## [Unreleased]
 
+## [0.3.4] - 2019-12-11
+### Added
+* Folder#delete
+* Document#delete
+* Client#document (by path or UID)
+* Folder#move (by destination folder path or UID)
+* Document#move (by destination folder path or UID)
+* Account#attribute_groups
+* Mixins::Attributes#get_attribute
+
+### Changed
+* Tweaked PageBuilder to support items that don't have a parent folder.
+  Instead uses a base HREF to build next/prev/first/last HREFs. Similarly
+  modified ResourceBuilder to reference a parent object instead of a parent
+  folder. Outside of folders/documents, this parent object will simply be
+  the Account.
+
+## [0.3.3] - 2019-11-12
+### Changed
+* Fix issue with getting root folder by path
+
 ## [0.3.2]
 ### Changed
 * Fix issue with JSON library not being required
@@ -48,7 +69,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.3.2...HEAD
+[Unreleased]: https://github.com/paulholden2/springcm-sdk/compare/0.3.4...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
@@ -56,3 +77,5 @@ All notable changes to springcm-sdk will be documented in this file.
 [0.3.0]: https://github.com/paulholden2/springcm-sdk/releases/tag/0.3.0
 [0.3.1]: https://github.com/paulholden2/springcm-sdk/releases/tag/0.3.1
 [0.3.2]: https://github.com/paulholden2/springcm-sdk/releases/tag/0.3.2
+[0.3.3]: https://github.com/paulholden2/springcm-sdk/releases/tag/0.3.3
+[0.3.4]: https://github.com/paulholden2/springcm-sdk/releases/tag/0.3.4

data/lib/springcm-sdk/account.rb

@@ -1,6 +1,50 @@
 require "springcm-sdk/object"
+require "springcm-sdk/attribute_group"
 
 module Springcm
   class Account < Object
+    def initialize(data, client)
+      super(data, client)
+      @all_attribute_groups = nil
+    end
+
+    # Retrieve all attribute groups for this account. Calls #attribute_groups
+    # and concatenates results to a cache that is returned from future calls
+    # to #all_attribute_groups.
+    def all_attribute_groups
+      if @all_attribute_groups.nil?
+        load_all_attribute_groups
+      end
+      @all_attribute_groups
+    end
+
+    # Retrieve a page of attribute groups in this account. In most cases,
+    # you can call #all_attribute_groups instead, as attribute group
+    # configurations do not frequently change.
+    def attribute_groups(offset: 0, limit: 20)
+      conn = @client.authorized_connection(url: @client.object_api_url)
+      res = conn.get do |req|
+        req.url "accounts/current/attributegroups"
+        req.params["offset"] = offset
+        req.params["limit"] = limit
+      end
+      if res.success?
+        data = JSON.parse(res.body)
+        ResourceList.new(data, self, AttributeGroup, @client)
+      else
+        nil
+      end
+    end
+
+    private
+
+    def load_all_attribute_groups
+      @all_attribute_groups = []
+      list = attribute_groups(offset: 0, limit: 20)
+      while !list.nil?
+        @all_attribute_groups.concat(list.items)
+        list = list.next
+      end
+    end
   end
 end

data/lib/springcm-sdk/attribute.rb

@@ -0,0 +1,17 @@
+require "springcm-sdk/resource"
+
+module Springcm
+  class Attribute < Resource
+    def required?
+      required
+    end
+
+    def read_only?
+      read_only
+    end
+
+    def repeating_attribute?
+      repeating_attribute
+    end
+  end
+end

data/lib/springcm-sdk/attribute_group.rb

@@ -0,0 +1,56 @@
+require "springcm-sdk/resource"
+require "springcm-sdk/attribute"
+
+module Springcm
+  # A configured attribute group in SpringCM.
+  class AttributeGroup < Resource
+    # Retrieve an attribute set by name.
+    def set(name)
+      res = @data["Attributes"].select { |attr|
+        attr["Attributes"].is_a?(Array) && attr["Name"] == name
+      }
+      return nil if !res.any?
+      res.first["Attributes"].map { |attr|
+        Attribute.new(attr, @client)
+      }
+    end
+
+    # Retrieve an attribute field by name.
+    def field(name)
+      res = attributes.select { |attr|
+        attr["Name"] == name
+      }
+      return nil if !res.any?
+      # TODO: Assert only one result
+      Attribute.new(res.first, @client)
+    end
+
+    def set_for_field(name)
+      if sets.map { |set| set["Name"] }.include?(name)
+        return nil
+      end
+      sets.each { |set|
+        if set["Attributes"].map { |attr| attr["Name"] }.include?(name)
+          return set
+        end
+      }
+      nil
+    end
+
+    def attributes
+      @data["Attributes"].map { |attr|
+        if attr["Attributes"].is_a?(Array)
+          attr["Attributes"]
+        else
+          [attr]
+        end
+      }.flatten
+    end
+
+    def sets
+      @data["Attributes"].select { |attr|
+        attr["Attributes"].is_a?(Array)
+      }
+    end
+  end
+end

data/lib/springcm-sdk/client.rb

@@ -95,6 +95,9 @@ module Springcm
       if (path.nil? && uid.nil?) || (!path.nil? && !uid.nil?)
         raise ArgumentError.new("Specify exactly one of: path, uid")
       end
+      if path == "/"
+        return root_folder
+      end
       conn = authorized_connection(url: object_api_url)
       res = conn.get do |req|
         if !path.nil?
@@ -103,6 +106,9 @@ module Springcm
         elsif !uid.nil?
           req.url "folders/#{uid}"
         end
+        Folder.resource_params.each { |key, value|
+          req.params[key] = value
+        }
       end
       if res.success?
         data = JSON.parse(res.body)
@@ -112,6 +118,30 @@ module Springcm
       end
     end
 
+    def document(path: nil, uid: nil)
+      if (path.nil? && uid.nil?) || (!path.nil? && !uid.nil?)
+        raise ArgumentError.new("Specify exactly one of: path, uid")
+      end
+      conn = authorized_connection(url: object_api_url)
+      res = conn.get do |req|
+        if !path.nil?
+          req.url "documents"
+          req.params["path"] = path
+        elsif !uid.nil?
+          req.url "documents/#{uid}"
+        end
+        Document.resource_params.each { |key, value|
+          req.params[key] = value
+        }
+      end
+      if res.success?
+        data = JSON.parse(res.body)
+        return Document.new(data, self)
+      else
+        nil
+      end
+    end
+
     # Check if client is successfully authenticated
     # @return [Boolean] Whether a valid, unexpired access token is held.
     def authenticated?

data/lib/springcm-sdk/document.rb

@@ -1,8 +1,17 @@
 require "springcm-sdk/resource"
 require "springcm-sdk/mixins/access_level"
+require "springcm-sdk/mixins/attributes"
 
 module Springcm
   class Document < Resource
-    include Springcm::AccessLevel
+    include Springcm::Mixins::AccessLevel
+    include Springcm::Mixins::ParentFolder
+    include Springcm::Mixins::Attributes
+
+    def self.resource_params
+      {
+        "expand" => "attributegroups"
+      }
+    end
   end
 end

data/lib/springcm-sdk/folder.rb

@@ -7,15 +7,22 @@ require "springcm-sdk/helpers"
 
 module Springcm
   class Folder < Resource
-    include Springcm::AccessLevel
-    include Springcm::ParentFolder
-    include Springcm::Documents
+    include Springcm::Mixins::AccessLevel
+    include Springcm::Mixins::ParentFolder
+    include Springcm::Mixins::Documents
 
+    def self.resource_params
+      {
+        "expand" => "attributegroups"
+      }
+    end
+
+    # Retrieve a page of folders contained in this folder.
     def folders(offset: 0, limit: 20)
       Helpers.validate_offset_limit!(offset, limit)
       conn = @client.authorized_connection(url: @client.object_api_url)
       res = conn.get do |req|
-        req.url "folders/#{uid}/folders"
+        req.url "#{resource_uri}/folders"
         req.params["offset"] = offset
         req.params["limit"] = limit
       end
@@ -27,12 +34,16 @@ module Springcm
       end
     end
 
+    # Retrieve the containing folder.
     def parent_folder
       uri = URI(parent_folder_href)
       url = "#{uri.scheme}://#{uri.host}"
       conn = @client.authorized_connection(url: url)
       res = conn.get do |req|
         req.url uri.path
+        resource_params.each { |key, value|
+          req.params[key] = value
+        }
       end
       if res.success?
         data = JSON.parse(res.body)
@@ -42,6 +53,7 @@ module Springcm
       end
     end
 
+    # Retrieve a page of documents in this folder.
     def documents(offset: 0, limit: 20)
       Helpers.validate_offset_limit!(offset, limit)
       uri = URI(documents_href)

data/lib/springcm-sdk/helpers.rb

@@ -1,5 +1,6 @@
 module Springcm
   module Helpers
+    # Validate an offset and limit pair.
     def self.validate_offset_limit!(offset, limit)
       if !limit.is_a?(Integer) || limit < 1 || limit > 1000
         raise ArgumentError.new("Limit must be an integer between 1 and 1000 (inclusive).")

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

@@ -1,37 +1,40 @@
 module Springcm
-  module AccessLevel
-    # @return [Boolean] Does the API user have see permission
-    def see?
-      !!access_level.dig("See")
-    end
+  module Mixins
+    # Mixin for objects that have security attached, e.g. folders.
+    module AccessLevel
+      # @return [Boolean] Does the API user have see permission
+      def see?
+        !!access_level.dig("See")
+      end
 
-    # @return [Boolean] Does the API user have read permission
-    def read?
-      !!access_level.dig("Read")
-    end
+      # @return [Boolean] Does the API user have read permission
+      def read?
+        !!access_level.dig("Read")
+      end
 
-    # @return [Boolean] Does the API user have write permission
-    def write?
-      !!access_level.dig("Write")
-    end
+      # @return [Boolean] Does the API user have write permission
+      def write?
+        !!access_level.dig("Write")
+      end
 
-    # @return [Boolean] Does the API user have move permission
-    def move?
-      !!access_level.dig("Move")
-    end
+      # @return [Boolean] Does the API user have move permission
+      def move?
+        !!access_level.dig("Move")
+      end
 
-    # @return [Boolean] Does the API user have create permission
-    def create?
-      !!access_level.dig("Create")
-    end
+      # @return [Boolean] Does the API user have create permission
+      def create?
+        !!access_level.dig("Create")
+      end
 
-    # @return [Boolean] Does the API user have set access permission
-    def set_access?
-      !!access_level.dig("SetAccess")
-    end
+      # @return [Boolean] Does the API user have set access permission
+      def set_access?
+        !!access_level.dig("SetAccess")
+      end
 
-    def access_level
-      @data.fetch("AccessLevel")
+      def access_level
+        @data.fetch("AccessLevel")
+      end
     end
   end
 end

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

@@ -0,0 +1,52 @@
+module Springcm
+  module Mixins
+    # Mixin for objects that have attributes.
+    module Attributes
+      def deserialize_field(field)
+        type = field["AttributeType"]
+        value = field["Value"]
+        if type == "String"
+          value
+        elsif type == "Number"
+          value.to_i
+        elsif type == "Decimal"
+          value.to_f
+        elsif type == "Date"
+          Date.strptime(value[0..8], "%Y%m%d")
+        else
+          value
+        end
+      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?
+        field_config = group_config.field(field)
+        field_set_config = group_config.set_for_field(field)
+        # Non-existent field
+        return nil 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|
+            deserialize_field(item[field])
+          }
+        else
+          field_data = group_data.fetch(field, nil)
+          return nil if field_data.nil?
+          deserialize_field(field_data)
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,9 @@
 module Springcm
-  module Documents
-    def documents_href
-      @data.dig("Documents", "Href")
+  module Mixins
+    module Documents
+      def documents_href
+        @data.dig("Documents", "Href")
+      end
     end
   end
 end

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

@@ -1,8 +1,30 @@
 module Springcm
-  module ParentFolder
-    def parent_folder_href
-      # Root folders won't have ParentFolder key
-      @data.dig("ParentFolder", "Href")
+  module Mixins
+    # Mixin for objects that have a parent folder.
+    module ParentFolder
+      def parent_folder_href
+        # Root folders won't have ParentFolder key
+        @data.dig("ParentFolder", "Href")
+      end
+
+      def move(path: nil, uid: nil)
+        parent = @client.folder(path: path, uid: uid)
+        body = {
+          "ParentFolder" => parent.raw
+        }
+        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 = body.to_json
+        end
+        if res.success?
+          data = JSON.parse(res.body)
+          self.class.new(data, @client)
+        else
+          nil
+        end
+      end
     end
   end
 end

data/lib/springcm-sdk/object.rb

@@ -5,6 +5,15 @@ module Springcm
       @data = data
     end
 
+    # Retrieve a top-level property of the object's JSON data.
+    #
+    # For convenience, top-level properties of a SpringCM object's JSON data
+    # are accessible via instance methods (underscore format), e.g.
+    # attribute_groups to retrieve JSON for $.AttributeGroups. This can be and
+    # is often overridden by inheriting classes by defining a method and
+    # extending what it does. Some mixins also provide convenience methods
+    # 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
       if @data.key?(key)
@@ -13,5 +22,10 @@ module Springcm
         super
       end
     end
+
+    # Retrieve the raw JSON document for this object.
+    def raw
+      @data
+    end
   end
 end

data/lib/springcm-sdk/resource.rb

@@ -1,10 +1,65 @@
 require "springcm-sdk/object"
 
 module Springcm
+  # A Resource is a SpringCM object that has an auto-assigned GUID.
   class Resource < Object
-    # @return [String] The folder unique identifier (UID)
+    # @return [String] The object's unique identifier (UID)
     def uid
       href[-36..-1]
     end
+
+    # Resend a request to the API for this resource and return a new instance.
+    def reload
+      get
+    end
+
+    # Send a GET request for this resource.
+    def get
+      conn = @client.authorized_connection(url: @client.object_api_url)
+      res = conn.get do |req|
+        req.url resource_uri
+        resource_params.each { |key, value|
+          req.params[key] = value
+        }
+      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)
+      res = conn.delete do |req|
+        req.url resource_uri
+      end
+      if res.success?
+        data = JSON.parse(res.body)
+        reload
+      else
+        nil
+      end
+    end
+
+    # Retrieve the URI for this resource (relative to the base object API
+    # URL).
+    def resource_uri
+      "#{resource_name}/#{uid}"
+    end
+
+    # Some resources have query parameters that must be passed when
+    # retrieving it, e.g. expand=attributegroups when retrieving a document.
+    def resource_params
+      {}
+    end
+
+    # Pluralized resource name, e.g. documents or folders. Used to construct
+    # request URLs.
+    def resource_name
+      "#{self.class.to_s.split("::").last.downcase}s"
+    end
   end
 end

data/lib/springcm-sdk/resource_list.rb

@@ -1,7 +1,11 @@
 module Springcm
+  # A list object of arbitrary SpringCM resources. Allows for easy navigation
+  # of paged resources like documents and attribute groups. All resources
+  # that are retrieved in this manner are attached to a parent object, e.g.
+  # the account for attribute groups, or a folder for documents.
   class ResourceList < Object
-    def initialize(data, parent_folder, kind, client)
-      @parent_folder = parent_folder
+    def initialize(data, parent_object, kind, client)
+      @parent_object = parent_object
       @kind = kind
       super(data, client)
     end
@@ -38,7 +42,7 @@ module Springcm
       query = CGI.parse(uri.query || "")
       offset = query.fetch("offset", ["0"]).first.to_i
       limit = query.fetch("limit", ["20"]).first.to_i
-      @parent_folder.send(method, offset: offset, limit: limit)
+      @parent_object.send(method, offset: offset, limit: limit)
     end
 
     def method_for_kind!(kind)
@@ -47,8 +51,10 @@ module Springcm
         method = :folders
       elsif kind == Springcm::Document
         method = :documents
+      elsif kind == Springcm::AttributeGroup
+        method = :attribute_groups
       else
-        raise ArgumentError.new("Resource kind must be one of: Springcm::Document, Springcm::Folder.")
+        raise ArgumentError.new("Resource kind must be one of: Springcm::Document, Springcm::Folder, Springcm::AttributeGroup.")
       end
       return method
     end

data/lib/springcm-sdk/version.rb

@@ -1,3 +1,3 @@
 module Springcm
-  VERSION = "0.3.2"
+  VERSION = "0.3.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: springcm-sdk
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.4
 platform: ruby
 authors:
 - Paul Holden
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-08 00:00:00.000000000 Z
+date: 2019-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -160,11 +160,14 @@ files:
 - exe/springcm
 - lib/springcm-sdk.rb
 - lib/springcm-sdk/account.rb
+- lib/springcm-sdk/attribute.rb
+- lib/springcm-sdk/attribute_group.rb
 - lib/springcm-sdk/client.rb
 - lib/springcm-sdk/document.rb
 - lib/springcm-sdk/folder.rb
 - lib/springcm-sdk/helpers.rb
 - lib/springcm-sdk/mixins/access_level.rb
+- lib/springcm-sdk/mixins/attributes.rb
 - lib/springcm-sdk/mixins/documents.rb
 - lib/springcm-sdk/mixins/parent_folder.rb
 - lib/springcm-sdk/object.rb
@@ -179,7 +182,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.3.2
+  documentation_uri: https://rubydoc.info/github/paulholden2/springcm-sdk/0.3.4
   changelog_uri: https://github.com/paulholden2/springcm-sdk/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []