springcm-sdk 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6147bd5e61e56858a0c7bd91d8aab95a718b580e32e42f1fe7de34a2599742a
-  data.tar.gz: 84260d0c7050d3675765f7d481da6ca261e98ad900c272731de26daa8d1792a5
+  metadata.gz: 82c89b40586e83b4ac5e875be284b7f399be97beeeba634e3e500dd8e98fcff2
+  data.tar.gz: b0584226929818e8088afc36c9172cdc21a4d894217fd1e877eb126da1d731a7
 SHA512:
-  metadata.gz: 3ed35a3f5b082bf08b7e4162f8a6491f8a27d8f4d6ffb9a88de4116dd2b1c078cb564f161d683c557c0eda46b9251dfb23f7ffee6aec592d64ca804cde7af254
-  data.tar.gz: cf064b9ea38ac974f63f87d67e548aab6e58fed69d545bff2e84da68e30be373b9c1924954c16ee6a5ad582cd58eb1a6930e56a0f4b37f2b4657b31fa4b9c3ea
+  metadata.gz: f09f4b7a972bdda28ca3c48653acec5da3e9f8fe77170ff46b7973b0c66d4a911fecb376308377661a1e00680d110412353cf8d2adcc8e3134e39930fc470048
+  data.tar.gz: 661b3763c4fdeace47f06e4bf0cd731960809dd6b6454da7a2cf908bd83190b6ac74ee687efaa5a489b30b8bb79760aa90ae156181368a6d27fa244f3d9b3a6e

data/CHANGELOG.md

@@ -4,6 +4,21 @@ All notable changes to springcm-sdk will be documented in this file.
 
 ## [Unreleased]
 
+## [0.6.0] - 2020-01-13
+### Added
+* Document versions via #versions method. Document versions behave much like
+  normal Documents, but have some different behaviors.
+* Document#download method.
+* Resource#reload! method, to reload a resource object in-place.
+* Security setting updates for Folders.
+* Users and Groups.
+
+### Changed
+* Path is expanded when retrieving individual Folders.
+
+### Removed
+* `springcm` executable. Will be provided via the springcm-cli gem.
+
 ## [0.5.0] - 2020-01-03
 ### Added
 * #patch and #put for Resources.
