hudu 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed87eec77a92013c3e0c83084432ad5a91a50762cdd19e0e24ea6b383481d2c0
-  data.tar.gz: '048caa2a4f7abb2e2b940fd9681a026669ab84ef7d67cfc7c3655736a41de75d'
+  metadata.gz: d1e4245c0dce3f094901ea8fdfbcf9b4c2d395b702968d5b869e60dad16adfc5
+  data.tar.gz: 2e44553c6bbac29f51fae2453a55c36b5fdeb26745cabf73c4cb6cfcc97e2eea
 SHA512:
-  metadata.gz: 64307e6e97f707ad42b2736c4473fa178e9b4a8f86a62fb9840c65519ab5e4cb4f057d8d0f7f06e52c931f67ef0066f0ceb1b27f777c75dfda8566d4a77222f5
-  data.tar.gz: 14a41bde5270cd5e5710674ad9372ca9579a396ddb18d3ba6d517c4b89b9a7bad37608b5bae52fa6d496952589e9d6aed333f70727b0251d0202aa70007e3bbe
+  metadata.gz: 9bc275aebd8cb6dbf89be44e4fdd59eb24761ab5d7b63c8687cf480f5ad6a3074dc911850705881e1bc2b173979393b6a0a859c6e13c7077e151d1853c71fe2d
+  data.tar.gz: c50428e0ec1922c8cc11fc1710ce82d99af88e1ac110c2a559da7b6baeed3c3183b5e8a28087e79e8bc40434baabb3ac9aef90d548b57941ce371152866b1bbd

data/CHANGELOG.md

@@ -1,13 +1,21 @@
-## [Unreleased]
+# Changelog
 
 ## [0.1.0] - 2024-02-20
+
 - Initial release
 
 ## [0.2.0] - 2024-03-13
+
 - update_company_asset added
 
 ## [0.3.0] - 2024-03-13
+
 - throtling connection rate
 
 ## [0.3.1] - 2024-03-13
+
 - rubocop fixes
+
+## [0.3.2] - 2025-03-20
+
+- update wrapi dependency

data/README.md

@@ -1,4 +1,5 @@
 # Hudu API
