client-api-builder 0.2.1 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d181593590629e548b61b096cf47322584fd943002972d002d6104348628af7
-  data.tar.gz: 01a9168981928f32c6a64a0315dce7227c2153a4b75bfb1e9192a69f1bc80785
+  metadata.gz: ed94b089c0e0f86ccf4acec03af52e2b23e6b0c7f284b3a947e9c15280fc208e
+  data.tar.gz: 7858cb787ce243ee49ad7d953d747f859116f0cc47906d13235faa71e629f1ca
 SHA512:
-  metadata.gz: b7eec7746486022b3f92e01a96a49057299cb2a4f6afd9b763ba4214bd6c61d79f0c2d6e4e2447a302a7751939628881dca83b274cbf4efc5a8f70b582d2ecc4
-  data.tar.gz: 2b4729698266b975556d13b717fd6ea5224f2da79379e2f1225058b1bc03e2a20d20be7228ff4d7c181e0275529577f46cf183dcddd271efb08a95f8490ea9b8
+  metadata.gz: '096660ad1bde2cec7fbfbcf532879cc415a702c467e5dc687469f2b77aaa064a94a82a3a1efc5f480d35408adb0af8c870d686fe5ab11b5842a2c51eff58097e'
+  data.tar.gz: 2e15e44494be6edd6fbb29f1469b70708567d071a4936b1b58902c96e7a0958e1a5de10e8de8abcbf66baeaaab99152c93752cec9045ce11dbba459072fbc938

data/client-api-builder.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'client-api-builder'
-  s.version     = '0.2.1'
+  s.version     = '0.2.5'
   s.licenses    = ['MIT']
   s.summary     = 'Develop Client API libraries faster'
   s.description = 'Utility for constructing API clients'

data/examples/basic_auth_example_client.rb

@@ -0,0 +1,23 @@
+require 'base64'
+
+class BasicAuthExampleClient < Struct.new(
+        :username,
+        :password
+      )
+
+  include ClientApiBuilder::Router
+
+  base_url 'https://www.example.com'
+
+  header 'Authorization', :basic_authorization
+  query_param('cache_buster') { (Time.now.to_f * 1000).to_i }
+
+  route :get_apps, '/apps'
+  route :get_app, '/apps/:app_id'
+
+  private
+
+  def basic_authorization
+    'basic ' + Base64.strict_encode64(username + ':' + password)
+  end
+end

data/examples/imdb_datasets_client.rb

@@ -0,0 +1,31 @@
+class IMDBDatesetsClient
+  include ClientApiBuilder::Router
+
+  base_url 'https://datasets.imdbws.com'
+
+  route :get_name_basics, '/name.basics.tsv.gz', stream: :file
+  route :get_title_akas, '/title.akas.tsv.gz', stream: :io
+  route :get_title_basics, '/title.basics.tsv.gz', stream: :block
+
+  def self.stream_to_file
+    new.get_name_basics(file: 'name.basics.tsv.gz')
+  end
+
+  def self.stream_to_io
+    File.open('title.akas.tsv.gz', 'wb') do |io|
+      new.get_title_akas(io: io)
+    end
+  end
+
+  def self.stream_with_block
+    File.open('title.basics.tsv.gz', 'wb') do |io|
+      total_read = 0.0
+      new.get_title_basics do |response, chunk|
+        total_read += chunk.bytesize
+        percentage_complete = ((total_read / response.content_length) * 100).to_i
+        puts "downloading title.basics.tsv.gz completed: #{percentage_complete}%"
+        io.write chunk
+      end
+    end
+  end
+end

data/lib/client_api_builder/net_http_request.rb

@@ -28,7 +28,30 @@ module ClientApiBuilder
         request.body = body if body
 
         Net::HTTP.start(uri.hostname, uri.port, connection_options.merge(use_ssl: uri.scheme == 'https')) do |http|
-          http.request(request)
+          http.request(request) do |response|
+            yield response if block_given?
+          end
+        end
+      end
+
+      def stream(method:, uri:, body:, headers:, connection_options:)
+        request(method: method, uri: uri, body: body, headers: headers, connection_options: connection_options) do |response|
+          response.read_body do |chunk|
+            yield response, chunk
+          end
+        end
+      end
+
+      def stream_to_io(method:, uri:, body:, headers:, connection_options:, io:)
+        stream(method: method, uri: uri, body: body, headers: headers, connection_options: connection_options) do |_, chunk|
+          io.write chunk
+        end
+      end
+
+      def stream_to_file(method:, uri:, body:, headers:, connection_options:, file:)
+        mode = connection_options.delete(:file_mode) || 'wb'
+        File.open(file, mode) do |io|
+          stream_to_io(method: method, uri: uri, body: body, headers: headers, connection_options: connection_options, io: io)
         end
       end
     end

