pylon-api 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcfe4ab02c112c8898998add96fc34ff4846029b2fc10bf2e2ce13c1f907a565
-  data.tar.gz: d8fd25a0307bbdc62e1a8921a95cf5859382f52d27303d25fec825db7f416ee7
+  metadata.gz: 417baee1f917bf76f2bebeafe9ac0e740ca238649225e26ad75092d368d542ef
+  data.tar.gz: '018b75c89e76821075e2c6a9a369ce2630627d82c15a441c162aa16de0d78a2e'
 SHA512:
-  metadata.gz: 7205621d5fe56ec66b58974d632eaa03e5be978a42e508656ad59583d499d348eef1ae91e6838da9f2ee3f9add0113f7e45151cce4578aebcd786cb2065a86ff
-  data.tar.gz: d0bd80e6ba44a85fb9d083263cf0ae74904d5fce043fb18de248cf6e4ff8807905b4dedc5508afc05af9c293c1b2f8778b860602969c48992b58a7896fe01c6a
+  metadata.gz: 658536c7d456207f7ff5eab110aa1f991b658753a603301512896ed22cb7434881c6800dad2593c39f457238fdcf252a98d2dc18a16d0d541fb9e8660a581e08
+  data.tar.gz: 9de4cd5667d7dfc9a7eb890e067d3d3dc756f5f31a4a2b35ef9e49aa9790dcb31f1efd8ad7b6c421a0fd76aaf2e2de8aa38c50f4da8418efb059c30fec3f5d27

data/CHANGELOG.md

@@ -1,34 +1,25 @@
 # Changelog
-All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+## [1.0.0] - 2024-03-21
 
-## [0.1.0] - 2024-03-21
+### Changed
+- Downgraded Faraday dependency from 2.12.2 to 1.10.4 for better compatibility with existing applications
+- Updated Faraday multipart and retry dependencies to match Faraday 1.x compatibility
+
+## [0.2.0] - 2024-03-21
 
 ### Added
-- Initial release of the Pylon API Ruby client
-- Comprehensive client implementation with support for all major API endpoints:
-  - Accounts management
-  - Attachments handling
-  - Contacts management
-  - Custom fields
-  - Issues tracking
-  - Knowledge base articles
-  - Tags management
-  - Teams management
-  - Ticket forms
-  - User roles
-  - Users management
-- Robust error handling with specific error classes:
-  - `Pylon::AuthenticationError`
-  - `Pylon::ResourceNotFoundError`
-  - `Pylon::ValidationError`
-  - `Pylon::ApiError`
-- Pagination support for list endpoints
-- Debug mode for request/response logging
-- Comprehensive test suite with RSpec
-- YARD documentation for all methods
-- MIT License
+- Added support for file uploads via multipart/form-data
+- Added retry mechanism for failed requests
+- Added comprehensive error handling and logging
+
+### Changed
+- Improved request/response logging
+- Enhanced error messages and documentation
 
-[0.1.0]: https://github.com/benjodo/pylon-api/releases/tag/v0.1.0 
+## [0.1.0] - 2024-03-20
+
+### Added
+- Initial release
+- Basic API client functionality
+- Support for core API endpoints 

data/lib/pylon/client.rb

@@ -154,6 +154,15 @@ module Pylon
       patch("/issues/#{issue_id}", body: params)
     end
 
+    # Snooze an issue until a specified time
+    #
+    # @param issue_id [String] The ID or number of the issue to snooze
+    # @param snooze_until [String] The date and time to snooze the issue until (RFC3339 format)
+    # @return [Hash] Updated issue details
+    def snooze_issue(issue_id, snooze_until:)
+      post("/issues/#{issue_id}/snooze", body: { snooze_until: snooze_until })
+    end
+
     # List all knowledge base articles with pagination
     #
     # @param page [Integer] Page number for pagination
@@ -297,7 +306,7 @@ module Pylon
       @connection ||= Faraday.new(@base_url) do |f|
         f.request :json
         f.request :multipart
-        f.response :json
+        f.response :json, content_type: /\bjson$/
         f.response :logger if @debug
         f.adapter Faraday.default_adapter
         f.headers["Authorization"] = "Bearer #{api_key}"
@@ -327,13 +336,15 @@ module Pylon
         data = data["data"] if data.is_a?(Hash) && data.key?("data")
         [data, response]
       when 401
-        raise AuthenticationError, parse_error_message(response)
+        raise AuthenticationError, parse_error_message(response) || "Invalid API key"
       when 404
-        raise ResourceNotFoundError, parse_error_message(response)
+        raise ResourceNotFoundError, parse_error_message(response) || "Resource not found"
       when 422
-        raise ValidationError, parse_error_message(response)
+        raise ValidationError, parse_error_message(response) || "Validation error"
+      when 429
+        raise ApiError, parse_error_message(response) || "Rate limit exceeded"
       else
-        raise ApiError.new(parse_error_message(response), response)
+        raise ApiError.new(parse_error_message(response) || "Internal server error", response)
       end
     end
 
@@ -342,10 +353,12 @@ module Pylon
     # @param response [Faraday::Response] The API response
     # @return [String] Error message
     def parse_error_message(response)
-      if response.body.is_a?(Hash)
-        response.body["errors"]&.first || response.body["error"] || "HTTP #{response.status}"
-      else
-        "HTTP #{response.status}"
+      return nil unless response.body.is_a?(Hash)
+
+      if response.body["errors"].is_a?(Array) && !response.body["errors"].empty?
+        response.body["errors"].first
+      elsif response.body["error"].is_a?(String)
+        response.body["error"]
       end
     end
 

data/lib/pylon/version.rb

@@ -2,9 +2,9 @@
 
 module Pylon
   # Major version for breaking changes
-  MAJOR = 0
+  MAJOR = 1
   # Minor version for new features
-  MINOR = 1
+  MINOR = 0
   # Patch version for bug fixes
   PATCH = 0
   # Pre-release version (optional)

metadata

@@ -1,43 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: pylon-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Ben Odom
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-27 00:00:00.000000000 Z
+date: 2025-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.12.2
+        version: 1.10.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.12.2
+        version: 1.10.4
 - !ruby/object:Gem::Dependency
   name: faraday-multipart
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.0.4
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -145,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Ruby client for the Pylon API