+
 [![Version](https://img.shields.io/gem/v/hudu.svg)](https://rubygems.org/gems/hudu)
 [![Maintainability](https://api.codeclimate.com/v1/badges/e02c3f2cd2f13261597d/maintainability)](https://codeclimate.com/github/jancotanis/hudu/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/e02c3f2cd2f13261597d/test_coverage)](https://codeclimate.com/github/jancotanis/hudu/test_coverage)
@@ -17,15 +18,20 @@ gem 'hudu'
 
 And then execute:
 
-    $ bundle install
+```console
+> bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install hudu
+```console
+> gem install hudu
+```
 
 ## Usage
 
-Before you start making the requests to API provide the endpoint and api key using the configuration wrapping.
+Before you start making the requests to API provide the endpoint and
+api key using the configuration wrapping.
 
 ```ruby
 require 'hudu'
@@ -44,20 +50,23 @@ client.login
 ```
 
 ## Resources
+
 ### Authentication
-```
+
+```ruby
 # setup 
 #
 client.login
 ```
+
 |Resource|API endpoint|Description|
 |:--|:--|:--|
 |.login| none |uses api_info to check if credentials are correct. Raises Hudu:AuthenticationError incase this fails|
 
-
-
 ### Data resources
+
 Endpoint for data related requests 
+
 ```ruby
 
 # list all asset layouts/fields for a company
@@ -99,17 +108,20 @@ end
 2. Add release to [CHANGELOG.md](CHANGELOG.md)
 3. Commit.
 4. Test build.
-```
-> rake build
 
+```console
+> rake build
 ```
+
 5. Release
-```
+
+```console
 > rake release
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/jancotanis/hudu.
+Bug reports and pull requests are welcome on [GitHub](https://github.com/jancotanis/hudu).
 
 ## License
 

data/hudu.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |s|
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.platform = Gem::Platform::RUBY
   s.add_runtime_dependency 'faraday'
-  s.add_runtime_dependency 'wrapi', '>= 0.3.0'
+  s.add_runtime_dependency 'wrapi', '>= 0.4.9'
   s.add_development_dependency 'dotenv'
   s.add_development_dependency 'minitest'
   s.add_development_dependency 'rubocop'

data/lib/hudu/asset_helper.rb

@@ -11,9 +11,13 @@ module Hudu
     # @example
     #   asset = SomeAssetEntity.new(attributes: { id: 1, name: "Asset 1", company_id: 101 }, fields: [field1, field2])
     #   Hudu::AssetHelper.construct_asset(asset)
-    #   # => { asset: { id: 1, company_id: 101, asset_layout_id: nil, slug: nil, name: "Asset 1", custom_fields: [...] } }
+    #   # => { asset: 
+    #   #      { id: 1, company_id: 101, asset_layout_id: nil, slug: nil, name: "Asset 1", custom_fields: [...]
+    #   #      }
+    #   #    }
     def self.construct_asset(asset)
-      custom_asset = asset.attributes.slice(*%w[
+      custom_asset = asset.attributes.slice(
+        *%w[
           id company_id asset_layout_id slug name
           primary_serial primary_model primary_mail
           primary_manufacturer
@@ -47,7 +51,8 @@ module Hudu
     # Formats custom fields into a standardized hash structure.
     #
     # @param fields [Array<Object>] A collection of field objects, each expected to respond to `label` and `value`.
-    # @return [Array<Hash>] An array containing a single hash mapping field labels (downcased and underscored) to their values.
+    # @return [Array<Hash>] An array containing a single hash mapping field labels 
+    #                       (downcased and underscored) to their values.
     #
     # @example
     #   fields = [Field.new(label: "Warranty", value: "2025"), Field.new(label: "Location", value: "NYC")]

data/lib/hudu/client.rb

@@ -4,10 +4,10 @@ require File.expand_path('api', __dir__)
 require File.expand_path('asset_helper', __dir__)
 
 module Hudu
-  # The Client class serves as a wrapper for the Hudu REST API, providing methods to interact 
+  # The Client class serves as a wrapper for the Hudu REST API, providing methods to interact
   # with various Hudu resources.
   #
-  # This class dynamically defines methods to fetch, create, update, and manipulate Hudu resources 
+  # This class dynamically defines methods to fetch, create, update, and manipulate Hudu resources
   # such as companies, articles, assets, and more.
   #
   # @example Basic Usage
@@ -16,7 +16,6 @@ module Hudu
   #   client.update_company(1, { name: "Updated Company" }) # Update a company
   #   client.create_company({ name: "New Company" }) # Create a new company
   class Client < API
-
     # Dynamically defines methods for interacting with Hudu API resources.
     #
     # Depending on the arguments, this will define methods to:
@@ -68,7 +67,6 @@ module Hudu
       end
     end
 
-
     # Define API endpoints for various resources
     api_endpoint :api_info
     api_endpoint :activity_logs
@@ -117,7 +115,10 @@ module Hudu
     # @param asset [Object] The asset object to update.
     # @return [Hash] The updated asset data.
     def update_company_asset(asset)
-      hudu_data(put(api_url("companies/#{asset.company_id}/assets/#{asset.id}"), AssetHelper.construct_asset(asset), false), :asset)
+      hudu_data(
+        put(api_url("companies/#{asset.company_id}/assets/#{asset.id}"), AssetHelper.construct_asset(asset), false),
+        :asset
+      )
     end
 
     # Creates a new asset for a company.
@@ -127,7 +128,13 @@ module Hudu
     # @param fields [Array<Hash>] The custom fields for the asset.
     # @return [Hash] The newly created asset data.
     def create_company_asset(company_id, asset_layout, fields)
-      hudu_data(post(api_url("companies/#{company_id}/assets"), AssetHelper.create_asset(asset_layout.name, asset_layout.id, fields), false), :asset)
+      hudu_data(
+        post(
+          api_url("companies/#{company_id}/assets"),
+          AssetHelper.create_asset(asset_layout.name, asset_layout.id, fields),
+          false
+        ), :asset
+      )
     end
 
     # Constructs the full API URL for a given path.

data/lib/hudu/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hudu
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: hudu
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Janco Tanis
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-14 00:00:00.000000000 Z
+date: 2025-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -30,14 +29,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.9
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -94,7 +93,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email: gems@jancology.com
 executables: []
 extensions: []
@@ -125,7 +123,6 @@ licenses:
 metadata:
   homepage_uri: https://rubygems.org/gems/hudu
   source_code_uri: https://github.com/jancotanis/hudu
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -140,8 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A Ruby wrapper for the Hudu APIs (readonly)
 test_files: []