jess 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ba4716ea02efd8b3125dd57ede1c75fafc26de9
-  data.tar.gz: 03f2507e70f5ca75b2bfac60e61be5e8d12a1b68
+  metadata.gz: c1c4ee12ab3f054a1313667831afa2936b55abaa
+  data.tar.gz: a87377cb5dec69ab89e41e0a875625539d07b410
 SHA512:
-  metadata.gz: 6a8519484aa74c44671a609ec1e9acab79eeba09d1094b4ed22c988f459c0671287c39eac8ff94ca999cf4708ef638c5f20e157de8c697dc268c3c0d726dabb0
-  data.tar.gz: 2e0a4267865b068782beb774541741cd636bc925a46bd31532f3f5d7351d0582b37c60978192eb2b74c77cbbdf394fb83725cd41c68836ca4f1913564fa03c83
+  metadata.gz: 7cef11b0d500e5817ecb713166f92ebe1a9682665a8ebc53e093c7e26cf47a07a3eb07e2bcb708136858bfec257caa4928f3e6ba080796e3259c7662615a4924
+  data.tar.gz: 6c40232501f9bef0f63580266243bc700eed446acc75aeabc5bc2eceb934240655fc0cec38c39f0addf85bb6e6a928aa407aa35a8d4fe59dc007e23e94d7fd36

data/.travis.yml

@@ -1,7 +1,8 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.1
-  - 2.2
-  - 2.3.1
-before_install: gem install bundler -v 1.13.1
+  - 2.1.10
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0
+before_install: gem install bundler -v '~> 1.14' --conservative

data/CHANGELOG.md

@@ -8,9 +8,14 @@ Jess is in a pre-1.0 state. This means that its APIs and behavior are subject to
 
 * Your contribution here!
 
+## [0.2.0][] (2017-01-21)
+
+* Improved support for using jess in irb with `awesome_print` by implementing `to_hash` on resources
+
 ## 0.1.0 (2016-10-03)
 
 * Initial release
 
 [Semver]: http://semver.org
-[Unreleased]: https://github.com/mattbrictson/chandler/compare/v0.1.0...HEAD
+[Unreleased]: https://github.com/mattbrictson/jess/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/mattbrictson/jess/compare/v0.1.0...v0.2.0

data/README.md

@@ -91,10 +91,27 @@ If you ever need access to the raw JSON data of any object, use the `_json` meth
 computer.extension_attributes._json # => [{ ... }]
 ```
 
+## Gotchas
+
+Beware of these gotchas due to limitations of the JSS JSON API.
+
+### Timestamps
+
 Jess does not perform any type conversions. For example, timestamps are provided exactly as returned in the original JSON; they are not converted to Ruby DateTime objects.
 
 ```ruby
-computer.purchasing.po_date_utc # => "2016-03-18T00:00:00.000-0500"
+computer.purchasing.po_date_utc   # => "2016-03-18T00:00:00.000-0500"
+computer.purchasing.po_date_epoch # => 1399698000000
+```
+
+### Unspecified values
+
+JSS does a poor job of indicating unspecified values. For example, a computer where the bus speed cannot be determined will return `0` rather that `null` for the `bus_speed` JSON value. Likewise, unspecified string values are `""`, and unspecified timestamps are `""` or `0` instead of `null`. Jess passes these values straight through without any interpretation, so be aware that just because an attribute is *truthy* does not mean it has a useful value.
+
+```ruby
+# A computer without warranty information
+computer.purchasing.warranty_expires       # => ""
+computer.purchasing.warranty_expires_epoch # => 0
 ```
 
 ## Why not ruby-jss?

data/jess.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 11.0"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "minitest-reporters", "~>1.1"
+  spec.add_development_dependency "rainbow", "~> 2.1.0"
   spec.add_development_dependency "rubocop", "~> 0.43"
   spec.add_development_dependency "webmock", "~> 2.1"
 end

data/lib/jess/extension_attributes.rb

@@ -3,16 +3,23 @@ require "forwardable"
 module Jess
   # A Hash-like wrapper around the extension attributes that facilitates easy
   # key/value access.
-  class ExtensionAttributes < Resource
+  class ExtensionAttributes
     extend Forwardable
     def_delegators :@values, :[], :fetch, :key?, :keys, :size, :length, :to_h
 
     def initialize(json)
-      super
       @values = json.each_with_object({}) do |attr, hash|
         hash[attr.name] = attr.value
       end
       @values.freeze
     end
+
+    # Explicitly delegate instead of using def_delegators in order to be
+    # compatible with awesome_print. The original Hash#to_hash method is
+    # implemented in C, which means it has an arity of -1. This confuses
+    # awesome_print.
+    def to_hash
+      @values.to_hash
+    end
   end
 end

data/lib/jess/http_client/error_decorator.rb

@@ -25,6 +25,7 @@ module Jess
         raise Error, res.message
       end
 
+      # rubocop:disable Lint/EmptyWhen
       def handle_exception(e, req)
         case e
         when IOError, Timeout::Error
@@ -39,6 +40,7 @@ module Jess
         e.http_method = req.method
         raise e
       end
+      # rubocop:enable Lint/EmptyWhen
     end
   end
 end

data/lib/jess/resource.rb

@@ -11,6 +11,10 @@ module Jess
       @_json = json.freeze
     end
 
+    def to_hash
+      _json
+    end
+
     private
 
     def method_missing(symbol, *args)
@@ -30,9 +34,9 @@ module Jess
       when Hash
         Resource.new(json)
       when Array
-        json.map(&method(:_as_resource))
+        json.map(&method(:_as_resource)).freeze
       else
-        json
+        json.freeze
       end
     end
   end

data/lib/jess/version.rb

@@ -1,3 +1,3 @@
 module Jess
-  VERSION = "0.1.0".freeze
+  VERSION = "0.2.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jess
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Matt Brictson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-04 00:00:00.000000000 Z
+date: 2017-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -190,7 +204,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Lightweight, unofficial client for the JAMF Software Server (JSS) API