relax2 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3ced21a4e66c7b6eee62f684be2f4960bf10512f9d6618414f5dd6bc750f41a
-  data.tar.gz: 94c2ebd8799612e6dbd780ff5e2eecb65810c4a1b50ec883098ff4e4e7611647
+  metadata.gz: 4c072b05f258411e87c18e1065cb6ca8a283d528104c0372eea8c4e785bcc871
+  data.tar.gz: 61f05cf1460f2d796c0e90052ebd550514642bf62665ac0bb34d74bf8bc87ab0
 SHA512:
-  metadata.gz: 7d102b5eb07a687e9fbd92bb9297246d980c0f0101299124a64ed561d1316e351d3e150e72d174846b39fccfc63768580e3db1fc567daa8a7a63548b519165ef
-  data.tar.gz: 76a6bec28e312cafb5ca718aa3109930142fe26dde56cb509613c8ceda521d582357c0a62a3b559ac1458e3bbcbb5e91d72662ac6cb1309b9822583880b2e19b
+  metadata.gz: 1729cb47a19c4f1d9a6a23678cb374f0351316175716ea9853ef755b93ddffb50b57e01473fbb23bab1950a12746a078f5ee8ae298ca22904012038b284a9df8
+  data.tar.gz: 323b17e9d0d6d00588ba543ad428160ca00e0cd19ea546eedff7eb1dd9a8c8d61f3aa8f4b0ab1e48c97034ca1932b4ce10c5c7a947240edaf74fa1cb393d4289

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 YusukeIwaki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -8,56 +8,20 @@ require 'relax2'
 
 base_url 'https://petstore.swagger.io/v2'
 
-interceptor -> (request, perform_request) do
-  puts request.body
-  response = perform_request.call(request)
-  puts response.body
-  response
-end
+interceptor :json_request
+interceptor :print_response
 ```
 
 Then enjoy your API calls.
 
 ```
 % ruby petstore.rb GET /pet/2
-{
-  "id": 2,
-  "category": {
-    "id": 5,
-    "name": "Angel"
-  },
-  "name": "DOG",
-  "tags": [
-    {
-      "id": 1,
-      "name": "Armanda Hirthe"
-    }
-  ],
-  "status": "available"
-}
+{"id":2,"name":"doggie","photoUrls":[],"tags":[],"status":"available"}
 ```
 
 ```
-% ruby petstore.rb PUT /pet/2
-{
-  "name": "NEW DOG"
-}
-
-{
-  "id": 2,
-  "category": {
-    "id": 5,
-    "name": "Angel"
-  },
-  "name": "NEW DOG",
-  "tags": [
-    {
-      "id": 1,
-      "name": "Armanda Hirthe"
-    }
-  ],
-  "status": "available"
-}
+$ echo '{"id": 2, "name": "NEW DOG", "status": "unavailable"}' | ruby petstore.rb PUT /pet
+{"id":2,"name":"NEW DOG","photoUrls":[],"tags":[],"status":"unavailable"}
 ```
 
 If you want to create more detailed client, use the modular style with `Relax2::Base`.
@@ -78,12 +42,13 @@ class ExampleApi < Relax2::Base
   end
 end
 
-request = Relax2::Request.from_string('GET /hogehoge q=xx USER-Agent: Hoge/1.23')
+# Request manually
+request = Relax2::Request.from(args: 'GET /hogehoge q=xx USER-Agent: Hoge/1.23'.split(' '))
 response = ExampleApi.call(request)
-```
-
-
 
+# or, simply work with CLI args :)
+ExampleApi.run
+```
 
 ## Installation
 
@@ -95,6 +60,17 @@ gem 'relax2'
 
 and then `bundle install`
 
+## References
+
+### Examples
+
+* Example of relax2 for [Android Management API](https://developers.google.com/android/management): https://github.com/YusukeIwaki/relax2-androidmanagement-api
+
+### Other langs
+
+* rakuda[https://github.com/YusukeIwaki/rakuda]: Dart implementation. Good for distributing in-house API client tool.
+* [@zatsu/core](https://github.com/YusukeIwaki/zatsu-core): Node.js implementation. Useful for distribution with npx.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/relax2/interceptors.rb

@@ -12,8 +12,8 @@ module Relax2
         lines = []
         lines << "#{request.http_method} #{request.path}"
         if @print_headers
-          request.headers.each do |header|
-            lines << "#{header.name}: #{header.value}"
+          request.headers.each do |name, value|
+            lines << "#{name}: #{value}"
           end
         end
 
@@ -42,8 +42,8 @@ module Relax2
         lines << "HTTP #{response.status}" if @print_status
 
         if @print_headers
-          response.headers.each do |header|
-            lines << "#{header.name}: #{header.value}"
+          response.headers.each do |name, value|
+            lines << "#{name}: #{value}"
           end
         end
 
@@ -52,6 +52,8 @@ module Relax2
           lines << response.body
         end
         puts lines.join("\n")
+
+        response
       end
     end
 

data/lib/relax2/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Relax2
-  VERSION = '0.1.0'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relax2
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - YusukeIwaki
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-18 00:00:00.000000000 Z
+date: 2025-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,7 +150,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - q7w8e9w8q7w8e9@yahoo.co.jp
 executables: []
@@ -159,6 +159,7 @@ extra_rdoc_files: []
 files:
 - ".rubocop.yml"
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
@@ -179,7 +180,7 @@ files:
 homepage: https://github.com/YusukeIwaki/relax2
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -195,7 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.7
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A quick and dirty HTTP API client factory for Ruby
 test_files: []