tp_client 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b2f4a9b278c3d0435ba587384e32a51cf16fbd22152c20237770f880686540b
-  data.tar.gz: 5e80eff590a3d995e059f19343cedfb7ff86fa2164d8b32122f86cdc4e2b1dd5
+  metadata.gz: 45d071ddd6ff993e8ccaec2877044dfaad106f5dc462dfb631081a07cb970d84
+  data.tar.gz: 830446aaa112228e6380c3226839e5cbf17fbdc1c31c6921ad37ea2b3e455d38
 SHA512:
-  metadata.gz: 1c8b8ca1690c74b86f134e408b0c9a293211ee2c53a7739279e44e9a1373e074cff31393ea5bcc77cfc80832b62e187e0a5d4b831a6bd6fc300564b34d4a5675
-  data.tar.gz: 3fbfd5cda721137b30b81767b19ccfd1599f1d8b71992afbcb0342fae98cd1b59743d66afb17c088d875e76354dc7a8137b1596d45aa52208377fe2f747014f8
+  metadata.gz: 73d4cfa097d479f970e191ab323d82acc5f451ab3753c0e7fb143b3f83001e97d92930218c85fce4c4bd96b681f98cb2473dd94737efd23e3e18c35422fe62dc
+  data.tar.gz: 71f71cd5f623af3dbae81064d268443055cc0fa34b399387c8840454a8469794282642d46fb7ab72d791b81f7c966e64664f9f3f86063d8df06a038e6394e917

data/README.md

@@ -16,7 +16,7 @@ gem install tp_client
 
 ```ruby
 # As gem main class is different from gem name, we must require file name explicitly
-gem 'tp_client', '~> 0.1', require: 'tiny_client'
+gem 'tp_client', '~> 0.2.6', require: 'tiny_client'
 ```
 
 Please notice, we have 2 similar gems:
@@ -34,7 +34,6 @@ You can initialize your API by extending the `TinyClient::Configuration`
 
 ```ruby
 class MyConf < TinyClient::Configuration
-
   def initialize
     @url = 'http://localhost:3000/api/1.0'
     @headers = { 'Authorization' => 'token asdfasf4ffsafasdf@12rfsdfa' }
@@ -197,7 +196,7 @@ toto.save! # POST { author: {} }
 Pagination, buffer is achieve through `limit` and `offset` params.
 
 ```
-Author.index_all({limit: 100}) # Will queries the server by batch of 100, until all authors has been retrieved through the enumerator.
+Author.index_all(limit: 100) # Will queries the server by batch of 100, until all authors has been retrieved through the enumerator.
 
 ```
 

data/lib/tiny_client/configuration.rb

@@ -6,6 +6,7 @@ module TinyClient
   # @attr_reader [Integer] limit default limit used as a query param
   class Configuration
     include Singleton
+
     attr_reader :url, :limit
 
     # You need to initialize the api {#url}, default {#headers}, and default limit.
@@ -28,6 +29,18 @@ module TinyClient
       @verbose ||= false
     end
 
+    # @return [String] url using `TinyClient::UrlBuilder` to build url
+    def url_for(*args)
+      query = args.extract_options!
+      url_builder.path(*args).query(query).build
+    end
+
+    # @return [TinyClient::UrlBuilder] url_builder
+    def url_builder
+      TinyClient::UrlBuilder.url(url)
+    end
+
+    # @return [TinyClient::RemoteClient] requestor
     def requestor
       @requestor ||= TinyClient::RemoteClient.new(self)
     end

data/lib/tiny_client/remote_client.rb

@@ -9,7 +9,7 @@ module TinyClient
     # @raise [ResponseError] if the server respond with an error status (i.e 404, 500..)
     # @return [Response]
     def get(path, params, id, name)
-      url = build_url(path, id, name).query(params).build!
+      url = @config.url_for(path, id, name, params)
       CurbRequestor.perform_get(url, {
         'Accept' => 'application/json',
         'Content-Type' => 'application/x-www-form-urlencoded'
@@ -21,7 +21,7 @@ module TinyClient
     # @raise [ResponseError] if the server respond with an error status (i.e 404, 500..)
     # @return [Response]
     def post(data, path, id, name)
-      url = build_url(path, id, name).build!
+      url = @config.url_for(path, id, name)
       verify_json(data)
       CurbRequestor.perform_post(url, {
         'Accept' => 'application/json',
@@ -34,7 +34,7 @@ module TinyClient
     # @raise [ResponseError] if the server respond with an error status (i.e 404, 500..)
     # @return [Response]
     def put(data, path, id, name)
-      url = build_url(path, id, name).build!
+      url = @config.url_for(path, id, name)
       verify_json(data)
       CurbRequestor.perform_put(url, {
         'Accept' => 'application/json',
@@ -46,7 +46,7 @@ module TinyClient
     # @raise [ResponseError] if the server respond with an error status (i.e 404, 500..)
     # @return [Response]
     def delete(path, id, name)
-      url = build_url(path, id, name).build!
+      url = @config.url_for(path, id, name)
       CurbRequestor.perform_delete(url, {
         'Accept' => 'application/json',
         'Content-Type' => 'application/x-www-form-urlencoded'
@@ -58,9 +58,5 @@ module TinyClient
     def verify_json(data)
       raise ArgumentError, 'data must respond to .to_json' unless data.respond_to? :to_json
     end
-
-    def build_url(path, id, name)
-      UrlBuilder.url(@config.url).path(path).path(id).path(name)
-    end
   end
 end

data/lib/tiny_client/response.rb

@@ -4,14 +4,14 @@ require 'active_support/gzip'
 module TinyClient
   # Wrap the curl request response.
   class Response
-    attr_reader :status, :body_str, :header_str, :url, :code
+    attr_reader :url, :body_str, :header_str, :status, :code
 
     def initialize(curb)
-      @status = curb.status
+      @url = curb.url
       @body_str = curb.body_str
       @header_str = curb.header_str
+      @status = curb.status
       @code = @status.to_i
-      @url = curb.url
     end
 
     # Convert the response json body into an hash.

data/lib/tiny_client/url_builder.rb

@@ -4,14 +4,16 @@ module TinyClient
   # Convenient class used to build a request URL.
   class UrlBuilder
     SEPARATOR = '/'.freeze
-    attr_writer :query
 
     def self.url(url)
       new(url)
     end
 
-    def path(path)
-      @path << fix_path(path) unless path.blank?
+    def path(*paths)
+      paths.each do |path|
+        new_path = fix_path(path)
+        @path << new_path if new_path.present?
+      end
       self
     end
 
@@ -20,21 +22,43 @@ module TinyClient
       self
     end
 
+    # @return [String] url with all paths and query params
+    def build
+      url = "#{[@url, @path].join(SEPARATOR)}.json"
+      url = "#{url}?#{@query.to_query}" unless @query.empty?
+      url
+    end
+
+    # @deprecated Please use {#build} instead
     def build!
-      query_s = "?#{@query.to_query}" unless @query.empty?
-      "#{@path.join(SEPARATOR)}.json#{query_s}"
+      ActiveSupport::Deprecation.warn('`build!` is deprecated. Please use `build` instead')
+      build
     end
 
     private
 
     def initialize(url)
-      @path = [url]
+      @url = parse_url(url)
+      @path = []
       @query = {}
     end
 
+    def parse_url(url)
+      if url.blank? || url == SEPARATOR
+        ''
+      else
+        url = url[0..-2] if url.end_with?(SEPARATOR)
+        url
+      end
+    end
+
     def fix_path(path)
-      if path.respond_to?(:gsub)
-        path.gsub(/\.json$/, '')
+      case path
+      when String
+        path = path.gsub(/\.json$/, '')
+        path = path[1..-1] if path.start_with?('/')
+        path = path[0..-2] if path.end_with?('/')
+        path
       else
         path
       end

data/tp_client.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.name     = 'tp_client'
-  s.version  = '0.2.4'
+  s.version  = '0.2.6'
   s.authors  = ['TINYpulse Devops']
   s.email    = 'devops@tinypulse.com'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tp_client
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.6
 platform: ruby
 authors:
 - TINYpulse Devops
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-24 00:00:00.000000000 Z
+date: 2020-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curb
@@ -130,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: TINYclient, an HTTP/JSON crud client toolkit.