web_api 1.0.210927 → 2.0.221220

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82115f267d8164697506e891e5dace6f796a69ab8923c1dd193dd5d38faeff3e
-  data.tar.gz: c60078933f51883cadefb158d221607e9e11bad9cd66fc47185f87d2df45adc4
+  metadata.gz: 45268acfd02c273b2cdc3287a654dbd673b6e1851d101ae35ec2cf50d8f24a55
+  data.tar.gz: 48566e13c223421ededbcfcc8433daa76e9f59b180c2cbd77069d0f63b71e9cf
 SHA512:
-  metadata.gz: 32e2b5f9b5f467aee348c968a409bd7df263eeb73395929e8e3f43945bdf9ed2cf6f9d3b0c715dc6685239f56601d1ed99928a858d9d622aca285542a5539d16
-  data.tar.gz: ed2d94e383e02ae8c327157054b91d069131470e6b21ed107797879eaef05d6072d134eff70ea7999e7b6e989d430b082b28e936b1d0c1e9a020c03aee781e36
+  metadata.gz: 5401701566ec8629ddf63a4bdd046b086505ad196ce5f7cf0766db9f281b5c49a430d84b14f4f7fffc1877d966287d281381b25a843724d57852df0f7f9649fd
+  data.tar.gz: 332efd0ad4edfa7d7c7734686c7b728831e655f0bc75fcb9e5255cf360c23c6f12ec4d70f599bf286e5c1f50d74e2b22567a090cb654d71ed170680cffab9797

data/README.md

@@ -1,12 +1,12 @@
 # WebApi
 
