wrapi 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f1cf824802fe7b24c8df963fcf6598e650d4bcf8393f4d685cab9f4825838ca
-  data.tar.gz: 4f7b2f485cdbbcf3e2f10aa64fa0d562d789bb23aa2e6c47611bb7ff5a86db29
+  metadata.gz: d9f4476458af28d2c64f885a156dbab8e4797d30992b8b52a92fbe9876456442
+  data.tar.gz: d1cd4782db7f857ca68c72f956fa2b061b029e545a81ff85901ea39958345b32
 SHA512:
-  metadata.gz: d601f302816a8e521bfd00985f04391a939c4f416a06e7b5accb0701a6c02109f7653b4be0ea8d7b12b191f867284959e0068a1b84495c082dd600c094636e2e
-  data.tar.gz: 16c72f9028b2060dc39b28a9c7037e3d2fba2ebe2a1079a2dbfe3eef2f9ed198ecc60c7dd4ae0c61a1cf79ddefe4638789b4e5072e07da36236b0cf4d3fc92f6
+  metadata.gz: ced08d3424e62508e0dca3e85e30a7fd1a6d116b0a13bed7aec1d11b77234e8aaf93b8d4dce32c2fb3e3787baf95da59f1c595f7b7d318eb63cea9d8f301c6cf
+  data.tar.gz: c2984a92eef0e8038e43d3eb9bbc775490372dbc3eefe97b5ea41c475e77dc0d2b26ecaac64c93ee5977c2ccb5e3089cbdf2a479b748a18e84cb446e7d14ba32

data/CHANGELOG.md

@@ -15,3 +15,13 @@
 ## [0.2.0] - 2024-02-8
 - implement json pagination
 
+## [0.2.0] - 2024-02-13
+- implement option to manipulate request
+
+## [0.4.0] - 2024-02-13
+- testing/code quality
+  authentication tests (mocked)
+  test string/{}/[] entities returned with mock
+  request tests with mock including delete/put/post
+- Entity fix issues returning json arrays
+  Request option to return raw response

data/Gemfile

@@ -2,8 +2,7 @@
 
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in cloudally.gemspec
+# Specify your gem's dependencies in wrapi.gemspec
 gemspec
 
 gem 'rake', '~> 13.0'
-gem 'rubocop', "~> 1.7'

data/README.md

@@ -1,6 +1,9 @@
 # Wrapper API 
