springcm-sdk 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c626238746aa02cfd403653085370636c99af119aa8881ae0b46173af1f06c8e
-  data.tar.gz: 9c1c8f3fef1867d2eac0fbfca2859d30d700de0ca14834c411b761d053cc854b
+  metadata.gz: 70227f140ad8a68e84bd32aec03aeb899633107045e5c851e40f8b7d73068ede
+  data.tar.gz: bdc7c10bea0a4d8325816b55252d585a3d1898b53a040978023498e6f19cfb93
 SHA512:
-  metadata.gz: 151e2a843f61d1e9363cb1e821423a09b8f8205e45818853be4daf57268cbfbf81ea11f171d4ef2d0876ab7d543bc5dbf065279f02f65f905ae00e910f699b59
-  data.tar.gz: de8e1e91215603118cd19f467447bc28daa99dfb4e0cc6b5a95d7fc15a6a6e44318d465b3ed0d8aedc255080a8f231e6523483a831df82cadb7583c4f65ed03a
+  metadata.gz: 43a96d2cebb32bd566e90336517e0826bb21bf261a8c7b29e8c990ab087146fa530011d6086ef580691d01e3c065a0f5c85b52ad2d60e5ee0d66ebfbae836e6b
+  data.tar.gz: cc362d457fd602088481a9f4de399f670f1ffc6f50992447be13084470c6d081eab94dbd4834b45429520743edd406b7d50ae215ae0c28bce0392129fbb45a0c

data/README.md

@@ -48,6 +48,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/paulho
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 [SpringCM REST API Guide]: https://developer.springcm.com/guides/rest-api-guide
-
-[//]: # (TODO: Replace version tag below with vX.Y.Z)
-[documentation]: https://rubydoc.info/github/paulholden2/springcm-sdk/0.1.1
+[documentation]: https://rubydoc.info/github/paulholden2/springcm-sdk

data/lib/springcm-sdk/client.rb

@@ -90,17 +90,17 @@ module Springcm
       end
     end
 
-    def folder(hash = {})
-      if hash.keys.size != 1
+    def folder(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 !hash[:path].nil?
+        if !path.nil?
           req.url "folders"
-          req.params["path"] = hash[:path]
-        elsif !hash[:uid].nil?
-          req.url "folders/#{hash[:uid]}"
+          req.params["path"] = path
+        elsif !uid.nil?
+          req.url "folders/#{uid}"
         end
       end
       if res.success?

data/lib/springcm-sdk/folder.rb

@@ -1,7 +1,9 @@
 require "springcm-sdk/resource"
+require "springcm-sdk/resource_list"
 require "springcm-sdk/mixins/access_level"
 require "springcm-sdk/mixins/parent_folder"
 require "springcm-sdk/mixins/documents"
+require "springcm-sdk/helpers"
 
 module Springcm
   class Folder < Resource
@@ -9,17 +11,17 @@ module Springcm
     include Springcm::ParentFolder
     include Springcm::Documents
 
-    def folders
+    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.params["offset"] = offset
+        req.params["limit"] = limit
       end
       if res.success?
         data = JSON.parse(res.body)
-        items = data["Items"].map { |item|
-          Folder.new(item, @client)
-        }
-        items
+        ResourceList.new(data, self, Folder, @client)
       else
         nil
       end
@@ -40,12 +42,15 @@ module Springcm
       end
     end
 
-    def documents
+    def documents(offset: 0, limit: 20)
+      Helpers.validate_offset_limit!(offset, limit)
       uri = URI(documents_href)
       url = "#{uri.scheme}://#{uri.host}"
       conn = @client.authorized_connection(url: url)
       res = conn.get do |req|
         req.url uri.path
+        req.params["offset"] = offset
+        req.params["limit"] = limit
       end
       if res.success?
         data = JSON.parse(res.body)

data/lib/springcm-sdk/helpers.rb

@@ -0,0 +1,13 @@
+module Springcm
+  module Helpers
+    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).")
+      end
+
+      if !offset.is_a?(Integer) || offset < 0
+        raise ArgumentError.new("Offset must be a positive, non-zero integer.")
+      end
+    end
+  end
+end

data/lib/springcm-sdk/resource_list.rb

@@ -0,0 +1,56 @@
+module Springcm
+  class ResourceList < Object
+    def initialize(data, parent_folder, kind, client)
+      @parent_folder = parent_folder
+      @kind = kind
+      super(data, client)
+    end
+
+    def next
+      nav_list("Next")
+    end
+
+    def prev
+      nav_list("Previous")
+    end
+
+    def first
+      nav_list("First")
+    end
+
+    def last
+      nav_list("Last")
+    end
+
+    def items
+      @data.fetch("Items", []).map { |item|
+        @kind.new(item, @client)
+      }
+    end
+
+    private
+
+    def nav_list(mode)
+      url = @data.fetch(mode, nil)
+      return nil if url.nil?
+      method = method_for_kind!(@kind)
+      uri = URI(url)
+      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)
+    end
+
+    def method_for_kind!(kind)
+      method = nil
+      if kind == Springcm::Folder
+        method = :folders
+      elsif kind == Springcm::Document
+        method = :documents
+      else
+        raise ArgumentError.new("Resource kind must be one of: Springcm::Document, Springcm::Folder.")
+      end
+      return method
+    end
+  end
+end

data/lib/springcm-sdk/version.rb

@@ -1,3 +1,3 @@
 module Springcm
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: springcm-sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Paul Holden
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-03 00:00:00.000000000 Z
+date: 2019-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -163,11 +163,13 @@ files:
 - 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/documents.rb
 - lib/springcm-sdk/mixins/parent_folder.rb
 - lib/springcm-sdk/object.rb
 - lib/springcm-sdk/resource.rb
+- lib/springcm-sdk/resource_list.rb
 - lib/springcm-sdk/version.rb
 - springcm-sdk.gemspec
 homepage: https://github.com/paulholden2/springcm-sdk
@@ -177,7 +179,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.2.0
+  documentation_uri: https://rubydoc.info/github/paulholden2/springcm-sdk/0.3.0
   changelog_uri: https://github.com/paulholden2/springcm-sdk/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
@@ -194,8 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A library for working with the SpringCM REST API.