-* [VERSION 1.0.210927](https://www.github.com/carlosjhr64/web_api)
+* [VERSION 2.0.221220](https://www.github.com/carlosjhr64/web_api)
 * [github](https://www.github.com/carlosjhr64/web_api)
 * [rubygems](https://rubygems.org/gems/web_api)
 
 ## DESCRIPTION:
 
-Ruby library for web api's.
+Ruby library for web API's.
 
 ## SYNOPSIS:
 ```ruby
@@ -25,18 +25,18 @@ $ gem install web_api
 ## MORE:
 
 There's not that much code here...
-under 200 lines in `lib/**.rb` at the time of this writing.
+Under 200 lines in `lib/**.rb` at the time of this writing.
 Take a look at the examples given at [github](https://github.com/carlosjhr64/web_api/tree/master/examples)
 for use cases.
 
 The model is that at each step...
 
-1. instantiation of a WebApi object
-2. addition of a WebApi method
-3. call to a WebApi method
+1. instantiation of a `WebApi` object
+2. addition of a `WebApi` method
+3. call to a `WebApi` method
 
-...one builds up the url, type, data, and header of the http request.
-The WebApi methods `#new`, `#add`, and `#<method>`
+...one builds up the URL, type, data, and header of the HTTP request.
+The `WebApi` methods `#new`, `#add`, and `#<method>`
 all have the same argument signature:
 
     extension String,
@@ -62,13 +62,11 @@ it only gets a hash:
     #<method>({"a"=>"ABC","x"=>"XYZ"})
     #=> #<method>('', data: {"a"=>"ABC","x"=>"XYZ"})
 
-The dumper to dump the data in a post request is JSON.dump by default
-if JSON is available.
+The dumper to dump the data in a post request is `JSON.dump` by default
+if `JSON` is available.
 
-The parser to parse the body of an "application/json" type content is
-JSON.parse by default if available.
-You can read the code and inspect `WebApi::PARSER`
-to see the other parsers available by default.
+The parser to parse the body of an `application/json` type content is
+`JSON.parse` by default if available.
 
 If one does not want to parse the response's body,
 one can set `parser: :none`. For example:
@@ -79,7 +77,7 @@ body = webapi.resourse(data: {key: "value"}, parser: :none)
 
 (The MIT License)
 
-Copyright (c) 2021 CarlosJHR64
+Copyright (c) 2022 CarlosJHR64
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/web_api/web_api.rb

@@ -1,17 +1,22 @@
 class WebApi
-  DUMPER = (defined? JSON)? JSON.method(:dump) : :none
+  def WebApi.get_dumper
+    (defined? JSON)? JSON.method(:dump) : :none
+  end
 
-  PARSER = Hash.new :none
-  PARSER['application/json'] = JSON.method(:parse)    if defined? JSON
-  PARSER['text/csv']  = CSV.method(:parse)            if defined? CSV
-  PARSER['text/html'] = Nokogiri::HTML.method(:parse) if defined? Nokogiri
+  def WebApi.get_parsers
+    parsers = Hash.new :none
+    parsers['application/json'] = JSON.method(:parse)    if defined? JSON
+    parsers['text/csv']  = CSV.method(:parse)            if defined? CSV
+    parsers['text/html'] = Nokogiri::HTML.method(:parse) if defined? Nokogiri
+    return parsers
+  end
 
   def initialize(base =  '',
                  type:   :get,
                  data:   {},
                  header: {},
-                 dumper: DUMPER,
-                 parser: PARSER,
+                 dumper: WebApi.get_dumper,
+                 parser: WebApi.get_parsers,
                  &block)
     @base, @type, @data, @header, @dumper, @parser, @block =
      base,  type,  data,  header,  dumper,  parser,  block

data/lib/web_api/web_api_method.rb

@@ -7,9 +7,9 @@ class WebApiMethod
   OK = 200..299
 
   # Escapes value's string representation for query string use.
-  def escape(value)
-    #http://rosettacode.org/wiki/URL_encoding#Ruby
-    CGI.escape(value.to_s).gsub("+", "%20")
+  def escape(s)
+    # Contraction of ERB#url_encode method
+    s.to_s.b.gsub(/[^\w\-.~]/n){sprintf("%%%02X",_1.unpack1("C"))}
   end
 
   def query_string(ah)
@@ -28,6 +28,9 @@ class WebApiMethod
      target,  type,  data,  header,  dumper,  parser,  block
   end
 
+  # uri_parse(request: CRStruct) -> N/A
+  # Expects request to have url, data, type, and dumper.
+  # Sets the request's scheme, host, port, uri, and payload
   def uri_parse(request)
     uri = URI.parse(request.url)
     request_uri = uri.request_uri
@@ -56,21 +59,25 @@ class WebApiMethod
     request.header = @header.merge(header)
     request.dumper = dumper || @dumper
 
-    parser = parser || @parser
-    block  = block  || @block
+    parser ||= @parser
+    block  ||= @block
 
     uri_parse(request)
     block.call(request) if block
 
     body, content = http_response_body(request)
-    parser = parser[content]  if parser.is_a? Hash
-    body = parser.call body if parser and parser!=:none
+    parser = parser[content]   if parser.is_a? Hash
+    body   = parser.call(body) if parser and parser!=:none
     return body
   end
 
   def http_response_body(request)
     response = http_response(request)
-    raise ResponseError, response.message unless OK === response.code.to_i
+    unless OK === response.code.to_i
+      $stderr.puts response.code
+      $stderr.puts response.body
+      raise ResponseError, response.message
+    end
     return response.body, response['content-type'].sub(/;.*$/,'')
   end
 

data/lib/web_api.rb

@@ -1,13 +1,10 @@
 # Standard Libraries
 require 'net/http'
-require 'cgi'
-
 # External Gems
 require 'crstruct'
-
 # This Gem
 class WebApi
-  VERSION = '1.0.210927'
+  VERSION = '2.0.221220'
   require_relative 'web_api/web_api_method.rb'
   require_relative 'web_api/web_api.rb'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: web_api
 version: !ruby/object:Gem::Version
-  version: 1.0.210927
+  version: 2.0.221220
 platform: ruby
 authors:
 - CarlosJHR64
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-27 00:00:00.000000000 Z
+date: 2022-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: crstruct
@@ -16,21 +16,21 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.210920
+        version: 1.0.221218
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.210920
-description: 'Ruby library for web api''s.
+        version: 1.0.221218
+description: 'Ruby library for web API''s.
 
   '
 email: carlosjhr64@gmail.com
@@ -46,7 +46,7 @@ homepage: https://github.com/carlosjhr64/web_api
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -61,9 +61,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- 'ruby: ruby 3.0.2p107 (2021-07-07 revision 0db68f0233) [x86_64-linux]'
-rubygems_version: 3.2.22
-signing_key:
+- 'ruby: ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) [aarch64-linux]'
+rubygems_version: 3.3.7
+signing_key: 
 specification_version: 4
-summary: Ruby library for web api's.
+summary: Ruby library for web API's.
 test_files: []