client-api-builder 0.2.3 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '01795148989ed0a14c42cb886fd3ce76e3692d82c388f49adf09b7b7229b928f'
-  data.tar.gz: 4ce828ecc5ee2017e6318ab83e8c1c02e3a557f746a7f3f6fc8d7471cdac2750
+  metadata.gz: 920aa0f202c1e60cf6e3dc8bf0e44d289f3cc37ec6052b2bca3535493065bb7e
+  data.tar.gz: c8f534c244d2c572f36f9b42a64610bde62a7bbc8b8d54ef2ae7049982f6a1c0
 SHA512:
-  metadata.gz: 57b713cda946c263a13f6642d8548442f574eaea1f0374b1e02c7d2f071a3826aeb3e49eaa3a785784eeb7caa671584192f0391e6a508b5dbbd4fff32868063e
-  data.tar.gz: d41bfea574c3399d534455ab7165a9fc6f91c347fd5c6d6634fa67731bb5198ccc843532e06fea853097316f766522daebf875cce855694b87e67bb0ea6771fb
+  metadata.gz: 971aea4195329e45bf445ec744bcffaf3fc9a4d1a4eed5b88ec4be973f30daa568e7bca15180bc008b7f36967144fb130df67a11a4b060a96bae93ad1fd8ce32
+  data.tar.gz: ded78f47f7b31dfb671fb8bcd8ee383e0e965a16c94090cabba69a2bc1eedd678f99acc9baa2e89c23a391df6d7dd3e7b4ed3634d1722bda18f13cfd505696c2

data/Gemfile.lock

@@ -9,7 +9,7 @@ GEM
     diff-lcs (1.4.4)
     docile (1.4.0)
     hashdiff (1.0.1)
-    inheritance-helper (0.1.5)
+    inheritance-helper (0.2.5)
     parallel (1.20.1)
     parser (3.0.1.1)
       ast (~> 2.4.1)

data/client-api-builder.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'client-api-builder'
-  s.version     = '0.2.3'
+  s.version     = '0.2.7'
   s.licenses    = ['MIT']
   s.summary     = 'Develop Client API libraries faster'
   s.description = 'Utility for constructing API clients'
@@ -10,4 +10,6 @@ Gem::Specification.new do |s|
   s.email       = 'dougyouch@gmail.com'
   s.homepage    = 'https://github.com/dougyouch/client-api-builder'
   s.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+
+  s.add_runtime_dependency 'inheritance-helper', '>= 0.2.5'
 end

data/examples/basic_auth_example_client.rb

@@ -1,4 +1,5 @@
 require 'base64'
