web_api 0.3.191208 → 2.0.221220

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d807c131626709ce9df0f7e5fa92c96fd7a0df6868fc96a823be2ec823ef26aa
-  data.tar.gz: a9c6ecf0c3a73b2a4d4018eb7882054c6029c85cc3decf7bca28a452f38313ee
+  metadata.gz: 45268acfd02c273b2cdc3287a654dbd673b6e1851d101ae35ec2cf50d8f24a55
+  data.tar.gz: 48566e13c223421ededbcfcc8433daa76e9f59b180c2cbd77069d0f63b71e9cf
 SHA512:
-  metadata.gz: ef7a923eee894aa4f3346ccbc5a1b89601e58a17aac35e11821ed604ebc0c1354286466a3b4dbee9e5de78642bf646dc2e5fbb7319f5a06bd04d8c8df2609454
-  data.tar.gz: cd959864b8da19658c3a54afb46b0bdd39bffb5a24658be664a51cfa2eb85cbe1a6da0d16085be7c6eaf354461f654de69b460a3dfa39ffce4383d6ab06f6bf4
+  metadata.gz: 5401701566ec8629ddf63a4bdd046b086505ad196ce5f7cf0766db9f281b5c49a430d84b14f4f7fffc1877d966287d281381b25a843724d57852df0f7f9649fd
+  data.tar.gz: 332efd0ad4edfa7d7c7734686c7b728831e655f0bc75fcb9e5255cf360c23c6f12ec4d70f599bf286e5c1f50d74e2b22567a090cb654d71ed170680cffab9797

data/README.md

@@ -1,44 +1,52 @@
-# web_api
+# WebApi
 
+* [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:
-
-    require 'web_api'
-    webapi = WEB_API::WebApi.new "https://api.site.org/path-to-base/", header: {Authorization: "Bearer ABC123XYZ"}
-    # for a post to https://api.site.org/path-to-base/resource...
-    webapi.add(:resource, type: :post)
-    # You can pass the post's (or query's) key value pairs in a hash.
-    body = webapi.resource(data: {key: "value"})
-
+```ruby
+require 'web_api'
+webapi = WebApi.new "https://api.site.org/path-to-base/",
+                             header: {Authorization: "Bearer ABC123XYZ"}
+# for a post to https://api.site.org/path-to-base/resource...
+webapi.add(:resource, type: :post)
+# You can pass the post's (or query's) key value pairs in a hash.
+body = webapi.resource(data: {key: "value"})
+```
 ## INSTALL:
-
-    $ gem install web_api
-
+```console
+$ gem install web_api
+```
 ## MORE:
 
 There's not that much code here...
-under 200 lines in `lib/**.rb` at the time of this writting.
+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>` all have the same argument signature:
+...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, type: Symbol, data: Hash, header: Hash, dumper: Proc, Parser: Proc|Hash(String, Proc)
+    extension String,
+    type:     Symbol,
+    data:     Hash,
+    header:   Hash,
+    dumper:   Proc,
+    Parser:   Proc|Hash(String, Proc)
 
-The extension builds up the url by concatanation.
+The extension builds up the url by concatenation.
 The data and headers hashes are built up with merge.
 The type, dumper, and parser can be changed at each step.
 
@@ -46,28 +54,30 @@ One can read the code to check the minor nuances of each method's signature,
 such as default values.
 
 Note that `#add` will assume extension is the same as the name of the method if
-no extenstion is given.
+no extension is given.
 
-Note that `#<method>` will assume the user meant to pass data if it only gets a hash, but
-the hash must then not have any `Symbol` for its keys:
+Note that `#<method>` will assume the user meant to pass data if
+it only gets a hash:
 
-    #<method>({"a"=>"ABC","x"=>"XYZ"}) #=> #<method>('', data: {"a"=>"ABC","x"=>"XYZ"})
+    #<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 `WEB_API::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 reponse's body,
+If one does not want to parse the response's body,
 one can set `parser: :none`. For example:
-
-    body = webapi.resourse(data: {key: "value"}, parser: :none)
-
+```ruby
+body = webapi.resourse(data: {key: "value"}, parser: :none)
+```
 ## LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2019 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,58 +1,63 @@
-module WEB_API
-  class WebApi
-    DUMPER = (defined? JSON)? JSON.method(:dump)  : :none
+class WebApi
+  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,
-                   &block)
-      @base, @type, @data, @header, @dumper, @parser, @block =
-       base,  type,  data,  header,  dumper,  parser,  block
-      @strict = false
-      @webmethods = {}
-    end
+  def initialize(base =  '',
+                 type:   :get,
+                 data:   {},
+                 header: {},
+                 dumper: WebApi.get_dumper,
+                 parser: WebApi.get_parsers,
+                 &block)
+    @base, @type, @data, @header, @dumper, @parser, @block =
+     base,  type,  data,  header,  dumper,  parser,  block
+    @strict = false
+    @webmethods = {}
+  end
 
-    def strict!(t = true)
-      @strict = t
-    end
+  def strict!(t = true)
+    @strict = t
+  end
 
-    def add(method, target =  method.to_s,
-                    type:   @type,
-                    data:   {},
-                    header: {},
-                    dumper: @dumper,
-                    parser: @parser,
-                    &block)
-      @webmethods[method] = WebApiMethod.new(@base+target,
-                                             type,
-                                             @data.merge(data),
-                                             @header.merge(header),
-                                             dumper,
-                                             parser,
-                                             &(block || @block))
-    end
+  def add(method, target =  method.to_s,
+                  type:   @type,
+                  data:   {},
+                  header: {},
+                  dumper: @dumper,
+                  parser: @parser,
+                  &block)
+    @webmethods[method] = WebApiMethod.new(@base+target,
+                                           type,
+                                           @data.merge(data),
+                                           @header.merge(header),
+                                           dumper,
+                                           parser,
+                                           &(block || @block))
+  end
 
-    def method_missing(symbol , extension =  '',
-                                type:   nil,
-                                data:   {},
-                                header: {},
-                                dumper: nil,
-                                parser: nil,
-                                &block)
-      unless @webmethods.has_key? symbol
-        super if @strict
-        add symbol
-      end
-      extension, data = '', extension unless extension.is_a? String # user passed data as first argument
-      @webmethods[symbol].run(extension, type, data, header, dumper, parser, &block)
+  def method_missing(symbol , extension =  '',
+                              type:   nil,
+                              data:   {},
+                              header: {},
+                              dumper: nil,
+                              parser: nil,
+                              &block)
+    unless @webmethods.has_key? symbol
+      super if @strict
+      add symbol
     end
+    # user passed data as first argument?
+    extension, data = '', extension unless extension.is_a? String
+    @webmethods[symbol].run(extension, type, data, header, dumper, parser,
+                            &block)
   end
 end

data/lib/web_api/web_api_method.rb

@@ -1,99 +1,103 @@
-module WEB_API
-  class WebApiMethod
-    class ResponseError < ::RuntimeError
-    end
-    class UnsupportedMethodError < ::RuntimeError
-    end
+class WebApiMethod
+  class ResponseError < ::RuntimeError
+  end
+  class UnsupportedMethodError < ::RuntimeError
+  end
 
-    OK = 200..299
+  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")
-    end
+  # Escapes value's string representation for query string use.
+  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)
-      case ah
-      when Array
-        ah.select{|h| !h.empty?}.map{|h| query_string(h)}.join('&')
-      when Hash
-        ah.map do |k,v|
-          "#{k}=#{escape v}"
-        end
-        .join('&')
-      else
-        ah.to_s
-      end
+  def query_string(ah)
+    case ah
+    when Array
+      ah.select{!_1.empty?}.map{query_string _1}.join('&')
+    when Hash
+      ah.map{"#{_1}=#{escape _2}"}.join('&')
+    else
+      ah.to_s
     end
+  end
 
-    def initialize(target, type, data, header, dumper, parser, &block)
-      @target, @type, @data, @header, @dumper, @parser, @block =
-       target,  type,  data,  header,  dumper,  parser,  block
-    end
+  def initialize(target, type, data, header, dumper, parser, &block)
+    @target, @type, @data, @header, @dumper, @parser, @block =
+     target,  type,  data,  header,  dumper,  parser,  block
+  end
 
