client-api-builder 0.2.0 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e5b76aafc223c8695b05460638fbd487b9ee2ad969e690f26de97d1cccf8293
-  data.tar.gz: 4b31ea3ef759fd3cf553d32e6b474378137e6b0badc52139068f7db9d7f87b00
+  metadata.gz: fe20c0bab4626c805bc2b0c982cdd2bf27ed6b83d601a2b4be3377da74d34d65
+  data.tar.gz: c82184aadfac611f12f57060bc315d9790b4bab7238ba4c2942334058b5fdafd
 SHA512:
-  metadata.gz: bb0d45fe8b4832a73b84a931f63ea3713a955c0d5b44a31159a54b0d454b4b63c0d29d80a379cbbcbd1c469b4b65a9e04ba238650d04e749f28918819987b65a
-  data.tar.gz: 752dfdf1071668e456532b1d41c1adcdbd522e09bb6a05a5c904f678a71e62014247ecc6e66a0a51fe8474fc222dee05127e9988406b95e6c5887ee6682f7f23
+  metadata.gz: b3df586e352a828dc8423862f425ce0524c4e479c10f4e35b6a514b92412277dc4d0c095afbdaaeb024b5783c38745f3d1fe2bebb31b34f097611b0dca77d7ad
+  data.tar.gz: 42c359200e625705ce7960ae88d861d49cf5a83ad7e3dca71ee240f0df36addb88a7488e9da656a6d545b27cafe6075f09b8aab2242363896aa0321fb3399bf5

data/client-api-builder.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'client-api-builder'
-  s.version     = '0.2.0'
+  s.version     = '0.2.4'
   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
@@ -22,6 +22,7 @@ module ClientApiBuilder
           base_url: nil,
           headers: {},
           connection_options: {},
+          query_params: {},
           query_builder: Hash.method_defined?(:to_query) ? :to_query : :query_params
         }.freeze
       end
@@ -50,6 +51,12 @@ module ClientApiBuilder
         add_value_to_class_method(:default_options, connection_options: connection_options)
       end
 
+      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)
+      end
+
       def headers
         default_options[:headers]
       end
@@ -58,6 +65,10 @@ module ClientApiBuilder
         default_options[:connection_options]
       end
 
+      def query_params
+        default_options[:query_params]
+      end
+
       def build_query(query)
         case query_builder
         when :to_query
@@ -181,8 +192,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"
@@ -194,9 +215,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
@@ -239,8 +282,23 @@ module ClientApiBuilder
     end
 
     def build_query(query, options)
-      query.merge!(options[:query]) if options[:query]
-      self.class.build_query(query)
+      query_params = {}
+
+      add_query_param_proc = proc do |name, value|
+        query_params[name] =
+          if value.is_a?(Proc)
+            instance_eval(&value)
+          elsif value.is_a?(Symbol)
+            send(value)
+          else
+            value
+          end
+      end
+
+      self.class.query_params.each(&add_query_param_proc)
+      query&.each(&add_query_param_proc)
+
+      self.class.build_query(query_params)
     end
 
     def build_body(body, options)

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.0
+  version: 0.2.4
 platform: ruby
 authors:
 - Doug Youch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-05 00:00:00.000000000 Z
+date: 2021-07-17 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