wrapi 0.1.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7707119492c003388e3396aebeb7a50b64009075e35fa6fbe8f779ae8312785e
-  data.tar.gz: a503388426775cd56de06672c62b7ba7086963d8191f2782e519061c13c21b28
+  metadata.gz: 1d7d0d197548b78702536dcb3ffd582f1a637ba7c4563b678b682702a55f1f92
+  data.tar.gz: 944dd3cb645f422900a45ff8728a08f47472abb98c64e7c3c34a3a8e696ad0d0
 SHA512:
-  metadata.gz: 1f7d3ef57fcd6ab8e0fcd92d387d093d0f46430349139f2b51718718c63da1d2429768b42fa159ec22384a26a753b2bdeaff9bac3f0778cbfdc344be3439aa7e
-  data.tar.gz: a669367530c66723672ab9523e055d752e235f45aee312366a4c1edbbd9240e2f137d5ea5f965f09b5f7371c873841bb0843d26364452ec93ba9985af883ff64
+  metadata.gz: 51854938895ac5cfdcb616fd9a6a6de72ed0e4a7544bea9eca525b64b8c370b2dbc9b0ca2b596fcbd1838f7b4eaec0a4fa476666e1bca79436f448c647d358cb
+  data.tar.gz: fe27c57580cf3d50d49830d0b1449d177f0de21cb077eb12a3cc953351c1f3d9dc898de8cf4391130dea6f5e549cf9b6530928094cf5866482fefb5e1d795cca

data/CHANGELOG.md

@@ -11,3 +11,10 @@
 
 ## [0.1.3] - 2024-02-5
 - fix entity should return empty array insted of nil
+
+## [0.2.0] - 2024-02-8
+- implement json pagination
+
+## [0.2.0] - 2024-02-13
+- implement option to manipulate request
+

data/Gemfile

@@ -6,4 +6,4 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rake', '~> 13.0'
-gem 'rubocop', "~> 1.7'
+gem 'rubocop', '~> 1.7'

data/lib/wrapi/configuration.rb

@@ -1,4 +1,6 @@
-require_relative './version'
+#require_relative './pagination'
+#require_relative './version'
+
 module WrAPI
   # Defines constants and methods related to configuration
   module Configuration
@@ -18,7 +20,8 @@ module WrAPI
       :logger,
       :format,
       :page_size,
-      :user_agent
+      :user_agent,
+      :pagination_class
     ].freeze
 
     # By default, don't set any connection options
@@ -36,6 +39,8 @@ module WrAPI
 
     # The user agent that will be sent to the API endpoint if none is set
     DEFAULT_USER_AGENT = "Ruby API wrapper #{WrAPI::VERSION}".freeze
+    
+    DEFAULT_PAGINATION = WrAPI::RequestPagination::DefaultPager
 
     # @private
     attr_accessor *VALID_OPTIONS_KEYS
@@ -74,6 +79,7 @@ module WrAPI
       self.format             = DEFAULT_FORMAT
       self.page_size          = DEFAULT_PAGE_SIZE
       self.user_agent         = DEFAULT_USER_AGENT
+      self.pagination_class   = DEFAULT_PAGINATION
     end
   end
 end

data/lib/wrapi/connection.rb

@@ -52,9 +52,9 @@ module WrAPI
       connection.response :logger, logger, { headers: true, bodies: true } do |l|
         # filter json content
         l.filter(/("password":")(.+?)(".*)/, '\1[REMOVED]\3')
-        l.filter(/("accessToken":")(.+?)(".*)/, '\1[REMOVED]\3')
+        l.filter(/("[Aa]ccess_?[Tt]oken":")(.+?)(".*)/, '\1[REMOVED]\3')
         # filter header content
-        l.filter(/(client-secret:.)([^&]+)/, '\1[REMOVED]')
+        l.filter(/(client[-_]secret[:=].)([^&]+)/, '\1[REMOVED]')
         l.filter(/(Authorization:.)([^&]+)/, '\1[REMOVED]')
       end
     end

data/lib/wrapi/pagination.rb

@@ -0,0 +1,39 @@
+require 'uri'
+require 'json'
+
+module WrAPI
+  # Defines HTTP request methods
+  # required attributes format
+  module RequestPagination
+
+    # Defaut pages asumes all data retrieved in a single go.
+    class DefaultPager
+
+      # initialize with page size
+      def initialize(page_size=nil)
+        @page = 0
+      end
+
+      # go to next page
+      # @return true if nore pages
+      def next_page!(data=nil)
+        @page += 1
+        more_pages?
+      end
+
+      # assume single page
+      def more_pages?
+        @page < 1
+      end
+
+      def page_options
+        {}
+      end
+
+      def self.data(body) 
+        body
+      end
+    end
+
+  end
+end

data/lib/wrapi/request.rb

@@ -1,6 +1,5 @@
 require 'uri'
 require 'json'
-require File.expand_path('entity', __dir__)
 
 module WrAPI
   # Defines HTTP request methods
@@ -8,65 +7,80 @@ module WrAPI
   module Request
 
     # Perform an HTTP GET request and return entity incase format is :json
+    #  @return if format is :json an [Entity] is returned, otherwhise the response body
     def get(path, options = {})
-      response = request(:get, path, options)
-      :json.eql?(format) ? Entity.new(response.body) : response.body
+      response = request(:get, path, options) do |request|
+        yield(request) if block_given?
+      end
+      :json.eql?(format) ? Entity.new(pagination_class.data(response.body)) : response.body
     end
 
-    # Perform an HTTP GET request for paged date sets response ind to
-    # Name          Description
-    # pageSize      The number of records to display per page
-    # page          The page number
-    # nextPageToken Next page token
-    #
-    # response format { "page": 0, "totalPages": 0, "total": 0, "nextPageToken": "string", "data": [] }
-    def get_paged(path, options = {}, &block)
-      raise! ArgumentError,
-             "Pages requests should be json formatted (given format '#{format}')" unless :json.eql? format
+    # Perform an HTTP GET request for paged date sets response
+    #  @return nil if block given, otherwise complete concatenated json result set
+    def get_paged(path, options = {}, request_labda = nil)
+      raise ArgumentError,
+            "Pages requests should be json formatted (given format '#{format}')" unless :json.eql? format
 
       result = []
-      page = 1
-      total = page + 1
-      next_page = ''
-      while page <= total
-        following_page = { pageSize: page_size }
-        following_page.merge!({ page: page, nextPageToken: next_page }) unless next_page.empty?
-
-        response = request(:get, path, options.merge(following_page))
-        data = response.body
-        d = data['data'].map { |e| Entity.new(e) }
+      pager = create_pager
+      while pager.more_pages?
+        response = request(:get, path, options.merge(pager.page_options)) do |req|
+          request_labda.call(req) if request_labda
+        end
+        d = pager.class.data(response.body)
+        if d.is_a? Array
+          d = pager.class.data(response.body).map { |e| Entity.new(e) }
+        else
+          d = Entity.new(d)
+        end
         if block_given?
           yield(d)
         else
-          result += d
+          if d.is_a? Array
+            result += d
+          else
+            result << d
+          end
         end
-        page += 1
-        total = data['totalPages'].to_i
-        next_page = data['nextPageToken']
+        pager.next_page!(response.body)
       end
       result unless block_given?
     end
 
     # Perform an HTTP POST request
+    # @return response is returned in json if format is :json
     def post(path, options = {})
-      request(:post, path, options)
+      response = request(:post, path, options) do |request|
+        yield(request) if block_given?
+      end
     end
 
     # Perform an HTTP PUT request
+    # @return response is returned in json if format is :json
     def put(path, options = {})
-      request(:put, path, options)
+      response = request(:put, path, options) do |request|
+        yield(request) if block_given?
+      end
     end
 
     # Perform an HTTP DELETE request
+    # @return response is returened
     def delete(path, options = {})
-      request(:delete, path, options)
+      response = request(:delete, path, options) do |request|
+        yield(request) if block_given?
+      end
     end
 
     private
 
+    def create_pager
+      pagination_class ? pagination_class.new(page_size) : WrAPI::RequestPagination::DefaultPager
+    end
+
     # Perform an HTTP request
     def request(method, path, options)
       response = connection.send(method) do |request|
+        yield(request) if block_given?
         uri = URI::Parser.new
         case method
         when :get, :delete

data/lib/wrapi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WrAPI
-  VERSION = '0.1.3'
+  VERSION = '0.3.0'
 end

data/lib/wrapi.rb

@@ -1,11 +1,12 @@
-require File.expand_path('wrapi/authentication', __dir__)
-require File.expand_path('wrapi/connection', __dir__)
+require File.expand_path('wrapi/version', __dir__)
+require File.expand_path('wrapi/pagination', __dir__)
 require File.expand_path('wrapi/configuration', __dir__)
+require File.expand_path('wrapi/connection', __dir__)
 require File.expand_path('wrapi/api', __dir__)
-require File.expand_path('wrapi/request', __dir__)
 require File.expand_path('wrapi/entity', __dir__)
+require File.expand_path('wrapi/request', __dir__)
 require File.expand_path('wrapi/respond_to', __dir__)
-require File.expand_path('wrapi/version', __dir__)
+require File.expand_path('wrapi/authentication', __dir__)
 
 module WrAPI
   extend RespondTo

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wrapi
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Janco Tanis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-05 00:00:00.000000000 Z
+date: 2024-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -69,6 +69,7 @@ files:
 - lib/wrapi/configuration.rb
 - lib/wrapi/connection.rb
 - lib/wrapi/entity.rb
+- lib/wrapi/pagination.rb
 - lib/wrapi/request.rb
 - lib/wrapi/respond_to.rb
 - lib/wrapi/version.rb