@@ -124,3 +139,4 @@ All notable changes to springcm-sdk will be documented in this file.
 [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
+[0.6.0]: https://github.com/paulholden2/springcm-sdk/releases/tag/0.6.0

data/lib/springcm-sdk/account.rb

@@ -22,6 +22,7 @@ module Springcm
     # you can call #all_attribute_groups instead, as attribute group
     # configurations do not frequently change.
     def attribute_groups(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 "accounts/current/attributegroups"

data/lib/springcm-sdk/change_security_task.rb

@@ -0,0 +1,27 @@
+require "springcm-sdk/resource"
+
+module Springcm
+  class ChangeSecurityTask < Resource
+    def await!(interval: 1, tries: 10, backoff: 2)
+      while tries > 0
+        return true if complete?
+        sleep(interval)
+        interval *= backoff
+        tries -= 1
+      end
+      raise Springcm::ChangeSecurityTaskAwaitTimeout.new
+    end
+
+    def await(interval: 1, tries: 10, backoff: 2)
+      begin
+        await!(interval: interval, tries: tries, backoff: backoff)
+      rescue Springcm::ChangeSecurityTaskAwaitTimeout => timeout
+        return false
+      end
+    end
+
+    def complete?
+      get.status == "Success"
+    end
+  end
+end

data/lib/springcm-sdk/client.rb

@@ -3,6 +3,7 @@ require "json"
 require "springcm-sdk/account"
 require "springcm-sdk/folder"
 require "springcm-sdk/document"
+require "springcm-sdk/group"
 require "springcm-sdk/middleware"
 
 module Springcm
@@ -159,6 +160,38 @@ module Springcm
       end
     end
 
+    def groups(offset: 0, limit: 20)
+      Helpers.validate_offset_limit!(offset, limit)
+      conn = authorized_connection(url: object_api_url)
+      res = conn.get do |req|
+        req.url "groups"
+        req.params["offset"] = offset
+        req.params["limit"] = limit
+      end
+      if res.success?
+        data = JSON.parse(res.body)
+        ResourceList.new(data, self, Group, self)
+      else
+        nil
+      end
+    end
+
+    def users(offset: 0, limit: 20)
+      Helpers.validate_offset_limit!(offset, limit)
+      conn = authorized_connection(url: object_api_url)
+      res = conn.get do |req|
+        req.url "users"
+        req.params["offset"] = offset
+        req.params["limit"] = limit
+      end
+      if res.success?
+        data = JSON.parse(res.body)
+        ResourceList.new(data, self, User, 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,6 +1,7 @@
 require "springcm-sdk/resource"
 require "springcm-sdk/mixins/access_level"
 require "springcm-sdk/mixins/attributes"
+require "springcm-sdk/mixins/parent_folder"
 require "springcm-sdk/history_item"
 
 module Springcm
@@ -15,6 +16,23 @@ module Springcm
       }
     end
 
+    def download
+      io = StringIO.new
+      conn = @client.authorized_connection(url: @client.download_api_url)
+      res = conn.get do |req|
+        req.url resource_uri
+        req.options.on_data = Proc.new do |chunk, total_bytes|
+          io << chunk
+        end
+      end
+      if res.success?
+        io.rewind
+        io
+      else
+        nil
+      end
+    end
+
     def history(offset: 0, limit: 20)
       Helpers.validate_offset_limit!(offset, limit)
       conn = @client.authorized_connection(url: @client.object_api_url)
@@ -31,6 +49,22 @@ module Springcm
       end
     end
 
+    def versions(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 "#{resource_uri}/versions"
+        req.params["offset"] = offset
+        req.params["limit"] = limit
+      end
+      if res.success?
+        data = JSON.parse(res.body)
+        ResourceList.new(data, self, Document, @client, method_override: :versions)
+      else
+        nil
+      end
+    end
+
     def delete!
       unsafe_delete
     end
@@ -39,7 +73,7 @@ module Springcm
     private :unsafe_delete
 
     def delete
-      reload
+      reload!
       if path.start_with?("/#{@client.account.name}/Trash")
         raise Springcm::DeleteRefusedError.new(path)
       end

data/lib/springcm-sdk/folder.rb

@@ -1,9 +1,12 @@
 require "springcm-sdk/resource"
+require "springcm-sdk/document"
 require "springcm-sdk/resource_list"
+require "springcm-sdk/change_security_task"
 require "springcm-sdk/mixins/access_level"
 require "springcm-sdk/mixins/parent_folder"
 require "springcm-sdk/mixins/documents"
 require "springcm-sdk/helpers"
+require "uri"
 
 module Springcm
   class Folder < Resource
@@ -13,7 +16,7 @@ module Springcm
 
     def self.resource_params
       {
-        "expand" => "attributegroups"
+        "expand" => "attributegroups,path"
       }
     end
 
@@ -71,5 +74,63 @@ module Springcm
         nil
       end
     end
+
+    def upload(name:, file:, type: :binary)
+      file_types = {
+        binary: "application/octet-stream",
+        pdf: "application/pdf",
+        csv: "text/csv",
+        txt: "text/plain"
+      }
+      if !type.nil? && !file_types.keys.include?(type)
+        raise ArgumentError.new("File type must be one of: nil, #{file_types.map(&:inspect).join(", ")}")
+      end
+      conn = @client.authorized_connection(url: @client.upload_api_url)
+      res = conn.post do |req|
+        req.headers["Content-Type"] = file_types[type]
+        req.headers["Content-Length"] = file.size.to_s
+        req.url "folders/#{uid}/documents?name=#{URI.escape(name)}"
+        req.body = file
+      end
+      if res.success?
+        data = JSON.parse(res.body)
+        Document.new(data, @client)
+      else
+        nil
+      end
+    end
+
+    def update_security(group:, access:)
+      Helpers.validate_access!(access)
+      if !group.is_a?(Springcm::Group)
+        raise ArgumentError.new("Invalid group; must be a Springcm::Group")
+      end
+      if group.group_type != "Security"
+        raise ArgumentError.new("Invalid group type; must be a security group")
+      end
+      conn = @client.authorized_connection(url: @client.object_api_url)
+      res = conn.post do |req|
+        req.headers["Content-Type"] = "application/json"
+        req.url "changesecuritytasks"
+        req.body = {
+          "Status" => "",
+          "Security" => {
+            "Groups" => [
+              {
+                "Item" => group.raw,
+                "AccessType" => access.to_s.split('_').map(&:capitalize).join
+              }
+            ]
+          },
+          "Folder" => raw
+        }.to_json
+      end
+      if res.success?
+        data = JSON.parse(res.body)
+        ChangeSecurityTask.new(data, @client)
+      else
+        nil
+      end
+    end
   end
 end

data/lib/springcm-sdk/group.rb

@@ -0,0 +1,23 @@
+require "springcm-sdk/resource"
+require "springcm-sdk/user"
+
+module Springcm
+  class Group < Resource
+    # @return [ResourceList] Users that are a member of the specified Group.
+    def users(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 "#{resource_uri}/groupmembers"
+        req.params["offset"] = offset
+        req.params["limit"] = limit
+      end
+      if res.success?
+        data = JSON.parse(res.body)
+        ResourceList.new(data, self, User, @client)
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/springcm-sdk/helpers.rb

@@ -13,6 +13,7 @@ module Springcm
 
     def self.serialize_field(field_config, value)
       type = field_config.type
+      name = field_config.name
       repeating = field_config.repeating_attribute?
       serialized = {
         "AttributeType" => type,
@@ -46,5 +47,20 @@ module Springcm
         value
       end
     end
+
+    def self.validate_access!(access)
+      access_types = [
+        :inherit_from_parent_folder,
+        :no_access,
+        :view,
+        :view_create,
+        :view_edit,
+        :view_edit_delete,
+        :view_edit_delete_set_access
+      ]
+      if !access_types.include?(access)
+        raise ArgumentError.new("Access must be one of: #{access_types.map(&:inspect).join(", ")}")
+      end
+    end
   end
 end

data/lib/springcm-sdk/middleware/rate_limit.rb

@@ -10,6 +10,7 @@ module Springcm
 
       def call(env)
         @app.call(env).on_complete do |response_env|
+          return response_env if response_env[:response].env.response_headers["Content-Type"] != "application/json"
           body = JSON.parse(response_env[:body])
           if body.fetch("Error", {}).fetch("ErrorCode", nil) == 103
             raise Springcm::RateLimitExceededError.new

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

@@ -8,7 +8,26 @@ module Springcm
         @data["AttributeGroups"] = value
       end
 
-      def set_attribute(group:, field:, index: nil, value:)
+      # 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
@@ -24,10 +43,28 @@ module Springcm
         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))
+          field_data = {
+            "#{field}" => Springcm::Helpers.serialize_field(field_config, value)
+          }
+          if mode == :insert
+            set_data["Items"].insert(index || -1, field_data)
+          elsif
+            set_data["Items"][index] = field_data
+          end
+          set_data["Items"].reject!(&:nil?)
           group_data[set_name] = set_data
         else
-          group_data[field] = Springcm::Helpers.serialize_field(field_config, value)
+          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
         end
         groups[group] = group_data
         attribute_groups = groups

data/lib/springcm-sdk/resource.rb

@@ -13,6 +13,13 @@ module Springcm
       get
     end
 
+    # Resend a request to the API for this resource and modify the data for
+    # the current object in-place.
+    def reload!
+      @data = reload.raw
+      self
+    end
+
     # Send a GET request for this resource.
     def get
       conn = @client.authorized_connection(url: @client.object_api_url)

data/lib/springcm-sdk/resource_list.rb

@@ -4,9 +4,10 @@ module Springcm
   # 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_object, kind, client)
+    def initialize(data, parent_object, kind, client, method_override: nil)
       @parent_object = parent_object
       @kind = kind
+      @method_override = method_override
       super(data, client)
     end
 
@@ -45,9 +46,13 @@ module Springcm
       @parent_object.send(method, offset: offset, limit: limit)
     end
 
+    # TODO: Better pattern for generating related links
+    #       Possibly a Springcm::DocumentVersion object?
     def method_for_kind!(kind)
       method = nil
-      if kind == Springcm::Folder
+      if !@method_override.nil?
+        method = @method_override
+      elsif kind == Springcm::Folder
         method = :folders
       elsif kind == Springcm::Document
         method = :documents
@@ -55,8 +60,12 @@ module Springcm
         method = :attribute_groups
       elsif kind == Springcm::HistoryItem
         method = :history
+      elsif kind == Springcm::Group
+        method = :groups
+      elsif kind == Springcm::User
+        method = :users
       else
-        raise ArgumentError.new("Resource kind must be one of: Springcm::Document, Springcm::Folder, Springcm::AttributeGroup, Springcm::HistoryItem.")
+        raise ArgumentError.new("Resource kind must be one of: Springcm::Document, Springcm::Folder, Springcm::AttributeGroup, Springcm::HistoryItem, Springcm::User, Springcm::Group.")
       end
       return method
     end

data/lib/springcm-sdk/user.rb

@@ -0,0 +1,23 @@
+require "springcm-sdk/resource"
+require "springcm-sdk/group"
+
+module Springcm
+  class User < Resource
+    # @return [ResourceList] Groups that the specified User is a member of.
+    def groups(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 "#{resource_uri}/groups"
+        req.params["offset"] = offset
+        req.params["limit"] = limit
+      end
+      if res.success?
+        data = JSON.parse(res.body)
+        ResourceList.new(data, self, Group, @client)
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/springcm-sdk/version.rb

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

data/lib/springcm-sdk.rb

@@ -50,4 +50,10 @@ module Springcm
       super("Refused to delete #{path}, use #delete! instead.")
     end
   end
+
+  class ChangeSecurityTaskAwaitTimeout < Error
+    def initialize
+      super("Timed out while awaiting ChangeSecurityTask to complete.")
+    end
+  end
 end

data/springcm-sdk.gemspec

@@ -34,10 +34,10 @@ Gem::Specification.new do |spec|
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = "exe"
-  spec.executables   = ["springcm"]
+  spec.executables   = []
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "faraday", "~> 0.17.1"
+  spec.add_dependency "faraday", "~> 1.0"
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 13.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: springcm-sdk
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Paul Holden
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-03 00:00:00.000000000 Z
+date: 2020-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -140,8 +140,7 @@ description: A library for working with the SpringCM REST API and associated obj
   in Ruby applications.
 email:
 - pholden@stria.com
-executables:
-- springcm
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -157,14 +156,15 @@ files:
 - bin/.gitignore
 - bin/console
 - bin/setup
-- 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/change_security_task.rb
 - lib/springcm-sdk/client.rb
 - lib/springcm-sdk/document.rb
 - lib/springcm-sdk/folder.rb
+- lib/springcm-sdk/group.rb
 - lib/springcm-sdk/helpers.rb
 - lib/springcm-sdk/history_item.rb
 - lib/springcm-sdk/middleware.rb
@@ -178,6 +178,7 @@ files:
 - lib/springcm-sdk/object.rb
 - lib/springcm-sdk/resource.rb
 - lib/springcm-sdk/resource_list.rb
+- lib/springcm-sdk/user.rb
 - lib/springcm-sdk/version.rb
 - springcm-sdk.gemspec
 homepage: https://github.com/paulholden2/springcm-sdk
@@ -187,7 +188,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.5.0
+  documentation_uri: https://rubydoc.info/github/paulholden2/springcm-sdk/0.6.0
   changelog_uri: https://github.com/paulholden2/springcm-sdk/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []

data/exe/springcm

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-
-require "springcm-sdk"