-    def uri_parse(request)
-      uri = URI.parse(request.url)
-      request_uri = uri.request_uri
-      payload = ''
-      unless request.data.empty?
-        if request.type == :post
-          if dumper=request.dumper and (dumper!=:none)
-            payload = dumper.call(request.data)
-          else
-            payload = query_string(request.data)
-          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
+    payload = ''
+    unless request.data.empty?
+      if request.type == :post
+        if dumper=request.dumper and (dumper!=:none)
+          payload = dumper.call(request.data)
         else
           payload = query_string(request.data)
-          request_uri += (uri.query ? '&' : '?') + payload
         end
+      else
+        payload = query_string(request.data)
+        request_uri += (uri.query ? '&' : '?') + payload
       end
-      request.scheme, request.host, request.port, request.uri, request.payload =
-          uri.scheme,     uri.host,     uri.port, request_uri,         payload
     end
+    request.scheme, request.host, request.port, request.uri, request.payload =
+        uri.scheme,     uri.host,     uri.port, request_uri,         payload
+  end
 
-    def run(extension, type, data, header, dumper, parser, &block)
-      request        = CRStruct::Open.new
-      request.url    = @target+extension
-      request.type   = type || @type
-      request.data   = @data.merge(data)
-      request.header = @header.merge(header)
-      request.dumper = dumper || @dumper
+  def run(extension, type, data, header, dumper, parser, &block)
+    request        = CRStruct::Open.new
+    request.url    = @target+extension
+    request.type   = type || @type
+    request.data   = @data.merge(data)
+    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
+    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
-      return body
-    end
+    body, content = http_response_body(request)
+    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
-      return response.body, response['content-type'].sub(/;.*$/,'')
+  def http_response_body(request)
+    response = http_response(request)
+    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
 
-    def http_response(request)
-      http = net_http(request)
-      case request.type
-      when :get, :delete, :head, :copy, :move, :options, :trace
-        http.method(request.type).call request.uri, request.header
-      when :post, :patch, :lock, :unlock, :mkcol, :propfind, :proppatch
-        http.method(request.type).call request.uri, request.payload, request.header
-      else
-        raise UnsupportedMethodError, "Method type #{type}(#{type.class}) not supported by WEB_API::WebApi."
-      end
+  def http_response(request)
+    http = net_http(request)
+    case request.type
+    when :get, :delete, :head, :copy, :move, :options, :trace
+      http.method(request.type).call request.uri, request.header
+    when :post, :patch, :lock, :unlock, :mkcol, :propfind, :proppatch
+      http.method(request.type)
+        .call request.uri, request.payload, request.header
+    else
+      raise UnsupportedMethodError,
+        "Method type #{type}(#{type.class}) not supported by WebApi."
     end
+  end
 
-    def net_http(request)
-      http = Net::HTTP.new(request.host, request.port)
-      http.use_ssl = request.scheme=='https'
-      return http
-    end
+  def net_http(request)
+    http = Net::HTTP.new(request.host, request.port)
+    http.use_ssl = request.scheme=='https'
+    return http
   end
 end

data/lib/web_api.rb

@@ -1,16 +1,12 @@
 # Standard Libraries
 require 'net/http'
-require 'cgi'
-
 # External Gems
 require 'crstruct'
-
 # This Gem
-module WEB_API
-  VERSION = '0.3.191208'
-  require 'web_api/web_api_method.rb'
-  require 'web_api/web_api.rb'
+class WebApi
+  VERSION = '2.0.221220'
+  require_relative 'web_api/web_api_method.rb'
+  require_relative 'web_api/web_api.rb'
 end
-
 # Requires:
 #`ruby`

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: web_api
 version: !ruby/object:Gem::Version
-  version: 0.3.191208
+  version: 2.0.221220
 platform: ruby
 authors:
-- carlosjhr64
+- CarlosJHR64
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-08 00:00:00.000000000 Z
+date: 2022-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: crstruct
@@ -16,15 +16,21 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.191207
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.221218
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.191207
-description: 'Ruby library for web api''s.
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.221218
+description: 'Ruby library for web API''s.
 
   '
 email: carlosjhr64@gmail.com
@@ -55,9 +61,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- 'ruby: ruby 2.6.5p114 (2019-10-01 revision 67812) [x86_64-linux]'
-rubygems_version: 3.0.3
+- '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: []