client-api-builder 0.1.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34ae348684b22669748f3dca2fc9866f2b87247da8452fc5b848e175c1ef74a8
-  data.tar.gz: 95e6b09d24e961c0ce20a6cc15d3fcdf858f47b2725151838cd8ea5d01df0965
+  metadata.gz: '01795148989ed0a14c42cb886fd3ce76e3692d82c388f49adf09b7b7229b928f'
+  data.tar.gz: 4ce828ecc5ee2017e6318ab83e8c1c02e3a557f746a7f3f6fc8d7471cdac2750
 SHA512:
-  metadata.gz: e6dd7780a28eec364c787d209fbd37618c6c9f8c7262c1abaa2fbf90b419240657a77bd1a7523388f680643837839162c36a427ca3023ccee986d6f0c1ba3b43
-  data.tar.gz: 6b407cefa4e351149e881c6f19897f1566b0440684790f26b9df7636a151737c068efd23ced372b8cd0a306179dc6a4c3491de574fdaacdd8b5f90b0b03e5e93
+  metadata.gz: 57b713cda946c263a13f6642d8548442f574eaea1f0374b1e02c7d2f071a3826aeb3e49eaa3a785784eeb7caa671584192f0391e6a508b5dbbd4fff32868063e
+  data.tar.gz: d41bfea574c3399d534455ab7165a9fc6f91c347fd5c6d6634fa67731bb5198ccc843532e06fea853097316f766522daebf875cce855694b87e67bb0ea6771fb

data/.ruby-version

@@ -1 +1 @@
-2.7.1
+3.0.0

data/Gemfile.lock

@@ -1,60 +1,62 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.1)
+    ast (2.4.2)
     crack (0.4.5)
       rexml
     diff-lcs (1.4.4)
-    docile (1.3.2)
+    docile (1.4.0)
     hashdiff (1.0.1)
     inheritance-helper (0.1.5)
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
       ast (~> 2.4.1)
     public_suffix (4.0.6)
     rainbow (3.0.0)
-    rake (13.0.1)
-    regexp_parser (1.7.1)
-    rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.87.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.18.2)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.1.0, < 1.0)
+      rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.1.0)
-      parser (>= 2.7.0.1)
-    ruby-progressbar (1.10.1)
-    simplecov (0.18.5)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.7.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
-    unicode-display_width (1.7.0)
-    webmock (3.11.1)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    unicode-display_width (2.0.0)
+    webmock (3.13.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
-  ruby
+  x86_64-darwin-20
 
 DEPENDENCIES
   inheritance-helper
@@ -65,4 +67,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.1.4
+   2.2.3

data/client-api-builder.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'client-api-builder'
-  s.version     = '0.1.0'
+  s.version     = '0.2.3'
   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/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 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
@@ -38,9 +39,9 @@ module ClientApiBuilder
         add_value_to_class_method(:default_options, query_builder: builder)
       end
 
-      def header(name, value)
+      def header(name, value = nil, &block)
         headers = default_options[:headers].dup
-        headers[name] = value
+        headers[name] = value || block
         add_value_to_class_method(:default_options, headers: headers)
       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,30 @@ 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,
+             :io
+          code += "  @response = stream_to_file(**@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
@@ -211,11 +253,23 @@ module ClientApiBuilder
     end
 
     def build_headers(options)
-      if options[:headers]
-        self.class.headers.merge(options[:headers])
-      else
-        self.class.headers
+      headers = {}
+
+      add_header_proc = proc do |name, value|
+        headers[name] =
+          if value.is_a?(Proc)
+            instance_eval(&value)
+          elsif value.is_a?(Symbol)
+            send(value)
+          else
+            value
+          end
       end
+
+      self.class.headers.each(&add_header_proc)
+      options[:headers]&.each(&add_header_proc)
+
+      headers
     end
 
     def build_connection_options(options)
@@ -227,8 +281,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)
@@ -257,7 +326,16 @@ module ClientApiBuilder
     end
 
     def handle_response(response, options, &block)
-      data = parse_response(response, options)
+      data =
+        case options[:return]
+        when :response
+          response
+        when :body
+          response.body
+        else
+          parse_response(response, options)
+        end
+
       if block
         instance_exec(data, &block)
       else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: client-api-builder
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Doug Youch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-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,7 @@ files:
 - LICENSE
 - README.md
 - client-api-builder.gemspec
+- examples/basic_auth_example_client.rb
 - lib/client-api-builder.rb
 - lib/client_api_builder/net_http_request.rb
 - lib/client_api_builder/query_params.rb
@@ -48,7 +49,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Develop Client API libraries faster