data/lib/client_api_builder/router.rb

@@ -7,7 +7,7 @@ module ClientApiBuilder
       base.extend InheritanceHelper::Methods
       base.extend ClassMethods
       base.include ::ClientApiBuilder::NetHTTP::Request
-      base.attr_reader :response
+      base.attr_reader :response, :request_options
     end
 
     module ClassMethods
@@ -51,7 +51,7 @@ module ClientApiBuilder
         add_value_to_class_method(:default_options, connection_options: connection_options)
       end
 
-      def query_param(name, value)
+      def query_param(name, value = nil, &block)
         query_params = default_options[:query_params].dup
         query_params[name] = value || block
         add_value_to_class_method(:default_options, query_params: query_params)
@@ -146,6 +146,11 @@ module ClientApiBuilder
       def generate_route_code(method_name, path, options = {})
         http_method = options[:method] || http_method(method_name)
 
+        # instance method
+        path.gsub!(/\{([a-z0-9_]+)\}/i) do |_|
+          "#\{#{$1}\}"
+        end
+
         path_arguments = []
         path.gsub!(/:([a-z0-9_]+)/i) do |_|
           path_arguments << $1
@@ -192,8 +197,18 @@ module ClientApiBuilder
           end
         expected_response_codes.map!(&:to_s)
 
+        stream_param =
+          case options[:stream]
+          when true,
+               :file
+            :file
+          when :io
+            :io
+          end
+
         method_args = named_arguments.map { |arg_name| "#{arg_name}:" }
         method_args += ['body:'] if has_body_param
+        method_args += ["#{stream_param}:"] if stream_param
         method_args += ['**__options__', '&block']
 
         code = "def #{method_name}(" + method_args.join(', ') + ")\n"
@@ -205,9 +220,31 @@ module ClientApiBuilder
         code += "  __body__ = build_body(__body__, __options__)\n"
         code += "  __headers__ = build_headers(__options__)\n"
         code += "  __connection_options__ = build_connection_options(__options__)\n"
-        code += "  @response = request(method: #{http_method.inspect}, uri: __uri__, body: __body__, headers: __headers__, connection_options: __connection_options__)\n"
+        code += "  @request_options = {method: #{http_method.inspect}, uri: __uri__, body: __body__, headers: __headers__, connection_options: __connection_options__}\n"
+        code += "  @request_options[:#{stream_param}] = #{stream_param}\n" if stream_param
+
+        case options[:stream]
+        when true,
+             :file
+          code += "  @response = stream_to_file(**@request_options)\n"
+        when :io
+          code += "  @response = stream_to_io(**@request_options)\n"
+        when :block
+          code += "  @response = stream(**@request_options, &block)\n"
+        else
+          code += "  @response = request(**@request_options)\n"
+        end
+
         code += "  expected_response_code!(@response, __expected_response_codes__, __options__)\n"
-        code += "  handle_response(@response, __options__, &block)\n"
+
+        if options[:stream] || options[:return] == :response
+          code += "  @response\n"
+        elsif options[:return] == :body
+          code += "  @response.body\n"
+        else
+          code += "  handle_response(@response, __options__, &block)\n"
+        end
+
         code += "end\n"
         code
       end

data/script/console

@@ -2,6 +2,9 @@
 # frozen_string_literal: true
 
 $LOAD_PATH << File.expand_path('../lib', __dir__)
+$LOAD_PATH << File.expand_path('../examples', __dir__)
 require 'client-api-builder'
+autoload :BasicAuthExampleClient, 'basic_auth_example_client'
+autoload :IMDBDatesetsClient, 'imdb_datasets_client'
 require 'irb'
 IRB.start(__FILE__)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: client-api-builder
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.5
 platform: ruby
 authors:
 - Doug Youch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-05 00:00:00.000000000 Z
+date: 2021-07-18 00:00:00.000000000 Z
 dependencies: []
 description: Utility for constructing API clients
 email: dougyouch@gmail.com
@@ -24,6 +24,8 @@ files:
 - LICENSE
 - README.md
 - client-api-builder.gemspec
+- examples/basic_auth_example_client.rb
+- examples/imdb_datasets_client.rb
 - lib/client-api-builder.rb
 - lib/client_api_builder/net_http_request.rb
 - lib/client_api_builder/query_params.rb