client-api-builder 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06500a9c514d0979b01f672ae5bdac70c5dfc7b23b3633f0662a71c4a057a01b
-  data.tar.gz: c3a00f73d888ad6a19b98a9a0c172685fd5299b61fa99b41931c427db8d73470
+  metadata.gz: c22eb6c8362909af90380e2513875c7a82c4bd67028e5a601694c1d604fc599d
+  data.tar.gz: e6ad4f872b67a07563b88f3880bbd1f3375ed2d628a4c15cdedb0734fc9723a3
 SHA512:
-  metadata.gz: 2263f684643292a86895f23906e2d566043d914704b92db919a1f23e1d47c1f5371ef7ea344257a63b234aac6ce8e5f293d4cf16b20e08248c7859fb8b692448
-  data.tar.gz: 0a2508597031c861ea8ba44ac00f9fcd3596b040bde9df1d3724afdb4c5a0d4b4b463d19e75b0360a2987ba1ad7375bff8c25572cb6fced4e194a560bb6f927e
+  metadata.gz: 5bbe4fe12d3ea5ca240b445630360346a0a1628c340c9ce602efbacfb185ad23c7215233dcb84cb245ff5d3961b0695e8d177a15c39f87e9f6f6b4c0d030e60c
+  data.tar.gz: 44c82d195b80ad34205af3fa256523fa0a3a1e7249bd857ac7cc0cece431d9d75906f26a5714914075e0b9291d84ad5649704add740c099d960ad2e60ad3e2ee

data/README.md

@@ -1,2 +1,33 @@
 # client-api-builder
-Utility for creating methods to make api calls
+
+Utility for creating API clients through configuration
+
+Example:
+
+```
+class LoremIpsumClient
+  include ClientApiBuilder::Router
+
+  # by default it converts the body data to JSON
+  # to convert the body to query params (x=1&y=2) use the following
+  # if using active support change this to :to_query
+  body_builder :query_params
+
+  base_url 'https://www.lipsum.com'
+
+  header 'Content-Type', 'application/x-www-form-urlencoded'
+  header 'Accept', 'application/json'
+
+  # this creates a method called create_lorem_ipsum with 2 named arguments amont and what
+  route :create_lorem_ipsum, '/feed/json', body: {amount: :amount, what: :what, start: 'yes', generate: 'Generate Lorem Ipsum'}
+end
+```
+
+How to use:
+
+```
+client = LoremIpsumClient.new
+payload = client.create_lorem_ipsum(amount: 10, what: 'words')
+puts payload.dig('feed', 'lipsum')
+# outputs: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam at.
+```

data/client-api-builder.gemspec

@@ -2,10 +2,10 @@
 
 Gem::Specification.new do |s|
   s.name        = 'client-api-builder'
-  s.version     = '0.3.1'
+  s.version     = '0.4.0'
   s.licenses    = ['MIT']
-  s.summary     = 'Develop Client API libraries faster'
-  s.description = 'Utility for constructing API clients'
+  s.summary     = 'Utility for creating API clients through configuration'
+  s.description = 'Create API clients through configuration with complete transparency'
   s.authors     = ['Doug Youch']
   s.email       = 'dougyouch@gmail.com'
   s.homepage    = 'https://github.com/dougyouch/client-api-builder'

data/examples/lorem_ipsum_client.rb

@@ -0,0 +1,16 @@
+class LoremIpsumClient
+  include ClientApiBuilder::Router
+
+  # by default it converts the body data to JSON
+  # to convert the body to query params (x=1&y=2) use the following
+  # if using active support change this to :to_query
+  body_builder :query_params
+
+  base_url 'https://www.lipsum.com'
+
+  header 'Content-Type', 'application/x-www-form-urlencoded'
+  header 'Accept', 'application/json'
+
+  # this creates a method called create_lorem_ipsum with 2 named arguments amont and what
+  route :create_lorem_ipsum, '/feed/json', body: {amount: :amount, what: :what, start: 'yes', generate: 'Generate Lorem Ipsum'}
+end

data/lib/client_api_builder/router.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require 'inheritance-helper'
+require 'json'
 
 module ClientApiBuilder
   module Router
@@ -9,7 +10,7 @@ module ClientApiBuilder
       base.include ::ClientApiBuilder::Section
       base.include ::ClientApiBuilder::NetHTTP::Request
       base.include(::ClientApiBuilder::ActiveSupportNotifications) if defined?(ActiveSupport)
-      base.send(:attr_reader, :response, :request_options, :total_request_time, :retry_attempts)
+      base.send(:attr_reader, :response, :request_options, :total_request_time, :request_attempts)
     end
 
     module ClassMethods

data/script/console

@@ -6,6 +6,7 @@ $LOAD_PATH << File.expand_path('../examples', __dir__)
 require 'client-api-builder'
 autoload :BasicAuthExampleClient, 'basic_auth_example_client'
 autoload :IMDBDatesetsClient, 'imdb_datasets_client'
+autoload :LoremIpsumClient, 'lorem_ipsum_client'
 require 'logger'
 LOG = Logger.new(STDOUT)
 ClientApiBuilder.logger = LOG

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: client-api-builder
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Doug Youch
@@ -24,7 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.5
-description: Utility for constructing API clients
+description: Create API clients through configuration with complete transparency
 email: dougyouch@gmail.com
 executables: []
 extensions: []
@@ -40,6 +40,7 @@ files:
 - client-api-builder.gemspec
 - examples/basic_auth_example_client.rb
 - examples/imdb_datasets_client.rb
+- examples/lorem_ipsum_client.rb
 - lib/client-api-builder.rb
 - lib/client_api_builder/active_support_log_subscriber.rb
 - lib/client_api_builder/active_support_notifications.rb
@@ -71,5 +72,5 @@ requirements: []
 rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
-summary: Develop Client API libraries faster
+summary: Utility for creating API clients through configuration
 test_files: []