springcm-sdk 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ad5c7b8f5ee94f60381f7a7c1584dade0d0e3a060f7a2914063e0d5c044db61
-  data.tar.gz: b314ab30a1191edf5df3ff00d629cb45184d01e10e12819b425c8a65c87b78a4
+  metadata.gz: 3e3841da2b35c8107f04251234a0850ab33fe344099fb586d1f7ffe19a8fc0fb
+  data.tar.gz: f145bc61a250cb7ee978f3dfed0ec20f9961f60e329579b31ba8a7b359325265
 SHA512:
-  metadata.gz: 05db834bd55f338e04f3d8b6275d87aa41727823300f339771934fe190eda689ff1b6e4fc120f9d9b7e00d6a7b4b8cc2961189af1ebde8bf1675d51d91658fde
-  data.tar.gz: 2d35b5c934bb4fe530e1f7e7d0ffd5f0424e1f1b8f63da0ae17c757d7d57003acc6c2e69398b42f00606b06489aa8425d8fd07501727381dc7ad346879c3f155
+  metadata.gz: 8d6f2862635fdb5258bfb5b5814c12772e55414e82ab2c9a218e5b6b0b59331627e6276290cfc55929f31d7002fcc01650cdf38d4a9d3581639e405b6fe19a15
+  data.tar.gz: 5d8fc9460e4d2e7c5c526e81a618846a74f0d54565688a46b08b373977ff09df50bb0417a3db379a5e5b8af49fd70cfc292057a06ac0c1cd285b686ed0850e90

data/CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to springcm-sdk will be documented in this file.
 
 ## [Unreleased]
 
+## [0.3.5] - 2019-12-23
+### Added
+* Document#history
+* History items
+
 ## [0.3.4] - 2019-12-11
 ### Added
 * Folder#delete
@@ -69,7 +74,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.4...HEAD
+[Unreleased]: https://github.com/paulholden2/springcm-sdk/compare/0.3.5...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
@@ -79,3 +84,4 @@ All notable changes to springcm-sdk will be documented in this file.
 [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
+[0.3.5]: https://github.com/paulholden2/springcm-sdk/releases/tag/0.3.5

data/README.md

@@ -1,6 +1,6 @@
 # SpringCM SDK
 
-[![Gem Version](https://badge.fury.io/rb/springcm-sdk.svg)](https://badge.fury.io/rb/springcm-sdk) [![Build Status](https://travis-ci.org/paulholden2/springcm-sdk.svg?branch=master)](https://travis-ci.org/paulholden2/springcm-sdk) [![Maintainability](https://api.codeclimate.com/v1/badges/06e1dd90fde417de15da/maintainability)](https://codeclimate.com/github/paulholden2/springcm-sdk/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/06e1dd90fde417de15da/test_coverage)](https://codeclimate.com/github/paulholden2/springcm-sdk/test_coverage)
+[![Gem Version](https://badge.fury.io/rb/springcm-sdk.svg)](https://badge.fury.io/rb/springcm-sdk) [![Depfu](https://badges.depfu.com/badges/d19cc9a4361b84a276e21997c49e640e/overview.svg)](https://depfu.com/github/paulholden2/springcm-sdk?project_id=10385) [![Build Status](https://travis-ci.org/paulholden2/springcm-sdk.svg?branch=master)](https://travis-ci.org/paulholden2/springcm-sdk) [![Maintainability](https://api.codeclimate.com/v1/badges/06e1dd90fde417de15da/maintainability)](https://codeclimate.com/github/paulholden2/springcm-sdk/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/06e1dd90fde417de15da/test_coverage)](https://codeclimate.com/github/paulholden2/springcm-sdk/test_coverage)
 
 This gem is a library for working with the SpringCM REST API.
 

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/history_item"
 
 module Springcm
   class Document < Resource
@@ -13,5 +14,21 @@ module Springcm
         "expand" => "attributegroups"
       }
     end
+
+    def history(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}/historyitems"
+        req.params["offset"] = offset
+        req.params["limit"] = limit
+      end
+      if res.success?
+        data = JSON.parse(res.body)
+        ResourceList.new(data, self, HistoryItem, @client)
+      else
+        nil
+      end
+    end
   end
 end

data/lib/springcm-sdk/helpers.rb

@@ -10,5 +10,22 @@ module Springcm
         raise ArgumentError.new("Offset must be a positive, non-zero integer.")
       end
     end
+
+    # Deserialize a SpringCM attribute value
+    def self.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
   end
 end

data/lib/springcm-sdk/history_item.rb

@@ -0,0 +1,4 @@
+module Springcm
+  class HistoryItem < Springcm::Object
+  end
+end

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

@@ -1,23 +1,9 @@
+require "springcm-sdk/helpers"
+
 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
@@ -39,12 +25,12 @@ module Springcm
           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])
+            Springcm::Helpers.deserialize_field(item[field])
           }
         else
           field_data = group_data.fetch(field, nil)
           return nil if field_data.nil?
-          deserialize_field(field_data)
+          Springcm::Helpers.deserialize_field(field_data)
         end
       end
     end

data/lib/springcm-sdk/resource_list.rb

@@ -53,8 +53,10 @@ module Springcm
         method = :documents
       elsif kind == Springcm::AttributeGroup
         method = :attribute_groups
+      elsif kind == Springcm::HistoryItem
+        method = :history_items
       else
-        raise ArgumentError.new("Resource kind must be one of: Springcm::Document, Springcm::Folder, Springcm::AttributeGroup.")
+        raise ArgumentError.new("Resource kind must be one of: Springcm::Document, Springcm::Folder, Springcm::AttributeGroup, Springcm::HistoryItem.")
       end
       return method
     end

data/lib/springcm-sdk/version.rb

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

data/springcm-sdk.gemspec

@@ -37,10 +37,10 @@ Gem::Specification.new do |spec|
   spec.executables   = ["springcm"]
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "faraday", "~> 0.15.4"
+  spec.add_dependency "faraday", "~> 0.17.1"
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "sinatra", "~> 2.0"
   spec.add_development_dependency "webmock", "~> 3.6"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: springcm-sdk
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Paul Holden
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-11 00:00:00.000000000 Z
+date: 2019-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.4
+        version: 0.17.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.4
+        version: 0.17.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -166,6 +166,7 @@ files:
 - lib/springcm-sdk/document.rb
 - lib/springcm-sdk/folder.rb
 - lib/springcm-sdk/helpers.rb
+- lib/springcm-sdk/history_item.rb
 - lib/springcm-sdk/mixins/access_level.rb
 - lib/springcm-sdk/mixins/attributes.rb
 - lib/springcm-sdk/mixins/documents.rb
@@ -182,7 +183,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.4
+  documentation_uri: https://rubydoc.info/github/paulholden2/springcm-sdk/0.3.5
   changelog_uri: https://github.com/paulholden2/springcm-sdk/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []