springcm-sdk 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f378f7dc1698fe53469166c6ced20bbed1aef7c43ccf514ce748138624d5bafb
-  data.tar.gz: 1933002ce3f5a7d2fdac68f8462c23aa7ceef4f56bec771da2e02a7054819a4c
+  metadata.gz: 62ce246eed8c9903f1a23c83296df864a39b29e7bdfc0dd1351833854ff9b2d4
+  data.tar.gz: 51bef14dbffb1245439232d41c10eb64d5ce29b31a3e1483aa6973e0be53b4ea
 SHA512:
-  metadata.gz: 93f36689ee2c46f12fc2d30cc4bfb992c9908c90b0a6e0e4a6a984b7fa8bcddadd582e38e8a9c7ca7a3839ce3a166408b2dfe3a59fb5ed8776475c9b938f4709
-  data.tar.gz: 6e65ec9ce5d2133f171254aee6ae1bab732f575977fb01b5c9eb2ec737332aabb7ae772f15db331c5760077d28ec4da6adf9de49de1cbf7a7b2b6da0799adc36
+  metadata.gz: f09b65c50f48af5ffa74584137bd79b3cb62fcab93f2b11ddca2089ef1815c82a455e23c6fc3591630a5238d29a37f452856d06e5e95bc25d0acd69f01c85d9d
+  data.tar.gz: d8f334881ad6de05354f696c8738344222750f177b2013e37492e71e1a392f1ce5173d8acd287ebddd768ade0c5d6ee9fe09532c3d911aa1d62469d04d931cd1

data/.gitignore

@@ -1 +1,5 @@
 Gemfile.lock
+springcm-sdk-*.gem
+coverage
+.yardoc
+doc

data/.travis.yml

@@ -5,3 +5,11 @@ cache: bundler
 rvm:
   - 2.5.5
 before_install: gem install bundler -v 2.0.1
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# springcm-sdk changelog
+
+All notable changes to springcm-sdk will be documented in this file.
+
+## [Unreleased]
+
+## [0.1.1] - 2019-07-17
+### Added
+* `Client#connect!` method
+* Documentation generation
+* Test coverage
+
+### Changed
+* Fix issues with gemspec file
+
+## [0.1.0] - 2019-07-16
+### 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

data/README.md

@@ -1,6 +1,6 @@
 # SpringCM
 
-[![Build Status](https://travis-ci.org/paulholden2/springcm-sdk.svg?branch=master)](https://travis-ci.org/paulholden2/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)
 
 This gem is a library for working with the SpringCM REST API.
 

data/lib/springcm.rb

@@ -14,4 +14,10 @@ module Springcm
 
   class ConnectionInfoError < Error
   end
+
+  class InvalidClientIdOrSecretError < Error
+    def initialize
+      super('Invalid Client Id or Client Secret')
+    end
+  end
 end

data/lib/springcm/client.rb

@@ -2,6 +2,9 @@ require "faraday"
 
 module Springcm
   class Client
+    # @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)
         raise Springcm::ConnectionInfoError.new("Invalid data center '#{data_center.to_s}'")
@@ -15,7 +18,10 @@ module Springcm
       @access_token
     end
 
-    def connect
+    # Connect to the configured SpringCM API service
+    # @param safe If truthy, connection failure does not raise an exception
+    # @return [Boolean] Whether connection was successful
+    def connect(safe=true)
       conn = Faraday.new(url: auth_url)
       res = conn.post do |req|
         req.url "/"
@@ -24,28 +30,46 @@ module Springcm
           client_secret: @client_secret
         }.to_json
       end
-      data = JSON.parse(res.body)
-      @access_token = data.fetch("access_token")
-      @expiry = Time.now + data.fetch("expires_in")
-      true
+      if res.success?
+        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
+        false
+      end
+    end
+
+    # Shorthand for connecting unsafely
+    def connect!
+      connect(false)
     end
 
+    # Check if client is successfully authenticated
+    # @return [Boolean] Whether a valid, unexpired access token is held.
     def authenticated?
       !!@access_token && @expiry > Time.now
     end
 
+    # Get the URL for object API requests
     def object_api_url
       "https://api#{@data_center}.springcm.com/v#{@api_version}"
     end
 
+    # Get the URL for content upload API requests
     def upload_api_url
       "https://apiupload#{@data_center}.springcm.com/v#{@api_version}"
     end
 
+    # Get the URL for content download requests
     def download_api_url
       "https://apidownload#{@data_center}.springcm.com/v#{@api_version}"
     end
 
+    # Get the URL for authentication requests
     def auth_url
       "https://auth#{auth_subdomain_suffix}.springcm.com/api/v#{@auth_version}/apiuser"
     end

data/lib/springcm/version.rb

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

data/springcm-sdk.gemspec

@@ -9,9 +9,9 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Paul Holden"]
   spec.email         = ["pholden@stria.com"]
 
-  spec.summary       = %q{A library API working with the SpringCM REST API.}
-  spec.description   = %q{A library API working with the SpringCM REST API.}
-  spec.homepage      = "https://github.com/paulholden2/springcm"
+  spec.summary       = %q{A library for working with the SpringCM REST API.}
+  spec.description   = %q{A library for working with the SpringCM REST API and associated objects in Ruby applications.}
+  spec.homepage      = "https://github.com/paulholden2/springcm-sdk"
   spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
@@ -20,8 +20,9 @@ Gem::Specification.new do |spec|
     spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
     spec.metadata["homepage_uri"] = spec.homepage
-    spec.metadata["source_code_uri"] = "https://github.com/paulholden2/springcm"
-    # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+    spec.metadata["source_code_uri"] = "https://github.com/paulholden2/springcm-sdk"
+    spec.metadata["documentation_uri"] = "https://rubydoc.info/github/paulholden2/springcm-sdk/#{Springcm::VERSION}"
+    spec.metadata["changelog_uri"] = "https://github.com/paulholden2/springcm-sdk/blob/master/CHANGELOG.md"
   else
     raise "RubyGems 2.0 or newer is required to protect against " \
       "public gem pushes."
@@ -43,4 +44,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "sinatra", "~> 2.0"
   spec.add_development_dependency "webmock", "~> 3.6"
+  spec.add_development_dependency "simplecov", "~> 0.17"
+  spec.add_development_dependency "yard", "~> 0.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: springcm-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Paul Holden
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-16 00:00:00.000000000 Z
+date: 2019-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -94,7 +94,36 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
-description: A library API working with the SpringCM REST API.
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: A library for working with the SpringCM REST API and associated objects
+  in Ruby applications.
 email:
 - pholden@stria.com
 executables: []
@@ -105,6 +134,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -115,13 +145,15 @@ files:
 - lib/springcm/client.rb
 - lib/springcm/version.rb
 - springcm-sdk.gemspec
-homepage: https://github.com/paulholden2/springcm
+homepage: https://github.com/paulholden2/springcm-sdk
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/paulholden2/springcm
-  source_code_uri: https://github.com/paulholden2/springcm
+  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
+  changelog_uri: https://github.com/paulholden2/springcm-sdk/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -141,5 +173,5 @@ rubyforge_project:
 rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
-summary: A library API working with the SpringCM REST API.
+summary: A library for working with the SpringCM REST API.
 test_files: []