springcm-sdk 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62ce246eed8c9903f1a23c83296df864a39b29e7bdfc0dd1351833854ff9b2d4
-  data.tar.gz: 51bef14dbffb1245439232d41c10eb64d5ce29b31a3e1483aa6973e0be53b4ea
+  metadata.gz: dd0b30d78f3a71c434ed1b79d6a8a24d01dc8907bcaacf3b2ddacab12300a865
+  data.tar.gz: 42567803347e928ccd0bd19ac7adfb88efa09e6ad8f8ed57be2430ef42b4549b
 SHA512:
-  metadata.gz: f09b65c50f48af5ffa74584137bd79b3cb62fcab93f2b11ddca2089ef1815c82a455e23c6fc3591630a5238d29a37f452856d06e5e95bc25d0acd69f01c85d9d
-  data.tar.gz: d8f334881ad6de05354f696c8738344222750f177b2013e37492e71e1a392f1ce5173d8acd287ebddd768ade0c5d6ee9fe09532c3d911aa1d62469d04d931cd1
+  metadata.gz: eb8d8db4db51182ab13c3bb83076861ef6a448b689c842d6f1c88f733db85e63a2997415c384284b969f6cef52815084ecafadab7ad98108d27d7c076c8946bc
+  data.tar.gz: 5e6fa0640fda92bfca0910ae59fc6e5639bd59196f4bc332a314f23fc40c67b83319eb77f22f8a87645265714be5aa99c067425344f185c0c53c3a7bfcbd18e5

data/CHANGELOG.md

@@ -3,6 +3,11 @@
 All notable changes to springcm-sdk will be documented in this file.
 
 ## [Unreleased]
+### Added
+* Folder object and API
+
+### Changed
+* Client no longer accepts credentials with keyword arguments
 
 ## [0.1.1] - 2019-07-17
 ### Added
@@ -17,6 +22,6 @@ 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/v0.1.0...HEAD
-[0.1.0]: https://github.com/paulholden2/springcm-sdk/releases/tag/v0.1.0
-[0.1.1]: https://github.com/paulholden2/springcm-sdk/releases/tag/v0.1.1
+[Unreleased]: https://github.com/paulholden2/springcm-sdk/compare/0.1.1...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

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 TODO: Write your name
+Copyright (c) 2019 Paul Holden
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,4 +1,4 @@
-# SpringCM
+# 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)
 
@@ -9,7 +9,7 @@ This gem is a library for working with the SpringCM REST API.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'springcm'
+gem 'springcm-sdk'
 ```
 
 And then execute:
@@ -18,22 +18,36 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install springcm
+    $ gem install springcm-sdk
 
 ## Usage
 
-TODO: Write usage instructions here
+### Connecting
 
-## Development
+To begin using the SpringCM REST API, you must first acquire a client ID and
+secret pair. To do so, contact DocuSign Support and request a key pair for
+REST API usage. They require you to be a super administrator in the account
+before they will generate the key pair for you. For more information, see
+the [SpringCM REST API Guide].
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+client = Springcm::Client.new("uatna11", "<your client ID>", "<your client secret>")
+client.connect
+client.authenticated?
+# ...
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+For more information, view the [documentation].
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/paulholden2/springcm.
+Bug reports and pull requests are welcome on GitHub at https://github.com/paulholden2/springcm-sdk.
 
 ## License
 
 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

data/bin/.gitignore

@@ -0,0 +1 @@
+livetest

data/exe/springcm

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

data/lib/springcm/account.rb

@@ -0,0 +1,6 @@
+require "springcm/object"
+
+module Springcm
+  class Account < Object
+  end
+end

data/lib/springcm/client.rb

@@ -1,12 +1,17 @@
 require "faraday"
+require "springcm/account"
+require "springcm/folder"
+require "springcm/document"
 
 module Springcm
   class Client
+    attr_reader :access_token
+
     # @param data_center [String] Data center name, e.g. uatna11
     # @param client_id [String] Your API client ID
     # @param client_secret [String] Your API client secret
-    def initialize(data_center:, client_id:, client_secret:)
-      if !["na11", "uatna11"].include?(data_center)
+    def initialize(data_center, client_id, client_secret)
+      if !["na11", "uatna11", "eu11", "eu21", "na21", "us11"].include?(data_center)
         raise Springcm::ConnectionInfoError.new("Invalid data center '#{data_center.to_s}'")
       end
 
@@ -24,7 +29,7 @@ module Springcm
     def connect(safe=true)
       conn = Faraday.new(url: auth_url)
       res = conn.post do |req|
-        req.url "/"
+        req.headers['Content-Type'] = 'application/json'
         req.body = {
           client_id: @client_id,
           client_secret: @client_secret
@@ -34,20 +39,78 @@ module Springcm
         data = JSON.parse(res.body)
         @access_token = data.fetch("access_token")
         @expiry = Time.now + data.fetch("expires_in")
-        true
       else
         @access_token = nil
         @expiry = nil
         raise Springcm::InvalidClientIdOrSecretError.new if !safe
+        return false
+      end
+    end
+
+    def get_account_info
+      conn = authorized_connection(url: object_api_url)
+      res = conn.get do |req|
+        req.headers["Content-Type"] = "application/json"
+        req.url "accounts/current"
+      end
+      if res.success?
+        data = JSON.parse(res.body)
+        @account = Springcm::Account.new(data, self)
+        true
+      else
         false
       end
     end
 
+    def account
+      if @account.nil?
+        get_account_info
+      end
+      @account
+    end
+
     # Shorthand for connecting unsafely
     def connect!
       connect(false)
     end
 
+    # Retrieve the root folder in SpringCM
+    # @return [Springcm::Folder] The root folder object.
+    def root_folder
+      conn = authorized_connection(url: object_api_url)
+      res = conn.get do |req|
+        req.url "folders"
+        req.params["systemfolder"] = "root"
+      end
+      if res.success?
+        data = JSON.parse(res.body)
+        return Folder.new(data, self)
+      else
+        nil
+      end
+    end
+
+    def folder(hash = {})
+      if hash.keys.size != 1
+        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?
+          req.url "folders"
+          req.params["path"] = hash[:path]
+        elsif !hash[:uid].nil?
+          req.url "folders/#{hash[:uid]}"
+        end
+      end
+      if res.success?
+        data = JSON.parse(res.body)
+        return Folder.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?
@@ -74,6 +137,21 @@ module Springcm
       "https://auth#{auth_subdomain_suffix}.springcm.com/api/v#{@auth_version}/apiuser"
     end
 
+    def authorized_connection(*options)
+      Faraday.new(*options) do |conn|
+        options = [{
+          max: 10,
+          interval: 1,
+          interval_randomness: 0.5,
+          backoff_factor: 2,
+          retry_statuses: [429]
+        }]
+        conn.request :retry, *options
+        conn.adapter :net_http
+        conn.authorization('bearer', @access_token)
+      end
+    end
+
     private
 
     def auth_subdomain_suffix

data/lib/springcm/document.rb

@@ -0,0 +1,8 @@
+require "springcm/resource"
+require "springcm/mixins/access_level"
+
+module Springcm
+  class Document < Resource
+    include Springcm::AccessLevel
+  end
+end

data/lib/springcm/folder.rb

@@ -0,0 +1,61 @@
+require "springcm/resource"
+require "springcm/mixins/access_level"
+require "springcm/mixins/parent_folder"
+require "springcm/mixins/documents"
+
+module Springcm
+  class Folder < Resource
+    include Springcm::AccessLevel
+    include Springcm::ParentFolder
+    include Springcm::Documents
+
+    def folders
+      conn = @client.authorized_connection(url: @client.object_api_url)
+      res = conn.get do |req|
+        req.url "folders/#{uid}/folders"
+      end
+      if res.success?
+        data = JSON.parse(res.body)
+        items = data["Items"].map { |item|
+          Folder.new(item, @client)
+        }
+        items
+      else
+        nil
+      end
+    end
+
+    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
+      end
+      if res.success?
+        data = JSON.parse(res.body)
+        Folder.new(data, @client)
+      else
+        nil
+      end
+    end
+
+    def documents
+      uri = URI(documents_href)
+      url = "#{uri.scheme}://#{uri.host}"
+      conn = @client.authorized_connection(url: url)
+      res = conn.get do |req|
+        req.url uri.path
+      end
+      if res.success?
+        data = JSON.parse(res.body)
+        items = data["Items"].map { |item|
+          Document.new(item, @client)
+        }
+        items
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/springcm/mixins/access_level.rb

@@ -0,0 +1,37 @@
+module Springcm
+  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 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 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
+
+    def access_level
+      @data.fetch("AccessLevel")
+    end
+  end
+end

data/lib/springcm/mixins/documents.rb

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

data/lib/springcm/mixins/parent_folder.rb

@@ -0,0 +1,8 @@
+module Springcm
+  module ParentFolder
+    def parent_folder_href
+      # Root folders won't have ParentFolder key
+      @data.dig("ParentFolder", "Href")
+    end
+  end
+end

data/lib/springcm/object.rb

@@ -0,0 +1,17 @@
+module Springcm
+  class Object
+    def initialize(data, client)
+      @client = client
+      @data = data
+    end
+
+    def method_missing(m, *args, &block)
+      key = m.to_s.split("_").map(&:capitalize).join
+      if @data.key?(key)
+        @data.fetch(key)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/springcm/resource.rb

@@ -0,0 +1,10 @@
+require "springcm/object"
+
+module Springcm
+  class Resource < Object
+    # @return [String] The folder unique identifier (UID)
+    def uid
+      href[-36..-1]
+    end
+  end
+end

data/lib/springcm/version.rb

@@ -1,3 +1,3 @@
 module Springcm
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/springcm.rb

@@ -17,7 +17,7 @@ module Springcm
 
   class InvalidClientIdOrSecretError < Error
     def initialize
-      super('Invalid Client Id or Client Secret')
+      super("Invalid Client Id or Client Secret")
     end
   end
 end

data/springcm-sdk.gemspec

@@ -34,7 +34,7 @@ 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   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.executables   = ["springcm"]
   spec.require_paths = ["lib"]
 
   spec.add_dependency "faraday", "~> 0.15.4"
@@ -46,4 +46,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "webmock", "~> 3.6"
   spec.add_development_dependency "simplecov", "~> 0.17"
   spec.add_development_dependency "yard", "~> 0.9"
+  spec.add_development_dependency "uuid", "~> 2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: springcm-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Paul Holden
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-17 00:00:00.000000000 Z
+date: 2019-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -122,11 +122,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: uuid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 description: A library for working with the SpringCM REST API and associated objects
   in Ruby applications.
 email:
 - pholden@stria.com
-executables: []
+executables:
+- springcm
 extensions: []
 extra_rdoc_files: []
 files:
@@ -139,10 +154,20 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/.gitignore
 - bin/console
 - bin/setup
+- exe/springcm
 - lib/springcm.rb
+- lib/springcm/account.rb
 - lib/springcm/client.rb
+- lib/springcm/document.rb
+- lib/springcm/folder.rb
+- lib/springcm/mixins/access_level.rb
+- lib/springcm/mixins/documents.rb
+- lib/springcm/mixins/parent_folder.rb
+- lib/springcm/object.rb
+- lib/springcm/resource.rb
 - lib/springcm/version.rb
 - springcm-sdk.gemspec
 homepage: https://github.com/paulholden2/springcm-sdk
@@ -152,7 +177,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.1.1
+  documentation_uri: https://rubydoc.info/github/paulholden2/springcm-sdk/0.1.2
   changelog_uri: https://github.com/paulholden2/springcm-sdk/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []