petail 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8b4586f6ff3956d439fa35a0aaa64753b3839261a55df4cc9ce83b0bbdd277f
-  data.tar.gz: 4b20c15bc80355c4d55dd83d365ca3ed8806775385623b005e53aaa61cf9b260
+  metadata.gz: e974c64e0259b3561130ac6d4ea4a7bae80fa381e9ab7ee7cb3ab0338d9fe2c4
+  data.tar.gz: 6e99b146485fd8da57711ed81512ee599b10797fbc5cfb2072941927f78bd640
 SHA512:
-  metadata.gz: 1e7a2e97589c26880828fda50953a8cf542b0eb6c1c285bed3e4889d091c8486a5c1e6998e5efae59dc0a5a013e3f30859366d08773155cc3ae96c95beffdbd1
-  data.tar.gz: 8f69aaadab1e77609b51824528b22e896c6e3c5a7c3b963e9fadd7edb098f232ba6f1cc64f07a3fcf746c0a9e1e16173a5e5bd8dfd7b059fc179e67786f4d608
+  metadata.gz: 4f6aa6a580106976c75f5f7db20362ffad7be1c6d25c1c55ed19dafe8c7ea7b50387213dcac51395d8cb9f6fe9aa5160bd1879fb20b9cbde9b48dedfdbe63822
+  data.tar.gz: a51c4609448bc36218c226c4f71a1b3fd99d46d4d16c666c4b009d76f1020ec2ee2634f156fbbaecd6012c9f4149409d45d44d00e378e5ecbc1eef1037db9bb9

data/README.adoc

@@ -55,10 +55,12 @@ The quickest way to get started is to create a new instance and then cast as JSO
 
 [source,ruby]
 ----
-payload = Petail.new type: "https://demo.io/problem_details/timeout",
-                     status: 413,
-                     detail: "You've exceeded the 5MB upload limit.",
-                     instance: "/profile/3a1bfd54-ae6c-4a61-8d0d-90c132428dc3"
+payload = Petail[
+  type: "https://demo.io/problem_details/timeout",
+  status: 413,
+  detail: "You've exceeded the 5MB upload limit.",
+  instance: "/profile/3a1bfd54-ae6c-4a61-8d0d-90c132428dc3"
+]
 
 payload.to_json
 
@@ -82,6 +84,8 @@ payload.to_xml
 # </problem>
 ----
 
+💡 You can also use `Petail.new` to create instances if you don't like `Petail.[]`, as shown above, but `.[]` is preferred.
+
 === Media Types
 
 For convenience, you can obtain the necessary media types for your HTTP headers as follows:
@@ -97,11 +101,11 @@ Petail.media_type_for :xml   # "application/problem+xml"
 
 === Payload
 
-You'll always get a `Petail::Payload` object answered back when using `Petail.new` for which you can cast to JSON, XML, and other types. There are few conveniences provided for you when constructing a new payload. For instance, you can also use status to set default title:
+You'll always get a `Petail::Payload` object answered back when using `Petail.[]` or `Petail.new` for which you can cast to JSON, XML, and other types. There are few conveniences provided for you when constructing a new payload. For instance, you can also use status to set default title:
 
 [source,ruby]
 ----
-Petail.new status: 413
+Petail[status: 413]
 # #<Struct:Petail::Payload:0x0000ec80
 #   detail = nil,
 #   extensions = {},
@@ -116,7 +120,7 @@ Notice that standard HTTP 413 title of "Content Too Large" is provided for you b
 
 [source,ruby]
 ----
-Petail.new status: :bad_request
+Petail[status: :bad_request]
 # #<Struct:Petail::Payload:0x0000f280
 #   detail = nil,
 #   extensions = {},
@@ -133,7 +137,7 @@ Due to the payload being a `Struct`, you have all of the standard methods availa
 
 [source,]
 ----
-payload = Petail.new status: :forbidden
+payload = Petail[status: :forbidden]
 
 payload.add_extension(:account, "/accounts/1")
        .add_extension(:balance, 50)
@@ -165,7 +169,7 @@ Both serialization and deserialization of JSON is supported. For example, given
 
 [source,ruby]
 ----
-payload = Petail.new(
+payload = Petail[
   type: "https://test.io/problem_details/out_of_credit",
   title: "You do not have enough credit.",
   status: 403,
@@ -175,7 +179,7 @@ payload = Petail.new(
     balance: 30,
     accounts: %w[/accounts/1 /accounts/10]
   }
-)
+]
 ----
 
 This means you can serialize as follows:
@@ -232,7 +236,7 @@ XML is supported too but isn't as robust as JSON support, at the moment. This is
 
 [source,ruby]
 ----
-payload = Petail.new(
+payload = Petail[
   type: "https://test.io/problem_details/out_of_credit",
   title: "You do not have enough credit.",
   status: 403,
@@ -242,7 +246,7 @@ payload = Petail.new(
     balance: 30,
     accounts: %w[/accounts/1 /accounts/10]
   }
-)
+]
 ----
 
 This means you can serialize as follows:

data/lib/petail.rb

@@ -10,6 +10,10 @@ module Petail
   MEDIA_TYPE_XML = "application/problem+xml"
   TYPES = %i[json xml].freeze
 
+  def self.[](**) = Payload.for(**)
+
+  def self.new(**) = Payload.for(**)
+
   def self.from_json(...) = Payload.from_json(...)
 
   def self.from_xml(...) = Payload.from_xml(...)
@@ -17,6 +21,4 @@ module Petail
   def self.media_type_for key, types: TYPES
     types.include?(key) ? const_get("MEDIA_TYPE_#{key.upcase}") : ""
   end
-
-  def self.new(**) = Payload.for(**)
 end

data/petail.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "petail"
-  spec.version = "0.2.0"
+  spec.version = "0.3.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/petail"
@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = "~> 3.4"
   spec.add_dependency "rack", ">= 2.2", "< 4.0"
+  spec.add_dependency "rexml", "~> 3.4"
 
   spec.extra_rdoc_files = Dir["README*", "LICENSE*"]
   spec.files = Dir["*.gemspec", "lib/**/*"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: petail
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -55,6 +55,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
 email:
 - brooke@alchemists.io
 executables: []
@@ -95,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A RFC 9457 Problem Details for HTTP APIs implementation.
 test_files: []