+require 'securerandom'
 
 class BasicAuthExampleClient < Struct.new(
         :username,
@@ -6,6 +7,7 @@ class BasicAuthExampleClient < Struct.new(
       )
 
   include ClientApiBuilder::Router
+  include ClientApiBuilder::Section
 
   base_url 'https://www.example.com'
 
@@ -15,9 +17,27 @@ class BasicAuthExampleClient < Struct.new(
   route :get_apps, '/apps'
   route :get_app, '/apps/:app_id'
 
+  section :users do
+    header 'Authorization', :bearer_authorization
+
+    route :create_user, '/users?z={cache_buster}'
+  end
+
+  def cache_buster
+    (Time.now.to_f * 1000).to_i
+  end
+
   private
 
+  def auth_token
+    @auth_token ||= SecureRandom.uuid
+  end
+
   def basic_authorization
     'basic ' + Base64.strict_encode64(username + ':' + password)
   end
+
+  def bearer_authorization
+    'bearer ' + auth_token
+  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.rb

@@ -11,8 +11,10 @@ module ClientApiBuilder
     end
   end
 
-  autoload :Router, 'client_api_builder/router'
+  autoload :NestedRouter, 'client_api_builder/nested_router'
   autoload :QueryParams, 'client_api_builder/query_params'
+  autoload :Router, 'client_api_builder/router'
+  autoload :Section, 'client_api_builder/section'
 
   module NetHTTP
     autoload :Request, 'client_api_builder/net_http_request'

data/lib/client_api_builder/nested_router.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+# Purpose: to nest routers, which are sub sections of APIs
+# for example if you had an entire section of your API dedicatd to user management.
+# you may want to nest all calls to those routes under the user section
+# ex: client.users.get_user(id: 1) # where users is a nested router
+module ClientApiBuilder
+  class NestedRouter
+    include ::ClientApiBuilder::Router
+
+    attr_reader :root_router
+
+    def initialize(root_router)
+      @root_router = root_router
+    end
+
+    def self.get_instance_method(var)
+      "\#{root_router.#{var}\}"
+    end
+
+    def request(**options, &block)
+      root_router.request(**options, &block)
+    end
+
+    def stream(**options, &block)
+      root_router.stream(**options, &block)
+    end
+
+    def stream_to_io(**options, &block)
+      root_router.stream_to_io(**options, &block)
+    end
+
+    def stream_to_file(**options, &block)
+      root_router.stream_to_file(**options, &block)
+    end
+
+    def base_url(options)
+      self.class.base_url || root_router.base_url(options)
+    end
+
+    def build_headers(options)
+      headers = root_router.build_headers(options)
+
+      add_header_proc = proc do |name, value|
+        headers[name] =
+          if value.is_a?(Proc)
+            root_router.instance_eval(&value)
+          elsif value.is_a?(Symbol)
+            root_router.send(value)
+          else
+            value
+          end
+      end
+
+      self.class.headers.each(&add_header_proc)
+
+      headers
+    end
+
+    def build_connection_options(options)
+      root_router.build_connection_options(options)
+    end
+
+    def build_query(query, options)
+      return nil if query.nil? && root_router.class.query_params.empty? && self.class.query_params.empty?
+
+      query_params = {}
+
+      add_query_param_proc = proc do |name, value|
+        query_params[name] =
+          if value.is_a?(Proc)
+            root_router.instance_eval(&value)
+          elsif value.is_a?(Symbol)
+            root_router.send(value)
+          else
+            value
+          end
+      end
+
+      root_router.class.query_params.each(&add_query_param_proc)
+      self.class.query_params.each(&add_query_param_proc)
+      query && query.each(&add_query_param_proc)
+      options[:query] && options[:query].each(&add_query_param_proc)
+
+      self.class.build_query(query_params)
+    end
+
+    def build_body(body, options)
+      root_router.build_body(body, options)
+    end
+
+    def expected_response_code!(response, expected_response_codes, options)
+      root_router.expected_response_code!(response, expected_response_codes, options)
+    end
+
+    def handle_response(response, options, &block)
+      root_router.handle_response(response, options, &block)
+    end
+  end
+end

data/lib/client_api_builder/net_http_request.rb

@@ -37,13 +37,13 @@ module ClientApiBuilder
       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
+            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|
+        stream(method: method, uri: uri, body: body, headers: headers, connection_options: connection_options) do |_, chunk|
           io.write chunk
         end
       end

data/lib/client_api_builder/router.rb

@@ -6,6 +6,7 @@ module ClientApiBuilder
     def self.included(base)
       base.extend InheritanceHelper::Methods
       base.extend ClassMethods
+      base.include ::ClientApiBuilder::Section
       base.include ::ClientApiBuilder::NetHTTP::Request
       base.attr_reader :response, :request_options
     end
@@ -20,19 +21,39 @@ module ClientApiBuilder
       def default_options
         {
           base_url: nil,
-          headers: {},
+          body_builder: :to_json,
           connection_options: {},
+          headers: {},
+          query_builder: Hash.method_defined?(:to_query) ? :to_query : :query_params,
           query_params: {},
-          query_builder: Hash.method_defined?(:to_query) ? :to_query : :query_params
+          response_procs: {}
         }.freeze
       end
 
+
+      def add_response_procs(method_name, proc)
+        response_procs = default_options[:response_procs].dup
+        response_procs[method_name] = proc
+        add_value_to_class_method(:default_options, response_procs: response_procs)
+      end
+
+      def response_proc(method_name)
+        proc = default_options[:response_procs][method_name]
+        proc
+      end
+
       def base_url(url = nil)
         return default_options[:base_url] unless url
 
         add_value_to_class_method(:default_options, base_url: url)
       end
 
+      def body_builder(builder = nil)
+        return default_options[:body_builder] unless builder
+
+        add_value_to_class_method(:default_options, body_builder: builder)
+      end
+
       def query_builder(builder = nil)
         return default_options[:query_builder] unless builder
 
@@ -69,6 +90,21 @@ module ClientApiBuilder
         default_options[:query_params]
       end
 
+      def build_body(router, body, options)
+        builder = options[:body_builder] || body_builder
+
+        case builder
+        when :to_json
+          body.to_json
+        when :to_query
+          body.to_query
+        when :query_params
+          ClientApiBuilder::QueryParams.to_query(body)
+        else
+          router.instance_exec(body, &builder)
+        end
+      end
+
       def build_query(query)
         case query_builder
         when :to_query
@@ -111,6 +147,8 @@ module ClientApiBuilder
             arguments += get_hash_arguments(v)
           when Array
             arguments += get_array_arguments(v)
+          when String
+            hsh[k] = "__||#{$1}||__" if v =~ /\{([a-z0-9_]+)\}/i
           end
         end
         arguments
@@ -127,6 +165,8 @@ module ClientApiBuilder
             arguments += get_hash_arguments(v)
           when Array
             arguments += get_array_arguments(v)
+          when String
+            list[idx] = "__||#{$1}||__" if v =~ /\{([a-z0-9_]+)\}/i
           end
         end
         arguments
@@ -143,9 +183,31 @@ module ClientApiBuilder
         end
       end
 
+      def get_instance_method(var)
+         "#\{#{var}\}"
+      end
+
+      @@namespaces = []
+      def namespaces
+        @@namespaces
+      end
+
+      def namespace(name)
+        namespaces << name
+        yield
+        namespaces.pop
+      end
+
       def generate_route_code(method_name, path, options = {})
         http_method = options[:method] || http_method(method_name)
 
+        path = namespaces.join + path
+
+        # instance method
+        path.gsub!(/\{([a-z0-9_]+)\}/i) do |_|
+          get_instance_method($1)
+        end
+
         path_arguments = []
         path.gsub!(/:([a-z0-9_]+)/i) do |_|
           path_arguments << $1
@@ -207,6 +269,7 @@ module ClientApiBuilder
         method_args += ['**__options__', '&block']
 
         code = "def #{method_name}(" + method_args.join(', ') + ")\n"
+        code += "  block ||= self.class.response_proc(#{method_name.inspect})\n"
         code += "  __path__ = \"#{path}\"\n"
         code += "  __query__ = #{query}\n"
         code += "  __body__ = #{body}\n"
@@ -220,9 +283,10 @@ module ClientApiBuilder
 
         case options[:stream]
         when true,
-             :file,
-             :io
+             :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
@@ -243,13 +307,15 @@ module ClientApiBuilder
         code
       end
 
-      def route(method_name, path, options = {})
+      def route(method_name, path, options = {}, &block)
+        add_response_procs(method_name, block) if block
+
         self.class_eval generate_route_code(method_name, path, options), __FILE__, __LINE__
       end
     end
 
     def base_url(options)
-      self.class.base_url
+      options[:base_url] || self.class.base_url
     end
 
     def build_headers(options)
@@ -267,7 +333,7 @@ module ClientApiBuilder
       end
 
       self.class.headers.each(&add_header_proc)
-      options[:headers]&.each(&add_header_proc)
+      options[:headers] && options[:headers].each(&add_header_proc)
 
       headers
     end
@@ -281,6 +347,8 @@ module ClientApiBuilder
     end
 
     def build_query(query, options)
+      return nil if query.nil? && self.class.query_params.empty?
+
       query_params = {}
 
       add_query_param_proc = proc do |name, value|
@@ -295,22 +363,24 @@ module ClientApiBuilder
       end
 
       self.class.query_params.each(&add_query_param_proc)
-      query&.each(&add_query_param_proc)
+      query && query.each(&add_query_param_proc)
+      options[:query] && options[:query].each(&add_query_param_proc)
 
       self.class.build_query(query_params)
     end
 
     def build_body(body, options)
-      return unless body
+      body = options[:body] if options.key?(:body)
+
+      return nil unless body
       return body if body.is_a?(String)
 
-      body.merge!(options[:body]) if options[:body]
-      body.to_json
+      self.class.build_body(self, body, options)
     end
 
     def build_uri(path, query, options)
       uri = URI(base_url(options) + path)
-      uri.query = build_query(query, options) if query
+      uri.query = build_query(query, options)
       uri
     end
 
@@ -342,5 +412,9 @@ module ClientApiBuilder
         data
       end
     end
+
+    def root_router
+      self
+    end
   end
 end

data/lib/client_api_builder/section.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# Purpose is to encapsulate adding nested routers
+module ClientApiBuilder
+  module Section
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def section(name, &block)
+        kls = InheritanceHelper::ClassBuilder::Utils.create_class(
+          self,
+          name,
+          ::ClientApiBuilder::NestedRouter,
+          nil,
+          'NestedRouter',
+          &block
+        )
+
+        code = <<CODE
+def self.#{name}_router
+  #{kls.name}
+end
+
+def #{name}
+  @#{name} ||= self.class.#{name}_router.new(self.root_router)
+end
+CODE
+        self.class_eval code, __FILE__, __LINE__
+      end
+    end
+  end
+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,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: client-api-builder
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.7
 platform: ruby
 authors:
 - Doug Youch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-17 00:00:00.000000000 Z
-dependencies: []
+date: 2021-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: inheritance-helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.5
 description: Utility for constructing API clients
 email: dougyouch@gmail.com
 executables: []
@@ -25,10 +39,13 @@ files:
 - 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/nested_router.rb
 - lib/client_api_builder/net_http_request.rb
 - lib/client_api_builder/query_params.rb
 - lib/client_api_builder/router.rb
+- lib/client_api_builder/section.rb
 - script/console
 homepage: https://github.com/dougyouch/client-api-builder
 licenses: