remote_entity 1.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33a2e9d809f7e4a0c941f234aa3e3d3c7233934cb476b44505ea12ae8980847d
-  data.tar.gz: 3eadac241251a0e74fa92673864799579bc20b3fb6fd8d8fd894566379b56caf
+  metadata.gz: 8b067d90ced8890a77499154dea7970e77d5805d48a16b5d67eef7890a3d21b9
+  data.tar.gz: 99284e3c3f68804086a88b6d0bad1b55b5cc3b52b2c38f1b5a7c314a0334467f
 SHA512:
-  metadata.gz: 4a4ddfb164a2ab1c6509fbfba0892ae8e0c8a0edc3c23fb67e8235971ee58c4df6dd585d0bba8f7cdd9f1b161bef0d23c4b3143676531b0c22811f6389e15184
-  data.tar.gz: 3512aaac40f588bae7f232b77e8953662718182d0473ce946ca7cacd8839fef15633c042330c601bb201167b6060718688a585d0f17a4d8ab551c075631f974e
+  metadata.gz: 1e557430c6043180f1ca654c62f143798764a7297154823528cd7e327f68a764a6684224672ca744dca94682562a96d7b9d96123df79651568c7773e4bed1c53
+  data.tar.gz: d527cfc59ec21bf1c969dc7c29beb515097f5b62f18597bdb7ee41bfeb3ec867092e21a4f602fee7acec52e5c269d9ac1459f1b1b416d0c925c3ef4c49e8d051

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.5
 
 Style/StringLiterals:
   Enabled: true

data/CHANGELOG.md

@@ -1,3 +1,13 @@
 ## [1.0.0] - 2024-01-18
 
 - Initial release
+
+## [2.0.0] - 2024-02-09
+
+- Add `RemoteEntity` namespace to class generated. For example, `RemoteEntity::User`.
+
+
+## [2.1.0] - 2024-04-26
+
+- Allow instant authorized token in the method params and bypass request to get oauth2 token
+- Allow this gem to use with Ruby >= 2.5.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    remote_entity (1.0.0)
+    remote_entity (2.1.0)
       cgi (~> 0.2)
       oauth2 (~> 2.0)
 
@@ -9,6 +9,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    base64 (0.2.0)
     cgi (0.4.1)
     diff-lcs (1.5.0)
     docile (1.4.0)
@@ -18,7 +19,8 @@ GEM
       net-http
     hashie (5.0.0)
     json (2.7.1)
-    jwt (2.7.1)
+    jwt (2.8.1)
+      base64
     language_server-protocol (3.17.0.3)
     multi_xml (0.6.0)
     net-http (0.4.1)
@@ -35,7 +37,7 @@ GEM
       ast (~> 2.4.1)
       racc
     racc (1.7.3)
-    rack (3.0.8)
+    rack (3.0.10)
     rainbow (3.1.1)
     rake (13.1.0)
     regexp_parser (2.9.0)
@@ -78,7 +80,7 @@ GEM
       version_gem (~> 1.1, >= 1.1.1)
     unicode-display_width (2.5.0)
     uri (0.13.0)
-    version_gem (1.1.3)
+    version_gem (1.1.4)
 
 PLATFORMS
   ruby

data/README.md

@@ -6,6 +6,9 @@ It is something less restricts than [her](https://github.com/remi/her) which map
 
 Currently it supports oauth2 `client_credentials` grant type for API authentication.
 
+## Supporting Ruby versions
+This gem can be used in Ruby >= 2.5.0. However, it might have incompatibilities as this gem was tested with Ruby 3.2.2. Please test thoroughly.
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -31,7 +34,8 @@ RemoteEntity.configure(
                 query_params: [:public]
             },
             authentication: {
-                method: "oauth2.client_credentials"
+                method: "oauth2.client_credentials",
+                accepting_instant_token: :authorized_token
             },
             r_turn: true
         },
@@ -58,18 +62,36 @@ RemoteEntity.configure(
     }
 )
 ```
+The configuration generated `RemoteEntity::User` class with `find` method which can be used by the following example:
+
+```
+RemoteEntity::User.find(id: 1, public: true)
 ```
-User.find(id: 1, public: true)
+**NOTE**:
+- All entity classes created are under `RemoteEntity` namespace.
+- The classes generated are a typical Ruby class which can be extended, inherited. For example:
 ```
-Above will translate to following `GET` http request. `param_mapping` will transform any `path parameter`, and `query parameter` of the request into `User` entity method parameter.
+class UserService < RemoteEntity::User
+
+end
+```
+- The methods generated are `class method`.
+- The method parameter generated from configuration is always key/value pairs (hash)
+
+The method parameters will be transformed into `path parameter`, `query parameter` or `body parameter` of the request by `param_mapping` configuration. It makes the following `GET` http request:
 ```
 curl --location 'https://example.com/users/1?public=true' \
 --header 'Content-Type: application/json' \
 --header 'Authorization: Bearer <token>'
 ```
+
 `Content-Type` header as `application/json` is by default.
 
-`Authorization` header is generated by oauth2 request using grant type defined in the configuration. The example above uses ouath2 client_credentials grant type. (The gem uses [oauth2](https://gitlab.com/oauth-xx/oauth2/) gem underdying, so the param structure is pretty the same as oauth2)
+`Authorization` header is generated by oauth2 request using grant type defined in the configuration. The example above uses ouath2 client_credentials grant type. (The gem uses [oauth2](https://gitlab.com/oauth-xx/oauth2/) gem underdying, so the param structure is pretty the same as oauth2). However, if the method has `authentication` key which includes `accepting_instant_token: :authorized_token`, the authentication token request will be bypassed. The `authorized_token` param value will pass instantly in the request `Authorization` header. For example:
+
+```
+RemoteEntity::User.find(id: 1, public: true, authorized_token: "authorized-token")
+```
 
 Since the `find` method is configured to return value (`r_turn` is set to `true`), it will return whatever the http response has. For example:
 ```
@@ -79,10 +101,11 @@ Since the `find` method is configured to return value (`r_turn` is set to `true`
     age: 22
 }
 ```
+The configuration also creates `create` method. For example:
 ```
-User.create(name: "John", age: 23)
+RemoteEntity::User.create(name: "John", age: 23)
 ```
-Above will translate to following `POST` http request. `param_mapping` will transform `body parameter` of the request into `User` entity method parameter.
+It will make the following `POST` http request:
 ```
 curl --location 'https://example.com/users' \
 --header 'Content-Type: application/json' \
@@ -94,13 +117,11 @@ curl --location 'https://example.com/users' \
 ```
 It has no authorization configured, so no `Authorization` header.
 
-It does not return anything as `r_turn` is set to `false`
-
-**NOTE**: All http request params whether it is query parameter, path parameter or body parameter, it will always transform into key/value pairs parameter of the entity method.
+It does not return anything as `r_turn` is set to `false`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/kseung-gpsw/remote_entity. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/remote_entity/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/kuroun/remote_entity. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/remote_entity/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 

data/lib/remote_entity/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RemoteEntity
-  VERSION = "1.0.0"
+  VERSION = "2.1.0"
 end

data/lib/remote_entity.rb

@@ -16,7 +16,7 @@ module RemoteEntity
     raise "missing required parameter - name" if options[:name].nil?
     raise "missing required parameter - methods" if options[:methods].nil?
 
-    Object.const_set(options[:name], RemoteEntity.build_dynamic_class(options))
+    RemoteEntity.const_set(options[:name], build_dynamic_class(options))
   end
 
   def self.build_dynamic_class(options)
@@ -32,24 +32,32 @@ module RemoteEntity
           request = http_class.new(url)
           request["Content-Type"] = "application/json"
 
-          if method[:authentication] && method[:authentication][:method].include?("oauth2")
-            request["Authorization"] =
-              RemoteEntity.build_oauth2_authorized_token_header(method[:authentication][:method],
-                                                                options[:authentications])
-          end
+          RemoteEntity.set_authorization_header(request, method, arg, options) if method[:authentication]
 
           if method[:param_mapping] && method[:param_mapping][:body_params]
             request.body = JSON.dump(RemoteEntity.build_body_params(method[:param_mapping][:body_params], arg))
           end
 
           response = https.request(request)
-          attributes = JSON.parse(response.read_body)
-          return attributes if method[:r_turn]
+
+          return JSON.parse(response.read_body) if method[:r_turn] && !response.read_body.empty?
         end
       end
     end
   end
 
+  def self.set_authorization_header(request, method, arg, options)
+    accepting_instant_token_key = method[:authentication][:accepting_instant_token]
+
+    if accepting_instant_token_key && arg[accepting_instant_token_key]
+      request["Authorization"] = "Bearer #{arg[accepting_instant_token_key]}"
+    elsif method[:authentication][:method].include?("oauth2")
+      request["Authorization"] =
+        RemoteEntity.build_oauth2_authorized_token_header(method[:authentication][:method],
+                                                          options[:authentications])
+    end
+  end
+
   def self.build_url(method, arg)
     url = method[:url]
 
@@ -102,6 +110,9 @@ module RemoteEntity
                                 site: credentials_info[:site],
                                 token_url: credentials_info[:token_url])
     token = client.send(grant_type).get_token(scope: credentials_info[:scope]).token
+
     "Bearer #{token}"
   end
+
+  private_class_method :build_dynamic_class
 end

data/remote_entity.gemspec

@@ -9,15 +9,15 @@ Gem::Specification.new do |spec|
   spec.email = ["kuroun.seung@gmail.com"]
 
   spec.summary = "Using configuration style to generate Ruby classes and methods that wrap the API calls to a remote service."
-  spec.homepage = "https://github.com/kseung-gpsw/remote_entity"
+  spec.homepage = "https://github.com/kuroun/remote_entity"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.required_ruby_version = ">= 2.5.0"
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/kseung-gpsw/remote_entity"
-  spec.metadata["changelog_uri"] = "https://github.com/kseung-gpsw/remote_entity/blob/main/CHANGELOG.md"
+  spec.metadata["source_code_uri"] = "https://github.com/kuroun/remote_entity"
+  spec.metadata["changelog_uri"] = "https://github.com/kuroun/remote_entity/blob/main/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: remote_entity
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Kuroun Seung
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-18 00:00:00.000000000 Z
+date: 2024-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cgi
@@ -64,14 +64,14 @@ files:
 - lib/remote_entity/version.rb
 - remote_entity.gemspec
 - sig/remote_entity.rbs
-homepage: https://github.com/kseung-gpsw/remote_entity
+homepage: https://github.com/kuroun/remote_entity
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/kseung-gpsw/remote_entity
-  source_code_uri: https://github.com/kseung-gpsw/remote_entity
-  changelog_uri: https://github.com/kseung-gpsw/remote_entity/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/kuroun/remote_entity
+  source_code_uri: https://github.com/kuroun/remote_entity
+  changelog_uri: https://github.com/kuroun/remote_entity/blob/main/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -80,7 +80,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="