+[![Version](https://img.shields.io/gem/v/wrapi.svg)](https://rubygems.org/gems/wrapi)
+[![Maintainability](https://api.codeclimate.com/v1/badges/d84930f1f1d8fae05c5c/maintainability)](https://codeclimate.com/github/jancotanis/wrapi/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/d84930f1f1d8fae05c5c/test_coverage)](https://codeclimate.com/github/jancotanis/wrapi/test_coverage)
 
-Some generic cody extracted from  by a number of api wrapper gems. Internal used only.
+Some generic code extracted from  by a number of api wrapper gems. Internal used only.
 
 ## Installation
 

data/Rakefile

@@ -1,12 +1,20 @@
 # frozen_string_literal: true
 
 require 'bundler/gem_tasks'
+require 'dotenv'
 require 'rake/testtask'
 
+Dotenv.load
+
+system './bin/cc-test-reporter before-build'
+
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.libs << 'lib'
   t.test_files = FileList['test/**/*_test.rb']
+  at_exit do
+    system './bin/cc-test-reporter after-build'
+  end
 end
 
 require 'rubocop/rake_task'

data/lib/wrapi/configuration.rb

@@ -2,10 +2,15 @@
 #require_relative './version'
 
 module WrAPI
+
   # Defines constants and methods related to configuration
+  # If configuration is overridden, please add following methods
+  # @see [self.extended(base)] to initialize the Configuration
+  # If additional options are added, please overide
+  # @see [reset] to initialize variables
+  # @see [options] to return the correct set of options
   module Configuration
-    # An array of valid keys in the options hash when configuring a {Integra365::API}
-
+    # An array of valid keys in the options hash when configuring a {WrAPI::API}
     VALID_OPTIONS_KEYS = [
       :access_token,
       :token_type,

data/lib/wrapi/connection.rb

@@ -33,7 +33,7 @@ module WrAPI
           'User-Agent': user_agent
         },
         url: endpoint
-      }.merge(connection_options)
+      }.merge(connection_options || {})
     end
 
     # callback method to setup api authorization
@@ -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/entity.rb

@@ -6,40 +6,37 @@ module WrAPI
     class Entity
       attr_reader :attributes
 
+      # factory method to create entity or array of entities
+      def self.create(attributes)
+
+        if attributes.is_a? Array
+          Entity.entify(attributes)
+        else
+          Entity.new(attributes) if attributes
+        end
+      end
+
       def initialize(attributes)
         @_raw = attributes
 
         case attributes
         when Hash
           @attributes = attributes.clone.transform_keys(&:to_s)
-        when Array
-          # make deep copy
-          @attributes = entify(attributes)
         else
           @attributes = attributes.clone
         end
       end
 
       def method_missing(method_sym, *arguments, &block)
-        len = arguments.length
         # assignment
         if (method = method_sym[/.*(?==\z)/m])
-          raise! ArgumentError, "wrong number of arguments (given #{len}, expected 1)", caller(1) unless len == 1
+          raise! ArgumentError, "wrong number of arguments (given #{arguments.length}, expected 1)", caller(1) unless arguments.length == 1
 
           @attributes[method] = arguments[0]
         elsif @attributes.include? method_sym.to_s
-          r = @attributes[method_sym.to_s]
-          case r
-          when Hash
-            @attributes[method_sym.to_s] = self.class.new(r)
-          when Array
-            # make deep copy
-            @attributes[method_sym.to_s] = r = entify(r)
-            r
-          else
-            r
-          end
+          accessor(method_sym.to_s)
         else
+          # delegate to hash
           @attributes.send(method_sym, *arguments, &block)
         end
       end
@@ -55,10 +52,23 @@ module WrAPI
       def to_json(options = {})
         @_raw.to_json
       end
-      
-      def entify(a)
+
+      def accessor(method)
+          case @attributes[method]
+          when Hash
+            @attributes[method] = self.class.new(@attributes[method])
+          when Array
+            # make deep copy
+            @attributes[method] = Entity.entify(@attributes[method])
+          else
+            @attributes[method]
+          end
+      end
+
+      def self.entify(a)
         a.map do |item|
-          item.is_a?(Hash) ? self.class.new(item) : item
+          #item.is_a?(Hash) ? self.class.new(item) : item
+          Entity.create(item)
         end
       end
     end

data/lib/wrapi/pagination.rb

@@ -6,7 +6,7 @@ module WrAPI
   # required attributes format
   module RequestPagination
 
-    # Defaut pages asumes all sdata retrieved in a single go.
+    # Defaut pages asumes all data retrieved in a single go.
     class DefaultPager
 
       # initialize with page size

data/lib/wrapi/request.rb

@@ -7,26 +7,37 @@ module WrAPI
   module Request
 
     # Perform an HTTP GET request and return entity incase format is :json
-    def get(path, options = {})
-      response = request(:get, path, options)
-      :json.eql?(format) ? Entity.new(pagination_class.data(response.body)) : response.body
+    #  @return if format is :json and !raw an [Entity] is returned, otherwhise the response body
+    def get(path, options = {}, raw=false)
+      response = request(:get, path, options) do |request|
+        yield(request) if block_given?
+      end
+      entity_response(response, raw)
     end
 
     # Perform an HTTP GET request for paged date sets response
-    def get_paged(path, options = {}, &block)
+    #  @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 = []
       pager = create_pager
       while pager.more_pages?
-        response = request(:get, path, options.merge(pager.page_options))
-        #data = response.body
-        d = pager.class.data(response.body).map { |e| Entity.new(e) }
-        if block_given?
-          yield(d)
-        else
-          result += d
+        response = request(:get, path, options.merge(pager.page_options)) do |req|
+          request_labda.call(req) if request_labda
+        end
+        if d = pager.class.data(response.body)
+          d = Entity.create(d)
+          if block_given?
+            yield(d)
+          else
+            if d.is_a? Array
+              result += d
+            else
+              result << d
+            end
+          end
         end
         pager.next_page!(response.body)
       end
@@ -34,29 +45,42 @@ module WrAPI
     end
 
     # Perform an HTTP POST request
-    def post(path, options = {})
-      request(:post, path, options)
+    # @return response is returned in json if format is :json
+    def post(path, options = {}, raw=true)
+      response = request(:post, path, options) do |request|
+        yield(request) if block_given?
+      end
+      entity_response(response, raw)
     end
 
     # Perform an HTTP PUT request
-    def put(path, options = {})
-      request(:put, path, options)
+    # @return response is returned in json if format is :json
+    def put(path, options = {}, raw=true)
+      response = request(:put, path, options) do |request|
+        yield(request) if block_given?
+      end
+      entity_response(response, raw)
     end
 
     # Perform an HTTP DELETE request
-    def delete(path, options = {})
-      request(:delete, path, options)
+    # @return response is returened
+    def delete(path, options = {}, raw=false)
+      response = request(:delete, path, options) do |request|
+        yield(request) if block_given?
+      end
+      entity_response(response, raw)
     end
 
     private
 
     def create_pager
-      pagination_class.new(page_size)
+      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
@@ -69,5 +93,13 @@ module WrAPI
       end
       response
     end
+
+    def entity_response(response, raw=false)
+      if :json.eql?(format) && !raw
+        Entity.create(pagination_class.data(response.body))
+      else
+        response
+      end
+    end
   end
 end

data/lib/wrapi/respond_to.rb

@@ -2,13 +2,13 @@
 module WrAPI
   module RespondTo
 
-    # Delegate to Integra365::Client
+    # Delegate to Client
     def self.method_missing(method, *args, &block)
       return super unless client.respond_to?(method)
       client.send(method, *args, &block)
     end
 
-    # Delegate to Integra365::Client
+    # Delegate to Client
     def self.respond_to?(method, include_all = false)
       client.respond_to?(method, include_all) || super
     end

data/lib/wrapi/version.rb

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

data/wrapi.gemspec

@@ -31,4 +31,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'faraday'
   s.add_development_dependency 'minitest'
   s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'webmock'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wrapi
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Janco Tanis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-08 00:00:00.000000000 Z
+date: 2024-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -52,6 +52,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email: gems@jancology.com
 executables: []
@@ -63,6 +91,7 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- bin/cc-test-reporter.exe
 - lib/wrapi.rb
 - lib/wrapi/api.rb
 - lib/wrapi/authentication.rb